Products
Retrieve Product Attribute
Retrieve an active global product attribute by ID.
GET
/
store
/
product-attributes
/
{id}
curl 'http://localhost:9000/store/product-attributes/attr_01JB2K7A1B' \
-H 'x-publishable-api-key: pk_01JB2K3XYZ'
const { product_attribute } = await client.store.productAttributes.$id.query({
$id: "attr_01JB2K7A1B",
})
{
"product_attribute": {
"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 }
],
"metadata": null,
"created_at": "2026-05-01T10:00:00.000Z",
"updated_at": "2026-05-01T10:00:00.000Z"
}
}
Returns a single active, global product attribute; inactive or product-scoped attributes return a
404.
Path parameters
string
required
The attribute’s ID.
Query parameters
string
Comma-separated fields and relations to include; prefix with
+/- to add to or remove from the defaults.Response
object
Show properties
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.
curl 'http://localhost:9000/store/product-attributes/attr_01JB2K7A1B' \
-H 'x-publishable-api-key: pk_01JB2K3XYZ'
const { product_attribute } = await client.store.productAttributes.$id.query({
$id: "attr_01JB2K7A1B",
})
{
"product_attribute": {
"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 }
],
"metadata": null,
"created_at": "2026-05-01T10:00:00.000Z",
"updated_at": "2026-05-01T10:00:00.000Z"
}
}
⌘I
curl 'http://localhost:9000/store/product-attributes/attr_01JB2K7A1B' \
-H 'x-publishable-api-key: pk_01JB2K3XYZ'
const { product_attribute } = await client.store.productAttributes.$id.query({
$id: "attr_01JB2K7A1B",
})
{
"product_attribute": {
"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 }
],
"metadata": null,
"created_at": "2026-05-01T10:00:00.000Z",
"updated_at": "2026-05-01T10:00:00.000Z"
}
}