<- Inventory API

Inventory API

Batch retrieve inventory changes

POST

 /v2/inventory/changes/batch-retrieve

Returns historical physical counts and adjustments based on the provided filter criteria.

Results are paginated and sorted in ascending order according their occurred_at timestamp (oldest first).

BatchRetrieveInventoryChanges is a catch-all query endpoint for queries that cannot be handled by other, simpler endpoints.

Permissions:INVENTORY_READ
Try in API Explorer
Link to section

Request body

Example code

Link to section

catalog_object_ids

string [ ]

The filter to return results by CatalogObject ID. The filter is only applicable when set. The default value is null.

Link to section

location_ids

string [ ]

The filter to return results by Location ID. The filter is only applicable when set. The default value is null.

Link to section

types

string [ ]

The filter to return results by InventoryChangeType values other than TRANSFER. The default value is [PHYSICAL_COUNT, ADJUSTMENT].

Link to section

states

string [ ]

The filter to return ADJUSTMENT query results by InventoryState. This filter is only applied when set. The default value is null.

Link to section

updated_after

string

The filter to return results with their calculated_at value after the given time as specified in an RFC 3339 timestamp. The default value is the UNIX epoch of (1970-01-01T00:00:00Z).

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

Link to section

updated_before

string

The filter to return results with their created_at or calculated_at value strictly before the given time as specified in an RFC 3339 timestamp. The default value is the UNIX epoch of (1970-01-01T00:00:00Z).

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

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

limit

integer(32-bit)

The number of records to return.

Min
1
Max
1000
Link to section

Response fields

Link to section

errors

Any errors that occurred during the request.

Link to section

changes

The current calculated inventory changes for the requested objects 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.