# /citilink/products/search

`POST /api/citilink/products/search`

Price: 20 credits

Search citilink.ru products by keyword and return priced cards for a specific city: current price in RUB with the pre-discount price, the loyalty-club price, the discount percentage and bonus points, brand and category, 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 any facet published by citilink/categories/filters.

## How to use it

Every price here belongs to `city` — the same query in another city returns different prices, different availability, and sometimes a different set of products, so set `city` deliberately and read it back off the rows. Citilink accepts a vendor code as the query text, which is the reliable way to reach one exact SKU. `brands` resolves brand names against this endpoint's own facet group and works regardless of category. This search has no category scope, so a category-specific `filters` group id from citilink/categories/filters (everything but availability, merchandising status, rating, discount and price) will not match here — this endpoint cannot currently enumerate its own attribute facets. Use citilink/categories/products instead when you want a whole category's attribute facets.

## 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"])
- `query` (string, required) — Free-text search phrase, matched against product names, brands and vendor codes (examples: "ноутбук asus", "iphone 16 pro", "DN15P5-ADXW05"; minLength: 1)

## Response

### 200 — Successful 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 — Validation Error

Unknown city code, unknown brand, or a filter value citilink.ru did not apply.

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

The search returned no result container from citilink.ru.

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.