/onlinetrade/categories/products

POST /api/onlinetrade/categories/products

Price: 1 credit

List the products of one ONLINE TRADE.RU (onlinetrade.ru) catalogue category 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 gallery images, the colour and memory variants of the same model and the canonical product URL. Narrows by manufacturer, availability class, price range, customer rating, promotion participation and by any of the category's own specification facets, and orders by popularity, price, novelty, title or number of reviews.

How to use it

This is the exhaustive view of a category, where onlinetrade/products/search is the keyword view and takes no filters at all. `brands` and `filters` take onlinetrade's own spellings, which differ per category: a name or value onlinetrade does not recognise is dropped upstream rather than refused, so this endpoint reads back the query onlinetrade built for the selection and answers 422 when any name or value spelled here is missing from it, rather than serving a different selection. `filters` keys are the facet names without the [] suffix, for example os, color, ram, processor. `city` changes the answer rather than its presentation, and each card echoes the city its price belongs to. Cards carry gallery images and model variants but no manufacturer code — that one is on the search card and on onlinetrade/products, which also carries specifications, description, warranty and delivery.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• category_id string required — Category as the numeric id onlinetrade uses in its -c{id} URL segment, or as any onlinetrade catalogue URL carrying one (examples: "13", "https://www.onlinetrade.ru/catalogue/smartfony-c13/"; 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. Every card echoes the city it was priced in (default: "Москва"; examples: "Москва", "Екатеринбург", "35"; 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")
• brands array nullable — Manufacturer names as onlinetrade spells them in this category's own brand facet (examples: ["APPLE","XIAOMI"])
• stock array nullable — Keep only products in these availability classes in the selected city (one of: "7", "1", "2", "0", "3", "5")
• min_price integer nullable — Lowest price in roubles (min: 0; max: 99999999)
• max_price integer nullable — Highest price in roubles (min: 0; max: 99999999)
• ratings array nullable — Keep only products whose rounded customer rating is one of these star values (examples: [5])
• on_promotion boolean — Keep only products taking part in a promotion (default: false)
• club_price_only boolean — Keep only products carrying a Клуб ON member price (default: false)
• filters object nullable — Category-specific specification facets, keyed by the facet name onlinetrade uses in its own category form without the [] suffix, each with one or more of that facet's values (examples: {"color":["черный"],"os":["iOS"]})
  • * array
• count integer required — Max number of products to return (min: 1; max: 285)

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, category_id is neither a numeric id nor a catalogue URL, or onlinetrade did not recognise one of the brand names, facet names or facet values spelled here and dropped it from the query it ran 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 category id does not exist; a filter combination nothing matches is not an error and comes back as 200 with an empty list 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 yielded a listing within the retry and session-mint budget; the category id is unrelated, 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.