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.Int
Backward pagination: returns the last N items (max 100, default 25). Use with
before; mutually exclusive with first/after.String
Only return items with this lot number.
Which key to sort by (creation time, newest first). Combine with
reverse to flip direction.Boolean
Reverses the sort direction selected by
orderBy (or its default).String
Only return items whose product has this SKU (exact, case-sensitive).
ID
Only return items in this storage location.
Returns
required
A paginated list of InventoryItem 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
required
Bin-level quantity rows for this inventory item.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.Planned disposition for return inventory.
Condition grade, when applicable.
ID!
required
The id of this inventory item.
Item classification.
required
The kind of inventory unit.
The warehouse this unit is associated with.Requires:
locations_readString
Lot number, when lot tracking applies.
The product this unit is tied to, when applicable.Requires:
inventory_readInt!
required
The number of units this record represents.
The bin or slot where this unit currently resides.Requires:
locations_readrequired
The nodes in this page, without the edge/cursor wrapper — a convenience over
edges.Show fields
Show fields
required
Bin-level quantity rows for this inventory item.Requires:
inventory_readShow fields
Show fields
ArgumentsFields
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 list of edges (each a node plus its pagination
cursor).required
The nodes in this page, without the edge/cursor wrapper — a convenience over
edges.Planned disposition for return inventory.
Condition grade, when applicable.
ID!
required
The id of this inventory item.
Item classification.
required
The kind of inventory unit.
The warehouse this unit is associated with.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, when lot tracking applies.
The product this unit is tied to, when applicable.Requires:
inventory_readShow fields
Show fields
[String!]!
required
Barcodes associated with this product, for scanning.
The product’s length, width, and height in a single shared unit, for box sizing.
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:
inventory_readString
The country of origin, as a country code, for customs.
String
The stock keeping unit identifying this product.
String!
required
The product’s title.
String
The Universal Product Code for this product.
Int!
required
The number of units this record represents.
The bin or slot where this unit currently resides.Requires:
locations_readShow fields
Show fields
required
Product quantities held in this storage 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.Boolean
true returns only rows holding stock (quantity above zero). false returns only empty or negative rows, such as emptied assignments and LOST balancing entries.
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 (creation time, newest first). Combine with
reverse to flip direction.Boolean
Reverses the sort direction selected by
orderBy (or its default).ID!
required
The id of this storage location.
required
Inventory items currently in this storage 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.Boolean!
required
Whether on-hand quantity in this slot counts as sellable inventory.
The warehouse this storage location belongs to.Requires:
locations_readString!
required
The display name of the bin or slot.
Pick priority relative to other bins, when set.
required
How this record was created.
Int!
required
How many product levels in this storage location have a quantity above zero.
Int!
required
The sum of every level’s quantity in this storage location. Negative in areas such as LOST that offset stock elsewhere.
required
The kind of storage location.
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 {
inventoryItems(after: "...", before: "...", first: 10, last: 10, lotNumber: "...", orderBy: CREATED_AT, reverse: true, sku: "...", storageLocationId: "...") {
nodes {
createdAt
disposition
expirationDate
grade
id
itemClass
kind
lotNumber
# ...
}
pageInfo { hasNextPage endCursor }
}
}