Extras
Extras are up-sell items that can be added to unit items
To use this capability add
octo/extras to your Octo-Capabilities header.Extras are up-sell items that can be added to unit items. An example of an extra could be a "Lunch Package" or a "Fast Track Entrance".
get
https://api.ventrata.com/octo
/products/:id
Product Extras
Extra items must be purchased within a unit item, therefore a list of available extras will be contained within the unit object, like so:
{
// rest of the unit object
"extras": [
{
"id": "12d7eb39-da3b-4b09-ac3d-a2e55f12e4a4",
"internalName": "Fast Track Entrance",
"title": "Fast Track Entrance",
"description": "Skip the queue and get to the front of the line saving as much as 2 hours.",
"reference": "FAST-123",
"restrictions": {
"minQuantity": 1,
"maxQuantity": 1
},
"pricingFrom": [
{
"original": 800,
"retail": 600,
"net": 450,
"currency": "USD",
"currencyPrecision": 2,
"includedTaxes": []
}
]
}
]
}
The example above includes the
octo/pricing and octo/content capabilities which will add the pricing and pricingFrom keys to the response. The values will be identical to the pricing fields on unit so read the documentation on the pricing capability to learn more.Field | Description |
|---|---|
id | The ID of the extra |
internalName | The internal name of the extra |
title | The public title of the extra.
This is provided by the octo/content capability. |
description | The public description of the extra.
This is provided by the octo/content capability. |
reference | The internal reference/SKU |
restrictions.minQuantity | The minimum quantity that can be bought of this extra per unit item. |
restrictions.maxQuantity | The maximum quantity that can be bought of this extra per unit item.
If this value is 1 then it can only be bought once per unit item. |
pricingFrom / pricing | These fields come from the octo/pricing capability. Read the documentation on the pricing capability to learn what these fields mean. |
Extras don't require vacancies and aren't affected by availability, so any extra you see on the product can be purchased without needing to check availability.
post
https://api.ventrata.com/octo
/bookings
Booking Reservation
{
//..rest of the unit item object
"extraItems": [
{
"uuid": "6f5364b4-f29e-4b17-8544-679ee643a606",
"extraId": "12d7eb39-da3b-4b09-ac3d-a2e55f12e4a4",
"resellerReference": "TEST-31242"
}
]
}
The
uuid and resellerReference fields are optional and you can include as many extras (even the same extra more than once - if it's allowed) to the unit item.The unit item object will contain the
extraItems array which will look like this:{
// The rest of the unit item object
"extraItems": [
{
"uuid": "6f5364b4-f29e-4b17-8544-679ee643a606",
"resellerReference": "TEST-31242",
"supplierReference": "G7PCF6",
"extraId": "12d7eb39-da3b-4b09-ac3d-a2e55f12e4a4",
"extra": {
"id": "12d7eb39-da3b-4b09-ac3d-a2e55f12e4a4",
"internalName": "Fast Track Entrance",
"title": "Fast Track Entrance",
"description": "Skip the queue and get to the front of the line saving as much as 2 hours.",
"reference": "FAST-123",
"restrictions": {
"minQuantity": 1,
"maxQuantity": 1
}
},
"pricing": {
"original": 800,
"retail": 600,
"net": 450,
"currency": "USD",
"currencyPrecision": 2,
"includedTaxes": []
}
}
]
}
When using the
octo/pricing capability, the pricing of the unit item will always include the sum of the extra items that it has.Last modified 1yr ago