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.
Servers
- https://connect.squareup.com
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
updated_after |
String | No |
The filter to return results with their |
catalog_object_ids[] |
Array | No |
The filter to return results by |
types[] |
Array | No |
The filter to return results by |
location_ids[] |
Array | No |
The filter to return results by |
states[] |
Array | No |
The filter to return |
updated_before |
String | No |
The filter to return results with their |
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.