Sign in

v1

latestOpenAPI 3.1.02026-08-06911,228852.2 KB
Reservations for Platforms

Callback to Complete Onboarding

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

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

Path parameters

platform-codestring required

The unique code assigned to the reservation platform.

Example:MyPlatform

Request body

businessLocationIdinteger required

The unique identifier of the business location.

onboardingCode'ACCEPTED' | 'DONE' | 'ONBOARDING_EXPIRED' | 'ONBOARDING_ID_NOT_VALID' | 'PLATFORM_CODE_NOT_VALID' | 'BUSINESS_LOCATION_NOT_VALID' | 'PLATFORM_RESTAURANT_NOT_VALID' | 'PLATFORM_RESTAURANT_NOT_FOUND' | 'UNEXPECTED_ERROR' required

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

onboardingIdstring required

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

platformRestaurantIdstring required

The external platform's unique identifier for the restaurant.

Example request

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

Response

Accepted

onboardingCode'ACCEPTED' | 'DONE' | 'ONBOARDING_EXPIRED' | 'ONBOARDING_ID_NOT_VALID' | 'PLATFORM_CODE_NOT_VALID' | 'BUSINESS_LOCATION_NOT_VALID' | 'PLATFORM_RESTAURANT_NOT_VALID' | 'PLATFORM_RESTAURANT_NOT_FOUND' | 'UNEXPECTED_ERROR' required

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

Example response

{
  "onboardingCode": "DONE"
}