Appearance
PUT
/order-property/orders/{orderId}/properties/{propertyKeyId}Required scope:
order:updateSets or updates the value of a single property key on an order. PUT is full replacement — any existing values not in the request are removed. For raw types (STRING, INTEGER, FLOAT, BOOLEAN, HTML): use value for a single value or values for multiple. Each value is an object: {"value": "Gold", "translations": [{"languageCode": "sv", "name": "Guld"}]}. Prefer a single value; for multiple reusable values, consider MULTI_SELECT. For SINGLE_SELECT: use propertyValueId. For MULTI_SELECT: use propertyValueIds.
Parameters
Path parameters
orderId integerThe unique identifier of the order.
propertyKeyId integerThe unique identifier of the property key.
Request body
JSON
{
"value": {
},
"values": [
{
"value": "Gold",
"translations": [
{
"languageCode": "sv",
"name": "Röd",
"description": "..."
}
]
}
],
"propertyValueId": 12345,
"propertyValueIds": [
12345
]
}
Response
The property value was set successfully.
| Error code | Description |
|---|---|
invalid-presentation-type | The property key has an unknown presentation type. |
invalid-request-fields | The wrong request fields were populated for the presentation type. |
invalid-value-format | The provided value does not match the expected format. |
language-not-found | An unknown language code was provided. |
map-count-violation | The number of values violates the min/max map count constraint. |
order-not-found | The order was not found. |
property-key-not-found | The property key was not found. |
property-value-not-found | The property value was not found or not linked to the key. |