Seating of a reservation Deprecated

POST /r/reservation/1/checkin
O auth2

Assign a reservation to a table

application/json

Body Required

  • businessLocationId integer(int64) Required

    Business Location ID as defined in K-series

  • customerCount integer(int32)

    Number of seats for the reservation

  • customerInfo object Required

    Basic customer information

    Hide customerInfo attributes Show customerInfo attributes object
    • contactNumberAsE164 string

      Contact number formatted in E164

    • email string Required
    • firstName string Required
    • lastName string
    • notes string

      Customer notes

    • rating number(float)
    • thirdPartyReference string Required

      Unique ID for you to tie this customer record back to yours

    • vip boolean
  • endPointId string Required

    Identifies the previously registered endpoint to use for Webhook notifications

  • notes array[object]

    An Array of notes

    An Array of notes

    Hide notes attribute Show notes attribute object
    • note string

      A note to add to the reservation

  • reservationReference string Required

    Unique ID for you to tie the callback events to this action

  • specialOffer string Deprecated

    Deprecated - use notes instead

  • table string Required

    Table name or number

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • error boolean
    • errorMessage string
    • responseEntity object

      A JSON object representing the response data
POST /r/reservation/1/checkin 
curl \
 --request POST 'https://api.trial.lsk.lightspeed.app/r/reservation/1/checkin' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"businessLocationId":42,"customerCount":42,"customerInfo":{"contactNumberAsE164":"string","email":"string","firstName":"string","lastName":"string","notes":"string","rating":42.0,"thirdPartyReference":"string","vip":true},"endPointId":"string","notes":[{"note":"string"}],"reservationReference":"string","specialOffer":"string","table":"string"}'
Request examples 
{
  "businessLocationId": 42,
  "customerCount": 42,
  "customerInfo": {
    "contactNumberAsE164": "string",
    "email": "string",
    "firstName": "string",
    "lastName": "string",
    "notes": "string",
    "rating": 42.0,
    "thirdPartyReference": "string",
    "vip": true
  },
  "endPointId": "string",
  "notes": [
    {
      "note": "string"
    }
  ],
  "reservationReference": "string",
  "specialOffer": "string",
  "table": "string"
}
Response examples (200) 
{
  "error": true,
  "errorMessage": "string",
  "responseEntity": {}
}