OCTO Developer Hub
OCTO WebsiteOpenAPI (Swagger)Become a Member
  • Welcome
  • Getting Started
    • Glossary of Terms
    • Errors
    • Headers
    • Authentication
    • Endpoints & Capabilities
    • Schemas
    • Development Support
  • OCTO API Core
    • Supplier
    • Products
    • Availability
    • Bookings
  • Capabilities (Optional)
    • Pricing
    • Notifications
    • Content
    • Pickups (Proposed Draft)
    • Promotions (Proposed Draft)
  • Additional Resources
    • Validation Tool
    • Postman Collections
    • Known Implementations
Powered by GitBook
On this page

Was this helpful?

  1. OCTO API Core

Products

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

PreviousSupplierNextAvailability

Last updated 1 year ago

Was this helpful?

Get Products

Get Product

Get Products

get

Fetch the list of products.

Responses
200
OK
application/json
get
GET /octo/products HTTP/1.1
Host: api.example.com
Accept: */*
200

OK

[
  {
    "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",
    "deliveryFormats": [
      "QRCODE"
    ],
    "deliveryMethods": [
      "VOUCHER"
    ],
    "redemptionMethod": "DIGITAL",
    "options": [
      {
        "id": "DEFAULT",
        "default": true,
        "internalName": "Private Morning Tour",
        "reference": "VIP-MORN",
        "availabilityLocalStartTimes": [
          "09:00"
        ],
        "cancellationCutoff": "1 hour",
        "cancellationCutoffAmount": 1,
        "cancellationCutoffUnit": "hour",
        "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

get

Fetch the product for the given id.

Path parameters
idstringRequired

The product id

Responses
200
OK
application/json
get
GET /octo/products/{id} HTTP/1.1
Host: api.example.com
Accept: */*
200

OK

{
  "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",
  "deliveryFormats": [
    "QRCODE"
  ],
  "deliveryMethods": [
    "VOUCHER"
  ],
  "redemptionMethod": "DIGITAL",
  "options": [
    {
      "id": "DEFAULT",
      "default": true,
      "internalName": "Private Morning Tour",
      "reference": "VIP-MORN",
      "availabilityLocalStartTimes": [
        "09:00"
      ],
      "cancellationCutoff": "1 hour",
      "cancellationCutoffAmount": 1,
      "cancellationCutoffUnit": "hour",
      "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 Products
  • GETGet Products
  • Get Product
  • GETGet Product