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
| Name | In | Type | Description |
|---|---|---|---|
statusOptional | query | string | Filter by status. |
storeIdOptional | query | string | Only this store.Pattern ^(?:QD-STR-[A-F0-9]{24}|QDSTR[A-Z0-9]{3,31})$ |
searchOptional | query | string | Return ID, tracking number, order reference or external order ID. |
limitOptional | query | integer | Page size.1 to 100Default 25 |
cursorOptional | query | string | Opaque cursor from nextCursor. |
Response
| Status | Meaning |
|---|---|
200 | A page of returns |
The body is { "status": "success", "data": … }. Fields of data (ReturnList):
| Field | Type | Description |
|---|---|---|
returnsRequired | array of Return | |
nextCursorRequired | string or null |
Errors
Errors use the error envelope { "status": "error", "message", "code"?, "details"? }.
| Status | When |
|---|---|
400 | The request is not valid. A field is missing or invalid, or the Idempotency-Key header is missing or malformed. |
401 | Missing, invalid, expired or revoked API key. The API key is missing, invalid, expired or revoked. |
403 | The 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). |
429 | Too many requests. See the RateLimit headers. Too many requests. Wait for Retry-After, then retry with the same idempotency key. |