Developers
API referenceBusiness sign in

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

WebhookReturnEvent fields
FieldTypeDescription
idRequiredstring (uuid)Stable event ID; deduplicate on it.
typeRequiredenumOne 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_atRequiredstring (date-time)
dataRequiredobject
returnRequiredobject
idRequiredstringReturn IDPattern ^(?:QD-RET-[A-F0-9]{24}|QDRET[A-Z0-9]{3,31})$
statusRequiredReturnStatusREQUESTED: 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.
reasonRequiredReturnReasonWhy the goods come back.
productOptionalReturnProductRELAY_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.
payerOptionalReturnPayerMERCHANT: 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_minorOptionalinteger
deduct_from_refund_minorOptionalinteger
currencyOptionalstring
itemsOptionalarray of object
nameOptionalstring
skuOptionalstring or null
quantityOptionalinteger
inspection_conditionOptionalstring or null
refund_methodOptionalstring or null
refund_amount_minorOptionalinteger or null
original_shipmentRequiredobject
idRequiredstring
tracking_numberRequiredstring
order_referenceOptionalstring or null
return_shipmentOptionalobject or null
idOptionalstring
tracking_numberOptionalstring
orderOptionalobject or null
idOptionalstring
external_order_idOptionalstring
created_atOptionalstring (date-time)

Used by