List Vendor Returns
GET/api/vendor-returns
Paginated list of vendor returns, sorted by return date (newest first) by default. Archived returns are excluded unless filter[archived] is provided.
Authentication: Requires Bearer token.
Filters:
- filter[search]: matches return ID (exact), return number, vendor RMA number, supplier name, item SKU, and purchase order number
- filter[return_status]: draft, authorized, shipped, completed, void
- filter[supplier_id], filter[warehouse_id]: exact ID match
- filter[purchase_order_id]: returns containing lines from that purchase order
- filter[return_date.from] / filter[return_date.to]: date range (YYYY-MM-DD, inclusive)
- filter[archived]: 'only' = archived only, 'all' = both; omitted = active only
Allowed sorts: id, vendor_return_number, supplier_rma_number, return_date, return_status, created_at, updated_at, supplier_name. Prefix with - for descending; default is -return_date.
Pagination: page and per_page (default 10).
Request
Responses
- 200
- 401
- 403
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.