docs
  1. Admin Api
  2. Resources
  3. Product Variants
  4. List Product Variants

List product variants

Get product variants

Rate Limit: 1000 Max attempts within 1 minute.

Path Parameters

ParameterDetails
productIdentifier
  • required
string
Examples:
  • ^[1-9][0-9]*$
  • ^key%3D[a-zA-Z0-9-_%\+\. ]*$

Query Parameters

ParameterDetails
with
Array of strings
string
Enum:
attributes
customData
prices
relatedVariants
stocks
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[attributes]
object
Example:
?filters[attributes][color]=red,blue,yellow&filters[attributes][size]=xs,s,m
sort
string
Enum:
id
Default:
id
sortDir
string
Enum:
asc
desc
Default:
asc
cursor
string

Responses

200
List of product variants
application/json
Success
Array of object
object
400
Bad Request
application/json
Error
401
Unauthorized
application/json
Error
404
Not Found
application/json
Error
GET/products/{productIdentifier}/variants

Request samples

Response samples

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