Products

Fetch the product for the given id or the list of products available to you.

Get Products

Get Products

Fetch the list of products.

GEThttps://api.example.com/octo/products

Response

200

OK

Body

application/json

id*string

The id used for checking for availability and creating bookings for the product. This MUST be unique within the scope of the Supplier.

internalName*string

The name the supplier calls the product.

reference*nullstring

An optional code this supplier might use to identify the product.

locale*string

A language code indicating what language this product content is in. This MUST be a valid BCP 47 RFC 5646 RFC 4647 language tag.

timeZonestring

The IANA TimeZone name this product is located in.

allowFreesale*boolean

Whether a booking can be made for this product without having to query availability first.

instantConfirmation*boolean

Whether bookings will be immediately confirmed when a sale is made, otherwise the supplier will later either accept or reject the booking. When instantConfirmation is set to false one should expect created bookings to first get into a PENDING state.

instantDelivery*boolean

This indicates whether the Reseller can expect immediate delivery of the customer's tickets. If false then the Reseller MUST be able to delay delivery of the tickets to the customer.

availabilityRequired*boolean

Whether an availabilityId is required when creating a booking. Without this the booking will be open-dated and not have a specified travel date.

availabilityType*AvailabilityType

What type of availability this product has, possible values are: START_TIME if there are fixed departure times which you must pick one. Typical for day tours or activities. OPENING_HOURS if you just select a date and can visit any time when the venue is open.

START_TIMEOPENING_HOURS

deliveryFormats*array of DeliveryFormat

An array of formats the API will deliver the tickets as. Possible values are: QRCODE A code to be presented as a QR CODE barcode CODE128A code to be presented as a CODE 128 barcode PDF_URL A URL to a PDF file which contains all the ticket details

deliveryMethods*array of DeliveryMethod

How the formats described in deliveryFormats will be delivered in the booking response, possible values are: TICKET: Individually per unit in the order (i.e. single ticket for each person) VOUCHER: One ticket for the whole booking

redemptionMethod*RedemptionMethod

How the voucher can be redeemed. Possible values are: MANIFEST The guest name will be written down and they just need to show up DIGITAL The tickets/voucher must be scanned but can be on mobile PRINT The tickets/voucher must be printed and presented on arrival

DIGITALPRINTMANIFEST

options*array of object

An array of all options for this product. All products must have at least one option.

Request

JavaScriptCurl

const response = await fetch('https://api.example.com/octo/products', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "id": "6b903d44-dc24-4ca4-ae71-6bde6c4f4854",
    "internalName": "Amazon River Tour",
    "reference": "AMZN",
    "locale": "en-GB",
    "timeZone": "Europe/London",
    "allowFreesale": false,
    "instantConfirmation": false,
    "instantDelivery": false,
    "availabilityRequired": false,
    "availabilityType": "START_TIME",
    "deliveryFormats": [
      "QRCODE"
    ],
    "deliveryMethods": [
      "VOUCHER"
    ],
    "redemptionMethod": "DIGITAL",
    "options": [
      {
        "id": "DEFAULT",
        "default": false,
        "internalName": "Private Morning Tour",
        "reference": "VIP-MORN",
        "availabilityLocalStartTimes": [
          "09:00"
        ],
        "cancellationCutoff": "1 hour",
        "cancellationCutoffAmount": 1,
        "cancellationCutoffUnit": "hour",
        "requiredContactFields": [
          "firstName"
        ],
        "restrictions": {
          "maxUnits": 10
        },
        "units": [
          {
            "id": "adult_697e3ce8-1860-4cbf-80ad-95857df1f640",
            "internalName": "Adult(s)",
            "reference": "LR1-01-new",
            "type": "YOUTH",
            "requiredContactFields": [
              "firstName"
            ],
            "restrictions": {
              "minAge": 3,
              "maxAge": 17,
              "idRequired": false,
              "minQuantity": 2,
              "maxQuantity": 7,
              "paxCount": 1,
              "accompaniedBy": [
                "adult_697e3ce8-1860-4cbf-80ad-95857df1f640"
              ]
            }
          }
        ]
      }
    ]
  }
]

Get Product

Get Product

Fetch the product for the given id.

GEThttps://api.example.com/octo/products/{id}

Path parameters

id*string

The product id

Response

200

OK

Body

application/json

id*string

The id used for checking for availability and creating bookings for the product. This MUST be unique within the scope of the Supplier.

internalName*string

The name the supplier calls the product.

reference*nullstring

An optional code this supplier might use to identify the product.

locale*string

A language code indicating what language this product content is in. This MUST be a valid BCP 47 RFC 5646 RFC 4647 language tag.

timeZonestring

The IANA TimeZone name this product is located in.

allowFreesale*boolean

Whether a booking can be made for this product without having to query availability first.

instantConfirmation*boolean

Whether bookings will be immediately confirmed when a sale is made, otherwise the supplier will later either accept or reject the booking. When instantConfirmation is set to false one should expect created bookings to first get into a PENDING state.

instantDelivery*boolean

This indicates whether the Reseller can expect immediate delivery of the customer's tickets. If false then the Reseller MUST be able to delay delivery of the tickets to the customer.

availabilityRequired*boolean

Whether an availabilityId is required when creating a booking. Without this the booking will be open-dated and not have a specified travel date.

availabilityType*AvailabilityType

What type of availability this product has, possible values are: START_TIME if there are fixed departure times which you must pick one. Typical for day tours or activities. OPENING_HOURS if you just select a date and can visit any time when the venue is open.

START_TIMEOPENING_HOURS

deliveryFormats*array of DeliveryFormat

An array of formats the API will deliver the tickets as. Possible values are: QRCODE A code to be presented as a QR CODE barcode CODE128A code to be presented as a CODE 128 barcode PDF_URL A URL to a PDF file which contains all the ticket details

deliveryMethods*array of DeliveryMethod

How the formats described in deliveryFormats will be delivered in the booking response, possible values are: TICKET: Individually per unit in the order (i.e. single ticket for each person) VOUCHER: One ticket for the whole booking

redemptionMethod*RedemptionMethod

How the voucher can be redeemed. Possible values are: MANIFEST The guest name will be written down and they just need to show up DIGITAL The tickets/voucher must be scanned but can be on mobile PRINT The tickets/voucher must be printed and presented on arrival

DIGITALPRINTMANIFEST

options*array of object

An array of all options for this product. All products must have at least one option.

Request

JavaScriptCurl

const response = await fetch('https://api.example.com/octo/products/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "6b903d44-dc24-4ca4-ae71-6bde6c4f4854",
  "internalName": "Amazon River Tour",
  "reference": "AMZN",
  "locale": "en-GB",
  "timeZone": "Europe/London",
  "allowFreesale": false,
  "instantConfirmation": false,
  "instantDelivery": false,
  "availabilityRequired": false,
  "availabilityType": "START_TIME",
  "deliveryFormats": [
    "QRCODE"
  ],
  "deliveryMethods": [
    "VOUCHER"
  ],
  "redemptionMethod": "DIGITAL",
  "options": [
    {
      "id": "DEFAULT",
      "default": false,
      "internalName": "Private Morning Tour",
      "reference": "VIP-MORN",
      "availabilityLocalStartTimes": [
        "09:00"
      ],
      "cancellationCutoff": "1 hour",
      "cancellationCutoffAmount": 1,
      "cancellationCutoffUnit": "hour",
      "requiredContactFields": [
        "firstName"
      ],
      "restrictions": {
        "maxUnits": 10
      },
      "units": [
        {
          "id": "adult_697e3ce8-1860-4cbf-80ad-95857df1f640",
          "internalName": "Adult(s)",
          "reference": "LR1-01-new",
          "type": "YOUTH",
          "requiredContactFields": [
            "firstName"
          ],
          "restrictions": {
            "minAge": 3,
            "maxAge": 17,
            "idRequired": false,
            "minQuantity": 2,
            "maxQuantity": 7,
            "paxCount": 1,
            "accompaniedBy": [
              "adult_697e3ce8-1860-4cbf-80ad-95857df1f640"
            ]
          }
        }
      ]
    }
  ]
}