快递100 API
  1. 电子面单接口
快递100 API
  • 入门指南
    • 如何注册企业账号
    • 如何开通产品服务
    • 如何联系工作人员
    • 企业版和基础版的区别
  • 产品文档
    • 快递查询
      • 实时快递查询
        • 产品介绍
        • 接口文档
          • 实时快递查询接口
      • 快递信息推送服务
        • 产品介绍
        • 接口文档
          • 快递订阅查询快递api接口技术文档
          • 推送接口
      • 快递查询地图轨迹
        • 产品介绍
        • 接口文档
          • 快递查询地图轨迹技术文档
      • 地图轨迹推送服务
        • 产品介绍
        • 接口文档
          • 订阅接口
          • 推送接口
    • 电子面单与云打印
      • 电子面单
        • 产品介绍
        • 电子面单参数
        • 第三方平台账号授权
          • 第三方授权回调
          • 第三方平台网点&面单余额接口
          • 电子面单账号授权
        • 电子面单接口
          • 打印状态回调
          • 电子面单下单接口
            POST
          • 电子面单复打接口
            POST
        • 电子面单取消接口
          POST
      • 订单导入
        • 产品介绍
        • 接口文档
          • 提交售后(退货)订单获取任务接口
          • 售后(退货)订单获取结果推送接口
          • 快递单号回传及订单发货接口
          • 获取店铺授权超链接接口
          • 提交订单获取任务接口
          • 订单获取结果推送接口
      • 自定义打印
        • 产品介绍
        • 自定义模板打印
          • 自定义模板打印接口
          • 自定义模板打印复打接口
          • 打印状态回调
          • 硬件状态查询接口
        • 附件打印
          • 附件打印接口
          • 附件打印复打接口
          • 打印状态回调
          • 硬件状态查询接口
        • 指令打印
          • 指令打印接口
          • 指令打印复打接口
          • 打印状态回调
          • 硬件状态查询接口
      • 发货单
        • 产品介绍
        • 接口文档
          • 发货单接口
          • 打印回调接口
    • 物流服务
      • 商家寄件
        • 产品介绍
        • 接口文档
          • 快递公司编码
          • 商家寄件下单接口
          • 下单回调接口
          • 商家寄件下单取消接口
          • 商家寄件下单价格接口
          • 快递信息推送接口
          • 商家寄件订单详情查询接口
          • 电子面单复打接口
      • 同城配送
        • 产品介绍
        • 参数字典
        • 同城配送接账号授权
          • 授权回调接口
          • 同城配送账号授权接口
        • 同城配送下单
          • 下单回调接口
          • 同城配送下单
        • 同城配送查询订单
        • 同城配送取消下单接口
      • C端寄件
        • 产品文档
        • 接口文档
          • C端寄件下单接口
          • 下单回调接口
          • C端寄件下单取消接口
          • C端寄件价格查询接口
          • 快递信息推送接口
    • 跨境服务
      • 国际电子面单API
        • 产品介绍
        • 参考数字典
        • 接口文档
          • 国际电子面单下单API
          • 预约取件API
          • 取消预约PI
    • 增值服务
      • 短信提醒发送
        • 产品介绍
        • 接口文档
          • 快递100短信回调请求
          • 快递100短信发送接口
      • 智能单号识别
        • 产品介绍
        • 智能识别接口说明
      • 快递面单OCR识别
        • 产品介绍
        • 快递面单OCR识别接口
      • 快递可用性查询
        • 产品介绍
        • 快递可用性接口
  • 常见问题
    • 查询类问题
      • 实时快递查询
      • 快递信息推送服务
      • 智能单号识别
      • 短信提醒发送
      • Excel表格批量查询
    • 电子面单类问题
      • 电子面单
      • 快递面单模板
      • 参数配置
      • 云打印机/云盒
    • 地图轨迹类问题
      • 快递查询地图轨迹
    • 物流类服务
      • 同城配送
      • 商家寄件
      • 个人寄件
    • 云打印类问题
      • 自定义打印
      • 云打印
      • 发货单
    • 申请与审核
      • 企业版
      • 基础版
    • 支付与支票
      • 产品价格
      • 账单与充值
      • 发票问题
    • 政策与规范
      • 商家寄件服务协议
      • 用户协议
      • 授权声明
      • 隐私政策
      • 增值服务
      • 服务协议
      • 保密协议
    • 账号与密码
      • 账号密码
      • 授权问题
    • 快递公司入驻
      • 入驻资料及审核
      • 电子面单接口示例
      • 快递公司接入快递100实时查询接口
      • 快递公司接入快递100订阅推送接口
      • 手机app快递查询接口
  1. 电子面单接口

电子面单下单接口

POST
https://api.kuaidi100.com/label/order

通过快递公司或网点、菜鸟与淘宝提供的电子面单账号,支持只下单,或者生成图片使用本地打印设备打印输出,以及调用快递100云打印设备打印输出。使用快递100云打印则连接的设备必须是快递100云打印机或者快递100云盒。云盒可以支持不同品牌的打印机,具体支持品牌查询:云盒支持的打印机列表

param数据结构:

参数名是否必填类型说明
printType是string打印类型,NON:只下单不打印(默认); IMAGE:生成图片短链;HTML:生成html短链; CLOUD:使用快递100云打印机打印,使用CLOUD时siid必填
partnerId是string电子面单客户账户或月结账号,需贵司向当地快递公司网点申请(参考电子面单申请指南); 是否必填该属性,请查看参数字典
partnerKey否string电子面单密码,需贵司向当地快递公司网点申请; 是否必填该属性,请查看参数字典
partnerSecret否string电子面单密钥,需贵司向当地快递公司网点申请; 是否必填该属性,请查看参数字典
partnerName否string电子面单客户账户名称,需贵司向当地快递公司网点申请; 是否必填该属性,请查看参数字典
net否string收件网点名称,由快递公司当地网点分配, 若使用淘宝授权填入(taobao),使用菜鸟授权填入(cainiao), 使用京东授权填入(jdalpha),使用拼多多授权填入(pinduoduoWx),使用抖音授权填入(douyin),使用快手授权填入(kuaishou),使用唯品会授权填入(weipinhui)。 是否必填该属性,请查看参数字典 (若通过第三方授权方式获取单号partnerId,partnerKey参数为必填,参数值可通过第三方授权接口获取)
code否string电子面单承载编号,需贵司向当地快递公司网点申请; 是否必填该属性,请查看参数字典
checkMan否string电子面单承载快递员名,需贵司向当地快递公司网点申请; 是否必填该属性,请查看参数字典
tbNet否string在使用菜鸟/淘宝/拼多多授权电子面单时,若月结账号下存在多个网点,则tbNet="网点名称,网点编号" ,注意此处为英文逗号
kuaidicom是string快递公司的编码,一律用小写字母,请查看参数字典
ΘrecMan是recMan收件人信息
¬name是string收件人姓名
¬mobile是string收件人的手机号,手机号和电话号二者其一必填
¬tel是string收件人的电话号,手机号和电话号二者其一必填
¬printAddr是string收件人所在完整地址,如广东深圳市南山区科技南十二路金蝶软件园B10
¬company否string收件人所在公司名称
ΘsendMan是sendMan寄件人信息
¬name是寄件人姓名
¬mobile是string寄件人的手机号,手机号和电话号二者其一必填
¬tel是string寄件人的电话号,手机号和电话号二者其一必填
¬printAddr是string寄件人所在的完整地址,如广东深圳市南山区科技南十二路金蝶软件园B10
¬company否string寄件人所在公司名称
cargo是string物品名称,例:文件
count是int包裹总数量。该属性与子单有关,如果需要子单(指同一个订单打印出多张电子面单,即同一个订单返回多个面单号),needChild = 1、count 需要大于1,如count = 2 则一个主单 一个子单,count = 3则一个主单 二个子单;返回的子单号码见返回结果的childNum字段
weight否Double物品总重量KG,例:1.5,单位kg。极兔速递必填,其他快递公司非必填
payType否string支付方式: SHIPPER:寄方付(默认) CONSIGNEE:到付 MONTHLY:月结 THIRDPARTY:第三方支付 (详细请查看参数字典 )
expType否string产品类型: 如标准快递(默认) 顺丰标快(陆运) EMS经济 (详细请请查看参数字典 )
remark否string备注
siid否string打印设备,通过打印机输出的设备码进行获取,printType为CLOUD时必填
direction否string打印方向, 0:正方向(默认); 1:反方向;只有printType为CLOUD时该参数生效
tempId是string主单模板,通过管理后台的快递公司模板V2信息获取
childTempId否string子单模板,部分快递公司需指定。通过管理后台的快递公司模板V2信息获取
backTempId否string回单模板,部分快递公司需指定。通过管理后台的快递公司模板V2信息获取
面单扩展属性
valinsPay否double保价额度
collection否double代收货款额度
needChild否string是否需要子单: 1:需要 0:不需要(默认) 如果需要子单(指同一个订单打印出多张电子面单,即同一个订单返回多个面单号); needChild = 1、count 需要大于1,如count = 2 一个主单 一个子单,count = 3 一个主单 二个子单,返回的子单号码见返回结果的childNum字段
needBack否string是否需要回单: 1:需要 0:不需要(默认) 返回的回单号见返回结果的returnNum字段
orderId否string贵司内部自定义的订单编号,需要保证唯一性,非必填
callBackUrl否string数据回调地址(打印状态以及OCR识别结果)
salt否string签名用随机字符串,用于验证签名sign。salt值不为null时,推送数据将包含该加密签名,加密方式:md5(param+salt)。注意: salt值为空串时,推送的数据也会包含sign,此时可忽略sign的校验。
needSubscribe否boolean是否开启订阅功能 false:不开启(默认) true:开启 说明开启订阅功能时:pollCallBackUrl必须填入 此功能只针对有快递单号的单
pollCallBackUrl否string如果needSubscribe 设置为true时,pollCallBackUrl必须填入,用于跟踪回调
resultv2否string添加此字段表示开通行政区域解析或地图轨迹功能 。 0:关闭(默认) 1或4:开通行政区域解析功能(不同值下的参数返回详见:快递信息推送接口文档), 3或5:开通地图轨迹及时效返回(不同值下的参数返回详见地图轨迹推送服务技术文档)
needDesensitization否boolean是否脱敏 ,false:关闭(默认)true:开启。开启后生成的面单收寄件人手机号码会脱敏,使用前请先跟网点确认是否支持使用脱敏电话
needLogo否boolean面单是否需要logo false:关闭(默认)true:开启
thirdOrderId否string平台导入返回的订单id:如平台类加密订单,使用此下单为必填
oaid否string淘宝订单收件人ID (Open Addressee ID),长度不超过128个字符,淘宝订单加密情况用于解密
caid否string菜鸟解密地址ID,1688订单加密情况用于解密
thirdTemplateURL否string第三方平台面单基础模板链接,如为第三方平台导入订单选填,如不填写,默认返回两联面单模板
thirdCustomTemplateUrl否string第三方平台自定义区域模板地址
customParam否Map<String,String>面单自定义参数。方式传入为key-value格式,注意这里的key优先级高于面单生成的参数,例如:面单里面默认的快递单号对应参数为kuaidinum,如果这里的key也包含kuaidinum,将会覆盖原来的值。使用第三方平台订单时,也可配合thirdCustomTemplateUrl,实现自定义区域的传值
needOcr否boolean第三方平台订单是否需要开启ocr,开启后将会通过推送方式推送 false:关闭(默认)true:开启
ocrInclude否String[]orc需要检测识别的面单元素。取值范围:barcode,qrcode,receiver,sender,bulkpen。不传或者 null 则默认为 ["barcode", "receiver", "sender"]
height否string打印纸的高度,以mm为单位(该参数只有第三方平台订单,并且printType为CLOUD时起作用)
width否string打印纸的宽度,以mm为单位(该参数只有第三方平台订单,并且printType为CLOUD时起作用)

data数据结构

字段类型说明备注
taskIdstring任务ID
kuaidinumstring快递单号
childNumstring子单号多个子单时使用”,”隔开。比如JD6666666,JD888888,JD99999
backNumstring回单号部分快递公司回单会返回回单号
labelstring面单短链,printType为IMAGE或者HTML时的面单短链多个面单时使用”,”隔开。比如http://api.kuaidi100.com/label/1, http://api.kuaidi100.com/label/2, http://api.kuaidi100.com/label/3 面单异步生成,请求还未生成时,可以稍后重试
bulkpenstring大头笔用于显示于电子面单上规定位置,非必需,是否有值取决于快递公司
orgCodestring始发地区域编码
orgNamestring始发地/始发网点名称
destCodestring目的地区域编码
destNamestring目的地/到达网点
orgSortingCodestring始发分拣编码
orgSortingNamestring始发分拣名称
destSortingCodestring目的分栋编码
destSortingNamestring目的分栋中心名称
orgExtrastring始发其他信息
destExtrastring目的其他信息
pkgCodestring集包编码
pkgNamestring集包地名称
roadstring路区
qrCodestring二维码
kdComOrderNumstring快递公司订单号
expressCodestring快递业务类型编码
expressNamestring快递业务类型名称

注意:当net入参为taobao/cainiao/jdalpha/pinduoduoWx/douyin/kuaishou/weipinhui时,printType将不起作用,label返回的结果除了jdalpha是jpg,其他都是pdf格式

1.6 返回信息代码含义

信息代码信息内容描述原因及建议处理方式
-1服务器错误快递100的服务器出现间歇或临时性异常,有时如果因为不按规范提交请求,比如快递公司参数写错等,也会报此错误
200提交成功提交成功
30001参数错误请根据技术文档请求,注意参数类型及是否必填
30002验证签名失败检查加密方式,param +t+key+ secret的顺序进行MD5加密,加密后字符串转32位大写,不用加上“+”号
30003账号信息不正确检查key是否正确
30004账号单量不足单量不足需要充值
30005快递公司返回异常按照描述可以自行检查是否参数缺失或者错误
30006参数转换异常按照描述可以自行检查参数的数据类型是否正确
30007模板id不正确检查传入tempId、childTempId、backTempId是否正确
30008第三方平台生成面单失败平台订单面单生成失败,一般是网络问题可以稍后重试
30010打印机状态不正确打印机当前状态无法打单,需要检查
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.kuaidi100.com/label/order' \
--data-urlencode 'method=' \
--data-urlencode 'key=' \
--data-urlencode 'sign=' \
--data-urlencode 't=' \
--data-urlencode 'param='
响应示例响应示例
200 - 成功 - 成功示例
{
    "code": 200,
    "data": {
        "kuaidinum": "ZJS8888888888",
        "bulkpen": "371-转9999-C482",
        "sameCity": "1",
        "sameProv": "1",
        "taskId": "7EEAFD6CBEF64FEBAA10022BD32378BC"
    },
    "message": "success",
    "time": 0,
    "success": true
}

请求参数

Body 参数application/x-www-form-urlencoded
method
string 
必需
业务类型(默认:order)
key
string 
必需
授权码,请到快递100页面申请企业版接口获取
sign
string 
必需
32位大写,签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号,secret在企业管理后台获取
t
string 
必需
时间戳如:1576123932000
param
string 
由其他字段拼接
必需

返回响应

🟢200成功
application/json
Body
code
integer 
返回编码
必需
200为成功
data
object 
必需
kuaidinum
string 
快递单号
必需
bulkpen
string 
必需
sameCity
string 
必需
sameProv
string 
必需
taskId
string 
任务ID
必需
message
string 
返回报文描述
必需
time
integer 
必需
success
boolean 
提交结果
必需
true提交成功,false失败
🟢200失败

【快递100】API开发者 微信交流群

用微信扫右侧二维码,加入【快递100】API开发者 交流群,互助沟通

扫码加入交流群
上一页
打印状态回调
下一页
电子面单复打接口
Built with