This method allows to take informations about the status of an order return requests by passing the unique identification of the order

Use

Method Url
GET /restful/ghost/returnedgoods/serverkey/{order_id}

Request Headers

This method works using JSON or XML format, set the following headers to choose the format you want to use:

Key Value
Accept application/xml or application/json
Content-type application/xml or application/json

Authentication

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

Path Parameter

Response Body

The Response Body contains the follow parameters:

Example XML Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<returnedGoodRequest orderId="10550081">
    <returnedGoodRequestItem requestExtRef="1234" pdfLink="https://<supplierWebsite>/restful/returnedgoods/print/rfvbbbvgyar9.pdf" returnCode="rfvbbbvgyar9" refundStatus="0" status="2" notes="" quantity="1" stockModelId="224002"/>
    <returnedGoodRequestItem requestExtRef="1235" pdfLink="https://<supplierWebsite>/restful/returnedgoods/print/rfvxjndvdtqr.pdf" returnCode="rfvxjndvdtqr" refundStatus="0" status="2" notes="" quantity="1" stockModelId="224001"/>
    <returnedGoodRequestItem requestExtRef="1236" pdfLink="https://<supplierWebsite>/restful/returnedgoods/print/rd4tdtbxrkdh.pdf" returnCode="rd4tdtbxrkdh" refundStatus="0" status="3" notes="" quantity="1" stockModelId="316363"/>
    <returnedGoodRequestItem requestExtRef="1237" pdfLink="https://<supplierWebsite>/restful/returnedgoods/print/rd4tdtbxrkdh.pdf" returnCode="rd4tdtbxrkdh" refundStatus="0" status="5" notes="" quantity="1" stockModelId="315840"/>
    <returnedGoodRequestItem requestExtRef="1238" pdfLink="https://<supplierWebsite>/restful/returnedgoods/print/rd4tdtbxrkdh.pdf" returnCode="rd4tdtbxrkdh" refundStatus="0" status="4" notes="" quantity="1" stockModelId="312408"/>
</returnedGoodRequest>

Example JSON Response

{
    "returnedGoodRequestItems": [
        {
            "refundStatus": 0,
            "pdfLink": "https://<supplierWebsite>/restful/returnedgoods/print/rfvbbbvgyar9.pdf",
            "requestExtRef": "1234",
            "returnCode": "rfvbbbvgyar9",
            "stockModelId": 224002,
            "notes": "",
            "quantity": 1,
            "status": 2
        },
        {
            "refundStatus": 0,
            "pdfLink": "https://<supplierWebsite>/restful/returnedgoods/print/rfvxjndvdtqr.pdf",
            "requestExtRef": "1235",
            "returnCode": "rfvxjndvdtqr",
            "stockModelId": 224001,
            "notes": "",
            "quantity": 1,
            "status": 2
        },
        {
            "refundStatus": 0,
            "pdfLink": "https://<supplierWebsite>/restful/returnedgoods/print/rd4tdtbxrkdh.pdf",
            "requestExtRef": "1236",
            "returnCode": "rd4tdtbxrkdh",
            "stockModelId": 316363,
            "notes": "",
            "quantity": 1,
            "status": 3
        },
        {
            "refundStatus": 0,
            "pdfLink": "https://<supplierWebsite>/restful/returnedgoods/print/rd4tdtbxrkdh.pdf",
            "requestExtRef": "1237",
            "returnCode": "rd4tdtbxrkdh",
            "stockModelId": 315840,
            "notes": "",
            "quantity": 1,
            "status": 5
        },
        {
            "refundStatus": 0,
            "pdfLink": "https://<supplierWebsite>/restful/returnedgoods/print/rd4tdtbxrkdh.pdf",
            "requestExtRef": "1238",
            "returnCode": "rd4tdtbxrkdh",
            "stockModelId": 312408,
            "notes": "",
            "quantity": 1,
            "status": 4
        }
    ],
    "orderId": 10550081
}

Refund Status

Code Value Description
0 NOT_REFUNDED Not refunded
1 REFUNDED Refunded

Request Status

Code Value Description
0 PENDING Request sent, waiting for approval
1 AUTHORIZED_C Request authorized, shipping changed to customer
2 AUTHORIZED Request authorized, shipping payed by supplier
3 RECEIVED_OK Return received in good condition
4 RECEIVED_NOK Return received in poor condition
5 NOT_RECEIVED Return not received
7 REFUSED Return not authorized
9 COMPLETED Return processing completed