Lightspeed Commerce Reservations for Platforms API

openapi: 3.2.0
info:
  version: 1.0.0
  title: Lightspeed Restaurant K Series Reservations for Platforms API
  description: '**Lightspeed Restaurant** offers a **REST API** in order to communicate with the data in the system. These APIs are built using the RESTful standards and adhere to the basic verb interactions as defined by the REST standard.

    Detailed developer guides can be found in the [Lightspeed Restaurant API Portal](https://api-portal.lsk.lightspeed.app/).

    These services are in continuous development and subject to change. Please find our versioning policy [here](https://api-portal.lsk.lightspeed.app/quick-start/versioning).

    '
  x-logo:
    altText: Lightspeed Commerce
    url: static/lightspeed@2x.png
servers:
- url: https://api.trial.lsk.lightspeed.app
  description: Demo URL
  x-bump-branch-name: demo
- url: https://api.lsk.lightspeed.app
  description: Production URL
  x-bump-branch-name: prod
tags:
- name: Reservations for Platforms
paths:
  /reservation/api/1/platform/{platform-code}/integration/onboarding:
    post:
      description: Once the external platform receives the [onboarding webhook](https://api-docs.lsk.lightspeed.app/operation/operation-reservationonboardingnotification), the process needs to be completed using this callback.
      operationId: reservation-serviceOnboardingCallback
      parameters:
      - in: path
        name: platform-code
        required: true
        schema:
          $ref: '#/components/schemas/reservation-servicePlatformCode'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/reservation-serviceOnboardingCallbackRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/reservation-serviceOnboardingCallbackResponse'
          description: Accepted
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/reservation-serviceOnboardingCallbackResponse'
          description: Non relevant request
        '403':
          description: Scope 'reservation-{platform-code}' not found in the token
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/reservation-serviceOnboardingCallbackResponse'
          description: Platform not found
      security:
      - OAuth2:
        - reservation-platform-code
      summary: Callback to Complete Onboarding
      tags:
      - Reservations for Platforms
  /reservation/api/1/platform/{platform-code}/profile:
    get:
      description: Retrieve platform profile details.
      operationId: reservation-serviceGetByPlatformCode
      parameters:
      - in: path
        name: platform-code
        required: true
        schema:
          $ref: '#/components/schemas/reservation-servicePlatformCode'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/reservation-servicePlatformProfileResponse'
          description: Platform profile details
        '400':
          description: Non relevant request
        '403':
          description: Scope 'reservation-{platform-code}' not found in the token
      security:
      - OAuth2:
        - reservation-platform-code
      summary: Platform Profile Details
      tags:
      - Reservations for Platforms
    post:
      description: Create or update details for external reservation platform.
      operationId: reservation-serviceSetByPlatformCode
      parameters:
      - in: path
        name: platform-code
        required: true
        schema:
          $ref: '#/components/schemas/reservation-servicePlatformCode'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/reservation-servicePlatformProfile'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/reservation-servicePlatformProfileResponse'
          description: Platform profile details
        '400':
          description: Non relevant request
        '403':
          description: Scope 'reservation-{platform-code}' not found in the token
      security:
      - OAuth2:
        - reservation-platform-code
      summary: Create or Update Platform Profile
      tags:
      - Reservations for Platforms
  /reservation/api/1/platform/{platform-code}/course-settings:
    patch:
      description: Setup platform's course settings definition.
      operationId: reservation-servicePlatformCourseSettings
      parameters:
      - in: path
        name: platform-code
        required: true
        schema:
          $ref: '#/components/schemas/reservation-servicePlatformCode'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/reservation-servicePlatformCourseSettingsDto'
      responses:
        '200':
          description: Accepted
        '400':
          description: Non relevant request
        '403':
          description: Scope 'reservation-{platform-code}' not found in the token
      security:
      - OAuth2:
        - reservation-platform-code
      summary: Platform course settings definition
      tags:
      - Reservations for Platforms
  /reservation/api/1/platform/{platform-code}/restaurant/{platform-restaurant-id}/reservation/{platform-reservation-id}/push:
    put:
      description: Create a new reservation or provide updates about guests, deposits, status, etc.
      operationId: reservation-servicePushPlatformReservation
      parameters:
      - in: path
        name: platform-code
        required: true
        schema:
          $ref: '#/components/schemas/reservation-servicePlatformCode'
      - in: path
        name: platform-restaurant-id
        required: true
        schema:
          $ref: '#/components/schemas/reservation-servicePlatformRestaurantId'
      - description: The external identifier of the reservation.
        in: path
        name: platform-reservation-id
        required: true
        schema:
          $ref: '#/components/schemas/reservation-servicePlatformReservationId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/reservation-servicePlatformReservation'
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/reservation-servicePlatformReservationAcceptedDto'
        '400':
          description: Non relevant request
        '403':
          description: Scope 'reservation-{platform-code}' not found in the token
        '404':
          description: Integration not found
      security:
      - OAuth2:
        - reservation-platform-code
      summary: Create or Update Reservation
      tags:
      - Reservations for Platforms
  /reservation/api/1/platform/{platform-code}/webhook/auth/api-keys:
    patch:
      description: Activate XApiKey authentication for webhooks.
      operationId: reservation-serviceActivateApiKeysAuth
      parameters:
      - in: path
        name: platform-code
        required: true
        schema:
          $ref: '#/components/schemas/reservation-servicePlatformCode'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/reservation-servicePlatformAPIKeysWebhook'
      responses:
        '200':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/reservation-servicePlatformWebhookResponseDto'
        '400':
          description: Non relevant request
        '403':
          description: Scope 'reservation-{platform-code}' not found in the token
        '404':
          description: Platform not found
      security:
      - OAuth2:
        - reservation-platform-code
      summary: Add authentication by XApiKey
      tags:
      - Reservations for Platforms
  /reservation/api/1/platform/{platform-code}/webhook/auth/basic-auth:
    patch:
      description: Activate BasicAuth authentication for webhooks.
      operationId: reservation-serviceActivateBasicAuth
      parameters:
      - in: path
        name: platform-code
        required: true
        schema:
          $ref: '#/components/schemas/reservation-servicePlatformCode'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/reservation-servicePlatformBasicAuthWebhook'
      responses:
        '200':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/reservation-servicePlatformWebhookResponseDto'
        '400':
          description: Non relevant request
        '403':
          description: Scope 'reservation-{platform-code}' not found in the token
        '404':
          description: Platform not found
      security:
      - OAuth2:
        - reservation-platform-code
      summary: Add authentication with BasicAuth
      tags:
      - Reservations for Platforms
  /reservation/api/1/platform/{platform-code}/webhook/auth/bearer-auth:
    patch:
      description: Activate BearerAuth authentication for webhooks.
      operationId: reservation-serviceActivateBearerAuthAuth
      parameters:
      - in: path
        name: platform-code
        required: true
        schema:
          $ref: '#/components/schemas/reservation-servicePlatformCode'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/reservation-servicePlatformBearerTokenWebhook'
      responses:
        '200':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/reservation-servicePlatformWebhookResponseDto'
        '400':
          description: Non relevant request
        '403':
          description: Scope 'reservation-{platform-code}' not found in the token
        '404':
          description: Platform not found
      security:
      - OAuth2:
        - reservation-platform-code
      summary: Add authentication with BearerAuth
      tags:
      - Reservations for Platforms
  /reservation/api/1/platform/{platform-code}/webhook/auth/oauth2:
    patch:
      description: Activate OAuth2 authentication for webhooks.
      operationId: reservation-serviceActivateOAuth2
      parameters:
      - in: path
        name: platform-code
        required: true
        schema:
          $ref: '#/components/schemas/reservation-servicePlatformCode'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/reservation-servicePlatformOAuth2Webhook'
      responses:
        '200':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/reservation-servicePlatformWebhookResponseDto'
        '400':
          description: Non relevant request
        '403':
          description: Scope 'reservation-{platform-code}' not found in the token
        '404':
          description: Platform not found
      security:
      - OAuth2:
        - reservation-platform-code
      summary: Add authentication with OAuth2
      tags:
      - Reservations for Platforms
  /reservation/api/1/user/platform/{platform-code}/business-locations:
    get:
      description: Retrieve all the business locations accessible for a User
      operationId: reservation-serviceGetBusinessLocations
      parameters:
      - in: path
        name: platform-code
        required: true
        schema:
          $ref: '#/components/schemas/reservation-servicePlatformCode'
      - description: The page number, when paginating
        in: query
        name: page
        required: false
        schema:
          default: 0
          format: int32
          type: integer
      - description: The items per page, when paginating
        in: query
        name: size
        required: false
        schema:
          default: 1000
          format: int32
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/reservation-servicePlatformBusinessLocation'
                type: array
                examples:
                - - businessLocationId: '123456789'
                    city: Genève
                    country: CH
                    name: Le Gâteau
                    state: Canton de Genève
                    street1: Rue de la Servette 10
                    street2: Suite 2
                    zip: '101201'
          description: A list of business locations
        '400':
          description: Non relevant request
        '403':
          description: Access token not relevant for the businessLocation, use authorization-code
        '404':
          description: No business locations found
      security:
      - OAuth2:
        - user-token-by-authorization-code
      summary: Get Business Locations
      tags:
      - Reservations for Platforms
  /reservation/api/1/user/platform/{platform-code}/integration/activate:
    post:
      description: Activate the integration between the K-Series business location and the external reservation platform.
      operationId: reservation-serviceActivatePlatformIntegration
      parameters:
      - in: path
        name: platform-code
        required: true
        schema:
          $ref: '#/components/schemas/reservation-servicePlatformCode'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/reservation-servicePlatformIntegrationDto'
      responses:
        '200':
          description: Accepted
        '400':
          description: Non relevant request
        '403':
          description: Access token not relevant for the businessLocation, use authorization-code
        '404':
          description: Platform not found
      security:
      - OAuth2:
        - user-token-by-authorization-code
      summary: Activate Integration for Restaurant
      tags:
      - Reservations for Platforms
  /reservation/api/1/user/platform/{platform-code}/integration/deactivate:
    post:
      description: Deactivate the integration between the K-Series business location and the external reservation platform.
      operationId: reservation-serviceDeactivatePlatformIntegration
      parameters:
      - in: path
        name: platform-code
        required: true
        schema:
          $ref: '#/components/schemas/reservation-servicePlatformCode'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/reservation-servicePlatformIntegrationDto'
      responses:
        '200':
          description: Accepted
        '400':
          description: Non relevant request
        '403':
          description: Access token not relevant for the businessLocation, use authorization-code
        '404':
          description: Platform not found
      security:
      - OAuth2:
        - user-token-by-authorization-code
      summary: Deactivate Integration for Restaurant
      tags:
      - Reservations for Platforms
webhooks:
  reservation-serviceReservation error notification:
    post:
      summary: Error notification
      operationId: reservationErrorNotification
      description: These notifications are sent to the URL provided in the[`errorsWebhookUrl` field](https://api-docs.lsk.lightspeed.app/operation/operation-reservation-servicesetbyplatformcode#operation-reservation-servicesetbyplatformcode-body-application-json-errorswebhookurl).
      tags:
      - Reservations for Platforms
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/reservation-serviceErrorWebhook'
        required: true
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  reservation-serviceReservation integration notification:
    post:
      summary: Integration notification
      operationId: reservationIntegrationNotification
      description: These notifications are sent to the URL provided in the[`integrationWebhookUrl` field](https://api-docs.lsk.lightspeed.app/operation/operation-reservation-servicesetbyplatformcode#operation-reservation-servicesetbyplatformcode-body-application-json-integrationwebhookurl).
      tags:
      - Reservations for Platforms
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/reservation-serviceIntegrationWebhook'
        required: true
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  reservation-serviceReservation onboarding notification:
    post:
      summary: Onboarding notification
      operationId: reservationOnboardingNotification
      description: These notifications are sent to the URL provided in the[`onboardingWebhookUrl` field](https://api-docs.lsk.lightspeed.app/operation/operation-reservation-servicesetbyplatformcode#operation-reservation-servicesetbyplatformcode-body-application-json-onboardingwebhookurl).
      tags:
      - Reservations for Platforms
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/reservation-serviceOnboardingWebhook'
        required: true
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  reservation-serviceReservation order notification:
    post:
      summary: Order notification
      operationId: reservationOrderNotification
      description: These notifications are sent to the URL provided in the[`orderWebhookUrl` field](https://api-docs.lsk.lightspeed.app/operation/operation-reservation-servicesetbyplatformcode#operation-reservation-servicesetbyplatformcode-body-application-json-orderwebhookurl).
      tags:
      - Reservations for Platforms
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/reservation-serviceOrderUpdate'
        required: true
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  reservation-servicePOS reservation updated notification:
    post:
      summary: POS reservation updated notification
      operationId: posReservationUpdatedNotification
      description: These notifications are sent to the URL provided in the[`posReservationUpdateWebhookUrl` field](https://api-docs.lsk.lightspeed.app/operation/operation-reservation-servicesetbyplatformcode#operation-reservation-servicesetbyplatformcode-body-application-json-posreservationupdatewebhookurl).
      tags:
      - Reservations for Platforms
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/reservation-servicePosReservationUpdate'
        required: true
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
components:
  schemas:
    reservation-serviceAccount:
      properties:
        accountNumber:
          description: The unique identifier of the account (order).
          example: A833754.74
          type: string
        accountObjectId:
          description: The internal identifier of the table.
          example: '25769805453'
          type: string
          deprecated: true
        accountProfileCode:
          description: The code of the [account (order) profile](https://api-docs.lsk.lightspeed.app/operation/operation-reservationordernotification#operation-reservationordernotification-body-application-json-account-accountprofilecode) associated with this order. <br> See the [order profiles](https://api-portal.lsk.lightspeed.app/guides/definitions/order-profiles) definition for more details.
          example: zoneB
          type: string
        accountProfileId:
          description: The unique identifier of the [account (order) profile](https://api-docs.lsk.lightspeed.app/operation/operation-reservationordernotification#operation-reservationordernotification-body-application-json-account-accountprofilecode) associated with this order.
          example: '25769805764'
          type: string
        accountProfileName:
          description: The name of the [account (order) profile](https://api-docs.lsk.lightspeed.app/operation/operation-reservationordernotification#operation-reservationordernotification-body-application-json-account-accountprofilecode) associated with this order.
          example: Livraison Zone B
          type: string
        businessLocationId:
          description: The unique identifier of the business location.
          example: '9765040300495493'
          type: string
        closeDate:
          description: The timestamp of when transaction was completed, in milliseconds.
          example: 1694083785354
          format: int64
          nullable: true
          type: integer
        consumerRecord:
          $ref: '#/components/schemas/reservation-serviceConsumerRecord'
        coverCount:
          description: The number of covers associated with the transaction.
          example: 2
          format: int64
          type: integer
        currencyCode:
          description: The ISO-4217 3 letter currency code.
          example: EUR
          type: string
        currentProductionPhase:
          description: The active course. Starts with 0.
          example: 0
          format: int32
          type: integer
        discounts:
          items:
            $ref: '#/components/schemas/reservation-serviceDiscount'
          type: array
        externalReferences:
          description: The unique identifiers of this transaction provided by 3rd parties or the K-Series backend.
          items:
            $ref: '#/components/schemas/reservation-serviceExternalReference'
          type: array
        gratuityAmount:
          description: The tip amount.
          example: 20
          type: number
        id:
          description: Legacy account identifier created by the POS (for backwards compatibility).
          example: '21474836499'
          type: string
          deprecated: true
        latestExternalReferences:
          items:
            $ref: '#/components/schemas/reservation-serviceExternalReference'
          type: array
        name:
          description: The name of the transaction or tab.
          example: Floor 1, Table 2
          type: string
        offset:
          description: The UTC Offset of the location, in minutes.
          example: 240
          format: int32
          type: integer
        orderMode:
          description: 'Order mode of the transaction:

            * DIRECT – Retail-like direct sale, no table associated

            * TABLE – Table based order / sale

            * DELIVERY – Retail-like delivery or take-away sale, no table associated

            * LOCAL_ORDER – Sale generated by a local order system (e.g. drink dispenser)

            * ONLINE – Sale generated by a remote order system (e.g. a web site)

            * SYSTEM – Used for transfer operations between payment methods

            * ON_HOLD – Direct Sale that is currently put on hold (parked), resumed at a later time

            * CROSS_BL – Cross business location order

            '
          example: ONLINE
          type: string
          enum:
          - DIRECT
          - TABLE
          - DELIVERY
          - LOCAL_ORDER
          - ONLINE
          - SYSTEM
          - OTHER
          - ON_HOLD
          - CROSS_BL
          - BAR_TAB
        openDate:
          description: The timestamp of when transaction was started, in milliseconds.
          example: 1694083785354
          format: int64
          type: integer
        originAccountId:
          description: Legacy reference identifier of origin account created by the POS (for backwards compatibility).
          example: 21474836579
          format: int64
          nullable: true
          type: integer
        originAccountNumber:
          description: A unique identifier of an account, used to identify sales transactions.
          example: A1.5
          nullable: true
          type: string
        paidAmount:
          description: The amount paid.
          example: 45
          type: number
        paymentLines:
          items:
            $ref: '#/components/schemas/reservation-servicePaymentLine'
          type: array
        preTaxAmount:
          description: The amount before tax.
          example: 201.78
          type: number
        receiptNumber:
          description: The unique identifier of the final transaction.
          example: R1.2
          type: string
        serviceCharge:
          description: The sum of all surcharges applied to the transaction.
          example: 34.2
          type: number
        staffId:
          description: The unique identifier of staff member who created/started and owns the transaction.
          example: '13'
          type: string
        staffName:
          description: The name of staff member who created/started and owns the transaction.
          example: Manager
          type: string
        tableName:
          description: The name of the table.
          example: Table 112
          type: string
          deprecated: true
        tableNumber:
          description: Integer number of the table.
          example: 112
          type: number
          deprecated: true
        tables:
          description: List of table names (codes) associated with this order
          example:
          - '112'
          - 112A
          type: array
          items:
            type: string
        taxAmount:
          description: The total amount of tax.
          example: 14.12
          type: number
        totalAmount:
          description: The total amount of the receipt.
          example: 30
          type: number
        totalDiscount:
          description: The applied discount rate, as a percentage.
          example: 0.9
          type: number
        transactionLines:
          items:
            $ref: '#/components/schemas/reservation-serviceTransactionLine'
          type: array
        type:
          description: The sale line type.
          example: SALE
          type: string
        updateDate:
          description: The timestamp of when the complete update was finalized at the POS, in milliseconds.
          example: 1694083819623
          format: int64
          type: integer
      type: object
    reservation-serviceIntegrationWebhook:
      properties:
        businessLocationId:
          $ref: '#/components/schemas/reservation-serviceBusinessLocationId'
        notificationType:
          description: The type of notification.
          enum:
          - ACTIVATED
          - DEACTIVATED
          type: string
        platformCode:
          $ref: '#/components/schemas/reservation-servicePlatformCode'
        platformRestaurantId:
          $ref: '#/components/schemas/reservation-servicePlatformRestaurantId'
      required:
      - notificationType
      - platformCode
      - businessLocationId
      - platformRestaurantId
      type: object
    reservation-servicePaymentLine:
      properties:
        accountId:
          description: Legacy account identifier created by the POS (supplied because older API provides it to 3rd parties).
          example: '21474836499'
          type: string
        amount:
          description: Amount given by the customer to settle the transaction.
          example: 45
          type: number
        currencyCode:
          description: An ISO-4217 3 letter currency code
          example: GBP
          type: string
        date:
          description: Timestamp in ms of the moment when the line was registered. by the user
          example: 1694084890294
          format: int64
          type: integer
        gratuityAmount:
          description: Amount of tip given by the customer using the payment method.
          example: 50
          type: number
        id:
          description: Legacy line identifier created by the POS (supplied because older API provides it to 3rd parties).
          example: 21474836506
          format: int64
          type: integer
        paymentMethod:
          description: Short code of the payment method the customer used to settle the transaction.
          example: IKGIFT
          type: string
        paymentMethodDescription:
          description: Name of the payment method used.
          example: Geschenkkarte
          type: string
      type: object
    reservation-serviceErrorCode:
      description: A code that describes the reason for the error.
      enum:
      - PLATFORM_NOT_FOUND
      - URL_MUST_START_WITH_HTTPS
      - BEARER_AUTH_TTL_IS_EXPIRED
      - BASIC_AUTH_FIELDS_CAN_NOT_BE_EMPTY
      - BEARER_AUTH_FIELDS_CAN_NOT_BE_EMPTY
      - API_KEY_AUTH_FIELDS_CAN_NOT_BE_EMPTY
      - OAUTH_FIELDS_CAN_NOT_BE_EMPTY
      - RESTAURANT_PROPERTIES_REQUIRED
      - RESTAURANT_PROPERTIES_INVALID
      - RESTAURANT_PROPERTIES_EXPIRED
      - INTEGRATION_LOCATION_ID_MISMATCH
      - PLATFORM_ALREADY_ACTIVATED
      - CURRENCY_NOT_ACCEPTABLE
      - PLATFORM_FIELDS_CAN_NOT_BE_EMPTY
      - PLATFORM_CODE_TOO_MANY_SYMBOLS
      - REQUESTED_TABLE_IS_UNAVAILABLE
      - PLATFORM_RESTAURANT_NOT_FOUND
      - PLATFORM_PROPERTIES_INVALID
      - PLATFORM_PROPERTIES_DUPLICATION
      - RESERVATION_FIELDS_CAN_NOT_BE_EMPTY
      - RESERVATION_ID_TOO_MANY_SYMBOLS
      - RESERVATION_PARTY_SIZE_ERROR
      - RESERVATION_SEQUENCE_ID_ERROR
      - RESERVATION_PROPERTIES_INVALID
      - GUEST_URL_UNREACHABLE
      - GUEST_PROPERTIES_INVALID
      - GUEST_FIELDS_CAN_NOT_BE_EMPTY
      - VOIDED_DEPOSIT_CAN_NOT_BE_FUNDED_AGAIN
      - DEPOSIT_AMOUNT_CAN_NOT_BE_CHANGED
      - DEPOSIT_UNACCEPTABLE_AMOUNT
      - DEPOSIT_ID_MUST_BE_UNIQUE
      - VOIDED_REFUND_CAN_NOT_BE_REFUNDED_AGAIN
      - REFUND_AMOUNT_CAN_NOT_BE_CHANGED
      - REFUND_ID_MUST_BE_UNIQUE
      - REFUND_UNACCEPTABLE_AMOUNT
      - CURRENCY_CAN_NOT_BE_CHANGED
      - TOO_MANY_DEPOSITS
      - TOO_MANY_REFUNDS
      - TOO_MANY_INTEGRATIONS_WITH_PLATFORM
      - INTERNAL_ERROR
      - ACCOUNT_CREATION_ERROR
      - CLIENT_REQUEST_ERROR
      - INTEGRATION_ONBOARDING_PROPERTIES_INVALID
      - INTEGRATION_ONBOARDING_NOTIFICATION_FAILED
      example: REQUESTED_TABLE_IS_UNAVAILABLE
      type: string
    reservation-servicePlatformCourseSettingsDto:
      properties:
        allowCourseNumberUpdates:
          type: boolean
          example: true
          default: false
          description: If true, table statuses can be customized using a number format.
        inServiceTableStatuses:
          items:
            $ref: '#/components/schemas/reservation-servicePlatformTableStatusDto'
          type: array
          description: List of customizable table statuses that will be used to notify platforms about reservation progress with outbound API.
      type: object
    reservation-serviceBusinessLocationId:
      description: The unique identifier of the business location.
      example: 9765040300495493
      format: int64
      type: integer
    reservation-servicePlatformReservation:
      properties:
        guest:
          description: Guest information associated with the reservation.
          properties:
            email:
              description: The guest's email address.
              example: john.smith@email.com
              format: email
              type: string
            firstName:
              description: The guest's first name.
              example: John
              type: string
            lastName:
              description: The guest's last name.
              example: Smith
              typ

# --- truncated at 32 KB (77 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/lightspeed/refs/heads/main/openapi/lightspeed-reservations-for-platforms-api-openapi.yml