object CycleCountBatch

Fields

Field	Type	Description
`id`	`String`	Public API ID for this identifiable.
`legacy_id`	BigInt	Numeric legacy ID for this identifiable; use only where legacy IDs are required.
`name`	`String`	Human-readable name for this cycle count batch.
`warehouse_id`	`String`	Public API warehouse ID. Use this when passing or filtering by a warehouse; warehouse fields are display values or nested objects.
`account_id`	`String`	Public API account ID that identifies the related record.
`count_type`	DSCycleCountBatchCountTypes	Count type for this cycle count batch.
`queue_status`	DSCycleCountBatchQueueStatusTypes	Current queue status; use the API status values returned by this field when filtering or updating.
`status`	`String`	uncounted \| in_progress \| closed.
`progress`	`Int`	Percentage of items counted (0-100).
`counted`	`Int`	Number of items counted.
`uncounted`	`Int`	Number of items not yet counted.
`due_date`	ISODateTime	Due date in ISO-8601 date or datetime format, returned in UTC when time is included.
`started_at`	ISODateTime	Started at as an ISO-8601 datetime, returned in UTC unless otherwise noted.
`ended_at`	ISODateTime	Ended at as an ISO-8601 datetime, returned in UTC unless otherwise noted.
`created_at`	ISODateTime	Created at as an ISO-8601 datetime, returned in UTC unless otherwise noted.
`updated_at`	ISODateTime	Updated at as an ISO-8601 datetime, returned in UTC unless otherwise noted.
`locations`	CycleCountProgressType	Location count progress (total/counted).
`skus`	CycleCountProgressType	SKU count progress (total/counted).

Referenced By

Example

{
  "id": "UmVjb3JkOjEyMzQ=",
  "legacy_id": 1234,
  "name": "2",
  "warehouse_id": "Q3ljbGVDb3VudEJhdGNoOjEyMzQ=",
  "account_id": "Q3ljbGVDb3VudEJhdGNoOjEyMzQ=",
  "count_type": "{id: \"Q3ljbGVDb3VudEJhdGNoQ291bnRUeXBlOjEyMzQ=\"}",
  "queue_status": "{id: \"Q3ljbGVDb3VudEJhdGNoUXVldWVTdGF0dXM6MTIzNA==\"}",
  "status": "pending",
  "progress": 2,
  "counted": 2,
  "uncounted": 2,
  "due_date": "2026-07-09T15:30:00Z",
  "started_at": "2026-07-09T15:30:00Z",
  "ended_at": "2026-07-09T15:30:00Z",
  "created_at": "2026-07-09T15:30:00Z",
  "updated_at": "2026-07-09T15:30:00Z",
  "locations": {id: "TG9jYXRpb246MTIzNA==", name: "A01-01-01"},
  "skus": {id: "Q3ljbGVDb3VudFByb2dyZXNzVHlwZToxMjM0"}
}