Articles in this section

Update Check-in

Avatar
John Twomey
  • Updated
Follow

Update a check-in

PUT ~/checkins/:checkin-id?checkTables=true

Headers

Field Type Description
doshii-location-id String

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

Query Parameters

Field Type Description
checkTablesoptional Boolean

A boolean for validating the tableName(s) against a location. Default is false.

Parameters

Field Type Description
:checkin-id String

The ID of the checkin you'd like to update
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
status String

The current checkin status. See Check-in State Machine for more information.
consumeroptional Object[]

Consumer details object
  nameoptional String

Customer name. Required when order.consumer is provided.
  emailoptional String

Customer email. Required when order.consumer is provided.
  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

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
status String

The current check-in status. See Status for more information.

status description
pending Check-in has been initiated
cancelled Partner has cancelled the Check-in
accepted POS has accepted the Check-in at the venue
rejected POS has rejected the Check-in request.
complete The Check-in is now complete
consumer Object

Consumer details object
  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 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

Request: Update a check-in

{
    "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"
        }
    }
}

Response

{
  "id":"123",
  "ref":"813889491",
  "tableNames":["Table 1"],
  "covers":"4",
  "status":"pending",
  "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/partner/v3/checkins/123"
}

 

Comments

0 comments

Please sign in to leave a comment.