Skip to main content
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 '{}'
{
  "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

id
string
required
The product change’s ID.

Body parameters

internal_note
string
Note recorded with the cancellation, visible to operators only.

Response

product_change
object
curl -X POST 'http://localhost:9000/admin/product-changes/prodch_01HXYZABCDEF/cancel' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{}'
{
  "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
      }
    ]
  }
}