电商快递物流的电子面单打印接口API案例代码
一、電子面單打印接口
通過(guò)快遞公司或網(wǎng)點(diǎn)、菜鳥(niǎo)與淘寶提供的電子面單賬號(hào),調(diào)用打印設(shè)備打印輸出。打印接口連接的設(shè)備必須是快遞100云打印機(jī)或者快遞100云盒。云盒可以支持不同品牌的打印機(jī),點(diǎn)擊查詢具體支持品牌。
電子面單接口可選擇面單模板并進(jìn)行編輯,支持遠(yuǎn)程打印機(jī)和共享打印。支持面單復(fù)打,兩天內(nèi)可以復(fù)打10次。
1.1 接口格式
提供統(tǒng)一格式的HTTP POST或GET調(diào)用接口,并返回統(tǒng)一格式JSON數(shù)據(jù)。
1.2 請(qǐng)求地址
https://poll.kuaidi100.com/printapi/printtask.do
請(qǐng)求參數(shù)(header)
| Content-Type | string | application/x-www-form-urlencoded |
請(qǐng)求參數(shù)(body)
| method | 是 | string | 業(yè)務(wù)類型(默認(rèn):eOrder) |
| key | 是 | string | 授權(quán)碼,請(qǐng)申請(qǐng)企業(yè)版獲取 |
| sign | 是 | string | 32位大寫 ,簽名,用于驗(yàn)證身份,按MD5 (param +t+key+ secret)的順序進(jìn)行MD5加密,不需要加上“+”號(hào),secret在授權(quán)郵件里面有 |
| t | 是 | string | 時(shí)間戳如:1576123932000 |
| param | 是 | param | 由其他字段拼接 |
param數(shù)據(jù)結(jié)構(gòu):
| type | 是 | string | 業(yè)務(wù)類型,默認(rèn)為10 |
| partnerId | 是 | string | 電子面單客戶賬戶或月結(jié)賬號(hào),需貴司向當(dāng)?shù)乜爝f公司網(wǎng)點(diǎn)申請(qǐng)(參考電子面單申請(qǐng)指南); 是否必填該屬性,請(qǐng)查看參數(shù)字典 |
| partnerKey | 否 | string | 電子面單密碼,需貴司向當(dāng)?shù)乜爝f公司網(wǎng)點(diǎn)申請(qǐng); 是否必填該屬性,請(qǐng)查看參數(shù)字典 |
| partnerName | 否 | string | 商家名稱,net為jdalpha時(shí)必填 |
| net | 否 | string | 收件網(wǎng)點(diǎn)名稱,由快遞公司當(dāng)?shù)鼐W(wǎng)點(diǎn)分配, 若使用淘寶授權(quán)填入(taobao),使用菜鳥(niǎo)授權(quán)填入(cainiao)。 是否必填該屬性,請(qǐng)查看參數(shù)字典(若通過(guò)淘寶/菜鳥(niǎo)授權(quán)方式獲取單號(hào)partnerId,partnerKey參數(shù)為必填,參數(shù)值可通過(guò)菜鳥(niǎo)淘寶賬號(hào)授權(quán)接口獲取) |
| tbNet | 否 | string | 在使用菜鳥(niǎo)/淘寶/拼多多授權(quán)電子面單時(shí),若月結(jié)賬號(hào)下存在多個(gè)網(wǎng)點(diǎn),則tbNet=“網(wǎng)點(diǎn)名稱,網(wǎng)點(diǎn)編號(hào)” ,注意此處為英文逗號(hào) |
| kuaidicom | 是 | string | 快遞公司的編碼,一律用小寫字母,見(jiàn)參數(shù)字典 |
| ΘrecMan | 是 | object | 收件人信息 |
| ¬name | 是 | string | 收件人姓名 |
| ¬mobile | 是 | string | 收件人的手機(jī)號(hào),手機(jī)號(hào)和電話號(hào)二者其一必填 |
| ¬printAddr | 是 | string | 收件人所在完整地址,如廣東深圳市深圳市南山區(qū)科技南十二路2號(hào)金蝶軟件園B10 |
| ¬company | 否 | string | 收件人所在公司名稱 |
| ΘsendMan | 是 | object | 寄件人信息 |
| ¬name | 是 | string | 寄件人姓名 |
| ¬mobile | 是 | string | 寄件人的手機(jī)號(hào),手機(jī)號(hào)和電話號(hào)二者其一必填 |
| ¬printAddr | 是 | string | 寄件人所在的完整地址,如廣東深圳市深圳市南山區(qū)科技南十二路2號(hào)金蝶軟件園B10 |
| ¬company | 否 | string | 寄件人所在公司名稱 |
| cargo | 否 | string | 物品名稱,例:文件 |
| count | 是 | string | 物品總數(shù)量。 另外該屬性與子單有關(guān),如果需要子單(指同一個(gè)訂單打印出多張電子面單,即同一個(gè)訂單返回多個(gè)面單號(hào)),needChild = 1、count 需要大于1,如count = 2 則一個(gè)主單 一個(gè)子單,count = 3則一個(gè)主單 二個(gè)子單;返回的子單號(hào)碼見(jiàn)返回結(jié)果的childNum字段 |
| weight | 否 | string | 物品總重量KG,例:1.5,單位kg |
| payType | 否 | string | 支付方式: SHIPPER:寄方付(默認(rèn)) CONSIGNEE:到付 MONTHLY:月結(jié) THIRDPARTY:第三方支付 (詳細(xì)請(qǐng)參考參數(shù)字典) |
| expType | 否 | string | 快遞類型: 如標(biāo)準(zhǔn)快遞(默認(rèn)) 順豐標(biāo)快(陸運(yùn)) EMS經(jīng)濟(jì) (詳細(xì)請(qǐng)參考參數(shù)字典) |
| remark | 否 | string | 備注 |
| tempid | 是 | string | 通過(guò)管理后臺(tái)的打印模版配置信息獲取 |
| siid | 是 | string | 快遞100打印機(jī)或者云盒設(shè)備碼 |
| 面單擴(kuò)展屬性 | |||
| valinsPay | 否 | string | 保價(jià)額度 |
| collection | 否 | string | 代收貨款額度 |
| needChild | 否 | string | 是否需要子單: 1:需要 0:不需要(默認(rèn)) 如果需要子單(指同一個(gè)訂單打印出多張電子面單,即同一個(gè)訂單返回多個(gè)面單號(hào)); needChild = 1、count 需要大于1,如count = 2 一個(gè)主單 一個(gè)子單,count = 3 一個(gè)主單 二個(gè)子單,返回的子單號(hào)碼見(jiàn)返回結(jié)果的childNum字段 |
| needBack | 否 | string | 是否需要回單: 1:需要 0:不需要(默認(rèn)) 返回的回單號(hào)見(jiàn)返回結(jié)果的returnNum字段 |
| orderId | 否 | string | 貴司內(nèi)部自定義的訂單編號(hào),需要保證唯一性,非必填 |
| height | 否 | string | 打印紙的高度,以mm為單位,默認(rèn)為面單模板尺寸 |
| width | 否 | string | 打印紙的寬度,以mm為單位,默認(rèn)為面單模板尺寸 |
| callBackUrl | 否 | string | 打印狀態(tài)回調(diào)地址 |
| salt | 否 | string | 簽名用隨機(jī)字符串 |
| op | 否 | string | 是否開(kāi)啟訂閱功能 0:不開(kāi)啟(默認(rèn)) 1:開(kāi)啟 說(shuō)明開(kāi)啟訂閱功能時(shí):pollCallBackUrl必須填入 此功能只針對(duì)有快遞單號(hào)的單 |
| pollCallBackUrl | 否 | string | 如果op設(shè)置為1時(shí),pollCallBackUrl必須填入,用于跟蹤回調(diào) |
| resultv2 | 否 | string | 添加此字段表示開(kāi)通行政區(qū)域解析功能, 詳細(xì)見(jiàn):快遞信息推送接口文檔-2.3 推送輸入?yún)?shù)。 0:關(guān)閉(默認(rèn)) 1:開(kāi)通行政區(qū)域解析功能 |
| ****** | 否 | string | 其他面單特殊需求參數(shù)顯示,可以到后臺(tái)-面單模板選擇該模板,下方有對(duì)應(yīng)產(chǎn)生列表 |
關(guān)于回單:
支持回單的網(wǎng)點(diǎn)面單包括順豐、順豐快運(yùn)、德邦快遞、德邦物流、京東、跨越、匯森速運(yùn)、加運(yùn)美物流、順心捷達(dá);
支持回單的菜鳥(niǎo)面單包括申通快運(yùn)、中通快運(yùn)、韻達(dá)快運(yùn)、德邦快運(yùn);
關(guān)于子單:
支持子單的網(wǎng)點(diǎn)面單包括順豐、順豐快運(yùn)、德邦快遞、德邦物流、京東、品駿、全一快遞、速爾快遞、信豐物流、優(yōu)速快遞、宅急送、圓通承諾達(dá)、龍邦快遞、D速快遞、匯森速運(yùn)、加運(yùn)美物流、京廣速遞、順心捷達(dá)、壹米滴答;
支持子單的菜鳥(niǎo)面單包括申通快運(yùn)、中通快運(yùn)、韻達(dá)快運(yùn)、德邦快運(yùn)、安能快運(yùn)、百世快運(yùn);
1.3 返回結(jié)果
| result | boolean | 提交結(jié)果 | true提交成功,false失敗 |
| returnCode | string | 返回編碼 | |
| message | string | 返回報(bào)文描述 | |
| data | data |
data數(shù)據(jù)結(jié)構(gòu)
| taskId | string | 任務(wù)ID | |
| kuaidicom | string | 快遞公司編碼 | |
| kuaidinum | string | 快遞單號(hào) | |
| ****** | ****** | 其他報(bào)文 |
1.4 提供數(shù)據(jù)內(nèi)容
{ "result": true,"returnCode": "200","message": "提交成功","data": {"taskId": "****", // 任務(wù)ID "kuaidicom": "****", // 快遞公司編碼 "kuaidinum": "****", // 快遞單號(hào) ******} }1.5 返回的信息代碼含義
| 200 | 提交成功 | 提交成功 |
| 400 | 參數(shù)錯(cuò)誤 | 請(qǐng)根據(jù)技術(shù)文檔請(qǐng)求,注意參數(shù)類型及是否必填。 |
| 500 | 服務(wù)器錯(cuò)誤 | 快遞100的服務(wù)器出理間隙或臨時(shí)性異常,有時(shí)如果因?yàn)椴话匆?guī)范提交請(qǐng)求,比如快遞公司參數(shù)寫錯(cuò)等,也會(huì)報(bào)此錯(cuò)誤 |
| 501 | 重復(fù)提交 | 重復(fù)提交生成圖片請(qǐng)求 |
| 502 | 提交內(nèi)容含有敏感關(guān)鍵字,被安全防護(hù)攔截 | 檢查提交內(nèi)容,可找快遞100工作人員排查 |
| 503 | 驗(yàn)證簽名失敗 | 請(qǐng)檢查加密方式,param +t+key+ secret的順序進(jìn)行MD5加密,加密后字符串轉(zhuǎn)32位大寫,不用加上“+”號(hào) |
| 600 | 您不是合法的客戶(即授權(quán)key出錯(cuò)) | 賬號(hào)無(wú)可用單量,需要充值 |
| 601 | KEY已過(guò)期 | 賬號(hào)無(wú)可用單量,需要充值 |
| 601 | 電子面單賬號(hào)校驗(yàn)失敗,請(qǐng)確認(rèn)賬號(hào)信息是否正確 | 傳入的電子面單賬號(hào)信息錯(cuò)誤,請(qǐng)聯(lián)系當(dāng)?shù)鼐W(wǎng)點(diǎn)獲得正確的賬號(hào)信息。 |
| 602 | 電子面單數(shù)量余額不足,請(qǐng)聯(lián)系合作網(wǎng)點(diǎn)客服充值 | 申請(qǐng)的快遞公司網(wǎng)點(diǎn)電子面單賬號(hào)的電子面單數(shù)量不足,需要去網(wǎng)點(diǎn)充值面單數(shù)量。 |
| 603 | 無(wú)法獲取行政信息 | 請(qǐng)?zhí)顚懺敿?xì)的省市區(qū)信息 |
| 604 | 該快遞公司不支持子單號(hào) | 請(qǐng)查看1.2支持子單的快遞公司 |
| 605 | 該快遞公司不支持回單 | 請(qǐng)查看1.2支持回單的快遞公司 |
| 606 | 業(yè)務(wù)類型錯(cuò)誤 | 從參數(shù)字典選擇合適的業(yè)務(wù)類型 |
| 607 | 收件人手機(jī)號(hào)或電話不能同時(shí)為空 | 傳入收件人手機(jī)號(hào)或者電話 |
| 610 | 菜鳥(niǎo)電子面單認(rèn)證信息過(guò)期,請(qǐng)重新授權(quán) | 菜鳥(niǎo)授權(quán)一年有效,到期重新授權(quán) |
| 697 | 電子面單請(qǐng)求失敗,請(qǐng)重新打印 | 請(qǐng)根據(jù)技術(shù)文檔請(qǐng)求,注意參數(shù)類型及是否必填。 |
官方文檔:
https://api.kuaidi100.com/document/5f0ff6adbc8da837cbd8aef8.html
總結(jié)
以上是生活随笔為你收集整理的电商快递物流的电子面单打印接口API案例代码的全部?jī)?nèi)容,希望文章能夠幫你解決所遇到的問(wèn)題。
- 上一篇: 关于7.0去掉Chrome后,平台默认浏
- 下一篇: 无线产品认证logo