Get All Inventory Levels Grouped By Fulfillment Center

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

AuthorizationBearer

OAuth2 authentication using JWT tokens

Query parameters

LocationTypestringOptional

Filter by location type. Valid values: ‘hub’, ‘spoke’, or ‘lts’. Defaults to all locations if not specified.

LocationIdintegerOptional

Filter by specific fulfillment center location ID. Use this to retrieve inventory levels for a particular fulfillment 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 location-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 location-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).

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

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 location-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.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

503

Service Unavailable Error