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

  • businessInformation object Required

    Additional properties are allowed.

    Hide businessInformation attributes Show businessInformation attributes object

    • businessLocationId integer(int64) Required

      The K-Series business location ID.

    • city string

      The city of the company.

    • country string

      The country code of the company.

    • name string Required

      The company name in Lightspeed Backoffice.

    • state string

      The state of the company.

    • street1 string

      The primary street of the company.

    • street2 string

      The secondary street of the company.

    • zip string

      The zip code of the company.

  • epochSecondsDeadlineUtc integer(int64) Required

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

  • onboardingId string Required

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

  • 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_-]+.