Update Return Status

post
/returns/{id}/status-transitions

You can receive the status of a particular return via Returns Center Webhooks. Furthermore, you can transit the return status via an API call. While calling this endpoint, you should fill the from_status with the value recorded in the latest webhook update.

Currently, we support these use cases:

Mark as received: to_status should be "received"

Mark as resolved: to_status should be "done"

Approve the return: to_status should be "approved"

  • In this case, if the return method is "Ship with a returns label", you have to provide return.retailer_label_url in the payload. And never provide the key retailer_label_url in other cases, otherwise, the request will fail.

Reject the return: to_status should be "rejected".

  • In this case, you have to provide return.reject_reason in the payload. And never provide the key reject_reason in other cases, otherwise, the request will fail.

Resolve the return: to_status should be "done"

Please check all the enum possibilities according to the doc below.

id
string
required

return id

(one of)
from_status
string
required
Allowed values:
submittedapprovedshippedreceived
to_status
string
required
Allowed values:
receiveddone
Parameters
:
Body
preparing...