GET /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.
Servers
- https://connect.squareup.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
catalog_object_id |
String | Yes |
ID of the CatalogObject to retrieve. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
location_ids |
String | No |
The Location IDs to look up as a comma-separated list. An empty list queries all locations. |
cursor |
String | No |
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. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.