快递100快递信息订阅推送API接口案例代码
一、訂閱接口
1.1 訂閱請求地址
https://poll.kuaidi100.com/poll
1.2 訂閱請求類型
post
1.3 訂閱輸入?yún)?shù)
請求參數(shù)(header)
| Content-Type | string | application/x-www-form-urlencoded |
請求參數(shù)(body)
| schema | String | 是 | json | 返回的數(shù)據(jù)格式 |
| Θparam | param | 是 | 由其他字段拼接 | |
| └ company | String | 是 | ems | 訂閱的快遞公司的編碼,一律用小寫字母 |
| └ number | String | 是 | 1136281381675 | 訂閱的快遞單號,單號的最大長度是32個字符 下載編碼表格 |
| └ from | String | 否 | 廣東省深圳市南山區(qū) | 出發(fā)地城市,省-市-區(qū),非必填,填了有助于提升簽收狀態(tài)的判斷的準(zhǔn)確率,請盡量提供 |
| └ to | String | 否 | 北京市朝陽區(qū) | 目的地城市,省-市-區(qū),非必填,填了有助于提升簽收狀態(tài)的判斷的準(zhǔn)確率,且到達目的地后會加大監(jiān)控頻率,請盡量提供 |
| └ key | String | 是 | 授權(quán)碼,請申請企業(yè)版獲取 | |
| Θparameters | parameters | 是 | 附加參數(shù)信息 | |
| └- callbackurl | String | 是 | 回調(diào)接口的地址 | |
| └- salt | String | 否 | XXXXXXXXXX | 簽名用隨機字符串 |
| └- resultv2 | String | 否 | 1 | 添加此字段表示打開行政區(qū)域解析功能 |
| └- autoCom | String | 否 | 1 | 添加此字段且將此值設(shè)為1,則表示開始智能判斷單號所屬公司的功能,開啟后,company字段可為空,即只傳運單號(number字段),我方收到后會根據(jù)單號判斷出其所屬的快遞公司(即company字段)。建議只有在無法知道單號對應(yīng)的快遞公司(即company的值)的情況下才開啟此功能 |
| └- interCom | String | 否 | 1 | 添加此字段表示開啟國際版,開啟后,若訂閱的單號(即number字段)屬于國際單號,會返回出發(fā)國與目的國兩個國家的跟蹤信息,本功能暫時只支持郵政體系(國際類的郵政小包、EMS)內(nèi)的快遞公司,若單號我方識別為非國際單,即使添加本字段,也不會返回destResult元素組 |
| └- departureCountry | String | 否 | CN | 出發(fā)國家編碼 |
| └- departureCom | String | 否 | ems | 出發(fā)的快遞公司的編碼 |
| └- destinationCountry | String | 否 | JP | 目的國家編碼 |
| └- destinationCom | String | 否 | japanposten | 目的的快遞公司的編碼 |
| └- phone | String | 否 | 13488888888 | 收、寄件人的電話號碼(手機和固定電話均可,只能填寫一個,順豐單號必填,其他快遞公司選填。如座機號碼有分機號,分機號無需上傳。) |
1.4 訂閱請求參數(shù)示例
schema = jsonparam = {"company": "ems","number": "1136281381675","from": "廣東省深圳市南山區(qū)","to": "北京市朝陽區(qū)","key": "XXX ","parameters": {"callbackurl": "您的回調(diào)接口的地址,如http://www.您的域名.com/kuaidi?callbackid=...","salt": "XXXXXXXXXX","resultv2": "1","autoCom": "1","interCom": "1","departureCountry": "CN","departureCom": "ems","destinationCountry": "JP","destinationCom": "japanposten"}}1.5 訂閱返回信息代碼含義
result: true表示成功,false表示失敗
| 200 | 提交成功 | 訂閱提交成功 |
| 500 | 服務(wù)器錯誤 | 快遞100的服務(wù)器出理間隙或臨時性異常,有時如果因為不按規(guī)范提交請求,比如快遞公司參數(shù)寫錯等,也會報此錯誤 |
| 501 | 重復(fù)訂閱 | 此單已經(jīng)訂閱成功且目前還在跟蹤過程中。若要提交多次訂閱,請在收到單號的status=abort或shutdown后隔半小時再提交訂閱 |
| 502 | 提交內(nèi)容含有敏感關(guān)鍵字,被安全防護攔截 | 回調(diào)地址、提交內(nèi)容包含敏感詞,請聯(lián)系快遞100工作人員 |
| 600 | 您不是合法的訂閱者(即授權(quán)Key出錯) | 賬號無可用單量,需要充值 |
| 601 | POLL: KEY 已過期 | 賬號無可用單量,需要充值 |
| 700 | 不支持的快遞公司 | 拒絕訂閱的快遞公司,檢查快遞公司編碼是否有誤 |
| 701 | 訂閱方的訂閱數(shù)據(jù)存在錯誤(如不支持的快遞公司、單號為空、單號超長等)或錯誤的回調(diào)地址 | 請檢查快遞公司編碼、對照技術(shù)文檔檢查參數(shù)、在后臺調(diào)試工具測試回調(diào)地址 |
| 702 | POLL:識別不到該單號對應(yīng)的快遞公司 | 快遞公司編碼錯誤或者無可用單量,需要充值 |
1.6 訂閱返回示例(JSON格式)
{"result": true,"returnCode": "200","message": "提交成功" }二、推送接口
2.1 推送請求地址
由貴司在訂閱請求中通過callbackurl字段提供
2.2 推送請求類型
post
2.3 推送輸入?yún)?shù)
請求參數(shù)(header)
| Content-Type | string | application/x-www-form-urlencoded |
請求參數(shù)(body)
| sign | String | 訂閱參數(shù)salt值不為空時,推送數(shù)據(jù)將包含該加密簽名,加密方式:md5(param+salt) | |
| Θparam | 由其他字段拼接 | ||
| └ status | String | polling | 監(jiān)控狀態(tài):polling:監(jiān)控中,shutdown:結(jié)束,abort:中止,updateall:重新推送。其中當(dāng)快遞單為已簽收時status=shutdown,當(dāng)message為“3天查詢無記錄”或“60天無變化時”status= abort ,對于status=abort的狀態(tài),需要增加額外的處理邏輯 |
| └ billstatus | String | got | 包括got、sending、check三個狀態(tài),由于意義不大,已棄用,請忽略 |
| └ message | String | 監(jiān)控狀態(tài)相關(guān)消息,如:3天查詢無記錄,60天無變化 | |
| └ autoCheck | String | 1 | 快遞公司編碼是否出錯,0為本推送信息對應(yīng)的是貴司提交的原始快遞公司編碼,1為本推送信息對應(yīng)的是我方糾正后的新的快遞公司編碼。一個單如果我們連續(xù)3天都查不到結(jié)果,我方會(1)判斷一次貴司提交的快遞公司編碼是否正確,如果正確,給貴司的回調(diào)接口(callbackurl)推送帶有如下字段的信息:autoCheck=0、comOld與comNew都為空;(2)如果貴司提交的快遞公司編碼出錯,我們會幫忙用正確的快遞公司編碼+原來的運單號重新提交訂閱并開啟監(jiān)控(后續(xù)如果監(jiān)控到單號有更新就給貴司的回調(diào)接口(callbackurl)推送帶有如下字段的信息:autoCheck=1、comOld=原來的公司編碼、comNew=新的公司編碼);并且給貴方的回調(diào)接口(callbackurl)推送一條含有如下字段的信息:status=abort、autoCheck=0、comOld為空、comNew=糾正后的快遞公司編碼。 |
| └ comOld | String | yuantong | 貴司提交的原始的快遞公司編碼。詳細(xì)見autoCheck后說明。若開啟了國際版(即在訂閱請求中增加字段interCom=1),則回調(diào)請求中暫無此字段 |
| └ comNew | String | ems | 我司糾正后的新的快遞公司編碼。詳細(xì)見autoCheck后說明。若開啟了國際版(即在訂閱請求中增加字段interCom=1),則回調(diào)請求中暫無此字段 |
| ΘlastResult | lastResult | 最新查詢結(jié)果,若在訂閱報文中通過interCom字段開通了國際版,則此lastResult表示出發(fā)國的查詢結(jié)果,全量,倒序(即時間最新的在最前) | |
| └- message | String | 消息體,請忽略 | |
| └- state | String | 0 | 快遞單當(dāng)前狀態(tài),包括0在途,1攬收,2疑難,3簽收,4退簽,5派件,6退回,7轉(zhuǎn)單,10待清關(guān),11清關(guān)中,12已清關(guān),13清關(guān)異常,14收件人拒簽等13個狀態(tài) |
| └- status | String | 200 | 通訊狀態(tài),請忽略 |
| └- condition | String | F00 | 快遞單明細(xì)狀態(tài)標(biāo)記,暫未實現(xiàn),請忽略 |
| └- ischeck | String | 0 | 是否簽收標(biāo)記 |
| └- com | String | yuantong | 快遞公司編碼,一律用小寫字母 |
| └- nu | String | V030344422 | 單號 |
| └- data | Object | 數(shù)組,包含多個對象,每個對象字段如展開所示 | |
| └-- context | String | 上海分撥中心/裝件入車掃描 | 內(nèi)容 |
| └-- time | String | 2012-08-28 16:33:19 | 時間,原始格式 |
| └-- ftime | String | 2012-08-28 16:33:19 | 格式化后時間 |
| └-- status | String | 在途 | 本數(shù)據(jù)元對應(yīng)的簽收狀態(tài)。在訂閱接口中提交resultv2 = 1字段后才會出現(xiàn) |
| └-- areaCode | String | 310000000000 | 本數(shù)據(jù)元對應(yīng)的行政區(qū)域的編碼,在訂閱接口中提交resultv2 = 1字段后才會出現(xiàn) |
| └-- areaName | String | 上海市 | 本數(shù)據(jù)元對應(yīng)的行政區(qū)域的名稱,在訂閱接口中提交resultv2 = 1字段后才會出現(xiàn) |
| Θ destResult | destResult | 表示最新的目的國家的查詢結(jié)果,只有在訂閱報文中通過interCom=1字段開通了國際版才會顯示此數(shù)據(jù)元,全量,倒序(即時間最新的在最前) | |
| └- message | String | 消息體,請忽略 | |
| └- state | String | 0 | 快遞單當(dāng)前狀態(tài),包括0在途,1攬收,2疑難,3簽收,4退簽,5派件,6退回等8個狀態(tài) |
| └- status | String | 200 | 通訊狀態(tài),請忽略 |
| └- condition | String | F00 | 快遞單明細(xì)狀態(tài)標(biāo)記,暫未實現(xiàn),請忽略 |
| └- ischeck | String | 0 | 是否簽收標(biāo)記 |
| └- com | String | yuantong | 快遞公司編碼,一律用小寫字母 |
| └- nu | String | V030344422 | 單號 |
| Θ data | data | 數(shù)組,包含多個對象,每個對象字段如展開所示 | |
| └-- context | String | 上海分撥中心/裝件入車掃描 | 內(nèi)容 |
| └-- time | String | 2012-08-28 16:33:19 | 時間,原始格式 |
| └-- ftime | String | 2012-08-28 16:33:19 | 格式化后時間 |
| └-- status | String | 在途 | 本數(shù)據(jù)元對應(yīng)的簽收狀態(tài),在訂閱接口中提交resultv2 = 1字段后才會出現(xiàn) |
| └-- areaCode | String | 310000000000 | 本數(shù)據(jù)元對應(yīng)的行政區(qū)域的編碼,在訂閱接口中提交resultv2 = 1字段后才會出現(xiàn) |
| └-- areaName | String | 上海市 | 本數(shù)據(jù)元對應(yīng)的行政區(qū)域的名稱,在訂閱接口中提交resultv2 = 1字段后才會出現(xiàn) |
2.4 推送輸入?yún)?shù)示例
param = {"status": "polling","billstatus": "got","message": "","autoCheck": "1","comOld": "yuantong","comNew": "ems","lastResult": {"message": "ok","state": "0","status": "200","condition": "F00","ischeck": "0","com": "yuantong","nu": "V030344422","data": [{"context": "上海分撥中心/裝件入車掃描 ","time": "2012-08-28 16:33:19","ftime": "2012-08-28 16:33:19","status": "在途","areaCode": "310000000000","areaName": "上海市"},{"context": "上海分撥中心/下車掃描 ","time": "2012-08-27 23:22:42","ftime": "2012-08-27 23:22:42","status": "在途","areaCode": "310000000000","areaName": "上海市"}]},"destResult": {"message": "ok","state": "0","status": "200","condition": "F00","ischeck": "0" ,"com": "speedpost","nu": "EX015142583SG","data": [{"context": "[01000]Final delivery Delivered to: SLOVESNOV","time": "2016-05-24 14:00:00","ftime": "2016-05-24 14:00:00","status": "簽收","areaCode": null,"areaName": null}]} }2.5 運單簽收狀態(tài)服務(wù)說明
| 0 | 在途 | 快件處于運輸過程中 |
| 1 | 攬收 | 快件已由快遞公司攬收 |
| 2 | 疑難 | 快遞100無法解析的狀態(tài),或者是需要人工介入的狀態(tài), 比方說收件人電話錯誤。 |
| 3 | 簽收 | 正常簽收 |
| 4 | 退簽 | 貨物退回發(fā)貨人并簽收 |
| 5 | 派件 | 貨物正在進行派件 |
| 6 | 退回 | 貨物正處于返回發(fā)貨人的途中 |
| 7 | 轉(zhuǎn)投 | 貨物轉(zhuǎn)給其他快遞公司郵寄 |
| 10 | 待清關(guān) | 貨物等待清關(guān) |
| 11 | 清關(guān)中 | 貨物正在清關(guān)流程中 |
| 12 | 已清關(guān) | 貨物已完成清關(guān)流程 |
| 13 | 清關(guān)異常 | 貨物在清關(guān)過程中出現(xiàn)異常 |
| 14 | 拒簽 | 收件人明確拒收 |
2.6 推送響應(yīng)報文及錯誤碼解釋
| result | true表示成功,false表示失敗。如果提交回調(diào)接口的地址失敗,30分鐘后重新回調(diào),3次仍舊失敗的,自動放棄 |
| returnCode | 200: 提交成功 500: 服務(wù)器錯誤 其他錯誤請自行定義 |
| message | 返回的提示 |
2.7 推送返回示例
當(dāng)我方調(diào)用貴方的回調(diào)接口(callbackurl)時,貴方需要先將我方提交的數(shù)據(jù)保存至貴方的數(shù)據(jù)庫,接著向我方返回是否成功接收的響應(yīng)報文及代碼,即貴公司直接在回調(diào)接口的地址的response中填寫如下內(nèi)容:
{"result":true,"returnCode":"200","message":"成功" }注意:對于status= abort(message中包含“3天查詢無記錄”或者“60天無變化”)的快遞單,也需要返回成功接收的響應(yīng)報文及代碼。
三、快遞公司編碼
下載表格
四、demo下載
JAVA示例代碼????PHP示例代碼????PYTHON示例代碼????.NET示例代碼
一、快遞信息推送API產(chǎn)品介紹
快遞100信息推送服務(wù)提供運單查詢、追蹤的功能,用于企業(yè)對寄出的物品進行物流追蹤。
信息推送服務(wù)是企業(yè)提交快遞單號,快遞100接收到后便對這些運單進行跟蹤,當(dāng)運單狀態(tài)發(fā)生變化的時候,快遞100便通過調(diào)用回調(diào)接口將運單的跟蹤信息推送給貴公司,直到這些運單號的生命周期結(jié)束(一般以“已簽收”為準(zhǔn))。對于某個單號,當(dāng)貴方正確提交訂閱了后,我們一般會在15分鐘左右后進行第一次監(jiān)控,如果監(jiān)控到單號本身有了跟蹤信息,即進行第一次推送,否則等待下一次監(jiān)控。此后我們一般每4小時進行一次監(jiān)控,并會根據(jù)單號的狀態(tài)等因素作調(diào)整。
二、快遞信息推送API應(yīng)用場景
讓顧客登錄您的網(wǎng)站、APP、小程序后,直接在“我的訂單”頁面內(nèi)就能看到訂單的物流狀態(tài)。
能開發(fā)自動的、批量查單功能,自動篩選出“已簽收”、“疑難件”等狀態(tài)的單號,減輕跟單人員的壓力。
改變訂單的狀態(tài)與交易流程,例如只要運單號變?yōu)椤耙押炇铡?#xff0c;就能讓訂單變更為可以確認(rèn)退換貨等。
核銷銷售人員,根據(jù)“已簽收”的運單數(shù),就能算出銷售人員的業(yè)績。
評估與選擇快遞公司,可獲得快遞實際在途時間,評估快遞公司的時效,優(yōu)化快遞選擇;
助結(jié)算運費,找出“已簽收”的單及簽收時間,便能輕松應(yīng)對貨到付款的結(jié)算與對賬。
三、系統(tǒng)結(jié)構(gòu)與流程
四、快遞信息推送API費用結(jié)算
1. 收費方式
快遞信息推送接口屬于查詢類接口,企業(yè)注冊快遞100賬號后可以在企業(yè)管理后臺查看查詢類接口套餐查看查詢類接口套餐并購買。
2. 收費價格
查詢類接口預(yù)充值收費套餐:充值即可開通使用,無需合同流程。
| 2000 | 20000 | 5000 | 0.08 |
| 1000 | 10000 | 2000 | 約0.083 |
| 500 | 5000 | 500 | 約0.09 |
查詢類接口按單收費,一個自然月內(nèi)同一個運單多次查詢只收一次費用。
3. 開具發(fā)票
快遞100支持開具增值稅發(fā)票,用戶購買完成后可在企業(yè)管理后臺-費用中心-支付記錄-請求開票。默認(rèn)開具電子增值稅普通發(fā)票,1000元以上可支持開具增值稅專用發(fā)票。
官方源文檔:
https://api.kuaidi100.com/document/5f0ffa7f2977d50a94e1023b.html
https://api.kuaidi100.com/document/5f0ffa8f2977d50a94e1023c.html
http://api.kuaidi100.com/document/5eb9f73986b0df4188313a04.html
http://api.kuaidi100.com/document/5eb9f73186b0df4188313a03.html
總結(jié)
以上是生活随笔為你收集整理的快递100快递信息订阅推送API接口案例代码的全部內(nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 已解决:联想G480安装win10反复出
- 下一篇: 道客巴巴