API Reference
API Reference
Main Website
Help-Docs
Introduction
Authentication
Errors
Pagination
Versioning
Rate limits
Changelog
Returns
GET - List all returns
GET - Retrieve a return
POST - Approve a return
POST - Ship a return
POST - Receive a return
POST - Resolve a return
POST - Reject a return
PUT - Update a return
API Support
Technical Support
Powered by GitBook

POST - Ship a return

Ships a return and executes routine actions such as sending email

post
Ship a return

https://api.richcommerce.co/v1/returns/:id/:action
Puts a return into the "Shipped" 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: ship
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/v1/returns/RMA-3249292502002/ship

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)

Returns - Previous
POST - Approve a return
Next - Returns
POST - Receive a return
Last updated 4 months ago
Contents
post
Ship a return
Example
Actions