OCTO Website OpenAPI (Swagger)Become a Member

Products

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

Get Products

Get Product

PreviousSupplier NextAvailability

Last updated 9 months ago

Was this helpful?

Get Products

Fetch the list of products.

get

/products

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.example.com/octo/products'

200

[
  {
    "id": "6b903d44-dc24-4ca4-ae71-6bde6c4f4854",
    "internalName": "Amazon River Tour",
    "reference": "AMZN",
    "locale": "en-GB",
    "timeZone": "Europe/London",
    "allowFreesale": true,
    "instantConfirmation": true,
    "instantDelivery": true,
    "availabilityRequired": true,
    "availabilityType": "START_TIME",
    "redemptionMethod": "DIGITAL",
    "deliveryFormats": [
      "QRCODE"
    ],
    "deliveryMethods": [
      "VOUCHER"
    ],
    "options": [
      {
        "id": "DEFAULT",
        "default": true,
        "internalName": "Private Morning Tour",
        "reference": "VIP-MORN",
        "cancellationCutoff": "1 hour",
        "cancellationCutoffAmount": 1,
        "cancellationCutoffUnit": "hour",
        "availabilityLocalStartTimes": [
          "09:00"
        ],
        "requiredContactFields": [
          "firstName"
        ],
        "restrictions": {
          "minUnits": "null",
          "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": true,
              "minQuantity": 2,
              "maxQuantity": 7,
              "paxCount": 1,
              "accompaniedBy": [
                "adult_697e3ce8-1860-4cbf-80ad-95857df1f640"
              ]
            }
          }
        ]
      }
    ]
  }
]

Get Product

Fetch the product for the given id.

get

/products/{id}

Path parameters

idstringrequired

The product id