Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
The unique RMA ID. This ID is automatically generated when you register a pending return for a vendor using the POST /v1/retailers/{retailer_id}/rmas/
endpoint.
The unique retailer ID. In the Dropship UI this is called the Merchant ID. To find your Merchant ID, click your merchant name in the top nav.
Body
Order ID
1000
ID associated with return reason
344
RMA number
32
"ABC123"
RMA status. Default is Pending.
pending
, approved
, rejected
"Pending"
User that initiated RMA
retailer
, brand
"Retailer"
Time of RMA creation (UTC format)
"2022-09-10T15:24:56Z"
Time of RMA approval (UTC format)
"2022-09-10T15:24:56Z"
Time of RMA rejection(UTC format)
null
Time of RMA acknowledgment (UTC format)
"2022-09-10T15:24:56Z"
Response
Ok
Order ID
1000
ID associated with return reason
344
RMA ID. This ID is required in subsequent endpoints related to RMA.
4
Purchase order number
1
"CS192168"
RMA number
32
"ABC123"
RMA status. Default is Pending.
pending
, approved
, rejected
"Pending"
User that initiated RMA
retailer
, brand
"Retailer"
Time of RMA creation (UTC format)
"2022-09-10T15:24:56Z"
Time of RMA approval (UTC format)
"2022-09-10T15:24:56Z"
Time of RMA rejection(UTC format)
null
Time of order finalization (UTC format)
"2022-09-10T15:24:56Z"
Time of RMA acknowledgment (UTC format)
"2022-09-10T15:24:56Z"
Reason for return
1
"Incorrect"
Total amount
"34.00"