List Products

List products

Query Parameters

Parameter	Details
shopId	integer Example: 10001
ids	Array of integers Default: [] integer Example: 123456
campaignKey	string Example: e6413f96-b47c-4be1-be61-d2206adeae71
includeSoldOut	boolean Example: true
referenceKey	string Example: ABC123
pricePromotionKey	string Example: ppk-123
sort	string Enum: id new price reduction Default: id Example: price
sortDir	string Enum: asc desc Default: asc Example: asc
sortingKey	string Example: sortingKey123
filters	object Default: {} Example: { "color": 123 }
filters:not	object Default: {} Example: { "color": 123 }
filters:not[id]	Array of integers Default: [] integer Example: 999
orFiltersOperator	Array of strings Default: [] string Example: attributeGroup2
filters[category]	Array of integers Default: [] Example: 20201,20202 integer
filters[ean]	Array of strings Default: [] string Example: ABC123
filters[isNew]	boolean Example: true
filters[maxPrice]	integer Example: 99999
filters[maxReduction]	integer Example: 30
filters[minPrice]	integer Example: 100
filters[minReduction]	integer Example: 10
filters[referenceKey]	string
filters[variants.referenceKey]	Array of strings Example: ESR0307001,2170-20-00449_36 string
filters[variants.color]	Array of integers Default: [] Example: 446&filters[variants.size]=886 integer
filters[sale]	boolean Example: true
filters[masterKey]	Array of strings Default: [] string Example: [ 502227553 ]
filters[term]	string Example: jeans
filters[minFirstLiveAt]	string Example: 2020-10-13T00:00:00Z
filters[merchantId]	integer Example: 130
filters[hasCampaignReduction]	boolean Example: true&campaignKey={campaignKey}
with	Array of strings Default: [] string Example: attributes
minProductId	integer
disableFuzziness	boolean Example: true
trackSearchAnalyticsEvent	boolean
page Minimum: 1 Maximum: 500000	integer Default: 1 Example: 1
perPage Minimum: 1 Maximum: 1000	integer Default: 100 Example: 100
limit Minimum: 1 Maximum: 1000	integer Example: 100
offset Maximum: 499999	integer

Header Parameters

Parameter	Details
X-Shop-Id	integer Example: 10001

Responses

200

successful operation

application/json

Success

required

Array of object

required

null

400

Required query parameter missing / invalid

application/json

Error

401

Authentication information is missing or invalid

application/json

Error

429

Triggered when a client exceeds the API request limit.

application/json

Error

GET/v1/products

Request samples

Response samples

200

Content type: application/json