Retrieve booking all bookings within the query parameters
GET ~/bookings/:booking-id
Parameters
| Field | Type | Description |
|---|---|---|
| :booking-id | String | The ID of the reservation you'd like to retrieve |
Response
| Field | 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 |
| status | String |
The current status of the booking. |
| ref | String |
Booking id in partner system. (Only available to the app that created the booking) |
| notes | String |
Free-text entry for additional booking details |
| consumer | Object |
Consumer details object. (Only available to the app that created the booking) |
| name | String |
Consumer name |
| 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 |
Checkin Id when the booking is taking place (allocated) at the venue |
| 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"],
"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"
}
},
"checkinId": null,
"updatedAt": "2016-08-18T04:58:38.485Z",
"createdAt": "2016-08-18T04:58:38.485Z",
"uri": "https://sandbox.doshii.co/partner/v3/bookings/129"
}
Comments
0 comments
Please sign in to leave a comment.