Get Shift Availability

Retrieves availability for a specific Shift.

POST /availability/work-days/{date}/shifts/{time}/time-slots

Get Shift Availability

cURL

curl --request POST \
  --url https://api-dev.myrestoo.net/v3/availability/work-days/{date}/shifts/{time}/time-slots \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Restoo-Account-Id: <restoo-account-id>' \
  --header 'Restoo-Partner-Id: <restoo-partner-id>' \
  --data '
{
  "paxChildren": 0,
  "pax": 2,
  "status": "CONFIRMED",
  "filters": {
    "floorPlanAreaIds": [
      1,
      2
    ]
  },
  "customerUuid": "0199ce9adaab7327bda33ef9f75c123",
  "excludeBookingUuid": "50b5571be67b477baa9dead4b290c555",
  "promoCode": "promo2x1",
  "redemptionCode": "ABC123",
  "highChairs": 1,
  "strollers": 1
}
'

200

{
  "metadata": {
    "filters": {
      "floorPlanAreas": [
        {
          "name": "Terrace",
          "summary": "<p>The beautiful terrace of our restaurant.</p>",
          "images": [
            {
              "type": "THUMBNAIL",
              "url": "https://example.com/assets/image.jpg"
            }
          ],
          "id": 101
        }
      ]
    }
  },
  "promo": {
    "name": "Summer Discount 2025",
    "id": 101
  },
  "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
      }
    ]
  },
  "accountId": "best-burger",
  "addOns": [
    {
      "name": "Premium wine tasting",
      "summary": "<p>Enjoy our best wines with your experience.</p>",
      "unitPrice": 1000,
      "currency": "EUR",
      "id": 101
    }
  ],
  "experience": {
    "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": [
    {
      "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
          }
        ]
      },
      "name": "Terrace",
      "summary": "<p>The beautiful terrace of our restaurant.</p>",
      "images": [
        {
          "type": "THUMBNAIL",
          "url": "https://example.com/assets/image.jpg"
        }
      ],
      "id": 101
    }
  ],
  "shift": {
    "type": {
      "id": "LUNCH",
      "name": "Lunch"
    },
    "firstBookingAt": "2025-03-20T20:00:00+02:00",
    "lastBookingAt": "2025-03-21T01:00:00+02:00",
    "hasExperiences": true,
    "hasAddOns": true,
    "isExperienceRequired": true
  },
  "timeSlots": [
    {
      "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
          }
        ]
      },
      "startAt": "2025-03-20T20:00:00+02:00",
      "isTimeLimited": true,
      "strollersAvailable": {
        "type": "LIMITED",
        "available": 3
      },
      "highChairsAvailable": {
        "type": "LIMITED",
        "available": 3
      },
      "experienceId": 123,
      "floorPlanAreaId": 123,
      "turnMinutes": 90
    }
  ],
  "workDay": {
    "date": "2025-03-20"
  }
}

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

GetShiftAvailabilityRequest

Request payload for shift availability query.

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 · ShiftAvailabilityFilters · object

Filters to apply on the shift availability request.

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"

experience · ExperienceRequest · object

The Experience requested

Show child attributes

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

200

application/json

GetShiftAvailabilityResponse

Response payload representing the availability a Shift.

metadata · ShiftAvailabilityMetadata · object · required

Metadata returned with the shift 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

availability · Availability · object · required

The Availability details for the request.

Show child attributes

accountId · string · required

The unique Restoo Account identifier for the Tenant

Example:

"best-burger"

addOns · AddOn · object[] · required

The Add-ons sent in the request, resolved with their current name, price and currency, and localized. Empty means none were requested, not that none exist.

Get Booking Availability flattens both levels, the Shift's and the Experience's. The other responses carry only the Experience's

Show child attributes

experience · Experience · object | null · required

The Experience details.

Show child attributes

floorPlanAreas · FloorPlanAreaAvailability · object[] · required

The Floor Plan Areas of the Shift. An area can appear here and still have no bookable times of its own in timeSlots

Show child attributes

shift · Shift · object | null · required

The Shift details.

Show child attributes

timeSlots · TimeSlotAvailability · object[] · required

The bookable Time Slots, one entry per combination of start time and Floor Plan Area. startAt is not unique: the same time comes back once per area, each entry with its own availability and floorPlanAreaId

Show child attributes

workDay · WorkDay · object · required

The Work Day details.

Show child attributes