Get a cycle count batch
Returns a batch with its per-warehouse sessions.
Authorizations
Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.
Path Parameters
Response
The batch with its per-warehouse sessions.
A cycle count batch — the top-level grouping created by POST /pickflow/cycle-counts. A batch fans out into one session per warehouse in scope (see sessions).
location (Scope Type A) counts whole warehouses/bins; item (Scope Type B) counts specific products or lots. Item scope requires the CS_8871_CYCLE_COUNT_LOCATION_SCOPE feature flag.
location, item sku, bin_location When true, counters do not see the expected quantity while counting.
The per-warehouse sessions belonging to this batch.
Total number of sessions in the batch. Present on the batch list/detail endpoints (redundant with sessions.length when the full collection is also returned).
Present only on the create response when scope_type=item and some selected products/lots had no stock and were dropped from the count.