/onlinetrade/products/search

POST /api/onlinetrade/products/search

Price: 1 credit

Search the ONLINE TRADE.RU (onlinetrade.ru) catalogue by keyword for a named Russian city and return product cards with the current price in roubles, the pre-discount price where the product is discounted, the ON-bonus amount, whether the product can be bought right now, the customer rating and its vote count, the manufacturer code, the category the product sits in with its category path, the product image and the canonical product URL. Orders by popularity, price, novelty, title or number of reviews.

How to use it

`city` changes the answer rather than its presentation: onlinetrade prices the same product differently by city, and each card carries the city its price belongs to — compare prices only within one city. An unknown city name is rejected rather than silently answered in Москва. `item_id` is the identifier onlinetrade/products accepts; the other number on the site, the one in its basket and compare links, is a different id space and does not resolve. Search cards carry the manufacturer code and the category path but no gallery images or colour and memory variants — call onlinetrade/products for those and for specifications, description, warranty and delivery. To walk a whole category exhaustively use onlinetrade/categories/products, which also takes brand, price, availability and rating filters; search itself takes none of them, because onlinetrade's search handler ignores them.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string required — Search text, matched against product names and manufacturer codes (examples: "iphone", "холодильник", "51098YXM"; minLength: 1)
• city string — City the prices belong to, as a city name or as the numeric city id onlinetrade uses in its own ?c= parameter. The same product is priced differently across cities, so this is part of the result and every card echoes the city it was priced in (default: "Москва"; examples: "Москва", "Санкт-Петербург", "52"; minLength: 1)
• sort string — Result ordering (default: "views-desc"; one of: "views-desc", "price-asc", "price-desc", "time-desc", "title-asc", "title-desc", "reviews-desc", "reviews-asc")
• count integer required — Max number of products to return (min: 1; max: 570)

Response

• @type string (default: "OnlinetradeProductCard")
• item_id string required
• model_id string nullable
• name string nullable
• url string nullable
• image string nullable
• images array (default: [])
• price integer nullable
• old_price integer nullable
• currency string (default: "RUB")
• discount_percent integer nullable
• badges array (default: [])
• bonus integer nullable
• in_stock boolean nullable
• rating number nullable
• rating_count integer nullable
• mpn string nullable
• category_id integer nullable
• category_path array (default: [])
  • @type string (default: "OnlinetradeCategoryRef")
  • name string required
  • id integer nullable
  • url string nullable
• modifications array (default: [])
  • @type string (default: "OnlinetradeModification")
  • item_id string required
  • label string required
  • selected boolean (default: false)
• city string nullable
• city_id string nullable

Errors

• 422 — The city is not one onlinetrade prices in, or a payload field is malformed 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 — onlinetrade's anti-bot wall never served the search results within the retry and session-mint budget; a query nothing matches is not an error and comes back as 200 with an empty list, so retry the call 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.