> ## 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.
# inventoryLevelLedgerEntry
> Fetch a single ledger row by id. Prefer `binInventoryLevel { ledgerEntries }` to page history for a bin.
**Required scopes:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)
## Arguments
The id of the ledger entry to fetch.
## Returns
InventoryLevelLedgerEntry}>
An append-only ledger row describing a quantity change at a bin-level inventory level.
On-hand quantity at this inventory level immediately after this entry.
BinInventoryLevel}>
The bin-level inventory record this ledger row belongs to.
**Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)
DateTime!} required>
When the record was created.
The id of this bin-level inventory record.
InventoryItem}>
The specific inventory item this level tracks, when item-scoped.
**Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)
BinInventoryLevelConnection!} required>
Bin-level quantity rows for this inventory item.
**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`.
DateTime!} required>
When the record was created.
InventoryItemDisposition}>
Planned disposition for return inventory.
Date}>
Expiration date for lot-tracked stock. Null when the lot has no expiration set.
InventoryItemGrade}>
Condition grade, when applicable.
The id of this inventory item.
InventoryItemClass}>
Item classification.
InventoryItemKind!} required>
The kind of inventory unit.
Location!} required>
The warehouse this unit is associated with.
**Requires:** [`locations_read`](/docs/api-reference/v3/reference/scopes#scope-locations_read)
Lot number, when lot tracking applies.
InventoryProduct}>
The product this unit is tied to, when applicable.
**Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)
The number of units this record represents.
StorageLocation}>
The bin or slot where this unit currently resides.
**Requires:** [`locations_read`](/docs/api-reference/v3/reference/scopes#scope-locations_read)
DateTime!} required>
When the record was last updated.
InventoryProduct}>
The product this quantity belongs to, when the level is product-scoped.
**Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)
Barcodes associated with this product, for scanning.
Dimensions}>
The product's length, width, and height in a single shared unit, for box sizing.
The Harmonized System code used for customs.
The id of this product.
ProductImage}>
The first (default) image for this product, if any.
**Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)
The country of origin, as a country code, for customs.
The stock keeping unit identifying this product.
The product's title.
The Universal Product Code for this product.
Weight}>
The product's weight, for shipping.
DateTime}>
When this bin-level quantity was last cycle-counted.
InventoryLevelLedgerEntryConnection!} required>
Append-only quantity change history for this bin-level inventory record. Load via `binInventoryLevel(id) { ledgerEntries(...) }` or `StorageLocation.binInventoryLevels { ledgerEntries(...) }`.
**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.
DateTime}>
Only return entries recorded at or after this instant.
DateTime}>
Only return entries recorded before this instant.
Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
[InventoryLevelAdjustmentKind!]}>
Only return entries with one of these adjustment kinds.
Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
InventoryLevelLedgerEntrySortKey}>
Which key to sort by (defaults to the first key, newest-first). Combine with `reverse` to flip direction.
Reverses the sort direction selected by `orderBy` (or its default).
**Fields**
[InventoryLevelLedgerEntryEdge!]!} required>
The list of edges (each a node plus its pagination `cursor`).
[InventoryLevelLedgerEntry!]!} required>
The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
PageInfo!} required>
Pagination metadata for the current page.
Location}>
The warehouse this quantity is held at.
**Requires:** [`locations_read`](/docs/api-reference/v3/reference/scopes#scope-locations_read)
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.
Maximum quantity allowed in the bin, when capped.
Quantity on hand in the storage location.
StorageLocation!} required>
The bin or slot holding this quantity.
**Requires:** [`locations_read`](/docs/api-reference/v3/reference/scopes#scope-locations_read)
BinInventoryLevelConnection!} required>
Product quantities held in this storage 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`.
true returns only rows holding stock (quantity above zero). false returns only empty or negative rows, such as emptied assignments and LOST balancing entries.
Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
BinInventoryLevelSortKey}>
Which key to sort by (creation time, newest first). Combine with `reverse` to flip direction.
Reverses the sort direction selected by `orderBy` (or its default).
DateTime!} required>
When the record was created.
The id of this storage location.
InventoryItemConnection!} required>
Inventory items currently in this storage 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`.
Whether on-hand quantity in this slot counts as sellable inventory.
Location!} required>
The warehouse this storage location belongs to.
**Requires:** [`locations_read`](/docs/api-reference/v3/reference/scopes#scope-locations_read)
The display name of the bin or slot.
StorageLocationPriority}>
Pick priority relative to other bins, when set.
StorageLocationSource!} required>
How this record was created.
How many product levels in this storage location have a quantity above zero.
The sum of every level's quantity in this storage location.
StorageLocationType!} required>
The kind of storage location.
DateTime!} required>
When the record was last updated.
DateTime!} required>
When the record was last updated.
DateTime!} required>
When this ledger entry was recorded.
Signed quantity change applied by this entry (negative reduces on-hand).
Date}>
Expiration date on the linked inventory item today (not a snapshot at adjustment time).
The id of this ledger entry.
InventoryLevelAdjustmentKind!} required>
What caused this inventory change.
Location}>
The warehouse location where this adjustment occurred.
**Requires:** [`locations_read`](/docs/api-reference/v3/reference/scopes#scope-locations_read)
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`.
**Fields**
[InventoryItemEdge!]!} required>
The list of edges (each a node plus its pagination `cursor`).
[InventoryItem!]!} required>
The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
PageInfo!} required>
Pagination metadata for the current page.
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`.
**Fields**
[LocationInventoryLevelEdge!]!} required>
The list of edges (each a node plus its pagination `cursor`).
[LocationInventoryLevel!]!} required>
The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
PageInfo!} required>
Pagination metadata for the current page.
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`.
**Fields**
[StorageLocationEdge!]!} required>
The list of edges (each a node plus its pagination `cursor`).
[StorageLocation!]!} required>
The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
PageInfo!} required>
Pagination metadata for the current page.
The first line of the street address.
The second line of the street address.
DateTime!} required>
When the record was last updated.
Lot number on the linked inventory item today (not a snapshot at adjustment time).
Free-text notes stored on the entry.
Product}>
The product whose inventory changed, when applicable.
**Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)
Attribute}>
Look up a single attribute on this product by its name, if set.
**Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)
**Arguments**
The machine name of the attribute to look up.
**Fields**
An optional description of what the attribute represents.
The human-readable label shown for the attribute.
The unique identifier of the attribute's definition.
The attribute's machine name, unique within the account.
AttributeType!} required>
The data type of the attribute's value.
JSON}>
The attribute's value, resolved to the typed JSON form for its `type` — read `type` to know the shape. E.g. SHORT\_TEXT → a string, WEIGHT → \{ value, unit }, MONEY → \{ amount, currency }. Null if unset. See AttributeType for each type's shape.
[Attribute!]!} required>
The merchant-defined attributes set on this product.
An optional description of what the attribute represents.
The human-readable label shown for the attribute.
The unique identifier of the attribute's definition.
The attribute's machine name, unique within the account.
AttributeType!} required>
The data type of the attribute's value.
JSON}>
The attribute's value, resolved to the typed JSON form for its `type` — read `type` to know the shape. E.g. SHORT\_TEXT → a string, WEIGHT → \{ value, unit }, MONEY → \{ amount, currency }. Null if unset. See AttributeType for each type's shape.
Barcodes associated with this product.
Money}>
The merchant's unit cost for the product.
Decimal!} required>
The exact amount as a decimal string (e.g. "19.99").
ISO 4217 currency code (e.g. USD).
DateTime!} required>
When the record was created.
The product's long-form description.
Dimensions}>
The product's length, width, and height, expressed in a single shared unit.
The height, in `unit`.
The length, in `unit`.
DimensionUnit!} required>
The unit all three measurements are expressed in.
The width, in `unit`.
The Harmonized System code used for customs.
The id of this product.
ProductImage}>
The first (default) image for this product, if any.
**Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)
Alternative text describing the image.
Whether this is the default image.
The id of this image.
The image's ordering position.
The public URL of the image.
ProductImageConnection!} required>
A paginated list of the product's images.
**Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_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`.
**Fields**
[ProductImageEdge!]!} required>
The list of edges (each a node plus its pagination `cursor`).
[ProductImage!]!} required>
The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
PageInfo!} required>
Pagination metadata for the current page.
InventoryItemConnection!} required>
Traceable inventory units for this product.
**Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)
**Arguments**
**Fields**
[InventoryItemEdge!]!} required>
The list of edges (each a node plus its pagination `cursor`).
[InventoryItem!]!} required>
The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
PageInfo!} required>
Pagination metadata for the current page.
LocationInventoryLevel}>
This product's inventory level at a single location, if any.
**Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)
**Arguments**
The id of the location to fetch the level at.
**Fields**
The quantity available to sell.
The quantity that can be built from components.
The quantity committed to existing orders.
DateTime!} required>
When the record was created.
The id of this inventory level.
InventoryProduct}>
A fulfillment-oriented view of the product, readable by anyone who can see this level (e.g. a 3PL). For the full product, use `product`.
**Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)
Location}>
The location these inventory levels are held at.
**Requires:** [`locations_read`](/docs/api-reference/v3/reference/scopes#scope-locations_read)
Product}>
The full product these inventory levels are for. Only readable by the account that owns the product; use `inventoryProduct` otherwise.
**Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)
The total quantity on hand at the location.
The quantity reserved across all reservation buckets.
DateTime!} required>
When the record was last updated.
LocationInventoryLevelConnection!} required>
Per-location inventory levels for this product.
**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`.
**Fields**
[LocationInventoryLevelEdge!]!} required>
The list of edges (each a node plus its pagination `cursor`).
[LocationInventoryLevel!]!} required>
The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
PageInfo!} required>
Pagination metadata for the current page.
[ProductOptionValue!]!} required>
The variant's selected option values (e.g. Size: M, Color: Red), ordered by the family's option positions.
The option name, e.g. Size.
The selected value, e.g. M.
The country of origin, as a country code.
Whether the product is a physical, shippable item.
Money}>
The product's selling price.
Decimal!} required>
The exact amount as a decimal string (e.g. "19.99").
ISO 4217 currency code (e.g. USD).
ProductFamily}>
The product family this product belongs to, if any.
**Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)
Attribute}>
Look up a single attribute on this family by its name, if set.
**Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)
**Arguments**
The machine name of the attribute to look up.
[Attribute!]!} required>
The merchant-defined attributes set on this family.
DateTime!} required>
When the record was created.
The product family's long-form description.
The id of this product family.
ProductFamilyImage}>
The first (default) image for this family, if any.
**Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)
ProductFamilyImageConnection!} required>
A paginated list of the family's images.
**Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_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`.
[ProductFamilyOption!]!} required>
The variant options (e.g. Size, Color) for this family.
ProductConnection!} required>
A paginated list of the products (variants) in this family.
**Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_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`.
Free-form tags applied to the product family.
The product family's title.
DateTime!} required>
When the record was last updated.
The vendor or manufacturer of the product family.
The stock keeping unit identifying this product.
Free-form tags applied to the product.
The tax code used to classify the product for taxation.
Whether the product is subject to tax.
The product's title.
The Universal Product Code for this product.
DateTime!} required>
When the record was last updated.
The vendor or manufacturer of the product.
Weight}>
The product's weight.
WeightUnit!} required>
The unit the value is expressed in.
The numeric magnitude of the weight.
Opaque reference tying this entry to a source record (fulfillment, count session, etc.).
Name of the bin or storage location for the linked inventory level today (not a snapshot at adjustment time).
Display name of the user who performed the adjustment.
## Example
```graphql theme={null}
query {
inventoryLevelLedgerEntry(id: "...") {
balance
createdAt
delta
expirationDate
id
kind
lotNumber
notes
# ...
}
}
```
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.