List Product Attributes

GET

vendor

product-attributes

curl 'http://localhost:9000/vendor/product-attributes?type=multi_select' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-seller-id: <seller_id>'

const { product_attributes, count } =
  await client.vendor.productAttributes.query({ type: "multi_select" })

{
  "product_attributes": [
    {
      "id": "pattr_01HXYZ",
      "name": "Color",
      "handle": "color",
      "type": "multi_select",
      "is_variant_axis": true,
      "values": [
        { "id": "pattrval_01HXYZ", "name": "Red", "rank": 0 }
      ]
    }
  ],
  "count": 1,
  "offset": 0,
  "limit": 50
}

Returns global attribute definitions (product-scoped attributes are excluded) with their values and category assignments.

Query parameters

number

default:"50"

The maximum number of attributes to return.

number

default:"0"

The number of attributes to skip before returning results.

string

The field to sort by, e.g. rank or -created_at.

string

Comma-separated fields to include in the response. Prefix with +/- to add to or remove from the defaults.

string

Search term matched against attribute fields.

string | string[]

Filter by attribute ID(s).

string | string[]

Filter by attribute handle(s).

string | string[]

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

boolean

Filter by whether the attribute is required.

boolean

Filter by whether the attribute drives variant combinations.

boolean

Filter by whether the attribute is filterable.

boolean

Filter by whether the attribute is active.

string | string[]

Filter by assigned category ID(s).

object

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

object

Filter by update date using operators like $gt, $lt, $gte, $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 name.

string

The attribute’s handle.

string

The attribute’s description.

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 for filtering.

boolean

Whether the attribute drives variant combinations.

boolean

Whether the attribute is active.

number

Sort rank of the attribute.

object[]

The attribute’s values with id, name, handle, and rank.

object[]

Assigned categories with id, name, and handle.

number

Total number of matching attributes.

number

Number of skipped attributes.

number

Maximum number of returned attributes.

curl 'http://localhost:9000/vendor/product-attributes?type=multi_select' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-seller-id: <seller_id>'

const { product_attributes, count } =
  await client.vendor.productAttributes.query({ type: "multi_select" })

{
  "product_attributes": [
    {
      "id": "pattr_01HXYZ",
      "name": "Color",
      "handle": "color",
      "type": "multi_select",
      "is_variant_axis": true,
      "values": [
        { "id": "pattrval_01HXYZ", "name": "Red", "rank": 0 }
      ]
    }
  ],
  "count": 1,
  "offset": 0,
  "limit": 50
}

curl 'http://localhost:9000/vendor/product-attributes?type=multi_select' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-seller-id: <seller_id>'

const { product_attributes, count } =
  await client.vendor.productAttributes.query({ type: "multi_select" })

{
  "product_attributes": [
    {
      "id": "pattr_01HXYZ",
      "name": "Color",
      "handle": "color",
      "type": "multi_select",
      "is_variant_axis": true,
      "values": [
        { "id": "pattrval_01HXYZ", "name": "Red", "rank": 0 }
      ]
    }
  ],
  "count": 1,
  "offset": 0,
  "limit": 50
}

Overview

Panel extensions

Admin API

Vendor API

Store API

Configuration

Query parameters

Response

​Query parameters

​Response

Query parameters

Response