快递信息查询
请求报文样例
1、按快递单号码查询:
- {
- "slots": {
- "trackingNoList": {
- "name": "trackingNoList",
- "slotType": "string",
- "values": [{
- "real": "{\"trackingNo\":\"1234567890\",\"vendor\":\"STO\"}"
- }]
- }
- }
- }
2、按手机号码查询:
- {
- "slots": {
- "phoneNoList": {
- "name": "phoneNoList",
- "slotType": "string",
- "values": [{
- "real": "{\"phoneNo\":\"13800001234\"}"
- }]
- },
- "excludeStates": {
- "name": "excludeStates",
- "slotType": "string",
- "values": [{
- "real": "{\"state\":\"FINISH\"}"
- }]
- },
- "pageNo": {
- "name": "pageNo",
- "slotType": "integer",
- "values": [{
- "real": "{\"pageNo\":0}"
- }]
- },
- "limit": {
- "name": "limit",
- "slotType": "integer",
- "values": [{
- "real": "{\"limit\":25}"
- }]
- },
- "containDetails": {
- "name": "containDetails",
- "slotType": "integer",
- "values": [{
- "real": "{\"containDetails\":1}"
- }]
- }
- }
- }
| 成员名称 | 描述 | 是否必选 | 类型 | 取值范围 |
| trackingNoList | 快递单号列表 | 否 | PackageTrackingIdentityItem[] | 最大Item数:10 |
| phoneNoList | 手机号列表 | 否 | PhoneInfoItem[] | 最大Item数:10 |
| excludeStates | 不需要返回的快递状态 | 否 | ExcludePackageStateItem[] | 最大Item数:8 |
| pageNo | 分页查询的指定分页,从0开始。 | 否 | int | / |
| limit | 一页最大返回的快递信息条数,最大为25条。 | 否 | int | 最大值:25 |
| containDetails | 是否返回物流详情0:不包含1:包含 | 否 | int | 枚举值: 0, 1 |
快递信息
响应中快递信息报文样例:
- {
- "items": [
- {
- "total": 10,
- "packageInfoList": [
- {
- "trackingNo": "859143010012",
- "phoneNo": "13800001234",
- "cpLogo": {
- "small": {
- "url": "https://imageurl/small.jpg",
- "widthPixels": 80,
- "heightPixels": 80
- },
- "medium": {
- "url": "https://imageurl/medium.jpg",
- "widthPixels": 120,
- "heightPixels": 120
- },
- "large": {
- "url": "https://imageurl/large.jpg",
- "widthPixels": 256,
- "heightPixels": 256
- }
- },
- "vendor": "SF",
- "vendorName": "顺丰速递",
- "vendorLogo": {
- "small": {
- "url": "https://imageurl/small.jpg",
- "widthPixels": 80,
- "heightPixels": 80
- },
- "medium": {
- "url": "https://imageurl/medium.jpg",
- "widthPixels": 120,
- "heightPixels": 120
- },
- "large": {
- "url": "https://imageurl/large.jpg",
- "widthPixels": 256,
- "heightPixels": 256
- }
- },
- "packageDescription": "已签收",
- "state": "FINISH",
- "operateDescription": "用户已签收",
- "operateMessage": "用户已签收",
- "operateName": "本人",
- "operateTime": "2019010109300000020190101093000",
- "trackingDetails": [
- {
- "time": "2019010109300000020190101093000",
- "context": "您的包裹已由本人签收。感谢您使用XX快递"
- },
- {
- "time": "2019010108050000020190101080500",
- "context": "您的包裹正在配送途中(配送员:XXX,电话:13500001234)请您准备签收,感谢您的耐心等待"
- },
- {
- "time": "2019010106500000020190101065000",
- "context": "您的包裹已到达【XX营业部】"
- }
- ],
- "additionalInfo": {
- "orderInfo": [
- {
- "merchant": "JD",
- "orderLink": {
- "webURL": "web url",
- "deepLink": {},
- "quickApp": {}
- },
- "commodityInfo": [
- {
- "productId": "12345678",
- "productName": "XXX商品",
- "productImageUrl": {
- "small": {
- "url": "https://imageurl/small.jpg",
- "widthPixels": 80,
- "heightPixels": 80
- },
- "medium": {
- "url": "https://imageurl/medium.jpg",
- "widthPixels": 120,
- "heightPixels": 120
- },
- "large": {
- "url": "https://imageurl/large.jpg",
- "widthPixels": 256,
- "heightPixels": 256
- }
- },
- "productDetailLink": {
- "webURL": "web url",
- "deepLink": {},
- "quickApp": {}
- }
- }
- ]
- }
- ]
- },
- "getcode": "123456",
- "address": "XXX西侧快递柜",
- "onboxTime": "2019010109150000020190101091500",
- "cabinetLocation": {
- "locationSystem": "BD09LL",
- "latitude": "120.785645",
- "longitude": "33.039635",
- "poiId": "2346"
- },
- "cpLink": {
- "webURL": "https://detailUrl",
- "deepLink": {},
- "quickApp": {}
- },
- "cabinet": "FCBOX",
- "cabinetName": "丰巢快递柜",
- "cabinetLogo": {
- "small": {
- "url": "https://imageurl/small.jpg",
- "widthPixels": 80,
- "heightPixels": 80
- },
- "medium": {
- "url": "https://imageurl/medium.jpg",
- "widthPixels": 120,
- "heightPixels": 120
- },
- "large": {
- "url": "https://imageurl/large.jpg",
- "widthPixels": 256,
- "heightPixels": 256
- }
- },
- "cabinetLink":{
- "webURL": "https://detailUrl",
- "deepLink": {},
- "quickApp": {}
- }
- }
- ]
- }
- ]
- }
| 成员名称 | 描述 | 是否必选 | 类型 | 取值范围 |
| items | 快递数据 | 是 | LogisticsInfoRspItem[] | 最大Item数:16 |
快递绑定
请求报文样例
1、按快递单号码订阅:
- {
- "slots": {
- "operateType": {
- "name": "operateType",
- "slotType": "integer",
- "values": [
- {
- "real": "2"
- }
- ]
- },
- "trackingNoList": {
- "name": "trackingNoList",
- "slotType": "string",
- "values": [
- {
- "real": "{\"trackingNo\":\"1234567890\",\"vendor\":\"SFSTO\"}"
- }
- ]
- }
- }
- }
- 按手机号码订阅
- {
- "slots": {
- "operateType": {
- "name": "operateType",
- "slotType": "integer",
- "values": [
- {
- "real": "1"
- }
- ]
- },
- "phoneNoList": {
- "name": "phoneNoList",
- "slotType": "string",
- "values": [
- {
- "real": "{\"phoneNo\":\"13800001234\"}"
- }
- ]
- }
- }
- }
2、按手机号码订阅:
{
"slots": {
"operateType": {
"name": "operateType",
"slotType": "integer",
"values": [{
"real": "1"
}]
},
"phoneNoList": {
"name": "phoneNoList",
"slotType": "string",
"values": [{
"real": "{\"phoneNo\":\"13800001234\"}"
}]
}
}
}| 成员名称 | 描述 | 是否必选 | 类型 | 取值范围 |
| operateType | 订阅/取消订阅快递信息方式 1:绑定手机号 2:绑定快递单号 3:解绑手机号 4:解绑快递单号 | 否 | int | 枚举值: 1, 2, 3, 4 |
| trackingNoList | 快递单号列表 | 否 | PackageTrackingIdentityItem[] | / |
| phoneNoList | 需要订阅快递信息的手机号,手机号码格式为:11位手机号码。 | 否 | PhoneInfoItem[] | / |
绑定手机号/快递单号跟踪快递信息请求的响应:
响应报文样例
按手机号码订阅响应
- {
- "items": {
- "subscribePhoneList": [
- {
- "phoneNo": "139XXXXXXXX",
- "subscribeState": 1
- }
- ]
- }
- }
- 按快递单号订阅响应
- {
- "items": {
- "subscribePackageList": [
- {
- "trackingNo": "123456789",
- "vendor": "SF",
- "subscribeState": 1
- }
- ]
- }
- }
| 成员名称 | 描述 | 是否必选 | 类型 | 取值范围 |
| items | 快递数据 | 否 | LogisticsSubscriptionInfoItem[] | 最大Item数:10 |
绑定手机号/快递单号跟踪快递信息请求的响应:
| 成员名称 | 描述 | 是否必选 | 类型 | 取值范围 |
| subscribePhoneList | 手机号码绑定结果数据数据 | 否 | PhoneSubscriptionInfoItem[] | 最大Item数:10 |
| subscribePackageList | 快递单号绑定结果数据数据 | 否 | PackageSubscriptionInfoItem[] | 最大Item数:10 |
绑定手机号跟踪快递信息请求的结果:
| 成员名称 | 描述 | 是否必选 | 类型 | 取值范围 |
| subscribeState | 绑定结果0:绑定失败1:绑定成功 | 否 | int | 最大Item数:10,枚举值: 0,1 |
| phoneNo | 请求绑定的手机号码 | 否 | string | / |
绑定快递单号跟踪快递信息请求的结果:
| 成员名称 | 描述 | 是否必选 | 类型 | 取值范围 |
| subscribeState | 绑定结果0:绑定失败1:绑定成功 | 否 | int | 最大Item数:10,枚举值: 0,1 |
| trackingNo | 请求绑定的快递单号 | 否 | string | / |
| vendor | 快递公司信息 POST:中国邮政 | 否 | string(LogisticsVendor) | / |
快递数据:
| 成员名称 | 描述 | 是否必选 | 类型 | 取值范围 |
| total | 满足查询条件的快递信息总条数 | 否 | int | / |
| packageInfoList | 快递信息列表 | 否 | PackageInfoRspItem[] | / |
快递跟踪信息标识:
| 成员名称 | 描述 | 是否必选 | 类型 | 取值范围 |
| trackingNo | 快递单号 | 是 | string | / |
| vendor | 快递公司信息 AIR:亚风速递 | 否 | string(LogisticsVendor) | / |
| phoneNo | 手机号码,快递单号对应的收件人或发件人的手机号码,需与trackingNo同时使用 | 否 | string | 最大长度:15 |
手机号码:
| 成员名称 | 描述 | 是否必选 | 类型 | 取值范围 |
| phoneNo | 手机号码 | 否 | string | 最大长度:15 |
| encryptedPhoneNo | 加密后的手机号码 | 否 | string | / |
手机号码:
| 成员名称 | 描述 | 是否必选 | 类型 | 取值范围 |
| phoneNo | 手机号码 | 是 | string | 最大长度:15 |
| inactiveTotal | 该手机号码对应的未显示的快递数 | 否 | int | / |
| lastUpdateTime | 该手机号码最近一次有快递更新的时间 | 否 | DateTimeSecondFormatString | / |
快递状态:
| 成员名称 | 描述 | 是否必选 | 类型 | 取值范围 |
| state | 快递状态 CONSIGN:待揽收 ACCEPT:已揽件 TRANSPORT:运输中 DELIVERING:派送中 AGENT:待取件 FINISH:已签收 REJECT:拒签 FAILED:包裹异常 RETURN:退货 OVERDUE:快递在暂存地(快递柜或代收点)超时未取 | 是 | string | 最大长度:15, 枚举值: CONSIGN, ACCEPT, TRANSPORT, DELIVERING, AGENT, FINISH, REJECT, FAILED, RETURN, OVERDUE |
快递信息:
| 成员名称 | 描述 | 是否必选 | 类型 | 取值范围 |
| trackingNo | 快递单号 | 是 | string | 最大长度:32 |
| phoneNo | 快递的收件人手机号码 | 否 | string | 最大长度:15 |
| senderPhoneNo | 寄件人手机号码 | 否 | string | / |
| vendor | 快递公司信息 AIR:亚风速递 | 是 | string(LogisticsVendor) | / |
| vendorName | 快递公司名称 | 否 | string | 最大长度:20 |
| packageDescription | 快递信息描述 | 否 | string | 最大长度:256 |
| state | 快递状态 CONSIGN:待揽收 ACCEPT:已揽件 TRANSPORT:运输中 DELIVERING:派送中 AGENT:待取件 FINISH:已签收 REJECT:拒签 FAILED:包裹异常 RETURN:退货 | 是 | string | 最大长度:15,枚举值: CONSIGN, ACCEPT, TRANSPORT, DELIVERING, AGENT, FINISH, REJECT, FAILED, RETURN |
| operateDescription | 最新一条消息的操作类型 | 否 | string | 最大长度:50 |
| operateMessage | 最新一条消息的操作详细信息 | 否 | string | 最大长度:50 |
| operateName | 最新一条消息的操作员姓名 | 否 | string | 最大长度:20 |
| operateTime | 最新一条消息的操作时间,本地时间,格式:yyyymmddhhmmss | 否 | DateTimeSecondFormatString | / |
| trackingDetails | 详细物流信息 | 否 | PackageTrackingDetailsInfoItem[] | 最大Item数:50 |
| additionalInfo | 快递的附加信息的JSON串,暂时留空,后续可根据需求补充如商品信息等 | 否 | PackageAdditionalInfo | / |
| getcode | 取件码 | 否 | string | 最大长度:16 |
| address | 取件地址 | 否 | string | 最大长度:100 |
| onboxTime | 投递时间 | 否 | DateTimeSecondFormatString | / |
| cabinetLocation | 快递柜所在位置 | 否 | Location | / |
| cpLink | 跳转到开发者展示快递信息的地址 | 否 | Interaction | / |
| cabinet | 取件信息提供方CAINIAO:菜鸟裹裹SF:顺丰JD:京东FCBOX:丰巢MOGE:魔格STO:申通YTO:圆通ZTO:中通YUNDA:韵达 | 否 | string | 枚举值: CAINIAO, SF, JD, FCBOX, MOGE, STO, YTO, ZTO, YUNDA |
| cabinetName | 取件信息提供方名称 | 否 | string | 最大长度:20 |
| cabinetLink | 跳转到快递柜取件的地址 | 否 | Interaction | / |
快递跟踪信息详情:
| 成员名称 | 描述 | 是否必选 | 类型 | 取值范围 |
| time | 此数据发生的时间,本地时间,格式:yyyyMMddHHmmss。 | 是 | DateTimeSecondFormatString | / |
| context | 此数据的具体内容 | 是 | string | 最大长度:1024 |
| state | 快递状态 CONSIGN:待揽收 ACCEPT:已揽件 TRANSPORT:运输中 DELIVERING:派送中 AGENT:待取件 FINISH:已签收 REJECT:拒签 FAILED:包裹异常 RETURN:退货 | 否 | string | 最大长度:15,枚举值: CONSIGN, ACCEPT, TRANSPORT, DELIVERING, AGENT, FINISH, REJECT, FAILED, RETURN |
快递包裹的附加信息,如商品信息等,后续可逐渐补充。
| 成员名称 | 描述 | 是否必选 | 类型 | 取值范围 |
| orderInfo | 快递包裹的订单和商品信息 | 否 | PackageOrderInfo[] | / |
| packageDyn | 快递包裹的原始增值服务信息 | 否 | string | / |
快递包裹的商品信息:
| 成员名称 | 描述 | 是否必选 | 类型 | 取值范围 |
| productId | 产品Id | 否 | string | 最大长度:50 |
| productName | 产品名称 | 否 | string | 最大长度:50 |
| productImageUrl | 产品图片地址 | 否 | ImageInfo[] | / |
| productDetailLink | 产品链接地址 | 否 | Interaction | / |
快递包裹的订单信息:
| 成员名称 | 描述 | 是否必选 | 类型 | 取值范围 |
| merchant | 商家信息JD:京东TMALL:天猫VMALL:VMall | 否 | string | 最大长度:20,枚举值: JD, TMALL, VMALL |
| orderId | 订单编号 | 否 | string | 最大长度:64 |
| orderLink | 订单链接地址 | 否 | Interaction | / |
| commodityInfo | 快递包裹中的商品信息 | 否 | PackageCommodityInfo[] | / |
根据快递单号查询快递公司
请求报文样例:
{
"slots": {
"trackingNoList": {
"name": "trackingNoList",
"slotType": "string",
"values": [
{
"real": "{\"trackingNo\":\"1234567890\"}"
}
]
}
}
}| 成员名称 | 描述 | 是否必选 | 类型 | 取值范围 |
| trackingNoList | 快递单号列表 | 否 | string[] | 最大Item数:20 |
快递单号与快递公司关联关系
响应报文样例:
{
"logisticsVendorInfoList": [{
"trackingNo": "1234567890",
"vendor": "SF"
}]
}| 成员名称 | 描述 | 是否必选 | 类型 | 取值范围 |
| logisticsVendorInfoList | 快递单号与快递公司关联关系列表 | 否 | LogisticsVendorInfoItem[] | 最大Item数:100 |
快递单号与快递公司关联关系:
| 成员名称 | 描述 | 是否必选 | 类型 | 取值范围 |
| trackingNo | 快递单号 | 是 | string | 最大长度:32 |
| vendor | 快递公司信息 AIR:亚风速递 | 否 | string(LogisticsVendor) |
快递公司信息:
快递公司信息
AIR:亚风速递
ANE56:安能物流
ANE66:安能快递
ARAMEX:Aramex
ASENDIA:Asendia USA
BEST:百世物流
BJCS:城市100
BLSYZ:比利时邮政
BLYZ:波兰邮政
BOYOL:贝业新兄弟
CAE:民航快递
CHENGBANG:晟邦物流
CITYLINK:City-Link
CNEX:佳吉快递
CNPOSTGJ:邮政国际包裹
COE:COE
CRE:中铁快运
CREWL:中铁物流
CXCOD:传喜物流
CYEXP:长宇
DBKD:德邦快递
DBL:德邦物流
DFH:东方汇
DHL:DHL中国
DHLDE:DHL德国
DHLEN:DHL全球
DISTRIBUTOR_13166902:菜鸟裹裹
DISTRIBUTOR_13323734:九曳鲜配
DJ56:东骏快捷
ds1:D速物流
DTW:大田物流
EES:百福东方
EMS:EMS
EMSGJ:EMS国际
EPOST:韩国邮政
ESB:E速宝
EWINSHINE:万象物流
EYB:EMS经济快递
FAST:快捷快递
FEC:银捷速递
FEDEX:联邦快递
FEDEXCN:FedEx中国
FEDEXUS:FedEx美国
FGYZ:法国邮政
FJSFWLJTYXGS:盛丰物流
GDEMS:广东EMS
GTO:国通快递
GZFY:凡宇速递
HKYZ:香港邮政
HLWL:恒路物流
HOAU:天地华宇
HQKY:华企快运
HTKY:百世汇通
HUANGMAJIA:黄马甲配送
HZABC:飞远(爱彼西)配送
JDKD:京东快递
JDYWL:筋斗云物流
JGSD:京广速递
JIAJIWL:佳吉物流
JIAYI:佳怡物流
JKYZ:捷克邮政
KERRYEAS:嘉里大通
KY:跨越速运
LB:龙邦速递
LTS:联昊通
MANCOWL:万家物流
MBEX:民邦快递
MGSD:美国速递
NEDA:能达速递
OCS:OCS
ONTRAC:OnTrac
POST:中国邮政
POSTAE:阿联酋邮政
POSTAL:阿尔巴尼亚邮政
POSTAM:亚美尼亚邮政
POSTAR:阿根廷邮政
POSTAT:奥地利邮政
POSTAU:澳大利亚邮政
POSTB:邮政国内小包
POSTBR:巴西邮政
POSTBY:白俄罗斯邮政
POSTCH:瑞士邮政
POSTCL:智利邮政
POSTEE:爱沙尼亚邮政
POSTES:西班牙邮政
POSTFI:芬兰邮政
POSTHR:克罗地亚邮政
POSTHU:匈牙利邮政
POSTIN:印度邮政
POSTIT:意大利邮政
POSTLB:黎巴嫩邮政
POSTMD:摩尔多瓦邮政
POSTMK:马其顿邮政
POSTMT:马耳他邮政
POSTMU:毛里求斯邮政
POSTNO:挪威邮政
POSTPK:巴基斯坦邮政
POSTPT:葡萄牙邮政
POSTSA:沙特邮政
POSTSI:斯洛文尼亚邮政
POSTSK:斯洛伐克邮政
POSTSRB:塞尔维亚邮政
POSTTH:泰国邮政
POSTTR:土耳其邮政
POSTUA:乌克兰邮政
POSTZA:南非邮政
QDHEWL-001:日日顺物流
QFKD:全峰快递
QRT:全日通
RBYZEMS:日本邮政
RFD:如风达
ROYALMAIL:英国皇家邮政
RRS:日日顺物流
RUSTON:俄速通
SAD:赛澳递
SERPOST:秘鲁邮政
SF:顺丰速运
SHENGHUI:盛辉物流
SHQ:华强物流
SNWL:苏宁快递
STO:申通快递
SURE:速尔
SZKKE:京广速递
SZML56:明亮物流
SZSA56:圣安物流
TMS56:加运美
TNT:TNT
TTKDEX:天天快递
UAPEX:全一快递
UC:优速快递
UCS:UCS合众速递
UNIPS:发网
UPS:UPS
USPS:USPS
WPH:唯品会
XB:新邦物流
XFWL:信丰物流
XLOBO:贝海国际速递
YANWENBJ:燕文北京
YANWENGZ:燕文广州
YANWENINTE:燕文国际
YANWENSH:燕文上海
YANWENSZ:燕文深圳
YANWENYW:燕文义乌
YCGWL:远成物流
YCKY:远成快运
YCT:黑猫宅急便
YCWL:远成物流
YFEXPRESS:越丰物流
YTO:圆通速递
YTZG:运通中港快递
YUD:长发
YUNDA:韵达快递
ZJS:宅急送
ZMKM:丹鸟
ZMKMKD:丹鸟快递
ZTO:中通快递
ZTOGZ:ZTOGZ
ZTOSH:ZTOSH
100004795:黄马甲配送
2639775697_301:筋斗云物流
4PX:递四方
类型 | 取值范围 |
string | 枚举值: |