post

/shopgate.catalog.getProductVariants.v1

This pipeline retrieves variant-products and the characteristics to distinguish these.

Request Body

Schema
object
productId
string
required
showInactive
boolean

Only active products would be fetched by default, to fetch inactive products too, set this to true

default: false

Responses

Successful response.

1 Example
Schema
object

A collection of variant-data for one product

products
array[object]

List of variant values that identify the different variant products

id
string

The product id of this variant

required
hasOptions
boolean

A flag that determines if this variant has options too, that should be loadead on the detail page

required
characteristics
object

A list of characteristic values that uniquely identify this variant

stock
object
required
availability
object
required
metadata
string or object
characteristics
array[object]

A list of the available characteristics of the variants of this product

id
string

The unique id of this characteristic

required
label
string

The name that should be displayed to the customer, like “color” or “size”

required
values
array[object]

A list of values for this characteristic, already sorted

required

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
1 variable not set
host