PUT
Change a cashier status
Company space For: Manager · Permission: cashiers.update Conditions
  • The cash register must not be locked.
  • The cashier must belong to that register.
What else happens
  • Changes the status of the matching seller record on the same register. The seller is active only when the cashier is active and the register has is_seller turned on, otherwise it is set to inactive.
Part of Sellers and cashiers.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

cashRegisterId
string
required

Identifier of the cash register (27-character KSUID string).

cashierId
string
required

Identifier of the cashier record on this register (not the person's agent or user profile id).

Query Parameters

response
enum<string>
default:none

Response mode. Default none; none answers 204 No Content.

Available options:
none,
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, cash_register_id, cashable_id, status, last_login_at, created_at, updated_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: cashable.

Body

application/json
status
enum<string>

New status of the cashier: active (can open the register) or inactive. When omitted nothing changes.

Available options:
active,
inactive

Response

Resource (only with response=resource).

id

Identifier of the cashier record (27-character KSUID string).

cash_register_id

Identifier of the register the cashier is attached to.

cashable_id

Identifier of the person who is the cashier: an agent account or a user profile of the company.

status

Whether the cashier can open the register: active or inactive.

cashable
object | null

Identity of the person behind the cashier (first_name, last_name, username). Only present when requested with include. An agent account has no username; a user profile carries its member pseudo as username.

last_login_at

Time of the cashier's last register opening, ISO 8601. Null until the cashier has opened a register.

created_at

Date and time the record was created (ISO 8601, UTC).

updated_at

Date and time the record was last changed (ISO 8601, UTC).