物流快递电子面单HTML接口API代码-快递100
生活随笔
收集整理的這篇文章主要介紹了
物流快递电子面单HTML接口API代码-快递100
小編覺得挺不錯的,現在分享給大家,幫大家做個參考.
一、電子面單HTML接口
通過快遞公司或網點、菜鳥與淘寶提供的電子面單賬號,提交生成電子面單號,返回固定面單模板,調用本地打印機即可打印出電子面單。
1.1 接口格式
提供統一格式的HTTP POST或GET調用接口,并返回統一格式JSON數據。
1.2 請求地址
http://poll.kuaidi100.com/eorderapi.do
請求參數(header)
| Content-Type | string | application/x-www-form-urlencoded |
請求參數(body)
| method | 是 | string | 業務類型(默認:getElecOrder) |
| key | 是 | string | 授權碼,請申請企業版獲取 |
| sign | 是 | string | 32位大寫 ,簽名,用于驗證身份,按MD5 (param +t+key+ secret)的順序進行MD5加密,不需要加上“+”號,secret可在企業管理后臺查看 |
| t | 是 | string | 時間戳如:1576123932000 |
| param | 是 | param | 由其他字段拼接 |
param數據結構
| partnerId | 是 | string | 電子面單客戶賬戶或月結賬號,需貴司向當地快遞公司網點申請(參考電子面單申請指南); 是否必填該屬性,請查看參數字典 |
| partnerKey | 否 | string | 電子面單密碼,需貴司向當地快遞公司網點申請; 是否必填該屬性,其他請查看參數字典 |
| partnerName | 否 | string | 商家名稱,net為jdalpha時必填 |
| net | 否 | string | 收件網點名稱,由快遞公司當地網點分配, 若使用淘寶授權填入(taobao),使用菜鳥授權填入(cainiao)。 是否必填該屬性,請查看參數字典(若通過淘寶/菜鳥授權方式獲取單號partnerId,partnerKey參數為必填,參數值可通過菜鳥淘寶賬號授權接口獲取) |
| tbNet | 否 | string | 在使用菜鳥/淘寶/拼多多授權電子面單時,若月結賬號下存在多個網點,則tbNet=“網點名稱,網點編號” ,注意此處為英文逗號 |
| kuaidicom | 是 | string | 快遞公司的編碼,一律用小寫字母,見參數字典 |
| ΘrecMan | 是 | object | 收件人信息 |
| ¬name | 是 | string | 收件人姓名 |
| ¬mobile | 是 | string | 收件人的手機號,手機號和電話號二者其一必填 |
| ¬printAddr | 是 | string | 收件人所在完整地址,如廣東深圳市深圳市南山區科技南十二路2號金蝶軟件園B10 |
| ¬company | 否 | string | 收件人所在公司名稱 |
| ΘsendMan | 是 | object | 寄件人信息 |
| ¬name | 是 | string | 寄件人姓名 |
| ¬mobile | 是 | string | 寄件人的手機號,手機號和電話號二者其一必填 |
| ¬printAddr | 是 | string | 寄件人所在的完整地址,如廣東深圳市深圳市南山區科技南十二路2號金蝶軟件園B10 |
| ¬company | 否 | string | 寄件人所在公司名稱 |
| cargo | 否 | string | 物品名稱,例:文件 |
| count | 是 | string | 物品總數量 另外該屬性與子單有關,如果需要子單(指同一個訂單打印出多張電子面單,即同一個訂單返回多個面單號),needChild = 1、count 需要大于1,如count = 2 則一個主單 一個子單,count = 3則一個主單 二個子單;返回的子單號碼見返回結果的childNum字段 |
| weight | 否 | string | 物品總重量KG,例:1.5,單位kg |
| payType | 否 | string | 支付方式: SHIPPER:寄方付(默認) CONSIGNEE:到付 MONTHLY:月結 THIRDPARTY:第三方支付 (詳細請參考參數字典) |
| expType | 否 | string | 快遞類型: 標準快遞(默認) 順豐標快(陸運) EMS經濟 (詳細請參考參數字典) |
| remark | 否 | string | 備注 |
| 面單擴展屬性 | |||
| valinsPay | 否 | string | 保價額度 |
| collection | 否 | string | 代收貨款額度 |
| needChild | 否 | string | 是否需要子單: 1:需要 0:不需要(默認) 如果需要子單(指同一個訂單打印出多張電子面單,即同一個訂單返回多個面單號); needChild = 1、count 需要大于1,如count = 2 一個主單 一個子單,count = 3 一個主單 二個子單,返回的子單號碼見返回結果的childNum字段 |
| needBack | 否 | string | 是否需要回單: 1:需要 0:不需要(默認) 返回的回單號見返回結果的returnNum字段 |
| orderId | 否 | string | 貴司內部自定義的訂單編號,需要保證唯一性,非必填 |
| needTemplate | 否 | string | 是否返回面單: 0:不需要(默認) 1:需要 如果需要,則返回要打印的模版的HTML代碼,貴司可以直接將之顯示到IE等瀏覽器,然后通過瀏覽器進行打印 |
| salt | 否 | string | 簽名用隨機字符串 |
| op | 否 | string | 是否開啟訂閱功能: 0:不開啟(默認) 1:開啟 說明開啟訂閱功能時:pollCallBackUrl必須填入此功能只針對有快遞單號的單 |
| pollCallBackUrl | 否 | string | 如果op設置為1時,pollCallBackUrl必須填入,用于跟蹤回調 |
| resultv2 | 否 | string | 添加此字段表示開通行政區域解析功能, 詳細見:快遞信息推送接口文檔-2.3推送輸入參數。 0:關閉(默認) 1:開通行政區域解析功能 |
關于回單:
支持回單的網點面單包括順豐、順豐快運、德邦快遞、德邦物流、京東、跨越、匯森速運、加運美物流、順心捷達;
支持回單的菜鳥面單包括申通快運、中通快運、韻達快運、德邦快運;
關于子單:
支持子單的網點面單包括順豐、順豐快運、德邦快遞、德邦物流、京東、品駿、全一快遞、速爾快遞、信豐物流、優速快遞、宅急送、圓通承諾達、龍邦快遞、D速快遞、匯森速運、加運美物流、京廣速遞、順心捷達、壹米滴答;
支持子單的菜鳥面單包括申通快運、中通快運、韻達快運、德邦快運、安能快運、百世快運;
1.3 請求參數示例
method = getElecOrder key = kytRsteof sign = 4BBDE07660E5EFF90873642CFAE9A8DD t = 1470304729724 param = {"partnerId": "******","partnerKey": "","net": "","kuaidicom": "ems","recMan": {"name": "張三","mobile": "13751866787","printAddr": "廣東深圳市深圳市南山區科技南十二路2號金蝶軟件園B10","company": ""},"sendMan": {"name": "李四","mobile": "13751866787","printAddr": "廣東深圳市深圳市南山區科技南十二路2號金蝶軟件園","company": ""},"cargo": "發票","count": "1","weight": "0.5","payType": "SHIPPER","expType": "標準快遞","remark": "","valinsPay": "","collection": "","needChild": "0","needBack": "0","orderId": "2147895476","needTemplate": "1","salt": "","op": "0","pollCallBackUrl": "","resultv2": "0" }1.4 返回結果
| result | boolean | 提交結果 | true提交成功,false失敗 |
| status | string | 返回編碼 | |
| message | string | 返回報文描述 | |
| data | data | Json |
data數據結構
| taskId | string | 任務ID | |
| kuaidinum | string | 快遞單號 | |
| returnNum | string | 回單號 | |
| childNum | string | 子單號,如果有多個,逗號分隔 | 如果需要子單 則需要提交報文needChild = 1、count 需要大于1。 如count = 2則一個主單、一個子單,count=3則一個主單、二個子單 |
| 快遞公司面單基礎信息 | |||
| bulkpen | string | 大頭筆 | 用于顯示于電子面單上規定位置,非必需,是否有值取決于快遞公司 |
| orgCode | string | 始發地區域編碼 | |
| orgName | string | 始發地/始發網點名稱 | |
| destCode | string | 目的地區域編碼 | |
| destName | string | 目的地/到達網點 | |
| orgSortingCode | string | 始發分揀編碼 | |
| orgSortingName | string | 始發分揀名稱 | |
| destSortingCode | string | 目的分棟編碼 | |
| destSortingName | string | 目的分棟中心名稱 | |
| orgExtra | string | 始發其他信息 | |
| destExtra | string | 目的其他信息 | |
| pkgCode | string | 集包編碼 | |
| pkgName | string | 集包地名稱 | |
| road | string | 路區 | |
| qrCode | string | 二維碼 | |
| orderNum | string | 快遞公司訂單號 | |
| expressCode | string | 快遞業務類型編碼 | |
| expressName | string | 快遞業務類型名稱 | |
| templateurl | string | 在線顯示電子面單模版的網址 | 用瀏覽器打開該網址,就能看到生成的電子面單,直接通過瀏覽器的打印功能即可完成打印 |
| template | string | 電子面單模板內容 |
1.5 返回結果示例
不帶模版返回
{ "result": true,"message": "成功","status": "200","data": [{"kuaidinum": "606568155331","returnNum": "","childNum": "","bulkpen": "大頭筆","orgCode": "755","orgName": "始發地區域編碼","destCode": "755","destName": "目的地/到達網點","orgSortingCode": "始發分揀編碼","orgSortingName": "始發分揀名稱","destSortingCode": "目的分棟編碼","destSortingName": "目的分棟中心名稱","orgExtra": "始發其他信息","destExtra": "目的其他信息","pkgCode": "集包編碼","pkgName": "集包地名稱","road": "路區","qrCode": "二維碼","orderNum": "快遞公司訂單號","expressCode": "快遞業務類型編碼","expressName": "標準快遞","templateurl": "http://www.kuaidi100.com/XXX"}] }帶模板返回
{ "result": true,"message": "成功","status": "200","data": [{"kuaidinum": "611399236259","returnNum": "","childNum": "","bulkpen": "大頭筆","orgCode": "755","orgName": "始發地區域編碼","destCode": "755","destName": "目的地/到達網點","orgSortingCode": "始發分揀編碼","orgSortingName": "始發分揀名稱","destSortingCode": "目的分棟編碼","destSortingName": "目的分棟中心名稱","orgExtra": "始發其他信息","destExtra": "目的其他信息","pkgCode": "集包編碼","pkgName": "集包地名稱","road": "路區","qrCode": "二維碼","orderNum": "快遞公司訂單號","expressCode": "快遞業務類型編碼","expressName": "標準快遞","templateurl": "http://ckd.im/u2WB5""template": ["<!DOCTYPE html><html><head><meta charset=\"utf-8\"><title>順豐</title><style>* { margin: 0;padding: 0}table {margin-top: -1px;font: 12px \"Microsoft YaHei\", Verdana,arial,sans-serif;border-collapse: collapse;}table.container {width: 375px;}table td {border: 1px solid #000;}table.nob {width: 100%;}table.nob td { border: 0;}table td.center {text-align: center;}table td.right {text-align: right;}……………</table></body></html>"]}] }返回的打印模版示例(即template或訪問templateurl后顯示的效果)
將template字段寫到一個html文件后通過瀏覽器打開并顯示出來后的效果示例:順豐:
1.6 返回信息代碼含義
| 200 | 成功 | 提交成功 |
| 401 | 參數錯誤 | 請根據技術文檔請求,注意參數類型及是否必填。 |
| 402 | 未指明服務 | 請檢查業務類型是否填錯 |
| 601 | KEY已過期 | 賬號無可用單量,需要充值 |
| 601 | 電子面單賬號校驗失敗,請確認賬號信息是否正確 | 傳入的電子面單賬號信息錯誤,請聯系當地網點獲得正確的賬號信息。 |
| 602 | 電子面單數量余額不足,請聯系合作網點客服充值 | 檢查提交內容,可找快遞100工作人員排查 |
| 603 | 無法獲取行政信息 | 請填寫詳細的省市區信息 |
| 604 | 該快遞公司不支持子單號 | 請查看1.2支持子單的快遞公司 |
| 605 | 該快遞公司不支持回單 | 請查看1.2支持回單的快遞公司 |
| 606 | 業務類型錯誤 | 從參數字典選擇合適的業務類型。 |
| 607 | 收件人手機號或電話不能同時為空 | 傳入收件人手機號或者電話 |
| 610 | 菜鳥電子面單認證信息過期,請重新授權 | 菜鳥授權一年有效,到期重新授權 |
| 697 | 電子面單請求失敗,請重新打印 | 請根據技術文檔請求,注意參數類型及是否必填。 |
| 699 | 請求快遞公司失敗,請稍候重試 | 請根據技術文檔請求,注意參數類型及是否必填。 |
快遞100API提供沙盒測試,點擊即可免費試用
總結
以上是生活随笔為你收集整理的物流快递电子面单HTML接口API代码-快递100的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: springboot毕设项目协同过滤推荐
- 下一篇: 保姆级 IGV 基因组浏览器使用指南(图