You are viewing an old version of the API

All Versions

Retrieve inventory count

Retrieves the current calculated stock count for a given CatalogObject at a given set of Locations.

Responses are paginated and unsorted. For more sophisticated queries, use a batch endpoint.

Required permissions: INVENTORY_READ

Open in API Explorer

Path Parameters

Name	Description
`catalog_object_id string` Required	ID of the CatalogObject to retrieve.

Query Parameters

Name	Description
`location_ids string`	The Location IDs to look up as a comma-separated list. An empty list queries all locations.
`cursor string`	A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the Pagination guide for more information.

Response Fields

Name	Description
`errors Error [ ]`	Any errors that occurred during the request.
`counts InventoryCount [ ]`	The current calculated inventory counts for the requested object and locations.
`cursor string`	The pagination cursor to be used in a subsequent request. If unset, this is the final response. See the Pagination guide for more information.

Examples

All Versions