inventory_read
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.ID
Only return entries for this bin-level inventory record (
BinInventoryLevel id).Only return entries with one of these adjustment kinds.
Int
Backward pagination: returns the last N items (max 100, default 25). Use with
before; mutually exclusive with first/after.Which key to sort by (defaults to the first key, newest-first). Combine with
reverse to flip direction.String
Only return entries with this exact reference id (fulfillment, count session, etc.).
Boolean
Reverses the sort direction selected by
orderBy (or its default).Returns
A paginated list of InventoryLevelLedgerEntry items.
Show fields
Show fields
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
Int!
required
On-hand quantity at this inventory level immediately after this entry.
The bin-level inventory record this ledger row belongs to.Requires:
inventory_readInt!
required
Signed quantity change applied by this entry (negative reduces on-hand).
ID!
required
The id of this ledger entry.
required
What caused this inventory change.
The warehouse location where this adjustment occurred.Requires:
locations_readString
Lot number on the linked inventory item today (not a snapshot at adjustment time).
String
Free-text notes stored on the entry.
The product whose inventory changed, when applicable.Requires:
products_readString
Opaque reference tying this entry to a source record (fulfillment, count session, etc.).
String
Name of the bin or storage location for the linked inventory level today (not a snapshot at adjustment time).
String
Display name of the user who performed the adjustment.
required
The nodes in this page, without the edge/cursor wrapper — a convenience over
edges.Show fields
Show fields
Int!
required
On-hand quantity at this inventory level immediately after this entry.
The bin-level inventory record this ledger row belongs to.Requires:
inventory_readShow fields
Show fields
ID!
required
The id of this bin-level inventory record.
The specific inventory item this level tracks, when item-scoped.Requires:
inventory_readThe product this quantity belongs to, when the level is product-scoped.Requires:
inventory_readAppend-only quantity change history for this bin-level inventory record. Load via
binInventoryLevel(id) { ledgerEntries(...) } or StorageLocation.binInventoryLevels { ledgerEntries(...) }.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.Only return entries with one of these adjustment kinds.
Int
Backward pagination: returns the last N items (max 100, default 25). Use with
before; mutually exclusive with first/after.Which key to sort by (defaults to the first key, newest-first). Combine with
reverse to flip direction.Boolean
Reverses the sort direction selected by
orderBy (or its default).The warehouse this quantity is held at.Requires:
locations_readInt
Maximum quantity allowed in the bin, when capped.
Int!
required
Quantity on hand in the storage location.
required
The bin or slot holding this quantity.Requires:
locations_readInt!
required
Signed quantity change applied by this entry (negative reduces on-hand).
ID!
required
The id of this ledger entry.
required
What caused this inventory change.
The warehouse location where this adjustment occurred.Requires:
locations_readShow 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.
String
Lot number on the linked inventory item today (not a snapshot at adjustment time).
String
Free-text notes stored on the entry.
The product whose inventory changed, when applicable.Requires:
products_readShow fields
Show fields
Look up a single attribute on this product by its name, if set.Requires:
products_readShow fields
Show fields
Arguments
String!
required
The machine name of the attribute to look up.
required
The merchant-defined attributes set on this product.
[String!]!
required
Barcodes associated with this product.
String!
required
The product’s long-form description.
The product’s length, width, and height, expressed in a single shared unit.
String
The Harmonized System code used for customs.
ID!
required
The id of this product.
The first (default) image for this product, if any.Requires:
products_readrequired
A paginated list of the product’s images.Requires:
products_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.required
Traceable inventory units for this product.Requires:
inventory_readThis product’s inventory level at a single location, if any.Requires:
inventory_readShow fields
Show fields
Arguments
ID!
required
The id of the location to fetch the level at.
Per-location inventory levels for this product.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.required
The variant’s selected option values (e.g. Size: M, Color: Red), ordered by the family’s option positions.
String
The country of origin, as a country code.
Boolean!
required
Whether the product is a physical, shippable item.
The product family this product belongs to, if any.Requires:
products_readString
The stock keeping unit identifying this product.
[String!]!
required
Free-form tags applied to the product.
String
The tax code used to classify the product for taxation.
Boolean!
required
Whether the product is subject to tax.
String!
required
The product’s title.
String
The Universal Product Code for this product.
String
The vendor or manufacturer of the product.
String
Opaque reference tying this entry to a source record (fulfillment, count session, etc.).
String
Name of the bin or storage location for the linked inventory level today (not a snapshot at adjustment time).
String
Display name of the user who performed the adjustment.
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 {
inventoryLevelLedgerEntries(after: "...", before: "...", createdAtAfter: "...", createdAtBefore: "...", first: 10, inventoryLevelId: "...", kind: BIN_COUNT, last: 10, orderBy: CREATED_AT, referenceId: "...", reverse: true) {
nodes {
balance
createdAt
delta
expirationDate
id
kind
lotNumber
notes
# ...
}
pageInfo { hasNextPage endCursor }
}
}