post

/shopgate.catalog.getProductOptions.v1

This pipeline is used to retrieve the options of a product. The result is already sorted.

Request Body

Schema
object
productId
string
required

Responses

Successful response.

1 Example
Schema
object
options
array[object]
id
string

The unique identifier for this option

required
type
string

The type of this option (input field or combobox)

1 validation + required
label
string

The label of the form element that will be display to the customer

required
required
boolean

If true, the customer is forced to select or insert something to the form element

1 validation
annotation
string

A short text, that will be available by clicking a little questionmark on the productpage

unitPriceModifier
number

This property is only available if the type is text and show the amount in the shop’s currency by that the price will change if something is inserted to the form field

1 validation
values
array[object]

This property is only available if the type is select and will display the possible values to choose from

Send a Test Request

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