input CreateRecountCycleCountInput

Fields

FieldTypeDescription
customer_account_idString

Use this when you are a 3PL acting on behalf of one of your customers

nameString!

Name for the cycle count batch.

warehouse_idString!

ID of the warehouse to count.

due_dateISODateTime

Due date for the cycle count. Defaults to 30 days from now.

sort_byString

Sort order for the generated cycle count tasks. Supported values: QUANTITY_ASC, QUANTITY_DESC, LOCATION_NAME_ASC, LOCATION_NAME_DESC, LAST_COUNTED_ASC, LAST_COUNTED_DESC, ITEM_NAME_ASC, ITEM_NAME_DESC.

max_itemsInt

Maximum number of items to include in the batch.

assigned_user_ids[String]

User IDs to assign to this cycle count.

skus[String]

List of SKUs to recount. If empty, all items with discrepancies are included.

client_ids[String]

Account IDs of clients to include (for 3PL accounts). Defaults to the current account.

vendor_ids[String]

Vendor IDs to filter items by.

tags[String]

Product tags to filter items by.

exclude_location_type_ids[String]

Location type IDs to exclude from the recount.

Referenced By

Example

{
  "customer_account_id": "abc123",
  "name": "abc123",
  "warehouse_id": "abc123",
  "due_date": "abc123",
  "sort_by": "abc123",
  "max_items": 987,
  "assigned_user_ids": "abc123",
  "skus": "abc123",
  "client_ids": "abc123",
  "vendor_ids": "abc123",
  "tags": "abc123",
  "exclude_location_type_ids": "abc123"
}