Sites

Sites are physical locations, such as outlets, offices etc, at which one or more Kountas will be used.

Get all sites

GET /v1/companies/5678/sites Get all sites
GET /v1/companies/5678/staff/me/sites Get sites for the authenticated staff member
GET /v1/companies/5678/staff/389427/sites Get sites for a given staff member

Get a site

GET /v1/companies/5678/sites/923 Get a site by ID
GET /v1/companies/5678/registers/927/site Get the site for a given register

Update an existing site

PUT /v1/companies/5678/sites/923 Update an existing site
  • Set the image property to null to delete an uploaded image, or any valid, public URL to use an online image. See Images for how to upload site images directly to Kounta.

Check the status of a site

A site is online if at least one device is currently in use at the site. Otherwise it is offline.

GET /v1/companies/5678/sites/927/status Get the status for a given site

Check status of all authorised sites

This endpoint will include the status for all sites that the current client has access to. A site ID will be shown as online if at least one device is currently in use at the site. Otherwise it will be shown as offline.

GET /v1/sites_status Get status for all sites

Webhooks

Here is a list of the supported webhook topics.

sites/created

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

sites/updated

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

You also may provide the following attribute filters:

  • name
  • email
  • address - if either shipping_address or postal_address are updated.
  • image
  • price_list - only if the associated price list is changed, if the items on the price list itself are changed this will not trigger the webhook.

sites/deleted

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