O
O
OCTo
Search…
Pricing
This capability provides additional pricing details to many basic endpoints
Add octo/pricing to your OCTO-Capabilities header
This capability will indicate pricing for the requested product dynamically returning product pricing for each day or departure time.
The following endpoints will have pricing details added to them when the octo/pricing capability is added to your requests. In general this includes:
    Product pricing - as a list of products, or single product
    Pricing checks - at the time of making an Availability call, we will confirm the price with you. Also handy for performing a price quote.
    Booking - at the time of making a booking, our system will return pricing details for the booking.
NOTE: we will return pricingFrom for each unit in each available currency.
get
https://api.zaui.io/octo
/suppliers/:sid/product/:id
Product Pricing

Pricing From Field Definitions

Field
Description
default
Indicates if this currency is the suppliers default. true or false.
currency
The ISO currency
currencyPrecision
We send back pricing in integers. This value indicates the currency precision so as to avoid rounding errors. For example, CAD = 2, USD = 2. eg. subtotal = subtotal / (10 ** currencyPrecision).
subtotal
The pre-tax total
taxes
The tax amount

Product Object Additions

We have added the following changes to the Product object for pricing:
1
{
2
//rest of the Product Object
3
"defaultCurrency": "CAD",
4
"availableCurrencies": ["CAD", "EUR", "GBP"],
5
"pricingPer": "UNIT" // "UNIT" or "BOOKING" or "EQUIPMENT"
6
}
Copied!
Field
Definition
defaultCurrency
The suppliers default currency.
availableCurrencies
Other currencies that the the supplier accepts.
pricingPer
How the supplier prices the requested product. (UNIT, BOOKING, EQUIPMENT)
UNIT means pricing is based on each unit as defined in the Product Object. Examples: day tours, transportation, attractions, any price per unit or age band.
BOOKING means pricing is the same regardless of number of units. Examples: charter bookings, group bookings, or ad-hoc pricing where it might be a fix price for the entire product.
EQUIPMENT means pricing is based on the particular equipment assigned to the product. Examples: rentals.
post
https://api.zaui.io/octo
/suppliers/:sid/availability/
Availability pricing (Price Check)
Use the /octo/suppliers/:id/availability/ call to perform simple price checks.
post
https://api.zaui.io/octo
/suppliers/:sid/bookings
Booking and pricing
Last modified 4mo ago