Lightspeed · JSON Structure

Restaurant K Series Reservation Service Onboarding Callback Response Structure

reservation-serviceOnboardingCallbackResponse schema from Lightspeed Restaurant K Series API

Type: object Properties: 1 Required: 1
POSRetailRestaurantEcommerce

reservation-serviceOnboardingCallbackResponse is a JSON Structure definition published by Lightspeed, describing 1 property, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

onboardingCode

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$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-response-structure.json",
  "name": "reservation-serviceOnboardingCallbackResponse",
  "description": "reservation-serviceOnboardingCallbackResponse schema from Lightspeed Restaurant K Series API",
  "type": "object",
  "properties": {
    "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"
    }
  },
  "required": [
    "onboardingCode"
  ]
}