PUT
/
return_orders
/
{return_order_id}

Authorizations

Authorization
string
headerrequired

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

Path Parameters

return_order_id
integer
required

Numeric ID of the return to retrieve.

Body

application/json
status
enum<string>
Available options:
requested,
expected,
received,
in_progress,
completed,
cancelled

Response

200 - application/json
id
integer
required

Numeric ID of the return.

createdAt
string
required
creditStatus
enum<string>
required
Available options:
uncredited,
partially_recredited,
recredited
customer
object
required
returnLines
object[]
required
sequentialId
integer
required

Sequential ID of the return.

status
enum<string>
required

Status of the return.

Available options:
requested,
expected,
received,
in_progress,
completed,
cancelled
requestedAt
string | null