2019年码报生肖表图|码报资料2019彩图
打印類接口
-云打印API(new)
物流跟蹤類接口
-訂閱推送API
-實時查詢API
增值服務接口
-短信接口API

快遞100云打印API,簡稱云打印API

  • 簡介:云打印API是通過接口可以滿足企業、電商、微商等用戶的快遞單、發貨單、發票等業務單據的打印需求,提升打印效率與打印質量。是專為企業提供的一體化、智能化的打印解決方案。
一、云打印API產品介紹

云打印API是專為寄件企業及快遞網點打造的智能化物流打印跟蹤解決方案。通過接口可以滿足企業、電商、微商、快遞網點、代收點等用戶的快遞單、發貨單、發票等業務單據打印需求,提升打印效率與打印質量,為企業提供一體化、智能化打印解決方案。

和傳統的快遞電子面單打印相比,快遞100云打印API最大的優勢,就是“無限制打印模式”。它可以幫助傳統電子面單打印機完全不用連接電腦、徹底擺脫安轉驅動的束縛,真正實現不受限制的打單操作。形成無視距離的無線化遠程打印、多人多部門的共享打印、自動打印、手機打印、便攜打印等多種打印方式,完美貼合企業方寄件打印的各種使用場景。大大降低系統切換、設備切換帶來的工作效率硬損耗,大大降低減低人工、設備、時效和管理成本。

免費申請API
二、接口說明
2.1 帶打印功能電子面單接口
通過快遞公司或網點、菜鳥與淘寶提供的電子面單賬號,提交生成電子面單,調用云打印機打印輸出,可自定義面單模板,支持遠程打印機和共享打印。
2.1.1 接口格式
提供統一格式的HTTP POST或GET調用接口,并返回統一格式JSON數據。
2.1.2 請求地址
https://poll.kuaidi100.com/printapi/printtask.do
參數名 是否必填 類型 說明
method string 業務類型(默認:eOrder)
key string 授權碼,請到快遞100頁面申請企業版接口獲取 http://www.ddwju.tw/openapi
sign string 32位大寫,簽名,用于驗證身份,按MD5 (param +t+key+ secret)的順序進行MD5加密,不需要加上“+”號,secret在授權郵件里面有
t string 時間戳如:1576123932000
param string 由其他字段拼接
param數據結構:
type為10時(電子面單)格式:
參數名 是否必填 類型 說明
type string 內容打印默認參數,10默認是電子面單
partnerId string 電子面單客戶賬戶或月結賬號,需向快遞公司在貴司當地的網點申請;
若所選快遞公司為京東或德邦全國快遞,可聯系快遞100進行賬號授權操作,則此項可不填。
其他請查看參數字典
partnerKey string 電子面單密碼,需向快遞公司在貴司當地的網點申請;
若所選快遞公司為京東或德邦全國快遞,可聯系快遞100進行賬號授權操作,則此項可不填。
其他請查看參數字典
net string 收件網點名稱,由快遞公司當地網點分配, 若使用淘寶授權填入(taobao),使用菜鳥授權填入(cainiao)。
其他請查看參數字典
kuaidicom string 快遞公司的編碼,一律用小寫字母,見《快遞公司編碼》
recMan name string 收件人姓名
mobile string 收件人的手機號,手機號和電話號二者其一必填
tel string 收件人的電話號,手機號和電話號二者其一必填
zipCode string 收件人所在地的編箱號
province string 收件人所在省份,如廣東省,province, city, district, addr 和 printAddr 任選一個必填
city string 收件人所在市,如深圳市, province, city, district, addr 和 printAddr 任選一個必填
district string 收件人所在區,如南山區, province, city, district, addr 和 printAddr 任選一個必填
addr string 收件人所在地址,如科技南十二路2號金蝶軟件園, province, city, district, addr 和 printAddr 任選一個必填
printAddr string 收件人所在完整地址,如廣東深圳市深圳市南山區科技南十二路2號金蝶軟件園, province, city, district, addr 和 printAddr 任選一個必填。如果有填寫province、city、district、addr 則系統優先讀取province, city、district、addr;如果只填寫printAddr,系統將自動識別對應的省、市與區
company string 收件人所在公司名稱
sendMan name string 寄件人姓名
mobile string 寄件人的手機號,手機號和電話號二者其一必填
tel string 寄件人的電話號,手機號和電話號二者其一必填
zipCode string 寄件人所在地的郵編號
province string 寄件人所在省份,如廣東省,province, city, district, addr 和 printAddr 任選一個必填。
city string 寄件人所在市,如深圳市, province, city, district, addr 和 printAddr 任選一個必填
district string 寄件人所在區,如南山區, province, city, district, addr 和 printAddr 任選一個必填
addr string 寄件人所在地址,如高新南十八道20號xxx, province, city, district, addr 和 printAddr 任選一個必填
printAddr string 寄件人所在的完整地址,如廣東深圳市深圳市南山區科技南十二路2號金蝶軟件園B10, province, city, district, addr 和 printAddr 任選一個必填。如果有填寫province、city、district、addr 則系統優先讀取province, city、district、addr;如果只填寫printAddr,系統將自動識別對應的省、市與區
company string 寄件人所在公司名稱
cargo string 物品名稱
count string 物品總數量,int類型,必填;如果需要子單(指同一個訂單打印出多張電子面單,即同一個訂單返回多個面單號),needChild = 1、count 需要大于1,如count = 2 則一個主單 一個子單,count = 3則一個主單 二個子單;返回的子單號碼見返回結果的childNum字段
weight string 物品總重量KG,double類型
volumn string 物品總體積,CM*CM*CM,double類型
payType string 支付方式:SHIPPER:寄方付(默認)、CONSIGNEE:到付、MONTHLY:月結、THIRDPARTY:第三方支付(詳細看參數字典)
expType string 快遞類型:標準快遞(默認)、順豐特惠、EMS經濟(詳細看參數字典)
remark string 備注
valinsPay double 保價額度
collection double 代收貨款額度
needChild string 是否需要子單:1:需要、0:不需要(默認) ,String類型,非必填;如果需要子單(指同一個訂單打印出多張電子面單,即同一個訂單返回多個面單號),needChild = 1、count 需要大于1,如count = 2 一個主單 一個子單,count = 3 一個主單 二個子單,返回的子單號碼見返回結果的childNum字段
needBack string 是否需要回單:1:需要、 0:不需要(默認) ,String類型,非必填;返回的回單號見返回結果的returnNum字段
orderId string 貴司內部自定義的訂單編號,需要保證唯一性,非必填
tempid string 通過管理后臺的打印摸版配置信息獲取
height string 打印紙的高度
width string 打印紙的寬度
siid string 打印設備,通過打印機輸出的設備碼進行獲取
salt string 簽名用隨機字符串
op string 是否開啟訂閱功能,默認是:0(不開啟),如果是1說明開啟訂閱功能此時pollCallBackUrl必須填入,此功能只針對有快遞單號的單
callBackUrl string 打印狀態回調地址
pollCallBackUrl string 如果op設置為1時,pollCallBackUrl必須填入
resultv2 string 添加此字段表示開通行政區域解析功能,見3.1.2相關說明。
0:關閉(默認),1:開通行政區域解析功能,2:開通行政解析功能并且返回出發、目的及當前城市信息
****** string 其他面單參數顯示,可以到后臺-面單模板選擇該模板,下方有對應產生列表
type為30時(內容)格式:
參數名 是否必填 類型 說明
type string 內容打印默認參數,參數為30
kuaidicom string 快遞公司的編碼,一律用小寫字母,見《快遞公司編碼》
kuaidinum string 快遞單號,單號的最大長度是32個字符
recMan name string 收件人姓名
mobile string 收件人的手機號,手機號和電話號二者其一必填
tel string 收件人的電話號,手機號和電話號二者其一必填
zipCode string 收件人所在地的編箱號
province string 收件人所在省份,如廣東省,province, city, district, addr 和 printAddr 任選一個必填
city string 收件人所在市,如深圳市, province, city, district, addr 和 printAddr 任選一個必填
district string 收件人所在區,如南山區, province, city, district, addr 和 printAddr 任選一個必填
addr string 收件人所在地址,如科技南十二路2號金蝶軟件園, province, city, district, addr 和 printAddr 任選一個必填
printAddr string 收件人所在完整地址,如廣東深圳市深圳市南山區科技南十二路2號金蝶軟件園, province, city, district, addr 和 printAddr 任選一個必填。如果有填寫province、city、district、addr 則系統優先讀取province, city、district、addr;如果只填寫printAddr,系統將自動識別對應的省、市與區
company string 收件人所在公司名稱
sendMan name string 寄件人姓名
mobile string 寄件人的手機號,手機號和電話號二者其一必填
tel string 寄件人的電話號,手機號和電話號二者其一必填
zipCode string 寄件人所在地的郵編號
province string 寄件人所在省份,如廣東省,province, city, district, addr 和 printAddr 任選一個必填。
city string 寄件人所在市,如深圳市, province, city, district, addr 和 printAddr 任選一個必填
district string 寄件人所在區,如南山區, province, city, district, addr 和 printAddr 任選一個必填
addr string 寄件人所在地址,如高新南十八道20號xxx, province, city, district, addr 和 printAddr 任選一個必填
printAddr string 寄件人所在的完整地址,如廣東深圳市深圳市南山區科技南十二路2號金蝶軟件園B10, province, city, district, addr 和 printAddr 任選一個必填。如果有填寫province、city、district、addr 則系統優先讀取province, city、district、addr;如果只填寫printAddr,系統將自動識別對應的省、市與區
company string 寄件人所在公司名稱
cargo string 物品名稱
count string 物品總數量,int類型,必填;如果需要子單(指同一個訂單打印出多張電子面單,即同一個訂單返回多個面單號),needChild = 1、count 需要大于1,如count = 2 則一個主單 一個子單,count = 3則一個主單 二個子單;返回的子單號碼見返回結果的childNum字段
weight string 物品總重量KG,double類型
volumn string 物品總體積,CM*CM*CM,double類型
payType string 支付方式:SHIPPER:寄方付(默認)、CONSIGNEE:到付、MONTHLY:月結、THIRDPARTY:第三方支付(詳細看參數字典
expType string 快遞類型:標準快遞(默認)、順豐特惠、EMS經濟(詳細看參數字典
remark string 備注
valinsPay double 保價額度
collection double 代收貨款額度
needBack string 是否需要回單:1:需要、 0:不需要(默認) ,String類型,非必填;返回的回單號見返回結果的returnNum字段
orderId string 貴司內部自定義的訂單編號,需要保證唯一性,非必填
tempid string 通過管理后臺的打印摸版配置信息獲取
height string 打印紙的高度
width string 打印紙的寬度
siid string 打印設備,通過打印機輸出的設備碼進行獲取
salt string 簽名用隨機字符串
op string 是否開啟訂閱功能,默認是:0(不開啟),如果是1說明開啟訂閱功能此時pollCallBackUrl必須填入,此功能只針對有快遞單號的單
callBackUrl string 打印狀態回調地址
pollCallBackUrl string 如果op設置為1時,pollCallBackUrl必須填入
resultv2 string 添加此字段表示開通行政區域解析功能,見3.1.2相關說明。
0:關閉(默認),1:開通行政區域解析功能,2:開通行政解析功能并且返回出發、目的及當前城市信息
****** string 其他面單參數顯示,可以到后臺-面單模板選擇該模板,下方有對應產生列表
2.1.3 返回結果
字段 類型 說明 備注
result boolean 提交結果 true提交成功,false失敗
returnCode string 返回編碼
message string 返回報文描述
data data
data數據結構
字段 類型 說明 備注
taskId string 任務ID
kuaidicom string 快遞公司編碼
kuaidinum string 快遞單號
****** ****** 其他報文

2.1.4 提供數據內容

      {
        "result":true,
        "returnCode":"200",
        "message":"提交成功",
        "data":{
          "taskId":"****",	//任務ID
          "kuaidicom":"****",	//快遞公司編碼
          "kuaidinum":"****" //快遞單號
          ******
        }
      }
         
說明:
  200: 提交成功
  400: Print:參數錯誤
  600: 您不是合法的用戶(即授權Key出錯)
  601: Print:KEY已過期
  500: 服務器錯誤(即快遞100的服務器出理間隙或臨時性異常,有時如果因為不按規范提交請求,比如快遞公司參數寫錯等,也會報此錯誤)
  501:重復提交
  503: 驗證簽名失敗
2.2 自定義生成圖片接口
通過快遞公司或網點、菜鳥與淘寶提供的電子面單賬號,提交生成電子面單;通過管理后臺模板配置,自定義面單摸版,生成圖片輸出,可自選方式打印。
2.2.1 接口格式
提供統一格式的HTTP POST或GET調用接口,并返回統一格式JSON數據。
2.2.2 請求地址
https://poll.kuaidi100.com/printapi/printtask.do
請求參數:
參數名 是否必填 類型 說明
method string 業務類型(默認:getPrintImg)
key string 授權碼,請到快遞100頁面申請企業版接口獲取 http://www.ddwju.tw/openapi
sign string 32位大寫,簽名,用于驗證身份,按MD5 (param +t+key+ secret)的順序進行MD5加密,不需要加上“+”號,secret在授權郵件里面有
t string 時間戳如:1576123932000
param param 由其他字段拼接
param數據結構:
type為10時(電子面單)格式:
參數名 是否必填 類型 說明
type string 內容打印默認參數,10默認是電子面單
partnerId string 電子面單客戶賬戶或月結賬號,需向快遞公司在貴司當地的網點申請;
若所選快遞公司為京東或德邦全國快遞,可聯系快遞100進行賬號授權操作,則此項可不填。
其他請查看參數字典
partnerKey string 電子面單密碼,需向快遞公司在貴司當地的網點申請;
若所選快遞公司為京東或德邦全國快遞,可聯系快遞100進行賬號授權操作,則此項可不填。
其他請查看參數字典
net string 收件網點名稱,由快遞公司當地網點分配, 若使用淘寶授權填入(taobao),使用菜鳥授權填入(cainiao)。
其他請查看參數字典
kuaidicom string 快遞公司的編碼,一律用小寫字母,見《快遞公司編碼》
recManName string 收件人姓名
recManMobile string 收件人的手機號,手機號和電話號二者其一必填
recManTel string 收件人的電話號,手機號和電話號二者其一必填
recManZipCode string 收件人所在地的編箱號
recManProvince string 收件人所在省份,如廣東省,province, city, district, addr 和 printAddr 任選一個必填
recManCity string 收件人所在市,如深圳市, province, city, district, addr 和 printAddr 任選一個必填
recManDistrict string 收件人所在區,如南山區, province, city, district, addr 和 printAddr 任選一個必填
recManAddr string 收件人所在地址,如科技南十二路2號金蝶軟件園, province, city, district, addr 和 printAddr 任選一個必填
recManPrintAddr string 收件人所在完整地址,如廣東深圳市深圳市南山區科技南十二路2號金蝶軟件園, province, city, district, addr 和 printAddr 任選一個必填。如果有填寫province、city、district、addr 則系統優先讀取province, city、district、addr;如果只填寫printAddr,系統將自動識別對應的省、市與區
recManCompany string 收件人所在公司名稱
sendManName string 寄件人姓名
sendManMobile string 寄件人的手機號,手機號和電話號二者其一必填
sendManTel string 寄件人的電話號,手機號和電話號二者其一必填
sendManZipCode string 寄件人所在地的郵編號
sendManProvince string 寄件人所在省份,如廣東省,province, city, district, addr 和 printAddr 任選一個必填。
sendManCity string 寄件人所在市,如深圳市, province, city, district, addr 和 printAddr 任選一個必填
sendManDistrict string 寄件人所在區,如南山區, province, city, district, addr 和 printAddr 任選一個必填
sendManAddr string 寄件人所在地址,如高新南十八道20號xxx, province, city, district, addr 和 printAddr 任選一個必填
sendManPrintAddr string 寄件人所在的完整地址,如廣東深圳市深圳市南山區科技南十二路2號金蝶軟件園B10, province, city, district, addr 和 printAddr 任選一個必填。如果有填寫province、city、district、addr 則系統優先讀取province, city、district、addr;如果只填寫printAddr,系統將自動識別對應的省、市與區
sendManCompany string 寄件人所在公司名稱
cargo string 物品名稱
count string 物品總數量,int類型,必填;如果需要子單(指同一個訂單打印出多張電子面單,即同一個訂單返回多個面單號),needChild = 1、count 需要大于1,如count = 2 則一個主單 一個子單,count = 3則一個主單 二個子單;返回的子單號碼見返回結果的childNum字段
weight string 物品總重量KG,double類型
volumn string 物品總體積,CM*CM*CM,double類型
payType string 支付方式:SHIPPER:寄方付(默認)、CONSIGNEE:到付、MONTHLY:月結、THIRDPARTY:第三方支付(詳細看參數字典)
expType string 快遞類型:標準快遞(默認)、順豐特惠、EMS經濟(詳細看參數字典)
remark string 備注
valinsPay double 保價額度
collection double 代收貨款額度
needChild string 是否需要子單:1:需要、0:不需要(默認) ,String類型,非必填;如果需要子單(指同一個訂單打印出多張電子面單,即同一個訂單返回多個面單號),needChild = 1、count 需要大于1,如count = 2 一個主單 一個子單,count = 3 一個主單 二個子單,返回的子單號碼見返回結果的childNum字段
needBack string 是否需要回單:1:需要、 0:不需要(默認) ,String類型,非必填;返回的回單號見返回結果的returnNum字段
orderId string 貴司內部自定義的訂單編號,需要保證唯一性,非必填
tempid string 通過管理后臺的打印摸版配置信息獲取
height string 打印紙的高度
width string 打印紙的寬度
salt string 簽名用隨機字符串
op string 是否開啟訂閱功能,默認是:0(不開啟),如果是1說明開啟訂閱功能此時pollCallBackUrl必須填入,此功能只針對有快遞單號的單
pollCallBackUrl string 如果op設置為1時,pollCallBackUrl必須填入
resultv2 string 添加此字段表示開通行政區域解析功能,見3.1.2相關說明。
0:關閉(默認),1:開通行政區域解析功能,2:開通行政解析功能并且返回出發、目的及當前城市信息
****** string 其他面單參數顯示,可以到后臺-面單模板選擇該模板,下方有對應產生列表
type為30時(內容)格式:
參數名 是否必填 類型 說明
type string 內容打印默認參數,參數為30
kuaidicom string 快遞公司的編碼,一律用小寫字母,見《快遞公司編碼》
kuaidinum string 快遞單號,單號的最大長度是32個字符
orderId string 貴司內部自定義的訂單編號,需要保證唯一性,非必填
tempid string 通過管理后臺的打印摸版配置信息獲取
height string 打印紙的高度
width string 打印紙的寬度
salt string 簽名用隨機字符串
op string 是否開啟訂閱功能,默認是:0(不開啟),如果是1說明開啟訂閱功能此時pollCallBackUrl必須填入,此功能只針對有快遞單號的單
pollCallBackUrl string 如果op設置為1時,pollCallBackUrl必須填入
resultv2 string 添加此字段表示開通行政區域解析功能,見3.1.2相關說明。
0:關閉(默認),1:開通行政區域解析功能,2:開通行政解析功能并且返回出發、目的及當前城市信息
****** string 其他面單參數顯示,可以到后臺-面單模板選擇該模板,下方有對應產生列表
2.2.3 返回結果
字段 類型 說明 備注
result boolean 提交結果 true提交成功,false失敗
returnCode string 返回編碼
message string 返回報文描述
data data
data數據結構
字段 類型 說明 備注
taskId string 任務ID
kuaidicom string 快遞公司編碼
kuaidinum string 快遞單號
imgBase64 string 面單BASE64編碼圖片
****** ****** 其他報文
2.2.4 提供數據內容
      {
        "result":true,
        "returnCode":"200",
        "message":"提交成功",
        "data":{
          "taskId":"****",	//任務ID
          "kuaidicom":"****",	//快遞公司編碼
          "kuaidinum":"****" //快遞單號
          "imgBase64":"****", //面單BASE64編碼圖片
          ******
        }
      }
         
說明:
  200: 提交成功
  400: Print:參數錯誤
  600: 您不是合法的用戶(即授權Key出錯)
  601: Print:KEY已過期
  500: 服務器錯誤(即快遞100的服務器出理間隙或臨時性異常,有時如果因為不按規范提交請求,比如快遞公司參數寫錯等,也會報此錯誤)
  501:重復提交
  503: 驗證簽名失敗
2.3 自定義打印接口
如有打印發貨單,發票等其他類打印需求,可使用該接口。通過管理后臺模板配置,配置自定義摸版,實現自定義打印功能。
2.3.1 接口格式
提供統一格式的HTTP POST或GET調用接口,并返回統一格式JSON數據。
2.3.2 請求地址
https://poll.kuaidi100.com/printapi/printtask.do
請求參數:
參數名 是否必填 類型 說明
method string 業務類型(默認:printOrder)
key string 授權碼,請到快遞100頁面申請企業版接口獲取 http://www.ddwju.tw/openapi
sign string 32位大寫,簽名,用于驗證身份,按MD5 (param +t+key+ secret)的順序進行MD5加密,不需要加上“+”號,secret在授權郵件里面有
t string 時間戳如:1576123932000
param param 由其他字段拼接
param數據結構:
參數名 是否必填 類型 說明
kuaidicom string 快遞公司的編碼,一律用小寫字母,見《快遞公司編碼》
kuaidinum string 快遞單號,單號的最大長度是32個字符
orderId string 貴司內部自定義的訂單編號,需要保證唯一性,非必填
tempid string 通過管理后臺的打印摸版配置信息獲取
height string 打印紙的高度
width string 打印紙的寬度
salt string 簽名用隨機字符串
siid string 打印設備,通過打印機輸出的設備碼進行獲取
op string 是否開啟訂閱功能,默認是:0(不開啟),如果是1說明開啟訂閱功能此時pollCallBackUrl必須填入,此功能只針對有快遞單號的單
callBackUrl string 打印狀態回調地址
pollCallBackUrl string 如果op設置為1時,pollCallBackUrl必須填入
resultv2 string 添加此字段表示開通行政區域解析功能,見3.1.2相關說明。
0:關閉(默認),1:開通行政區域解析功能,2:開通行政解析功能并且返回出發、目的及當前城市信息
****** string 其他面單參數顯示,可以到后臺-面單模板選擇該模板,下方有對應產生列表
2.3.3 返回結果
字段 類型 說明 備注
result boolean 提交結果 true提交成功,false失敗
returnCode string 返回編碼
message string 返回報文描述
data data
data數據結構
字段 類型 說明 備注
taskId string 任務ID
kuaidicom string 快遞公司編碼
kuaidinum string 快遞單號
****** **** 其他報文
2.3.4 提供數據內容
      {
        "result":true,
        "returnCode":"200",
        "message":"提交成功",
        "data":{
          "taskId":"****",	//任務ID
          "kuaidicom":"****",	//快遞公司編碼
          "kuaidinum":"****" //快遞單號
          ******
        }
      }
         
說明:
  200: 提交成功
  400: Print:參數錯誤
  600: 您不是合法的用戶(即授權Key出錯)
  601: Print:KEY已過期
  500: 服務器錯誤(即快遞100的服務器出理間隙或臨時性異常,有時如果因為不按規范提交請求,比如快遞公司參數寫錯等,也會報此錯誤)
  501: 重復提交
  503: 驗證簽名失敗
2.4 附件打印接口
為各應用產品提供的智能化打印解決方案。對接后可以讓企業、個人實現PC/手機無線打印,遠程打印,多人共享打印。打印內容包括但不限于文檔、發票、發貨單、快遞單等,搭配云盒使用,支持激光、噴墨、針式、熱敏打印機類型。讓企業和個人打印更高效、更便捷。
通過接口上傳打印內容,圖片或PDF、Word等文件,即可打印該內容。
2.4.1 接口格式
提供統一格式的HTTP POST或GET調用接口,并返回統一格式JSON數據。
2.4.2 請求地址
https://poll.kuaidi100.com/printapi/printtask.do
請求參數:
參數名 是否必填 類型 說明
method string 業務類型(默認:printOrder)
key string 授權碼,請到快遞100頁面申請企業版接口獲取 http://www.ddwju.tw/openapi
sign string 32位大寫,簽名,用于驗證身份,按MD5 (param +t+key+ secret)的順序進行MD5加密,不需要加上“+”號,secret在授權郵件里面有
t string 時間戳如:1576123932000
param param 由其他字段拼接
file file 需要打印的附件
param數據結構:
參數名 是否必填 類型 說明
kuaidicom string 快遞公司的編碼,一律用小寫字母,見《快遞公司編碼》
kuaidinum string 快遞單號,單號的最大長度是32個字符
orderId string 貴司內部自定義的訂單編號,需要保證唯一性,非必填
height string 打印紙的高度
width string 打印紙的寬度
copyNum string 需要打印的份數,默認是一份
startPage string 打印范圍,起始頁,僅對多頁文件支持,默認是打印整個文檔
endPage string 打印范圍,結束頁,僅對多頁文件支持,默認是打印整個文檔
salt string 簽名用隨機字符串
siid string 打印設備,通過打印機輸出的設備碼進行獲取
op string 是否開啟訂閱功能,默認是:0(不開啟),如果是1說明開啟訂閱功能此時pollCallBackUrl必須填入,此功能只針對有快遞單號的單
callBackUrl string 打印狀態回調地址
pollCallBackUrl string 如果op設置為1時,pollCallBackUrl必須填入
resultv2 string 添加此字段表示開通行政區域解析功能,見3.1.2相關說明。
0:關閉(默認),1:開通行政區域解析功能,2:開通行政解析功能并且返回出發、目的及當前城市信息
2.4.3 返回結果
字段 類型 說明 備注
result boolean 提交結果 true提交成功,false失敗
returnCode string 返回編碼
message string 返回報文描述
data data
data數據結構
字段 類型 說明 備注
taskId string 任務ID
kuaidicom string 快遞公司編碼
kuaidinum string 快遞單號
****** **** 其他報文
2.4.4 提供數據內容
      {
        "result":true,
        "returnCode":"200",
        "message":"提交成功",
        "data":{
          "taskId":"****",	//任務ID
          "kuaidicom":"****",	//快遞公司編碼
          "kuaidinum":"****" //快遞單號
          ******
        }
      }
         
說明:
  200: 提交成功
  400: Print:參數錯誤
  600: 您不是合法的用戶(即授權Key出錯)
  601: Print:KEY已過期
  500: 服務器錯誤(即快遞100的服務器出理間隙或臨時性異常,有時如果因為不按規范提交請求,比如快遞公司參數寫錯等,也會報此錯誤)
  501: 重復提交
  503: 驗證簽名失敗
2.5 打印接口回調
通過上述接口提交的打印請求,進行打印狀態返回。
2.5.1 接口格式
提供統一格式的HTTP POST或GET調用接口,并返回統一格式JSON數據。
2.5.2 請求地址
例如:
      <form method="post" name="" action="[callbackurl]">
        <input type="text" name="taskId" value="{XXX}" >
        <input type="text" name="param" value="{XXX}" >
        <input type="text" name="sign" value="簽名字符串" />
      </form>
          
請求參數:
字段 類型 說明 備注
taskId string 任務ID
sign string 32位大寫,簽名,用于驗證身份,按MD5 (param +t+key+ secret)的順序進行MD5加密,不需要加上“+”號,secret在授權郵件里面有
param param 由其他字段拼接
param數據結構:
參數名 是否必填 類型 說明
status string 狀態編碼,200:打印成功,201打印不成功。
message string 狀態描述。
kuaidicom string 快遞公司的編碼,一律用小寫字母,見《快遞公司編碼》
kuaidinum string 快遞單號,單號的最大長度是32個字符
2.5.3 返回結果
字段 說明 備注
result 提交結果 true提交成功,false失敗
returnCode 返回編碼
message 返回報文描述
2.5.4 提供數據內容
      {
        "result":true,
        "returnCode":"200",
        "message":"成功"
      }
         
說明:
  200: 提交成功
  500: 服務器錯誤
  其他錯誤請自行定義
result:true表示回調成功,false表示失敗,如果提交回調接口的地址失敗,30分鐘后重新回調,3次仍舊失敗的,自動放棄。
其他信息快遞100會忽略。
2.6 電子面單接口
通過快遞公司或網點、菜鳥與淘寶提供的電子面單賬號,提交生成電子面單號,返回固定面單模板,調用本地打印機即可打印出電子面單。
2.6.1 接口格式
提供統一格式的HTTP POST或GET調用接口,并返回統一格式JSON數據。
2.6.2 請求地址
http://poll.kuaidi100.com/eorderapi.do
請求參數:
參數名 是否必填 類型 說明
method string 業務類型(默認:getElecOrder)
key string 授權碼,請到快遞100頁面申請企業版接口獲取 http://www.ddwju.tw/openapi
sign string 32位大寫,簽名,用于驗證身份,按MD5 (param +t+key+ secret)的順序進行MD5加密,不需要加上“+”號,secret在授權郵件里面有
t string 時間戳如:1576123932000
param string 由其他字段拼接
param數據結構:
參數名 是否必填 類型 說明
partnerId string 電子面單客戶賬戶或月結賬號,需向快遞公司在貴司當地的網點申請;
若所選快遞公司為京東或德邦全國快遞,可聯系快遞100進行賬號授權操作,則此項可不填。
其他請查看參數字典
partnerKey string 電子面單密碼,需向快遞公司在貴司當地的網點申請;
若所選快遞公司為京東或德邦全國快遞,可聯系快遞100進行賬號授權操作,則此項可不填。
其他請查看參數字典
net string 收件網點名稱,由快遞公司當地網點分配, 若使用淘寶授權填入(taobao),使用菜鳥授權填入(cainiao)。
其他請查看參數字典
kuaidicom string 快遞公司的編碼,一律用小寫字母,見《快遞公司編碼》
recMan name string 收件人姓名
mobile string 收件人的手機號,手機號和電話號二者其一必填
tel string 收件人的電話號,手機號和電話號二者其一必填
zipCode string 收件人所在地的編箱號
province string 收件人所在省份,如廣東省,province, city, district, addr 和 printAddr 任選一個必填
city string 收件人所在市,如深圳市, province, city, district, addr 和 printAddr 任選一個必填
district string 收件人所在區,如南山區, province, city, district, addr 和 printAddr 任選一個必填
addr string 收件人所在地址,如科技南十二路2號金蝶軟件園, province, city, district, addr 和 printAddr 任選一個必填
printAddr string 收件人所在完整地址,如廣東深圳市深圳市南山區科技南十二路2號金蝶軟件園, province, city, district, addr 和 printAddr 任選一個必填。如果有填寫province、city、district、addr 則系統優先讀取province, city、district、addr;如果只填寫printAddr,系統將自動識別對應的省、市與區
company string 收件人所在公司名稱
sendMan name string 寄件人姓名
mobile string 寄件人的手機號,手機號和電話號二者其一必填
tel string 寄件人的電話號,手機號和電話號二者其一必填
zipCode string 寄件人所在地的郵編號
province string 寄件人所在省份,如廣東省,province, city, district, addr 和 printAddr 任選一個必填。
city string 寄件人所在市,如深圳市, province, city, district, addr 和 printAddr 任選一個必填
district string 寄件人所在區,如南山區, province, city, district, addr 和 printAddr 任選一個必填
addr string 寄件人所在地址,如高新南十八道20號xxx, province, city, district, addr 和 printAddr 任選一個必填
printAddr string 寄件人所在的完整地址,如廣東深圳市深圳市南山區科技南十二路2號金蝶軟件園B10, province, city, district, addr 和 printAddr 任選一個必填。如果有填寫province、city、district、addr 則系統優先讀取province, city、district、addr;如果只填寫printAddr,系統將自動識別對應的省、市與區
company string 寄件人所在公司名稱
cargo string 物品名稱
count string 物品總數量,int類型,必填;如果需要子單(指同一個訂單打印出多張電子面單,即同一個訂單返回多個面單號),needChild = 1、count 需要大于1,如count = 2 則一個主單 一個子單,count = 3則一個主單 二個子單;返回的子單號碼見返回結果的childNum字段
weight string 物品總重量KG,double類型
volumn string 物品總體積,CM*CM*CM,double類型
payType string 支付方式:SHIPPER:寄方付(默認)、CONSIGNEE:到付、MONTHLY:月結、THIRDPARTY:第三方支付(詳細看參數字典
expType string 快遞類型:標準快遞(默認)、順豐特惠、EMS經濟(詳細看參數字典
remark string 備注
valinsPay double 保價額度
collection double 代收貨款額度
needChild string 是否需要子單:1:需要、0:不需要(默認) ,String類型,非必填;如果需要子單(指同一個訂單打印出多張電子面單,即同一個訂單返回多個面單號),needChild = 1、count 需要大于1,如count = 2 一個主單 一個子單,count = 3 一個主單 二個子單,返回的子單號碼見返回結果的childNum字段
needBack string 是否需要回單:1:需要、 0:不需要(默認) ,String類型,非必填;返回的回單號見返回結果的returnNum字段
orderId string 貴司內部自定義的訂單編號,需要保證唯一性,非必填
neetTemplate string 是否需要打印模板:1:需要、 0 不需要(默認) ,如果需要,則返回要打印的模版的HTML代碼,貴司可以直接將之顯示到IE等瀏覽器,然后通過瀏覽器進行打印
salt string 簽名用隨機字符串
op string 是否開啟訂閱功能,默認是:0(不開啟),如果是1說明開啟訂閱功能此時pollCallBackUrl必須填入,此功能只針對有快遞單號的單
callBackUrl string 打印狀態回調地址
pollCallBackUrl string 如果op設置為1時,pollCallBackUrl必須填入
resultv2 string 添加此字段表示開通行政區域解析功能,見3.1.2相關說明。
0:關閉(默認),1:開通行政區域解析功能,2:開通行政解析功能并且返回出發、目的及當前城市信息
2.6.3 返回結果
字段 類型 說明 備注
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 電子面單模板內容
2.6.4 提供數據內容
1) 不帶模版返回
      {
        "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.ddwju.tw/XXX" 
          }
        ]
      }
         
2) 帶模版返回
      {
        "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文件后通過瀏覽器打開并顯示出來后的效果示例:順豐:
其他返回說明:
  200: 成功
  401:參數錯誤
  402:未指明服務
  601:電子面單賬號配置出錯/非法的數據簽名,請與快遞公司當地網點分配的賬號密碼核對
  602:電子面單可用單號不足,請聯系網點增加后繼續打印
  603:該訂單省市區信息不完整無法打印
  604:暫不支持子單號
  605:暫不支持回單
  606:快遞業務類型錯誤
  699:請求快遞公司失敗,請稍候重試
三、參數字典
快遞公司partnerId,partnerKey,net是否必填(*為必填)
快遞公司 partnerId partnerKey net
ane66(安能快遞) *
debangkuaidi(德邦快遞) *
ems(EMS) * *
guotongkuaidi(國通快遞) * * *
huitongkuaidi(百世快遞) * *
jd(京東物流) *
kuayue(跨越速運) * *
pjbest(品駿快遞) * *
shentong(申通快遞) * * *
shunfeng(順豐速運) *
suer(速爾快遞) * *
xinfengwuliu(信豐物流) * *
youshuwuliu(優速物流) * *
youzhengguonei(郵政快遞包裹) * *
yuantong(圓通速遞) * *
yuantongguoji(圓通國際) * *
yunda(韻達快遞) * *
zhaijisong(宅急送)
zhongtong(中通快遞) * *
ewe(EWE全球快遞) * *
quanyikuaidi(全一快遞) *

payType:
說明
SHIPPER 寄方付
CONSIGNEE 到付
MONTHLY 月結
THIRDPARTY 第三方支付

expType:
ne66(安能快遞) 標準快遞
次日達
次晨達
當日達
debangkuaidi(德邦快遞) 360特惠件
電商尊享
特準快件
德邦快遞
ems 標準快遞
EMS經濟
代收到付
快遞包裹
guotongkuaidi(國通快遞) 標準快遞
huitongkuaidi(百世快遞) 標準快遞
jd(京東物流) 標準快遞
京東到付
特準送
填倉
特配
鮮活
控溫
冷藏
冷凍
深冷
kuayue(跨越速運) 標準快遞
陸運件
同城次日
同城即日
隔日達
次日達
當天達
pjbest(品駿快遞) 標準快遞
標準快運
整車運輸
shentong(申通快遞) 標準快遞
shunfeng(順豐速運) 標準快遞
順豐特惠
電商特惠
順豐次晨
順豐即日
電商速配
順豐寶平郵
順豐寶掛號
醫藥常溫
醫藥溫控
物流普運
冷運宅配
生鮮速配
大閘蟹專遞
汽配專線
汽配吉運
全球順
行郵專列
醫藥專運(常溫)
醫藥專運(溫控)
國際特惠-文件
國際特惠-B類包裹
國際特惠-D類包裹
全球順保稅
全球順商家代理
電商專配
重貨包裹
順豐干配
suer(速爾快遞) 標準快遞
xinfengwuliu(信豐物流) 標準快遞
youshuwuliu(優速物流) 標準快遞
youzhengguonei(郵政快遞包裹) 快遞包裹
yuantong(圓通速遞) 標準快遞
yuantongguoji(圓通國際) 標準快遞
yunda(韻達快遞) 標準快遞
zhaijisong(宅急送) 標準快遞
zhongtong(中通快遞) 標準快遞
ewe(EWE全球快遞) 標準快遞
經濟奶粉
標準雜貨
經濟雜貨
快速奶粉
雜貨
quanyikuaidi(全一快遞) 標準快遞

關注快遞100接口API

2019年码报生肖表图