PUT
/
v1
/
retailers
/
{retailer_pk}
/
rmas
/
{id}
/
acknowledge
/

Authorizations

Authorization
string
headerrequired

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

Path Parameters

id
number
required

RMA ID

retailer_pk
number
required

Retailer ID

Body

application/json
order_id
integer
required

Order ID

reason_id
integer
required

ID associated with return reason

rma_number
string | null

RMA number

Maximum length: 32
status
enum<string> | null

RMA status. Default is Pending.

Available options:
pending,
approved,
rejected
currency
object
created_by
enum<string> | null

User that initiated RMA

Available options:
retailer,
brand
rmad_at
string | null

Time of RMA creation (UTC format)

approved_at
string | null

Time of RMA approval (UTC format)

rejected_at
string | null

Time of RMA rejection(UTC format)

acknowledged_at
string | null

Time of RMA acknowledgement (UTC format)

retailer
object
brand
object

Response

200 - application/json
order_id
integer
required

Order ID

reason_id
integer
required

ID associated with return reason

id
integer

RMA ID. This ID is required in subsequent endpoints related to RMA.

purchase_order_number
string

Purchase order number

Minimum length: 1
rma_number
string | null

RMA number

Maximum length: 32
status
enum<string> | null

RMA status. Default is Pending.

Available options:
pending,
approved,
rejected
currency
object
created_by
enum<string> | null

User that initiated RMA

Available options:
retailer,
brand
rmad_at
string | null

Time of RMA creation (UTC format)

approved_at
string | null

Time of RMA approval (UTC format)

rejected_at
string | null

Time of RMA rejection(UTC format)

ordered_at
string

Time of order finalization (UTC format)

acknowledged_at
string | null

Time of RMA acknowledgement (UTC format)

rma_lines
object[]
reason
string

Reason for return

Minimum length: 1
memos
object[]
attachments
object[]
retailer
object
brand
object
total_amount
string

Total amount

credits
object[]

Was this page helpful?

Get details of a return.Create a new order (for a single vendor)