Skip to main content

Desk Availability

Every counter order is placed at a desk (a counter or a table). Each desk has an enabled flag that controls whether customers can currently place orders at it.

Disabling a desk temporarily suspends ordering at that desk: customers browsing in the app, web, or kiosk cannot place new orders there until the desk is enabled again. Orders that were already placed are not affected -- you still manage their lifecycle as usual.

Typical use cases:

  • Closing time -- disable all desks when the restaurant closes, enable them again when it opens.
  • Temporary suspension -- pause incoming orders when the kitchen is overloaded or the POS is offline.
  • Selective availability -- disable only specific counters or tables (e.g. a section under maintenance).

List Your Desks

API: GET /v1/integrations/me/desks

Returns all desks that belong to your integration API key, including their current enabled state.

curl -X GET https://api.dev.votesess.com/v1/integrations/me/desks \
-H "X-API-Key: YOUR_API_KEY"

Response:

[
{
"id": "desk-001",
"name": "Counter 1",
"type": "COUNTER",
"enabled": true
},
{
"id": "desk-002",
"name": "Table 5",
"type": "TABLE",
"enabled": false
}
]

Enable or Disable Desks

API: PUT /v1/integrations/desks/status

Sets the enabled state for one or more desks in a single request. Use the desk id values returned by the list endpoint.

Disable desks (suspend ordering):

curl -X PUT https://api.dev.votesess.com/v1/integrations/desks/status \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"deskIds": ["desk-001", "desk-002"], "enabled": false}'

Enable desks (resume ordering):

curl -X PUT https://api.dev.votesess.com/v1/integrations/desks/status \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"deskIds": ["desk-001", "desk-002"], "enabled": true}'

The response contains the updated desks in the same format as the list endpoint.

FieldTypeDescription
deskIdsarray of stringsThe ids of the desks in the Cheers system. Must contain at least one unique id.
enabledbooleantrue to allow ordering at the desks, false to suspend it.
Closing hours automation

If your POS knows the venue's opening hours, you can automate this: disable all desks at closing time and enable them again at opening time, so customers never place orders that nobody will fulfill.