List RMA orders

List RMA orders with their returned and outbound items, optionally filtered by available attributes. Archived and cancelled RMA orders are left out unless the request filters by rma_order_id or by status. The returned item filters match an order when one of its returned items meets all of them; the order is returned with all its items.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer | null

Database ID of the RMA order. Archived and cancelled RMA orders are returned when this filter is given.

string | null

A unique number to identify the RMA order. Partial match.

integer | null

Database ID of the customer.

string | null

A unique number to identify the customer. Partial match.

string | null

A name of the customer. Partial match.

enum

Status of RMA order. One value or a list, for example ?status=10 or ?status[]=10&status[]=20. Archived and cancelled RMA orders are returned when this filter is given.


  • 10 - New
  • 20 - Waiting for inspection
  • 40 - Waiting for action
  • 50 - In progress
  • 60 - Ready for shipment
  • 70 - Shipped
  • 75 - Resolved
  • 80 - Delivered
  • 110 - Archived
  • 120 - Cancelled
integer | null

Database ID of the user who added the RMA order.

string | null

Reference of the RMA order. Partial match.

integer | null

ID of site where this RMA order is created.

integer | null

ID of the article of a returned item.

string | null

A unique number to identify the stock item of a returned item. Partial match.

string | null

Name of the stock item of a returned item. Partial match.

integer | null

ID of the product group of a returned item.

string | null

A unique number to identify the product group of a returned item. Partial match.

string | null

Name of the product group of a returned item. Partial match.

enum

Type of RMA order of a returned item. One value or a list, for example ?rma_type=10 or ?rma_type[]=10&rma_type[]=20.


  • 1 - Not specified
  • 10 - Repair
  • 20 - Repair and ship back
  • 30 - Replacement
  • 40 - Receipt and credit
  • 50 - Receipt and no credit
  • 60 - Reject and ship back
  • 70 - Credit only
integer | null

Minimum creation date and time as UNIX timestamp.

integer | null

Maximum creation date and time as UNIX timestamp. The whole of that day is covered.

custom_values
array of objects | null

Conditions on custom fields of the RMA order or of its customer. All of them must hold. Example for a text field: ?custom_values[0][field_id]=1&custom_values[0][value]=abc. Replace 1 with your custom field ID; use indices 0, 1, etc. for separate conditions.

custom_values
integer

Maximum number of records to return (1–1000).

integer

Number of records to skip for pagination.

Responses

401

Unauthorized

413

Content Too Large - please use smaller ´limit´

429

Too many requests

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json