Extras

Extras are upsell items that can be added to bookings and unit items

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

Extras are upsell items that can be configured either on the booking (option-level) or per unit item (unit-level). An example of an extra could be a "Lunch Package" or a "Fast Track Entrance".

Product Extras

This capability extends product routes documented in Products:

• GET /products

• GET /products/{productId}

Available extras are returned in the product response as:

• option.extras for booking-level extras

• unit.extras for unit-level extras

When combined with octo/pricing and octo/content, extra objects include pricing/content keys. Pricing values use the same schema as unit pricing. Read pricing capability for full pricing field details.

Extra IDs are returned as extra_<id> in responses. For request payloads, both extra_<id> and raw IDs are accepted.

For item-based products, item objects still include extras, but it is always an empty array.

Extra Availability

This capability extends availability routes documented in Availability:

• POST /availability

• POST /availability/calendar

• POST /availability/batch

• POST /availability/calendar/batch

Extras do not require availability by themselves, but you can include extra quantities in availability queries to calculate total pricing.

If an extra quantity exceeds configured limits, the API responds with:

• EXTRAS_QTY_LIMIT for booking-level extras

• EXTRAS_UNIT_QTY_LIMIT for unit-level extras

See Availability for the base request/response schema.

When used with octo/pricing, availability pricing includes both extra pricing breakdowns and totals.

extraPricingFrom is used instead of extraPricing on "from" payloads.

Booking Reservation

This capability extends booking write routes documented in Bookings:

• POST /bookings

• PATCH /bookings/{uuid}

• POST /bookings/{uuid}/confirm

Use extraItems to reserve extras on bookings:

• Booking-level extras: set extraItems on the booking object.

• Unit-level extras: set extraItems inside each unitItems[] object.

When extraItems is present it must be an array.

uuid and resellerReference are optional. contact is also permitted as an object. The same extra can be included multiple times if allowed by the extra configuration.

Booking and unit item responses both include extraItems with the same object schema.

When using the octo/pricing capability, the booking/unit-item pricing totals include the sum of attached extra items. For purchase unit items, extraItems is always an empty array.

Schema Additions (JSON)

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

AvailabilityBatchRequest

{
  "// ...rest of availability batch request object": "...",
  "extras": [
    {
      "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
      "quantity": 2
    }
  ]
}

AvailabilityCalendarBatchRequest

{
  "// ...rest of availability calendar batch request object": "...",
  "extras": [
    {
      "id": "f1a5d2e8-8d57-4f0b-9c3f-6a12d7a8bc90",
      "quantity": 2
    }
  ]
}

AvailabilityCalendarRequest

{
  "// ...rest of availability calendar request object": "...",
  "extras": [
    {
      "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
      "quantity": 2
    }
  ]
}

AvailabilityRequest

{
  "// ...rest of availability request object": "...",
  "extras": [
    {
      "id": "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
      "quantity": 2
    }
  ]
}

Booking

{
  "// ...rest of booking object": "...",
  "extraItems": [
    {
      "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "uuid": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "resellerReference": "RES-BOOK-10045",
      "supplierReference": "SUP-BOOK-7782",
      "extraId": "extra_fast_track",
      "extra": {
        "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
        "internalName": "Fast Track Entry",
        "reference": "extra_fast_track",
        "title": "Fast Track Entry"
      },
      "status": "CONFIRMED",
      "utcRedeemedAt": "2026-05-14T13:00:00Z",
      "contact": {
        "fullName": "Jane Doe",
        "emailAddress": "[email protected]"
      },
      "visibleContactFields": [
        "fullName",
        "emailAddress"
      ],
      "requiredContactFields": [
        "fullName",
        "emailAddress"
      ],
      "ticket": {
        "redemptionMethod": "DIGITAL",
        "utcRedeemedAt": "2026-05-14T13:00:00Z",
        "utcNoshowedAt": "2026-05-14T13:00:00Z",
        "deliveryOptions": [
          {
            "deliveryFormat": "PDF_URL",
            "deliveryValue": "https://api.ventrata.com/octo/download/signed-message"
          }
        ]
      },
      "pricing": {
        "original": 22000,
        "retail": 20000,
        "net": 18000,
        "currency": "USD",
        "currencyPrecision": 2,
        "includedTaxes": [
          {
            "name": "Sales Tax",
            "shortDescription": "Local sales tax",
            "original": 2000,
            "retail": 1800,
            "net": 1600
          }
        ],
        "offerDiscount": {
          "retail": 2000,
          "net": 2000,
          "includedTaxes": [
            {
              "name": "Sales Tax",
              "shortDescription": "Local sales tax",
              "retail": 200,
              "net": 200
            }
          ]
        }
      },
      "offerCode": "SUMMER25",
      "offerTitle": "Summer Promotion",
      "offerIsCombination": true,
      "offerComparisons": [
        {
          "offerCode": "SUMMER25",
          "offerTitle": "Summer Promotion",
          "pricing": {
            "original": 2300,
            "retail": 2300,
            "net": 1610,
            "currency": "EUR",
            "currencyPrecision": 2,
            "includedTaxes": [
              {
                "name": "10%",
                "shortDescription": null,
                "original": 209,
                "retail": 209,
                "net": 146
              }
            ]
          },
          "offer": {
            "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
            "title": "Summer Promotion",
            "code": "SUMMER25"
          }
        }
      ],
      "offer": {
        "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
        "title": "Summer Promotion",
        "code": "SUMMER25"
      },
      "offers": [
        {
          "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
          "title": "Summer Promotion",
          "code": "SUMMER25"
        }
      ]
    }
  ]
}

BookingUnitItem

{
  "// ...rest of booking unit item object": "...",
  "extraItems": [
    {
      "id": "a0d0f264-e244-461f-8612-4b175f8fa9e6",
      "uuid": "3f8b16ff-8e6d-49b4-a4ca-c0b4a137cc1b",
      "extraId": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
      "status": "CONFIRMED"
    }
  ]
}

BookingUnitItemWriteRequest

{
  "// ...rest of booking unit item write request object": "...",
  "extraItems": [
    {
      "extraId": "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
      "quantity": 2
    }
  ]
}

BookingWriteRequest

{
  "// ...rest of booking write request object": "...",
  "extraItems": [
    {
      "extraId": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
      "quantity": 2
    }
  ]
}

Option

{
  "// ...rest of option object": "...",
  "extras": [
    {
      "id": "89fe0192-ddcd-430a-b285-e1396a4725d2",
      "internalName": "Fast Track Entry",
      "reference": "extra_fast_track",
      "title": "Fast Track Entry"
    }
  ]
}

Unit

{
  "// ...rest of unit object": "...",
  "extras": [
    {
      "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
      "internalName": "Fast Track Entry",
      "reference": "extra_fast_track",
      "title": "Fast Track Entry"
    }
  ]
}