This method allows to create a return good request with the desired products.

It creates a new return request in Pending status.


Method Url
POST /restful/ghost/returnedgoods/request/new


Remember to authenticate properly, using HTTP Basic Authentication with your API-Key as username and your password.

Request Body

The request body contains the orderId of the order and a list of desired products that will return. Each product has four attributes:

Reason Code

reasonCode Reason
0 Other
1 Purchased by mistake
2 Damaged item
3 Wrong item
4 Defective
5 Unordered
6 Not my size
7 Don't like product
8 Missing

Not all reason code listed above are available for all suppliers. Please contact your supplier to find the list of reason codes available.


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<returnedGoodRequest orderId="912120">
    <returnedGoodRequestItem stockModelId="182179" quantity="1" reasonCode="2" notes="the item was damaged"/>
    <returnedGoodRequestItem stockModelId="182180" quantity="1" reasonCode="3" notes=""/>
    <returnedGoodRequestItem stockModelId="182180" quantity="2" reasonCode="1" notes=""/>

Response Body

The response body contains the status of the request.


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response message="" code="0" status="true"/>