Products

Ventrata Dashboard Test API Signup EdinExplore Agent Portal
Search…
Products
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.
OCTO Cloud 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.
get
https://api.ventrata.com/octo
/products
List Products
A description of each of the keys is given below:
Field
Description
id
The product id, you'll need to save this.
internalName
The name this suppliers calls the product.
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.
instantConfirmation
Whether bookings will be immediately confirmed when a sale is made, otherwise the supplier will later either accept or reject the booking.
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 which 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 which will increment each time the specification for this capability is updated.
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.
capabilities[].docs
A url to the documentation for this capability is.
capabilities[].default
Whether this capability is enabled by default.
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:
get
https://api.ventrata.com/octo
/products/:id
Get Product
A description of the fields is given above
Errors
Headers
Last modified 1yr ago
Copy link
Outline