Product Attributes
Retrieve Product Attribute
Retrieve a catalog product attribute by ID.
GET
/
admin
/
product-attributes
/
{id}
curl 'http://localhost:9000/admin/product-attributes/pattr_01HXYZABCDEF' \
-H 'Authorization: Bearer <token>'
const { product_attribute } = await client.admin.productAttributes.$id.query({
$id: "pattr_01HXYZABCDEF",
})
{
"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 }
]
}
}
Returns a single attribute with its values and linked categories.
Path parameters
string
required
The attribute’s ID.
Query parameters
string
Comma-separated list of fields to include, prefix with
+/- to add or remove from defaults.Response
object
Show properties
Show properties
string
The attribute’s ID.
string
Attribute name.
string
Unique URL-safe handle.
string
Attribute 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 as a storefront filter.
boolean
Whether the attribute drives variant generation.
boolean
Whether the attribute is active.
string
ID of the actor who created the attribute.
string
Owning product’s ID for product-scoped attributes, otherwise
null.number
Sort rank of the attribute.
object[]
object[]
Linked categories with
id, name, and handle.object
Custom key-value data.
string
Creation timestamp.
string
Last update timestamp.
curl 'http://localhost:9000/admin/product-attributes/pattr_01HXYZABCDEF' \
-H 'Authorization: Bearer <token>'
const { product_attribute } = await client.admin.productAttributes.$id.query({
$id: "pattr_01HXYZABCDEF",
})
{
"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 }
]
}
}
⌘I
curl 'http://localhost:9000/admin/product-attributes/pattr_01HXYZABCDEF' \
-H 'Authorization: Bearer <token>'
const { product_attribute } = await client.admin.productAttributes.$id.query({
$id: "pattr_01HXYZABCDEF",
})
{
"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 }
]
}
}