Skip to main content
POST
Start every draft session in the batch

Authorizations

Authorization
string
header
required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Path Parameters

batchId
integer
required

Response

The batch with its sessions now started.

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).

id
integer
uuid
string
name
string | null
scopeType
enum<string>

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.

Available options:
location,
item
countMode
enum<string>
Available options:
sku,
bin_location
isBlindCount
boolean

When true, counters do not see the expected quantity while counting.

categoryId
integer | null
subCategoryId
integer | null
preferredVendorId
integer | null
productIds
integer[] | null
lotIds
integer[] | null
remarks
string | null
createdBy
integer
createdAt
string<date-time>
updatedAt
string<date-time>
sessions
object[]

The per-warehouse sessions belonging to this batch.

sessionsCount
integer

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).

warning
string

Present only on the create response when scope_type=item and some selected products/lots had no stock and were dropped from the count.