Extras

Overview

Enable extras (addon products) by adding extras to the Octo-Capabilities header.

Extras are additional products that can be booked alongside the main product, such as equipment rentals, meal add-ons, or insurance.

Products Endpoint

When enabled, each unit in the product response includes an extras array:

{
  "units": [{
    "id": "ADULT_15",
    "extras": [{
      "id": "123",
      "internalName": "Helmet Rental",
      "restrictions": {
        "minQuantity": 0,
        "maxQuantity": 5
      },
      "pricingFrom": [...]
    }]
  }]
}

Availability Check

Include extras in your availability check request to get their availability:

{
  "productId": "42",
  "optionId": "DEFAULT",
  "localDate": "2025-01-15",
  "units": [{
    "id": "ADULT_15",
    "quantity": 2,
    "extras": [{
      "id": "123",
      "quantity": 2
    }]
  }]
}

The response includes extraPricing with availability and pricing for each requested extra:

{
  "id": "2025-01-15T10:00:00+01:00|2025-01-15T12:00:00+01:00",
  "available": true,
  "extraPricing": [{
    "extraId": "123",
    "available": true,
    "vacancies": 5,
    "pricing": [...]
  }]
}

Booking with Extras

Include extras in your booking request using the extraItems array within each unitItem:

{
  "productId": "42",
  "optionId": "DEFAULT",
  "availabilityId": "2025-01-15T10:00:00+01:00|2025-01-15T12:00:00+01:00",
  "unitItems": [{
    "unitId": "ADULT_15",
    "extraItems": [{
      "extraId": "123"
    }]
  }]
}

The booking response includes the booked extras in unitItems[].extraItems.