Developers
API referenceBusiness sign in

Returns

List returns

GET/returns

Scope returns.read

Returns of this Business's parcels, newest first, whoever started them (customer, Business workspace or API).

Request

Query parameters

Query parameters
NameInTypeDescription
statusOptionalquerystringFilter by status.
storeIdOptionalquerystringOnly this store.Pattern ^(?:QD-STR-[A-F0-9]{24}|QDSTR[A-Z0-9]{3,31})$
searchOptionalquerystringReturn ID, tracking number, order reference or external order ID.
limitOptionalqueryintegerPage size.1 to 100Default 25
cursorOptionalquerystringOpaque cursor from nextCursor.

Response

Success responses
StatusMeaning
200A page of returns

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

Response data
FieldTypeDescription
returnsRequiredarray of Return
nextCursorRequiredstring or null

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).
429Too many requests. See the RateLimit headers. Too many requests. Wait for Retry-After, then retry with the same idempotency key.