Developers
API referenceBusiness sign in

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

Return fields
FieldTypeDescription
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.
sourceOptionalenumOne of TRACKING_PAGE, PERSONAL_APP, MERCHANT_WEB, MERCHANT_API
reasonRequiredReturnReasonWhy the goods come back.
reasonLabelOptionalstring
noteOptionalstring or null
itemsRequiredarray of ReturnItem
declaredValueMinorOptionalinteger
productRequiredReturnProductRELAY_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.
payerRequiredReturnPayerMERCHANT: 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.
priceMinorRequiredintegerPrice of the return parcel in pesewas.
deductFromRefundMinorOptionalintegerFor DEDUCT_FROM_REFUND: keep this much back from the customer refund.
currencyOptional"GHS"
promisedByOptionalstring (date-time) or nullPromise on the return leg (NB19).
dropoffByOptionalstring (date-time) or nullThe code expires at this time if unused.
customerOptionalobject
nameOptionalstring or null
originalShipmentRequiredobject
idRequiredstring
trackingNumberRequiredstring
orderReferenceOptionalstring or null
returnShipmentOptionalobject or null
idRequiredstring
trackingNumberRequiredstring
statusRequiredstring
dropoffPointOptionalobject or null
codeOptionalstring
nameOptionalstring
returnsToOptionalobject or object or null
codeRequiredstring
nameOptionalstring
storeOptionalobject or null
idOptionalstring
nameOptionalstring
orderOptionalobject or null
idOptionalstring
externalOrderIdOptionalstring
codeOptionalobject or null
statusRequiredenumOne of PENDING_PAYMENT, ACTIVE, USED, EXPIRED, REVOKED
expiresAtOptionalstring (date-time)
usedAtOptionalstring (date-time) or null
paymentOptionalobject or null
obligationIdOptionalstring
statusOptionalstring
decisionOptionalobject or null
atOptionalstring (date-time) or null
reasonOptionalstring or null
automaticOptionalboolean
inspectionOptionalobject or null
conditionOptionalenumOne of AS_NEW, OPENED, USED, DAMAGED, MISSING_ITEMS, WRONG_ITEM
notesOptionalstring or null
atOptionalstring (date-time)
refundOptionalobject or null
methodOptionalenumOne of MERCHANT_SYSTEM, DELIVERY_WALLET, NONE
amountMinorOptionalinteger or null
referenceOptionalstring or null
atOptionalstring (date-time)
claimOptionalobject or null
idOptionalstring
statusOptionalstring
createdAtRequiredstring (date-time)
updatedAtOptionalstring (date-time)

Used by