batch-retrieve-inventory-changes-request.md

Batch Retrieve Inventory Changes Request

Structure

BatchRetrieveInventoryChangesRequest

Fields

Name	Type	Tags	Description
catalogObjectIds	string[] | undefined	Optional	The filter to return results by CatalogObject ID. The filter is only applicable when set. The default value is null.
locationIds	string[] | undefined	Optional	The filter to return results by Location ID. The filter is only applicable when set. The default value is null.
types	string[] | undefined	Optional	The filter to return results by InventoryChangeType values other than TRANSFER. The default value is [PHYSICAL_COUNT, ADJUSTMENT].
states	string[] | undefined	Optional	The filter to return ADJUSTMENT query results by InventoryState. This filter is only applied when set. The default value is null.
updatedAfter	string | undefined	Optional	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).
updatedBefore	string | undefined	Optional	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 | undefined	Optional	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.
limit	number | undefined	Optional	The number of records to return. Constraints: >= 1, <= 1000

Example (as JSON)

{
  "catalog_object_ids": [
    "W62UWFY35CWMYGVWK6TWJDNI"
  ],
  "location_ids": [
    "C6W5YS5QM06F5"
  ],
  "states": [
    "IN_STOCK"
  ],
  "types": [
    "PHYSICAL_COUNT"
  ],
  "updated_after": "2016-11-01T00:00:00.000Z",
  "updated_before": "2016-12-01T00:00:00.000Z"
}