List available products for purchase
Either you have a database of products that you need to map to products returned in this API, or you choose to import the product list from this endpoint to your system.
Ventrata has also implemented a self-service mapping capability that substantially reduces the burden of maintaining mappings. We recommend you implement this if you are able to. Click here for the documentation.
A description of each of the keys is given below:
The product id, you'll need to save this.
The name this suppliers calls the product.
An optional code this supplier might use to identify the product.
A language code indicating what language this product content is in.
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, otherwise the supplier will later either accept or reject the booking.
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
An array of settlement methods allowed for this product. Possible values are:
How must the guest present the ticket or voucher when they arrive at the venue. Possible values are:
Capabilities define API extensions that this product supports. Capabilities can be enabled using a special HTTP header that's described in the next section.
The capability id which identifies it
An integer which will increment each time the specification for this capability is updated.
Whether this product cannot be sold without this capability being used.
An array of other capability ids that this capability depends on.
A url to the documentation for this capability is.
Whether this capability is enabled by default.
An array of all options for this product. All products must have at least one option.
The id that identifies this option, it is only unique within the product
If there is only one option this value is
Like product internalName except for each option
Like product reference except for each option
An object containing a fixed list of restrictions. Keys and values are:
This will be an array of all possible start times that can be returned during availability. For example an all day attraction may just have a single value like
This is how long before the tour the booking can be still be cancelled. We also provide
The numeric amount for the cutoff (e.g. 1)
The cutoff unit (e.g. hour). Possible values are:
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. Possible values are:
The list of ticket types (units) available for sale
The id of the unit, this will be unique to the option
Like product/option internalName but for units
Like product/option reference but for units
This is the ticket type of the unit, values are:
The "other" type typically is used for an add-on, e.g. Bottle of Champaign, and not an actual ticket.
An object containing restrictions about this unit. Possible keys and values are:
If your server wants to query specific information about a product at a later stage, either to refresh your inventory or check for updates, you can call the following endpoint:
A description of the fields is given above