Articles in this section

Get Table Check-ins

Avatar
Greg
  • Updated
Follow

Retrieve the active checkins for a table. 

GET ~/tables/:table-name/checkins

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
:table-name String

The name of the table you'd like to retrieve checkins for

Response

Field Type Description
id String

Checkin id
covers String

The number of people covered by the checkin
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
createdAt Date

When the consumer was checked in to the venue
completedAt Date

When the consumer was checked out of the venue
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.
updatedAt String

Date when the record is last updated
uri String

The object details url

Examples

Response

[
  {
    "id": "123",
    "covers":"4",
    "status":"pending",
    "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": "2016-08-18T04:58:38.485Z",
    "createdAt": "2016-08-18T04:58:38.485Z",
    "uri": "https://sandbox.doshii.co/partner/v3/checkins/129"
  }
]

 

Related articles

Comments

0 comments

Please sign in to leave a comment.