Delete a check-in
DELETE ~/checkins/:checkin-id
Headers
Field | Type | Description |
---|---|---|
Authorization | String |
Bearer authentication token prefixed with |
Content-Type | String |
Request content type, must be 'application/json' |
vendor | String |
The POS vendor name retrieved from Doshii dashboard |
Parameters
Field | Type | Description |
---|---|---|
:checkin-id | String |
The ID of the checkin you'd like to delete |
Response
Field | Type | Description |
---|---|---|
id | String |
Checkin id in Doshii |
ref | String |
Checkin id in POS's system |
tableNames | String[] |
List of table names for the checkin |
date | Date |
Required reservation date & time in ISO8601 format |
covers | String |
The number of covers required |
consumer | Object |
Consumer details object |
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 |
completedAt | String |
Date when the checkin is closed |
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":"123",
"ref":"813889491",
"tableNames":["Table 1"],
"covers":"4",
"consumer":{
"name":"Tony",
"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"
}
},
"completedAt": null,
"updatedAt": "2016-08-18T04:58:38.485Z",
"createdAt": "2016-08-18T04:58:38.485Z",
"uri": "https://sandbox.doshii.co/pos/v3checkins/123"
}
Comments
0 comments
Please sign in to leave a comment.