Fetch Shipment Data
This service allows for monitoring shipments with the polling technique.
Note
Take care when polling, please do not do it too often in order not to overload our servers. Should such a scenario happen, we would have to temporarily block your client application. Polling every 10-30 seconds is acceptable.
Request
Orders | ||
---|---|---|
URI |
/shipments/S2AS000001/ |
|
Method | GET | |
Authorization |
required |
Example
Response
{
"message": "OK", "code": 200, "result": { "order": { "status": "PEN", "delivery": { "phone": "123123123", "first_name": "Foo", "last_name": "Bar", "postcode": "20001", "city": "Washington", "country": "US", "company": "baz", "address_lines": [ "address line 1", "address line 2", "address line 3" ], "email": "foo.bar@baz.com" }, "tracking_number": "AUS2A000002002934", "collection_type": "pickup", "description": "Additional comment.", "service": { "price": { "currency": "AUD", "amount": 45.09, "total": 45.09, "insurance": 0, "gst": 0 }, "code": "7001", "name": "GlobalMail" }, "customs_information": { "tax_status": "Company", "reason": "Purchase", "description": "Brief description of goods here", "items": [ { "currency": "AUD", "madein": "AU", "description": "shoes", "value": 20, "quantity": 1 } ] }, "packages": [ { "width": 15, "length": 20, "unit_weight": "CM", "weight": 3, "height": 10 } ], "id": "S2AS002934", "collection": { "phone": "61393282237", "first_name": "Receiving", "last_name": "na", "postcode": "2018", "city": "Rosebery", "country": "AU", "company": "DHL Global Mail", "address_lines": [ "PO Box 91980, Victoria St West", "", "" ], "pickup": { "date": "2014-04-20T00:00:00", "time_latest": "14:00", "time_earliest": "09:00" }, "email": "contact@ship2anywhere.com" } } } } |