Articles in this section

Get Booking

Avatar
Greg
  • Updated
Follow

Retrieve the details of a specific booking

GET ~/bookings/:booking-id

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
:booking-id String

The id of the Booking to retrieve

Response

Field Type Description
id String

Booking id in Doshii
tableNames String[]

List of table names for the booking
status String

The current status of the booking. One of ['pending', 'rejected', 'accepted', 'acknowledged', 'cancelled', 'cust_cancelled'].
date Date

Required reservation date & time in ISO8601 format
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
checkinId String

Id of the Checkin resource
app String

App name (source of booking)
posTerminalId String

A hashed ID of the POS terminal that is associated to this booking. Will not return if not set.
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

{
  "id":"129",
  "tableNames":["Table 1"],
  "status":"pending",
  "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"
    }
  },
  "checkinId": null,
  "app": "ResDiary",
  "updatedAt": "2016-08-18T04:58:38.485Z",
  "createdAt": "2016-08-18T04:58:38.485Z",
  "uri": "https://sandbox.doshii.co/pos/v3checkins/123"
}

 

Related articles

Comments

0 comments

Please sign in to leave a comment.