Cash Registers

Manage cash registers used at the point of sale. Each cash register has a default printer and can be enabled or disabled.

Cash Register Object

{
  "id": "clx1a2b3c4d5e6f7g8h9i0j1",
  "name": "Bar Cash Register",
  "enabled": true,
  "defaultPrinterId": "clx1a2b3c4d5e6f7g8h9i0j1"
}

GET /v1/cash-registers

Retrieve all cash registers.

Authentication: Bearer token

Query Parameters

Response 200 OK

[
  {
    "id": "clx1a2b3c4d5e6f7g8h9i0j1",
    "name": "Bar Cash Register",
    "enabled": true,
    "defaultPrinterId": "clx1a2b3c4d5e6f7g8h9i0j1"
  }
]

GET /v1/cash-registers/{id}

Retrieve a single cash register by ID.

Authentication: Bearer token

Path Parameters

Query Parameters

Response 200 OK

Returns a Cash Register Object.

Errors

POST /v1/cash-registers

Create a new cash register.

Authentication: Bearer token (admin)

Request Body

{
  "name": "Bar Cash Register",
  "enabled": true,
  "defaultPrinterId": "clx1a2b3c4d5e6f7g8h9i0j1"
}

Response 201 Created

Returns the created Cash Register Object.

Errors

PUT /v1/cash-registers/{id}

Update an existing cash register.

Authentication: Bearer token (admin)

Path Parameters

Request Body

Same as POST.

Response 200 OK

Returns the updated Cash Register Object.

Errors

PATCH /v1/cash-registers/{id}

Update the enabled status of a cash register.

Authentication: Bearer token (admin)

Path Parameters

Request Body

{
  "enabled": false
}

Response 200 OK

Returns the updated Cash Register Object.

Errors

DELETE /v1/cash-registers/{id}

Delete a cash register.

Authentication: Bearer token (admin)

Path Parameters

Response 200 OK

Errors