Schema
WebhookReturnEvent
Body for return.* events. No customer contact, notes or drop-off codes. Refund your customer from your own system on return.received or return.inspected.
Fields
| Field | Type | Description |
|---|---|---|
idRequired | string (uuid) | Stable event ID; deduplicate on it. |
typeRequired | enum | One of return.requested, return.approved, return.rejected, return.cancelled, return.expired, return.dropped_off, return.in_transit, return.arrived, return.received, return.inspected, return.refund_recorded |
created_atRequired | string (date-time) | |
dataRequired | object | |
returnRequired | object | |
idRequired | string | Return IDPattern ^(?:QD-RET-[A-F0-9]{24}|QDRET[A-Z0-9]{3,31})$ |
statusRequired | ReturnStatus | REQUESTED: waiting for your review. AWAITING_PAYMENT: approved; the customer pays before the code works. AWAITING_DROPOFF: the paperless code is active. DROPPED_OFF, IN_TRANSIT, ARRIVED (ready for you), RECEIVED (handed to you), INSPECTED. Closed: REJECTED, CANCELLED, EXPIRED. |
reasonRequired | ReturnReason | Why the goods come back. |
productOptional | ReturnProduct | RELAY_POINT: dropped off at a Qoene Point. RELAY_LOCKER: locker drop-off (not live until lockers are deployed). EXPRESS_STANDARD: a rider collects it inside an Express area. |
payerOptional | ReturnPayer | MERCHANT: billed to your Business wallet or invoice. CUSTOMER: the customer pays by Mobile Money before the code works. DEDUCT_FROM_REFUND: billed to you; deductFromRefundMinor tells your refund system what to keep back. |
price_minorOptional | integer | |
deduct_from_refund_minorOptional | integer | |
currencyOptional | string | |
itemsOptional | array of object | |
nameOptional | string | |
skuOptional | string or null | |
quantityOptional | integer | |
inspection_conditionOptional | string or null | |
refund_methodOptional | string or null | |
refund_amount_minorOptional | integer or null | |
original_shipmentRequired | object | |
idRequired | string | |
tracking_numberRequired | string | |
order_referenceOptional | string or null | |
return_shipmentOptional | object or null | |
idOptional | string | |
tracking_numberOptional | string | |
orderOptional | object or null | |
idOptional | string | |
external_order_idOptional | string | |
created_atOptional | string (date-time) |