Create a booking

post

https://api.roller.app/bookings

Create a booking in ROLLER, and optionally add an associated payment record.

Guest Records

Values provided in the customer object will create a Guest record

This Guest record will be automatically attached to the booking as the booking holder

An existing Guest record will be used where a match is found on email

Where a match is found and other fields on the record are different, they will be updated to reflect the new value

🔒
Required scope: Booking_Create

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

externalId

string

required

length ≤ 64

3rd party booking reference

name

string

length ≤ 128

Title of the booking. Name can be different to the booking owner name (defaults to the booking owner's name if not specified)

comments

string

length ≤ 500

Additional detail about the booking

purchaseDate

date-time | null

Optionally provide the creation datetime in UTC - generally used when re-creating bookings and needing to retain the original datetime

capacityReservationId

string | null

The GUID returned from the capacity reservation API - it's recommended to use the capacity reservation API otherwise the request may be rejected

companyId

integer | null

Id of the company making the booking

customer

object

required

The booking owner, i.e. the primary contact or person who paid for the booking

items

array of objects

required

The products being purchased, known as booking items

items*

payments

array of objects

Any initial payments for the booking (the booking can be unpaid, partially paid or fully paid)

payments

discounts

array of objects

Any discount codes or custom discounts applied to the booking

discounts

giftCards

array of objects

Any gift cards applied to the booking for paying down the booking subtotal. These payments do not need to cover the whole cost.

giftCards

sendConfirmations

boolean

When true ROLLER will send the booking confirmation / tickets to the customer automatically

customerPaysFees

boolean

Defaults to false

When true fees setup in ROLLER are applied. Please note if manual creditCardFees are provided in the request it will override all fees setup in ROLLER.

posNotes

string

Additional detail when processing a booking from POS

automaticCancelHours

integer | null

The number of hours until the booking will auto-expire, used to create a tentative booking. Leave empty if unused.

Responses

201Booking identifiers

409Invalid Booking