# /citilink/products/similar

`POST /api/citilink/products/similar`

Price: 20 credits

List the products citilink.ru links to one product — close substitutes, direct analogues, cross-sell accessories, the cheaper picks it suggests and its discounted counterparts — each priced for the requested city and tagged with the relation it came from.

## How to use it

`relation` says why each row is here, and the kinds are not interchangeable: `analog` is a replacement for the same job, `accessory` is something bought alongside it, so filter on it rather than treating the list as one pool. Several relations are frequently empty for a given product; that is the site having nothing to suggest, not a failure. Prices follow `city` like everywhere else on this platform.

## 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)
- `product` (string, required) — Citilink product page URL or the product code printed on the page as 'Код товара' (examples: "2019135", "M00300851", "https://www.citilink.ru/product/noutbuk-digma-pro-fortis-m-i5-1235u-16gb-ssd512gb-2019135/"; minLength: 1)
- `count` (integer, required) — Max number of related products to return (min: 1)
- `with_images` (boolean) — Include the product image gallery on every row (default: false)
- `relations` (array) — Which kinds of relation to include; all of them when left empty (default: []; one of: "similar", "analog", "accessory", "optimal_choice", "discounted")

## Response

### 200 — Successful Response

- `@type` (string) (default: "CitilinkRelatedProduct")
- `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)
- `relation` (string, nullable)
- `source_product_id` (string, nullable)

## Errors

### 422 — Validation Error

Unknown city code — take one from citilink/cities.

What to do: Check the fields against this schema. A URN with the wrong prefix is the most common cause.

- `detail` (array)
  - `loc` (array, required)
  - `msg` (string, required)
  - `type` (string, required)
  - `input` (any)
  - `ctx` (object)

### 408

The request ran past its time limit

What to do: 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 product on citilink.ru — the code or URL resolves to nothing.

What to do: 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

What to do: 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

What to do: 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

What to do: Wait at least 30 seconds, then retry.

## Response envelope

Success: Array of objects (may be empty if no results)

Error: Error may coexist with partial results if it occurs mid-execution. Check X-Error header and status code.

Every response carries these 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.