API ReferenceInventory

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.

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

OR
AuthorizationBearer
OAuth2 authentication using JWT tokens

Query parameters

LocationTypestringOptional
LocationIdstringOptionalformat: "int32"
SearchBystringOptional
InventoryIdsstringOptional
IsActivebooleanOptional
IsDigitalbooleanOptional
PageSizestringOptionalformat: "int32"
SortBystringOptional

Response

OK
firststring or null
URL to retrieve the first page of results. Null if already on the first page.
itemslist of objects or null

Array of location-grouped inventory quantity items in the current page of results.

laststring or null
URL to retrieve the last page of results. Null if already on the last page.
nextstring or null
URL to retrieve the next page of results. Null if on the last page.
prevstring or null
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