input CreateLocationsCycleCountInput

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 locations to include in the batch.

assigned_user_ids[String]

User IDs to assign to this cycle count.

prefixes[String]

Location name prefixes to include (e.g. ['A-', 'B-']).

location_type_ids[String]

Location type IDs to include.

client_ids[String]

Account IDs of clients to include (for 3PL accounts).

exclusion_filtersExclusionFiltersInput

Exclusion filters to narrow the set of locations included.

Referenced By

Example

{
  "customer_account_id": "QWNjb3VudDoxMjM0",
  "name": "2",
  "warehouse_id": "V2FyZWhvdXNlOjEyMzQ=",
  "due_date": "2026-07-09T15:30:00Z",
  "sort_by": "QUANTITY_ASC",
  "max_items": 2,
  "assigned_user_ids": ["Q3ljbGVDb3VudEJhdGNoOjEyMzQ=", "Q3ljbGVDb3VudEJhdGNoOjU2Nzg="],
  "prefixes": ["A-", "B-"],
  "location_type_ids": ["TG9jYXRpb25UeXBlOjEyMzQ=", "TG9jYXRpb25UeXBlOjU2Nzg="],
  "client_ids": ["QWNjb3VudDoxMjM0", "QWNjb3VudDo1Njc4"],
  "exclusion_filters": {id: "TG9jYXRpb246MTIzNA==", name: "A01-01-01"}
}