Skip to content

Latest commit

 

History

History
37 lines (29 loc) · 1.69 KB

batch-retrieve-inventory-counts-request.md

File metadata and controls

37 lines (29 loc) · 1.69 KB
Raw

Batch Retrieve Inventory Counts Request

Structure

Batch Retrieve Inventory Counts Request

Fields

Name Type Tags Description
catalog_object_ids List[str] Optional The filter to return results by CatalogObject ID.
The filter is applicable only when set. The default is null.
location_ids List[str] Optional The filter to return results by Location ID.
This filter is applicable only when set. The default is null.
updated_after str 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).
cursor str 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.
states str (List Inventory State) Optional The filter to return results by InventoryState. The filter is only applicable when set.
Ignored are untracked states of NONE, SOLD, and UNLINKED_RETURN.
The default is null.
limit int Optional The number of records to return.
Constraints: >= 1, <= 1000

Example (as JSON)

{
  "catalog_object_ids": [
    "W62UWFY35CWMYGVWK6TWJDNI"
  ],
  "location_ids": [
    "59TNP9SA8VGDA"
  ],
  "updated_after": "2016-11-16T00:00:00.000Z",
  "cursor": "cursor2",
  "states": [
    "RESERVED_FOR_SALE",
    "RETURNED_BY_CUSTOMER"
  ]
}