Bookings

Create, confirm, update, and cancel bookings. The booking flow is: reserve → confirm. Reservations expire if not confirmed within the specified time.

List bookings

get

Returns a list of bookings filtered by the specified parameters.

Important: At least one filter parameter is required. You must provide one of:

  • resellerReference - Filter by your reference

  • supplierReference - Filter by our booking ID

  • localDate - Filter by a specific date

  • localDateStart AND localDateEnd - Filter by date range (both required together)

Calling this endpoint without any filter parameters will return a 400 BAD_REQUEST error.

Authorizations
AuthorizationstringRequired

OCTO API Bearer token authentication

Query parameters
resellerReferencestringOptional

Filter by reseller reference (your booking reference)

supplierReferencestringOptional

Filter by supplier reference (our booking ID)

localDatestring · dateOptional

Filter by specific date (bookings occurring on this date)

Example: 2025-01-15
localDateStartstring · dateOptional

Filter by start date - must be used together with localDateEnd

Example: 2025-01-01
localDateEndstring · dateOptional

Filter by end date - must be used together with localDateStart

Example: 2025-01-31
Header parameters
Octo-CapabilitiesstringRequired

Comma-separated list of capabilities (pricing)

Example: pricing
Responses
chevron-right
200

List of bookings matching the filter criteria

application/json

A booking in the OCTO system

idstringRequired

Internal booking ID

uuidstring · uuidRequired

Unique booking identifier

testModebooleanOptional

Whether this is a test booking

resellerReferencestring · nullableOptional

Reseller reference number

supplierReferencestringOptional

Supplier reference number

statusstring · enumRequired

Booking status

Possible values:
utcCreatedAtstring · date-timeOptional

Creation time in UTC

utcUpdatedAtstring · date-time · nullableOptional
utcExpiresAtstring · date-time · nullableOptional

Expiration time for pending bookings

utcConfirmedAtstring · date-time · nullableOptional
productIdstringOptional

Product ID

productone of · nullableOptional
optionIdstringOptional

Option ID

optionobject · nullableOptional
availabilityIdstringOptional

Availability slot ID (format: startDateTime|endDateTime)

availabilityone of · nullableOptional

Availability details for the booking

notesstring · nullableOptional
deliveryMethodsstring[]Optional

Delivery methods matching product delivery formats

voucherone of · nullableOptional

Voucher details for the booking

pricingone of · nullableOptional

Total pricing (requires pricing capability)

get
/bookings

Create a booking reservation

post

Creates a new booking reservation. Include extraItems in unitItems when using the extras capability.

Authorizations
AuthorizationstringRequired

OCTO API Bearer token authentication

Header parameters
Octo-CapabilitiesstringRequired

Comma-separated list of capabilities (pricing, extras)

Example: pricing,extras
Body

Request body for creating a booking reservation

uuidstring · uuidOptional

Optional UUID for idempotency

productIdstringRequired

Product ID to book

Example: 42
optionIdstringRequired

Option ID

Example: DEFAULT
availabilityIdstringRequired

Availability slot ID from availability check

Example: 2025-01-15T10:00:00+01:00|2025-01-15T12:00:00+01:00
expirationMinutesintegerOptional

Minutes until reservation expires

Example: 30
notesstringOptional

Booking notes

Responses
chevron-right
200

Booking reservation created

application/json

A booking in the OCTO system

idstringRequired

Internal booking ID

uuidstring · uuidRequired

Unique booking identifier

testModebooleanOptional

Whether this is a test booking

resellerReferencestring · nullableOptional

Reseller reference number

supplierReferencestringOptional

Supplier reference number

statusstring · enumRequired

Booking status

Possible values:
utcCreatedAtstring · date-timeOptional

Creation time in UTC

utcUpdatedAtstring · date-time · nullableOptional
utcExpiresAtstring · date-time · nullableOptional

Expiration time for pending bookings

utcConfirmedAtstring · date-time · nullableOptional
productIdstringOptional

Product ID

productone of · nullableOptional
optionIdstringOptional

Option ID

optionobject · nullableOptional
availabilityIdstringOptional

Availability slot ID (format: startDateTime|endDateTime)

availabilityone of · nullableOptional

Availability details for the booking

notesstring · nullableOptional
deliveryMethodsstring[]Optional

Delivery methods matching product delivery formats

voucherone of · nullableOptional

Voucher details for the booking

pricingone of · nullableOptional

Total pricing (requires pricing capability)

post
/bookings

Confirm a booking

post

Confirms a pending booking reservation.

Authorizations
AuthorizationstringRequired

OCTO API Bearer token authentication

Path parameters
uuidstring · uuidRequired

Booking UUID

Header parameters
Octo-CapabilitiesstringRequired

Comma-separated list of capabilities (pricing)

Example: pricing
Body
notesstringOptional
Responses
chevron-right
200

Booking confirmed

application/json

A booking in the OCTO system

idstringRequired

Internal booking ID

uuidstring · uuidRequired

Unique booking identifier

testModebooleanOptional

Whether this is a test booking

resellerReferencestring · nullableOptional

Reseller reference number

supplierReferencestringOptional

Supplier reference number

statusstring · enumRequired

Booking status

Possible values:
utcCreatedAtstring · date-timeOptional

Creation time in UTC

utcUpdatedAtstring · date-time · nullableOptional
utcExpiresAtstring · date-time · nullableOptional

Expiration time for pending bookings

utcConfirmedAtstring · date-time · nullableOptional
productIdstringOptional

Product ID

productone of · nullableOptional
optionIdstringOptional

Option ID

optionobject · nullableOptional
availabilityIdstringOptional

Availability slot ID (format: startDateTime|endDateTime)

availabilityone of · nullableOptional

Availability details for the booking

notesstring · nullableOptional
deliveryMethodsstring[]Optional

Delivery methods matching product delivery formats

voucherone of · nullableOptional

Voucher details for the booking

pricingone of · nullableOptional

Total pricing (requires pricing capability)

post
/bookings/{uuid}/confirm

Cancel a booking

post

Cancels a booking reservation or confirmed booking.

Authorizations
AuthorizationstringRequired

OCTO API Bearer token authentication

Path parameters
uuidstring · uuidRequired

Booking UUID

Header parameters
Octo-CapabilitiesstringRequired

Comma-separated list of capabilities (pricing)

Example: pricing
Body
reasonstringOptional
Responses
chevron-right
200

Booking cancelled

application/json

A booking in the OCTO system

idstringRequired

Internal booking ID

uuidstring · uuidRequired

Unique booking identifier

testModebooleanOptional

Whether this is a test booking

resellerReferencestring · nullableOptional

Reseller reference number

supplierReferencestringOptional

Supplier reference number

statusstring · enumRequired

Booking status

Possible values:
utcCreatedAtstring · date-timeOptional

Creation time in UTC

utcUpdatedAtstring · date-time · nullableOptional
utcExpiresAtstring · date-time · nullableOptional

Expiration time for pending bookings

utcConfirmedAtstring · date-time · nullableOptional
productIdstringOptional

Product ID

productone of · nullableOptional
optionIdstringOptional

Option ID

optionobject · nullableOptional
availabilityIdstringOptional

Availability slot ID (format: startDateTime|endDateTime)

availabilityone of · nullableOptional

Availability details for the booking

notesstring · nullableOptional
deliveryMethodsstring[]Optional

Delivery methods matching product delivery formats

voucherone of · nullableOptional

Voucher details for the booking

pricingone of · nullableOptional

Total pricing (requires pricing capability)

post
/bookings/{uuid}/cancel

Get a booking

get

Returns details for a specific booking including any extras.

Authorizations
AuthorizationstringRequired

OCTO API Bearer token authentication

Path parameters
uuidstring · uuidRequired

Booking UUID

Header parameters
Octo-CapabilitiesstringRequired

Comma-separated list of capabilities (pricing)

Example: pricing
Responses
chevron-right
200

Booking details

application/json

A booking in the OCTO system

idstringRequired

Internal booking ID

uuidstring · uuidRequired

Unique booking identifier

testModebooleanOptional

Whether this is a test booking

resellerReferencestring · nullableOptional

Reseller reference number

supplierReferencestringOptional

Supplier reference number

statusstring · enumRequired

Booking status

Possible values:
utcCreatedAtstring · date-timeOptional

Creation time in UTC

utcUpdatedAtstring · date-time · nullableOptional
utcExpiresAtstring · date-time · nullableOptional

Expiration time for pending bookings

utcConfirmedAtstring · date-time · nullableOptional
productIdstringOptional

Product ID

productone of · nullableOptional
optionIdstringOptional

Option ID

optionobject · nullableOptional
availabilityIdstringOptional

Availability slot ID (format: startDateTime|endDateTime)

availabilityone of · nullableOptional

Availability details for the booking

notesstring · nullableOptional
deliveryMethodsstring[]Optional

Delivery methods matching product delivery formats

voucherone of · nullableOptional

Voucher details for the booking

pricingone of · nullableOptional

Total pricing (requires pricing capability)

get
/bookings/{uuid}

Update a booking

patch

Updates contact information or notes on a booking.

Authorizations
AuthorizationstringRequired

OCTO API Bearer token authentication

Path parameters
uuidstring · uuidRequired

Booking UUID

Header parameters
Octo-CapabilitiesstringRequired

Comma-separated list of capabilities (pricing)

Example: pricing
Body
notesstringOptional
Responses
chevron-right
200

Booking updated

application/json

A booking in the OCTO system

idstringRequired

Internal booking ID

uuidstring · uuidRequired

Unique booking identifier

testModebooleanOptional

Whether this is a test booking

resellerReferencestring · nullableOptional

Reseller reference number

supplierReferencestringOptional

Supplier reference number

statusstring · enumRequired

Booking status

Possible values:
utcCreatedAtstring · date-timeOptional

Creation time in UTC

utcUpdatedAtstring · date-time · nullableOptional
utcExpiresAtstring · date-time · nullableOptional

Expiration time for pending bookings

utcConfirmedAtstring · date-time · nullableOptional
productIdstringOptional

Product ID

productone of · nullableOptional
optionIdstringOptional

Option ID

optionobject · nullableOptional
availabilityIdstringOptional

Availability slot ID (format: startDateTime|endDateTime)

availabilityone of · nullableOptional

Availability details for the booking

notesstring · nullableOptional
deliveryMethodsstring[]Optional

Delivery methods matching product delivery formats

voucherone of · nullableOptional

Voucher details for the booking

pricingone of · nullableOptional

Total pricing (requires pricing capability)

patch
/bookings/{uuid}

Extend booking reservation

patch

Extends the expiration time of a pending booking reservation.

Authorizations
AuthorizationstringRequired

OCTO API Bearer token authentication

Path parameters
uuidstring · uuidRequired

Booking UUID

Header parameters
Octo-CapabilitiesstringRequired

Comma-separated list of capabilities (pricing)

Example: pricing
Body
expirationMinutesintegerRequired

Number of minutes from now until expiration

Example: 30
Responses
chevron-right
200

Booking reservation extended

application/json

A booking in the OCTO system

idstringRequired

Internal booking ID

uuidstring · uuidRequired

Unique booking identifier

testModebooleanOptional

Whether this is a test booking

resellerReferencestring · nullableOptional

Reseller reference number

supplierReferencestringOptional

Supplier reference number

statusstring · enumRequired

Booking status

Possible values:
utcCreatedAtstring · date-timeOptional

Creation time in UTC

utcUpdatedAtstring · date-time · nullableOptional
utcExpiresAtstring · date-time · nullableOptional

Expiration time for pending bookings

utcConfirmedAtstring · date-time · nullableOptional
productIdstringOptional

Product ID

productone of · nullableOptional
optionIdstringOptional

Option ID

optionobject · nullableOptional
availabilityIdstringOptional

Availability slot ID (format: startDateTime|endDateTime)

availabilityone of · nullableOptional

Availability details for the booking

notesstring · nullableOptional
deliveryMethodsstring[]Optional

Delivery methods matching product delivery formats

voucherone of · nullableOptional

Voucher details for the booking

pricingone of · nullableOptional

Total pricing (requires pricing capability)

patch
/bookings/{uuid}/extend

Last updated