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

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 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).

catalog_object_ids[] Array No

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

types[] Array No

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

location_ids[] Array No

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

states[] Array No

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

updated_before String No

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).

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

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.