Sign in

v1

latestOpenAPI 3.1.02026-08-06911,228852.2 KB
Reservations for Platforms

POS reservation updated notification

These notifications are sent to the URL provided in theposReservationUpdateWebhookUrl field.

postWebhookreservation-servicePOS reservation updated notification

Payload

platformCodestring

The unique code assigned to the reservation platform.

platformRestaurantIdstring

The external platform's unique identifier for the restaurant.

platformReservationIdstring

The external platform's unique identifier for the reservation.

businessLocationIdinteger

The unique identifier of the business location.

status'ON_HOLD' | 'SCHEDULED' | 'PARTIALLY_ARRIVED' | 'ARRIVED' | 'PARTIALLY_SEATED' | 'SEATED' | 'DEPARTED' | 'CANCELLED' | 'NO_SHOW' | 'ERROR' | 'PAID'

Extended Lightspeed reservation statuses.

tablesstring[]

Name of tables associated with the reservation.

coversinteger

The number of covers associated with the reservation.

Example payload

{
  "platformCode": "MyPlatform",
  "platformRestaurantId": "Restaurant-123",
  "platformReservationId": "Reservation-123",
  "businessLocationId": 9765040300495492,
  "status": "SEATED",
  "tables": [
    "1A",
    "2B"
  ]
}

Response

Your server returns this code if it accepts the callback.