Retrieve inventory 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.
| Name | Description |
|---|---|
catalog_
Required
|
ID of the CatalogObject to retrieve. |
| Name | Description |
|---|---|
location_
|
The Location IDs to look up as a comma-separated list. An empty list queries all locations. |
cursor
|
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
|
Any errors that occurred during the request. |
changes
|
The set of inventory changes for the requested object and locations. |
cursor
|
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
- cURL
- Ruby
- Python
- C#
- Java
- PHP
- Node.js
curl https://connect.squareup.com/v2/inventory/catalog_object_id0/changes \
-H 'Square-Version: 2021-07-21' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-Type: application/json'{
"errors": [],
"changes": [
{
"type": "ADJUSTMENT",
"adjustment": {
"id": "OJKJIUANKLMLQANZADNPLKAD",
"reference_id": "d8207693-168f-4b44-a2fd-a7ff533ddd26",
"from_state": "IN_STOCK",
"to_state": "SOLD",
"location_id": "C6W5YS5QM06F5",
"catalog_object_id": "W62UWFY35CWMYGVWK6TWJDNI",
"catalog_object_type": "ITEM_VARIATION",
"quantity": "3",
"total_price_money": {
"amount": 5000,
"currency": "USD"
},
"occurred_at": "2016-11-16T22:25:24.878Z",
"created_at": "2016-11-16T22:25:24.878Z",
"source": {
"product": "SQUARE_POS",
"application_id": "416ff29c-86c4-4feb-b58c-9705f21f3ea0",
"name": "Square Point of Sale 4.37"
},
"employee_id": "AV7YRCGI2H1J5NQ8E1XIZCNA",
"transaction_id": "5APV6JYK1SNCZD11AND2RX1Z"
}
}
]
}