RetrieveInventoryChanges
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.
Path parameters
ID of the CatalogObject to retrieve.
Query parameters
The Location IDs to look up as a comma-separated list. An empty list queries all locations.
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
Success
Example response
{
"changes": [
{
"adjustment": {
"catalog_object_id": "W62UWFY35CWMYGVWK6TWJDNI",
"catalog_object_type": "ITEM_VARIATION",
"created_at": "2016-11-16T22:25:24.878Z",
"from_state": "IN_STOCK",
"id": "OJKJIUANKLMLQANZADNPLKAD",
"location_id": "C6W5YS5QM06F5",
"occurred_at": "2016-11-16T22:25:24.878Z",
"quantity": "3",
"reference_id": "d8207693-168f-4b44-a2fd-a7ff533ddd26",
"source": {
"application_id": "416ff29c-86c4-4feb-b58c-9705f21f3ea0",
"name": "Square Point of Sale 4.37",
"product": "SQUARE_POS"
},
"team_member_id": "AV7YRCGI2H1J5NQ8E1XIZCNA",
"to_state": "SOLD",
"total_price_money": {
"amount": 5000,
"currency": "USD"
},
"transaction_id": "5APV6JYK1SNCZD11AND2RX1Z"
},
"type": "ADJUSTMENT"
}
],
"errors": []
}