POST - Receive a return

Receives a return and executes routine actions such as sending email

post
Receive a return

https://api.richcommerce.co/2020-05-25/returns/:id/:action
Puts a return into the "Received" status and executes routine actions such as sending email.
Request
Response
Request
Path Parameters
id
optional
string
rma number of the return object
action
optional
string
allowed value: receive
Headers
Authorization
required
string
Authentication token in the format of "RichReturnsToken xxxxx-xxxxx-xxxxx-xxxxx-xxxxx"
Response
200: OK
Action successfully executed.
{
"status": "success"
}

Example

https://api.richcommerce.co/2020-05-25/returns/RMA-3249292502002/receive

Actions

Actions taken for this endpoint if enabled in the merchant dashboard:

  • Associated Email is sent out if enabled (Dashboard: E-Mail Settings / Your customers)