Articles in this section

Get Tables

Avatar
Greg
  • Updated
Follow

Retrieve a list of tables

GET ~/tables?id=1,2,3&isActive=true&covers=4

Headers

Field Type Description
Authorization String

Bearer authentication token prefixed with Bearer and a space. See Authentication for more information.
Content-Type String

Request content type, must be 'application/json'
vendor String

The POS vendor name retrieved from Doshii dashboard
Accept-Encodingoptional String

Using compression on the response will improve the response times of this endpoint. Using this header will indicate to Doshii that the JSON response should be compressed (e.g. Accept-Encoding: gzip)

Parameters

Field Type Description
idoptional String

Comma separated list of table IDs.
isActiveoptional String

Retrieves all tables that have their isActive property matching the specified value.
coversoptional String

Retrieves all tables that have been configured to support at least the number of covers supplied.

Response

Field Type Description
name String

The name of the Table
maxCovers Integer

Seating capacity
isActive Boolean

Table status if it is on or off service
posId String

The internal ID of the table within the POS
criteria Object

Table properties if any
  isCommunal Boolean

Unrelated checkins can simultaneously be seated at this table
  canMerge Boolean

Can be be combined with other tables for larger seating capacity
  isSmoking Boolean

Is in smoking area
  isOutdoor Boolean

Exists in an outdoor setting (terrace, balcony, etc...)
updatedAt String

Date when the record is last updated
createdAt String

Date when the record is created
uri String

The object details url

 

Examples

Response


[
 {
  "name": "table1",
  "maxCovers": 4,
  "isActive": true,
  "criteria":{
     "canMerge": true,
     "isCommunal": true,
     "isSmoking": false,
     "isOutdoor": false
  },
  "updatedAt": "2016-08-18T04:58:38.485Z",
  "createdAt": "2016-08-18T04:58:38.485Z",
  "uri": "https://sandbox.doshii.co/pos/v3/tables/table1"
 }
]

 

Related articles

Comments

0 comments

Please sign in to leave a comment.