Skip to main content
GET
/
vendor
/
product-attributes
curl 'http://localhost:9000/vendor/product-attributes?type=multi_select' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-seller-id: <seller_id>'
{
  "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

limit
number
default:"50"
The maximum number of attributes to return.
offset
number
default:"0"
The number of attributes to skip before returning results.
order
string
The field to sort by, e.g. rank or -created_at.
fields
string
Comma-separated fields to include in the response. Prefix with +/- to add to or remove from the defaults.
q
string
Search term matched against attribute fields.
id
string | string[]
Filter by attribute ID(s).
handle
string | string[]
Filter by attribute handle(s).
type
string | string[]
Filter by type. Values: single_select, multi_select, unit, toggle, text.
is_required
boolean
Filter by whether the attribute is required.
is_variant_axis
boolean
Filter by whether the attribute drives variant combinations.
is_filterable
boolean
Filter by whether the attribute is filterable.
is_active
boolean
Filter by whether the attribute is active.
category_id
string | string[]
Filter by assigned category ID(s).
created_at
object
Filter by creation date using operators like $gt, $lt, $gte, $lte.
updated_at
object
Filter by update date using operators like $gt, $lt, $gte, $lte.
$and
object[]
Join multiple filter objects with a logical AND.
$or
object[]
Join multiple filter objects with a logical OR.

Response

product_attributes
object[]
count
number
Total number of matching attributes.
offset
number
Number of skipped attributes.
limit
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>'
{
  "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
}