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

快递订阅查询快递api接口技术文档

POST
https://poll.kuaidi100.com/poll
一、订阅接口
通过订阅接口提交快递单号,接口接收到后便对这些运单进行跟踪,当运单状态发生变化的时候,通过调用回调接口将运单的跟踪信息推送给贵公司,直到这些运单号的生命周期结束(一般以“已签收”为准)。
注意:对于同一快递公司同一个快递单号,每月最大订阅次数为4次,超过4次的订阅在提交时会报重复订阅。
名称类型是否必需示例值描述
schemaString是json返回的数据格式
Θparamparam是由其他字段拼接
└ companyString是ems订阅的快递公司的编码,一律用小写字母
└ numberString是1136281381675订阅的快递单号,单号的最大长度是32个字符 下载编码表格
└ fromString否广东省深圳市南山区出发地城市,省-市-区,非必填,填了有助于提升签收状态的判断的准确率,请尽量提供
└ toString否北京市朝阳区目的地城市,省-市-区,非必填,填了有助于提升签收状态的判断的准确率,且到达目的地后会加大监控频率,请尽量提供
└ keyString是授权码,请申请企业版获取
Θparametersparameters是附加参数信息
└- callbackurlString是回调接口的地址
└- saltString否XXXXXXXXXX签名用随机字符串
└- resultv2String否1添加此字段表示开通行政区域解析功能。0:关闭(默认),1:开通行政区域解析功能以及物流轨迹增加物流状态值,2:开通行政解析功能以及物流轨迹增加物流状态值并且返回出发、目的及当前城市信息 4:开通行政解析功能以及物流轨迹增加物流高级状态名称并且返回出发、目的及当前城市信息 6:开通行政解析功能以及物流轨迹增加物流高级状态名称、状态值并且返回出发、目的及当前城市信息
└- autoComString否1添加此字段且将此值设为1,则表示开启智能判断单号所属公司的功能,开启后,需确保company字段为空,即只传运单号(number字段),我方收到后会根据单号判断出其所属的快递公司(即company字段)。建议只有在无法知道单号对应的快递公司(即company的值)的情况下才开启此功能。
└- interComString否1添加此字段表示开启国际版,开启后,若订阅的单号(即number字段)属于国际单号,会返回出发国与目的国两个国家的跟踪信息,本功能暂时只支持邮政体系(国际类的邮政小包、EMS)内的快递公司,若单号我方识别为非国际单,即使添加本字段,也不会返回destResult元素组
└- departureCountryString否CN出发国家编码
└- departureComString否ems出发的快递公司的编码
└- destinationCountryString否JP目的国家编码
└- destinationComString否japanposten目的的快递公司的编码
└- phoneString否13488888888收、寄件人的电话号码(手机和固定电话均可,只能填写一个,顺丰速运和丰网速运必填,其他快递公司选填。如座机号码有分机号,分机号无需上传。)
注:如需物流状态高级状态名称及状态值需要 resultv2 传 “6” 返回,如需物流状态高级状态名称需要 resultv2 传 “4” 返回

1.5 订阅返回信息代码含义#

result: true表示成功,false表示失败
信息代码信息内容描述原因及建议处理方式
200提交成功订阅提交成功
500服务器错误快递100的服务器出理间隙或临时性异常,有时如果因为不按规范提交请求,比如快递公司参数写错等,也会报此错误
501重复订阅此单已经订阅成功且目前还在跟踪过程中。若要提交多次订阅,请在收到单号的status=abort或shutdown后隔半小时再提交订阅
502提交内容含有敏感关键字,被安全防护拦截回调地址、提交内容包含敏感词,请联系快递100工作人员
600您不是合法的订阅者(即授权Key出错)账号无可用单量,需要充值
601POLL: KEY 已过期账号无可用单量,需要充值
700不支持的快递公司拒绝订阅的快递公司,检查快递公司编码是否有误
701订阅方的订阅数据存在错误(如不支持的快递公司、单号为空、单号超长等)或错误的回调地址请检查快递公司编码、对照技术文档检查参数、在后台调试工具测试回调地址
702POLL:识别不到该单号对应的快递公司快递公司编码错误或者无可用单量,需要充值
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://poll.kuaidi100.com/poll' \
--data-urlencode 'schema=json' \
--data-urlencode 'param={    "company": "ems",    "number": "1136281381675",    "from": "广东省深圳市南山区",    "to": "北京市朝阳区",    "key": "XXX ",    "parameters": {        "callbackurl": "您的回调接口的地址,如http://www.您的域名.com/kuaidi?callbackid=...",        "salt": "XXXXXXXXXX",        "resultv2": "1",        "autoCom": "1",        "interCom": "1",        "departureCountry": "CN",        "departureCom": "ems",        "destinationCountry": "JP",        "destinationCom": "japanposten",        "phone": "13800138000"    }}'
响应示例响应示例
{
    "result": true,
    "returnCode": "200",
    "message": "提交成功"
}

请求参数

Body 参数application/x-www-form-urlencoded
schema
string 
返回的数据格式
必需
示例值:
json
param
string 
由其他字段拼接
必需
示例值:
{ "company": "ems", "number": "1136281381675", "from": "广东省深圳市南山区", "to": "北京市朝阳区", "key": "XXX ", "parameters": { "callbackurl": "您的回调接口的地址,如http://www.您的域名.com/kuaidi?callbackid=...", "salt": "XXXXXXXXXX", "resultv2": "1", "autoCom": "1", "interCom": "1", "departureCountry": "CN", "departureCom": "ems", "destinationCountry": "JP", "destinationCom": "japanposten", "phone": "13800138000" }}

返回响应

🟢200成功
application/json
Body
result
boolean 
必需
returnCode
string 
必需
message
string 
必需

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

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

扫码加入交流群
上一页
产品介绍
下一页
推送接口
Built with