Booking
Reserving availability and making a booking
Last updated
Reserving availability and making a booking
Last updated
The steps to making a booking are as follows:
Check Availability Check the availability in the previous section and retrieve an availability ID.
Booking Reservation Create a booking that reserves the availability while you collect payment and contact information from the customer.
Booking Confirmation The final step, once payment has been taken and you want to finalize the booking.
POST https://octo.peek.com/integrations/octo/bookings
The first step is to reserve the availability by creating the booking.
| Name | Type | Description |
|---|---|---|
The request above was made with the following request body:
The UUID on the request body and on each unit is optional but recommended if you're requesting from a source of poor network connectivity. If the connection fails or you do not receive a response, you can repeat the same request with the same UUID and it will respond with the same booking object without duplicating the booking.
The booking object is described as:
The booking object schema described above will be returned on every endpoint in this section. Only the values may change.
PATCH https://octo.peek.com/integrations/octo/bookings/:uuid
This endpoint allows you to update an existing booking. The request parameters are the same as the booking reservation endpoint.
You can update a booking before and after it has been confirmed as long as it hasn't been redeemed or within the cancellation cutoff window. To know if the booking can be updated check the booking.cancellable field. If the booking can be cancelled, it can also be updated. It's generally preferred to update a booking rather than cancelling it and rebooking.
POST https://octo.peek.com/integrations/octo/bookings/:uuid/confirm
This endpoint confirms the booking so it's ready to be used.
An example of the confirmation request above looks like this:
Once the booking is confirmed, the delivery options of both the voucher and/or ticket are populated. An example of the values is shown below:
If booking.deliveryMethods contains both TICKET and VOUCHER then both those values will be set. You can then offer the guest whether they'd like their tickets per-person (booking.unitItems[].ticket) or one for the whole booking (booking.voucher). If you're unable to offer the choice then it's suggested you default to one falling back to the other if that's not available.
DELETE https://octo.peek.com/integrations/octo/bookings/:uuid
If the booking is confirmed this endpoint will cancel it, otherwise it will release the availability that was put on hold.
Note you can only cancel a booking if booking.cancellable is true.
POST https://octo.peek.com/integrations/octo/bookings/:uuid/extend
Use this method to hold the availability for a booking longer if the status is `ON_HOLD`.
GET https://octo.peek.com/integrations/octo/bookings/:uuid
Fetch the status of an existing booking
This endpoint will fetch the booking with the provided UUID from the system.
GET https://octo.peek.com/integrations/octo/bookings
List bookings in the system given certain parameters
| Field | Description |
|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
uuid
String
A unique UUID to identify the booking. Setting this value acts as an idempotency key, preventing you from double booking
expirationMinutes
Integer
How many minutes to reserve the availability, otherwise defaults to the supplier default amount
productId*
String
The product id
optionId
String
The option id
availabilityId*
String
The availability ID
unitItems*
Array
An array of unit items
unitItems[].unitId*
String
The unit item unit ID
unitItems[].uuid
String
A unique UUID to identify the unit, same as the booking uuid except per unit
resellerReference
String
Your reference for this booking. Also known as a Voucher Number
contact
Object
Contact information
uuid
A unique UUID used to identify booking. Make sure you save this value as you will need it to perform any future actions against this booking.
testMode
Whether this booking is in test mode.
resellerReference
Your reference (as the reseller). You set this value in the second confirmation request
supplierReference
The Peek Pro reference for this booking. Use this to help the supplier find this booking.
status
The status of the booking. Possible values are:
ON_HOLD The booking is pending confirmation, this is the default value when you first create the booking.
EXPIRED If the booking is not confirmed before the expiration hold expires, it goes into an expired state.
CONFIRMED Once the confirmation call is made the booking is ready to be used. CANCELLED If the booking is cancelled.
utcExpiresAt
An ISO8601 date time in UTC for when this booking is due to expire if the status is ON_HOLD
utcConfirmedAt
An ISO8601 date time in UTC when the booking was confirmed.
productId
The product ID for this booking
optionId
The option ID for this booking
cancellable
A boolean field indicating whether this booking can be cancelled.
cancellation
An object with information about why and when the booking was cancelled. This is null if the booking is not cancelled.
freesale
Whether the booking was made as freesale (without checking availability first).
notes
Public notes on the booking.
cancellation.reason
A text value describing why the cancellation happened.
cancellation.refund
Whether the booking was refunded as part of the cancellation. Possible values are FULL, PARTIAL or NONE
cancellation.utcCancelledAt
An ISO8601 date time in UTC indicating when the booking was cancelled.
availability
The availability object that was booked.
availability.id
The availability id that was used in the request.
availability.localDateTimeStart
The localDateTimeStart value from the original availability object.
availability.localDateTimeEnd
The localDateTimeEnd value from the original availability object.
availability.allDay
A boolean value indicating whether the availability is all day.
availability.openingHours
The opening hours from the original availability object.
contact
The customer contact details. These values are set in the booking confirmation step.
contact.fullName
The full name of the guest
contact.emailAddress
The email of the guest
contact.phoneNumber
The phone number of the guest
contact.locales
An array of locale values, equivalent to navigator.languages in a browsers environment.
deliveryMethods
An array of delivery methods available for this booking. Possible values are:
VOUCHER The voucher object is populated which is a single ticket for the whole booking.
TICKET The ticket object is populated on each unit item which is a ticket for each individual person.
voucher
This value will be set if deliveryMethods array has VOUCHER as one of the values.
voucher.redemptionMethod
How the voucher can be redeemed. Possible values are:
MANIFEST The guest name will be written down and they just need to show up
DIGITAL The tickets/voucher must be scanned but can be on mobile
PRINT The tickets/voucher must be printed and presented on arrival
voucher.utcRdeemedAt
The ISO8601 date in UTC indicating when the voucher was used at the attraction.
voucher.deliveryOptions
This is an array of delivery options for the voucher each object. You should use one of these to give the tickets to the guest.
voucher.deliveryOptions[].deliveryFormat
The format for the delivery option possible values are:
QRCODE You should generate the QR Code yourself on a ticket.
PDF_URL Where you use the Peek Pro generated tickets as a PDF.
voucher.deliveryOptions[].deliveryValue
Depending on the value of deliveryFormat this value is either:
QRCODE This value is a string to encode in a QR Code.
PDF_URL This value is a URL linking to a Peek-generated voucher PDF.
unitItems
This is an array of unit items generated when making the booking.
unitItems[].uuid
A unique UUID per unit item that you can use to help track it.
unitItems[].resellerReference
Your reference (as a reseller) for this unit item.
unitItems[].supplierReference
The Peek Pro reference for this unit item.
unitItems[].unitId
The unit id used for this unit item
unitItems[].ticket
If deliveryMethods has TICKET as one of its values this object will be set. The data structure will be identical to the voucher object.
uuid*
String
The UUID of the booking
resellerReference
String
Your reference for this booking. Also known as a Voucher Number.
contact*
Object
Contact information
contact.fullName*
String
The customer's full name
contact.emailAddress*
String
The customer's email
contact.phoneNumber
String
The customer's phone number
contact.locales
Array
An array of customer's locales. You can get this from navigator.languages in a browser context.
contact.country
String
The customer's country code
uuid*
String
The UUID of the booking
reason
String
The reason for cancelling the booking
uuid*
String
UUID of the original booking
expirationMinutes*
Integer
How many minutes from now do you want to have the booking reserved for.
uuid*
String
The uuid of the original booking
resellerReference
String
The reseller reference on the booking
supplierReference
String
The reference provided by the supplier
localDate
String
All bookings made for a specific date
localDateStart
String
First date of a date range search
localDateEnd
String
Last date of a date range search
productId
String
The product id to filter by
optionId
String
The option id to filter by