Product Changes
Cancel Product Change
Cancel a pending product change without applying it.
POST
/
admin
/
product-changes
/
{id}
/
cancel
curl -X POST 'http://localhost:9000/admin/product-changes/prodch_01HXYZABCDEF/cancel' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'
const { product_change } = await client.admin.productChanges.$id.cancel.mutate({
$id: "prodch_01HXYZABCDEF",
})
{
"product_change": {
"id": "prodch_01HXYZABCDEF",
"product_id": "prod_01HXYZABCDEF",
"status": "canceled",
"canceled_by": "user_01HXYZABCDEF",
"canceled_at": "2026-06-02T09:00:00.000Z",
"actions": [
{
"id": "prodchact_01HXYZABCDEF",
"action": "update_product",
"ordering": 0,
"details": { "title": "Linen Shirt v2" },
"applied": false
}
]
}
}
Cancels the pending change set and returns the updated change record.
Path parameters
string
required
The product change’s ID.
Body parameters
string
Note recorded with the cancellation, visible to operators only.
Response
object
Show properties
Show properties
string
The product change’s ID.
string
ID of the product the change applied to.
string
Change status after cancellation.
string
ID of the actor who canceled the change.
string
When the change was canceled.
object[]
The change’s individual actions with
action, ordering, details, and applied.string
Creation timestamp.
string
Last update timestamp.
curl -X POST 'http://localhost:9000/admin/product-changes/prodch_01HXYZABCDEF/cancel' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'
const { product_change } = await client.admin.productChanges.$id.cancel.mutate({
$id: "prodch_01HXYZABCDEF",
})
{
"product_change": {
"id": "prodch_01HXYZABCDEF",
"product_id": "prod_01HXYZABCDEF",
"status": "canceled",
"canceled_by": "user_01HXYZABCDEF",
"canceled_at": "2026-06-02T09:00:00.000Z",
"actions": [
{
"id": "prodchact_01HXYZABCDEF",
"action": "update_product",
"ordering": 0,
"details": { "title": "Linen Shirt v2" },
"applied": false
}
]
}
}
⌘I
curl -X POST 'http://localhost:9000/admin/product-changes/prodch_01HXYZABCDEF/cancel' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'
const { product_change } = await client.admin.productChanges.$id.cancel.mutate({
$id: "prodch_01HXYZABCDEF",
})
{
"product_change": {
"id": "prodch_01HXYZABCDEF",
"product_id": "prod_01HXYZABCDEF",
"status": "canceled",
"canceled_by": "user_01HXYZABCDEF",
"canceled_at": "2026-06-02T09:00:00.000Z",
"actions": [
{
"id": "prodchact_01HXYZABCDEF",
"action": "update_product",
"ordering": 0,
"details": { "title": "Linen Shirt v2" },
"applied": false
}
]
}
}