Products
Mapping the supplier available products and options to your reseller system.
Most reseller systems have a database of products. You will need to map to products returned in this API call.
The main components that you are required to map are: Product, Options, Units
The product ID, at least one option and units are required for inventory checks and booking calls. These are required for subsequent calls.
List Products
GET
https://api.zaui.io/octo/products/
Provides a list of all available products for resell provided by the supplier.
Response keys:
Field | Description |
| Product ID. You need to save this. |
| Product name used by the supplier. |
| An optional code this supplier might use to identify the product. |
| A language code indicating what language this product content is in (BCP 47 RFC 5646 RFC 4647 language tag). |
| The IANA TimeZone name this product is located in. |
| Whether a booking can be made for this product without having to query availability first. |
| Whether bookings will be immediately confirmed when a sale is made. |
| Whether an |
| What type of availability this product has, possible values are:
|
| An array of formats the API will deliver the tickets as. Possible values are:
|
| How the formats described in
|
| This indicates whether the Reseller can expect immediate delivery of the customer's tickets. If |
| How must the guest present the ticket or voucher when they arrive at the venue. Possible values are:
|
| An array of all options for this product, this list will not be empty. |
| The id that identifies this option and is only unique within the product. |
| This will be an array of all possible start times that can be returned during availability. For example an all day attraction may have a single value like |
| If there is only one option this value is |
| Like product |
| Like product |
| An array of the contact fields required to confirm a booking. These just apply to the lead traveller on the booking and not for every ticket.
Required Values: |
| An object containing a fixed list of restrictions. |
| The minimum number of tickets that can be purchased in a single booking (null = 0) |
| The maximum number of tickets that can be purchased in a single booking (null = unlimited) |
| This is how long before the tour the booking can be still be cancelled. We also provide |
| An integer representing the cut-off amount. |
| The cut-off unit. Values: |
| The list of ticket types (units) available for sale. |
| The id of the unit that is unique to the option. |
| Like product/option |
| Like product/option reference but for units. |
| This is the ticket type of the unit, values are: |
| This is the array of the contact information PER ticket that the supplier expects.
Required Values: |
| An object containing restrictions about this unit. Possible keys and values are: |
| An integer indicating the minimum age for the person this unit is for. |
| An integer indicating the maximum age for the person this unit is for. |
| A Boolean value indicating whether the person this unit is for must show ID on arrival. |
| The minimum quantity of this unit required per booking (null = no minimum) |
| The maximum quantity of this unit required per booking (null = no limit) |
| This is the amount of people each unit counts as (e.g. family == 4pax) |
| An array of unit ids one of which must accompany this unit if it is purchased. |
Get Product
GET
https://api.zaui.io/octo/products/{id}
This endpoint will respond with a single product object.
Path Parameters
Name | Type | Description |
---|---|---|
id* | string/uuid | The product ID |
Response from this endpoint is the same as GET
/products/
except as a single Product object.
Last updated