Restaurant K Series Reservation Service Onboarding Callback Request Structure
reservation-serviceOnboardingCallbackRequest schema from Lightspeed Restaurant K Series API
Type: objectProperties: 4Required: 4
Point-of-SaleRetailRestaurantE-Commerce
reservation-serviceOnboardingCallbackRequest is a JSON Structure definition published by Lightspeed, describing 4 properties, of which 4 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/lightspeed-pos/refs/heads/main/json-structure/restaurant-k-series-reservation-service-onboarding-callback-request-structure.json",
"name": "reservation-serviceOnboardingCallbackRequest",
"description": "reservation-serviceOnboardingCallbackRequest schema from Lightspeed Restaurant K Series API",
"type": "object",
"properties": {
"businessLocationId": {
"description": "The unique identifier of the business location.",
"example": 9765040300495493,
"type": "int64"
},
"onboardingCode": {
"description": "The machine code to interact with the external platform during the onboarding process.",
"enum": [
"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"
],
"example": "DONE",
"type": "string"
},
"onboardingId": {
"description": "The unique identifier of the integration process that has started onboarding.",
"example": "84f16177-98c5-4010-a7ab-d00144d1dede",
"type": "string"
},
"platformRestaurantId": {
"description": "The external platform's unique identifier for the restaurant.",
"example": "Restaurant-123",
"pattern": "[a-zA-Z0-9_-]+",
"type": "string"
}
},
"required": [
"onboardingId",
"onboardingCode",
"platformRestaurantId",
"businessLocationId"
]
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.