Articles in this section

Get Table Bookings

Avatar
Greg
  • Updated
Follow

Retrieve all pending bookings on the given table within the query parameters.

GET ~/tables/:table-name/bookings?from=:from&to=:to&offset=:offset&limit=:limit

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

Parameters

Field Type Description
:table-name String

The name of the Table to retrieve Bookings for
fromoptional Integer

Minimum booking date and time (in Epoch-time), default is 60 mins ago
tooptional Integer

Maximum booking date and time (in Epoch-time), default is 60 mins ahead
offsetoptional Integer

Number of matching records to skip before returning the matches, default is 0
limitoptional Integer

Max number of records to return, default is 50, max is 250

Response

ield Type Description
id String

Booking id in Doshii
tableNames String[]

List of table names for the booking
date Date

Required reservation date & time
covers String

The number of covers required
notes String

Free-text entry for additional booking details
consumer Object

Consumer details object
  name String

Consumer name
  email String

Consumer email
  phone String

Consumer phone
  address Object

Consumer address details
    line1 String

The street number and name
    line2 String

Apartment/unit/level/suite
    city String

City
    state String

State
    postalCode String

Postal code
    country String

2-character Country Code. Eg: AU for Australia
app String

App name (source of booking)
updatedAt String

Date when the booking is last updated
createdAt String

Date when the booking is created
uri String

The object details url

Examples

Request

Response

[
 {
  "id":"129",
  "tableNames":["Table 1"],
  "date":"06/10/11 15:24:16 +00:00",
  "covers":"4",
  "notes":"Customer would like to be seated near window",
  "consumer":{
    "name":"4",
    "email":"user@test.com",
    "phone":"0415 123 456",
    "address":{
      "line1":"616 St Kilda Road",
      "line2":"Level 8",
      "city":"Melbourne",
      "state":"VIC",
      "postalCode":"3004",
      "country":"AU"
    }
  },
  "app":"ResDiary",
  "updatedAt": "2016-08-18T04:58:38.485Z",
  "createdAt": "2016-08-18T04:58:38.485Z",
  "uri": "https://sandbox.doshii.co/pos/v3/bookings/129"
 }
]

 

Comments

0 comments

Please sign in to leave a comment.