Get All Inventory Levels Grouped By Fulfillment Center

View as Markdown
Retrieves inventory levels for all inventory items grouped by fulfillment center location. Supports filtering by location type, location ID, and various product attributes. Returns inventory quantities broken down by fulfillment center location; it does not return the list of fulfillment centers. For the physical location list use the Locations API, and for receiving-eligible fulfillment centers use the Receiving API's fulfillment centers endpoint.

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

OR
AuthorizationBearer
OAuth2 authentication using JWT tokens

Query parameters

LocationTypestringOptional
LocationIdintegerOptional
SearchBystringOptional
InventoryIdslist of integersOptional
IsActivebooleanOptional
IsDigitalbooleanOptional
PageSizeintegerOptional
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
itemslist of objects or nullOptional
laststring or nullOptional
nextstring or nullOptional
prevstring or nullOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error
503
Service Unavailable Error