POST
Open a cash register session
Company space For: Cashier and seller Conditions
  • The register must be closed and must not be locked.
  • The device (cash_register_instance_id) must be active, belong to this register, and its secret must match; a wrong secret is refused with 403.
  • If the device is linked to a POS sync instance, that instance must still be active on the same computer.
  • The caller must be an active cashier of this register.
  • The caller cannot already be the current cashier of another open register of the company.
  • No register session may remain open on this register.
What else happens
  • Marks the register open and sets the caller as its current cashier.
  • Sets the cashier last_login_at.
  • Starts a register session on the computer whose opening balance is the current balance of the register’s ledger account (in minor units).
  • Refreshes the last seen time of the device.
  • Returns a login token carrying the register, cashier, seller and device identifiers.
Part of Run a register session.

Authorizations

Authorization
string
header
required

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

Path Parameters

cashRegister
string
required

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

Body

application/json
cash_register_instance_id
string
required

Identifier of the device (cash register instance) used to open the register. It must be active and linked to this register.

Required string length: 27
cash_register_instance_secret
string
required

Secret of the device: 64 lowercase hexadecimal characters. A wrong secret is refused with 403.

Required string length: 64

Response

JsonResource

The response is of type string.