Sign in

v1

latestOpenAPI 3.1.02026-07-234140131.3 KB
Availability & Pricing API

Product availability and pricing

get/products/{productId}/availability

Path parameters

productIdinteger required

ID of the product to return.

Query parameters

currencystring

Currency code of the price components (ISO 4217).

langstring

Language of the content to retrieve (ISO 639-1). Defaults to English if undefined.

start_datestring date

First day for which to return availability.

end_datestring date

Last day for which to return availability (by default: 31 days from current date). We capped the endpoint response to a maximum of 31 days per request to manage the response time of the endpoint.

skip_to_first_available_dayboolean

Whenever a range (open or closed) is specified with start_date and/or end_date, validate it against the next available date. If the next available date is in between start_date and end_date, return data from next available date adn end_date. If next available date is beyond end_date, return no available date. If it precedes start_date, nothing changes.

Headers

Authorizationstring required

Token <Your_API_Key>.

Response

Successful operation.

successboolean
capped_atstring nullable

The capped date that is used to limit the availability information in the response. For example, capped_at 2020-08-19 means the last information in the response is 2020-08-18. We capped the endpoint response to a maximum of 31 days per request to manage the response time of the endpoint.

next_available_datestring nullable

The first available date for the product. For example, next_available_date 2020-08-19 means that the first date in which there is availability and the product can bo sold is 2020-08-18.

sales_enabledboolean

Indicates whether the product is available for sale or not.

dynamic_pricingboolean

If true, the price depends on the day and timeslot, as well as the day on which the data is requested. Products with dynamic pricing can have different prices for one date for one variant ID, and it allows for active price changes from the supplier.

max_tickets_per_ordernumber nullable

Maximum total number of tickets of any product variant that can be purchased in one order. Returned as null if no restriction applies.

min_tickets_per_ordernumber nullable

Minimum total number of tickets of any product variant that can be purchased in one order. Returned as null if no restriction applies.