Retrieve all checkins within the query parameters
GET ~/checkins?from=:from&to=:to&updateFrom=:updatedFrom&updatedTo=:updatedTostatus=:active&limit=:limit&tableName=:tableName
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 checkin creation date and time (in Epoch-time), default is 60 mins ago |
tooptional | Integer |
Maximum checkin creation date and time (in Epoch-time), default is 60 mins ahead |
updateFromoptional | Integer |
Minimum checkin updated date and time (in Epoch-time), no default |
updateTooptional | Integer |
Maximum checkin creation date and time (in Epoch-time), no default |
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 |
tableNameoptional | String |
Single table name |
statusoptional | String |
String to return active or completed checkins, default is 'active' |
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 |
||||||||||||
covers | String |
The number of covers required |
||||||||||||
status | String |
The current check-in status. See Status for more information.
|
||||||||||||
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 |
||||||||||||
booking | Object |
Booking details object |
||||||||||||
id | String |
Booking id |
||||||||||||
date | String |
Booking date |
||||||||||||
app | String |
Booking app name |
||||||||||||
posTerminalId | String |
A hashed ID of the POS terminal that is associated to this checkin. Will not return if not set. |
||||||||||||
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",
"status":"accepted",
"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"
}
},
"booking":{
"id":"123",
"date":"06/10/11 15:24:16 +00:00",
"app":"ResDiary"
},
"completedAt": null,
"updatedAt": "2016-08-18T04:58:38.485Z",
"createdAt": "2016-08-18T04:58:38.485Z",
"uri": "https://sandbox.doshii.co/partner/v3/checkins/123"
}
]
Comments
0 comments
Please sign in to leave a comment.