Search…
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.
get
https://api.zaui.io/octo
/suppliers/:id/products/
List Products
Response keys:
Field
Description
id
Product ID. You need to save this.
internalName
Product name used by the supplier.
reference
An optional code this supplier might use to identify the product.
locale
A language code indicating what language this product content is in.
timeZone
The IANA TimeZone name this product is located in.
allowFreesale
Whether a booking can be made for this product without having to query availability first.
availabilityRequired
Whether an availabilityId is required when creating a booking. Without this, the booking will be open-dated and not have a specified travel date.
availabilityType
What type of availability this product has, possible values are: START_TIME if there are fixed departure times which you must pick one. Typical for day tours or activities. OPENING_HOURS if you just select a date and can visit any time when the venue is open.
deliveryFormats
An array of formats the API will deliver the tickets as. Possible values are:
QRCODE A code to be presented as a QR CODE barcode
CODE128A code to be presented as a CODE 128 barcode
PDF_URL A URL to a PDF file that contains all the ticket details
deliveryMethods
How the formats described in deliveryFormats will be delivered in the booking response, possible values are:
TICKET Individually per unit in the order (i.e. single ticket for each person)
VOUCHER One ticket for the whole booking
redemptionMethod
How must the guest present the ticket or voucher when they arrive at the venue. Possible values are:
MANIFEST The guest name will be written down and they just need to show up
DIGITAL The tickets/voucher must be scanned but can be on mobile
PRINT The tickets/voucher must be printed and presented on arrival
capabilities
Capabilities define API extensions that this product supports. Capabilities can be enabled using a special HTTP header that's described in the next section.
capabilities[].id
The capability id which identifies it
capabilities[].revision
An integer that will increment each time the specification for this capability is updated.
capabilities[].documentation
URL to the documentation describing this capability.
capabilities[].required
Whether this product cannot be sold without this capability being used.
capabilities[].dependencies
An array of other capability ids that this capability depends on.
options
An array of all options for this product, this list will not be empty.
options[].id
The id that identifies this option and is only unique within the product.
get
https://api.zaui.io/octo
/suppliers/:sid/products/:id
Get Product
Response from this endpoint is the same as GET /products/ except as a single Product object.