Skip to main content
POST
Get Experience Add-ons Availability

Authorizations

Authorization
string
header
required

All requests must include the static API Key in the Authorization header using the Bearer scheme.

Headers

Restoo-Partner-Id
string
required

Unique identifier of your Partner account (defined by Restoo).

Restoo-Account-Id
string
required

Unique identifier of the Tenant.

Path Parameters

date
string<date>
required

The date for the availability search in ISO 8601 format (YYYY-MM-DD)

Example:

"2025-03-20"

time
string
required

The time for the availability search in ISO 8601 format (HH:MM:SS)

Example:

"22:30:00"

Body

application/json

GetExperienceAddOnsAvailabilityRequest

experience
ExperienceAvailabilityRequest · object
required

Request payload representing an Experience selector (id + tickets only, without add-ons). Used by availability endpoints that compute availability for all add-ons in the group, regardless of any prior selection.

paxChildren
integer
required

The number of children in the Booking. Available only if the Tenant setting for differentiating adults and children is enabled

Required range: 0 <= x <= 100
Example:

0

pax
integer
required

The number of people (or adults, depending on Tenant settings) in the Booking

Required range: 1 <= x <= 100
Example:

2

status
enum<string>
required

Desired status of the Booking.

This value determines how availability should be evaluated and how the Booking should be handled if created.

  • CONFIRMED — The Booking should be immediately confirmed.
  • REQUESTED — The Booking requires manual review and confirmation by the venue.
  • PENDING_WAIT_LIST_BOOKING — The customer wishes to join the wait list and may be confirmed if availability becomes available.

Availability requests should initially be performed using the CONFIRMED status. If no availability is found, alternative statuses may be offered depending on the availability result and venue configuration.

Not all statuses are available for every availability request

Available options:
REQUESTED,
PENDING_MERCHANT_CONFIRMATION,
PENDING_WAIT_LIST_BOOKING,
CONFIRMED,
WAIT_LIST_WALK_IN,
ARRIVED,
SEATED,
DESSERTS,
ACCOUNT_SENT,
ACCOUNT_PAID,
ATTENDED,
CANCELED,
NO_SHOW,
DECLINED_BY_MERCHANT,
DELETED
Example:

"CONFIRMED"

customerUuid
string

The Customer UUID.

Include this field only to associate the request with an existing Customer in Restoo

Example:

"0199ce9adaab7327bda33ef9f75c123"

excludeBookingUuid
string

UUID of the Booking to be excluded from the availability search. Required only when updating an existing Booking

Example:

"50b5571be67b477baa9dead4b290c555"

promoCode
string

The promotion code requested for the reservation

Required string length: 6 - 255
Example:

"promo2x1"

redemptionCode
string

The alphanumeric code to redeem the purchased Product

Required string length: 6
Example:

"ABC123"

floorPlanAreaId
integer

The ID of the Floor Plan Area requested, taken from the chosen Time Slot's floorPlanAreaId. Required when the Shift offers Floor Plan Areas open to online booking

Required range: x >= 1
Example:

123

highChairs
integer

The number of high chairs requested

Required range: x >= 0
Example:

1

strollers
integer

The number of strollers requested

Required range: x >= 0
Example:

1

Response

GetExperienceAddOnsAvailabilityResponse

shift
Shift · object
required

The Shift details.

experience
Experience · object
required

The Experience details.

addOnGroup
AddOnGroupAvailability · object | null
required

The Experience Add-on Group availability details

promo
Promo · object | null
required

The Promo applied during the availability request, if any.

If null, no Promo was applied or no valid Promo was detected.

availability
Availability · object
required

The Availability details for the request.

accountId
string
required

The unique Restoo Account identifier for the Tenant

Example:

"best-burger"

workDay
WorkDay · object
required

The Work Day details.