This method allows to take informations about the status of an order by passing the identification that user gives to his order

Use

Method	Url
GET	/restful/ghost/clientorders/clientkey/{key}

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

Path Parameters

• key : the number that the user assigned to his order

Response Body

The Response Body contains the follow parameters:

• ext_ref : (legacy parameter, not required)
• last_update : date of the last modification (format:yyyy/MM/dd HH:mm:ss Z)
• order_id : the number that identificates the user's order
• parsedDate : (legacy parameter, not required)
• status : a status number
• tracking_url : url to track shipment

Example XML Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<root>
    <order_list>
        <order>
            <ext_ref>56</ext_ref>
            <last_update>2018/05/25 12:20:37 +0200</last_update>
            <order_id>123456</order_id>
            <parsedDate>2018-05-25T12:20:37+02:00</parsedDate>
            <status>3002</status>
            <tracking_url>http://www.dhl.com/content/g0/en/express/tracking.shtml?AWB=0123456789012&brand=DHL</tracking_url>
        </order>
    </order_list>
</root>

Example JSON Response

{
"orders": [
    {
        "tracking_code": null,
        "tracking_url": null,
        "carrier_name": null,
        "parsedDate": 1612363015000,
        "substatus": null,
        "order_id": 130,
        "last_update": "2021/02/03 14:36:55 +0000",
        "ext_ref": "2357",
        "status": 5
    }
]

}

Order Status

Code	Value	Description
0	PENDING	User is managing the cart
1	MONEY WAITING	Awaiting for payment gateway response
2	TO DISPATCH	Ready to be dispatched
3	DISPATCHED	Shipment has been picked up by carrier
5	BOOKED	Order created by API Send Order or booked by bank transfer
2000	CANCELLED	Order cancelled
2002	VERIFY FAILED	Payment was not accepted by payment gateway
3001	WORKING ON	Logistics office is working on the order
3002	READY	Order is ready for pick up
5003	DROPSHIPPER GROWING	Virtual order containing reserved items