Availability

Check product availability. Use the calendar endpoint for date-level availability, and the check endpoint for specific time slots with vacancy counts.

Get availability calendar

post

Returns a calendar overview of availability for a date range.

Authorizations

bearerAuth

AuthorizationstringRequired

OCTO API Bearer token authentication

Header parameters

Octo-CapabilitiesstringRequired

Comma-separated list of capabilities (pricing, content)

Example: pricing,content

Accept-LanguagestringOptional

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

Example: sv

Body

application/json

productIdstringRequiredExample: 42

optionIdstringRequiredExample: DEFAULT

localDateStartstring · dateRequiredExample: 2025-01-15

localDateEndstring · dateRequiredExample: 2025-01-31

Responses

200

Availability calendar

application/json

400

Invalid product ID or option ID

application/json

401

Unauthorized

post

/availability/calendar

HTTPcURLJavaScriptPython

POST /octo/v1/availability/calendar HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Octo-Capabilities: pricing,content
Content-Type: application/json
Accept: */*
Content-Length: 134

{
  "productId": "42",
  "optionId": "DEFAULT",
  "localDateStart": "2025-01-15",
  "localDateEnd": "2025-01-31",
  "units": [
    {
      "id": "text",
      "quantity": 1
    }
  ]
}

[
  {
    "localDate": "2025-01-15",
    "available": true,
    "status": "AVAILABLE",
    "openingHours": [
      {}
    ]
  }
]

Check availability

post

Returns detailed availability for specific dates/times. When the extras capability is enabled, include extras in units to get extraPricing in the response.

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

Body

application/json

productIdstringRequiredExample: 42

optionIdstringRequiredExample: DEFAULT

localDatestring · dateOptionalExample: 2025-01-15

localDateStartstring · dateOptional

localDateEndstring · dateOptional

availabilityIdsstring[]Optional

Responses

200

Availability details with optional extraPricing

application/json

400

Invalid product ID, option ID, or bad request

application/json

401

Unauthorized

post

/availability

HTTPcURLJavaScriptPython

POST /octo/v1/availability HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Octo-Capabilities: pricing,content,extras
Content-Type: application/json
Accept: */*
Content-Length: 227

{
  "productId": "42",
  "optionId": "DEFAULT",
  "localDate": "2025-01-15",
  "localDateStart": "2025-12-21",
  "localDateEnd": "2025-12-21",
  "availabilityIds": [
    "text"
  ],
  "units": [
    {
      "id": "ADULT_15",
      "quantity": 2,
      "extras": [
        {
          "id": "123",
          "quantity": 2
        }
      ]
    }
  ]
}

[
  {
    "id": "2025-01-15T10:00:00+01:00|2025-01-15T12:00:00+01:00",
    "localDateTimeStart": "2025-01-15T10:00:00+01:00",
    "localDateTimeEnd": "2025-01-15T12:00:00+01:00",
    "allDay": true,
    "available": true,
    "status": "AVAILABLE",
    "vacancies": 1,
    "capacity": 1,
    "utcCutoffAt": "2025-12-21T16:24:40.925Z",
    "unitPricing": [
      {
        "unitId": "ADULT_15",
        "pricing": [
          {
            "original": 10000,
            "retail": 10000,
            "net": 8000,
            "currency": "SEK",
            "currencyPrecision": 2,
            "includedTaxes": [
              {
                "name": "VAT",
                "retail": 2000,
                "net": 1600
              }
            ]
          }
        ]
      }
    ],
    "extraPricing": [
      {
        "extraId": "123",
        "available": true,
        "vacancies": 5,
        "pricing": [
          {
            "original": 10000,
            "retail": 10000,
            "net": 8000,
            "currency": "SEK",
            "currencyPrecision": 2,
            "includedTaxes": [
              {
                "name": "VAT",
                "retail": 2000,
                "net": 1600
              }
            ]
          }
        ]
      }
    ]
  }
]