List Product Attributes

GET

store

product-attributes

curl 'http://localhost:9000/store/product-attributes?is_filterable=true' \
  -H 'x-publishable-api-key: pk_01JB2K3XYZ'

const { product_attributes, count } = await client.store.productAttributes.query({
  is_filterable: true,
})

{
  "product_attributes": [
    {
      "id": "attr_01JB2K7A1B",
      "name": "Material",
      "handle": "material",
      "description": null,
      "type": "single_select",
      "is_required": false,
      "is_filterable": true,
      "is_variant_axis": false,
      "product_id": null,
      "rank": 0,
      "values": [
        { "id": "attrval_01JB2K7C2D", "name": "Linen", "rank": 0 },
        { "id": "attrval_01JB2K7E3F", "name": "Cotton", "rank": 1 }
      ],
      "metadata": null,
      "created_at": "2026-05-01T10:00:00.000Z",
      "updated_at": "2026-05-01T10:00:00.000Z"
    }
  ],
  "count": 5,
  "offset": 0,
  "limit": 50
}

Returns a paginated list of active, global product attributes (attributes scoped to a single product are excluded).

Query parameters

number

default:"50"

Maximum number of attributes to return.

number

default:"0"

Number of attributes to skip before collecting results.

string

Field to sort by, prefixed with - for descending order.

string

Comma-separated fields and relations to include; prefix with +/- to add to or remove from the defaults.

string

Free-text search term applied to attribute fields.

string | string[]

Filter by one or more attribute IDs.

string | string[]

Filter by one or more attribute handles.

string | string[]

Filter by attribute type. Values: single_select, multi_select, unit, toggle, text.

boolean

Filter attributes that define variant axes.

boolean

Filter attributes usable as storefront filters.

object

Filter by creation date using operators like $gt, $gte, $lt, $lte.

object

Filter by update date using operators like $gt, $gte, $lt, $lte.

object[]

Join multiple filter objects with a logical AND.

object[]

Join multiple filter objects with a logical OR.

Response

object[]

Show properties

string

The attribute’s ID.

string

The attribute’s display name.

string

URL-safe handle.

string | null

The attribute’s description.

string

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

boolean

Whether sellers must set a value.

boolean

Whether the attribute can drive storefront filters.

boolean

Whether the attribute defines a variant axis.

null

Always null on the store API (global attributes only).

number

Sort rank.

object[]

The attribute’s predefined values.

object | null

Custom key-value data.

string

Creation timestamp.

string

Last update timestamp.

number

Total number of matching attributes.

number

Number of skipped attributes.

number

Maximum number of returned attributes.

curl 'http://localhost:9000/store/product-attributes?is_filterable=true' \
  -H 'x-publishable-api-key: pk_01JB2K3XYZ'

const { product_attributes, count } = await client.store.productAttributes.query({
  is_filterable: true,
})

{
  "product_attributes": [
    {
      "id": "attr_01JB2K7A1B",
      "name": "Material",
      "handle": "material",
      "description": null,
      "type": "single_select",
      "is_required": false,
      "is_filterable": true,
      "is_variant_axis": false,
      "product_id": null,
      "rank": 0,
      "values": [
        { "id": "attrval_01JB2K7C2D", "name": "Linen", "rank": 0 },
        { "id": "attrval_01JB2K7E3F", "name": "Cotton", "rank": 1 }
      ],
      "metadata": null,
      "created_at": "2026-05-01T10:00:00.000Z",
      "updated_at": "2026-05-01T10:00:00.000Z"
    }
  ],
  "count": 5,
  "offset": 0,
  "limit": 50
}

curl 'http://localhost:9000/store/product-attributes?is_filterable=true' \
  -H 'x-publishable-api-key: pk_01JB2K3XYZ'

const { product_attributes, count } = await client.store.productAttributes.query({
  is_filterable: true,
})

{
  "product_attributes": [
    {
      "id": "attr_01JB2K7A1B",
      "name": "Material",
      "handle": "material",
      "description": null,
      "type": "single_select",
      "is_required": false,
      "is_filterable": true,
      "is_variant_axis": false,
      "product_id": null,
      "rank": 0,
      "values": [
        { "id": "attrval_01JB2K7C2D", "name": "Linen", "rank": 0 },
        { "id": "attrval_01JB2K7E3F", "name": "Cotton", "rank": 1 }
      ],
      "metadata": null,
      "created_at": "2026-05-01T10:00:00.000Z",
      "updated_at": "2026-05-01T10:00:00.000Z"
    }
  ],
  "count": 5,
  "offset": 0,
  "limit": 50
}

Overview

Panel extensions

Admin API

Vendor API

Store API

Configuration

Query parameters

Response

​Query parameters

​Response

Query parameters

Response