Availability
Getting availability for a product
Returns one availability object per date for calendar rendering over a date range. This endpoint is optimized for faster calendar rendering, but it does not replace POST /availability for booking flow. You must call POST /availability to obtain an availabilityId before creating or reserving a booking.
Request schema for /availability/calendar.
Product ID or code.
e7cc8bb4-8d1c-4848-8824-5dbedb718681Option ID or code. Use DEFAULT only when the product has no options.
94cdd032-3d32-416d-b0a4-abf8b7495b8bStart of local date range in the product timezone (YYYY-MM-DD).
2026-05-14End of local date range in the product timezone (YYYY-MM-DD).
2026-05-21ISO 4217 currency code.
USDUser-submitted UUID field that can be used to uniquely reference this resource and provide idempotency against repeat requests with the same UUID.
89fe0192-ddcd-430a-b285-e1396a4725d2Offer code to evaluate for pricing and eligibility. From capability octo/offers.
SUMMER25Rental duration identifier for rental products. From capability octo/rentals.
rental_duration_2hSuccessful response
List of availability local start time values.
["09:00","13:00"]Whether this availability can be booked.
trueAvailable weight numeric value.
20Capacity numeric value.
2Local date in YYYY-MM-DD format.
2026-03-01Max pax count numeric value.
2Max units numeric value.
2Max weight numeric value.
20Pax count numeric value.
2Pax weight numeric value.
20Current status value.
AVAILABLEPossible values: Status message value.
Limited availability for this departure.Utc cutoff at timestamp in ISO 8601 format.
2026-05-14T13:00:00ZUtc onsale at timestamp in ISO 8601 format.
2026-05-14T13:00:00ZVacancies numeric value.
2Weight unit for the weight value.
kgFrom capability octo/offers.
SUMMER25Successful response
Returns detailed availability objects per departure time or day. Use this endpoint before booking to obtain the availabilityId required by booking creation/reservation requests.
Request schema for /availability. productId and optionId are required, and at least one availability selector must be provided (localDate, localDateStart+localDateEnd, availabilityId, or availabilityIds).
Product ID or code.
e7cc8bb4-8d1c-4848-8824-5dbedb718681Option ID or code. Use DEFAULT only when the product has no options.
94cdd032-3d32-416d-b0a4-abf8b7495b8bSingle availability identifier (ISO-8601 local date or date-time).
2026-05-14T09:00:00-04:00Multiple availability identifiers.
["2026-05-14T09:00:00-04:00","2026-05-15T09:00:00-04:00"]ISO 4217 currency code.
USDLocal date in the product timezone (YYYY-MM-DD).
2026-05-14End of local date range in the product timezone (YYYY-MM-DD).
2026-05-21Start of local date range in the product timezone (YYYY-MM-DD).
2026-05-14Local start time in the product timezone (HH:MM).
09:00User-submitted UUID field that can be used to uniquely reference this resource and provide idempotency against repeat requests with the same UUID.
89fe0192-ddcd-430a-b285-e1396a4725d2Offer code to evaluate for pricing and eligibility. From capability octo/offers.
SUMMER25Rental duration identifier for rental products. From capability octo/rentals.
rental_duration_2hSuccessful response
Whether all day is enabled.
falseWhether this availability can be booked.
trueCapacity numeric value.
2Unique identifier for this resource.
94cdd032-3d32-416d-b0a4-abf8b7495b8bLocal date time end timestamp in ISO 8601 format.
2026-03-01T12:00:00-08:00Local date time start timestamp in ISO 8601 format.
2026-03-01T09:00:00-08:00Max pax count numeric value.
2Max units numeric value.
2Pax count numeric value.
2Reference value.
REF-2026-001Current status value.
AVAILABLEPossible values: Status message value.
Limited availability for this departure.Utc cutoff at timestamp in ISO 8601 format.
2026-05-14T13:00:00ZUtc onsale at timestamp in ISO 8601 format.
2026-05-14T13:00:00ZVacancies numeric value.
2From capability octo/offers.
SUMMER25From capability octo/pickups.
trueFrom capability octo/pickups.
trueFrom capability octo/pickups.
trueFrom capability octo/pickups.
trueFrom capability octo/resources.
trueSuccessful response
Returns calendar availability across multiple products/options. Designed for background batch jobs and back-office processing, not realtime client requests. For realtime calendar UX use POST /availability/calendar, then call POST /availability to obtain the availabilityId required for booking.
Request schema for /availability/calendar/batch. Includes the same selectors as /availability/calendar, with optional product filters.
Start local date in YYYY-MM-DD format.
2026-05-14End local date in YYYY-MM-DD format.
2026-05-21Optional multi-product filter.
["e7cc8bb4-8d1c-4848-8824-5dbedb718681","prod_london_hop_on_hop_off"]ISO 4217 currency code.
USDUser-submitted UUID field that can be used to uniquely reference this resource and provide idempotency against repeat requests with the same UUID.
89fe0192-ddcd-430a-b285-e1396a4725d2From capability octo/offers.
SUMMER25From capability octo/rentals.
rental_duration_2hSuccessful response
List of availability local start time values.
["09:00","13:00"]Whether this availability can be booked.
trueAvailable weight numeric value.
20Capacity numeric value.
2Local date in YYYY-MM-DD format.
2026-03-01Max pax count numeric value.
2Max units numeric value.
2Max weight numeric value.
20Option identifier.
94cdd032-3d32-416d-b0a4-abf8b7495b8bPax count numeric value.
2Pax weight numeric value.
20Product identifier.
e7cc8bb4-8d1c-4848-8824-5dbedb718681Current status value.
AVAILABLEPossible values: Status message value.
Limited availability for this departure.Utc cutoff at timestamp in ISO 8601 format.
2026-05-14T13:00:00ZUtc onsale at timestamp in ISO 8601 format.
2026-05-14T13:00:00ZVacancies numeric value.
2Weight unit for the weight value.
kgFrom capability octo/offers.
SUMMER25Successful response
Returns detailed availability across multiple products and options. Designed for background batch jobs and back-office processing, not realtime client requests. For realtime client requests use POST /availability.
Request schema for /availability/batch. Includes the same selectors as /availability, with optional product filters.
Single availability identifier (ISO-8601 local date or date-time).
2026-05-14T09:00:00-04:00Multiple availability identifiers.
["2026-05-14T09:00:00-04:00","2026-05-15T09:00:00-04:00"]ISO 4217 currency code.
USDLocal date in the product timezone (YYYY-MM-DD).
2026-05-14End of local date range in the product timezone (YYYY-MM-DD).
2026-05-21Start of local date range in the product timezone (YYYY-MM-DD).
2026-05-14Local start time in the product timezone (HH:MM).
09:00Optional multi-product filter.
["e7cc8bb4-8d1c-4848-8824-5dbedb718681","prod_london_hop_on_hop_off"]User-submitted UUID field that can be used to uniquely reference this resource and provide idempotency against repeat requests with the same UUID.
89fe0192-ddcd-430a-b285-e1396a4725d2Offer code to evaluate for pricing and eligibility. From capability octo/offers.
SUMMER25Rental duration identifier for rental products. From capability octo/rentals.
rental_duration_2hSuccessful response
Whether all day is enabled.
falseWhether this availability can be booked.
trueCapacity numeric value.
2Unique identifier for this resource.
94cdd032-3d32-416d-b0a4-abf8b7495b8bLocal date time end timestamp in ISO 8601 format.
2026-03-01T12:00:00-08:00Local date time start timestamp in ISO 8601 format.
2026-03-01T09:00:00-08:00Max pax count numeric value.
2Max units numeric value.
2Option identifier.
94cdd032-3d32-416d-b0a4-abf8b7495b8bPax count numeric value.
2Product identifier.
e7cc8bb4-8d1c-4848-8824-5dbedb718681Reference value.
REF-2026-001Current status value.
AVAILABLEPossible values: Status message value.
Limited availability for this departure.Utc cutoff at timestamp in ISO 8601 format.
2026-05-14T13:00:00ZUtc onsale at timestamp in ISO 8601 format.
2026-05-14T13:00:00ZVacancies numeric value.
2From capability octo/offers.
SUMMER25From capability octo/pickups.
trueFrom capability octo/pickups.
trueFrom capability octo/pickups.
trueFrom capability octo/pickups.
trueFrom capability octo/resources.
trueSuccessful response
Last updated