Articles in this section

Create Booking Check-In

Avatar
Greg
  • Updated
Follow

Creates a checkin based on the booking info which can be overridden

POST ~/bookings/:booking-id/checkin

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
doshii-terminal-id  String 

The hashed Id of a POS Terminal registered within Doshii via the Create POS Terminal endpoint

Parameters

Field Type Description
:booking-id String

The id of the Booking to create a Checkin for
refoptional String

Checkin id in POS system
tableNamesoptional Object[]

List of names 'in case of more than a table required for the checkin'
coversoptional String

The number of covers required
statusoptional String

The current checkin status. Default is "pending". See Check-in State Machine for more information.
consumeroptional Object

Consumer details object
  nameoptional String

Customer name
  emailoptional String

Customer email
  phoneoptional String

Customer phone
  addressoptional Object

Consumer address details
    line1optional String

The street number and name
    line2optional String

Apartment/unit/level/suite
    cityoptional String

City
    stateoptional String

State
    postalCodeoptional String

Postal code
    countryoptional String

2-character Country Code. Eg: AU for Australia

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
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
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
checkin Object

An object containing Checkin details.
  id String

The checkin ID
  ref String

Checkin id in POS system
  tableNames String

Array of table names used in the checkin.
  covers String

Number of covers
  bookingId String

The id of the associated booking
  updatedAt String

Checkin last update date
  createdAt String

Checkin creation date
  uri String

URI of the Checkin

Examples

Request: Create a checkin from the booking

{
    "ref": "813234",
    "tableNames": [
        "Table 1"
    ],
    "covers": "4"
}

Response

{
  "id":"765",
  "ref":"7645784",
  "tableNames":["Table 1"],
  "covers":"4",
  "date":"2018-03-17T20:20:00.264Z",
  "status":"arrived",
  "checkinId":"123",
  "checkin":{
     "uri":"https://sandbox.doshii.co/pos/v3/checkins/123",
     "updatedAt":"2018-03-17T20:10:00.264Z",
     "ref": "813234",
     "bookingId": "765",
     "tableNames":[
         "Table 1"
     ],
     "id":"123",
     "createdAt":"2018-03-17T20:10:00.264Z",
     "covers":4,
     "status":"pending",
     "completedAt":null
   },
  "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": "2018-03-17T20:10:00.264Z",
  "createdAt": "2018-03-17T20:09:00.264Z",
  "version":"LYKkPOEdM2uXpzKLpWaVhdWzONvyWnImnavrmB2q",
  "log":"https://sandbox.doshii.co/pos/v3/bookings/765/logs",
  "uri": "https://sandbox.doshii.co/pos/v3/bookings/765"
}

 

Related articles

Comments

0 comments

Please sign in to leave a comment.