Esnad Express International | Shipping Information Table of Contents How does it Work? ................................................................................................................................ 3 Security ................................................................................................................................................. 3 1. Upload Shipments.......................................................................................................................... 4 2. Track Shipments ............................................................................................................................ 8 APPENDIX: ESNAD and General References ....................................................................................... 11 NOTE: DOCUMENT INDEX SHOULD BE MODIFIED AS PER YOUR DOCUMENT HEADINGS AND THIS INDEX IS GIVEN AS FORMAT AND SAME SHOULD BE FOLLOWED FOR ESNAD API DOC AS WELL. URLs SHOULD BE CREATED AND ACCORDINGLY WE CAN UPDATE ON API DOC AS WELL ONCE ALL URL ARE WORKING FINE. Esnad Express International | Shipping Information How does it Work? The Esnad Services API provides these features: Upload Shipments & Track Shipments Simple and easy to use Upload Shipments, is easily generated by providing very basic and simple information about the shipper, consignee and shipments 1. Upload Shipments Allows you to create shipments, providing a wide range of options for customers to provide full details about their shipments. 2. Track Shipments Allows you to track shipment whole life cycle information details. Security Each submitted request should contain a valid account Token. This is used to authenticate and verify the identity of the client. During the process of shipment, the submitted information such as addresses, payment methods and more, goes through a detailed validation procedure to insure the validity and correctness. In case of errors, detailed descriptive error messages are provided in the generated response. The API access token is generated by Esnad IT group, pls add it in HTTP Headers: Esnad Express International | Shipping Information 1. Upload Shipments 1.1 Request URL: Staging: http://testapi.esnad.com.cn/orderInfo/uploadOrderInfo Production: http://api.esnad.com.cn/orderInfo/uploadOrderInfo 1.2 HTTP Method: Method: POST Content-Type: application/json token: [Get from Esnad IT] Esnad Express International | Shipping Information 1.3 Request Body Json Sample: Red is Mandatory 1. [{ 2. "esnadAwbNo": "1008000000021", //esnad give AWB number zone to client,such as 10010 00000000 to 1001999999999 3. "clientOrderNo": "test860096766679", //client’s order number 4. "pieceId": "A00001|A00002", //client’s package number, use ** | ** split different package number if one order has more than one package 5. "orderType": "INT", //International client use INT, Domestic client use DOM, B2B client use TOB 6. "deliveryService": "EXP", //normal order use EXP, urgent order use UGT 7. "consignor": "zhang san", //consignor name 8. "pickupAddress": "Room601 Bldg Gongyuan Plaza DengLiang Road", //consignor address 9. "pickupPincode": "518000", //consignor zip 10. "pickupContact": "+86-0755-82597607", //consignor contact 11. "originCity": "Shenzhen", //consignor city 12. "originCountry": "CN", // consignor country 13. "consignee": "Li Si", //consignee name 14. "deliveryAddress": "2319 Muqbal Adh Dhakir Riyadh 12467 ", // consignee address 15. "deliveryLandmark": "Kindom Tower", // consignee address landmark 16. "deliveryPincode": "11564", // consignee zip 17. "deliveryContact": "+933-500774188", // consignee contact 18. "deliveryContact2": "+933-500773333", // backup contact 19. "deliveryTime": "13:00-18:00 GMT+3", // delivery time 20. "deliveryLongitude": "25.0445575", // consignee longitude 21. "deliveryLatitude": "55.1418511", // consignee latitude 22. "destCity": "Riyadh", // consignee city 23. "destRegion": "Esatern Province", // consignee province 24. "destCountry": "SA", // consignee country 25. "returnName": "", //return name 26. "returnAddress": "", //return address 27. "returnPincode": "", // return zip 28. "returnContact": "", // return contact 29. "returnCity": "", // return city 30. "returnCountry": "", // return country 31. "productDescription": "Toys Cloths", //product category, for customs clearance 32. "paymentMode": "COD", // **cash on delivery use COD , prepaid use PPD** 33. "amountToCollect": "104.55", //order total price **Currency is SAR** 34. "pcs": "3", //product pieces 35. "declaredValue": "20", //customs declared value **Currency is Doller** 36. "length": "", //package length **unit is cm ** 37. "breadth": "", // package breadth ** unit is cm ** 38. "height": "", // package height ** unit is cm ** 39. "volWeight": "3", // package volumn weight ** unit is kg ** 40. "packageWeight": "3", //package real weight ** unit is kg ** 41. "invoiceNumber": "85120366570", //invoice number 42. "invoicePdf": "http://invoice.xxxxx.com/download?uuid=123", //invoice pdf or html link, esnad print it for customs random check 43. "memo": "LP00134943276177", //remarks ** will print on the bottom of esnad AWB, for client private tracking info ** 44. "productDetails": [{ //product details 45. "productLink": "http://www.xxxxxx.com/item/32855004219.html", //product link ** for prohibited products auto detection** 46. "productPrice": "100.00", //product price 47. "productPcs": "3", //product pieces 48. "productHscode": "21069010.00", //costoms HScode 49. "productName": "2019 Summer Chiffon Women Blouses Vintage Floral Print Blouse S exy V Neck Sleeveless Tunic Casual Loose Ladies Tops" //product’s full name 50. }, { Esnad Express International | Shipping Information 51. "productLink": "", 52. "productPrice": "", 53. "productPcs": "", 54. "productHscode": "", 55. "productName": "" 56. }] 57. }] Esnad Express International | Shipping Information 1.4 Response Message There are 3 response code: 1000 – upload success 2000 – upload failed because of invalid value check 3000 – upload failed because of duplicate order number Upload success response – 1000 1. { 2. "data": [ 3. { 4. "clientOrderNo": "98765432472", 5. "esnadAwbNo": "1000000000150", 6. "esnadAwbPdfLink": "http://testawb.esnad.com.cn/20191118/1000000000150.pdf" , 7. "esnadAwbHTMLLink": "http://testapi.esnad.com.cn/pdf/getOrderDocHtml/100000 0000150" 8. } 9. ], 10. "code": "1000", 11. "msg": "SUCCESS" 12. } Upload failed response – 2000 1. { 2. "data": "", 3. "code": "2000", 4. "msg": "consignor can't be null!" 5. } This case is consignor is null Upload failed response – 3000 1. { 2. "data": [ 3. { 4. "esnadAwbNo": "1000000000151", // request esnad awb number 5. "clientOrderNo": "98765432472", // request client order number 6. "orignEsnadAwbNo": "1000000000150", // esnad awb number saved in db 7. "orignClientOrderNo": "98765432472", // client order number saved in db 8. "esnadAwbPdfLink": "http://testawb.esnad.com.cn/20191118/1000000000150.pdf" , 9. "esnadAwbHTMLLink": "http://testapi.esnad.com.cn/pdf/getOrderDocHtml/100000 0000150", 10. "consignee": "wang wu", 11. "deliveryContact": "+966-500774188" 12. } 13. ], 14. "code": "3000", Esnad Express International | Shipping Information 15. "msg": "the order have exist!" 16. } 2. Track Shipments 2.1 Request URL: Staging: http://testapi.esnad.com.cn/orderTracking/esnadTrackingOrderInfo Production: http://tracking.esnad.com.cn/orderTracking/esnadTrackingOrderInfo 2.2 HTTP Method: Method: POST Content-Type: application/json token: [Get from Esnad IT] 2.3 Request Body Json Sample: 1. { 2. "esnadAwbNo": "1000000000000" 3. } Esnad Express International | Shipping Information 2.4 Response Message 1. { 2. "data": { 3. "paymentMode": "COD", 4. "esnadAwbNo": "4000000001335", 5. "consigneeInfo": { 6. "id": 60286, 7. "consignee": "FEDAA ALJAAFAR", 8. "deliveryAddress": "KSA, EASTERN REGION, SAFWA, JABER BIN HAYAN STREET SAFW A", 9. "deliveryPincode": "", 10. "deliveryContact": "00966558165888", 11. "orderId": 60299 12. }, 13. "consignorInfo": { 14. "id": 60417, 15. "consignor": "YNAP MIDDLE EAST GENERAL TRADING(BR", 16. "pickupAddress": "LIU E08 , DUBAI AIRPORT FREEZONE DUBAI - VAT NO. 10025217 3800003 DAFZ, PO BOX 49042", 17. "pickupPincode": "", 18. "pickupContact": "8008449250", 19. "orderId": 60299 20. }, 21. "signatureUrls": "", 22. "trackingInfoList": [ 23. { 24. "status": "999", 25. "description": "delivered", 26. "updatedTime": "2019-11-18 19:10:54", 27. "location": null, 28. "remarks": "TASK_COMPLETED_SUCCESSFULLY" 29. }, 30. { 31. "status": "600", 32. "description": "out for delivery", 33. "updatedTime": "2019-11-18 17:06:27", 34. "location": null, 35. "remarks": "TASK_ASSIGNED" 36. }, 37. { 38. "status": "300", 39. "description": "assign to last mile team", 40. "updatedTime": "2019-11-18 03:00:28", 41. "location": "", 42. "remarks": null 43. } 44. ], 45. "collectAmount": "100.00" 46. }, 47. "code": "1000", 48. "msg": "SUCCESS" 49. } Esnad Express International | Shipping Information 2.5 Track Status List Code Status Remarks 100 Data received 客户创建订单完成 200 Shipment pickuped from shipper 收货完成 -201 Shipment pickuped failed 收货失败 210 Departed from the origin 发货目的国 400 Customs clearance completed 清关完成 -401 Held at customs authorities 清关失败 -402 Customs clearance delay 清关延迟 500 Arrived at sorting hub facility 入库扫描 510 Sorting at hub facility 分拣打包 520 Departed from sorting hub facility 出库扫描 530 Arrived at delivery center 地派团队收货 540 Shipment in transit 货物运输流转 600 Shipment out for delivery 外出派送 610 Undelivery - Hold at delivery center 派送失败后返回仓库 700 RTH - Return to hub 退件到退货中心 710 Arrived