Skip to main content
POST
/citilink/products/search

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
count
integer
required
Required range: x >= 1
query
string
required
Minimum string length: 1
timeout
integer
default:300
Required range: 20 <= x <= 1500
city
string
default:msk_cl
Minimum string length: 1
with_images
boolean
default:false
sort
enum<string>
default:relevance
Available options:
relevance,
price_asc,
price_desc,
discount,
rating,
opinions,
reviews
price_min
integer | null
Required range: x >= 0
price_max
integer | null
Required range: x >= 0
availability
enum<string>[]
Available options:
pickup,
pickup_now,
delivery
status
enum<string>[]
Available options:
on_sale,
installment,
new,
hit,
sale,
clearance
min_rating
enum<string> | null
Available options:
3.0,
3.5,
4.0,
4.5
min_discount
enum<string> | null
Available options:
5,
10,
20,
35
brands
string[]
filters
string[]

Response

Successful Response

id
string
required
@type
string
default:CitilinkProduct
city
string | null
city_name
string | null
name
string | null
short_name
string | null
alias
string | null
url
string | null
brand
object | null
category
object | null
price
number | null
old_price
number | null
club_price
number | null
club_price_view_type
string | null
discount_percent
integer | null
bonus_points
integer | null
sbp_bonus
integer | null
is_fair_price
boolean | null
currency
string
default:RUB
is_available
boolean | null
is_discount
boolean | null
rating
number | null
opinion_count
integer | null
review_count
integer | null
stock_in_stores
integer | null
max_stock_in_store
integer | null
pickup_points
object[]
image
string | null
images
string[]
labels
object[]
key_properties
object[]
pack_size
integer | null
supplier_pack_size
integer | null
has_analog_products
boolean | null
access_mode
string | null