Reservation Errors

Introduction

The Reservations for Platforms API has a predefined list of errors that may be returned to the webhook URL. Below is a table listing possible errors and their meanings.

When applicable, a list of the fields in the request that caused errors will be found in errorProperties.

Error Code	Description
PLATFORM_NOT_FOUND	The specified platform does not exist or is not registered.
URL_MUST_START_WITH_HTTPS	The provided URL is invalid because it does not use HTTPS.
BEARER_AUTH_TTL_IS_EXPIRED	The bearer authentication token has expired.
BASIC_AUTH_FIELDS_CAN_NOT_BE_EMPTY	Required fields for basic authentication are missing.
BEARER_AUTH_FIELDS_CAN_NOT_BE_EMPTY	Required fields for bearer authentication are missing.
API_KEY_AUTH_FIELDS_CAN_NOT_BE_EMPTY	Required fields for API key authentication are missing.
OAUTH_FIELDS_CAN_NOT_BE_EMPTY	Required OAuth authentication fields are missing.
RESTAURANT_PROPERTIES_REQUIRED	Some required restaurant properties were not provided.
RESTAURANT_PROPERTIES_INVALID	Provided restaurant properties have invalid values.
RESTAURANT_PROPERTIES_EXPIRED	One or more restaurant properties have expired.
INTEGRATION_LOCATION_ID_MISMATCH	The provided businessLocationID does not match the expected integration.
PLATFORM_ALREADY_ACTIVATED	The specified platform has already been activated for this location.
CURRENCY_NOT_ACCEPTABLE	The specified currency is not supported or allowed.
PLATFORM_FIELDS_CAN_NOT_BE_EMPTY	Required platform fields are missing or empty.
PLATFORM_CODE_TOO_MANY_SYMBOLS	The provided platform-code exceeds the allowed length.
REQUESTED_TABLE_IS_UNAVAILABLE	The requested table is already occupied or does not exist.
PLATFORM_RESTAURANT_NOT_FOUND	The specified restaurant is not found within the platform.
PLATFORM_PROPERTIES_INVALID	Some platform properties have invalid values.
PLATFORM_PROPERTIES_DUPLICATION	Duplicate platform properties were found and are not allowed.
RESERVATION_FIELDS_CAN_NOT_BE_EMPTY	Required fields for a reservation are missing.
RESERVATION_ID_TOO_MANY_SYMBOLS	The reservation ID exceeds the allowed length.
RESERVATION_PARTY_SIZE_ERROR	The party size for the reservation is invalid.
RESERVATION_SEQUENCE_ID_ERROR	The reservation sequence ID does not match expected values.
RESERVATION_PROPERTIES_INVALID	Provided reservation properties have invalid values.
GUEST_URL_UNREACHABLE	The provided guest URL is not reachable.
GUEST_PROPERTIES_INVALID	Guest properties contain invalid values.
GUEST_FIELDS_CAN_NOT_BE_EMPTY	Required fields for a guest are missing.
VOIDED_DEPOSIT_CAN_NOT_BE_FUNDED_AGAIN	A deposit that was voided cannot be funded again.
DEPOSIT_AMOUNT_CAN_NOT_BE_CHANGED	The deposit amount cannot be modified after creation.
DEPOSIT_UNACCEPTABLE_AMOUNT	The deposit amount is outside the acceptable range.
DEPOSIT_ID_MUST_BE_UNIQUE	The deposit ID must be unique and is already in use.
VOIDED_REFUND_CAN_NOT_BE_REFUNDED_AGAIN	A refund that was voided cannot be processed again.
REFUND_AMOUNT_CAN_NOT_BE_CHANGED	The refund amount cannot be modified after creation.
REFUND_ID_MUST_BE_UNIQUE	The refund ID must be unique and is already in use.
REFUND_UNACCEPTABLE_AMOUNT	The refund amount is outside the acceptable range.
CURRENCY_CAN_NOT_BE_CHANGED	The deposit currency cannot be changed once set.
TOO_MANY_DEPOSITS	The number of deposits exceeds the allowed limit.
TOO_MANY_REFUNDS	The number of refunds exceeds the allowed limit.
TOO_MANY_INTEGRATIONS_WITH_PLATFORM	The platform is already activated for this location.
INTERNAL_ERROR	A generic internal server error occurred.
ACCOUNT_CREATION_ERROR	An error occurred while trying to create an order.
CLIENT_REQUEST_ERROR	The client made an invalid request.
INTEGRATION_ONBOARDING_PROPERTIES_INVALID	Provided integration onboarding properties are invalid.
INTEGRATION_ONBOARDING_NOTIFICATION_FAILED	A notification related to integration onboarding failed.