1.常用快遞API
支持順豐、EMS、申通、圓通、韻達、匯通、中通、天天、德邦、全峰等主流快遞公司。
文檔地址:https://www.juhe.cn/docs/api/id/43
1.1常用快遞查詢API
接口地址:
http://v.juhe.cn/exp/index
支持格式:
json/xml
請求方式:
http post/get
請求示例:
http://v.juhe.cn/exp/index?key=key&com=sf&no=575677355677
調用樣例及調試工具:
API測試工具
請求參數說明:
| 名稱 | 類型 | 必填 | 說明 | |
|---|---|---|---|---|
| com | string | 是 | 需要查詢的快遞公司編號 | |
| no | string | 是 | 需要查詢的訂單號 | |
| key | string | 是 | 應用APPKEY(應用詳細頁查詢) | |
| dtype | string | 否 | 返回數據的格式,xml或json,默認json |
返回參數說明:
| 名稱 | 類型 | 說明 | |
|---|---|---|---|
| 參考JSON返回示例 | - | - |
JSON返回示例:
{
"resultcode":"200",/*返回標識碼*/
"reason":"查詢成功!",
"result":{
"company":"順豐",
"com":"sf",
"no":"575677355677",
"list":[
{
"datetime":"2013-06-25 10:44:05", /*時間*/
"remark":"已收件", /*描述*/
"zone":"台州市" /*區域,視快遞公司情況,不保證一定有信息*/
},
{
"datetime":"2013-06-25 11:05:21",
"remark":"快件在 台州 ,准備送往下一站 台州集散中心 ",
"zone":"台州市"
},
{
"datetime":"2013-06-25 20:36:02",
"remark":"快件在 台州集散中心 ,准備送往下一站 台州集散中心 ",
"zone":"台州市"
},
{
"datetime":"2013-06-25 21:17:36",
"remark":"快件在 台州集散中心 ,准備送往下一站 杭州集散中心 ",
"zone":"台州市"
},
{
"datetime":"2013-06-26 12:20:00",
"remark":"快件在 杭州集散中心 ,准備送往下一站 西安集散中心 ",
"zone":"杭州市"
},
{
"datetime":"2013-06-27 05:48:42",
"remark":"快件在 西安集散中心 ,准備送往下一站 西安 ",
"zone":"西安市/咸陽市"
},
{
"datetime":"2013-06-27 08:03:03",
"remark":"正在派件..",
"zone":"西安市/咸陽市"
},
{
"datetime":"2013-06-27 08:51:33",
"remark":"派件已簽收",
"zone":"西安市/咸陽市"
},
{
"datetime":"2013-06-27 08:51",
"remark":"簽收人是:已簽收 ",
"zone":"西安市/咸陽市"
}
]
"status": "1", /*0或1。0表示此單號信息還有更新的可能;1表示此單號信息不會再更新
(簽收、退回等最終狀態),您可將單號信息存入數據庫,不必再次往聚合發送更新請求。*/
}
}
XML返回示例:
<root> <resultcode>200</resultcode> <reason>查詢成功!</reason> <result> <company>順豐</company> <com>sf</com> <no>575677355677</no> <list> <item> <datetime>2013-06-25 10:44:05</datetime> <remark>已收件</remark> <zone>台州市</zone> </item> <item> <datetime>2013-06-25 11:05:21</datetime> <remark>快件在 台州 ,准備送往下一站 台州集散中心</remark> <zone>台州市</zone> </item> <item> <datetime>2013-06-25 20:36:02</datetime> <remark>快件在 台州集散中心 ,准備送往下一站 台州集散中心</remark> <zone>台州市</zone> </item> <item> <datetime>2013-06-25 21:17:36</datetime> <remark>快件在 台州集散中心 ,准備送往下一站 杭州集散中心</remark> <zone>台州市</zone> </item> <item> <datetime>2013-06-26 12:20:00</datetime> <remark>快件在 杭州集散中心 ,准備送往下一站 西安集散中心</remark> <zone>杭州市</zone> </item> <item> <datetime>2013-06-27 05:48:42</datetime> <remark>快件在 西安集散中心 ,准備送往下一站 西安</remark> <zone>西安市/咸陽市</zone> </item> <item> <datetime>2013-06-27 08:03:03</datetime> <remark>正在派件..</remark> <zone>西安市/咸陽市</zone> </item> <item> <datetime>2013-06-27 08:51:33</datetime> <remark>派件已簽收</remark> <zone>西安市/咸陽市</zone> </item> <item> <datetime>2013-06-27 08:51</datetime> <remark>簽收人是:已簽收</remark> <zone>西安市/咸陽市</zone> </item> </list> <status>1</status> </result> </root>
1.2快遞公司編號對照表
接口地址:
http://v.juhe.cn/exp/com
支持格式:
json/xml/jsonp
請求方式:
http post get
請求示例:
http://v.juhe.cn/exp/com?key=key
調用樣例及調試工具:
API測試工具
請求參數說明:
| 名稱 | 類型 | 必填 | 說明 | |
|---|---|---|---|---|
返回參數說明:
| 名稱 | 類型 | 說明 | |
|---|---|---|---|
JSON返回示例:
{
"resultcode":"200",
"reason":"成功的返回",
"result":[
{
"com":"順豐",
"no":"sf"
},
{
"com":"申通",
"no":"sto"
},
{
"com":"圓通",
"no":"yt"
},
{
"com":"韻達",
"no":"yd"
},
{
"com":"天天",
"no":"tt"
},
{
"com":"EMS",
"no":"ems"
},
{
"com":"中通",
"no":"zto"
},
{
"com":"匯通",
"no":"ht"
}
]
}
2.快遞在線下單
應用場景:普通用戶在線向快遞公司在線下單,快遞公司收到申請快遞員上門取件
接口文檔:https://www.juhe.cn/docs/api/id/229
2.1獲取快遞公司列表
接口地址:
http://v.juhe.cn/expressonline/test/getCarriers.php
支持格式:
json/xml
請求方式:
http get/post
請求示例:
http://v.juhe.cn/expressonline/test/getCarriers.php?key=APPKEY
接口備注:
獲取支持的快遞公司列表
調用樣例及調試工具:
API測試工具
請求參數說明:
| 名稱 | 類型 | 必填 | 說明 | |
|---|---|---|---|---|
| dtype | string | 否 | 結果數據返回類型(json/xml) | |
| key | string | 是 | 您申請的appkey | |
| ex_category | string | 否 | recommend:推薦快遞公司; |
返回參數說明:
| 名稱 | 類型 | 說明 | |
|---|---|---|---|
| error_code | int | 返回碼 | |
| reason | string | 返回說明 | |
| result | string | 返回結果集 |
JSON返回示例:
{
"reason": "查詢成功",
"result": [
{
"carrier_code": "ems",/*快遞公司代碼*/
"carrier_phone": "11183",/*快遞公司電話*/
"carrier_name": "EMS"/*快遞公司名稱*/
},
{
"carrier_code": "zhongtong",
"carrier_phone": "021-39777777",
"carrier_name": "中通快遞"
},
{
"carrier_code": "yuantong",
"carrier_phone": "021-69777888",
"carrier_name": "圓通速遞"
},
{
"carrier_code": "zjs",
"carrier_phone": "400-6789-000",
"carrier_name": "宅急送"
},
{
"carrier_code": "debang",
"carrier_phone": "400-830-5555",
"carrier_name": "德邦物流"
},
{
"carrier_code": "huitong",
"carrier_phone": "021-62963636",
"carrier_name": "百世匯通"
},
{
"carrier_code": "shunfeng",/*快遞公司編碼*/
"carrier_phone": "400-811-1111",/*快遞公司電話*/
"carrier_name": "順豐速運"/*快遞公司名稱*/
},....
],
"error_code": 0
}
XML返回示例:
<?xml version="1.0" encoding="utf-8"?>
<root>
<reason>查詢成功</reason>
<result>
<item>
<carrier_code>ems</carrier_code>
<carrier_phone>11183</carrier_phone>
<carrier_name>EMS</carrier_name>
</item>
<item>
<carrier_code>zhongtong</carrier_code>
<carrier_phone>021-39777777</carrier_phone>
<carrier_name>中通快遞</carrier_name>
</item>
<item>
<carrier_code>yousu</carrier_code>
<carrier_phone>400-1111-119</carrier_phone>
<carrier_name>優速快遞</carrier_name>
</item>
<item>
<carrier_code>quanfeng</carrier_code>
<carrier_phone>400-100-0001</carrier_phone>
<carrier_name>全峰快遞</carrier_name>
</item>
<item>
<carrier_code>yuantong</carrier_code>
<carrier_phone>021-69777888</carrier_phone>
<carrier_name>圓通速遞</carrier_name>
</item>
<item>
<carrier_code>zjs</carrier_code>
<carrier_phone>400-6789-000</carrier_phone>
<carrier_name>宅急送</carrier_name>
</item>
<item>
<carrier_code>debang</carrier_code>
<carrier_phone>400-830-5555</carrier_phone>
<carrier_name>德邦物流</carrier_name>
</item>
<item>
<carrier_code>huitong</carrier_code>
<carrier_phone>021-62963636</carrier_phone>
<carrier_name>百世匯通</carrier_name>
</item>
<item>
<carrier_code>shunfeng</carrier_code>
<carrier_phone>400-811-1111</carrier_phone>
<carrier_name>順豐速運</carrier_name>
</item>
</result>
<error_code>0</error_code>
</root>
2.2在線下單發快遞
接口地址:
http://v.juhe.cn/expressonline/test/expressSend.php
支持格式:
json/xml
請求方式:
http post
請求示例:
http://v.juhe.cn/expressonline/test/expressSend.php?key=APPKEY&send_method=addOrderInfoMes&order_no=......所有參數(請轉換成post形式提交)
接口備注:
提供兩種模式,(1)普通發快遞:在線向快遞公司在線下單;(2)異步發快遞: 用戶將訂單信息提交到平台
注:開發測試,下單成功后請及時撤銷訂單,否則快遞公司會打電話上門取件
注:開發測試,下單成功后請及時撤銷訂單,否則快遞公司會打電話上門取件
調用樣例及調試工具:
API測試工具
請求參數說明:
| 名稱 | 類型 | 必填 | 說明 | |
|---|---|---|---|---|
| dtype | string | 否 | 結果數據返回類型(json/xml) | |
| key | string | 是 | 您申請的appkey | |
| send_method | string | 是 | 接口方法名稱 (addOrderInfoMes:普通發快遞, (1)普通用戶在線向快遞公司在線下單, (2)快遞公司收到申請快遞員上門取件; addOrderInfoAsy:異步發快遞, (1)用戶將訂單信息提交到開放平台, (2)開放平台通過訂單狀態推送用戶發件結果, (3)快遞公司收到申請快遞員上門取件) |
|
| order_no | string | 是 | 訂單編號10-32位唯一的數字字符串(例:20160129121200956523) | |
| isWaybill | string | 是 | 是否為電子運單( 1 普通訂單(默認為1),暫僅支持普通) | |
| carrier_code | string | 是 | 快遞公司編碼.建議使用宅急送(zjs)進行功能和流程測試 | |
| sender_name | string | 是 | 發件人姓名 | |
| sender_telphone | string | 是 | 發件人手機號碼 | |
| sender_phone | string | 否 | 發件人固定電話 | |
| sender_province_name | string | 是 | 發件地址省名稱 | |
| sender_city_name | string | 是 | 發件地址市名稱 | |
| sender_district_name | string | 是 | 發件地址區名稱 | |
| sender_address | string | 是 | 發件地址詳細信息 | |
| sender_post_code | string | 否 | 發件地址郵政編碼 | |
| receiver_name | string | 是 | 收件人姓名 | |
| receiver_telphone | string | 是 | 收件人手機號碼 | |
| receiver_phone | string | 否 | 收件人固定電話 | |
| receiver_province_name | string | 是 | 收件地址省名稱 | |
| receiver_city_name | string | 是 | 收件地址市名稱 | |
| receiver_district_name | string | 是 | 收件地址區名稱 | |
| receiver_address | string | 是 | 收件地址詳細信息 | |
| receiver_org_name | string | 否 | 收件機構 | |
| receiver_post_code | string | 否 | 收件地址郵政編碼 | |
| remark | string | 否 | 備注 | |
| item_weight | double | 否 | 重量(double,單位kg) | |
| item_name | string | 否 | 貨物名稱 | |
| item_spec | string | 否 | 規格 | |
| send_start_time | string | 否 | 預約開始時間(時間格式為:yyyy-MM-dd HH:mm:ss) | |
| send_end_time | string | 否 | 預約結束時間(時間格式為:yyyy-MM-dd HH:mm:ss) |
返回參數說明:
| 名稱 | 類型 | 說明 | |
|---|---|---|---|
| error_code | int | 返回碼 | |
| reason | string | 返回說明 | |
| result | string | 返回結果集 |
JSON返回示例:
{
"reason": "下單成功",
"result": {
"order_no":"20160129121200956523",/*訂單編號*/
"carrier_code":"zjs"/*快遞公司編號*/
},
"error_code": 0
}
2.3撤銷訂單
接口地址:
http://v.juhe.cn/expressonline/test/cancleSend.php
支持格式:
json/xml
請求方式:
http post
請求示例:
http://v.juhe.cn/expressonline/test/cancleSend.php?key=APPKEY&
接口備注:
用戶下單后,不想發快遞了,可以及時取消;由於快遞公司IT系統原因,暫支持 宅急送、優速、百世匯通、圓通、中通、德邦快遞公司撤銷發件
調用樣例及調試工具:
API測試工具
請求參數說明:
| 名稱 | 類型 | 必填 | 說明 | |
|---|---|---|---|---|
| dtype | string | 否 | 結果數據返回類型(json/xml) | |
| key | string | 是 | 您申請的appkey | |
| order_no | string | 是 | 訂單編號 10-32位唯一的數字字符串 | |
| carrier_code | string | 是 | 快遞公司編碼 |
返回參數說明:
| 名稱 | 類型 | 說明 | |
|---|---|---|---|
| error_code | int | 返回碼 | |
| reason | string | 返回說明 | |
| result | string | 返回結果集 |
JSON返回示例:
{
"reason": "取消成功",
"result": {
"order_no": "20160129121200956523",/*訂單號*/
"carrier_code": "zjs"/*快遞公司編碼 (宅急送)*/
},
"error_code": 0
}
2.4推送接口設置
接口地址:
http://v.juhe.cn/expressonline/setPush.php
支持格式:
json/xml
請求方式:
http post
請求示例:
http://v.juhe.cn/expressonline/setPush.php?key=APPKEY&
接口備注:
用戶設置訂單狀態更新信息推送接口 (測試階段不予以推送狀態更新)
調用樣例及調試工具:
API測試工具
請求參數說明:
| 名稱 | 類型 | 必填 | 說明 | |
|---|---|---|---|---|
| dtype | string | 否 | 結果數據返回類型(json/xml) | |
| key | string | 是 | 您申請的appkey | |
| name | string | 否 | 公司名 | |
| state_method | string | 是 | 訂單狀態更新推送地址 | |
| content_method | string | 是 | 物流信息更新推送地址 |
返回參數說明:
| 名稱 | 類型 | 說明 | |
|---|---|---|---|
| error_code | int | 返回碼 | |
| reason | string | 返回說明 | |
| result | string | 返回結果集 |
JSON返回示例:
{
"reason": "成功的返回",
"result": {
"name": "",/*公司名稱或其他說明文字*/
"state_method": "您接收訂單狀態更新信息推送的接口(例:http://test.com/test.php)",/*訂單狀態更新推送地址*/
"content_method": "您接收訂物流信息更新推送的接口(例:http://test.com/test.php)",/*物流信息更新推送地址*/
"key": APPKEY
},
"error_code": 0
}
/*訂單狀態推送,數據格式以及參數說明.(注:操作完成后輸出:success字符串)*/
{
"orders": [
{
"order_no": "20160201090120458263",/*訂單號*/
"carrier_code": "zjs",/*快遞公司編碼*/
"status": "4",/*訂單狀態:0:下單成功,1:下單失敗,2:撤單成功,3:撤單失敗,4:接單成功,5:接單失敗,
6:攬收成功,7:攬收失敗,8:在途,9:派件掃描,10:簽收成功,11:簽收失敗*/
"time": "2015-01-15 09:33:32",/*操作時間*/
"content": "工業園區網點接單,電話1234568"/*內容*/
}
]
}
/*物流信息推送,數據格式以及參數說明.(注:操作完成后輸出:success字符串)*/
{
"orders": [
{
"order": {
"bill_code": "350301727598", /*快遞公司運單號*/
"order_no": "20160201090120458263", /*訂單號*/
"carrier_code": "zjs", /*快遞公司編碼*/
"status": "4"
},
"data": [/*物流信息list*/
{
"time": "2014-11-14 15:51:59",/*操作時間*/
"content": "到太原市【太原分撥中心】"/*操作內容*/
},
{
"time": "2014-11-14 01:57:02",
"content": "北京市【北京分撥中心】,正發往【太原分撥中心】"
},
{
"time": "2014-11-14 01:55:27",
"content": "到北京市【北京分撥中心】"
}
]
}
]
}
