O
O
OCTo
Search…
Availability
Getting availability for a product

What you need to know:

The OCTo specification outlines a number of types of inventory calls. We implement the following OCTo availability calls:
POST /suppliers/:id/availability/ this endpoint will return a single availability object for each day, based on the request parameters. You MUST perform this step to obtain the availabilityId to perform a sale transaction.
Example of POST /suppliers/:id/availability/ :
1
POST /suppliers/:id/availability/
2
{
3
"productId": 121,
4
"optionId": "328d132f3cf710bbe34cd48be09e439b2948f43d",
5
"localDateStart": "2021-07-01",
6
"localDateEnd": "2021-07-03",
7
"units": [
8
{ "id": "senior", "quantity": 2 },
9
{ "id": "adult", "quantity": 1 }
10
]
11
}
Copied!
post
https://api.zaui.io/octo
/suppliers/:id/availability
Check Availability

Response Objects:

Field
Description
id
The availability ID. You need this for making a Booking.
localDateTimeStart
The travel date/time for this availability, in the same time zone as the supplier's product.
localDateTimeEnd
The travel date/time for this availability, in the same time zone as the supplier's product.
allDay
Boolean indicating an all day or a fixed departure time. If true, then there will be no other available objects on the same day.
status
The status of that date. Possible values are:
AVAILABLE This availability is available for sale
FREESALE This availability has no capacity and is available.
SOLD_OUT This availability is not available
LIMITED This availability is available but limited.
vacancies
The remaining inventory.
capacity
Total allowed inventory.
If the product status is CLOSED then there will be no availability object returned.
Last modified 1mo ago