Availability

The first step when making a sale is to check for availability. Note if allowFreesale is set to true on the product then this step is optional but it is advised you check it anyway if you can to check for closures.

OCTO has two main availability calls:

Availability Calendar endpoint is designed to be highly optimized and returns a single object per day. It's designed to be queried for large date ranges and the result is used to populate an availability calendar.

Availability Check endpoint may be slightly slower as it will return an object for each individual departure time (or day).

Availability Calendar

Availability Calendar

This endpoint is highly optimised and will return a single object per day. It's designed to be queried for large date ranges and the result is used to populate an availability calendar.

When the end user selects an open date you can call on /availability endpoint to get the availabilityId to create the booking.

post

/availability/calendar

Body

productIdstringrequired

The product id.

Example: 6b903d44-dc24-4ca4-ae71-6bde6c4f4854

optionIdstringrequired

The option id.

Example: DEFAULT

localDateStartstringrequired

Start date to query for (YYYY-MM-DD).

Example: 2022-05-23

localDateEndstringrequired

End date to query for (YYYY-MM-DD).

Example: 2022-05-29

unitsobject[]

A list of units.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.example.com/octo/availability/calendar' \
  --header 'Content-Type: application/json' \
  --data '{"productId":"6b903d44-dc24-4ca4-ae71-6bde6c4f4854","optionId":"DEFAULT","localDateStart":"2022-06-14","localDateEnd":"2022-06-16"}'

200

400

200

START_TIMES

OPENING_HOURS

START_TIMES

[
  {
    "localDate": "2022-06-14",
    "available": true,
    "status": "AVAILABLE",
    "vacancies": 20,
    "capacity": 20,
    "openingHours": []
  },
  {
    "localDate": "2022-06-15",
    "available": true,
    "status": "AVAILABLE",
    "vacancies": 10,
    "capacity": 10,
    "openingHours": []
  },
  {
    "localDate": "2022-06-16",
    "available": true,
    "status": "AVAILABLE",
    "vacancies": 10,
    "capacity": 10,
    "openingHours": []
  }
]

OK

Availability Check

A reseller has to perform Availability Check to retrieve an availabilityId in order to make a Booking Reservation, so this endpoint is critical for the booking flow.

Availability Check

This endpoint is slightly slower as it will return an object for each individual departure time (or day). You have to perform this step to retrieve an availabilityId in order to confirm a sale, so if you just want to use this endpoint and skip the calendar endpoint then that's perfectly ok.

You must pass in one of the following combinations of parameters for this endpoint:

• localDate
• localeDateStart and localDateEnd
• availabilityIds

post

/availability

Body

productIdstringrequired

The product id.

Example: 6b903d44-dc24-4ca4-ae71-6bde6c4f4854

optionIdstringrequired

The option id.

Example: DEFAULT

localDateStartstring · date

Start date to query for (YYYY-MM-DD). Required if localDateEnd is set.

Example: 2022-05-23

localDateEndstring · date

End date to query for (YYYY-MM-DD). Required if localDateStart is set.

Example: 2022-05-29

availabilityIdsstring[]

Filter the results by the given ids.

Example: ["2022-05-23T00:00:00+01:00"]

unitsobject[]

A list of units.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.example.com/octo/availability' \
  --header 'Content-Type: application/json' \
  --data '{"productId":"6b903d44-dc24-4ca4-ae71-6bde6c4f4854","optionId":"DEFAULT","localDateStart":"2022-05-23","localDateEnd":"2022-05-29"}'

200

400

200

START_TIMES

OPENING_HOURS

START_TIMES

[
  {
    "id": "2022-06-30T12:00:00+01:00",
    "localDateTimeStart": "2022-06-30T12:00:00+01:00",
    "localDateTimeEnd": "2022-06-30T14:00:00+01:00",
    "allDay": false,
    "available": true,
    "status": "AVAILABLE",
    "vacancies": 10,
    "capacity": 10,
    "maxUnits": null,
    "utcCutoffAt": "2022-06-30T10:00:00Z",
    "openingHours": []
  },
  {
    "id": "2022-06-30T14:00:00+01:00",
    "localDateTimeStart": "2022-06-30T14:00:00+01:00",
    "localDateTimeEnd": "2022-06-30T16:00:00+01:00",
    "allDay": false,
    "available": true,
    "status": "AVAILABLE",
    "vacancies": 10,
    "capacity": 10,
    "maxUnits": null,
    "utcCutoffAt": "2022-06-30T12:00:00Z",
    "openingHours": []
  }
]

OK