Skip to content

Latest commit

 

History

History
47 lines (35 loc) · 2.54 KB

File metadata and controls

47 lines (35 loc) · 2.54 KB

BatchRetrieveInventoryChangesRequest

Description

Properties

Name Type Description Notes
catalogObjectIds List<String> Filters results by CatalogObject ID. Only applied when set. Default: unset. [optional]
locationIds List<String> Filters results by Location ID. Only applied when set. Default: unset. [optional]
types List<TypesEnum> Filters results by InventoryChangeType. Default: [`PHYSICAL_COUNT`, `ADJUSTMENT`]. `TRANSFER` is not supported as a filter. See InventoryChangeType for possible values [optional]
states List<StatesEnum> Filters `ADJUSTMENT` query results by InventoryState. Only applied when set. Default: unset. See InventoryState for possible values [optional]
updatedAfter String 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`). [optional]
updatedBefore String 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`). [optional]
cursor String 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 Pagination for more information. [optional]

Enum: List<TypesEnum>

Name Value
PHYSICAL_COUNT "PHYSICAL_COUNT"
ADJUSTMENT "ADJUSTMENT"
TRANSFER "TRANSFER"

Enum: List<StatesEnum>

Name Value
CUSTOM "CUSTOM"
IN_STOCK "IN_STOCK"
SOLD "SOLD"
RETURNED_BY_CUSTOMER "RETURNED_BY_CUSTOMER"
RESERVED_FOR_SALE "RESERVED_FOR_SALE"
SOLD_ONLINE "SOLD_ONLINE"
ORDERED_FROM_VENDOR "ORDERED_FROM_VENDOR"
RECEIVED_FROM_VENDOR "RECEIVED_FROM_VENDOR"
IN_TRANSIT_TO "IN_TRANSIT_TO"
NONE "NONE"
WASTE "WASTE"
UNLINKED_RETURN "UNLINKED_RETURN"