Create an attribute value

Creates a new value for an attribute.

• The combination of attribute and value must be unique. Creating a duplicate is rejected.

• If order is omitted, the server tries to derive it from the numeric interpretation of value; non-numeric values leave order unset.

• The write-only translations object may be supplied to provide localized values of translatable fields (label).

Dynamic Setting

Setting Key	Type	Default	Effect
LANDING_PAGE_ATTRIBUTES	array of strings	[]	When the parent attribute's key is in this list, a landing page is automatically created for the new attribute value. See the Dynamic Settings & Environment Variables section.

post

/attribute_value/

Authorizations

AuthorizationstringRequired

Token credential sent in the Authorization header, in the form: Token <your-token>. Requires a staff (admin) account.

Body

The payload accepted when creating or fully updating an attribute value.

attributeintegerRequired

The identifier of the parent attribute. Together with value, must be unique.

valuestringRequired

The value. Together with attribute, must be unique.

orderinteger · nullableOptional

The sort order of the value. When omitted, the server tries to derive it from the numeric interpretation of value.

labelstring · nullableOptional

The translatable display label of the value.

translationsobject · nullableWrite-onlyOptional

Localized values of the translatable fields, keyed by language code. Write-only.

Responses

201

The attribute value was created.

application/json

A predefined value of an attribute as returned by the API.

pkintegerRead-onlyOptional

The unique identifier of the attribute value.

attributeintegerOptional

The identifier of the parent attribute.

valuestringOptional

The value.

orderinteger · nullableOptional

The sort order of the value. Values are listed by order, then value.

labelstring · nullableOptional

The translatable display label of the value, when any.

400

The request contains invalid or missing data.

application/json

401

Authentication credentials were not provided or are invalid.

application/json

403

The authenticated user does not have administrator privileges.

application/json

post/attribute_value/

POST /api/remote/1/attribute_value/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 76

{
  "attribute": 1,
  "value": "text",
  "order": null,
  "label": null,
  "translations": null
}

{
  "pk": 501,
  "attribute": 42,
  "value": "Red",
  "order": 1,
  "label": "Red"
}