Get Calendar Availability

Returns the availability calendar for a specific date range, showing which Work Days have available booking slots.

POST /availability/calendar

Get Calendar Availability

cURL

curl --request POST \
  --url https://api-dev.myrestoo.net/v3/availability/calendar \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Restoo-Account-Id: <restoo-account-id>' \
  --header 'Restoo-Partner-Id: <restoo-partner-id>' \
  --data '
{
  "dateStart": "2025-01-01",
  "dateEnd": "2025-01-31",
  "paxChildren": 0,
  "pax": 2,
  "status": "CONFIRMED",
  "filters": {
    "experienceIds": [
      1,
      2
    ],
    "floorPlanAreaIds": [
      1,
      2
    ],
    "shiftTypes": [
      "LUNCH",
      "DINNER"
    ]
  },
  "customerUuid": "0199ce9adaab7327bda33ef9f75c123",
  "excludeBookingUuid": "50b5571be67b477baa9dead4b290c555",
  "promoCode": "promo2x1",
  "redemptionCode": "ABC123"
}
'

200

{
  "workDays": [
    {
      "availability": {
        "isAvailable": false,
        "outcome": "SHIFT_FULL",
        "code": "TENANT_BOOKING_MAX_DATE_NOTICE_EXCEEDED",
        "detail": "Bookings cannot be made more than 30 days in advance.",
        "fallbackOptions": [
          {
            "action": "CONTACT",
            "isPreferred": true
          }
        ]
      },
      "date": "2025-03-20"
    }
  ],
  "metadata": {
    "filters": {
      "experiences": [
        {
          "name": "Premium Menu",
          "summary": "<p>A 5-course premium tasting menu.</p>",
          "description": "<p>Enjoy a 5-course tasting menu crafted by our head chef.</p>",
          "detailsUrl": "https://example.com/experiences/premium-menu",
          "images": [
            {
              "type": "THUMBNAIL",
              "url": "https://example.com/assets/image.jpg"
            }
          ],
          "turnMinutes": 90,
          "isTimeLimited": true,
          "minBookingSize": 2,
          "maxBookingSize": 10,
          "minTicketsPerBooking": 1,
          "paxPerTicket": 4,
          "automaticTicketQuantity": false,
          "pricePerTicket": 7500,
          "minAdvanceBookingMinutes": 60,
          "firstBookingTime": "18:00:00",
          "lastBookingTime": "23:00:00",
          "groupId": 1,
          "floorPlanAreas": ":\n    [\n        {\n            \"id\": 1,\n            \"name\": \"Terrace\",\n            \"summary\": \"The beautiful terrace of our restaurant.\",\n            \"images\": [],\n        }\n    ]",
          "hasAddOns": true,
          "currency": "EUR",
          "id": 101
        }
      ],
      "floorPlanAreas": [
        {
          "name": "Terrace",
          "summary": "<p>The beautiful terrace of our restaurant.</p>",
          "images": [
            {
              "type": "THUMBNAIL",
              "url": "https://example.com/assets/image.jpg"
            }
          ],
          "id": 101
        }
      ],
      "shiftTypes": [
        {
          "id": "LUNCH",
          "name": "Lunch"
        }
      ]
    }
  },
  "promo": {
    "name": "Summer Discount 2025",
    "id": 101
  },
  "accountId": "best-burger"
}

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.

Body

application/json

GetCalendarAvailabilityRequest

Request payload for calendar availability query.

dateStart · string<date> · required

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

Example:

"2025-01-01"

dateEnd · string<date> · required

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

Example:

"2025-01-31"

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"

filters · WorkDayAvailabilityFilters · object

Filters to apply on the calendar and work day availability requests.

Show child attributes

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"

Response

200

application/json

GetCalendarAvailabilityResponse

Response payload representing the availability a for a range of Work Days.

workDays · CalendarWorkDayAvailability · object[] · required

Show child attributes

metadata · CalendarAvailabilityMetadata · object · required

Metadata returned with the calendar availability response.

Show child attributes

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.

Show child attributes

accountId · string · required

The unique Restoo Account identifier for the Tenant

Example:

"best-burger"