Schema
Return
An e-commerce return: a reverse parcel linked to the original. The customer's phone and the drop-off code are never returned.
Fields
| Field | Type | Description |
|---|---|---|
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. |
sourceOptional | enum | One of TRACKING_PAGE, PERSONAL_APP, MERCHANT_WEB, MERCHANT_API |
reasonRequired | ReturnReason | Why the goods come back. |
reasonLabelOptional | string | |
noteOptional | string or null | |
itemsRequired | array of ReturnItem | |
declaredValueMinorOptional | integer | |
productRequired | 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. |
payerRequired | 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. |
priceMinorRequired | integer | Price of the return parcel in pesewas. |
deductFromRefundMinorOptional | integer | For DEDUCT_FROM_REFUND: keep this much back from the customer refund. |
currencyOptional | "GHS" | |
promisedByOptional | string (date-time) or null | Promise on the return leg (NB19). |
dropoffByOptional | string (date-time) or null | The code expires at this time if unused. |
customerOptional | object | |
nameOptional | string or null | |
originalShipmentRequired | object | |
idRequired | string | |
trackingNumberRequired | string | |
orderReferenceOptional | string or null | |
returnShipmentOptional | object or null | |
idRequired | string | |
trackingNumberRequired | string | |
statusRequired | string | |
dropoffPointOptional | object or null | |
codeOptional | string | |
nameOptional | string | |
returnsToOptional | object or object or null | |
codeRequired | string | |
nameOptional | string | |
storeOptional | object or null | |
idOptional | string | |
nameOptional | string | |
orderOptional | object or null | |
idOptional | string | |
externalOrderIdOptional | string | |
codeOptional | object or null | |
statusRequired | enum | One of PENDING_PAYMENT, ACTIVE, USED, EXPIRED, REVOKED |
expiresAtOptional | string (date-time) | |
usedAtOptional | string (date-time) or null | |
paymentOptional | object or null | |
obligationIdOptional | string | |
statusOptional | string | |
decisionOptional | object or null | |
atOptional | string (date-time) or null | |
reasonOptional | string or null | |
automaticOptional | boolean | |
inspectionOptional | object or null | |
conditionOptional | enum | One of AS_NEW, OPENED, USED, DAMAGED, MISSING_ITEMS, WRONG_ITEM |
notesOptional | string or null | |
atOptional | string (date-time) | |
refundOptional | object or null | |
methodOptional | enum | One of MERCHANT_SYSTEM, DELIVERY_WALLET, NONE |
amountMinorOptional | integer or null | |
referenceOptional | string or null | |
atOptional | string (date-time) | |
claimOptional | object or null | |
idOptional | string | |
statusOptional | string | |
createdAtRequired | string (date-time) | |
updatedAtOptional | string (date-time) |