Skip to content
Guides
ES
API reference
stablecatalog:read

List product variants

Lists the variants of a product with their own SKU, price and stock.

GET/v1/catalog/products/{productId}/variants

Lists the variants of a product with their own SKU, price and stock.

Authorization

bearerAuth
AuthorizationBearer <token>

OAuth2 access token issued by Ecomiq Auth.

In: header

Path Parameters

productId*string

Query Parameters

limit?integer

Maximum number of results to return.

Formatint32
cursor?string

Opaque cursor from the previous response. Omit it on the first page.

search?string

Free-text filter. Which fields it covers depends on the resource.

sortBy?string

Field to sort by. Accepted values depend on the resource.

sortDirection?string

Sort direction: asc or desc.

Value in

  • "asc"
  • "desc"
optionKey*array<string>
optionValue*array<string>

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/catalog/products/string/variants?optionKey=string&optionValue=string"
{  "data": [    {      "id": "string",      "name": "string",      "sku": "string",      "status": "string",      "order": 0,      "imageUrl": null    }  ],  "hasNextPage": true,  "nextCursor": null,  "totalCount": null}