Products
Batch Product Attributes
Add, remove, and update attributes on a product in one request.
POST
/
admin
/
products
/
{id}
/
attributes
/
batch
curl -X POST 'http://localhost:9000/admin/products/prod_01HXYZABCDEF/attributes/batch' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{
"add": [{ "id": "pattr_01HXYZABCDEF", "value_ids": ["pattrval_01HXYZABCDEF"] }],
"remove": ["pattr_01HXYZABCDEG"]
}'
const { product } = await client.admin.products.$id.attributes.batch.mutate({
$id: "prod_01HXYZABCDEF",
add: [{ id: "pattr_01HXYZABCDEF", value_ids: ["pattrval_01HXYZABCDEF"] }],
remove: ["pattr_01HXYZABCDEG"],
})
{
"product": {
"id": "prod_01HXYZABCDEF",
"title": "Linen Shirt",
"status": "published",
"product_attribute_values": [
{
"id": "pattrval_01HXYZABCDEF",
"name": "Linen",
"attribute": { "id": "pattr_01HXYZABCDEF", "name": "Material", "type": "single_select" }
}
],
"scoped_attributes": []
}
}
Applies attribute changes to the product in the order
remove → add → update.
Path parameters
string
required
The product’s ID.
Body parameters
object[]
Attributes to attach, one of two shapes per item.
Show existing attribute (by id)
Show existing attribute (by id)
Show inline attribute (by title)
Show inline attribute (by title)
string
required
Attribute title.
string
One of
single_select, multi_select, unit, toggle, text; required for non-axis inline attributes unless value is a boolean.string[]
Value names to create and select.
string | number | boolean
Scalar value for non-select types.
boolean
Whether the attribute drives variant generation; only allowed on
multi_select attributes.boolean
Whether the attribute can be used as a storefront filter.
boolean
Whether a value is required on products.
string
Attribute description.
object
Custom key-value data.
string[]
IDs of attributes to detach from the product.
object[]
Changes to attributes already on the product.
Response
object
curl -X POST 'http://localhost:9000/admin/products/prod_01HXYZABCDEF/attributes/batch' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{
"add": [{ "id": "pattr_01HXYZABCDEF", "value_ids": ["pattrval_01HXYZABCDEF"] }],
"remove": ["pattr_01HXYZABCDEG"]
}'
const { product } = await client.admin.products.$id.attributes.batch.mutate({
$id: "prod_01HXYZABCDEF",
add: [{ id: "pattr_01HXYZABCDEF", value_ids: ["pattrval_01HXYZABCDEF"] }],
remove: ["pattr_01HXYZABCDEG"],
})
{
"product": {
"id": "prod_01HXYZABCDEF",
"title": "Linen Shirt",
"status": "published",
"product_attribute_values": [
{
"id": "pattrval_01HXYZABCDEF",
"name": "Linen",
"attribute": { "id": "pattr_01HXYZABCDEF", "name": "Material", "type": "single_select" }
}
],
"scoped_attributes": []
}
}
⌘I
curl -X POST 'http://localhost:9000/admin/products/prod_01HXYZABCDEF/attributes/batch' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{
"add": [{ "id": "pattr_01HXYZABCDEF", "value_ids": ["pattrval_01HXYZABCDEF"] }],
"remove": ["pattr_01HXYZABCDEG"]
}'
const { product } = await client.admin.products.$id.attributes.batch.mutate({
$id: "prod_01HXYZABCDEF",
add: [{ id: "pattr_01HXYZABCDEF", value_ids: ["pattrval_01HXYZABCDEF"] }],
remove: ["pattr_01HXYZABCDEG"],
})
{
"product": {
"id": "prod_01HXYZABCDEF",
"title": "Linen Shirt",
"status": "published",
"product_attribute_values": [
{
"id": "pattrval_01HXYZABCDEF",
"name": "Linen",
"attribute": { "id": "pattr_01HXYZABCDEF", "name": "Material", "type": "single_select" }
}
],
"scoped_attributes": []
}
}