Jump to Content

List RMA orders

get

https://api.mrpeasy.com/rest/v1/rma

Recent Requests

Log in to see full request history

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

rma_ord_id

integer

Database ID of the RMA order.

code

string

A unique number to identify the RMA order.

customer_id

integer

Database ID of the customer.

customer_code

string

A unique number to identify the customer.

customer_name

string

A name of the customer.

status

array of objects

Status of RMA order.

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 - Canceled

Arrays are supported, for example ?status[]=10&status[]=20.

status

user_id

integer

Database ID of the user responsible for the customer.

reference

string

Reference of the RMA order.

article_id

integer

deprecated

Legacy filter mirrored from the first return item. Prefer using return_items in responses.

item_code

string

deprecated

Legacy filter mirrored from the first return item. Prefer using return_items in responses.

item_title

string

deprecated

Legacy filter mirrored from the first return item. Prefer using return_items in responses.

group_id

integer

deprecated

Legacy filter mirrored from the first return item. Prefer using return_items in responses.

group_code

string

deprecated

Legacy filter mirrored from the first return item. Prefer using return_items in responses.

group_title

string

deprecated

Legacy filter mirrored from the first return item. Prefer using return_items in responses.

site_id

integer

ID of site where this RMA order is created.

rma_type

array of objects

deprecated

Legacy filter mirrored from the first return item. Prefer using return_items in responses.
Type of RMA order.

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

rma_type

created_min

integer

Minimum creation timestamp (Unix timestamp).

created_max

integer

Maximum creation timestamp (Unix timestamp).

Headers

Range

string

Pagination range (e.g., items=0-99, items=200-249)

Responses

429

Rate limited - another request is running

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json