> ## 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.
# binInventoryLevel
> Fetch a single bin-level inventory record by its id. List records with `binInventoryLevels` or `StorageLocation.binInventoryLevels`.
**Required scopes:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)
## Arguments
The id of the bin inventory level to fetch.
## Returns
BinInventoryLevel}>
On-hand quantity for a product (and optionally a specific inventory item) in a storage location.
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`.
**Fields**
[BinInventoryLevelEdge!]!} required>
The list of edges (each a node plus its pagination `cursor`).
[BinInventoryLevel!]!} required>
The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
PageInfo!} required>
Pagination metadata for the current page.
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)
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.
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)
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.
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)
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. Negative in areas such as LOST that offset stock elsewhere.
StorageLocationType!} required>
The kind of storage location.
DateTime!} required>
When the record was last updated.
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 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:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_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.
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.
WeightUnit!} required>
The unit the value is expressed in.
The numeric magnitude of the weight.
DateTime}>
When this bin-level quantity was last cycle-counted.
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`.
**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.
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).
**Fields**
[BinInventoryLevelEdge!]!} required>
The list of edges (each a node plus its pagination `cursor`).
[BinInventoryLevel!]!} required>
The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
PageInfo!} required>
Pagination metadata for the current page.
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`.
**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.
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 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.
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. Negative in areas such as LOST that offset stock elsewhere.
StorageLocationType!} required>
The kind of storage location.
DateTime!} required>
When the record was last updated.
DateTime!} required>
When the record was last updated.
## Example
```graphql theme={null}
query {
binInventoryLevel(id: "...") {
createdAt
id
lastCountedAt
maxQuantity
quantity
updatedAt
}
}
```
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.