Skip to content

Latest commit

 

History

History
32 lines (24 loc) · 1.67 KB

batch-retrieve-inventory-counts-request.md

File metadata and controls

32 lines (24 loc) · 1.67 KB

Batch Retrieve Inventory Counts Request

Structure

BatchRetrieveInventoryCountsRequest

Fields

Name Type Tags Description
catalogObjectIds string[] | undefined Optional The filter to return results by CatalogObject ID.
The filter is applicable only when set. The default is null.
locationIds string[] | undefined Optional The filter to return results by Location ID.
This filter is applicable only when set. The default 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).
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.
states string[] | undefined 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 number | undefined 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"
}