Get Sample Onboarding Notification

GET /reservation/api/1/platform/{platform-code}/onboarding-webhook-sample
OAuth2

Returns an example of an onboarding notification. These notifications are sent to the URL provided in theonboardingWebhookUrl field.

Path parameters

  • platform-code string Required

    The unique code assigned to the reservation platform.

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

Responses

  • • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • platformCode string Required

      The unique code assigned to the reservation platform.

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

    • platformRestaurantReference string Required

      The alias for a restaurant on an external platform, such as its ID or local unique name.

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

    • onboardingId string Required

      The unique ID of the integration process that has started onboarding.

    • epochSecondsDeadlineUtc integer(int64) Required

      The epoch time in seconds until which the onboarding process remains active.

    • businessInformation object Required
      Hide businessInformation attributes Show businessInformation attributes
      • businessLocationId integer(int64) Required

        The K-Series business location ID.

      • name string Required

        The trade name in Lightspeed Backoffice.

      • street1 string

        The primary street of the trade.

      • street2 string

        The secondary street of the trade.

      • city string

        The city of the trade.

      • state string

        The state of the trade.

      • country string

        The country code of the trade.

      • zip string

        The zip code of the trade.
GET /reservation/api/1/platform/{platform-code}/onboarding-webhook-sample 
curl \
 -X GET https://api.lsk.lightspeed.app/reservation/api/1/platform/MyPlatform/onboarding-webhook-sample \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "platformCode": "MyPlatform",
  "platformRestaurantReference": "Schnitzel_and_Kartoffel",
  "onboardingId": "84f16177-98c5-4010-a7ab-d00144d1dede",
  "epochSecondsDeadlineUtc": 1711628625,
  "businessInformation": {
    "businessLocationId": 9765040300495493,
    "name": "Le Gâteau",
    "street1": "Rue de la Servette 10",
    "street2": "Suite 2",
    "city": "Genève",
    "state": "Canton de Genève",
    "country": "CH",
    "zip": "101201"
  }
}