01When does it fire?
- When a customer opens a new return request on an existing order.
- Once per return request — its later decision is a separate event (return.request_decided).
02Full payload example
{
"id": "mwh:return-requested:9e8d7c6b-5a4f-4e3d-2c1b-0a9f8e7d6c5b:d2a6b8c1-4e75-49f0-8a23-6b9c0d1e2f34",
"type": "return.requested",
"api_version": "v2",
"tenant_id": "9e8d7c6b-5a4f-4e3d-2c1b-0a9f8e7d6c5b",
"data": {
"request_id": "d2a6b8c1-4e75-49f0-8a23-6b9c0d1e2f34",
"order_id": "3f0c8e6a-1d24-4b7f-9a3e-2c5b8d90f1aa",
"receipt_number": "RCP-20261020-1482",
"status": "PENDING",
"reason": "WRONG_SIZE",
"notes": "The size ran smaller than expected",
"items": [
{
"product_id": "7a2b9c4e-8f31-4d5a-b6c2-1e9f8a7b6c5d",
"variant_id": "2c4e6f8a-0b1d-4e2f-8a3b-5c6d7e8f9a0b",
"name": "Cotton T-shirt - Blue / L",
"price": 225,
"quantity": 1
}
],
"items_truncated": false,
"order": {
"order_id": "3f0c8e6a-1d24-4b7f-9a3e-2c5b8d90f1aa",
"receipt_number": "RCP-20261020-1482",
"order_type": "DELIVERY",
"order_source": "WEBSITE",
"status": "SHIPPED",
"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
| Field | Meaning |
|---|---|
| request_id | The return request id (UUID). |
| order_id | The order id. |
| receipt_number | The order receipt number. |
| status | The request status at event time (PENDING). |
| reason | The return reason (capped at 500 characters). |
| notes | The customer free-form notes. |
| items | The items requested for return — same shape as order items. |
| items_truncated | true when items exceeded 100 and were capped. |
| order | The full order summary — the same object as the order.created summary. |
04Event identity
Pattern: mwh:return-requested:<tenant_id>:<request_id> — the resource is the return request.
COMPLETE YOUR INTEGRATION