企业服务平台接入技术规范 - V3.6 - 160507

更新时间：2024-01-17 17:44:01 阅读量：教育文库文档下载

说明：文章内容仅供预览，部分内容可能不全。下载后的文档，内容与下面显示的完全一致。下载之前请确认下面内容是否您想要的，是否完整无缺。

晋城市企业服务平台推荐度：
相关推荐

顺丰科技有限公司

企业服务平台接入规范

V3.6

系统与数据集成研发中心

16.2.19

企业服务平台技术规范 – 目录

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页

企业服务平台技术规范 – 目录

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页

企业服务平台技术规范 – 目录

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页

企业服务平台技术规范 – 目录

15. 附录 ......................................................................................................................................54

15.1. 原因代码表 ................................................................................................................54 15.2. 快件产品类别表 ........................................................................................................57 15.3. 其它参考材料 ............................................................................................................59

第 4页 /共 59页

企业服务平台技术规范 – 前言

2. 前言

本文档目的是定义企业服务平台（后面简称BSP）的通用对外服务接口，以便快速集成大客户自有的系统，从而打通大客户与顺丰系统之间的信息流，实现整体物流供应链的一体化，进而达到顺丰与客户的双赢。

第 5页 /共 59页

企业服务平台技术规范 – 接口规范说明

3. 接口规范说明

3.1. 报文及报文编码

BSP统一使用UTF-8编码的XML报文。

BSP使用ORACLE数据库，以UTF-8编码形式保存数据，所以中文字符会在数据库中占varchar2类型的三个单位长度。例如，接口定义中的“类型（约束）”如果为String(100)，则表示对于此字段，如果字段值全部为中文汉字，只能保存33个单位。

3.2. 通讯协议

接口通信协议支持WEBSERVICE及HTTP/POST协议：

1) 当使用WEBSERVICE接口时，报文通过方法参数传入（两个参数分别为XML报文

及校验码）。

2) 当使用HTTP/POST接口时，通过一个名叫xml的参数传入XML报文，一个名叫

verifyCode的参数传入校验码。

其中校验码的生成规则为：

? 接入BSP前，顺丰BSP系统管理员会为每个接入客户分配一个“密钥”，以下把

密钥简称为checkword。 ? 按以下逻辑生成校验码：

o 先把XML报文与checkword前后连接。 o 把连接后的字符串做MD5编码。

o 把MD5编码后的数据进行Base64编码，此时编码后的字符串即为校验码。

3.3. 接口规范说明

3.3.1. 接口基本信息说明以下表为例： 1 服务名称第 6页 /共 59页

OrderService 企业服务平台技术规范 – 接口规范说明 2 批量交易 3 接口类型 4 接口方法不支持接入 String sfexpressService(String xml, String verifyCode) 1) 服务名称：此接口的服务名称。

2) 批量交易：此接口是否支持批量交易，若支持，则会说明所支持的元素/元素属性。 3) 接口类型：BSP接口分为接入与推送两类接口。 4) 接口方法：此接口的方法。 3.3.2. XML报文说明

BSP使用的XML报文需要遵循以下格式与规则：

? 请求XML报文：

o service 属性与Head元素预先定义了“服务名”及“接入编码”。 o “接入编码”统一由顺丰BSP系统管理员分配。

o lang属性用于定义响应报文的语言，缺省值为zh-CN，目前支持以下值zh-CN表示中文简体，zh-TW或zh-HK或zh-MO表示中文繁体，en表示英文。

接入编码

请求数据XML

? 响应XML报文：

o Head元素值为OK或ERR；OK代表交易成功，ERR代表发生系统或业务异

常，交易失败；对于批量交易场景，只能为成功/失败，无部分成功/部分失败，只要存在有未成功接收的信息即认为为失败。

o Head元素值为OK时只返回Body元素，为ERR时只返回Error元素，Body

与Error元素不能同时存在。

o Error元素中的code属性值为四位数字，错误编码的描述请参考附录《原

因代码表》。

第 7页 /共 59页

企业服务平台技术规范 – 接口规范说明

OK|ERR

正常响应数据XML

? 扩展字段

o 个别接口存在扩展字段，扩展字段使用数据元素下保留元素的属性

进行定义。

o 字段的数目最多支持20个，超过20个的部分将被忽略。 o 属性名为e1,…,e20，只支持字符串值。

3.3.3. 元素及元素属性说明以下表为例： 1 4.2.2. 元素<请求>Order # 1 2 2 属性名 orderid 3 4 类型（约束）必填 String(64) 是 5 默认值 6 描述客户订单号顺丰运单号，一个订单只能有一个母单号，如果是子母单的情况，以半角mailno String(4000) 条件逗号分隔，主单号在第一个位置，如“755123456789,001123456789,002123456789”，对于路由推送注册，此字段为必填。 3 is_gen_bill_no Number(1) 否 _SYSTEM 是否要求返回顺丰运单号： ? 1：要求 ? 其它为不要求 1) 元素标题，其中<请求>表示此元素属于请求XML报文中的元素，同样<响应>表示

其属于响应XML报文中的元素，Order表示此元素的名称，元素名称后若带“（可选）“代表此元素在XML报文中为可选的元素。 2) 属性名：属于此元素的属性名称，元素的属性也称字段。

第 8页 /共 59页

企业服务平台技术规范 – 接口规范说明

3) 类型（约束）：表示此属性的数据类型，包括：

o String(n)：n代表字节长度（中文汉字占3字节）。

o Number(m,n)：m代表总有效数字的位数，n代表小数点后的有效数字的位

数。

o Date：代表日期，格式为YYYY-MM-DD HH24:MM:SS。

4) 必填：表示此属性是否必填，包括：

o 是：此属性为必填。 o 否：此属性为非必填。

o 条件：此属性在某条件下为必填，在描述中会对此说明。

5) 默认值：属性的默认值，如果接口定义中字段默认值标记有 “_SYSTEM”，则表示这

个字段可由顺丰内部为客户配置。

6) 描述：此属性的意义，用途及注意事项的说明。

3.4. 开发用公共接口信息

客户开发时可调用以下公共接口，具体联调需与商务人员沟通安排联调日程。

? · WEBSERVICE地址

? http://bspoisp.sit.sf-express.com:11080/bsp-oisp/ws/sfexpressService?wsdl ? 或者

? https://bspoisp.sit.sf-express.com:11443/bsp-oisp/ws/sfexpressService?wsdl ? ?

? ·HTTP/POST地址

? http://bspoisp.sit.sf-express.com:11080/bsp-oisp/sfexpressService ? 或者

? https://bspoisp.sit.sf-express.com:11443/bsp-oisp/sfexpressService ? 开发环境接入编码：BSPdevelop

? 开发环境Checkword：j8DzkIFgmlomPt0aLuwU ? BSP接口开发咨询QQ群号码：314535266

第 9页 /共 59页

企业服务平台技术规范 – 下订单（含筛选）接口

4. 下订单（含筛选）接口

4.1. 功能描述

下订单接口根据客户需要，可提供以下三个功能：

1) 客户系统向顺丰下发订单。 2) 为订单分配运单号。

3) 筛单（可选，具体商务沟通中双方约定，由顺丰内部为客户配置）。

此接口也用于路由推送注册。客户的顺丰运单号不是通过此下订单接口获取，但却需要获取BSP的路由推送时，需要通过此接口对相应的顺丰运单进行注册以使用BSP的路由推送接口。

4.2. 接口定义

4.2.1. 接口基本信息服务名称批量交易接口类型接口方法 OrderService 不支持接入 String sfexpressService(String xml, String verifyCode) 4.2.2. 元素<请求>Order # 1 属性名 orderid 类型（约束）必填 String(64) 是默认值描述客户订单号顺丰运单号，一个订单只能有一个母单号，如果是子母单的情况，以半角2 mailno String(4000) 条件逗号分隔，主单号在第一个位置，如“755123456789,001123456789,002123456789”，对于路由推送注册，此字段为必填。第 10页 /共 59页

企业服务平台技术规范 – 下订单（含筛选）接口 # 属性名 is_gen_bill_no 类型（约束）必填 Number(1) 默认值 _SYSTEM 描述是否要求返回顺丰运单号： 3 否 ? 1：要求 ? 其它为不要求 4 5 6 7 8 9 j_company j_contact j_tel j_mobile j_shippercode j_country String(100) String(100) String(20) String(20) String(30) String(30) 条件条件条件否条件否 _SYSTEM _SYSTEM _SYSTEM _SYSTEM 寄件方公司名称，如果需要生成电子运单，则为必填。寄件方联系人，如果需要生成电子运单，则为必填。寄件方联系电话，如果需要生成电子运单，则为必填。寄件方手机寄件方国家/城市代码，如果是跨境件，则此字段为必填。寄方国家寄件方所在省份 10 j_province String(30) 否 _SYSTEM 字段填写要求：必须是标准的省名称称谓如：广东省，如果是直辖市，请直接传北京、上海等。寄件方所在城市名称，字段填写要11 j_city String(100) 否 _SYSTEM 求：必须是标准的城市称谓如：深圳市。 12 j_county String(30) 否寄件人所在县/区，必须是标准的县/区称谓，示例：“福田区”。寄件方详细地址，包括省市区，示13 j_address String(200) 条件 _SYSTEM 例：“广东省深圳市福田区新洲十一街万基商务大厦10楼” ，如果需要生成电子运单，则为必填。 14 j_post_code 15 d_company 16 d_contact 17 d_tel 第 11页 /共 59页

String(25) String(100) String(100) String(20) 条件是是是寄方邮编，跨境件必填（中国大陆，港澳台互寄除外）。到件方公司名称到件方联系人到件方联系电话企业服务平台技术规范 – 下订单（含筛选）接口 # 属性名类型（约束）必填 String(20) 否默认值描述到件方手机到件方代码，如果是跨境件，则要传这个字段，用于表示到方国家的城19 d_deliverycode String(30) 条件市。如果此国家整体是以代理商来提供服务的，则此字段可能需要传国家编码。具体商务沟通中双方约定。 20 d_country String(30) 否到方国家到件方所在省份，必须是标准的省名称称谓如：广东省，如果是直辖市，请直接传北京、上海等。如果此字段21 d_province String(30) 否与d_city字段都有值，BSP则直接使用这两个值而不是通过对d_address进行地址识别获取。为避免地址识别不成功的风险，建议传输此字段。到件方所在城市名称，必须是标准的城市称谓如：深圳市，如果是直辖市，请直接传北京（或北京市）、上22 d_city String(100) 否海（或上海市）等。如果此字段与d_province字段都有值，BSP则直接使用这两个值而不是对d_address进行地址识别获取。为避免地址识别不成功的风险，建议传输此字段。 23 d_county String(30) 否到件方所在县/区，必须是标准的县/区称谓，示例：“福田区”。到件方详细地址，如果不传输d_province/d_city字段，此详细地址24 d_address String(200) 是需包含省市信息，以提高地址识别的成功率，示例：“广东省深圳市福田区新洲十一街万基商务大厦10楼”。 25 d_post_code String(25) 条件到方邮编，跨境件必填（中国大陆，港澳台互寄除外）。 18 d_mobile 第 12页 /共 59页

企业服务平台技术规范 – 下订单（含筛选）接口 # 属性名类型（约束）必填 String(20) 条件默认值 _SYSTEM 描述顺丰月结卡号付款方式： 27 pay_method Number(1) 否 1 _SYSTEM ? 1:寄方付 ? 2:收方付 ? 3:第三方付 28 express_type String(5) 否 1 _SYSTEM 快件产品类别，详见附录《快件产品类别表》，只有在商务上与顺丰约定的类别方可使用。包裹数，一个包裹对应一个运单号，29 parcel_quantity Number(5) 否 1 如果是大于1个包裹，则返回则按照子母件的方式返回母运单号和子运单号。 30 cargo_length 31 cargo_width 32 cargo_height Number(10, 3) 否 Number(10, 3) 否 Number(10, 3) 否客户订单货物总长，单位厘米，精确到小数点后3位，包含子母件。客户订单货物总宽，单位厘米，精确到小数点后3位，包含子母件。客户订单货物总高，单位厘米，精确到小数点后3位，包含子母件。订单货物总体积，单位立方厘米，精33 volume Number(17,3) 否确到小数点后3位，会用于计抛（是否计抛具体商务沟通中双方约定）。 34 cargo_total_weight 订单货物总重量，包含子母件，单位Number(10,3) 否千克，精确到小数点后3位，如果提供此值，必须>0 。客户订单货物总声明价值，包含子母35 declared_value Number(15, 3) 条件件，精确到小数点后3位。如果是跨境件，则必填。 26 custid 第 13页 /共 59页

企业服务平台技术规范 – 下订单（含筛选）接口 # 属性名类型（约束）必填默认值描述货物声明价值币别，支持以下值： ? CNY: 人民币 ? HKD: 港币 ? USD: 美元 ? NTD: 新台币如果目的地是中国36 declared_value_currency 大陆的，String(5) 否则默认为CNY，否则默认为USD ? RUB: 卢布 ? EUR: 欧元 ? MOP: 澳门元 ? SGD: 新元 ? JPY: 日元 ? KRW: 韩元 ? MYR: 马币 ? VND: 越南盾 ? THB: 泰铢 ? AUD: 澳大利亚元 ? MNT: 图格里克跨境件报关需要填写 37 customs_batchs String(20) 否 _SYSTEM BSP接收38 sendstarttime Date 否到XML报文的时间报关批次要求上门取件开始时间，格式：YYYY-MM-DD HH24:MM:SS，示例：2012-7-30 09:30:00。是否要求通过是否手持终端通知顺丰39 is_docall Number(1) 否 _SYSTEM 收派员收件： ? 1：要求 ? 其它为不要求 40 need_return_tracking_no 是否要求签回单号： String(2) String(30) String(30) 否否否 ? 1：要求 ? 其它为不要求 41 return_tracking 42 d_tax_no 顺丰签回单服务运单号收件人税号第 14页 /共 59页

企业服务平台技术规范 – 下订单（含筛选）接口 # 属性名类型（约束）必填 String(5) String(30) String(100) String(100) String(100) String(100) String(100) String(600) String(600) 默认值描述税金付款方式： 43 tax_pay_type 44 tax_set_accounts 45 original_number 46 payment_tool 47 payment_number 48 goods_code 49 in_process_waybill_no 否否否否否否否否否 ? 1：寄付 ? 2：到付税金结算账号电商原始订单号支付工具支付号码商品编号头程运单号货物品牌货物规格型号温度范围类型，当express_type为1252 temp_range Number(1,0) 条件医药温控件时必填： ? 1为冷藏 ? 3为冷冻 53 order_name 54 order_cert_type 55 order_cert_no 56 order_source String(100) String(100) String(100) String(50) 否否否否客户订单下单人姓名客户订单下单人证件类型客户订单下单人证件号客户订单来源（对于平台类客户，如果需要在订单中区分订单来源，则可使用此字段）业务模板编码，业务模板指BSP针对57 template String(30) 否客户业务需求配置的一套接口处理逻辑，一个接入编码可对应多个业务模板。 58 remark String(100) 否否 50 brand 51 specifications 0 备注快件自取；1表示客户同意快件自取；非1表示客户不同意快件自取 59 oneself_pickup_flg Number(1) 60 dispatch_sys 注意事项： String(20) 否订单数据分发的系统编码第 15页 /共 59页

企业服务平台技术规范 – 下订单（含筛选）接口

1) 可从顺丰商务人员处获取标准的中国省市县/区列表。 2) 可从顺丰商务人员处获取标准的国家/城市代码列表。 4.2.3. 元素<请求>Order/Cargo # 1 2 3 属性名 name count unit 类型（约束）必填 String(60) Number(5) String(30) 是条件条件默认值描述货物名称，如果需要生成电子运单，则为必填。货物数量跨境件报关需要填写货物单位，如：个、台、本，跨境件报关需要填写。订单货物单位重量，包含子母件，单4 weight Number(16,3) 条件位千克，精确到小数点后3位跨境件报关需要填写。 5 amount Number(17,3) 条件货物单价，精确到小数点后3位，跨境件报关需要填写。第 16页 /共 59页

企业服务平台技术规范 – 下订单（含筛选）接口 # 属性名类型（约束）必填默认值描述货物单价的币别： ? CNY: 人民币 ? HKD: 港币 ? USD: 美元 ? NTD: 新台币 ? RUB: 卢布 ? EUR: 欧元 ? MOP: 澳门元 6 currency String(5) 条件 ? SGD: 新元 ? JPY: 日元 ? KRW: 韩元 ? MYR: 马币 ? VND: 越南盾 ? THB: 泰铢 ? AUD: 澳大利亚元 ? MNT: 图格里克跨境件报关需要填写。 7 8 9 source_area product_record_no good_prepard_no String(5) String(18) String(100) 条件否否原产地国别，跨境件报关需要填写。货物产品国检备案编号商品海关备案号 4.2.4. 元素<请求>Order/ AddedService（可选）属性名 name value value1 类型（约束）必填 String(20) String(30) String(30) 是条件条件默认值描述增值服务名，如COD等。增值服务扩展属性，参考增值服务传值说明。增值服务扩展属性 4.2.5. 元素<响应> OrderResponse # 1 属性名 orderid 类型（约束）必填 String(64) 是默认值描述客户订单号第 17页 /共 59页

企业服务平台技术规范 – 下订单（含筛选）接口 # 属性名类型（约束）必填默认值描述顺丰运单号，一个订单只能有一个母单号，如果是子母单的情况，以半角2 mailno String(4000) 否逗号分隔，主单号在第一个位置，如“755123456789,001123456789,002123456789” ，可用于顺丰电子运单标签打印。 3 4 5 return_tracking_no origincode destcode String(30) String(10) String(10) 否否否顺丰签回单服务运单号原寄地区域代码，可用于顺丰电子运单标签打印。目的地区域代码，可用于顺丰电子运单标签打印。筛单结果： 6 filter_result Number(2) 否 ? 1：人工确认 ? 2：可收派 ? 3：不可以收派如果filter_result=3时为必填，不可以收派的原因代码： 7 remark String(100) 条件 ? 1：收方超范围 ? 2：派方超范围 ? 3-：其它原因 4.2.6. 增值服务下单属性说明 # 名称代码说明 ? value为货款，以原寄地所在区域币种为1 代收货款 COD 准，如中国大陆为人民币，香港为港币，保留3位小数。 ? value1为代收货款卡号 ? value为声明价值以原寄地所在区域币种2 3 保价签收短信通知 INSURE MSG 为准，如中国大陆为人民币，香港为港币，保留3位小数。 ? value为手机号码备注第 18页 /共 59页

企业服务平台技术规范 – 下订单（含筛选）接口 # 4 5 6 7 名称包装服务特殊保价特殊配送特殊增值服务代码 PKFEE SINSURE SDELIVERY SADDSERVICE 说明 ? value为包装费费用，单位与主运费一致 ? value为服务费，单位与主运费一致 ? value为服务费，单位与主运费一致 ? value 为服务费，单位与主运费一致 value为派送日期（格式：YYYYMMDD），8 定时派送 TDELIVERY value1为派送时间段调整为09:00-12:00、12:01-18:00、18:01-21:00三个选项（分别用快捷键1、2、3代表） 9 电商加急 URGENT Esign ? Value 为图片类型： 10 电子签收 1、身份证，2、军官证，3、护照，4、其他 Value1 为照片张数 Value 为图片类型： 10 拍照验证 11 保鲜服务 12 大闸蟹 13 票据专送 4.2.7. 扩展字段信息

此接口支持扩展字段，遵循扩展字段规范，参考XML报文说明。 4.2.8. 报文范例

请求XML，使用公共接口信息开发时，按需修改客户订单号（Order元素中的orderid属性）：

? 中国大陆件：

BSPdevelop

orderid='TE20150104'

j_company='罗湖火车站'

备注 Value和value1必填 Psign FRESH IN98 IN99 1、身份证，2、军官证，3、护照，4、其他 Value1 为照片张数 ? ? ? 第 19页 /共 59页

企业服务平台技术规范 – 下订单（含筛选）接口

j_contact='小雷' j_tel='13810744' j_mobile='13111744' j_province='广东省' j_city='深圳' j_county='福田区'

j_address='罗湖火车站东区调度室' d_company='顺丰速运' d_contact='小邱' d_tel='15819050'

d_mobile='15539050'

d_address='北京市海淀区中关村' express_type='1' pay_method='1'

parcel_quantity='1' cargo_length='33' cargo_width='33' cargo_height='33' remark=''>

name='LV1' count='3' unit='a' weight='' amount='' currency=''

source_area=''>

name='LV2' count='3' unit='a' weight='' amount='' currency=''

source_area=''>

value1='0123456789'>

第 20页 /共 59页

企业服务平台技术规范 – 下订单（含筛选）接口

e2=”abc”/>

? 跨境件：

BSPdevelop

orderid='TEST_201501290001' j_company='SFSingapore' j_contact='PeterK' j_tel='12345678' j_mobile='12345678' j_shippercode='SIN01D' j_country='SG'

j_province='Singapore' j_city='Singapore' j_county='Singapore'

j_address='7SixthLokYangRoad#11-11Singapore628105' j_post_code='628105' d_deliverycode='852' d_country='HK'

d_company='Daniel' d_contact='DanielLi' d_tel='87654321' d_mobile='87654321' d_province='Hong Kong' d_city='Hong Kong' d_county='Hong Kong'

d_address='27/Ftestaddress,Kowloon,HongKong' d_post_code='852852' custid='0650000001' pay_method='1' express_type='23' parcel_quantity='1'

cargo_total_weight='2.18' declared_value='1'

declared_value_currency='CNY'

sendstarttime='2014-12-1707:08:38' remark='beizhu'>

name='nailcare' count='20' unit='pcs'

weight='0.003' amount='0.05' currency='CNY'

source_area='China'>

响应XML：

? 订单处理成功：

o 中国大陆件：

第 21页 /共 59页

企业服务平台技术规范 – 下订单（含筛选）接口

orderid=\mailno=\origincode=\destcode=\

filter_result=\

o 跨境件：

orderid=\mailno=\origincode=\destcode=\

filter_result=\

? 订单处理失败：

o 范例1：

ERR

o 范例2：

ERR

第 22页 /共 59页

企业服务平台技术规范 – 订单确认/取消接口

5. 订单确认/取消接口

5.1. 功能描述

该接口用于：

? 客户在确定将货物交付给顺丰托运后，将运单上的一些重要信息，如快件重量通过

此接口发送给顺丰。 ? 客户在发货前取消订单。

注意：订单取消之后，订单号也是不能重复利用的。

5.2. 接口定义

5.2.1. 接口基本信息服务名称批量交易接口类型接口方法 OrderConfirmService 不支持接入 String sfexpressService(String xml, String verifyCode) 5.2.2. 元素<请求> OrderConfirm # 1 2 3 属性名 orderid mailno dealtype 类型（约束）必填 String(64) String(20) Number(1) 是条件否默认值 1 描述客户订单号顺丰母运单号(如果dealtype=1，必填) 客户订单操作标识： ? 1：确认 ? 2：取消 5.2.3. 元素<请求> OrderConfirm/OrderConfirmOption（可选） # 属性名类型（约束）必填默认值描述第 23页 /共 59页

企业服务平台技术规范 – 订单确认/取消接口 # 属性名 weight 类型（约束）必填 Number(10,3) 默认值描述订单货物总重量，包含子母件，单位1 否千克，精确到小数点后2位，如果提供此值，必须>0。货物的总体积（值为长，宽，高），包含子母件，以半角逗号分隔，单位2 volume String(100) 否厘米，精确到小数点后2位，会用于计抛（是否计抛具体商务沟通中双方约定）。 3 return_tracking String(30) 否顺丰签回单服务运单号快件产品类别，详见附录《快件产品4 express_type String(5) 否类别表》，只有在商务上与顺丰约定的类别方可使用。如果此字段为空，则以下单时的为准。 5 children_nos String(1000) 否子单号（以半角逗号分隔）如果此字段为空，则以下订单时为准。 5.2.4. 元素<响应> OrderConfirmResponse # 1 2 属性名 orderid mailno 类型（约束）必填 String(64) String(20) 是条件默认值描述客户订单号顺丰母运单号(如果dealtype=1，必填) 备注 3 res_status Number(1) 是 ? 1：客户订单号与顺丰运单不匹配 ? 2 ：操作成功 5.2.5. 扩展字段信息

此接口支持扩展字段，遵循扩展字段规范，参考XML报文说明。 5.2.6. 报文范例

请求XML，使用公共接口信息开发时，按需修改客户订单号及顺丰运单号（OrderConfirm元素中的orderid属性与mailno属性）：

第 24页 /共 59页

企业服务平台技术规范 – 订单确认/取消接口

BSPdevelop

orderid='TE201500104' mailno='444003078326' dealtype='1'>

volume=’33,33,33’/>

响应XML：

? 订单确认成功：

? 订单确认失败：

o 范例1

ERR

o 范例2

ERR

第 25页 /共 59页

企业服务平台技术规范 – 订单结果查询接口

6. 订单结果查询接口

6.1. 功能描述

因Internet环境下，网络不是绝对可靠，用户系统下订单到顺丰后，不一定可以收到BSP返回的数据，此接口用于在未收到返回数据时，查询下订单（含筛选）接口客户订单当前的处理情况。

6.2. 接口定义

6.2.1. 接口基本信息服务名称批量交易接口类型接口方法 OrderSearchService 不支持接入 String sfexpressService(String xml, String verifyCode) 6.2.2. 元素<请求> OrderSearch # 1 属性名 orderid 类型（约束）必填 String(64) 是默认值描述客户订单号 6.2.3. 元素<响应> OrderSearchResponse # 1 属性名 orderid 类型（约束）必填 String(64) 是默认值描述客户订单号顺丰运单号，一个订单只能有一个母单号，如果是子母单的情况，以半角2 mailno String(4000) 是逗号分隔，主单号在第一个位置，如“755123456789,001123456789,002123456789”。 3 4 origincode destcode String(10) String(10) 是是原寄地区域代码目的地区域代码第 26页 /共 59页

企业服务平台技术规范 – 订单结果查询接口 # 属性名类型（约束）必填默认值描述筛单结果： 5 filter_result Number(2) 否 ? 1：人工确认 ? 2：可收派 ? 3：不可以收派如果filter_result=3时为必填，不可以收派的原因代码： 6 remark String(100) 否 ? 1：收方超范围 ? 2：派方超范围 ? 3-：其它原因 6.2.4. 报文范例

请求XML，使用公共接口信息开发时，按需修改客户订单号（OrderSearch元素中的orderid属性）：

BSPdevelop

响应XML：

? 订单处理成功：

orderid=\mailno=\origincode=\destcode=\

filter_result=\

? 订单处理失败：

ERR

第 27页 /共 59页

企业服务平台技术规范 – 订单筛选接口

7. 订单筛选接口

7.1. 功能描述

客户系统通过此接口向BSP发送主动的筛单请求，用于判断客户的收、派地址是否属于顺丰的收派范围。

7.2. 接口定义

7.2.1. 接口基本信息服务名称批量交易接口类型接口方法 OrderFilterService 最多5个OrderFilter元素接入 String sfexpressService(String xml, String verifyCode) 7.2.2. 元素<请求> OrderFilter # 属性名类型（约束）必填默认值描述筛单类别： ? 1：自动筛单（系统根据地址库进行判断，并返回结果，系统无法检索到可派送的将返回不可派送） 1 filter_type Number(1) 否 1 ? 2：可人工筛单（系统首先根据地址库判断，如果无法自动判断是否收派，系统将生成需要人工判断的任务，后续由人工处理，处理结束后，顺丰可主动推送给客户系统） 2 orderid String(64) 条件客户订单号，filter_type=2则必须提供。第 28页 /共 59页

企业服务平台技术规范 – 订单筛选接口 # 属性名 d_address 类型（约束）必填 String(150) 默认值描述到件方详细地址，需要包括省市区，3 是如：广东省深圳市福田区新洲十一街万基商务大厦。 7.2.3. 元素<请求> OrderFilter/OrderFilterOption（可选） # 1 2 3 属性名 j_tel country province 类型（约束）必填 String(20) String (50) String (30) 否否否默认值 CN 描述寄件方电话寄件人所在国家代码寄件方所在省份，必须是标准的省名称称谓如：广东省，如果是直辖市，请直接传北京、上海等。 4 5 6 7 city county d_country d_province String (100) String (30) String(50) String (30) 否否否否 CN 寄件方所属城市名称，必须是标准的城市称谓如：深圳市。寄件人所在县/区，必须是标准的县/区称谓，示例：“福田区”。到件方国家到件方所在省份，必须是标准的省名称称谓如：广东省，如果是直辖市，请直接传北京、上海等。到件方所属城市名称，必须是标准的8 d_city String (100) 否城市称谓如：深圳市，如果是直辖市，请直接传北京（或北京市）、上海（或上海市）等。 9 d_county String (30) 否到件方所在县/区，必须是标准的县/区称谓，示例：“福田区”。寄件方详细地址，包括省市区，示10 j_address 11 d_tel 12 j_custid String(150) String(23) String(30) 否否否例：“广东省深圳市福田区新洲十一街万基商务大厦10楼”。到件方电话结账号，用于在人工筛单时，筛单人员识别客户使用。第 29页 /共 59页

本文来源：https://www.bwwdw.com/article/5hvo.html

相关文章：

正在阅读：

企业服务平台接入技术规范 - V3.6 - 16050701-17

水泥回转窑物料平衡、热平衡与热效率计算方11-18

国家电网公司电力安全工作规程(配电部分)(试行)04-30

Modbus的智能仪表与PC机通信技术实现12-27

知识点165 坐标与图形性质(解答)07-06

数字系统设计与VHDL 实验指导书2014 - 图文12-08

各大学报投稿邮箱11-04

2019-2020年七年级数学上第二章有理数及其运算单元测试含答案10-22

毕业设计说明书05-02

江苏省财政厅、江苏省交通运输厅关于印发江苏省农村公路提档升05-14

上一篇：边疆少数民族地区低龄儿童汉语言能力培养的重要性下一篇：2017秋部编人教版八年级上-八年级上语文练习（一）