Retrieves inventory levels for all inventory items grouped by lot number. Enables tracking of inventory across multiple lots, including expiration dates and manufacturing batch information.
Query parameters
LocationIdintegerOptional
Filter by specific fulfillment center location ID. Use this to retrieve lot-based inventory levels for a particular warehouse or distribution center.
SearchBystringOptional
Search is available for 3 fields: Inventory ID, Name, and SKU. Expected behavior for search by Inventory ID is exact match. Expected behavior for search by Inventory Name or SKU is partial match (consecutive characters, case insensitive).
InventoryIdslist of integersOptional
Comma-separated list of inventory IDs to filter results. Use this to retrieve lot-grouped inventory levels for specific inventory items only.
IsActivebooleanOptional
Filter inventory levels by active status. Set to true to return only active inventory items, false for inactive items. Omit to return all items regardless of status.
IsDigitalbooleanOptional
Filter inventory levels by digital product status. Set to true to return only digital products, false for physical products. Digital products are items that don't require physical fulfillment.
PageSizeintegerOptional
Number of lot-grouped inventory level items to return per page. Controls pagination size for the response.
SortBystringOptional
Sort results by field name. Valid fields: id, inventory_id, name, sku, fulfillable_quantity, on_hand_quantity, committed_quantity, awaiting_quantity, internal_transfer_quantity, in_fulfillment_quantity, exception_quantity. Results are returned in ascending order by default; append ' desc' to a field for descending order (e.g., 'on_hand_quantity desc' sorts by on-hand quantity descending).
Response
OK
firststring or nullOptional
URL to retrieve the first page of results. Null if already on the first page.
itemslist of objects or nullOptional
Array of lot-grouped inventory quantity items in the current page of results.
laststring or nullOptional
URL to retrieve the last page of results. Null if already on the last page.
nextstring or nullOptional
URL to retrieve the next page of results. Null if on the last page.
prevstring or nullOptional
URL to retrieve the previous page of results. Null if on the first page.
