Rentals

Adds rental duration selection and rental metadata to OCTO endpoints.

To use this capability, add octo/rentals to your Octo-Capabilities header.

Rentals adds duration selection for rental products and exposes rental metadata on product, option, and booking responses.

Operations below use the /octo prefix.

Rental Product Data

This capability extends product routes documented in Products:

• GET /products

• GET /products/{productId}

Rental Duration Object

Used by option.rentalDurations[] and booking.rentalDuration.

Base product schema: Products.

Always use ids returned by option.rentalDurations[]. Unsupported duration units return INVALID_RENTAL_DURATION_ID.

Rental Availability

This capability extends availability routes documented in Availability:

• POST /availability

• POST /availability/calendar

• POST /availability/batch

• POST /availability/calendar/batch

Request Fields Added by Rentals

Base availability schema: Availability.

Rentals does not add new availability response fields. The selected duration is applied to availability and pricing calculation.

Rental Booking

The same rentalDurationId request field is supported on all booking write routes that use create_booking:

• POST /bookings

• PATCH /bookings/{uuid}

• POST /bookings/{uuid}/confirm

Request Field

Base booking schema: Bookings.

Added Booking Response Fields

These are additive response fields on the base booking schema from Bookings.

These booking fields are returned on booking write routes above and booking read/cancel/extend routes that serialize bookings (GET /octo/bookings, GET /octo/bookings/:uuid, POST /octo/bookings/:uuid/cancel, POST /octo/bookings/:uuid/extend).

Schema Additions (JSON)

These are additive fragments showing only fields introduced by this capability.

AvailabilityBatchRequest

{
  "// ...rest of availability batch request object": "...",
  "rentalDurationId": "rental_duration_2h"
}

AvailabilityCalendarBatchRequest

{
  "// ...rest of availability calendar batch request object": "...",
  "rentalDurationId": "rental_duration_2h"
}

AvailabilityCalendarRequest

{
  "// ...rest of availability calendar request object": "...",
  "rentalDurationId": "rental_duration_2h"
}

AvailabilityRequest

{
  "// ...rest of availability request object": "...",
  "rentalDurationId": "rental_duration_2h"
}

Booking

{
  "// ...rest of booking object": "...",
  "rentalDurationId": "rental_duration_2h",
  "rentalDuration": {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "duration": "2",
    "durationAmount": 220.0,
    "durationUnit": "HOUR",
    "title": "Summer Promotion",
    "description": "Morning departure with central pickup included."
  }
}

BookingWriteRequest

{
  "// ...rest of booking write request object": "...",
  "rentalDurationId": "rental_duration_2h"
}

Option

{
  "// ...rest of option object": "...",
  "rentalDurations": [
    {
      "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
      "title": "Summer Promotion",
      "duration": "2",
      "durationAmount": 220.0
    }
  ]
}

Product

{
  "// ...rest of product object": "...",
  "isRental": true
}