Get Sample Error Notification

GET /reservation/api/1/platform/{platform-code}/error-webhook-sample
OAuth2

Returns an example of an error notification. These notifications are sent to the URL provided in theerrorsWebhookUrl field.

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

    OK

    Hide response attributes Show response attributes object
    • entityType Required

      The type of entity with which the error occurred.

      Values are business-location, general, platform-profile, platform-restaurant, or platform-reservation.

    • errorCode string Required

      A code that describes the reason for the error.

      Values are 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, or INTEGRATION_ONBOARDING_NOTIFICATION_FAILED.

    • errorMessage string Required

      Error description.

    • errorProperties array[string]

      The list of request properties that are incorrect.

    • httpCode integer(int32) Required

      The code of http error (4xx, 5xx) response.

    • platformCode string

      The unique code assigned to the reservation platform.

      Maximum length is 11. Format should match the following pattern: [a-zA-Z0-9_-]+.

    • platformReservationId string

      The external platform ID for the reservation.

      Maximum length is 36. Format should match the following pattern: [a-zA-Z0-9_-]+.

    • platformRestaurantId string

      The external platform ID for the restaurant.

      Format should match the following pattern: [a-zA-Z0-9_-]+.

    • traceId string Required

      Unique ID of the issue.
GET /reservation/api/1/platform/{platform-code}/error-webhook-sample 
curl \
 -X GET https://api.trial.lsk.lightspeed.app/reservation/api/1/platform/MyPlatform/error-webhook-sample \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "entityType": "platform-reservation",
  "errorCode": "REQUESTED_TABLE_IS_UNAVAILABLE",
  "errorMessage": "Incorrect properties",
  "errorProperties": [
    "tableNumbers"
  ],
  "httpCode": 400,
  "platformCode": "MyPlatform",
  "platformReservationId": "Reservation-123",
  "platformRestaurantId": "Restaurant-123",
  "traceId": "b43f8e3e-5ac9-464e-ab34-20b4e137115e"
}