Create Product Attribute

POST

admin

product-attributes

curl -X POST 'http://localhost:9000/admin/product-attributes' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Material",
    "type": "single_select",
    "is_filterable": true,
    "values": [{ "name": "Linen" }, { "name": "Cotton" }]
  }'

const { product_attribute } = await client.admin.productAttributes.mutate({
  name: "Material",
  type: "single_select",
  is_filterable: true,
  values: [{ name: "Linen" }, { name: "Cotton" }],
})

{
  "product_attribute": {
    "id": "pattr_01HXYZABCDEF",
    "name": "Material",
    "handle": "material",
    "type": "single_select",
    "is_required": false,
    "is_filterable": true,
    "is_variant_axis": false,
    "is_active": true,
    "values": [
      { "id": "pattrval_01HXYZABCDEF", "name": "Linen", "rank": 0 },
      { "id": "pattrval_01HXYZABCDEG", "name": "Cotton", "rank": 1 }
    ]
  }
}

Creates a shared attribute that products across the catalog can use.

is_variant_axis is only valid for multi_select attributes. Axis attributes provide the value sets that variants are generated from.

Body parameters

string

required

Attribute name.

string

required

One of single_select, multi_select, unit, toggle, text.

string

Unique URL-safe handle, generated from the name if omitted.

string

Attribute description.

boolean

Whether a value is required on products.

boolean

Whether the attribute can be used as a storefront filter.

boolean

Whether the attribute drives variant generation; only valid for multi_select.

number

Sort rank of the attribute; must be non-negative.

boolean

Whether the attribute is active.

string[]

IDs of categories to link the attribute to; omit for a global attribute.

object[]

Initial attribute values for select types.

Show properties

string

required

Value name.

string

Unique URL-safe handle.

number

Sort rank; must be non-negative.

boolean

Whether the value is active.

object

Custom key-value data.

object

Custom key-value data.

object

Custom data passed to workflow hooks.

Response

object

Show properties

string

The attribute’s ID.

string

Attribute name.

string

Unique URL-safe handle.

string

One of single_select, multi_select, unit, toggle, text.

boolean

Whether a value is required on products.

boolean

Whether the attribute can be used as a storefront filter.

boolean

Whether the attribute drives variant generation.

boolean

Whether the attribute is active.

object[]

The attribute’s values.

object[]

Linked categories with id, name, and handle.

string

Creation timestamp.

string

Last update timestamp.

curl -X POST 'http://localhost:9000/admin/product-attributes' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Material",
    "type": "single_select",
    "is_filterable": true,
    "values": [{ "name": "Linen" }, { "name": "Cotton" }]
  }'

const { product_attribute } = await client.admin.productAttributes.mutate({
  name: "Material",
  type: "single_select",
  is_filterable: true,
  values: [{ name: "Linen" }, { name: "Cotton" }],
})

{
  "product_attribute": {
    "id": "pattr_01HXYZABCDEF",
    "name": "Material",
    "handle": "material",
    "type": "single_select",
    "is_required": false,
    "is_filterable": true,
    "is_variant_axis": false,
    "is_active": true,
    "values": [
      { "id": "pattrval_01HXYZABCDEF", "name": "Linen", "rank": 0 },
      { "id": "pattrval_01HXYZABCDEG", "name": "Cotton", "rank": 1 }
    ]
  }
}

curl -X POST 'http://localhost:9000/admin/product-attributes' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Material",
    "type": "single_select",
    "is_filterable": true,
    "values": [{ "name": "Linen" }, { "name": "Cotton" }]
  }'

const { product_attribute } = await client.admin.productAttributes.mutate({
  name: "Material",
  type: "single_select",
  is_filterable: true,
  values: [{ name: "Linen" }, { name: "Cotton" }],
})

{
  "product_attribute": {
    "id": "pattr_01HXYZABCDEF",
    "name": "Material",
    "handle": "material",
    "type": "single_select",
    "is_required": false,
    "is_filterable": true,
    "is_variant_axis": false,
    "is_active": true,
    "values": [
      { "id": "pattrval_01HXYZABCDEF", "name": "Linen", "rank": 0 },
      { "id": "pattrval_01HXYZABCDEG", "name": "Cotton", "rank": 1 }
    ]
  }
}

Overview

Panel extensions

Admin API

Vendor API

Store API

Configuration

Body parameters

Response

​Body parameters

​Response

Body parameters

Response