/citilink/categories/products

POST /api/citilink/categories/products

Price: 20 credits

List the products of one citilink.ru catalogue category, priced for a specific city: current price in RUB with the pre-discount price, the loyalty-club price, the discount percentage and bonus points, brand, rating and review counts, stock and pickup-point counts, promo labels, the key specification summary and images. Filter by price range, fulfilment route, merchandising status, minimum rating, minimum discount, brand, and the category's own attribute facets.

How to use it

Prices, availability and the product set are per city — set `city` and read it back off the rows. Take `filters` values from citilink/categories/filters for this same category: facet group ids are category-specific. `brands` takes the brand name as shown on the site, resolved against that category's own brand list. Sorting by `discount` ranks by the size of the markdown, not by the price itself.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• city string — Citilink city code that the returned prices, stock and delivery belong to. Codes come from citilink/cities; the response echoes the resolved city back in `city` (default: "msk_cl"; examples: "msk_cl", "kzn_cl", "nvs_cl", "abn_cl:5x0050435"; minLength: 1)
• with_images boolean — Include the product image gallery on every row (default: false)
• count integer required — Max number of products to return (min: 1)
• sort string — Result ordering (default: "relevance"; one of: "relevance", "price_asc", "price_desc", "discount", "rating", "opinions", "reviews")
• price_min integer nullable — Lowest current price in RUB to keep (min: 0)
• price_max integer nullable — Highest current price in RUB to keep (min: 0)
• availability array — Keep only products offered through these fulfilment routes in the requested city (default: []; one of: "pickup", "pickup_now", "delivery")
• status array — Keep only products carrying these merchandising statuses (default: []; one of: "on_sale", "installment", "new", "hit", "sale", "clearance")
• min_rating string nullable — Keep only products whose buyer rating is at least this value (one of: "3.0", "3.5", "4.0", "4.5")
• min_discount string nullable — Keep only products discounted by at least this percentage (one of: "5", "10", "20", "35")
• brands array — Brand filter values taken from the brand group of citilink/categories/filters (default: []; examples: ["asus","acer"])
• filters array — Extra facet values as `group_id:value_id` pairs, both taken from citilink/categories/filters (default: []; examples: ["23881_3:15.6","298_3:asus"])
• category string required — Citilink category slug or the full catalogue URL (examples: "noutbuki", "smartfony", "https://www.citilink.ru/catalog/televizory/"; minLength: 1)

Response

• @type string (default: "CitilinkProduct")
• id string required
• city string nullable
• city_name string nullable
• name string nullable
• short_name string nullable
• alias string nullable
• url string nullable
• brand object nullable
  • @type string (default: "CitilinkBrandRef")
  • id string nullable
  • name string nullable
  • alias string nullable
  • url string nullable
  • image string nullable
  • vendor_site string nullable
• category object nullable
  • @type string (default: "CitilinkCategoryRef")
  • id string nullable
  • name string nullable
  • alias string nullable
  • url string nullable
• price number nullable
• old_price number nullable
• club_price number nullable
• club_price_view_type string nullable
• discount_percent integer nullable
• bonus_points integer nullable
• sbp_bonus integer nullable
• is_fair_price boolean nullable
• currency string (default: "RUB")
• is_available boolean nullable
• is_discount boolean nullable
• rating number nullable
• opinion_count integer nullable
• review_count integer nullable
• stock_in_stores integer nullable
• max_stock_in_store integer nullable
• pickup_points array (default: [])
  • @type string (default: "CitilinkPickupSummary")
  • delivery_date string nullable
  • store_count integer nullable
• image string nullable
• images array (default: [])
• labels array (default: [])
  • @type string (default: "CitilinkLabel")
  • kind string nullable
  • name string nullable
  • description string nullable
  • url string nullable
  • action_id string nullable
  • expires_at string nullable
• key_properties array (default: [])
  • @type string (default: "CitilinkProperty")
  • name string required
  • value string required
  • measure string nullable
  • description string nullable
  • group string nullable
• pack_size integer nullable
• supplier_pack_size integer nullable
• has_analog_products boolean nullable
• access_mode string nullable

Errors

• 422 — Unknown city code, unknown brand for this category, or a filter value citilink.ru did not apply. 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 — No such category on citilink.ru — the slug or URL resolves to nothing. 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.