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

Responses

• 200 application/json

  Platform profile details

  Hide response attributes Show response attributes object

  • baseUrl string(uri)

    The base URL of the external platform (optional).

  • depositSupported boolean

    Whether or not the platform supports deposits.

  • displayName string Required

    The official platform name that will be displayed.

  • errorsWebhookUrl string

    The URL where notifications for any issues will be sent.
    Required for error notificationTypes.
    See Get Sample Error notification.

  • integrationWebhookUrl string

    The URL where notifications for activation or deactivation of the customer's integration will be sent.
    Required for integration notificationTypes.
    See Integration notification.

  • notificationTypes array[string]

    The events that trigger a notification.

    Values are ORDER_OPENED, ORDER_UPDATED, ORDER_CLOSED, ONBOARDING_STARTED, INTEGRATION_ACTIVATED, INTEGRATION_DEACTIVATED, or ERROR.

  • onboardingWebhookUrl string

    The URL where notifications for the customer's integration onboarding will be sent.
    Required for onboarding notificationTypes.
    See Onboarding notification.

  • orderWebhookUrl string

    The URL where order notifications will be sent.
    Required for order notificationTypes.
    See Order Notification.

  • posReservationUpdateWebhookUrl string

    The URL where notifications about reservation changes on POS will be sent.

  • ownNotificationsOnly boolean

    When true, notifications will only be sent for orders linked to the reservation platform.

  • webhookAuthType string Required

    The type of authentication used by the webhook.

    Values are BASIC_AUTH, BEARER_TOKEN, API_KEYS, OAUTH2, or NONE.

  • allowCourseNumberUpdates boolean

    If true, table statuses can be customized using a number format.

    Default value is false.

  • inServiceTableStatuses array[object]

    List of customizable table statuses that will be used to notify platforms about reservation progress with outbound API.

    Hide inServiceTableStatuses attributes Show inServiceTableStatuses attributes object

    • statusLabel string Required

      The unique text which will be displayed in the back-office for users.

    • statusValue string Required

      The unique code which will be used for outbound communication within table status mapping.

    • sequence integer(int32) Required

      This number is used to resolve collisions between statuses in order of highest priority.

  • allowedPosStatuses array[string]

    Reservation statuses allowed for setting on a POS. PARTIALLY_ARRIVED should be included only with ARRIVED, and PARTIALLY_SEATED only with SEATED. Requires posReservationUpdateWebhookUrl to be set.

    Values are ON_HOLD, SCHEDULED, PARTIALLY_ARRIVED, ARRIVED, PARTIALLY_SEATED, SEATED, DEPARTED, CANCELLED, NO_SHOW, or ERROR.

• 400

  Non relevant request

• 403

  Scope 'reservation-{platform-code}' not found in the token