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

PUT - Update a return

Updates selected attributes of a return

put
Update a return

https://api.richcommerce.co/v1/returns/:id
Update selected attributes of a return.
Request
Response
Request
Path Parameters
id
optional
string
rma number of the return object
Headers
Authorization
required
string
Authentication token in the format of "RichReturnsToken xxxxx-xxxxx-xxxxx-xxxxx-xxxxx"
Body Parameters
staffNotes
optional
string
Notes visible only internally to staff.
customShippingLabelUrl
optional
string
First Manual Label or File URL. Must start with https://
customShippingLabelSecondUrl
optional
string
Second Manual Label or File URL. Must start with https://
Response
200: OK
Action successfully executed.
​

Example

https://api.richcommerce.co/v1/returns/RMA-3249292502002
Returns - Previous
POST - Reject a return
Next - API Support
Technical Support
Last updated 4 months ago
Contents
put
Update a return
Example