Initiate Count
POST/api/stock-takes/:stockTake/initiate
Transition a stock take from Draft to Open status. Takes an inventory snapshot for all items.
inventory:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token.
exclude_product_ids: optional array of product IDs to remove before initiating.
is_integrity_fix: if true, marks as integrity fix count.
date_count: optional retroactive count date (Y-m-d, app timezone, must be today or earlier). Use it when the physical count was performed earlier than it is being entered - the resulting inventory movements, FIFO layers and accounting journal are dated to it (so a historical 'as of' inventory valuation reflects the count), while the snapshot cutoff for reconciling movements made during the count stays at the real initiate moment. Omit to date the count as of now.
Returns 400 if stock take is in adjustment mode (use finalize-adjustment instead), if all items are excluded, or if date_count falls within a locked accounting period. Returns 422 if date_count is in the future.
Requires permission: inventory.count
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Content
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.