Articles in this section

Get Bookings

Avatar
Greg
  • Updated
Follow

Retrieve booking all bookings within the query parameters.

GET ~/bookings

Headers 

Field Type Description
doshii-location-id String

The hashed ID of the location you're targeting. See Hashed Location IDs

Parameters 

Field Type Description
fromoptional Integer

Minimum booking date and time (seconds since Epoch) (Default: 60 minutes ago)
tooptional Integer

Maximum booking date and time (seconds since Epoch) (Default: 60 from now)
offsetoptional Integer

Number of matching records to skip before returning the matches (Default: 0)
limitoptional Integer

Max number of records to return (Default: 50)
seatedoptional Boolean

Include bookings with checkins (Default: false)

or

Field Type Description
refoptional String

The unique booking reference used when creating the booking. Querying by reference will return a single result or a 404.

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.
date Date

Required reservation date & time in ISO8601 format as UTC ("Z") time. eg. 2017-04-12T20:54:25Z.
covers String

The number of covers required
notes String

Free-text entry for additional booking details
ref String

Booking id in partner system. (Only available to the app that created the booking)
consumer Object

Consumer details object. (Only available to the app that created the booking)
  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
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: By Query

[
  {
    "id":"129",
    "tableNames":["Table 1"],
    "status": "pending",
    "date":"2016-04-12T20:54:25.289Z",
    "covers":"4",
    "notes":"Customer would like to be seated near window",
    "updatedAt": "2016-08-18T04:58:38.485Z",
    "createdAt": "2016-08-18T04:58:38.485Z",
    "uri": "https://sandbox.doshii.co/partner/v3/bookings/123"
  }
]

Response: By Reference

{
  "id":"129",
  "tableNames":["Table 1"],
  "status": "pending",
  "date":"2016-04-12T20:54:25.289Z",
  "covers":"4",
  "notes":"Customer would like to be seated near window",
  "ref":"813889491",
  "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"
    }
  },
  "updatedAt": "2016-08-18T04:58:38.485Z",
  "createdAt": "2016-08-18T04:58:38.485Z",
  "uri": "https://sandbox.doshii.co/partner/v3/bookings/129"
}

 

Related articles

Comments

0 comments

Please sign in to leave a comment.