Skip to main content
POST
/
admin
/
attributes
Create Attribute
curl --request POST \
  --url https://api.example.com/admin/attributes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "handle": "<string>",
  "is_filterable": true,
  "is_required": true,
  "ui_component": "select",
  "metadata": {},
  "possible_values": [
    {
      "value": "<string>",
      "rank": 123,
      "metadata": {}
    }
  ],
  "product_category_ids": [
    "<string>"
  ]
}
'
{
  "attribute": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "handle": "<string>",
    "is_filterable": true,
    "is_required": true,
    "ui_component": "select",
    "metadata": {},
    "possible_values": [
      {
        "id": "<string>",
        "value": "<string>",
        "rank": 123,
        "metadata": {},
        "created_at": "2023-11-07T05:31:56Z"
      }
    ],
    "values": [
      {
        "id": "<string>",
        "value": "<string>"
      }
    ],
    "product_categories": [
      {
        "id": "<string>",
        "name": "<string>"
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
name
string
required

The name of the attribute.

Minimum string length: 1
​
description
string

A description of the attribute.

​
handle
string

A unique handle for the attribute.

​
is_filterable
boolean

Whether the attribute can be used for filtering products.

​
is_required
boolean

Whether the attribute is required for products.

​
ui_component
enum<string>
default:select

The UI component type for this attribute.

Available options:
select,
multivalue,
unit,
toggle,
text_area,
color_picker
​
metadata
object

Additional metadata for the attribute.

​
possible_values
object[]

Array of possible values for the attribute (required when ui_component is 'select').

​
product_category_ids
string[]

Array of product category IDs to associate with this attribute.

Response

Created

​
attribute
Attribute · object

Attribute object