电商快递物流的电子面单打印接口API案例代码
生活随笔
收集整理的這篇文章主要介紹了
电商快递物流的电子面单打印接口API案例代码
小編覺得挺不錯的,現在分享給大家,幫大家做個參考.
一、電子面單打印接口
通過快遞公司或網點、菜鳥與淘寶提供的電子面單賬號,調用打印設備打印輸出。打印接口連接的設備必須是快遞100云打印機或者快遞100云盒。云盒可以支持不同品牌的打印機,點擊查詢具體支持品牌。
電子面單接口可選擇面單模板并進行編輯,支持遠程打印機和共享打印。支持面單復打,兩天內可以復打10次。
1.1 接口格式
提供統一格式的HTTP POST或GET調用接口,并返回統一格式JSON數據。
1.2 請求地址
https://poll.kuaidi100.com/printapi/printtask.do
請求參數(header)
| Content-Type | string | application/x-www-form-urlencoded |
請求參數(body)
| method | 是 | string | 業務類型(默認:eOrder) |
| key | 是 | string | 授權碼,請申請企業版獲取 |
| sign | 是 | string | 32位大寫 ,簽名,用于驗證身份,按MD5 (param +t+key+ secret)的順序進行MD5加密,不需要加上“+”號,secret在授權郵件里面有 |
| t | 是 | string | 時間戳如:1576123932000 |
| param | 是 | param | 由其他字段拼接 |
param數據結構:
| type | 是 | string | 業務類型,默認為10 |
| 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 | 備注 |
| tempid | 是 | string | 通過管理后臺的打印模版配置信息獲取 |
| siid | 是 | string | 快遞100打印機或者云盒設備碼 |
| 面單擴展屬性 | |||
| valinsPay | 否 | string | 保價額度 |
| collection | 否 | string | 代收貨款額度 |
| needChild | 否 | string | 是否需要子單: 1:需要 0:不需要(默認) 如果需要子單(指同一個訂單打印出多張電子面單,即同一個訂單返回多個面單號); needChild = 1、count 需要大于1,如count = 2 一個主單 一個子單,count = 3 一個主單 二個子單,返回的子單號碼見返回結果的childNum字段 |
| needBack | 否 | string | 是否需要回單: 1:需要 0:不需要(默認) 返回的回單號見返回結果的returnNum字段 |
| orderId | 否 | string | 貴司內部自定義的訂單編號,需要保證唯一性,非必填 |
| height | 否 | string | 打印紙的高度,以mm為單位,默認為面單模板尺寸 |
| width | 否 | string | 打印紙的寬度,以mm為單位,默認為面單模板尺寸 |
| callBackUrl | 否 | string | 打印狀態回調地址 |
| salt | 否 | string | 簽名用隨機字符串 |
| op | 否 | string | 是否開啟訂閱功能 0:不開啟(默認) 1:開啟 說明開啟訂閱功能時:pollCallBackUrl必須填入 此功能只針對有快遞單號的單 |
| pollCallBackUrl | 否 | string | 如果op設置為1時,pollCallBackUrl必須填入,用于跟蹤回調 |
| resultv2 | 否 | string | 添加此字段表示開通行政區域解析功能, 詳細見:快遞信息推送接口文檔-2.3 推送輸入參數。 0:關閉(默認) 1:開通行政區域解析功能 |
| ****** | 否 | string | 其他面單特殊需求參數顯示,可以到后臺-面單模板選擇該模板,下方有對應產生列表 |
關于回單:
支持回單的網點面單包括順豐、順豐快運、德邦快遞、德邦物流、京東、跨越、匯森速運、加運美物流、順心捷達;
支持回單的菜鳥面單包括申通快運、中通快運、韻達快運、德邦快運;
關于子單:
支持子單的網點面單包括順豐、順豐快運、德邦快遞、德邦物流、京東、品駿、全一快遞、速爾快遞、信豐物流、優速快遞、宅急送、圓通承諾達、龍邦快遞、D速快遞、匯森速運、加運美物流、京廣速遞、順心捷達、壹米滴答;
支持子單的菜鳥面單包括申通快運、中通快運、韻達快運、德邦快運、安能快運、百世快運;
1.3 返回結果
| result | boolean | 提交結果 | true提交成功,false失敗 |
| returnCode | string | 返回編碼 | |
| message | string | 返回報文描述 | |
| data | data |
data數據結構
| taskId | string | 任務ID | |
| kuaidicom | string | 快遞公司編碼 | |
| kuaidinum | string | 快遞單號 | |
| ****** | ****** | 其他報文 |
1.4 提供數據內容
{ "result": true,"returnCode": "200","message": "提交成功","data": {"taskId": "****", // 任務ID "kuaidicom": "****", // 快遞公司編碼 "kuaidinum": "****", // 快遞單號 ******} }1.5 返回的信息代碼含義
| 200 | 提交成功 | 提交成功 |
| 400 | 參數錯誤 | 請根據技術文檔請求,注意參數類型及是否必填。 |
| 500 | 服務器錯誤 | 快遞100的服務器出理間隙或臨時性異常,有時如果因為不按規范提交請求,比如快遞公司參數寫錯等,也會報此錯誤 |
| 501 | 重復提交 | 重復提交生成圖片請求 |
| 502 | 提交內容含有敏感關鍵字,被安全防護攔截 | 檢查提交內容,可找快遞100工作人員排查 |
| 503 | 驗證簽名失敗 | 請檢查加密方式,param +t+key+ secret的順序進行MD5加密,加密后字符串轉32位大寫,不用加上“+”號 |
| 600 | 您不是合法的客戶(即授權key出錯) | 賬號無可用單量,需要充值 |
| 601 | KEY已過期 | 賬號無可用單量,需要充值 |
| 601 | 電子面單賬號校驗失敗,請確認賬號信息是否正確 | 傳入的電子面單賬號信息錯誤,請聯系當地網點獲得正確的賬號信息。 |
| 602 | 電子面單數量余額不足,請聯系合作網點客服充值 | 申請的快遞公司網點電子面單賬號的電子面單數量不足,需要去網點充值面單數量。 |
| 603 | 無法獲取行政信息 | 請填寫詳細的省市區信息 |
| 604 | 該快遞公司不支持子單號 | 請查看1.2支持子單的快遞公司 |
| 605 | 該快遞公司不支持回單 | 請查看1.2支持回單的快遞公司 |
| 606 | 業務類型錯誤 | 從參數字典選擇合適的業務類型 |
| 607 | 收件人手機號或電話不能同時為空 | 傳入收件人手機號或者電話 |
| 610 | 菜鳥電子面單認證信息過期,請重新授權 | 菜鳥授權一年有效,到期重新授權 |
| 697 | 電子面單請求失敗,請重新打印 | 請根據技術文檔請求,注意參數類型及是否必填。 |
官方文檔:
https://api.kuaidi100.com/document/5f0ff6adbc8da837cbd8aef8.html
總結
以上是生活随笔為你收集整理的电商快递物流的电子面单打印接口API案例代码的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 关于7.0去掉Chrome后,平台默认浏
- 下一篇: 无线产品认证logo