# /citilink/products/reviews

`POST /api/citilink/products/reviews`

Price: 10 credits

List buyer reviews of one citilink.ru product: star rating, the separate 'pros', 'cons' and free-text sections, publication date, author nickname and expert flag, helpful and unhelpful vote counts, and whether the review came from an external source. Optionally prepend the average rating with the per-star breakdown.

## How to use it

Citilink pools reviews across the colours and configurations of one model, so by default the list contains reviews written about sibling SKUs — `product_id` on each row says which one, and `include_variant_group: false` narrows it to only the exact code you asked for, dropping the reviews of every sibling SKU. Set `with_summary` when you want the star histogram, and expect that first row to be a different shape from the reviews after it. `sort: worst` plus `ratings: [1, 2]` is how you reach the complaints without reading the whole set.

## 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 reviews to return (min: 1)
- `sort` (string) — Review ordering (default: "helpful"; one of: "helpful", "new", "old", "best", "worst")
- `ratings` (array) — Keep only reviews carrying these star ratings (default: []; one of: 1, 2, 3, 4, 5; examples: [1,2])
- `include_variant_group` (boolean) — Include reviews written for the other colours and configurations of the same model (default: true)
- `with_summary` (boolean) — Prepend one row holding the average rating and the per-star breakdown (default: false)

## Response

### 200 — Successful Response

- `@type` (string) (default: "CitilinkReview")
- `id` (string, required)
- `product_id` (string, nullable)
- `product_name` (string, nullable)
- `rating` (integer, nullable)
- `pros` (string, nullable)
- `cons` (string, nullable)
- `text` (string, nullable)
- `published_at` (string, nullable)
- `created_at` (string, nullable)
- `author` (string, nullable)
- `author_id` (string, nullable)
- `is_expert` (boolean, nullable)
- `is_best` (boolean, nullable)
- `is_from_variant_group` (boolean, nullable)
- `status` (string, nullable)
- `source` (string, nullable)
- `source_description` (string, nullable)
- `vendor` (string, nullable)
- `likes` (integer, nullable)
- `dislikes` (integer, 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, or the product has no review container.

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.