POST - Ship a return
Ships a return and executes routine actions such as sending email
postShip a return
post
https://api.richcommerce.co/2020-05-25/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"}
https://api.richcommerce.co/2020-05-25/returns/RMA-3249292502002/ship
Actions taken for this endpoint if enabled in the merchant dashboard:
Associated Email is sent out if enabled (Dashboard: E-Mail Settings / Your customers)
Last updated 4 months ago