> ## 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.
# Location
> A physical or logical location where inventory is held or shipped from.
**Required scopes:** [`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`).
Opaque cursor for this item; pass to `after`/`before` to page from here.
InventoryItem!} required>
The item at this edge.
[InventoryItem!]!} required>
The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
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.
PageInfo!} required>
Pagination metadata for the current page.
Cursor of the last edge in this page; pass to `after` to page forward.
Whether more items exist after this page (drives forward pagination with `first`/`after`).
Whether more items exist before this page (drives backward pagination with `last`/`before`).
Cursor of the first edge in this page; pass to `before` to page backward.
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`).
Opaque cursor for this item; pass to `after`/`before` to page from here.
LocationInventoryLevel!} required>
The item at this edge.
[LocationInventoryLevel!]!} required>
The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
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.
PageInfo!} required>
Pagination metadata for the current page.
Cursor of the last edge in this page; pass to `after` to page forward.
Whether more items exist after this page (drives forward pagination with `first`/`after`).
Whether more items exist before this page (drives backward pagination with `last`/`before`).
Cursor of the first edge in this page; pass to `before` to page backward.
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`).
Opaque cursor for this item; pass to `after`/`before` to page from here.
StorageLocation!} required>
The item at this edge.
[StorageLocation!]!} required>
The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
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.
PageInfo!} required>
Pagination metadata for the current page.
Cursor of the last edge in this page; pass to `after` to page forward.
Whether more items exist after this page (drives forward pagination with `first`/`after`).
Whether more items exist before this page (drives backward pagination with `last`/`before`).
Cursor of the first edge in this page; pass to `before` to page backward.
The first line of the street address.
The second line of the street address.
DateTime!} required>
When the record was last updated.
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.