Lightspeed · Example Payload

Restaurant K Series Reservation Service Platform Profile Response Example

POSRetailRestaurantEcommerce

Restaurant K Series Reservation Service Platform Profile Response Example is an example object payload from Lightspeed, with 14 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

baseUrldepositSupporteddisplayNameerrorsWebhookUrlintegrationWebhookUrlnotificationTypesonboardingWebhookUrlorderWebhookUrlposReservationUpdateWebhookUrlownNotificationsOnlywebhookAuthTypeallowCourseNumberUpdatesinServiceTableStatusesallowedPosStatuses

Example Payload

Raw ↑ 
{
  "baseUrl": "https://my.platform/api/lsk",
  "depositSupported": true,
  "displayName": "My Platform",
  "errorsWebhookUrl": "https://my.platform/api/lsk/webhook/errors",
  "integrationWebhookUrl": "https://my.platform/api/lsk/webhook/integrations",
  "notificationTypes": [
    "ORDER_CLOSED"
  ],
  "onboardingWebhookUrl": "https://my.platform/api/lsk/webhook/onboarding",
  "orderWebhookUrl": "https://my.platform/api/lsk/webhook/orders",
  "posReservationUpdateWebhookUrl": "https://my.platform/api/lsk/webhook/reservation",
  "ownNotificationsOnly": true,
  "webhookAuthType": "OAUTH2",
  "allowCourseNumberUpdates": true,
  "inServiceTableStatuses": [
    {
      "statusLabel": "Appetizer",
      "statusValue": "appetizer",
      "sequence": 1
    }
  ],
  "allowedPosStatuses": [
    "SCHEDULED"
  ]
}