/viator/products/search

POST /api/viator/products/search

Price: 10 credits

Search Viator tours and activities by keyword, or list all of them for a destination. Provide exactly one of 'query' (free-text keyword) or 'destination_id'. Returns product cards with id, title, description, destination, star rating with review count, from-price, duration, languages, free-cancellation flag and image.

How to use it

Search Viator tours/activities. Provide exactly one of 'query' (free-text keyword like 'rome colosseum') or 'destination_id' (numeric Viator destination id like 511 for Rome, to list everything there). Returns results with id (productCode), url, title, description, destination + destination_id + parent_destination, rating/rating_exact/review_count, price + currency (from-price), duration_minutes, languages (codes), has_free_cancellation, is_private_tour, is_likely_to_sell_out, is_new, image and badges.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string nullable — Search keyword (e.g. 'rome colosseum') (examples: "rome colosseum", "paris food tour")
• destination_id integer nullable — Viator destination id to list all tours & activities for (e.g. 511 for Rome) (>: 0)
• count integer required — Max number of results to return (min: 1)

Response

• @type string (default: "ViatorSearchProduct")
• id string required
• url string required
• description string nullable
• destination string nullable
• destination_id integer nullable
• parent_destination string nullable
• rating number nullable
• rating_exact number nullable
• review_count integer nullable
• price number nullable
• currency string nullable
• duration_minutes integer nullable
• languages array (default: [])
• has_free_cancellation boolean nullable
• is_private_tour boolean nullable
• is_likely_to_sell_out boolean nullable
• is_new boolean nullable
• image string nullable
• badges array (default: [])

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.