前言
- 通过运单号和物流公司编码等信息发起订阅，当货物放入驿站/快递柜后，会将对应驿站取件码通过回调地址推送至客户。
- 支持推送、查询两种方式获取取件码。如果没有传回调地址，也可以通过查询接口查询取件码（必须订阅成功后才可以使用查询接口，否则无效）。
- 必须在运单进入驿站前发起订阅，否则无效。
- 支持的驿站：下载支持的驿站清单
- 共有发起订阅、查询取件码、推送3个功能。
应用场景
需要有收货提醒功能的场景。例如购物APP、公众号等，用于日常收件、寄件与退换货、代取与特殊管理等。
API介绍
戳这里查看详情
发起订阅
- 通过快递信息，发起订阅。
请求说明
| 名称 | 类型 | 必须 | 说明 |
|---|---|---|---|
| shipperCode | String | 是 | 快递公司编码，详见：下载快递公司编码对照表 |
| logisticCode | String | 是 | 运单号 |
| callBackUrl | String | 否 | 回调地址 |
| senderMobile | String | 否 | 发件人号码 |
| virtualNumber | String | 否 | 虚拟号码（若单号做了隐私保护，可通过虚拟号查询） |
| senderAddress | String | 否 | 发件人地址 |
| receiverMobile | String | 是 | 收件人电话 |
| receiverAddress | String | 否 | 收件人地址 |
返回样例
{
"code": 200,// 返回码，详见返回码说明
"msg": "成功",// 返回码对应描述
"taskNo": "043439882226367117195632",// 本次请求号
"charge": true, // 计费标志
"data": {
"logisticCode": "79105030690097",//运单号
"shipperCode": "ZTO" //快递公司编码
}
}
查询取件码
请求说明
| 名称 | 类型 | 必须 |
说明
|
|---|---|---|---|
| shipperCode | String | 是 | 快递公司编码 |
| logisticCode | String | 是 | 运单号 |
| senderMobile | String | 否 | 发件人号码 |
| virtualNumber | String | 否 | 虚拟号码（若单号做了隐私保护，可通过虚拟号查询） |
| senderAddress | String | 否 | 发件人地址 |
| receiverMobile | String | 是 | 收件人电话 |
| receiverAddress | String | 否 | 收件人地址 |
返回样例
{
"code": 200,// 返回码，详见返回码说明
"msg": "成功",// 返回码对应描述
"taskNo": "043439882226367117195632",// 本次请求号
"charge": true, // 计费标志
"data": {
"logisticCode": "79105030690097",//运单号
"shipperCode": "ZTO", //快递公司编码
"pickUpCode": "xxx",//取件码
"pickUpAddress": "xxx",//代收点地址
"pickUpStation": "xxx" //代收点名称
}
}
推送说明
- 当货物放入驿站/快递柜后，会将取件码信息推送至callBackUrl接口
数据结构
{
"pickUpCode": "13-3-5236",
"code": "200",
"pickUpAddress": "xxx街道xx中心1幢",
"logisticCode": "9816475xxxxxx",
"shipperCode": "YZPY"
}
