v1

latestOpenAPI 3.1.02026-07-234140131.3 KB
Content API

Search and filter products

get/products

Query parameters

city_idinteger

Only return products located in the defined city. Use the /cities endpoint to find the IDs Tiqets has assigned to the various known cities. Products located in the surrounding area can also be returned, this depends on the configuration of each individual product.

Repeat the city_id parameter to broaden the search to span multiple cities.

city_namestring

Name of the city to filter by. Useful for debugging or certain use cases. We recommend using city_id instead.

country_idinteger

Tiqets ID of the product country to filter by.

country_namestring

Name of the country to filter by. Useful for debugging or certain use cases. We recommend using country_id instead.

currencystring

Currency code of the price components (ISO 4217).

exclude_city_idinteger

Exclude products from the results if they belong to the specified city.

exclude_venue_idinteger

Exclude products from the results if they belong to the specified experience.

langstring

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

latnumber

Filters the result set by latitude. Requires a combination of latitude/longitude parameters. Also see max_distance.

lngnumber

Filters the result set by longitude. Requires a combination of latitude/longitude parameters. Also see max_distance.

max_distanceinteger

Maximum distance in kilometers to filter results by. Value can be between 0 and 100; defaults to 5 if undefined.

min_ratinginteger

Minimum rating of the product in customer reviews.

page_sizeinteger

Number of items per page. Default value is 10, maximum value is 100.

pageinteger

Number of the page to retrieve. Used in combination with the page_size parameter to define the page size.

querystring

Textual query to find products that match the query. The results are ranked by internal calculation of relevancy which can change over time. Adding more keywords narrows down the results.

require_venueboolean

Define as true if you do not wish to include products that do not have a determined venue location. Defaults to false if undefined.

sortstring

Sort by

  • popularity
  • price
  • title
  • distance (in combination with lat/lng)
  • score (Search query matching score. Only in combination with the query parameter). Sort ascending (asc) or descending (desc).
tag_idinteger

ID of the tag to filter by. See tags endpoint. Repeat the tag_id parameter to broaden the search to include one or more of the provided tag IDs.

exclude_tag_idinteger

ID of the tag to exclude from results. Products associated with the specified tag will not be returned. Repeat the exclude_tag_id parameter to exclude products matching any of the provided tag IDs.

exclude_packagesboolean

If true, only individual products are returned and package products are excluded from the results. Defaults to false if undefined.

experience_idinteger

ID of the experience to filter by. Experiences can be searched and retrieved using the dedicated Experiences endpoint.

Repeat the experience_id parameter to broaden the search to span multiple experiences.

Note that this parameter is not allowed together with venue_id that is deprecated.

venue_idinteger

ID of the experience to filter by. Experiences can be searched and retrieved using the dedicated Experiences endpoint.

Repeat the venue_id parameter to broaden the search to span multiple experiences.

Note that this parameter is deprecated and experience_id is recommended. If you specify this and experience_id, it will trigger an error.

Headers

Authorizationstring required

Token <Your_API_Key>.

Response

Successful operation.

successboolean
All 41 operations