Open Register Session
POST/api/pos/register-sessions
Opens a register session (shift) for the authenticated user, tied to a warehouse (the register's stock location). The opening float is the starting cash in the drawer.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
A user may only have ONE open session at a time — opening a second returns 422.
Body fields:
warehouse_id(integer, required) — the register's warehouse (must exist).opening_float(numeric, required, min 0) — starting cash in the drawer.
Authentication: Requires Bearer token (PAT).
Requires permission: pos.operate (when granular permissions are enabled).
Request
Responses
- 201
- 401
- 403
- 422
- 429
Created
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.
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.