githubEdit

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.

circle-info

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.

List Products

get

List all products available for sale.

Query parameters
destinationIdstringOptional

Filter products by destination ID. Use DEFAULT to skip destination filtering.

Example: destination_san_francisco
categoryIdstringOptional

Filter products by category ID. Use DEFAULT to skip category filtering.

Example: category_bus_tours
featuredbooleanOptional

When true, return checkout-featured products.

Example: true
productIds[]string[]Optional

Restrict response to specific product IDs.

Example: ["product_ids-example"]
offerCodestringOptional

Offer code or combination code context for products lookup.

Example: SUMMER25
membership[id]string · uuidOptional

Membership identifier returned by /memberships/lookup. When set, also include membership[verification] and one of membership[email], membership[mobile], or membership[reference].

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2
membership[email]string · emailOptional

Membership email used during lookup.

Example: [email protected]
membership[mobile]stringOptional

Membership mobile number used during lookup.

Example: +12025550123
membership[country]stringOptional

ISO 3166-1 alpha-2 country code used to parse membership[mobile].

Example: US
membership[reference]stringOptional

Membership reference used during lookup. Use with membership[id] and membership[verification] as one of the allowed lookup identifiers.

Example: REF-2026-001
membership[verification]stringOptional

Verification token from lookup (OTP for email/mobile, or guest name for reference). Required when membership[id] is provided.

Example: 123456
currencystringOptional

Currency override (ISO-4217 or default).

Example: USD
Responses
chevron-right
200

Successful response

application/json
allowFreesalebooleanOptional

Whether allow freesale is enabled.

Example: true
availabilityRequiredbooleanOptional

Whether availability required is enabled.

Example: true
availabilityTypestring · enumOptional

Availability type value.

Example: START_TIMEPossible values:
deliveryFormatsstring[]Optional

List of delivery format values.

Example: ["PDF_URL","QRCODE"]
deliveryMethodsstring[]Optional

List of delivery methods available for this product. VOUCHER means one ticket media object per booking (booking.voucher); TICKET means one ticket media object per unit item (booking.unitItems[].ticket).

Example: ["VOUCHER","TICKET"]
fixedWeightbooleanOptional

Whether fixed weight is enabled.

Example: true
freesaleDurationAmountnumberOptional

Freesale duration amount numeric value.

Example: 220
freesaleDurationRoundupbooleanOptional

Whether freesale duration roundup is enabled.

Example: true
freesaleDurationRoundupUnitstringOptional

Freesale duration roundup unit value.

Example: HOUR
freesaleDurationUnitstringOptional

Freesale duration unit value.

Example: HOUR
idstring · uuidRequired

Unique identifier for this resource.

Example: e7cc8bb4-8d1c-4848-8824-5dbedb718681
instantConfirmationbooleanOptional

Whether instant confirmation is enabled.

Example: true
instantDeliverybooleanOptional

Whether instant delivery is enabled.

Example: true
internalNamestringRequired

Internal name value.

Example: Walking Tour of Barcelona
localestringOptional

Locale code (BCP 47).

Example: en
redemptionMethodstringOptional

Redemption method value.

Example: DIGITAL
referencestringOptional

Reference value.

Example: BRC-WALK
settlementMethodsstring[]Optional

List of settlement method values.

Example: ["DIRECT","DEFERRED"]
tagsstring[]Optional

List of tag values.

Example: ["vip","partner"]
timeZonestringOptional

IANA timezone identifier.

Example: Europe/Madrid
weightUnitstringOptional

Weight unit for the weight value.

Example: kg
availableCurrenciesstring[]Optional

From capability octo/pricing.

Example: ["USD","EUR"]
defaultCurrencystringOptional

From capability octo/pricing.

Example: USD
hidePricingFrombooleanOptional

From capability octo/pricing.

Example: true
includeTaxbooleanOptional

From capability octo/pricing.

Example: true
pricingMultipliernumberOptional

From capability octo/pricing.

Example: 10
pricingPerstring · enumOptional

From capability octo/pricing.

Example: UNITPossible values:
isPackagebooleanOptional

From capability octo/packages.

Example: true
isPackagePassbooleanOptional

From capability octo/packages.

Example: true
packageProductbooleanOptional

From capability octo/packages.

Example: true
isRentalbooleanOptional

From capability octo/rentals.

Example: true
isMembershipbooleanOptional

From capability octo/memberships.

Example: true
membershipAutoRenewbooleanOptional

From capability octo/memberships.

Example: true
get
/products
200

Successful response

Depending on the capabilities you enable, additional fields may be merged into this core product schema by capability modules. The capabilities that were applied to the request are returned in the Octo-Capabilities response header.

Get Product

get

Get details on a specific product.

Path parameters
productIdstringRequired

Product ID, for example: 94cdd032-3d32-416d-b0a4-abf8b7495b8b.

Example: e7cc8bb4-8d1c-4848-8824-5dbedb718681
Query parameters
currencystringOptional

Optional currency override. Use an ISO-4217 currency code from availableCurrencies or default.

Example: USD
offerCodestringOptional

Offer code or combination context.

Example: SUMMER25
membership[id]string · uuidOptional

Membership identifier returned by /memberships/lookup. When set, also include membership[verification] and one of membership[email], membership[mobile], or membership[reference].

Example: 89fe0192-ddcd-430a-b285-e1396a4725d2
membership[email]string · emailOptional

Membership email used during lookup.

Example: [email protected]
membership[mobile]stringOptional

Membership mobile number used during lookup.

Example: +12025550123
membership[country]stringOptional

ISO 3166-1 alpha-2 country code used to parse membership[mobile].

Example: US
membership[reference]stringOptional

Membership reference used during lookup. Use with membership[id] and membership[verification] as one of the allowed lookup identifiers.

Example: REF-2026-001
membership[verification]stringOptional

Verification token from lookup (OTP for email/mobile, or guest name for reference). Required when membership[id] is provided.

Example: 123456
Header parameters
Accept-LanguagestringRequired

fr-CH, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5

Example: en-US
Octo-CapabilitiesstringOptional

Optional comma-separated capability IDs.

Example: octo/pricing,octo/offers
Responses
chevron-right
200

Successful response

application/json
allowFreesalebooleanOptional

Whether allow freesale is enabled.

Example: true
availabilityRequiredbooleanOptional

Whether availability required is enabled.

Example: true
availabilityTypestring · enumOptional

Availability type value.

Example: START_TIMEPossible values:
deliveryFormatsstring[]Optional

List of delivery format values.

Example: ["PDF_URL","QRCODE"]
deliveryMethodsstring[]Optional

List of delivery methods available for this product. VOUCHER means one ticket media object per booking (booking.voucher); TICKET means one ticket media object per unit item (booking.unitItems[].ticket).

Example: ["VOUCHER","TICKET"]
fixedWeightbooleanOptional

Whether fixed weight is enabled.

Example: true
freesaleDurationAmountnumberOptional

Freesale duration amount numeric value.

Example: 220
freesaleDurationRoundupbooleanOptional

Whether freesale duration roundup is enabled.

Example: true
freesaleDurationRoundupUnitstringOptional

Freesale duration roundup unit value.

Example: HOUR
freesaleDurationUnitstringOptional

Freesale duration unit value.

Example: HOUR
idstring · uuidRequired

Unique identifier for this resource.

Example: e7cc8bb4-8d1c-4848-8824-5dbedb718681
instantConfirmationbooleanOptional

Whether instant confirmation is enabled.

Example: true
instantDeliverybooleanOptional

Whether instant delivery is enabled.

Example: true
internalNamestringRequired

Internal name value.

Example: Walking Tour of Barcelona
localestringOptional

Locale code (BCP 47).

Example: en
redemptionMethodstringOptional

Redemption method value.

Example: DIGITAL
referencestringOptional

Reference value.

Example: BRC-WALK
settlementMethodsstring[]Optional

List of settlement method values.

Example: ["DIRECT","DEFERRED"]
tagsstring[]Optional

List of tag values.

Example: ["vip","partner"]
timeZonestringOptional

IANA timezone identifier.

Example: Europe/Madrid
weightUnitstringOptional

Weight unit for the weight value.

Example: kg
availableCurrenciesstring[]Optional

From capability octo/pricing.

Example: ["USD","EUR"]
defaultCurrencystringOptional

From capability octo/pricing.

Example: USD
hidePricingFrombooleanOptional

From capability octo/pricing.

Example: true
includeTaxbooleanOptional

From capability octo/pricing.

Example: true
pricingMultipliernumberOptional

From capability octo/pricing.

Example: 10
pricingPerstring · enumOptional

From capability octo/pricing.

Example: UNITPossible values:
isPackagebooleanOptional

From capability octo/packages.

Example: true
isPackagePassbooleanOptional

From capability octo/packages.

Example: true
packageProductbooleanOptional

From capability octo/packages.

Example: true
isRentalbooleanOptional

From capability octo/rentals.

Example: true
isMembershipbooleanOptional

From capability octo/memberships.

Example: true
membershipAutoRenewbooleanOptional

From capability octo/memberships.

Example: true
get
/products/{productId}
200

Successful response

This endpoint does not add capability-specific query parameters.

Last updated