Developers
API referenceBusiness sign in

Returns

Price and promise of a return option

POST/returns/quote

Scope returns.writeLIVE keys only

Prices the return parcel from a drop-off point (or the customer's address for Express) to where your returns go, with your contract rates, and the promised date of the return leg.

Request

Body ReturnQuoteRequest

Request body
FieldTypeDescription
trackingNumberRequiredstring
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.
dropoffPointCodeOptionalstring
pickupAddressTextOptionalstring

Response

Success responses
StatusMeaning
200The quote

The body is { "status": "success", "data": … }. Fields of data (ReturnQuoteResult):

Response data
FieldTypeDescription
quoteRequiredReturnQuote

Errors

Errors use the error envelope { "status": "error", "message", "code"?, "details"? }.

Error responses
StatusWhen
400The request is not valid. A field is missing or invalid, or the Idempotency-Key header is missing or malformed.
401Missing, invalid, expired or revoked API key. The API key is missing, invalid, expired or revoked.
403The key lacks the scope, or the operation needs a LIVE key. The key lacks the scope, or this call needs a LIVE key (LIVE_KEY_REQUIRED), or the Business owner is not verified (SENDER_VERIFICATION_REQUIRED).
404Not found for this Business and environment. IDs from another Business or environment are always 404. Not found for this Business and environment. IDs from another Business or the other environment are always 404.
409Idempotency key reused with another body, or the resource changed state. The idempotency key was used with a different body, a reference is already taken, or the resource changed state.
422Eligibility or business rule refused the request; details.reason explains why. A business rule refused the request. details.reason.code says why (for example OVER_PRODUCT_WEIGHT_LIMIT or a point exclusion reason).
429Too many requests. See the RateLimit headers. Too many requests. Wait for Retry-After, then retry with the same idempotency key.