Get a list of returns

Gets a list of returns. RMAs are issued when merchandise needs to be, or has already been, returned to the vendor. Either party (vendor or retailer) can initiate the return. Once created, the return’s status is set to pending while the vendor awaits the delivery of the items to the return address. Upon receipt, the vendor will inspect the items, and if all is well, close the return.

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

retailer_pk

number

required

Retailer ID

Query Parameters

search

string

Search by RMA status or identifier

status

string

RMA status

purchase_order_number

string

Purchase order number

rma_number

string

RMA number

reason_id

number[]

Reason IDs associated with RMAs. Multiple values may be separated by commas.

reason

string

RMA reason

since

number

From a past date till current time (Unix epoch format)

brand_id

number[]

Vendor ID. Multiple values may be separated by commas.

connection_id

number[]

Connection IDs. Multiple values may be separated by commas.

order_by

string

Sorting criteria

page

integer

Page number within the paginated response

limit

integer

Number of records per page

Response

200 - application/json

count

integer

required

Total number of records

results

object[]

required

Show child attributes

next

string | null

Next page (applicable in a paginated response)

previous

string | null

Previous page (applicable in a paginated response)