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 Cloud has two main availability calls:
GET /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.
GET /availability 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.
We will document both endpoints below.
postAvailability Calendar
[{"localDate": "2020-07-01","status": "AVAILABLE","available": true,"capacity": 24,"openingHours": [{ "from": "09:00", "to": "12:00" },{ "from": "15:00", "to": "18:00" }]},{"localDate": "2020-07-02","status": "CLOSED","available": false,"capacity": null,"openingHours": []}]
The availability calendar can optionally take an array of units if you already know what they are and will automatically show availabilities as sold out if they have insufficient space.
POST /availability/calendar{"productId": "1a7213eb-3a33-4cbb-b114-64d771c201ac","optionId": "DEFAULT","localDateStart": "2020-07-01","localDateEnd": "2020-07-03","units": [{ "id": "adult", "quantity": 2 },{ "id": "child", "quantity": 1 }]}
The response will be an array of objects, one for each day between the range given in localDateStart and localDateEnd. Each object is defined as:
Field | Description |
| The date (in format YYYY-MM-DD) |
| The status of that date. Possible values are:
|
| A boolean value (true or false) indicating whether you're able to sell tickets. This is basically just an alias for: |
| The total capacity on this day. We cannot give exact vacancies on the calendar endpoint as this endpoint is cached for speed and is only meant to give an indication. |
| A list of opening hours that the product is open on this day. |
| When this product opens (HH:MM) |
| When this product closes (HH:MM) |
postAvailability Check
[{"id": "2020-07-01T11:30:00-05:00","localDateTimeStart": "2020-07-01T11:30:00-05:00","localDateTimeEnd": "2020-07-01T23:30:00-05:00","allDay": false,"status": "AVAILABLE","available": true,"vacancies": 24,"capacity": 24,"maxUnits": 24,"openingHours": []},{"id": "2020-07-01T12:00:00-05:00","localDateTimeStart": "2020-07-01T12:00:00-05:00","localDateTimeEnd": "2020-07-02T00:00:00-05:00","allDay": false,"status": "AVAILABLE","available": true,"vacancies": 24,"capacity": 24,"maxUnits": 24,"openingHours": []},{"id": "2020-07-01T14:30:00-05:00","localDateTimeStart": "2020-07-01T14:30:00-05:00","localDateTimeEnd": "2020-07-02T02:30:00-05:00","allDay": false,"status": "AVAILABLE","available": true,"vacancies": 24,"capacity": 24,"maxUnits": 24,"openingHours": []},{"id": "2020-07-01T15:00:00-05:00","localDateTimeStart": "2020-07-01T15:00:00-05:00","localDateTimeEnd": "2020-07-02T03:00:00-05:00","allDay": false,"status": "AVAILABLE","available": true,"vacancies": 24,"capacity": 24,"maxUnits": 24,"openingHours": []}]
The availability calendar can optionally take an array of units if you already know what they are and will automatically show availabilities as sold out if they have insufficient space.
POST /availability{"productId": "1a7213eb-3a33-4cbb-b114-64d771c201ac","optionId": "DEFAULT","localDateStart": "2020-07-01","localDateEnd": "2020-07-03","units": [{ "id": "adult", "quantity": 2 },{ "id": "child", "quantity": 1 }]}
The response will be an array of availability objects which are defined below:
Field | Description |
| The availability id, you'll need this when booking |
| The start time for this availability. This will be in the local time zone to the product. |
| The end time for this availability. This will be in the local time zone to the product. |
| A boolean field indicating whether this is an all day availability and not a fixed departure time. If this value is true then there will be no other availability object on the same day. |
| The status of that date. Possible values are:
|
Depending on the value of product.availabilityType the response will keep the same structure but will generally look slightly different. We've provided examples of that below:
Products with this availabilityType are typically Museums, Attractions or Hop on Hop off tours where the guest just picks a date they wish to travel and can show up at any point whilst the product is open.
This is a typical response from a product with OPENING_HOURS availability type:
[{"id": "2020-07-01","localDateTimeStart": "2020-07-01T00:00:00-05:00","localDateTimeEnd": "2020-07-01T23:59:59-05:00","allDay": true,"status": "AVAILABLE","available": true,"vacancies": null,"capacity": null,"maxUnits": null,"openingHours": [{ "from": "09:00", "to": "12:00" },{ "from": "15:00", "to": "18:00" }]},{"id": "2020-07-02","localDateTimeStart": "2020-07-02T12:00:00-05:00","localDateTimeEnd": "2020-07-02T23:59:59-05:00","allDay": true,"status": "AVAILABLE","available": true,"vacancies": null,"capacity": null,"maxUnits": null,"openingHours": [{ "from": "09:00", "to": "12:00" },{ "from": "15:00", "to": "18:00" }]},{"id": "2020-07-03","localDateTimeStart": "2020-07-03T12:00:00-05:00","localDateTimeEnd": "2020-07-03T23:59:59-05:00","allDay": true,"status": "AVAILABLE","available": true,"vacancies": null,"capacity": null,"maxUnits": null,"openingHours": [{ "from": "09:00", "to": "12:00" },{ "from": "15:00", "to": "18:00" }]}]
Notice how vacancies, capacity and max units are all null indicating unlimited, and the allDay flag is set true. You should just render this as a calendar with no further times to chose from once the guest has chosen the date.
Products with this availability type are typically walking tours, day trips and other activities where the guest has to book onto a specific departure time. There may be just one or multiple throughout the day.
This is a typical response from a product with START_TIME availability type:
[{"id": "2020-07-01T11:30:00-05:00","localDateTimeStart": "2020-07-01T11:30:00-05:00","localDateTimeEnd": "2020-07-01T23:30:00-05:00","allDay": false,"status": "AVAILABLE","available": true,"vacancies": 24,"capacity": 24,"maxUnits": 24,"openingHours": []},{"id": "2020-07-01T12:00:00-05:00","localDateTimeStart": "2020-07-01T12:00:00-05:00","localDateTimeEnd": "2020-07-02T00:00:00-05:00","allDay": false,"status": "AVAILABLE","available": true,"vacancies": 24,"capacity": 24,"maxUnits": 24,"openingHours": []},{"id": "2020-07-01T14:30:00-05:00","localDateTimeStart": "2020-07-01T14:30:00-05:00","localDateTimeEnd": "2020-07-02T02:30:00-05:00","allDay": false,"status": "AVAILABLE","available": true,"vacancies": 24,"capacity": 24,"maxUnits": 24,"openingHours": []},{"id": "2020-07-01T15:00:00-05:00","localDateTimeStart": "2020-07-01T15:00:00-05:00","localDateTimeEnd": "2020-07-02T03:00:00-05:00","allDay": false,"status": "AVAILABLE","available": true,"vacancies": 24,"capacity": 24,"maxUnits": 24,"openingHours": []}]
These are all availabilities for the same day. Once the guest has chosen the date (in this example 2020-07-01 then they must then pick a departure time. Again in this example the departure times would be:
11:00 AM
12:00 PM
2:30 PM
3:00 PM
Unlike the calendar endpoint, the availability check endpoint will not return an availability object if the product is closed. If there are no availabilities for a given date you should just mark it as closed in your interface.
