POS reservation updated notification

POST https://webhook.example.com

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

application/json

Body Required

  • platformCode string

    The unique code assigned to the reservation platform.

    Maximum length is 11. Format should match the following pattern: [a-zA-Z0-9_-]+.

  • platformRestaurantId string

    The external platform's unique identifier for the restaurant.

    Format should match the following pattern: [a-zA-Z0-9_-]+.

  • platformReservationId string

    The external platform's unique identifier for the reservation.

    Maximum length is 36. Format should match the following pattern: [a-zA-Z0-9_-]+.

  • businessLocationId integer(int64)

    The unique identifier of the business location.

  • status string

    Extended Lightspeed reservation statuses.

    Values are ON_HOLD, SCHEDULED, PARTIALLY_ARRIVED, ARRIVED, PARTIALLY_SEATED, SEATED, DEPARTED, CANCELLED, NO_SHOW, ERROR, or PAID.

  • tables array[string]

    Name of tables associated with the reservation.

  • covers integer(int32)

    The number of covers associated with the reservation.

Responses

  • 200

    Your server returns this code if it accepts the callback.

POST POS reservation updated notification
Request examples 
{
  "platformCode": "MyPlatform",
  "platformRestaurantId": "Restaurant-123",
  "platformReservationId": "Reservation-123",
  "businessLocationId": 9765040300495493,
  "status": "PAID",
  "tables": [
    "1A",
    "2B"
  ],
  "covers": 42
}