Skip to content

Latest commit

 

History

History
39 lines (32 loc) · 1.98 KB

batch-retrieve-inventory-changes-request.md

File metadata and controls

39 lines (32 loc) · 1.98 KB
Raw

Batch Retrieve Inventory Changes Request

Structure

BatchRetrieveInventoryChangesRequest

Fields

Name Type Tags Description
CatalogObjectIds IList<string> Optional Filters results by CatalogObject ID.
Only applied when set. Default: unset.
LocationIds IList<string> Optional Filters results by Location ID. Only
applied when set. Default: unset.
Types IList<string> Optional Filters results by InventoryChangeType.
Default: [PHYSICAL_COUNT, ADJUSTMENT]. TRANSFER is not supported as
a filter.
See InventoryChangeType for possible values
States IList<string> Optional Filters ADJUSTMENT query results by
InventoryState. Only applied when set.
Default: unset.
See InventoryState for possible values
UpdatedAfter string Optional Provided as an RFC 3339 timestamp. Returns results whose
created_at or calculated_at value is after the given time.
Default: UNIX epoch (1970-01-01T00:00:00Z).
UpdatedBefore string Optional Provided as an RFC 3339 timestamp. Returns results whose
created_at or calculated_at value is strictly before the given time.
Default: UNIX epoch (1970-01-01T00:00:00Z).
Cursor string 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.

Example (as JSON)

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