Skip to main content

Create/update product parameter value

Creates or updates a new product parameter value.

Request Body REQUIRED

The product parameter value to create or update.

ProductId int32

The product id of the parameter.
This value can be omitted if the value is part of a product request.

ParameterId int32

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

Value string

The identifying value of the parameter.
Although always presented as a string, the data within Value must validate against the ProductParameterType of the parameter:
String = Any string.
Float = Any floating point number.
DateTime = Any date.
Multi = Any predefined value id from the predefined set of values for this parameter.
Single = Any predefined value id from the predefined set of values for this parameter.
Headline = Any string.
Tags = Any string, as part of a pipe-separated list. A string containing the pipe (|) character is not allowed.

LocalizedDescriptions object[]

The localized descriptions of the parameter.
Only used for parameter types String or Headline.
For Multi and Single, use LocalizedNames.

LanguageCode string
Content string

The localized content.

Responses
200

The updated or created product parameter value.

Schema OPTIONAL
Resource object OPTIONAL

A parameter value for a product.

ParameterValueId int32 OPTIONAL

The unique identifier of this parameter value.

ProductId int32 OPTIONAL

The product id of the parameter.

ParameterId int32 OPTIONAL

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

ParameterName string OPTIONAL

The non-localized name of 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.
The Value field must validate against this type.
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.

Value string OPTIONAL

The identifying value of the parameter.
Although always presented as a string, the data within Value must validate against the type of the parameter:
String = Any string.
Float = Any floating point number.
DateTime = Any date.
Multi = Any predefined value id from the predefined set of values for this parameter.
Single = Any predefined value id from the predefined set of values for this parameter.
Headline = Any string.

Description string OPTIONAL

The non-localized description of the parameter.
This is usually the same value as Value for all parameter types, except Single Multi.

LocalizedDescriptions object[] OPTIONAL

The localized descriptions of the parameter.
Not used for parameter types Float or DateTime.

LanguageCode string OPTIONAL
Content string OPTIONAL

The localized content.

InternalIdentifier string OPTIONAL

The internal identifier of the parameter.

Order int32 OPTIONAL

Value indicating order of the parameter value. The value takes the order of the parameter into account. Formula: (ParameterOrder * 10000) + ParameterValueOrder.

Message string OPTIONAL

A status message for the action taken.

Details string[] OPTIONAL

Any validation messages for the data on the current action.

400

Bad request.

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.