Callback to Complete Onboarding

POST /reservation/api/1/platform/{platform-code}/integration/onboarding

OAuth2

Once the external platform receives the onboarding webhook, the process needs to be completed using this callback.

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

application/json

Body Required

businessLocationId integer(int64) Required

The unique identifier of the business location.
onboardingCode string Required

The machine code to interact with the external platform during the onboarding process.

Values are ACCEPTED, DONE, ONBOARDING_EXPIRED, ONBOARDING_ID_NOT_VALID, PLATFORM_CODE_NOT_VALID, BUSINESS_LOCATION_NOT_VALID, PLATFORM_RESTAURANT_NOT_VALID, PLATFORM_RESTAURANT_NOT_FOUND, or UNEXPECTED_ERROR.
onboardingId string Required

The unique identifier of the integration process that has started onboarding.
platformRestaurantId string Required

The external platform's unique identifier for the restaurant.

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

Responses

200 application/json

Accepted
Hide response attribute Show response attribute object
- onboardingCode string Required
  
  The machine code to interact with the external platform during the onboarding process.
  
  Values are ACCEPTED, DONE, ONBOARDING_EXPIRED, ONBOARDING_ID_NOT_VALID, PLATFORM_CODE_NOT_VALID, BUSINESS_LOCATION_NOT_VALID, PLATFORM_RESTAURANT_NOT_VALID, PLATFORM_RESTAURANT_NOT_FOUND, or UNEXPECTED_ERROR.
400 application/json

Non relevant request
Hide response attribute Show response attribute object
- onboardingCode string Required
  
  The machine code to interact with the external platform during the onboarding process.
  
  Values are ACCEPTED, DONE, ONBOARDING_EXPIRED, ONBOARDING_ID_NOT_VALID, PLATFORM_CODE_NOT_VALID, BUSINESS_LOCATION_NOT_VALID, PLATFORM_RESTAURANT_NOT_VALID, PLATFORM_RESTAURANT_NOT_FOUND, or UNEXPECTED_ERROR.
403

Scope 'reservation-{platform-code}' not found in the token
404 application/json

Platform not found
Hide response attribute Show response attribute object
- onboardingCode string Required
  
  The machine code to interact with the external platform during the onboarding process.
  
  Values are ACCEPTED, DONE, ONBOARDING_EXPIRED, ONBOARDING_ID_NOT_VALID, PLATFORM_CODE_NOT_VALID, BUSINESS_LOCATION_NOT_VALID, PLATFORM_RESTAURANT_NOT_VALID, PLATFORM_RESTAURANT_NOT_FOUND, or UNEXPECTED_ERROR.

POST /reservation/api/1/platform/{platform-code}/integration/onboarding

curl \
 -X POST https://api.trial.lsk.lightspeed.app/reservation/api/1/platform/MyPlatform/integration/onboarding \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"businessLocationId":9765040300495493,"onboardingCode":"DONE","onboardingId":"84f16177-98c5-4010-a7ab-d00144d1dede","platformRestaurantId":"Restaurant-123"}'

Request examples

{
  "businessLocationId": 9765040300495493,
  "onboardingCode": "DONE",
  "onboardingId": "84f16177-98c5-4010-a7ab-d00144d1dede",
  "platformRestaurantId": "Restaurant-123"
}

Response examples (200)

{
  "onboardingCode": "DONE"
}

Response examples (400)

{
  "onboardingCode": "DONE"
}

Response examples (404)

{
  "onboardingCode": "DONE"
}