世聯翻譯公司完成平臺接入技術規范中文翻譯
時間:2018-09-19 10:47 來源:未知 作者:dongli 點擊:次
世聯翻譯公司完成平臺接入技術規范中文翻譯
1. 前言
本文檔目的是定義BSP企業服務平臺的通用對外服務接口，以便快速集成大客戶自有的系統，從而打通大客戶與順豐系統之間的信息流，實現整體物流供應鏈的一體化，進而達到順豐與客戶的雙贏。
2. 接口規范說明 接口規范說明
通用對外服務接口統一使用UTF-8編碼的XML報文，接口通信協議支持WEBSERVICE、HTTP/POST、FTP三種協議，當前主要使用WEBSERVICE協議方式。
通用對外服務接口分為主動接入與對外推送兩類接口，基于FTP協議的對外推送類接口無需對應的響應報文，其他均存在對應的請求與響應報文；以下定義了通用對外服務接口報文需要遵循的格式與規則：
. 請求報文：
<Request service="服務名" lang="zh-CN">
<Head>客戶卡號,校驗碼</Head>
<Body>請求數據XML</Body>
</Request>
關鍵規則：
a) service 屬性與HEAD元素預先定義了服務名，客戶卡號及檢驗碼，結合請求的客戶IP地址可以滿足只要通過預解析HEAD元素就能夠進行系統功能權限的驗證，無功能權限情況下無需進一步解析Body內部數據，大大提高了攔截非法訪問的性能；
b) 客戶卡號與校驗碼統一使用順豐分配的客戶卡號與校驗碼；
c) lang屬性用于支持國際化請求，缺省值為zh-CN。
. 響應報文：
<Response service="服務名">
<Head>OK|ERR</HEAD>
<BODY>正常響應數據XML</BODY>
<ERROR code="NNNN">錯誤詳細信息</ERROR>
</Response>
關鍵規則：
a) Head元素值為OK或ERR；OK代表交易正常，ERR代表發生系統或業務異常；對于批量交易場景，部分交易異常必須返回OK值，且必須在返回BODY中標識出發生異常的交易記錄，避免下次全部重發；
BSP-企業服務平臺接入技術規范
順豐集團資訊科技本部研發中心 4
2013 年 06 月 01 日
b) Head元素值為OK時返回BODY元素，為ERR時返回ERROR元素；BODY與ERROR元素不能同時存在；
c) ERROR元素中的code屬性值為四位數字，錯誤編碼的描述請參考文檔的最后一個部分。
. 批量交易記錄數限制為20條以下（參考順豐網站），特定業務可以自定義不支持批量交易或小于20的批量記錄數限制。
. 請求或正常響應數據XML中數據元素的定義需遵循將必要字段（包含有默認值的字段），可選字段及擴展字段進行分開定義的原則，同時字段盡量通過元素的屬性進行定義，字段值限制在200字符以下（50個漢字以下）；必要字段使用數據元素本身的屬性進行定義，可選項字段在數據元素下定義“數據元素名+Option”元素并通過其屬性進行定義，擴展字段使用數據元素下保留元素<Extra>的屬性進行定義；必要字段的數目盡量控制在10個以下；如：
<Order id="XXXX" …>
<OrderOption payment="XXXX" …/>
<Extra e1="XXXX" …/>
</Order>
OrderOption元素的屬性及值由具體的業務數據定義；Extra 元素最大支持20個屬性，屬性名為e1,…,e20,只支持字符串值。
. 盡量通過客戶個性化服務配置的方式減少接口報文需要傳遞的字段量，如在訂單報文中加入發貨點代碼的方式，可以在后臺基于客戶+發貨點代碼的方式配置月結賬號等等數據，避免在接口報文中傳遞附加的月結賬號。
. 請求與響應報文元素命名采用大寫字母開頭的單詞序列，如“OrderResponse”；屬性名統一使用小寫，如“orderid”；子元素在定義表格中一律使用“/”徑表示，如“outeTrackingResponse/Route”；
通用對外服務接口當前已經定義了快遞類服務接口，其參考地址參見：
Http://bsp-oip/sf-express.com/bsp-ois/ws/expressService
3. 快遞類服務 遞類服務 接口
3.1. 下訂單（含篩選）
3.1.1. 功能描述
下單接口根據客戶需要，可提供以下三個功能：
1） 客戶系統向順豐下發訂單。
2） 為訂單分配運單號。
BSP-企業服務平臺接入技術規范
順豐集團資訊科技本部研發中心 5
2013 年 06 月 01 日
3） 篩單。
3.1.2. 接口主信息定義
服務名稱
OrderService
批量交易限制
不支持
接口類型
接入
協議類型
WEBSERVICE
接口方法
public String sfexpressService(String XML);
數據元素<請求>
Order
必要字段名
類型（約束）
默認值
描述
order rder id
String(64) String(64)String(64) String(64) String(64) String(64)
客戶 訂單號， 訂單號， 訂單號， 訂單號， 建議 英文字母 英文字母 英文字母 英文字母 +YYMMDD +YYMMDD +YYMMDD +YYMMDD（日 期） +流水號，如： 流水號，如： 流水號，如： TB1207300000001 TB1207300000001 TB1207300000001TB1207300000001 TB1207300000001TB1207300000001 TB1207300000001 TB1207300000001 TB1207300000001
express_type express_typeexpress_type express_type express_type express_type express_type
String( String(String( String( 5)
標準快遞 標準快遞
快件產品類別 快件產品類別 快件產品類別
1標準快遞 標準快遞
2順豐特惠 順豐特惠
j_company j_companyj_company j_company j_company
String(100) String(100)String(100) String(100) String(100) String(100)
_SYSTEM _SYSTEM_SYSTEM _SYSTEM
寄件方公司名稱 寄件方公司名稱 寄件方公司名稱 寄件方公司名稱 寄件方公司名稱 寄件方公司名稱 寄件方公司名稱 , _SYSTEM _SYSTEM _SYSTEM _SYSTEM表示 如果不提 如果不提 如果不提 如果不提 供，將 從系統配置獲取 從系統配置獲取 從系統配置獲取 從系統配置獲取
j_contact j_contactj_contact j_contact j_contact
String(30) String(30)String(30) String(30) String(30) String(30)
_SYSTEM _SYSTEM_SYSTEM _SYSTEM
寄件方聯系人 寄件方聯系人 , _SYSTEM_SYSTEM _SYSTEM _SYSTEM_SYSTEM表示如果不提供， 表示如果不提供， 將從系統配置獲取 將從系統配置獲取 將從系統配置獲取 將從系統配置獲取
j_tel j_telj_tel
String(2 String(2String(2 String(2 String(20)
_SYSTEM _SYSTEM_SYSTEM _SYSTEM
寄件方聯系電話 寄件方聯系電話 寄件方聯系電話 寄件方聯系電話 寄件方聯系電話 寄件方聯系電話 寄件方聯系電話 , _SYSTEM _SYSTEM _SYSTEM _SYSTEM表示如果不 表示如果不 表示如果不 表示如果不 表示如果不 提 供，將從系統配置獲取 供，將從系統配置獲取 供，將從系統配置獲取 供，將從系統配置獲取 供，將從系統配置獲取
j_address j_addressj_address j_address j_address
String(150) String(150)String(150) String(150) String(150) String(150)
_SYSTEM _SYSTEM_SYSTEM _SYSTEM
寄件方詳細地址 寄件方詳細地址 寄件方詳細地址 寄件方詳細地址 寄件方詳細地址 寄件方詳細地址 寄件方詳細地址 ，包括省市區 ，包括省市區 ，包括省市區 ，包括省市區 ，包括省市區 ，包括省市區 ，示例：“ ，示例：“ ，示例：“ ，示例：“ ，示例：“ 廣東 省深圳市福田區 省深圳市福田區 省深圳市福田區 省深圳市福田區 省深圳市福田區 省深圳市福田區 省深圳市福田區 新洲十一街萬基商務大廈 新洲十一街萬基商務大廈 新洲十一街萬基商務大廈 新洲十一街萬基商務大廈 新洲十一街萬基商務大廈 新洲十一街萬基商務大廈 新洲十一街萬基商務大廈 新洲十一街萬基商務大廈 新洲十一街萬基商務大廈 新洲十一街萬基商務大廈 新洲十一街萬基商務大廈 10 樓” , _SYSTEM_SYSTEM _SYSTEM _SYSTEM 表示如果不提供，將從系 表示如果不提供，將從系 表示如果不提供，將從系 表示如果不提供，將從系 表示如果不提供，將從系 表示如果不提供，將從系 表示如果不提供，將從系 表示如果不提供，將從系 表示如果不提供，將從系 表示如果不提供，將從系 表示如果不提供，將從系 統配置獲取 統配置獲取
d_company _company _company _company
String(100) String(100)String(100) String(100) String(100) String(100)
到件方公司名稱 到件方公司名稱 到件方公司名稱
d_contact d_contactd_contact d_contact d_contact
String(30) String(30)String(30) String(30) String(30) String(30)
到件方聯系人 到件方聯系人 到件方聯系人
d_tel d_teld_tel
String(2 String(2String(2 String(2 String(20)
到件方聯系電話 到件方聯系電話 到件方聯系電話
d_address d_addressd_address d_address d_address
String(150) String(150)String(150) String(150) String(150) String(150)
到件方詳細地址，示例：“ 到件方詳細地址，示例：“ 到件方詳細地址，示例：“ 到件方詳細地址，示例：“ 到件方詳細地址，示例：“ 到件方詳細地址，示例：“ 到件方詳細地址，示例：“ 到件方詳細地址，示例：“ 到件方詳細地址，示例：“ 到件方詳細地址，示例：“ 到件方詳細地址，示例：“ 到件方詳細地址，示例：“ 廣東省深圳市福田 廣東省深圳市福田 廣東省深圳市福田 廣東省深圳市福田 廣東省深圳市福田 廣東省深圳市福田 廣東省深圳市福田 廣東省深圳市福田 區新洲十一街萬基商務大 新洲十一街萬基商務大 新洲十一街萬基商務大 新洲十一街萬基商務大 新洲十一街萬基商務大 廈10 樓”
parcel_quantity parcel_quantityparcel_quantity parcel_quantity parcel_quantity parcel_quantity parcel_quantity parcel_quantity
Number(5) Number(5)Number(5) Number(5) Number(5)
1
包裹數， 如果生成運單 號碼 ，需要提供此項。 一個包裹對應運單號，數據必須準確 一個包裹對應運單號，數據必須準確 一個包裹對應運單號，數據必須準確 一個包裹對應運單號，數據必須準確 一個包裹對應運單號，數據必須準確 一個包裹對應運單號，數據必須準確 一個包裹對應運單號，數據必須準確 一個包裹對應運單號，數據必須準確 。
pay_method pay_methodpay_method pay_method pay_method pay_method
Number umber umber(1)(1)
_SYSTEM _SYSTEM_SYSTEM _SYSTEM
付款方式： 1: 寄方付 2: 收方付 3: 第三方 付，默認為 ，默認為 ，默認為 1。_SYSTEM _SYSTEM _SYSTEM _SYSTEM表示如果不提供， 表示如果不提供， 表示如果不提供， 表示如果不提供， 表示如果不提供， 表示如果不提供， 將從系統配置獲取 將從系統配置獲取 將從系統配置獲取 將從系統配置獲取
j_province j_provincej_province j_province j_province j_province
String StringString String(30)
_SYSTEM _SYSTEM_SYSTEM _SYSTEM
寄件方所在省份字段填寫要求：必須是標準的省名稱謂 省名稱謂 如：廣東省 如：廣東省 如：廣東省
j_city j_cityj_city j_city
String StringString String(100)(100) (100)
_SYSTEM _SYSTEM_SYSTEM _SYSTEM
寄件方所屬城 寄件方所屬城 寄件方所屬城 市名稱 市名稱
字段填寫要求：必須是標準的城市稱謂 字段填寫要求：必須是標準的城市稱謂 字段填寫要求：必須是標準的城市稱謂 如： 深圳市
d_province d_provinced_province d_province d_province d_province
String StringString String(30)
到件方所在省份字段填寫要求：必須是標準的 省名稱謂 省名稱謂 如：廣東省 如：廣東省 如：廣東省
d_city d_cityd_city d_city
String StringString String(100)(100) (100)
到件方所屬城市名稱 件方所屬城市名稱 件方所屬城市名稱 件方所屬城市名稱
字段填寫要求：必須是標準的城市稱謂 字段填寫要求：必須是標準的城市稱謂 字段填寫要求：必須是標準的城市稱謂 如： 深圳市
數據元素<響應>
OrderResponse
字段名
類型（約束）
是否非空
描述
orderid rderid rderid
String(64) String(64)String(64) String(64) String(64) String(64)
否
訂單號
mailno mailnomailno mailno
String(20) String(20)String(20) String(20) String(20) String(20)
運單號 ，可多個單號如子母件以逗分隔 ，可多個單號如子母件以逗分隔 ，可多個單號如子母件以逗分隔 ，可多個單號如子母件以逗分隔 ，可多個單號如子母件以逗分隔 ，可多個單號如子母件以逗分隔 ，可多個單號如子母件以逗分隔 ，可多個單號如子母件以逗分隔
BSP-企業服務平臺接入技術規范
順豐集團資訊科技本部研發中心 6
2013 年 06 月 01 日
originc origincoriginc originc ode ode
String(10) String(10)String(10) String(10) String(10) String(10)
否
原寄地代碼 原寄地代碼
destc destcdestc ode ode
String(10) String(10)String(10) String(10) String(10) String(10)
否
目的地代碼 目的地代碼
filter_result filter_resultfilter_result filter_result filter_result filter_result filter_result
Number(2) Number(2)Number(2) Number(2) Number(2)
篩單結果： 1-人工確認， 人工確認， 人工確認， 人工確認， 人工確認， 2-可收派 3-不可 以收派
remark remarkremark remark
String(100) String(100)String(100) String(100) String(100) String(100)
1-收方超范圍， 收方超范圍， 收方超范圍， 收方超范圍， 2-派方超范圍， 派方超范圍， 派方超范圍， 3-其他原因 其他原因
3.1.3. 可選字段信息
數據元素
Order/OrderOption
字段名
類型（約束）
描述
custid custidcustid custid
String(20) String(20)String(20) String(20) String(20) String(20)
月結卡號 月結卡號 _SYSTEM _SYSTEM _SYSTEM _SYSTEM _SYSTEM 可配置
template templatetemplate template template
String StringString String(30)(30) (30)
模板選擇 模板選擇
j_shippercode j_shippercodej_shippercode j_shippercode j_shippercode j_shippercode j_shippercode
String(30) String(30)String(30) String(30) String(30) String(30)
寄件 方代碼 方代碼
d_deliverycode d_deliverycoded_deliverycode d_deliverycode d_deliverycode d_deliverycode d_deliverycode d_deliverycode
String(30 String(30String(30 String(30 String(30 )
到件 方代碼 方代碼
cargo cargocargo
String(4000) String(4000)String(4000) String(4000) String(4000) String(4000) String(4000)
貨物 名稱，可有多個貨物 名稱，可有多個貨物 名稱，可有多個貨物 名稱，可有多個貨物 名稱，可有多個貨物 名稱，可有多個貨物 名稱，可有多個貨物 名稱，可有多個貨物 名稱，可有多個貨物 名稱，可有多個貨物 名稱，可有多個， 如果有多個貨物以逗號分隔， 如果有多個貨物以逗號分隔， 如果有多個貨物以逗號分隔， 如果有多個貨物以逗號分隔， 如果有多個貨物以逗號分隔， 如果有多個貨物以逗號分隔， 如果有多個貨物以逗號分隔， 如果有多個貨物以逗號分隔， 如果有多個貨物以逗號分隔， 如果有多個貨物以逗號分隔， 如果有多個貨物以逗號分隔， 如果有多個貨物以逗號分隔， 如果有多個貨物以逗號分隔， 如果有多個貨物以逗號分隔， 如果有多個貨物以逗號分隔如：“手機 如：“手機 如：“手機 ,IPAD, ,IPAD, ,IPAD, 充電器“ 充電器“ 充電器“ 需生成電子運單，此字段必傳 需生成電子運單，此字段必傳 需生成電子運單，此字段必傳 需生成電子運單，此字段必傳 需生成電子運單，此字段必傳 需生成電子運單，此字段必傳 需生成電子運單，此字段必傳
cargo_count cargo_countcargo_count cargo_count cargo_count cargo_count
String(4000) String(4000)String(4000) String(4000) String(4000) String(4000) String(4000)
貨物數量，多個時以逗號分隔且與 貨物數量，多個時以逗號分隔且與 cargo cargo cargo中描述的貨 物相對應 物相對應
如： 2,1,32,1,3 2,1,3
cargo_unit cargo_unitcargo_unit cargo_unit cargo_unit cargo_unit
String(4000) String(4000)String(4000) String(4000) String(4000) String(4000) String(4000)
貨物單位，多個時以逗號 貨物單位，多個時以逗號 分隔，且與 cargo cargo cargo中描述的貨 物相對應 物相對應
如：個 ,臺,本
cargo_weight cargo_weightcargo_weight cargo_weight cargo_weight cargo_weight cargo_weight
String(4000) String(4000)String(4000) String(4000) String(4000) String(4000) String(4000)
貨物重量，多個時以逗號分隔且與 貨物重量，多個時以逗號分隔且與 cargo cargo cargo中描述的貨 物相對應 物相對應
如： 1.5,1.0,3.01.5,1.0,3.0 1.5,1.0,3.0 1.5,1.0,3.0 1.5,1.0,3.0 1.5,1.0,3.0
cargo_amount cargo_amountcargo_amount cargo_amount cargo_amount cargo_amount cargo_amount
String(4000) String(4000)String(4000) String(4000) String(4000) String(4000) String(4000)
貨物 單價 ，多個貨物時以逗號分隔且與 ，多個貨物時以逗號分隔且與 ，多個貨物時以逗號分隔且與 ，多個貨物時以逗號分隔且與 ，多個貨物時以逗號分隔且與 ，多個貨物時以逗號分隔且與 ，多個貨物時以逗號分隔且與 ，多個貨物時以逗號分隔且與 ，多個貨物時以逗號分隔且與 ，多個貨物時以逗號分隔且與 ，多個貨物時以逗號分隔且與 ，多個貨物時以逗號分隔且與 ，多個貨物時以逗號分隔且與 cargo cargo cargo中描述的貨 物相對應 物相對應
如： 1000,2000,15001000,2000,1500 1000,2000,1500 1000,2000,1500 1000,2000,1500 1000,2000,1500 1000,2000,1500 1000,2000,1500
cargo_total_weight cargo_total_weightcargo_total_weight cargo_total_weight cargo_total_weight cargo_total_weight cargo_total_weight cargo_total_weight cargo_total_weight cargo_total_weight
Number(10,2) Number(10,2)Number(10,2) Number(10,2) Number(10,2) Number(10,2) Number(10,2)
訂單貨物總重量，位 訂單貨物總重量，位 訂單貨物總重量，位 訂單貨物總重量，位 訂單貨物總重量，位 KG ，如果提供此值， 如果提供此值， 如果提供此值， 如果提供此值， 必須 >0
sendstarttime sendstarttimesendstarttime sendstarttime sendstarttime sendstarttime sendstarttime
dat e
要求上門取件開始時間，格式：YYYY-MM-DD HH24:MM:SS，示例：2012-7-30 09:30:00,默認為系統收到訂單的系統時間
mailno mailnomailno mailno
String( String(String( String( 400 4000)
運單號 ， 一個訂單只能有主號如果是子母的情況， 一個訂單只能有主號如果是子母的情況， 一個訂單只能有主號如果是子母的情況， 一個訂單只能有主號如果是子母的情況， 一個訂單只能有主號如果是子母的情況， 一個訂單只能有主號如果是子母的情況， 一個訂單只能有主號如果是子母的情況， 一個訂單只能有主號如果是子母的情況， 一個訂單只能有主號如果是子母的情況， 一個訂單只能有主號如果是子母的情況， 一個訂單只能有主號如果是子母的情況， 一個訂單只能有主號如果是子母的情況， 一個訂單只能有主號如果是子母的情況， 一個訂單只能有主號如果是子母的情況， 一個訂單只能有主號如果是子母的情況， 一個訂單只能有主號如果是子母的情況， 一個訂單只能有主號如果是子母的情況， 一個訂單只能有主號如果是子母的情況， 一個訂單只能有主號如果是子母的情況， 一個訂單只能有主號如果是子母的情況， 一個訂單只能有主號如果是子母的情況， 一個訂單只能有主號如果是子母的情況， 一個訂單只能有主號如果是子母的情況， 一個訂單只能有主號如果是子母的情況請以，分 請以，分
隔，主單在第一個位置如 隔，主單在第一個位置如 隔，主單在第一個位置如 隔，主單在第一個位置如 隔，主單在第一個位置如 隔，主單在第一個位置如 隔，主單在第一個位置如 隔，主單在第一個位置如 隔，主單在第一個位置如 隔，主單在第一個位置如 隔，主單在第一個位置如 隔，主單在第一個位置如 “755123456789,001123456789,002123456789 755123456789,001123456789,002123456789 755123456789,001123456789,002123456789 755123456789,001123456789,002123456789 755123456789,001123456789,002123456789 755123456789,001123456789,002123456789 755123456789,001123456789,002123456789 755123456789,001123456789,002123456789 755123456789,001123456789,002123456789755123456789,001123456789,002123456789 755123456789,001123456789,002123456789755123456789,001123456789,002123456789 755123456789,001123456789,002123456789 755123456789,001123456789,002123456789 755123456789,001123456789,002123456789 755123456789,001123456789,002123456789 755123456789,001123456789,002123456789 755123456789,001123456789,002123456789 755123456789,001123456789,002123456789 755123456789,001123456789,002123456789 “
remark remarkremark remark
String(100) String(100)String(100) String(100) String(100) String(100)
備注
數據元素
OrderOption/AddedService
字段名
類型（約束）
描述
name ame（定義對應關系） （定義對應關系） （定義對應關系） （定義對應關系） （定義對應關系）
String(20) String(20)String(20) String(20) String(20) String(20)
增值服務名 增值服務名 ，如 CODCOD 等
value valuevalue
String(30) String(30)String(30) String(30) String(30) String(30)
增值 服務增值 服務增值 服務1
BSP-企業服務平臺接入技術規范
順豐集團資訊科技本部研發中心 7
2013 年 06 月 01 日
增值服務傳值說明:
服務
NAME
說明
備注
代收貨款
COD
value為貨款，value1為客戶編碼
保價
INSURE
value為聲明價值
MSG
MSG
value為手機號碼
包裝費
PKFEE
value為包裝費費用
SMS
SMS
value為手機號碼,且與收件方的手機號相同.
value1 為個性化文字。
特殊保價
SINSURE
value為服務費。
特殊配送
SDELIVERY
value為服務費。
特殊增值服務費
SADDSERVICE
value 為服務費
3.1.4. 擴展字段信息
遵循擴展字段規范
3.1.5. 應用場景XML實例
. 場景1
場景描述：客戶下單
請求XML：
<Request service= Request service= Request service= Request service= Request service= Request service= Request service= Request service= ”OrderSerOrderSer OrderSerOrderSer OrderSer vice vice ” lang="zh lang="zh lang="zh lang="zh -CN" CN">
<Head> <Head><Head> <Head>j_custidj_custid j_custid j_custid j_custid（客戶卡號 客戶卡號 ）,checkwork ,checkwork ,checkwork ,checkwork ,checkwork （校驗碼 校驗碼 ）</Head> </Head> </Head> </Head>
<B ody>ody> ody>
<O rder rder rder orderid orderid orderid orderid=”訂單號 ” express_type express_type express_type express_type express_type express_type =”快件類型 快件類型 ” j_company j_company j_company j_company j_company=” 寄件方公司名稱 寄件方公司名稱 寄件方公司名稱 ” j_contact j_contactj_contact j_contact j_contact =”寄件方聯系人 寄件方聯系人 寄件方聯系人 寄件方聯系人 ” j_tel j_tel j_tel=”聯系電話 聯系電話 聯系電話 ” j_address j_addressj_address j_address j_address =”寄件地址 寄件地址 ” d_company d_company d_company d_company d_company=”到件方公司名 到件方公司名 到件方公司名 到件方公司名 稱” d_contact d_contact d_contact d_contact d_contact=”到件方聯系人 到件方聯系人 到件方聯系人 到件方聯系人 ” d_teld_tel d_tel =”聯系電話 聯系電話 ” d_addressd_address d_address d_address d_address =”到件方地址 到件方地址 到件方地址 ” parce parceparce l_quantity l_quantity l_quantity l_quantity l_quantity =”包裹數 包裹數 ” pay_method=pay_method= pay_method= pay_method= pay_method= pay_method= ”付款方式 付款方式 ”>
<O rderOptionrderOption rderOption rderOption rderOption rderOption custid= custid= custid= custid=”月結卡號 月結卡號 月結卡號 ” j_shippercode=”寄件方代碼” d_deliverycode=”到件方代碼” cargo cargo cargo=”貨物名稱 貨物名稱 ” cargo_total_weightargo_total_weight argo_total_weight argo_total_weight argo_total_weight argo_total_weight argo_total_weight argo_total_weightargo_total_weight argo_total_weight=”總重量 總重量 ” insurance_amount insurance_amount insurance_amount insurance_amountinsurance_amount insurance_amount insurance_amount insurance_amount insurance_amount=”申明價值 申明價值 申明價值 ” sendstarttime sendstarttimesendstarttime sendstarttime sendstarttime sendstarttime sendstarttime =”要求上門收件時間 要求上門收件時間 要求上門收件時間 要求上門收件時間 ” mailnomailno mailno mailno=”運單號 運單號 ” remarkremark remark remark=”備注 ”>
<AddedService name= <AddedService name=<AddedService name= <AddedService name= <AddedService name= <AddedService name= <AddedService name= <AddedService name= <AddedService name= <AddedService name= ”增值服務 增值服務 增值服務 1” value= value= value=value=”值 1” value value value1=”值 2” valuevalue valuevalue2=”值 3” value value value3=”值 4” value valuevalue 4=”值 5”/>
<! -- ...... // <AddedService> // <AddedService> // <AddedService> // <AddedService> // <AddedService> // <AddedService> // <AddedService>// <AddedService> // <AddedService> 可有多個 可有多個 -- >
</OrderOptionOrderOption OrderOption OrderOption OrderOption OrderOption >
value1 value1value1 value1
String(30) String(30)String(30) String(30) String(30) String(30)
增值 服務增值 服務增值 服務2
value2 value2value2 value2
String(30) String(30)String(30) String(30) String(30) String(30)
增值 服務增值 服務增值 服務3
value3 value3value3 value3
String(30) String(30)String(30) String(30) String(30) String(30)
增值 服務增值 服務增值 服務4
value4 value4value4 value4
String(30) String(30)String(30) String(30) String(30) String(30)
增值 服務增值 服務增值 服務5
BSP-企業服務平臺接入技術規范
順豐集團資訊科技本部研發中心 8
2013 年 06 月 01 日
<Extra <Extra<Extra <Extra e1= ”擴展字段 擴展字段 ” e2=”擴展字段 擴展字段 ” e3=”擴展字段 擴展字段 ” e4=”擴展字段 擴展字段 ” e5=”擴展字段 擴展字段 ” e6=”擴展字 擴展字 段” e7=”擴展字段 擴展字段 ” e8= e8=”擴展字段 擴展字段 ” e9= e9=”擴展字段 擴展字段 擴展字段 ” e10= e10= ”擴展字段 擴展字段 擴展字段 ” e11=e11=e11= ”擴展字段 擴展字段 ” e12= e12= ”擴展字 擴展字 段” e13= e13= ”擴展字段 擴展字段 擴展字段 ” e14=e14=e14= ”擴展字段 擴展字段 ” e1 5= ”擴展字段 擴展字段 ” e16= e16= ”擴展字段 擴展字段 擴展字段 ” e17=e17= e17=”擴展字段 擴展字段 ” e18= e18=e18=”擴展 字段 ” e19=e19= e19=”擴展字段 擴展字段 ” e20= e20=e20=”擴展字段 擴展字段 ”/>
</Order> </Order></Order> </Order> </Order>
</Body> ody>
</ RequestRequest Request Request >
響應XML：
訂單處理成功： 訂單處理成功： 訂單處理成功：
<Response <Response<Response <Response <Response service=service= service= service= service=”OrderService OrderServiceOrderService OrderService OrderService OrderService OrderService”>
<Head> <Head><Head> <Head>OK </Head></Head> </Head> </Head>
<Body> <Body><Body> <Body>
<O rderrder rderResponseResponse Response Response Response orderid= orderid= orderid= orderid=orderid=”訂單號 訂單號 ” mailno=mailno= mailno= mailno= ”主單 ,子單 1, 子單 2, …,子單 n” originCode=originCode= originCode= originCode=originCode= originCode= originCode=”原寄 地代碼 ” destCode= destCode= destCode= destCode= destCode=”目的地代碼 目的地代碼 目的地代碼 ” filter_result=”篩單結果 篩單結果 ” remark= remark= remark=remark= ”備注 ”/>
</Body> </Body></Body> </Body>
</Response> </Response></Response> </Response> </Response> </Response>
訂單處理失敗： 訂單處理失敗： 訂單處理失敗：
<Response service= <Response service=<Response service= <Response service= <Response service= <Response service= <Response service= <Response service= <Response service= <Response service=”OrderService OrderServiceOrderService OrderService OrderService OrderService OrderService”>
<Head> ERR</<Head>ERR</Head><Head> ERR</<Head> ERR</<Head> ERR</<Head> ERR</<Head> ERR</<Head> ERR</<Head>
ERR</<ERROR code="NNN <ERROR code="NNN<ERROR code="NNN <ERROR code="NNN <ERROR code="NNN <ERROR code="NNN <ERROR code="NNN <ERROR code="NNN <ERROR code="NNNN"> 錯誤詳細信息 錯誤詳細信息 錯誤詳細信息 </ERROR></ERROR> </ERROR> </ERROR> </ERROR>
</Response> </Response></Response> </Response> </Response> </Response>
3.2. 訂單發貨確認
3.2.1. 功能描述
該接口用于客戶在確定將貨物交付給順豐托運后，將運單上的一些重要信息，如快件重量、寄件時間，通過此接口發送給順豐。
3.2.2. 接口主信息定義
服務名稱
OrderConfirmService
批量交易限制
不支持
接口類型
接入
協議類型
WEBSERVICE
接口方法
public String sfexpressService(String XML);
數據元素<請求>
OrderConfirm
必要字段名
類型（約束）
默認值
描述
orderid rderid rderid
String(64) String(64)String(64) String(64) String(64) String(64)
訂單號
mailno ailno ailno
String(20) String(20)String(20) String(20) String(20) String(20)
運單號
數據元素<響應>
OrderConfirmResponse
字段名
類型（約束）
是否非空
描述
orderid orderidorderid orderid
St ring(64)ring(64) ring(64) ring(64) ring(64)
否
訂單號
mailno mailnomailno mailno
String(20) String(20)String(20) String(20) String(20) String(20)
否
運單號
res_status res_statusres_status res_status res_status res_status
Number NumberNumber Number(1)
備注 1-訂單號與運不匹配 訂單號與運不匹配 訂單號與運不匹配 訂單號與運不匹配 訂單號與運不匹配
2 成功
BSP-企業服務平臺接入技術規范
順豐集團資訊科技本部研發中心 9
2013 年 06 月 01 日
3.2.3. 可選字段信息
數據元素
OrderConfirm/OrderConfirmOption
字段名
類型（約束）
描述
weight weightweight weight
Number(10,2) Number(10,2)Number(10,2) Number(10,2) Number(10,2) Number(10,2) Number(10,2)
訂單重量，位 訂單重量，位 訂單重量，位 訂單重量，位 KG
vo lumelume lume
String(100) String(100)String(100) String(100) String(100) String(100)
托寄物的 托寄物的 長，寬高以逗號分隔 長，寬高以逗號分隔 長，寬高以逗號分隔 長，寬高以逗號分隔 長，寬高以逗號分隔 長，寬高以逗號分隔 ，單位 CM ，精確到小數點 ，精確到小數點 ，精確到小數點 ，精確到小數點 1位。
3.2.4. 擴展字段信息
遵循擴展字段規范
3.2.5. 應用場景XML實例
. 場景1
場景描述：
請求XML：
<Request service= Request service= Request service= Request service= Request service= Request service= Request service= Request service= ”OrderConfirmServiceOrderConfirmService OrderConfirmServiceOrderConfirmService OrderConfirmService OrderConfirmService OrderConfirmService OrderConfirmService OrderConfirmService OrderConfirmService OrderConfirmService” lang="zh lang="zh lang="zh lang="zh -CN"CN" >
<Head> <Head><Head> <Head>custidcustid custid custid（客戶卡號 客戶卡號 客戶卡號 ）,checkwork,checkwork ,checkwork ,checkwork ,checkwork ,checkwork（校驗碼 校驗碼 ）</Head></Head> </Head> </Head>
<B ody>ody> ody>
<Order Order OrderConfirmConfirm Confirm Confirm orderid rderid rderid =”訂單號 訂單號 ” mailnoailno ailno =”運單號 ”>
<OrderConfirmOption w <OrderConfirmOption w<OrderConfirmOption w <OrderConfirmOption w <OrderConfirmOption w <OrderConfirmOption w <OrderConfirmOption w <OrderConfirmOption w <OrderConfirmOption w <OrderConfirmOption w <OrderConfirmOption w eighteight eight =”快件 重量 ” volume=volume= volume=volume= volume=”托寄物的長，寬，高”/>
<Extra <Extra <Extra <Extra e1 =”擴展字段 擴展字段 ” e2=”擴展字段 擴展字段 ” e3=”擴展字段 擴展字段 ” e4=”擴展字段 擴展字段 ” e5=”擴展字段 擴展字段 ” e6=”擴展字 擴展字 段” e7=”擴展字段 擴展字段 ” e8= ”擴展字段 擴展字段 ” e9= ”擴展字段 擴展字段 擴展字段 ” e10=10= ”擴展字段 擴展字段 擴展字段 ” e11=11= ”擴展字段 擴展字段 ” e12=12= ”擴展字 擴展字 段” e13=13= ”擴展字段 擴展字段 擴展字段 ” e14=14= ”擴展字段 擴展字段 ” e15=15= ”擴展字段 擴展字段 ” e16=16= ”擴展字段 擴展字段 擴展字段 ” e17= 17=”擴展字段 擴展字段 ” e18= ”擴展 字段 ” e19= 19=”擴展字段 擴展字段 ” e20= 20=”擴展字段 擴展字段 ”/>
</Order /Order /Order Confirm Confirm Confirm Confirm>
</Body>Body> Body>
</ RequestRequest Request Request >
響應XML：
訂單確認成功： 訂單確認成功： 訂單確認成功：
<Response <Response<Response <Response <Response service=service= service= service= service=”Orde OrdeOrderConfirmServicerConfirmService rConfirmService rConfirmService rConfirmService rConfirmService rConfirmService rConfirmService ”>
<Head> <Head><Head> <Head>OK </Head></Head> </Head> </Head>
<Body> <Body><Body> <Body>
<OrderConfirmResponse OrderConfirmResponse OrderConfirmResponse OrderConfirmResponse OrderConfirmResponse OrderConfirmResponse OrderConfirmResponse OrderConfirmResponse OrderConfirmResponse OrderConfirmResponse orderid= orderid= orderid= orderid= ”訂單號 訂單號 ” mailno= mailno=mailno= mailno= ”運單號” remark= remark= remark= remark=”備注 ”/>
</Body> </Body></Body> </Body>
</Response> </Response></Response> </Response> </Response> </Response>
訂單 確認 失敗： 失敗：
<Response <Response<Response <Response <Response service=service= service= service= service=”OrderConfirmService OrderConfirmServiceOrderConfirmService OrderConfirmService OrderConfirmService OrderConfirmService OrderConfirmService OrderConfirmService OrderConfirmService OrderConfirmService ”>
<Head> <Head><Head> <Head>ERRERR </Head> </Head> </Head> </Head>
<ERROR code=" <ERROR code="<ERROR code=" <ERROR code=" <ERROR code=" <ERROR code=" <ERROR code=" NNN NNNN"> 錯誤詳細信息 錯誤詳細信息 錯誤詳細信息 </ERROR></ERROR> </ERROR> </ERROR> </ERROR>
</Response> </Response></Response> </Response> </Response> </Response>
BSP-企業服務平臺接入技術規范
順豐集團資訊科技本部研發中心 10
2013 年 06 月 01 日
3.3. 訂單篩選
3.3.1. 功能描述
客戶系統通過此接口向順豐企業服務平臺發送自動篩單請求，用于判斷客戶的收、派地址是否屬于順豐的收派范圍。系統會根據收派雙方的地址自動判斷是否在順豐的收派范圍內。如果屬于范圍內則返回可收派，否則返回不可收派。
3.3.2. 接口主信息定義
服務名稱
OrderFilterService
批量交易限制
<=5筆
接口類型
接入
協議類型
WEBSERVICE
接口方法
public String sfexpressService(String XML);
數據元素<請求>
OrderFilter
必要字段名
類型（約束）
默認值
描述
filter_type filter_typefilter_type filter_type filter_type filter_type
Number NumberNumber Number(1)(1)
1
篩單類別： 篩單類別： 1-自動篩單（系統根據 自動篩單（系統根據 自動篩單（系統根據 自動篩單（系統根據 自動篩單（系統根據 地址庫進行判斷，并返回結果）， 地址庫進行判斷，并返回結果）， 地址庫進行判斷，并返回結果）， 地址庫進行判斷，并返回結果）， 地址庫進行判斷，并返回結果）， 地址庫進行判斷，并返回結果）， 地址庫進行判斷，并返回結果）， 2-可人工篩單（系統首先根據地址庫 可人工篩單（系統首先根據地址庫 可人工篩單（系統首先根據地址庫 可人工篩單（系統首先根據地址庫 可人工篩單（系統首先根據地址庫 可人工篩單（系統首先根據地址庫 可人工篩單（系統首先根據地址庫 判斷，如果無法自動是否收 判斷，如果無法自動是否收 判斷，如果無法自動是否收 判斷，如果無法自動是否收 判斷，如果無法自動是否收 判斷，如果無法自動是否收 派，系統將生成需要人工判斷的任 派，系統將生成需要人工判斷的任 派，系統將生成需要人工判斷的任 派，系統將生成需要人工判斷的任 派，系統將生成需要人工判斷的任 派，系統將生成需要人工判斷的任 派，系統將生成需要人工判斷的任 務，后續由人工處理 務，后續由人工處理 務，后續由人工處理 務，后續由人工處理 ，處理結束 ，處理結束 后，順豐可主動推送給客戶系統 后，順豐可主動推送給客戶系統 后，順豐可主動推送給客戶系統 后，順豐可主動推送給客戶系統 后，順豐可主動推送給客戶系統 后，順豐可主動推送給客戶系統 ）
orderid orderidorderid orderid
String StringString String(64)(64) (64)
如果filter_type=2 filter_type=2filter_type=2 filter_type=2 filter_type=2 filter_type=2 filter_type=2 ， 則必須提供 則必須提供
客戶 訂單號 訂單號
d_address d_addressd_address d_address d_address
String StringString String(150)(150) (150)
到件方詳細地址， 到件方詳細地址， 到件方詳細地址， 到件方詳細地址， 需要包括省市 需要包括省市 需要包括省市 區，如：廣東省深圳市福田新洲 區，如：廣東省深圳市福田新洲 區，如：廣東省深圳市福田新洲 區，如：廣東省深圳市福田新洲 區，如：廣東省深圳市福田新洲 區，如：廣東省深圳市福田新洲 區，如：廣東省深圳市福田新洲 十一街萬基商務大廈。 十一街萬基商務大廈。 十一街萬基商務大廈。 十一街萬基商務大廈。 十一街萬基商務大廈。
數據元素<響應>
OrderFilterResponse
字段名
類型（約束）
是否非空
描述
orderid orderidorderid orderid
String(64) String(64)String(64) String(64) String(64) String(64)
訂單號 ，如果需要順豐提供人工篩 ，如果需要順豐提供人工篩 單，需要提供此項值 單，需要提供此項值 單，需要提供此項值 單，需要提供此項值
filter ilter ilter_r esultesult esult
Number(2) Number(2)Number(2) Number(2) Number(2)
否
篩單結果： 篩單結果： 篩單結果： 篩單結果： 篩單結果： 1-人工確認， 人工確認， 人工確認， 人工確認， 人工確認， 2-可收派 可收派 可收派 3-不可以收派 不可以收派 不可以收派
origin originorigin origincode ode
String(10) String(10)String(10) String(10) String(10) String(10)
原寄地代碼 原寄地代碼
dest destdestcode ode
String(10) String(10)String(10) String(10) String(10) String(10)
目的地代碼 ,如果可收派，此項不能 為空
remark remarkremark remark
String(100) String(100)String(100) String(100) String(100) String(100)
1-收方超范圍， 2-派方超范圍， 3-其他原因 其他原因
3.3.3. 可選字段信息
數據元素
OrderFilter/OrderFilterOption
字段名
類型（約束）
默認值
描述
j_tel
String(20)
寄件方電話
country
String (50)
CN
寄件人所在國家
BSP-企業服務平臺接入技術規范
順豐集團資訊科技本部研發中心 11
2013 年 06 月 01 日
province
String (30)
寄件人所在省份，必須是標準的省名稱稱謂，示例：“廣東省”（省字不要省略）
city
String (100)
寄件方所屬城市名稱，必須是標準的城市稱謂，示例：“深圳市”（市字不要省略）
county
String (30)
寄件人所在縣/區，必須是標準的縣/區稱謂，示例：“福田區”（區字不要省略）
d_country
String(50)
CN
到件方國家
d_province
String (30)
到件方所在省份，必須是標準的省名稱稱謂，示例：“廣東省”（省字不要省略）
d_city
String (100)
到件方所屬城市名稱，必須是標準的城市稱謂，示例：“深圳市”（市字不要省略）
d_county
String (30)
到件方所在縣/區，必須是標準的縣/區稱謂，示例：“福田區”（區字不要省略）
j_address
String(150)
寄件方詳細地址，示例：“廣東省深圳市福田區新洲十一街萬基商務大廈10樓”
d_tel
String(23)
到件方電話
3.3.4. 擴展字段信息
無。
3.3.5. 應用場景XML實例
. 場景1
場景描述：
請求XML：
<Request service= Request service= Request service= Request service= Request service= Request service= Request service= Request service= ”OrderFilter rderFilterrderFilter rderFilter rderFilter rderFilterServiceService Service Service ” lang="zh lang="zhlang="zh lang="zh lang="zh-CN" CN">
<Head> <Head><Head> <Head>j_custidj_custid j_custid j_custid j_custid（客戶卡號 客戶卡號 ）,checkwork ,checkwork ,checkwork ,checkwork ,checkwork （校驗碼 校驗碼 ）</Head> </Head> </Head> </Head>
<B ody>ody> ody>
<O rderFilter rderFilter rderFilter rderFilter rderFilter rderFilter filter_type filter_type filter_type filter_type filter_typefilter_type =”篩單類別 篩單類別 ” orderid orderidorderid orderidorderid=”訂單號 訂單號 ” d_address d_address d_address d_address d_address=”到件方地址 到件方地址 到件方地址 ”>
<OrderFilterOption <OrderFilterOption <OrderFilterOption <OrderFilterOption <OrderFilterOption <OrderFilterOption <OrderFilterOption <OrderFilterOption <OrderFilterOption <OrderFilterOption j_tel j_telj_tel =”寄件方電話 寄件方電話 寄件方電話 ” j_addressj_addressj_address j_addressj_address j_address =”寄件方地址 寄件方地址 寄件方地址 ” d_tel d_teld_tel =”到件方電話 到件方電話 到件方電話 ”/>
</ OrderFilter rderFilter rderFilter rderFilter rderFilter >
<! -- ...... // 最多包括 最多包括 5個<OrderFiler OrderFiler OrderFiler OrderFiler OrderFiler >-- >
</Body>Body> Body>
</ RequestRequest Request Request >
響應XML：
篩單處理成功： 篩單處理成功： 篩單處理成功：
<Response <Response<Response <Response <Response service=service= service= service= service=”OrderFilter rderFilter rderFilter rderFilter rderFilter Service Service Service Service”>
<Head> <Head><Head> <Head>OK </Head></Head> </Head> </Head>
<Body> <Body><Body> <Body>
<OrderFilter <OrderFilter<OrderFilter <OrderFilter <OrderFilter <OrderFilter <OrderFilterResponseResponse Response Response Response orderid rderid rderid =”訂單號 訂單號 ” filter_result=”是否可收派 是否可收派 是否可收派 ” originorigin origin origincode ode=”原寄地 原寄地 代碼 ” destdest destcode ode=”目的地代碼 目的地代碼 目的地代碼 ” remark remark remark =”備注 ”/>
...
</Body> </Body></Body> </Body>
</Response> </Response></Response> </Response> </Response> </Response>
BSP-企業服務平臺接入技術規范
順豐集團資訊科技本部研發中心 12
2013 年 06 月 01 日
篩單處理失敗： 單處理失敗： 單處理失敗：
<Response <Response<Response <Response <Response service=service= service= service= service=”OrderFilter rderFilter rderFilter rderFilter rderFilter Service Service Service Service”>
<Head> <Head><Head> <Head>ERRERR </Head> </Head> </Head> </Head>
<ERROR code="NNN"> <ERROR code="NNN"><ERROR code="NNN"> <ERROR code="NNN"> <ERROR code="NNN"> <ERROR code="NNN"> <ERROR code="NNN"> <ERROR code="NNN"> <ERROR code="NNN"> <ERROR code="NNN">錯誤詳細信息 錯誤詳細信息 錯誤詳細信息 </ERROR></ERROR> </ERROR> </ERROR> </ERROR>
</Response> </Response></Response> </Response> </Response> </Response>
3.4. 人工篩選結果推送
3.4.1. 功能描述
如果客戶通過訂單篩選接口得到的反饋結果為：3-待確認時，如果訂單篩選時，提供了訂單號且apply_type=2，當完成人工篩單時，順豐系統將人工篩單的結果推送給客戶系統。
請客戶系統提供一個符合以下規范的HTTP URL，以便順豐向客戶系統推送人工篩單數據。
1）順豐以HTTP POST的方式向客戶系統推送數據。
2）請求方法的編碼格式：“application/x-www-form-urlencoded; charset=UTF-8”
3）推送的篩單結果以XML格式，通過POST方式發送給客戶系統。
4）一個POST方法最多推送5條篩單數據。
5）對xml內容進行URL編碼（字符集為UTF-8）。
6）客戶系統在接收到請求后，需要先對收到的內容進行URL解碼，得到相應的XML。然后從XML中獲取相應的篩單數據。
7）在客戶系統正確處理XML信息后，向順豐返回響應信息，考慮到處理的效率，篩單推送認為批量成功或失敗。
3.4.2. 接口主信息定義
服務名稱
OrderFilterPushService
批量交易限制
<=5筆
接口類型
推送
協議類型
HTTP
接口方法
無
數據元素<請求>
OrderFilterResult
必要字段名
類型（約束）
默認值
描述
orderid orderidorderid orderid
String(64) String(64)String(64) String(64) String(64) String(64)
訂單號 ，如果需要順豐提供人 ，如果需要順豐提供人 工篩單，需要提供此項值 工篩單，需要提供此項值 工篩單，需要提供此項值 工篩單，需要提供此項值 工篩單，需要提供此項值
filter ilter ilter_resultesult esult
Number(2) Number(2)Number(2) Number(2) Number(2)
否
篩單結果： 2-可收派 3-不 可以收派 可以收派
origin originorigin origincode ode
String(10) String(10)String(10) String(10) String(10) String(10)
原寄地代碼 原寄地代碼
dest destdestcode ode
String(10) String(10)String(10) String(10) String(10) String(10)
目的地代碼 ,如果可收派，此 如果可收派，此 如果可收派，此 如果可收派，此 如果可收派，此 如果可收派，此 如果可收派，此 項不能為空 項不能為空
remark remarkremark remark
String(100) String(100)String(100) String(100) String(100) String(100)
1-收方超范圍， 收方超范圍， 收方超范圍， 收方超范圍， 收方超范圍， 收方超范圍， 2-派方超范 派方超范 派方超范 派方超范 圍， 3-其他原因 其他原因 其他原因
mailno mailnomailno mailno
String( String(String( String( 30 )
運單號
數據元素<響應>
OrderFilterResultResponse
字段名
類型（約束）
是否非空
描述
orderid orderidorderid orderid
String( String(String( String( 4000 4000 )
否
成功接收的人工篩單 訂單號 訂單號 ， 如果有多個訂單號，以逗分 如果有多個訂單號，以逗分 隔，如 ”123,124123,124 123,124 123,124 ”
orderid orderidorderid orderid _error rror
String(4000) String(4000)String(4000) String(4000) String(4000) String(4000) String(4000)
未成功接收的人工篩單 訂未成功接收的人工篩單 訂號，如果有多個訂單以逗 號，如果有多個訂單以逗
BSP-企業服務平臺接入技術規范
順豐集團資訊科技本部研發中心 13
2013 年 06 月 01 日
號分隔，如 號分隔，如 號分隔，如 號分隔，如 號分隔，如 ”123,124 123,124 123,124 123,124” ，這 部分訂單的篩數據順豐會定 部分訂單的篩數據順豐會定 時重發。 時重發。
3.4.3. 可選字段信息
無
3.4.4. 擴展字段信息
無
3.4.5. 應用場景XML實例
. 場景1
場景描述：
請求XML：
<Re quest service= quest service= quest service= quest service= quest service= quest service= quest service= ”OrderFilterPushServiceOrderFilterPushService OrderFilterPushServiceOrderFilterPushService OrderFilterPushService OrderFilterPushService OrderFilterPushService OrderFilterPushService OrderFilterPushService OrderFilterPushService OrderFilterPushService OrderFilterPushService ”>
<Head> <Head><Head> <Head>OK </Head></Head> </Head> </Head>
<Body> <Body><Body> <Body>
<OrderFilter OrderFilter OrderFilter OrderFilter OrderFilter OrderFilterResultResult Result Result orderid rderid rderid =”訂單號 訂單號 ” filter_result=”是否可收派 是否可收派 是否可收派 是否可收派 ” origin origin origin codeode =”原寄地代 原寄地代 碼” destCode destCode destCode destCode =”目的地代碼 目的地代碼 目的地代碼 ” remarkremark remark remark=”備注 ”/>
<! -- ...//...// ...// 最多包括 最多包括 5個<OrderFilter OrderFilter OrderFilter OrderFilter OrderFilter OrderFilterResult>Result> Result> Result> -- >
</Body> </Body></Body> </Body>
</Re </Re</Requestquest quest >
響應XML：
成功響應： 成功響應：
<Response <Response<Response <Response <Response serser vice= vice= vice=”OrderFilterPushService OrderFilterPushServiceOrderFilterPushService OrderFilterPushService OrderFilterPushService OrderFilterPushService OrderFilterPushService OrderFilterPushService OrderFilterPushService OrderFilterPushService OrderFilterPushService OrderFilterPushService”>
<Head> <Head><Head> <Head>OK </Head></Head> </Head> </Head>
</Response> </Response></Response> </Response> </Response> </Response>
失敗響應 失敗響應 ：
<Response <Response<Response <Response <Response service=service= service= service= service=”OrderFilterPushService OrderFilterPushServiceOrderFilterPushService OrderFilterPushService OrderFilterPushService OrderFilterPushService OrderFilterPushService OrderFilterPushService OrderFilterPushService OrderFilterPushService OrderFilterPushService OrderFilterPushService”>
<Head> <Head><Head> <Head>ERRERR </Head> </Head> </Head> </Head>
<ERROR code=" <ERROR code="<ERROR code=" <ERROR code=" <ERROR code=" <ERROR code=" <ERROR code=" NNNN NNNN "> 錯誤詳細信息 錯誤詳細信息 錯誤詳細信息 </ERROR></ERROR> </ERROR> </ERROR> </ERROR>
</Response> </Response></Response> </Response> </Response> </Response>
3.5. 路由查詢
3.5.1. 功能描述
提供客戶系統通過接口查詢客戶通過順豐承運的運單路由的功能，支持單個或批量運單路由查詢的功能，批量查詢中，最多不能超過10個運單號。同一批次，只允許查詢同一種語言的運單路由。
BSP-企業服務平臺接入技術規范
順豐集團資訊科技本部研發中心 14
2013 年 06 月 01 日
路由查詢接口支持兩類查詢方式：
1） 根據運單號查詢：查詢請求中提供客戶卡號與運單號，系統將驗證客戶卡號與所有請求運單號的歸屬關系，系統只返回具有正確歸屬關系的運單路由信息。
2） 根據訂單號查詢：查詢請求中提供客戶卡號與訂單號，系統將驗證客戶卡號與所有請求訂單號的歸屬關系，對于歸屬關系正確的訂單號，找到對應的運單號，然后返回訂單對應運單號的路由信息。適用于通過企業服務平臺下發過訂單的客戶。
3.5.2. 接口主信息定義
服務名稱
RouteService
批量交易限制
<=10筆
接口類型
接入
協議類型
WEBSERVICE
接口方法
public String sfexpressService(String xml);
數據元素<請求>
RouteRequest
必要字段名
類型（約束）
默認值
描述
tracking_type tracking_typetracking_type tracking_type tracking_type tracking_type tracking_type
Number(2) Number(2)Number(2) Number(2) Number(2)
1
查詢類別 查詢類別 , tracking_typetracking_type tracking_type tracking_type tracking_type tracking_typetracking_type tracking_type字段說明： 字段說明： 1-根據運單號查 根據運單號查 根據運單號查 根據運單號查 詢， orderorder order 節點中 節點中 track_number track_numbertrack_number track_number track_number track_number track_number將被當作運單 將被當作運單 將被當作運單 將被當作運單 號處理， 號處理， 2-根據訂單號查詢， 根據訂單號查詢， 根據訂單號查詢， 根據訂單號查詢， 根據訂單號查詢， order orderorder 節點中 節點中 track_number track_numbertrack_number track_number track_number track_number track_number將被當作訂單 將被當作訂單 將被當作訂單 將被當作訂單 號處理
track tracktrack ing ing_n umberumber umber
String StringString String(4000 4000 )
查詢號 , 如果 tracking_type=1 tracking_type=1tracking_type=1 tracking_type=1 tracking_type=1 tracking_type=1 tracking_type=1 tracking_type=1 ，則此值 ，則此值 為運單號。如果 為運單號。如果 為運單號。如果 tracking_type=2 tracking_type=2tracking_type=2 tracking_type=2 tracking_type=2 tracking_type=2 tracking_type=2 tracking_type=2 ，則此值 ，則此值 為訂單號 為訂單號
如果有多個單號，以逗分 如果有多個單號，以逗分 如果有多個單號，以逗分 如果有多個單號，以逗分 如果有多個單號，以逗分 如果有多個單號，以逗分 隔，如 ”123,124,125123,124,125 123,124,125 123,124,125 123,124,125 123,124,125 ”
數據元素<響應>
RouteResponse
字段名
類型（約束）
是否非空
描述
mailno mailnomailno mailno
String(20) String(20)String(20) String(20) String(20) String(20)
否
運單號
orderid orderidorderid orderid
String(64) String(64)String(64) String(64) String(64) String(64)
訂單號
數據元素<響應>
RouteResponse/Route
字段名
類型（約束）
是否非空
描述
accept ccept ccept_timeime
Date DateDate
否
路由發生的時間 路由發生的時間 路由發生的時間
accept ccept ccept_addressddress ddress ddress
String(100) String(100)String(100) String(100) String(100) String(100)
否
路由發生的地點 路由發生的地點 路由發生的地點
remark remarkremark remark
String(150) String(150)String(150) String(150) String(150) String(150)
否
具體描述 具體描述
op code ode
String(20) String(20)String(20) String(20) String(20) String(20)
操作碼
3.5.3. 可選字段信息
無
BSP-企業服務平臺接入技術規范
順豐集團資訊科技本部研發中心 15
2013 年 06 月 01 日
3.5.4. 擴展字段信息
無
3.5.5. 應用場景XML實例
. 場景1
場景描述：根據運單號查詢
請求XML：
<Request service= Request service= Request service= Request service= Request service= Request service= Request service= Request service= ”RouteService outeServiceouteService outeService outeService outeService ” lang="zh lang="zh lang="zh lang="zh -CN" CN">
<Head> <Head><Head> <Head>custidcustid custid custid（客戶卡號 客戶卡號 客戶卡號 ）,checkwork,checkwork ,checkwork ,checkwork ,checkwork ,checkwork（校驗碼 校驗碼 ）</Head></Head> </Head> </Head>
<B ody>ody> ody>
<R outeoute outeRequestRequest Request Request tracking_typetracking_type tracking_type tracking_type tracking_typetracking_type tracking_type tracking_type=”查詢類別 查詢類別 查詢類別 ” tracking_number tracking_numbertracking_number tracking_number tracking_number tracking_number tracking_number tracking_number =”單號 1,單號 2,…,單號 n”/>
</Body>Body> Body>
</ RequestRequest Request Request >
響應XML：
路由查詢成功： 路由查詢成功： 路由查詢成功：
<Response service= <Response service=<Response service= <Response service= <Response service= <Response service= <Response service= <Response service= <Response service= <Response service=”RouteService” outeService” outeService” outeService” outeService” outeService” >
<Head> <Head><Head> <Head>OK </Head></Head> </Head> </Head>
<Body> <Body><Body> <Body>
<R outeoute outeResponseResponse Response Response Response mailno= mailno= mailno= mailno=”運單號 運單號 ” orderid= orderid= orderid= orderid= ”訂單號 訂單號 ”>
<R oute oute oute accept_time=”路由發生時間 路由發生時間 路由發生時間 ” accept_address=”路由發生地點 路由發生地點 路由發生地點 路由發生地點 ” remark remark remark =”詳細說明 詳細說明 ” opCode= opCode=opCode= opCode= ”操作碼 操作碼 ”/>
<! -- ...... // 可包括多個 可包括多個 可包括多個 <Route> oute>oute> -- >
</ RouteResponseRouteResponse RouteResponse RouteResponse RouteResponse RouteResponse RouteResponse >
<! -- ...... // 最多包括 最多包括 10個<RouteResponseRouteResponse RouteResponse RouteResponse RouteResponse RouteResponse RouteResponse >-- >
</Body> </Body></Body> </Body>
</Response> </Response></Response> </Response> </Response> </Response>
路由查詢 路由查詢 失敗： 失敗：
<Response <Response<Response <Response <Response service=service= service= service= service=”RouteService outeService outeService outeService outeService outeService”>
<Head> <Head><Head> <Head>ERRERR </Head> </Head> </Head> </Head>
<ERROR code=" <ERROR code="<ERROR code=" <ERROR code=" <ERROR code=" <ERROR code=" <ERROR code=" NNNN NNNN "> 錯誤詳細信息 錯誤詳細信息 錯誤詳細信息 </ERROR></ERROR> </ERROR> </ERROR> </ERROR>
</Response> </Response></Response> </Response> </Response> </Response>
失敗響應： 失敗響應：
<Response <Response<Response <Response <Response service=service= service= service= service=”RouteService outeService outeService outeService outeService outeService”>
<Head> <Head><Head> <Head>ERRERR </Head> </Head> </Head> </Head>
<ERROR code=" <ERROR code="<ERROR code=" <ERROR code=" <ERROR code=" <ERROR code=" <ERROR code=" NNNN NNNN "> 錯誤詳細信息 錯誤詳細信息 錯誤詳細信息 </ERROR></ERROR> </ERROR> </ERROR> </ERROR>
</Response> </Response></Response> </Response> </Response> </Response>
3.6. 路由推送
3.6.1. 功能描述
BSP-企業服務平臺接入技術規范
順豐集團資訊科技本部研發中心 16
2013 年 06 月 01 日
該接口用于向客戶系統定時推送運單的路由信息。需要客戶系統提供一個符合以下規范的HTTP URL，以便順豐向客戶系統推送路由數據。推送方式為增量推送，對于同一個運單的路由，不重復推送。
1） 順豐以HTTP POST的方式向客戶系統推送數據。
2） 請求方法的編碼格式：“application/x-www-form-urlencoded; charset=UTF-8”
3） 推送的路由數據以XML格式，通過POST方式發送給客戶系統。
4） 一個POST方法最多推送10條路由數據。
5） 對xml內容進行URL編碼（字符集為UTF-8）。
6） 客戶系統在接收到請求后，需要先對收到的內容進行URL解碼，得到相應的XML。然后從XML中獲取相應的路由信息。
在客戶系統正確處理XML信息后，向順豐返回響應信息，考慮到處理的效率，路由推送認為批量成功或失敗。
3.6.2. 接口主信息定義
服務名稱
RoutePushService
批量交易限制
<=10筆
接口類型
推送
協議類型
HTTP
接口方法
無
數據元素<請求>
WaybillRoute
必要字段名
類型（約束）
默認值
描述
id
Number(15)
路由編號，每一個id代表一條不同的路由
mailno
String(20)
否
運單號
orderid
String(64)
訂單號
accept_time
Date
否
路由產生時間
accept_address
String(100)
否
路由發生城市
remark
String(300)
否
路由說明
opcode
String(20)
操作碼
數據元素<響應>
WaybillRouteResponse
字段名
類型（約束）
是否非空
描述
id
String(4000)
否
成功接收的路由編號，如果有多個路由編號，以逗號分隔，如“123,124,125“
id_error
String(4000)
否
未成功接收的路由編號，如果有多個路由編號，以逗號分隔，如“123,124,125“，這部分路由編號，順豐會定時重發
3.6.3. 可選字段信息
無
BSP-企業服務平臺接入技術規范
順豐集團資訊科技本部研發中心 17
2013 年 06 月 01 日
3.6.4. 擴展字段信息
無
3.6.5. 應用場景XML實例
. 場景1
場景描述：
請求XML：
<Request service= Request service= Request service= Request service= Request service= Request service= Request service= Request service= ”RoutePushServiceRoutePushService RoutePushServiceRoutePushService RoutePushService RoutePushService RoutePushService RoutePushService RoutePushService ” lang="zh lang="zh lang="zhlang="zh lang="zh-CN" CN">
<Head> <Head><Head> <Head>custidcustid custid custid（客戶卡號 客戶卡號 客戶卡號 ）,checkwork,checkwork ,checkwork ,checkwork ,checkwork ,checkwork（校驗碼 校驗碼 ）</Head></Head> </Head> </Head>
<B ody>ody> ody>
<WaybillRoute <WaybillRoute <WaybillRoute <WaybillRoute <WaybillRoute <WaybillRoute <WaybillRoute <WaybillRoute id=id= ”路由編號 路由編號 ” mailno=mailno= mailno= mailno= ”運單號 運單號 ” orderid=orderid= orderid= orderid= orderid=”訂單號 訂單號 ” accept_time=”路由發生時 路由發生時 間” accept_address=”路由發生地點 路由發生地點 路由發生地點 ” remark remark remark =”詳細說明 詳細說明 詳細說明 ” opcode=”操作碼 ”/>
<! -- //...//... //... 最多 10 個<Waybill<Waybill<Waybill <Waybill<Waybill <WaybillRoute>Route> Route> Route>-- >
</Body>Body> Body>
</ RequestRequest Request Request >
響應XML：
<Response <Response<Response <Response <Response service=service= service= service= service=”RoutePushService RoutePushServiceRoutePushService RoutePushService RoutePushService RoutePushService RoutePushService RoutePushService RoutePushService”>
<Head> <Head><Head> <Head>OK </Head></Head> </Head> </Head>
</Response> </Response></Response> </Response> </Response> </Response>
4. 附錄
4.1. 原因代碼表
原因代碼
描述
分類 61** 缺少必要參數
6101
請求數據缺少必選項
缺少必要參數
6102
寄件方公司名稱為空
關鍵字段校驗不合法
6103
寄方聯系人為空
6104
寄方所在省為空
6105
寄方所在城市為空
6106
寄件方詳細地址為空
6107
到件方公司名稱為空
6108
到件方聯系人為空
6109
到件方所在省為空
6110
到件方所在城市為空
6111
到件方地址為空
6112
到件方國家不能為空
6113
到件方所在省份不能為空
6114
必須提供客戶訂單號
6115
到件方所屬城市名稱不能為空
BSP-企業服務平臺接入技術規范
順豐集團資訊科技本部研發中心 18
2013 年 06 月 01 日
6116
到件方所在縣/區不能為空
6117
到件方詳細地址不能為空
6118
訂單號不能為空
6119
到件方聯系電話不能為空
6120
快遞類型不能為空
6121
寄件方聯系電話不能為空
6122
篩單類別不合法
6123
運單號不能為空
6124
付款方式不能為空
6125
需生成電子運單,貨物名稱等不能為空
6126
月結卡號不合法
6127
增值服務名不能為空
6128
增值服務名不合法
8*** 功能校驗
8000
報文 參數不合法
參數無效
8001
IP未授權
參數無效
8002
服務（功能）未授權
8003
查詢單號超過最大限制
8004
路由查詢條數超限制
8005
查詢次數超限制
8006
已下單，無法接收訂單確認請求
8007
此訂單已經確認，無法接收訂單確認請求
8008
此訂單人工篩單還未確認，無法接收訂單確認請求
8009
此訂單不可收派, 無法接收訂單確認請求。
8010
此訂單未篩單, 無法接收訂單確認請求。
8011
不存在該客戶卡號與運單號綁定關系
8012
不存在該客戶卡號與訂單號綁定關系
8013
未傳入查詢單號
8014
校驗碼錯誤
8015
未傳入運單號信息
8016
重復下單
8017
訂單號與運單號不匹配
8018
未獲取到訂單信息
8019
訂單已確認
8020
不存在該訂單跟運單綁定關系
BSP-企業服務平臺接入技術規范
順豐集團資訊科技本部研發中心 19
2013 年 06 月 01 日
8021
客戶卡號為空
8022
校驗碼為空
8023
服務名為空
8024
未下單
8025
未傳入服務或不提供該服務
8026
不存在的客戶
8027
不存在的業務模板
8028
客戶未配置此業務
8029
客戶未配置默認模板
8030
未找到這個時間的合法模板
8031
數據錯誤，未找到模板
8032
數據錯誤，未找到業務配置
8033
數據錯誤，未找到業務屬性
8034
重復注冊人工篩單結果推送
8035
生成電子運單，必須存在運單號
8036
注冊路由推送必須存在運單號
4*** 系統校驗
4001
系統發生數據錯誤或運行時異常
4002
報文解析錯誤
世聯翻譯-讓世界自由溝通！專業的全球語言翻譯供應商，上海翻譯公司專業品牌。絲路沿線56種語言一站式翻譯與技術解決方案，專業英語翻譯、日語翻譯等文檔翻譯、同傳口譯、視頻翻譯、出國外派服務，加速您的全球交付。
世聯翻譯公司在北京、上海、深圳等國際交往城市設有翻譯基地，業務覆蓋全國城市。每天有近百萬字節的信息和貿易通過世聯走向全球！積累了大量政商用戶數據，翻譯人才庫數據，多語種語料庫大數據。世聯品牌和服務品質已得到政務防務和國際組織、跨國公司和大中型企業等近萬用戶的認可。 |
