Products

List and retrieve products available for booking. Products contain options and units that define what can be booked and at what price.

List all products

get

Returns a list of all products available for booking. Use the extras capability to include extras for each unit.

Authorizations

bearerAuth

AuthorizationstringRequired

OCTO API Bearer token authentication

Header parameters

Octo-CapabilitiesstringRequired

Comma-separated list of capabilities (pricing, content, extras)

Example: pricing,content,extras

Accept-LanguagestringOptional

Preferred language for content (ISO 639-1 code). Only used when content capability is enabled.

Example: sv

Responses

200

List of products

application/json

401

Unauthorized

get

/products

HTTPcURLJavaScriptPython

GET /octo/v1/products HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Octo-Capabilities: pricing,content,extras
Accept: */*

[
  {
    "id": "42",
    "internalName": "Bike Tour",
    "reference": "text",
    "locale": "sv",
    "timeZone": "Europe/Stockholm",
    "availabilityType": "START_TIME",
    "deliveryFormats": "PDF_URL",
    "deliveryMethods": [
      "text"
    ],
    "options": [
      {
        "id": "DEFAULT",
        "default": true,
        "internalName": "text",
        "restrictions": {},
        "units": [
          {
            "id": "ADULT_15",
            "internalName": "Adult ticket",
            "reference": "text",
            "type": "ADULT",
            "restrictions": {},
            "requiredContactFields": [
              "text"
            ],
            "pricingFrom": [
              {
                "original": 10000,
                "retail": 10000,
                "net": 8000,
                "currency": "SEK",
                "currencyPrecision": 2,
                "includedTaxes": [
                  {
                    "name": "VAT",
                    "retail": 2000,
                    "net": 1600
                  }
                ]
              }
            ],
            "extras": [
              {
                "id": "123",
                "internalName": "Helmet Rental",
                "reference": "HELMET-001",
                "restrictions": {
                  "minQuantity": 0,
                  "maxQuantity": 10
                },
                "pricingFrom": [
                  {
                    "original": 10000,
                    "retail": 10000,
                    "net": 8000,
                    "currency": "SEK",
                    "currencyPrecision": 2,
                    "includedTaxes": [
                      {
                        "name": "VAT",
                        "retail": 2000,
                        "net": 1600
                      }
                    ]
                  }
                ],
                "title": "Safety Helmet Rental",
                "description": "High-quality safety helmet for your adventure"
              }
            ]
          }
        ]
      }
    ],
    "title": "text",
    "shortDescription": "text",
    "pricingFrom": [
      {
        "original": 10000,
        "retail": 10000,
        "net": 8000,
        "currency": "SEK",
        "currencyPrecision": 2,
        "includedTaxes": [
          {
            "name": "VAT",
            "retail": 2000,
            "net": 1600
          }
        ]
      }
    ]
  }
]

Get a single product

get

Returns details for a specific product. Use the extras capability to include extras for each unit.

Authorizations

bearerAuth

AuthorizationstringRequired

OCTO API Bearer token authentication

Path parameters

idstringRequired

Product ID

Header parameters

Octo-CapabilitiesstringRequired

Comma-separated list of capabilities (pricing, content, extras)

Example: pricing,content,extras

Accept-LanguagestringOptional

Preferred language for content (ISO 639-1 code). Only used when content capability is enabled.

Example: sv

Responses

200

Product details

application/json

400

Invalid product ID

application/json

401

Unauthorized

get

/products/{id}

HTTPcURLJavaScriptPython

GET /octo/v1/products/{id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Octo-Capabilities: pricing,content,extras
Accept: */*

{
  "id": "42",
  "internalName": "Bike Tour",
  "reference": "text",
  "locale": "sv",
  "timeZone": "Europe/Stockholm",
  "availabilityType": "START_TIME",
  "deliveryFormats": "PDF_URL",
  "deliveryMethods": [
    "text"
  ],
  "options": [
    {
      "id": "DEFAULT",
      "default": true,
      "internalName": "text",
      "restrictions": {},
      "units": [
        {
          "id": "ADULT_15",
          "internalName": "Adult ticket",
          "reference": "text",
          "type": "ADULT",
          "restrictions": {},
          "requiredContactFields": [
            "text"
          ],
          "pricingFrom": [
            {
              "original": 10000,
              "retail": 10000,
              "net": 8000,
              "currency": "SEK",
              "currencyPrecision": 2,
              "includedTaxes": [
                {
                  "name": "VAT",
                  "retail": 2000,
                  "net": 1600
                }
              ]
            }
          ],
          "extras": [
            {
              "id": "123",
              "internalName": "Helmet Rental",
              "reference": "HELMET-001",
              "restrictions": {
                "minQuantity": 0,
                "maxQuantity": 10
              },
              "pricingFrom": [
                {
                  "original": 10000,
                  "retail": 10000,
                  "net": 8000,
                  "currency": "SEK",
                  "currencyPrecision": 2,
                  "includedTaxes": [
                    {
                      "name": "VAT",
                      "retail": 2000,
                      "net": 1600
                    }
                  ]
                }
              ],
              "title": "Safety Helmet Rental",
              "description": "High-quality safety helmet for your adventure"
            }
          ]
        }
      ]
    }
  ],
  "title": "text",
  "shortDescription": "text",
  "pricingFrom": [
    {
      "original": 10000,
      "retail": 10000,
      "net": 8000,
      "currency": "SEK",
      "currencyPrecision": 2,
      "includedTaxes": [
        {
          "name": "VAT",
          "retail": 2000,
          "net": 1600
        }
      ]
    }
  ]
}