Skip to main content

Get product parameter

Gets a specific product parameter

Path Parameters
id int32 REQUIRED

The id of the product parameter to get.

Responses
200

The requested product parameter.

Schema OPTIONAL
Resource object OPTIONAL

An existing product parameter.

ParameterId int32 OPTIONAL

The unique identifier for the parameter.

GroupId int32 OPTIONAL

The unique identifier of the group that this parameter belongs to.

GroupName string OPTIONAL

The name of the group that this parameter belongs to.

ParameterType int32 OPTIONAL

Possible values: [1, 2, 3, 4, 5, 6, 7]

The type of parameter.
1 = String. Any string value.
2 = Float. Any floating point number.
Period as decimal separator and no thousands separator.
Eg: 10001.789.
3 = DateTime. Any ISO 8601 date.
Eg: 2017-03-06T16:31:24+02:00.
4 = Multi. A string value from a predefined set of values.
This type may occur multiple times for the same parameter.
5 = Single. A string value from a predefined set of values.
6 = Headline. A string value used mainly for grouping in layout.
7 = Tags. A pipe-separated list of product specific values.
Eg: red|green|blue.

Name string OPTIONAL

The non-localized name of the parameter.

LocalizedNames object[] OPTIONAL

The localized names of the parameter.

LanguageCode string OPTIONAL
Content string OPTIONAL

The localized content.

PredefinedValues object[] OPTIONAL

List of predefined values for the parameter. Only used for Single and Multi types.

ParameterId int32 OPTIONAL

The unique identifier for the parameter.

PredefinedValueId int32 OPTIONAL

The predefined value id of the parameter.
This value is used in ProductParameterValue.Value.

Name string OPTIONAL

The non-localized predefined value name of the parameter.

LocalizedNames object[] OPTIONAL

The localized predefined value names of the parameter.

LanguageCode string OPTIONAL
Content string OPTIONAL

The localized content.

Message string OPTIONAL

A status message for the action taken.

Details string[] OPTIONAL

Any validation messages for the data on the current action.

404

Not found.

Schema OPTIONAL
Message string OPTIONAL

A status message for the action taken.

Details string[] OPTIONAL

Any validation messages for the data on the current action.