Skip to content
Merchant guide
HTTPS · Signed events

order.cancellation_requested — V2 event (envelope + data)

It reaches you the moment a cancellation request is opened on an order — by the customer or from the dashboard — carrying the reason, the requesting party and the order status at that moment.

Reviewed against implementation
YOUR INTEGRATION, AT A GLANCE
order.cancellation_requested — full payload example
{
  "id": "mwh:order-cancellation-requested:9e8d7c6b-5a4f-4e3d-2c1b-0a9f8e7d6c5b:c7d1e4a9-2b35-4f68-9c01-5d7e8a9b0c12",
  "type": "order.cancellation_requested",
  "api_version": "v2",
  "tenant_id": "9e8d7c6b-5a4f-4e3d-2c1b-0a9f8e7d6c5b",
  "data": {
    "request_id": "c7d1e4a9-2b35-4f68-9c01-5d7e8a9b0c12",
    "order_id": "3f0c8e6a-1d24-4b7f-9a3e-2c5b8d90f1aa",
    "receipt_number": "RCP-20261020-1482",
    "status": "PENDING",
    "requested_by": "CUSTOMER",
    "reason": "CHANGED_MIND",
    "created_at": "2026-10-20T12:40:03.221104+00:00",
    "order": {
      "order_id": "3f0c8e6a-1d24-4b7f-9a3e-2c5b8d90f1aa",
      "receipt_number": "RCP-20261020-1482",
      "order_type": "DELIVERY",
      "order_source": "WEBSITE",
      "status": "PENDING",
      "customer_name": "Ahmed Mahmoud",
      "customer_phone": "+201001234567",
      "delivery_address": "15 El-Tahrir St., Dokki, Giza",
      "table_number": null,
      "branch_id": "4d5e6f7a-8b9c-4d0e-9f1a-2b3c4d5e6f7a",
      "payment_method": "COD",
      "coupon_code": "WELCOME10",
      "total_amount": 624,
      "tax_amount": 62,
      "shipping_fee": 50,
      "discount_amount": 50,
      "created_at": "2026-10-20T12:34:56.789147+00:00",
      "items": [
        {
          "product_id": "7a2b9c4e-8f31-4d5a-b6c2-1e9f8a7b6c5d",
          "variant_id": "2c4e6f8a-0b1d-4e2f-8a3b-5c6d7e8f9a0b",
          "name": "Cotton T-shirt - Blue / L",
          "price": 225,
          "quantity": 2
        },
        {
          "product_id": "9d8c7b6a-5f4e-4d3c-2b1a-0f9e8d7c6b5a",
          "variant_id": null,
          "name": "Summer cap",
          "price": 112,
          "quantity": 1
        }
      ],
      "items_truncated": false
    }
  }
}
See the implementation
On this page

01When does it fire?

  • When a new cancellation request is opened on any order — whether the customer or the dashboard is the requester.
  • Once per cancellation request — its later decision is a separate event (order.cancellation_decided).

02Full payload example

order.cancellation_requested — full payload example
{
  "id": "mwh:order-cancellation-requested:9e8d7c6b-5a4f-4e3d-2c1b-0a9f8e7d6c5b:c7d1e4a9-2b35-4f68-9c01-5d7e8a9b0c12",
  "type": "order.cancellation_requested",
  "api_version": "v2",
  "tenant_id": "9e8d7c6b-5a4f-4e3d-2c1b-0a9f8e7d6c5b",
  "data": {
    "request_id": "c7d1e4a9-2b35-4f68-9c01-5d7e8a9b0c12",
    "order_id": "3f0c8e6a-1d24-4b7f-9a3e-2c5b8d90f1aa",
    "receipt_number": "RCP-20261020-1482",
    "status": "PENDING",
    "requested_by": "CUSTOMER",
    "reason": "CHANGED_MIND",
    "created_at": "2026-10-20T12:40:03.221104+00:00",
    "order": {
      "order_id": "3f0c8e6a-1d24-4b7f-9a3e-2c5b8d90f1aa",
      "receipt_number": "RCP-20261020-1482",
      "order_type": "DELIVERY",
      "order_source": "WEBSITE",
      "status": "PENDING",
      "customer_name": "Ahmed Mahmoud",
      "customer_phone": "+201001234567",
      "delivery_address": "15 El-Tahrir St., Dokki, Giza",
      "table_number": null,
      "branch_id": "4d5e6f7a-8b9c-4d0e-9f1a-2b3c4d5e6f7a",
      "payment_method": "COD",
      "coupon_code": "WELCOME10",
      "total_amount": 624,
      "tax_amount": 62,
      "shipping_fee": 50,
      "discount_amount": 50,
      "created_at": "2026-10-20T12:34:56.789147+00:00",
      "items": [
        {
          "product_id": "7a2b9c4e-8f31-4d5a-b6c2-1e9f8a7b6c5d",
          "variant_id": "2c4e6f8a-0b1d-4e2f-8a3b-5c6d7e8f9a0b",
          "name": "Cotton T-shirt - Blue / L",
          "price": 225,
          "quantity": 2
        },
        {
          "product_id": "9d8c7b6a-5f4e-4d3c-2b1a-0f9e8d7c6b5a",
          "variant_id": null,
          "name": "Summer cap",
          "price": 112,
          "quantity": 1
        }
      ],
      "items_truncated": false
    }
  }
}

03data fields

FieldMeaning
request_idThe cancellation request id (UUID).
order_idThe id of the order requested for cancellation.
receipt_numberThe order receipt number.
statusThe request status at event time (PENDING).
requested_byThe requesting party — e.g. CUSTOMER.
reasonThe cancellation reason.
created_atWhen the request was opened, ISO 8601.
orderThe full order summary — the same object as the order.created summary.

04Event identity

Pattern: mwh:order-cancellation-requested:<tenant_id>:<request_id> — the resource is the cancellation request id, not the order id.