Registers

Registers are iPads or other computers running Kounta by Lightspeed.

Get registers

GET /v1/companies/5678/registers.json Get all registers
GET /v1/companies/5678/sites/985/registers.json Get all registers for a given site 
[
  {
    "id": 9091,
    "code": "T1",
    "name": "Terminal 1",
    "site_id": 985
  },
  {
    "id": 9085,
    "code": "T2",
    "name": "Terminal 2",
    "site_id": 985
  }
]
  • The site_id field will be omitted if you get registers by site.

Get a register

GET /v1/companies/5678/registers/9091.json Get a register 
{
  "id": 9091,
  "company_id": 5678,
  "code": "T1",
  "name": "Terminal 1",
  "site": {
    "id": 985,
    "name": "Downtown",
    "code": "DT"
  },
  "current_staff_member": {
    "id": 389427,
    "first_name": "Jamie",
    "last_name": "McDonald"
  },
  "sale_prefix": "ST1-",
  "return_prefix": "RT1-",
  "assigned_to_device": true
}

List of Webhooks

Here is a list of the supported webhook topics.

registers/created

When a register is created. You will receive the complete register.

registers/updated

When a register is updated. You will receive the complete register after the modifications have been applied.

You also may provide the following attribute filters:

  • name
  • current_staff_member
  • assigned_to_device

registers/deleted

When a register is deleted. You will receive the complete register.