/citilink/categories/filters

POST /api/citilink/categories/filters

Price: 10 credits

List every filter a citilink.ru category exposes, with the group id and human name, each option's id, label and matching product count, and the current bounds and unit of the numeric ranges.

How to use it

Call this first when you want to narrow citilink/categories/products by anything beyond price, availability, status, rating and discount: attribute group ids differ from category to category, so a value copied from one category is not valid in another. Feed `group_id:option_id` pairs straight into the `filters` field there. Each option's `total` is the count in the city you asked for and moves with it — a small settlement shows fewer and can drop an availability option entirely — so this sizes a segment for one city without pulling the products.

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)
• 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: "CitilinkFilterGroup")
• id string required
• name string nullable
• description string nullable
• kind string required
• is_global boolean nullable
• is_disabled boolean nullable
• logic string nullable
• is_searchable boolean nullable
• options array (default: [])
  • @type string (default: "CitilinkFilterOption")
  • id string required
  • name string nullable
  • total integer nullable
  • is_disabled boolean nullable
  • child_groups array (default: [])
• min_value string nullable
• max_value string nullable
• unit string nullable
• step string nullable

Errors

• 422 — Unknown city code — take one from citilink/cities. 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.