顺丰科技有限公司
企业服务平台接入规范
V3.6
系统与数据集成研发中心
16.2.19
?版权所有2015顺丰科技有限公司,未经顺丰科技有限公司/顺丰速运有限公司授权,不得向任何第三方透露本文档所含信息的全部或部分内容。
企业服务平台技术规范 – 目录
1. 目录
1. 目录 ......................................................................................................................................... 1 2. 前言 ......................................................................................................................................... 5 3. 接口规范说明 .......................................................................................................................... 6
3.1. 报文及报文编码 ........................................................................................................... 6 3.2. 通讯协议 ....................................................................................................................... 6 3.3. 接口规范说明 ............................................................................................................... 6
3.3.1. 接口基本信息说明............................................................................................. 6 3.3.2. XML报文说明 .................................................................................................... 7 3.3.3. 元素及元素属性说明 ......................................................................................... 8 3.4. 开发用公共接口信息 ................................................................................................... 9 4. 下订单(含筛选)接口 .........................................................................................................10
4.1. 功能描述 ......................................................................................................................10 4.2. 接口定义 ......................................................................................................................10
4.2.1. 接口基本信息 ...................................................................................................10 4.2.2. 元素<请求>Order ..............................................................................................10 4.2.3. 元素<请求>Order/Cargo ...................................................................................16 4.2.4. 元素<请求>Order/ AddedService(可选).......................................................17 4.2.5. 元素<响应> OrderResponse ..............................................................................17 4.2.6. 增值服务下单属性说明 ....................................................................................18 4.2.7. 扩展字段信息 ...................................................................................................19 4.2.8. 报文范例 ...........................................................................................................19
5. 订单确认/取消接口 ...............................................................................................................23
5.1. 功能描述 ......................................................................................................................23 5.2. 接口定义 ......................................................................................................................23
5.2.1. 接口基本信息 ...................................................................................................23 5.2.2. 元素<请求> OrderConfirm ................................................................................23 5.2.3. 元素<请求> OrderConfirm/OrderConfirmOption(可选) ...............................23 5.2.4. 元素<响应> OrderConfirmResponse .................................................................24 5.2.5. 扩展字段信息 ...................................................................................................24 5.2.6. 报文范例 ...........................................................................................................24
第 1页 /共 59页
?版权所有2015顺丰科技有限公司
企业服务平台技术规范 – 目录
6. 订单结果查询接口 .................................................................................................................26
6.1. 功能描述 ......................................................................................................................26 6.2. 接口定义 ......................................................................................................................26
6.2.1. 接口基本信息 ...................................................................................................26 6.2.2. 元素<请求> OrderSearch...................................................................................26 6.2.3. 元素<响应> OrderSearchResponse ...................................................................26 6.2.4. 报文范例 ...........................................................................................................27
7. 订单筛选接口 .........................................................................................................................28
7.1. 功能描述 ......................................................................................................................28 7.2. 接口定义 ......................................................................................................................28
7.2.1. 接口基本信息 ...................................................................................................28 7.2.2. 元素<请求> OrderFilter .....................................................................................28 7.2.3. 元素<请求> OrderFilter/OrderFilterOption(可选) ........................................29 7.2.4. 元素<响应> OrderFilterResponse ......................................................................30 7.2.5. 报文范例 ...........................................................................................................30
8. 人工筛单结果推送接口 .........................................................................................................32
8.1. 功能描述 ......................................................................................................................32 8.2. 接口定义 ......................................................................................................................32
8.2.1. 接口基本信息 ...................................................................................................32 8.2.2. 元素<请求> OrderFilterResult ...........................................................................32 8.2.3. 报文范例 ...........................................................................................................33
9. 路由查询接口 .........................................................................................................................35
9.1. 功能描述 ......................................................................................................................35 9.2. 接口定义 ......................................................................................................................35
9.2.1. 接口基本信息 ...................................................................................................35 9.2.2. 元素<请求> RouteRequest ................................................................................35 9.2.3. 元素<响应> RouteResponse ..............................................................................36 9.2.4. 元素<响应> RouteResponse/Route ...................................................................36 9.2.5. 报文范例 ...........................................................................................................37
10. 路由推送接口 .......................................................................................................................38
10.1. 功能描述 ....................................................................................................................38 10.2. 接口定义 ....................................................................................................................38
10.2.1. 接口基本信息 .................................................................................................38
第 2页 /共 59页
?版权所有2015顺丰科技有限公司
企业服务平台技术规范 – 目录
10.2.2. 元素<请求> WaybillRoute ...............................................................................38 10.2.3. 报文范例 .........................................................................................................39
11. 时效查询接口 .......................................................................................................................41
11.1. 功能描述 ....................................................................................................................41 11.2. 接口定义 ....................................................................................................................41
11.2.1. 接口基本信息 .................................................................................................41 11.2.2. 元素<请求> DeliverTmRequest .......................................................................41 11.2.3. 元素<请求> DeliverTmRequest/SrcAddress.....................................................42 11.2.4. 元素<请求> DeliverTmRequest/DestAddress ..................................................43 11.2.5. 元素<响应> DeliverTmResponse/DeliverTm....................................................43 11.2.6. 报文范例 .........................................................................................................44
12. 产品及增值服务查询接口 ...................................................................................................46
12.1. 功能描述 ....................................................................................................................46 12.2. 接口定义 ....................................................................................................................46
12.2.1. 接口基本信息 .................................................................................................46 12.2.2. 元素<请求> Scope ...........................................................................................46 12.2.3. 元素<响应> Scope/Service ..............................................................................46 12.2.4. 产品/增值服务客户属性说明.........................................................................47 12.2.5. 报文范例 .........................................................................................................47
13. 子单号申请接口 ...................................................................................................................48
13.1. 功能描述 ....................................................................................................................48 13.2. 接口定义 ....................................................................................................................48
13.2.1. 接口基本信息 .................................................................................................48 13.2.2. 元素<请求> OrderZDService ............................................................................48 13.2.3. 元素<响应> OrderZDResponse ........................................................................48 13.2.4. 报文范例 .........................................................................................................48
14. 身份证图片查询接口 ...........................................................................................................50
14.1. 功能描述 ....................................................................................................................50 14.2. 接口定义 ....................................................................................................................50
14.2.1. 接口基本信息 .................................................................................................50 14.2.2. 元素<请求> IdentitySearch..............................................................................50 14.2.3. 元素<响应> IdentitySearchResponse ..............................................................50 14.2.4. 报文范例 .........................................................................................................50
第 3页 /共 59页
?版权所有2015顺丰科技有限公司
企业服务平台技术规范 – 目录
15. 附录 ......................................................................................................................................54
15.1. 原因代码表 ................................................................................................................54 15.2. 快件产品类别表 ........................................................................................................57 15.3. 其它参考材料 ............................................................................................................59
第 4页 /共 59页
?版权所有2015顺丰科技有限公司