> ## Documentation Index
> Fetch the complete documentation index at: https://developers.redo.com/llms.txt
> Use this file to discover all available pages before exploring further.
# searchReplenishmentReports
> Search the replenishment report (OpenSearch location bin inventory index) for products at a warehouse location. Narrow results with textSearch on product title, SKU, UPC, or barcodes. Each row includes replenishment status fields such as needsReplenishment and suggestedQuantity. Always scoped to the authenticated account and the requested location.
**Required scopes:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)
## Arguments
Forward pagination cursor.
Backward pagination cursor.
Forward page size (default 25, max 100).
Backward page size (default 25, max 100).
Warehouse location to search.
Reverse the selected sort direction.
ReplenishmentReportSortKey}>
Sort key. Defaults to UPDATED\_AT, newest first.
Filter by product: case-insensitive match on title, SKU, UPC, and barcodes.
## Returns
ReplenishmentReportConnection!} required>
A paginated list of ReplenishmentReport items.
[ReplenishmentReportEdge!]!} required>
The list of edges (each a node plus its pagination `cursor`).
Opaque cursor for this item; pass to `after`/`before` to page from here.
ReplenishmentReport!} required>
The item at this edge.
Whether pickable quantity is below the configured minimum.
Why replenishment is blocked for this row, when stock is needed but cannot be moved.
Demand shortfall versus available pickable stock.
[ReplenishmentReportBin!]!} required>
Empty pickable bins assigned to this product.
Decimal!} required>
Ratio of pickable on-hand to target capacity (0–1).
Whether an assigned pickable bin is empty.
Whether an open replenishment request exists.
Whether a replenishment threshold is configured.
Stable report row id (product and location pair in the index).
Configured replenishment increment.
Location}>
Warehouse location for this report row.
Whether this product is lot-tracked at the warehouse.
Configured maximum pickable quantity, if set.
Configured minimum pickable quantity.
Whether this row is flagged as needing replenishment under current rules.
DateTime}>
When the open replenishment request started.
Status of the open replenishment request, if any.
[ReplenishmentReportBin!]!} required>
Overstock/reserve bins holding this product.
Total overstock/reserve on-hand quantity.
Number of pickable bins holding this product.
[ReplenishmentReportBin!]!} required>
Pickable bins holding this product.
Configured pickable capacity, if known.
Total pickable on-hand quantity.
Pickable shortfall versus configured need and demand.
Product id for this report row.
Receiving area on-hand quantity.
For lot-tracked products, whether matching lot stock is available in reserve.
Whether the product is short of stock for unpicked demand.
Product SKU.
Suggested quantity to replenish.
Product title.
Unpicked item demand.
Shipments blocked on pickable stock for this product.
Product UPC.
[ReplenishmentReport!]!} required>
The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
Whether pickable quantity is below the configured minimum.
Why replenishment is blocked for this row, when stock is needed but cannot be moved.
Demand shortfall versus available pickable stock.
[ReplenishmentReportBin!]!} required>
Empty pickable bins assigned to this product.
Bin name.
Quantity in this bin.
Decimal!} required>
Ratio of pickable on-hand to target capacity (0–1).
Whether an assigned pickable bin is empty.
Whether an open replenishment request exists.
Whether a replenishment threshold is configured.
Stable report row id (product and location pair in the index).
Configured replenishment increment.
Location}>
Warehouse location for this report row.
The city of the location's address.
The company name associated with the location.
The country code, e.g. "US".
DateTime!} required>
When the record was created.
The id of this location.
InventoryItemConnection!} required>
Traceable inventory units at this warehouse.
**Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)
**Arguments**
Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
LocationInventoryLevelConnection!} required>
Per-product inventory levels held at this location.
**Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)
**Arguments**
Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
The location's display name.
The contact phone number for the location.
The postal or ZIP code, e.g. "84101".
The state or province code, e.g. "UT".
StorageLocationConnection!} required>
Bins and other storage locations within this warehouse.
**Requires:** [`locations_read`](/docs/api-reference/v3/reference/scopes#scope-locations_read)
**Arguments**
Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
The first line of the street address.
The second line of the street address.
DateTime!} required>
When the record was last updated.
Whether this product is lot-tracked at the warehouse.
Configured maximum pickable quantity, if set.
Configured minimum pickable quantity.
Whether this row is flagged as needing replenishment under current rules.
DateTime}>
When the open replenishment request started.
Status of the open replenishment request, if any.
[ReplenishmentReportBin!]!} required>
Overstock/reserve bins holding this product.
Bin name.
Quantity in this bin.
Total overstock/reserve on-hand quantity.
Number of pickable bins holding this product.
[ReplenishmentReportBin!]!} required>
Pickable bins holding this product.
Bin name.
Quantity in this bin.
Configured pickable capacity, if known.
Total pickable on-hand quantity.
Pickable shortfall versus configured need and demand.
Product id for this report row.
Receiving area on-hand quantity.
For lot-tracked products, whether matching lot stock is available in reserve.
Whether the product is short of stock for unpicked demand.
Product SKU.
Suggested quantity to replenish.
Product title.
Unpicked item demand.
Shipments blocked on pickable stock for this product.
Product UPC.
PageInfo!} required>
Pagination metadata for the current page.
Cursor of the last edge in this page; pass to `after` to page forward.
Whether more items exist after this page (drives forward pagination with `first`/`after`).
Whether more items exist before this page (drives backward pagination with `last`/`before`).
Cursor of the first edge in this page; pass to `before` to page backward.
## Example
```graphql theme={null}
query {
searchReplenishmentReports(after: "...", before: "...", first: 10, last: 10, locationId: "...", reverse: true, sortKey: DEMAND_SHORTFALL, textSearch: "...") {
nodes {
belowMinimum
blockedReason
demandShortfall
fillRatio
hasEmptyPickableBin
hasPendingReplenishment
hasThreshold
id
# ...
}
pageInfo { hasNextPage endCursor }
}
}
```
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.