POST
/
v1
/
retailers
/
{retailer_pk}
/
rmas

Authorizations

Authorization
string
header
required

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

Path Parameters

retailer_pk
number
required

Body

application/json
order_id
integer
required

Order ID

reason_id
integer
required

ID associated with return reason

acknowledged_at
string | null

Time of RMA acknowledgement (UTC format)

approved_at
string | null

Time of RMA approval (UTC format)

brand
object
created_by
enum<string> | null

User that initiated RMA

Available options:
retailer,
brand
currency
object
rejected_at
string | null

Time of RMA rejection(UTC format)

retailer
object
rma_number
string | null

RMA number

Maximum length: 32
rmad_at
string | null

Time of RMA creation (UTC format)

status
enum<string> | null

RMA status. Default is Pending.

Available options:
pending,
approved,
rejected

Response

201 - application/json
order_id
integer
required

Order ID

reason_id
integer
required

ID associated with return reason

acknowledged_at
string | null

Time of RMA acknowledgement (UTC format)

approved_at
string | null

Time of RMA approval (UTC format)

attachments
object[]
brand
object
created_by
enum<string> | null

User that initiated RMA

Available options:
retailer,
brand
credits
object[]