Create Booking

Creates a new Booking with the provided customer, date, time, and party details.

POST /bookings

Create Booking

cURL

curl --request POST \
  --url https://api-dev.myrestoo.net/v3/bookings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Restoo-Account-Id: <restoo-account-id>' \
  --header 'Restoo-Partner-Id: <restoo-partner-id>' \
  --data '
{
  "customer": {
    "hasGdprConsent": true,
    "acceptsMarketing": true,
    "name": "Steve Jobs",
    "birthDate": "1979-03-20",
    "postalCode": "28045",
    "language": "en",
    "country": "ES",
    "uuid": "50b5571be67b477baa9dead4b290c555",
    "email": "[e-mail]",
    "phone": "[phone]"
  },
  "date": "2025-03-20",
  "time": "22:30:00",
  "paxChildren": 0,
  "pax": 2,
  "status": "CONFIRMED",
  "floorPlanAreaId": 123,
  "experience": {
    "tickets": 2,
    "id": 101,
    "addOns": [
      {
        "id": 101,
        "quantity": 1
      }
    ]
  },
  "customerSpecialRequests": "Table near the window",
  "hasAllergies": true,
  "allergiesDescription": "Peanuts, shellfish, lactose intolerance",
  "specialOccasion": "BIRTHDAY",
  "needsAccessibleSeating": true,
  "hotelRoom": "Room 305",
  "redemptionCode": "ABC123",
  "promoCode": "promo2x1",
  "highChairs": 1,
  "addOns": [
    {
      "id": 101,
      "quantity": 1
    }
  ],
  "strollers": 1,
  "utmSource": "google",
  "utmMedium": "cpc",
  "utmCampaign": "summer_promo",
  "utmTerm": "dinner+offers",
  "utmContent": "cta_button_top"
}
'

200

{
  "redirectUrl": "https://example.com/widget/?view=reservation/confirmed&uuid=...",
  "privateNotes": "Customer requested a table near the window.",
  "quotedWaitMinutes": 15,
  "isWalkIn": true,
  "hasFixedTables": false,
  "isHighlighted": false,
  "channel": "API",
  "ticketPartner": "DEFAULT",
  "ticketExternalId": "POS-98234",
  "ticketTotalAmount": 12500,
  "tableReadyAt": "2025-03-20T20:15:00+02:00",
  "arrivedAt": "2025-03-20T20:25:00+02:00",
  "seatedAt": "2025-03-20T20:30:00+02:00",
  "endedAt": "2025-03-20T22:15:00+02:00",
  "ip": "192.168.0.25",
  "customer": {
    "privateNotes": "Customer prefers a table near the terrace.",
    "visitFrequency": 30,
    "averageOrderAmountPerPax": 4500,
    "bookingReputation": 0.85,
    "bookingsCount": 25,
    "visitsCount": 18,
    "cancellationsCount": 3,
    "noShowsCount": 2,
    "firstVisitAt": "2023-05-10T20:00:00+02:00",
    "lastVisitAt": "2025-03-15T21:30:00+02:00",
    "firstCancellationAt": "2024-09-12T19:00:00+02:00",
    "nextVisitScheduledAt": "2025-04-05T22:00:00+02:00",
    "tags": [
      {
        "id": 1,
        "name": "VIP",
        "color": "#FF5733"
      }
    ],
    "uuid": "50b5571be67b477baa9dead4b290c555",
    "email": "[e-mail]",
    "phone": "[phone]",
    "birthDate": "1979-03-20",
    "postalCode": "28045",
    "isVip": true,
    "isBusiness": false,
    "language": "en",
    "acceptsImportantAlerts": true,
    "hasGdprConsent": true,
    "acceptsMarketing": true,
    "country": "ES",
    "name": "Steve Jobs"
  },
  "tables": [
    {
      "name": "T101",
      "floorPlanAreaId": 12,
      "posId": "POS-T101",
      "id": 101
    }
  ],
  "uuid": "50b5571be67b477baa9dead4b290c555",
  "bookingAt": "2025-03-20T23:00:00+02:00",
  "status": "CONFIRMED",
  "isTimeLimited": true,
  "customerSpecialRequests": "Table near the window",
  "hasAllergies": true,
  "allergiesDescription": "Peanuts, shellfish, lactose intolerance",
  "specialOccasion": "BIRTHDAY",
  "needsAccessibleSeating": true,
  "hotelRoom": "Room 305",
  "publicNotes": "Your reservation includes a birthday cake.",
  "isReconfirmed": true,
  "isReconfirmedByCustomer": false,
  "cancelReason": "CHANGED_PLANS",
  "bookingPartner": "GOOGLE",
  "bookingExternalId": "book_123456",
  "shiftType": {
    "id": "LUNCH",
    "name": "Lunch"
  },
  "floorPlanArea": {
    "name": "Terrace",
    "id": 101
  },
  "promo": {
    "name": "Summer Discount 2025",
    "id": 101
  },
  "product": {
    "orderItemId": 101,
    "orderUuid": "50b5571be67b477baa9dead4b290c555",
    "currency": "EUR",
    "experienceTickets": 1,
    "id": 101,
    "isGift": true,
    "name": "Gift Card",
    "quantity": 1,
    "taxRate": 1050,
    "type": "ITEM",
    "unitPrice": 7500
  },
  "experience": {
    "tickets": 1,
    "discount": 10.5,
    "experienceId": 123,
    "name": "Premium Menu",
    "pricePerTicket": 7500,
    "currency": "EUR",
    "id": 101
  },
  "cancellationPolicy": {
    "status": "PENDING_SIGNATURE",
    "signDeadlineAt": "2025-03-20T22:00:00+02:00",
    "signedAt": "2025-03-20T21:35:10+02:00",
    "signedFromIp": "203.0.113.10",
    "endedAt": "2025-03-21T23:59:59+02:00",
    "endedBy": "GUEST",
    "chargeStatus": "SUCCEEDED",
    "refundStatus": null,
    "type": "GUARANTEE_AUTHORIZATION",
    "amount": 2500,
    "amountType": "PER_PAX",
    "cancellationNoticeHours": 24,
    "currency": "EUR",
    "cancellationFeeAmount": 5000,
    "chargedAmount": 5000,
    "guaranteedPax": 2,
    "id": 101,
    "refundedAmount": 0
  },
  "addOns": [
    {
      "addOnId": 123,
      "name": "Premium wine tasting",
      "unitPrice": 1000,
      "currency": "EUR",
      "id": 101,
      "quantity": 1
    }
  ],
  "accountId": "best-burger",
  "highChairs": 1,
  "paxChildren": 0,
  "pax": 2,
  "strollers": 1,
  "turnMinutes": 90,
  "createdAt": "2025-03-20T18:45:00+02:00",
  "updatedAt": "2025-03-21T09:30:00+02:00"
}

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

CreateBookingRequest

Request payload for creating a new Booking.

customer · BookingCustomerRequest · object · required

Request payload with the Booking Customer details.

Show child attributes

date · string<date> · required

The date of the Booking in ISO 8601 format YYYY-MM-DD

Example:

"2025-03-20"

time · string · required

The time of the Booking in ISO 8601 format HH:MM:SS

Example:

"22:30:00"

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"

floorPlanAreaId · integer | null

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

experience · ExperienceRequest · object | null

The Experience requested

Show child attributes

customerSpecialRequests · string | null

Free-text field for customer special requests. The Venue will try to accommodate them but cannot guarantee fulfillment

Maximum string length: 1024

Example:

"Table near the window"

hasAllergies · boolean

Indicates whether any of the guests have allergies (e.g., peanut, chocolate, nuts, etc.)

Example:

true

allergiesDescription · string | null

Free-text description of allergies

Maximum string length: 1024

Example:

"Peanuts, shellfish, lactose intolerance"

specialOccasion · enum<string> | null

The special occasion associated with the booking

Available options: WEDDING, BIRTHDAY, ROMANTIC, FRIENDS, FAMILY, BUSINESS, OTHER

Example:

"BIRTHDAY"

needsAccessibleSeating · boolean

Indicates whether the guest requires an accessible seating (e.g., suitable for wheelchairs or reduced mobility)

Example:

true

hotelRoom · string | null

Hotel room number or identifier associated with the Booking

Maximum string length: 50

Example:

"Room 305"

redemptionCode · string | null

The redemption code requested for the reservation

Required string length: 6

Example:

"ABC123"

promoCode · string | null

The promotion code requested for the reservation

Required string length: 6 - 255

Example:

"promo2x1"

highChairs · integer

The number of high chairs requested

Required range: x >= 0

Example:

1

addOns · AddOnRequest · object[]

The Shift Add-ons requested

Show child attributes

strollers · integer

The number of strollers requested

Required range: x >= 0

Example:

1

utmSource · string

UTM Source. Identifies the traffic source

Example:

"google"

utmMedium · string

UTM Medium. Identifies the medium, such as email or cost-per-click

Example:

"cpc"

utmCampaign · string

UTM Campaign. Identifies a specific product promotion or strategic campaign

Example:

"summer_promo"

utmTerm · string

UTM Term. Identifies paid search keywords for the campaign

Example:

"dinner+offers"

utmContent · string

UTM Content. Differentiates similar content or links.

Used for A/B testing of links that point to the same URL

Example:

"cta_button_top"

Response

200

application/json

CreatePrivateBookingResponse

CreatePublicBookingResponse

CreatePrivateBookingResponse

CreatePublicBookingResponse

redirectUrl · string<uri> | null · required

The URL to redirect the customer after creating the booking

Example:

"https://example.com/widget/?view=reservation/confirmed&uuid=..."

privateNotes · string | null · required

Internal notes visible only to the venue staff

Maximum string length: 2048

Example:

"Customer requested a table near the window."

quotedWaitMinutes · integer | null · required

Estimated waiting time in minutes quoted to the customer

Required range: x >= 5

Example:

15

isWalkIn · boolean · required

Indicates whether the booking was created as a Walk-in

Example:

true

hasFixedTables · boolean · required

Indicates whether the booking has fixed table assignments that cannot be changed

Example:

false

isHighlighted · boolean · required

Indicates whether the booking is highlighted

Example:

false

channel · enum<string> · required

The booking creation channel

Available options: WIDGET, OFFLINE, API

Example:

"API"

ticketPartner · enum<string> | null · required

The partner system that created or manages the ticket (if applicable)

Available options: DEFAULT, REVO, HOSTELTACTIL, AGORA, WINEX, SIMPHONY, CUINER, BDP, GLOP, FRONT_REST, YANTAR, MADISA, LASTAPP, SQUARE, HIOPOS, API, WE_WELCOM

ticketExternalId · string | null · required

The external identifier of the ticket in the POS or third-party system

Maximum string length: 64

Example:

"POS-98234"

ticketTotalAmount · integer | null · required

The total amount of the ticket in cents

Required range: x >= 0

Example:

12500

tableReadyAt · string<date-time> | null · required

The datetime when the table was ready for the customer in ISO 8601 format

Example:

"2025-03-20T20:15:00+02:00"

arrivedAt · string<date-time> | null · required

The datetime when the customer arrived in ISO 8601 format

Example:

"2025-03-20T20:25:00+02:00"

seatedAt · string<date-time> | null · required

The datetime when the customer was seated in ISO 8601 format

Example:

"2025-03-20T20:30:00+02:00"

endedAt · string<date-time> | null · required

The datetime when the booking ended in ISO 8601 format

Example:

"2025-03-20T22:15:00+02:00"

ip · string | null · required

The IP address of the device or system that created the booking

Example:

"192.168.0.25"

customer · PrivateCustomer · object | null · required

Full Customer details, including private properties

Show child attributes

tables · BookingTable · object[] · required

The list of tables assigned to the booking

Show child attributes

uuid · string · required

UUID of the Booking

Example:

"50b5571be67b477baa9dead4b290c555"

bookingAt · string<date-time> · required

The Booking date and time in ISO 8601 format

Example:

"2025-03-20T23:00:00+02:00"

status · enum<string> · required

The Booking status

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"

isTimeLimited · boolean · required

Indicates whether the Booking has a time limit that must be notified and accepted by the customer

Example:

true

customerSpecialRequests · string | null · required

Free-text field for customer special requests. The Venue will try to accommodate them but cannot guarantee fulfillment

Maximum string length: 1024

Example:

"Table near the window"

hasAllergies · boolean · required

Indicates whether any of the guests have allergies (e.g., peanut, chocolate, nuts, etc.)

Example:

true

allergiesDescription · string | null · required

Free-text description of allergies

Maximum string length: 1024

Example:

"Peanuts, shellfish, lactose intolerance"

specialOccasion · enum<string> | null · required

The special occasion associated with the booking

Available options: WEDDING, BIRTHDAY, ROMANTIC, FRIENDS, FAMILY, BUSINESS, OTHER

Example:

"BIRTHDAY"

needsAccessibleSeating · boolean · required

Indicates whether the guest requires an accessible seating (e.g., suitable for wheelchairs or reduced mobility)

Example:

true

hotelRoom · string | null · required

Hotel room number or identifier associated with the Booking

Maximum string length: 50

Example:

"Room 305"

publicNotes · string | null · required

Public notes defined by the venue and visible to the customer

Maximum string length: 2048

Example:

"Your reservation includes a birthday cake."

isReconfirmed · boolean · required

Indicates whether the booking was manually reconfirmed by the customer after the venue contacted them to request reconfirmation

Example:

true

isReconfirmedByCustomer · boolean · required

Indicates whether the booking was automatically reconfirmed by the customer through Restoo’s automated reconfirmation service

Example:

false

cancelReason · enum<string> | null · required

The reason provided when canceling the booking (if applicable)

Available options: CALL_TO_CANCEL, UPDATE_BOOKING, UNEXPECTED_SITUATION, BOOKED_ANOTHER_PLACE, CHANGED_PLANS, OTHER, REVOKE_LEGAL_CONSENT

Example:

"CHANGED_PLANS"

bookingPartner · enum<string> | null · required

The partner through which the Booking was made (if any)

Available options: DEFAULT, GOOGLE, BOOKLINE, BOOKY_BOT, FLIP_EAT, FACEBOOK, MAYBEIN, LASTAPP, PRIMA

Example:

"GOOGLE"

bookingExternalId · string | null · required

The Booking ID provided by the external partner (if applicable). Required if bookingPartner is present

Maximum string length: 64

Example:

"book_123456"

shiftType · ShiftType · object · required

The Shift Type in which the Booking takes place

Show child attributes

floorPlanArea · BookingFloorPlanArea · object | null · required

The Floor Plan Area details related to a Booking.

Show child attributes

promo · BookingPromo · object | null · required

The Promotion details related to a Booking.

Show child attributes

product · BookingProduct · object | null · required

The Product details related to a Booking.

Show child attributes

experience · BookingExperience · object | null · required

The Experience details related to a Booking.

Show child attributes

cancellationPolicy · BookingCancellationPolicy · object | null · required

The Cancellation Policy details associated with a Booking.

Represents the persisted and authoritative state of the Cancellation Policy for a Booking.

Show child attributes

addOns · BookingAddOn · object[] · required

List of add-ons associated with the Booking (if any)

Show child attributes

accountId · string · required

The unique Restoo Account identifier for the Tenant

Example:

"best-burger"

highChairs · integer · required

The number of high chairs

Required range: x >= 0

Example:

1

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

strollers · integer · required

The number of strollers

Required range: x >= 0

Example:

1

turnMinutes · integer · required

The duration of the Booking in minutes

Required range: 15 <= x <= 720

Example:

90

createdAt · string<date-time> | null · required

The creation timestamp in ISO 8601 format

Example:

"2025-03-20T18:45:00+02:00"

updatedAt · string<date-time> | null · required

The last update timestamp in ISO 8601 format

Example:

"2025-03-21T09:30:00+02:00"