docs
  1. Admin Api
  2. Resources
  3. Products
  4. List Products

List products

Get products for given filters

Rate Limit: 1000 Max attempts within 1 minute.

Query Parameters

ParameterDetails
with
Array of strings
string
Enum:
attributes
images
variants
variants.attributes
variants.prices
variants.stocks
variants.customData
variants.relatedVariants
productSortings
customData
sellableTimeframes
limit
  • Minimum: 1
  • Maximum: 1000
integer
Default:
100
filters[id]
Array of integers
integer
filters[minId]
integer
filters[maxId]
integer
filters[minCreatedAt]
string
Example:
2021-01-23T11%3A30%3A58%2B00%3A00
filters[maxCreatedAt]
string
Example:
2021-01-23T11%3A30%3A58%2B00%3A00
filters[minUpdatedAt]
string
Example:
2021-01-23T11%3A30%3A58%2B00%3A00
filters[maxUpdatedAt]
string
Example:
2021-01-23T11%3A30%3A58%2B00%3A00
filters[variantId]
Array of integers
integer
filters[variantReferenceKey]
Array of strings
string
filters[variantEan]
Array of strings
string
  • MaxLength: 55
filters[attributes]
object
Example:
?filters[attributes][color]=red,blue,yellow&filters[attributes][size]=xs,s,m
filters[masterReferenceKey]
Array of strings
string
filters[isComposite]
boolean
filters[state]
string
Enum:
live
draft
problem
new
inApproval
blocked
Default:
live
Example:
live
sort
string
Enum:
id
Default:
id
sortDir
string
Enum:
asc
desc
Default:
asc
cursor
string

Responses

200
List of products
application/json
Success
Array of object
object
400
Bad Request
application/json
Error
401
Unauthorized
application/json
Error
GET/products

Request samples

Response samples

200
Complete Product Collection:
Content type: application/json
Provide Feedback