Search and filter products

This endpoint allows querying for product information using several search parameters. Common use cases include the initial and periodic retrieval of products in a certain city or country, retrieving a list of popular products in a given location, or a free-text query.

Search and filter products

get

/products

Query parameters

city_idintegerOptional

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.

Example: 113

city_namestringOptional

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

Example: Barcelona

country_idintegerOptional

Tiqets ID of the product country to filter by.

Example: 50233

country_namestringOptional

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

Example: United States

currencystringOptional

Currency code of the price components (ISO 4217).

Default: EURExample: EUR

exclude_city_idintegerOptional

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

Example: 113

exclude_venue_idintegerOptional

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

Example: 145528

langstringOptional

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

Default: enExample: en

latnumberOptional

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

Example: 40.74844100000001

lngnumberOptional

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

Example: -73.9856616352348

max_distanceinteger · min: 1 · max: 100Optional

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

min_ratinginteger · min: 1 · max: 5Optional

Minimum rating of the product in customer reviews.

Example: 1

page_sizeinteger · min: 1 · max: 100Optional

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

Default: 10Example: 5

pageinteger · min: 1Optional

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

Default: 1Example: 1

querystringOptional

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.

Example: Sagrada Familia

require_venuebooleanOptional

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

Default: false

sortstringOptional

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).

Example: distance desc

tag_idintegerOptional

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.

Example: 312

experience_idintegerOptional

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.

Example: 145528

venue_idintegerOptionalDeprecated

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.

Example: 145528

Header parameters

AuthorizationstringRequired

Token <Your_API_Key>.

Default: Token <Partner_API_key>.

Responses

200

Successful operation.

application/json

400

Bad Request -- Check your request parameters (typo in parameter or invalid value).

application/json

401

Unauthorized -- Your API key is incorrect.

application/json

403

Forbidden -- The endpoint or parameters are not allowed for the matching API key.

application/json

404

Not Found -- Requested resource/endpoint could not be found.

application/json

405

Method Not Allowed -- Check your request method.

application/json

429

Too Many Requests -- We currently apply a fair-use policy, but we might enforce limits in the future.

application/json

500

Internal Server Error -- We had a problem with our server. Try again later.

application/json

503

Service Unavailable -- We're temporarily offline for maintenance. Please try again later.

application/json

get

/products

GET /v2/products HTTP/1.1
Host: api-tiqt-test.steq.it
Authorization: Token <Partner_API_key>.
Accept: */*

{
  "success": true,
  "pagination": {
    "total": 5,
    "page": 1,
    "page_size": 100
  },
  "products": [
    {
      "id": "1006356",
      "language": "en",
      "title": "The Museum of Cognitive Dissonance",
      "city_name": "Milan",
      "city_id": "105851",
      "country_name": "Italy",
      "country_id": "50109",
      "tag_ids": [
        "327"
      ],
      "images": [
        {
          "small": "text",
          "medium": "text",
          "large": "text",
          "extra_large": "text",
          "alt_text": null,
          "credit": null
        }
      ],
      "geolocation": {
        "lat": 44.5,
        "lng": 7.58
      },
      "distance": 3,
      "venue": {
        "address": "800, Town and country boulevard",
        "id": "text",
        "name": "Moco Museum Amsterdam",
        "postal_code": "77024"
      },
      "ratings": {
        "average": 4.5,
        "total": 1081
      },
      "price": 9.5,
      "currency": "EUR",
      "price_in_supplier_currency": 9.5,
      "supplier_currency": "EUR",
      "product_slug": "tickets-moco-museum-amsterdam-p974431",
      "supports_cancellation_insurance_in_affiliate_checkout": true,
      "marketing_restrictions_detailed": [
        {
          "type": "AD_CONTENT",
          "scope": "COUNTRY",
          "languages": [
            "en-US"
          ],
          "parameters": [
            "Rembrandthuis"
          ],
          "scope_geolocation": "The Netherlands"
        }
      ],
      "prediscount_price": 10,
      "discount_percentage": 5,
      "display_booking_fee": 0,
      "cancellation": {
        "window": 48,
        "policy": "before_timeslot"
      },
      "product_url": "https://www.tiqets.com/en/centallo-attractions-c105851/tickets-for-distributor-test-a-p1006356?partner=testpartner",
      "product_checkout_url": "https://www.tiqets.com/en/centallo-attractions-c105851/tickets-for-distributor-test-a-p1006356/goto_checkout?partner=testpartner",
      "tagline": "Unleash your inner troglodyte on the uncomfortable reality of modern life!",
      "promo_label": "bestseller",
      "languages": [
        "pt",
        "en",
        "de",
        "nl",
        "it",
        "fr",
        "es",
        "ja"
      ],
      "sale_status": "available",
      "sale_status_reason": "The product is out of season",
      "sale_status_expected_reopen": null,
      "summary": "Leon Festinger\\'s theory presented in the Main Hall is widely regarded as some of the finest pieces of psychology ever created. It alone would be worth the price of admission, but the Museum of Cognitive Dissonance is full of other works amassed by its curators over decades – with drawings, video clips, scientific papers, and more. These skip-the-line tickets let you head straight for the entrance. No waiting, just wall-to-wall cognitive dissonance.",
      "whats_included": "Skip-the-line entrance to the Museum of Cognitive Dissonance.",
      "whats_excluded": "Entrance to temporary exhibitions on the 6th floor. Tickets can be bought at the venue.",
      "live_guide_languages": [
        "en",
        "it",
        "fr",
        "es",
        "nl",
        "ru"
      ],
      "audio_guide_languages": [
        "en",
        "de",
        "it",
        "fr",
        "es",
        "zh",
        "ja"
      ],
      "language_selection": [
        "eng",
        "ita",
        "fra",
        "spa",
        "nld",
        "rus"
      ],
      "starting_time": "12:00:00",
      "timezone": "Europe/Madrid",
      "duration": "01:00:00",
      "starting_point": {
        "lat": 44.5,
        "lng": 7.58,
        "address": "800, Town and country boulevard",
        "city_id": 105851,
        "label": "Anne Frank Huis"
      },
      "wheelchair_access": true,
      "smartphone_ticket": true,
      "advance_arrival_time": "0:10:00",
      "last_admission_window": "01:00:00",
      "description": "The Museum of Cognitive Dissonance underwent a ten-year renovation between 2007 and 2017. It's come out looking great – airy, bright and inviting. Plus, it's filled with more scientific papers and art objects than you can possibly absorb in an afternoon. Still, it's fun to give it a try. The highlight is Leon Festinger\\'s theory, one of the museum's most famous pieces of writing. Another spectacular – though underrated – section of the museum is the collection of gifs and memes presented in a multimedia installation on floor 4 and 5. The Museum of Cognitive Dissonance also offers an excellent multimedia tour app that can be downloaded straight to your smartphone. Check it out on the App Store or Google Play!",
      "exhibitions": [
        {
          "from_date": "2022-11-03",
          "to_date": "2021-08-03",
          "title": "Influencing Consumer Behaviour",
          "id": 2589,
          "description": "How is cognitive dissonance used to influence consumers? Find out in this exhibition. Only today with a 20% discount on the admission price!",
          "url": "https://www.tiqets.com/en/city-centre-tickets-l35818/influencing-customer-behaviour-e2589?partner=testpartner"
        }
      ],
      "instant_ticket_delivery": true,
      "is_package": false,
      "in_packages": [
        1013153
      ],
      "package_products": null,
      "supplier": {
        "name": "Tiqets International B.V.",
        "address": "James Wattstraat 77-P",
        "city": "Amsterdam",
        "postalcode": "1097 DL",
        "countrycode": "NL"
      },
      "product_groups": [
        {
          "group_id": "1106932",
          "type": "booking_sources",
          "products": [
            {
              "id": "1086528",
              "title": "Accademia Gallery: Skip The Line Ticket + Guided Tour",
              "currency": "EUR",
              "from_price": 46
            }
          ]
        }
      ]
    }
  ]
}

PreviousContent API NextGet single product

Last updated 4 months ago

Was this helpful?