Retrieve inventory changes

DEPRECATED

/v2/inventory/{catalog_object_id}/changes

Returns a set of physical counts and inventory adjustments for the provided CatalogObject at the requested Locations.

You can achieve the same result by calling BatchRetrieveInventoryChanges and having the catalog_object_ids list contain a single element of the CatalogObject ID.

Results are paginated and sorted in descending order according to their occurred_at timestamp (newest first).

There are no limits on how far back the caller can page. This endpoint can be used to display recent changes for a specific item. For more sophisticated queries, use a batch endpoint.

Permissions:INVENTORY_READ

Guide

Retrieve the Inventory Change History

Deprecation date

2021-06-16

Retirement date

2023-11-15

Replaced by

BatchRetrieveInventoryChanges

Link to section

Path parameters

Example code

Link to section

catalog_object_id

string

Required

ID of the CatalogObject to retrieve.

Link to section

Query parameters

Link to section

location_ids

string

The Location IDs to look up as a comma-separated list. An empty list queries all locations.

Link to section

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.

Link to section

Response fields

Link to section

errors

Any errors that occurred during the request.

Link to section

changes

The set of inventory changes for the requested object and locations.

Link to section

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.