Developers
API referenceBusiness sign in

Schema

ReturnCreateRequest

An object of the Qoene Delivery API.

Fields

ReturnCreateRequest fields
FieldTypeDescription
trackingNumberRequiredstringTracking number or shipment ID of the delivered LIVE parcel.Pattern ^(?:QDE-[A-F0-9]{24}|QDE[A-Z0-9]{10,33}|QD-SHP-[A-F0-9]{24}|QDSHP[A-Z0-9]{3,31})$
itemsRequiredarray of objectLines from the original order (all of them when you omit quantity).1–50 items
lineRequiredinteger
quantityOptionalinteger
reasonRequiredReturnReasonWhy the goods come back.
noteOptionalstring or nullRequired for OTHER (5–1000 characters).
productCodeOptionalReturnProductRELAY_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.
dropoffPointCodeOptionalstringThe Qoene Point where the customer plans to drop off (they may use another point of the same price).
pickupAddressTextOptionalstringEXPRESS_STANDARD: where the rider collects.
emailOptionalstringOptional email to send the code to.
declaredValueMinorOptionalintegerOnly when the order lines have no prices.
prohibitedItemsDeclarationRequiredobject
acceptedRequiredtrue
versionRequiredstring

Used by