Product Types

List variants of a configurable product

Configurable-type only. Returns the child product variants of the given configurable product. Each variant is a Product with the same card-level fields as the list endpoint.

get/products/{productId}/variants

Request

Base URL
http://localhost:8000/api/shop
Auth
HTTP bearer
TypeScript
https://skmtc.dev/bagisto/apis/bagisto-shop-api/docs/products/:productId/variants/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

productIdstring required

Product ID

Query parameters

pageinteger

The collection page number

per_pageinteger

The number of items per page

Headers

X-STOREFRONT-KEYstring required

Storefront API Key for authentication. Required for all shop/storefront API requests.

X-Localestring

Example:en

Locale code for localized data (e.g. "en", "fr", "ar"). Defaults to channel's default locale.

X-Channelstring

Example:default

Channel code (e.g. "default"). Defaults to the current channel.

X-Currencystring

Example:USD

Currency code (e.g. "USD", "EUR", "INR"). Defaults to channel's base currency.

Response

List of product variants

Changes

No recorded changes to this operation across all 13 revisions of this API.