Get Product Variants

GET/store/variants

Retrieves a list of product variants. The product variants can be filtered by fields such as id or title. The product variants can also be paginated.

For accurate and correct pricing of the product variants based on the customer's context, it's highly recommended to pass fields such as
region_id, currency_code, and cart_id when available.

Passing sales_channel_id ensures retrieving only variants of products available in the specified sales channel.
You can alternatively use a publishable API key in the request header instead of passing a sales_channel_id.

Request

Query Params

ids

string

optional

Filter by a comma-separated list of IDs. If supplied, it overrides the id parameter.

string

optional

Filter by one or more IDs. If ids is supplied, it's overrides the value of this parameter.

sales_channel_id

string

optional

"Filter by sales channel IDs. When provided, only products available in the selected sales channels are retrieved. Alternatively, you can pass a publishable API key in the request header and this will have the same effect."

expand

string

optional

Comma-separated relations that should be expanded in the returned product variants.

fields

string

optional

Comma-separated fields that should be included in the returned product variants.

offset

number

optional

The number of products to skip when retrieving the product variants.

limit

number

optional

Limit the number of product variants returned.

cart_id

string

optional

The ID of the cart. This is useful for accurate pricing based on the cart's context.

region_id

string

optional

The ID of the region. This is useful for accurate pricing based on the selected region.

currency_code

string

optional

A 3 character ISO currency code. This is useful for accurate pricing based on the selected currency.

title

string

optional

Filter by title

inventory_quantity

string

optional

Filter by available inventory quantity

Request samples

Responses

OK(200)

Client Error or Multiple Errors(400)

Not Found Error(404)

Invalid State Error(409)

Invalid Request Error(422)

Server Error(500)

HTTP Code: 200

Content Type : JSONapplication/json

No schema defined

Not configured

Last modified: a year ago