inventory_read
Arguments
String
Forward pagination cursor.
String
Backward pagination cursor.
Int
Forward page size (default 25, max 100).
Int
Backward page size (default 25, max 100).
ID!
required
Warehouse location to search.
Boolean
Reverse the selected sort direction.
Sort key. Defaults to UPDATED_AT, newest first.
String
Filter by product: case-insensitive match on title, SKU, UPC, and barcodes.
Returns
required
A paginated list of ReplenishmentReport items.
Show fields
Show fields
required
The list of edges (each a node plus its pagination
cursor).Show fields
Show fields
String!
required
Opaque cursor for this item; pass to
after/before to page from here.required
The item at this edge.
Show fields
Show fields
Boolean!
required
Whether pickable quantity is below the configured minimum.
String
Why replenishment is blocked for this row, when stock is needed but cannot be moved.
Int!
required
Demand shortfall versus available pickable stock.
required
Empty pickable bins assigned to this product.
Boolean!
required
Whether an assigned pickable bin is empty.
Boolean!
required
Whether an open replenishment request exists.
Boolean!
required
Whether a replenishment threshold is configured.
ID!
required
Stable report row id (product and location pair in the index).
Int
Configured replenishment increment.
Boolean!
required
Whether this product is lot-tracked at the warehouse.
Int
Configured maximum pickable quantity, if set.
Int!
required
Configured minimum pickable quantity.
Boolean!
required
Whether this row is flagged as needing replenishment under current rules.
String
Status of the open replenishment request, if any.
required
Overstock/reserve bins holding this product.
Int!
required
Total overstock/reserve on-hand quantity.
Int!
required
Number of pickable bins holding this product.
required
Pickable bins holding this product.
Int
Configured pickable capacity, if known.
Int!
required
Total pickable on-hand quantity.
Int!
required
Pickable shortfall versus configured need and demand.
ID!
required
Product id for this report row.
Int!
required
Receiving area on-hand quantity.
Boolean!
required
For lot-tracked products, whether matching lot stock is available in reserve.
Boolean!
required
Whether the product is short of stock for unpicked demand.
String
Product SKU.
Int!
required
Suggested quantity to replenish.
String
Product title.
Int!
required
Unpicked item demand.
Int!
required
Shipments blocked on pickable stock for this product.
String
Product UPC.
required
The nodes in this page, without the edge/cursor wrapper — a convenience over
edges.Show fields
Show fields
Boolean!
required
Whether pickable quantity is below the configured minimum.
String
Why replenishment is blocked for this row, when stock is needed but cannot be moved.
Int!
required
Demand shortfall versus available pickable stock.
required
Boolean!
required
Whether an assigned pickable bin is empty.
Boolean!
required
Whether an open replenishment request exists.
Boolean!
required
Whether a replenishment threshold is configured.
ID!
required
Stable report row id (product and location pair in the index).
Int
Configured replenishment increment.
Warehouse location for this report row.
Show fields
Show fields
String
The city of the location’s address.
String
The company name associated with the location.
String
The country code, e.g. “US”.
ID!
required
The id of this location.
required
Traceable inventory units at this warehouse.Requires:
inventory_readShow fields
Show fields
Arguments
String
Forward pagination cursor — returns items after it. Pass an
edges[].cursor or pageInfo.endCursor from a previous page.String
Backward pagination cursor — returns items before it. Pass an
edges[].cursor or pageInfo.startCursor from a previous page.Int
Forward pagination: returns the first N items (max 100, default 25). Use with
after; mutually exclusive with last/before.Int
Backward pagination: returns the last N items (max 100, default 25). Use with
before; mutually exclusive with first/after.Per-product inventory levels held at this location.Requires:
inventory_readShow fields
Show fields
Arguments
String
Forward pagination cursor — returns items after it. Pass an
edges[].cursor or pageInfo.endCursor from a previous page.String
Backward pagination cursor — returns items before it. Pass an
edges[].cursor or pageInfo.startCursor from a previous page.Int
Forward pagination: returns the first N items (max 100, default 25). Use with
after; mutually exclusive with last/before.Int
Backward pagination: returns the last N items (max 100, default 25). Use with
before; mutually exclusive with first/after.String!
required
The location’s display name.
String
The contact phone number for the location.
String
The postal or ZIP code, e.g. “84101”.
String
The state or province code, e.g. “UT”.
required
Bins and other storage locations within this warehouse.Requires:
locations_readShow fields
Show fields
Arguments
String
Forward pagination cursor — returns items after it. Pass an
edges[].cursor or pageInfo.endCursor from a previous page.String
Backward pagination cursor — returns items before it. Pass an
edges[].cursor or pageInfo.startCursor from a previous page.Int
Forward pagination: returns the first N items (max 100, default 25). Use with
after; mutually exclusive with last/before.Int
Backward pagination: returns the last N items (max 100, default 25). Use with
before; mutually exclusive with first/after.String
The first line of the street address.
String
The second line of the street address.
Boolean!
required
Whether this product is lot-tracked at the warehouse.
Int
Configured maximum pickable quantity, if set.
Int!
required
Configured minimum pickable quantity.
Boolean!
required
Whether this row is flagged as needing replenishment under current rules.
String
Status of the open replenishment request, if any.
required
Int!
required
Total overstock/reserve on-hand quantity.
Int!
required
Number of pickable bins holding this product.
required
Int
Configured pickable capacity, if known.
Int!
required
Total pickable on-hand quantity.
Int!
required
Pickable shortfall versus configured need and demand.
ID!
required
Product id for this report row.
Int!
required
Receiving area on-hand quantity.
Boolean!
required
For lot-tracked products, whether matching lot stock is available in reserve.
Boolean!
required
Whether the product is short of stock for unpicked demand.
String
Product SKU.
Int!
required
Suggested quantity to replenish.
String
Product title.
Int!
required
Unpicked item demand.
Int!
required
Shipments blocked on pickable stock for this product.
String
Product UPC.
Pagination metadata for the current page.
Show fields
Show fields
String
Cursor of the last edge in this page; pass to
after to page forward.Boolean!
required
Whether more items exist after this page (drives forward pagination with
first/after).Boolean!
required
Whether more items exist before this page (drives backward pagination with
last/before).String
Cursor of the first edge in this page; pass to
before to page backward.Example
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 }
}
}