- 翻譯公司資訊
-
世聯(lián)翻譯公司完成公司系統規范中文翻譯
發(fā)布時(shí)間:2018-09-11 14:13 點(diǎn)擊:
世聯(lián)翻譯公司完成公司系統規范中文翻譯
2 接口規范說(shuō)明
通用對外服務(wù)接口統一使用UTF-8編碼的XML報文,接口通信協(xié)議支持 WEBSERVICE、HTTP/POST、FTP三種協(xié)議,當前主要使用WEBSERVICE協(xié)議方式。
通用對外服務(wù)接口分為主動(dòng)接入與對外推送兩類(lèi)接口,基于 FTP 協(xié)議的對外推送類(lèi)接口無(wú)需對應的響應報文,其他均存在對應的請求與響應報文;以下定義了通用對外服務(wù)接口報文需要遵循的格式與規則:
² 請求報文:
<Request service="服務(wù)名"lang="zh-CN">
<Head>客戶(hù)卡號,校驗碼</Head>
<Body>請求數據 XML</Body>
</Request>
關(guān)鍵規則:
a) service屬性與HEAD元素預先定義了服務(wù)名,客戶(hù)卡號及檢驗碼,結合請求的客戶(hù)IP地址可以滿(mǎn)足只要通過(guò)預解析HEAD元素就能夠進(jìn)行系統功能權限的驗證,無(wú)功能權限情況下無(wú)需進(jìn)一步解析Body內部數據,大大提高了攔截非法訪(fǎng)問(wèn)的性能;
b) 客戶(hù)卡號與校驗碼統一使用順豐分配的客戶(hù)卡號與校驗碼;
c) lang屬性用于支持國際化請求,缺省值為 zh-CN。
² 響應報文:
<Response service="服務(wù)名">
<Head>OK|ERR</HEAD>
<BODY>正常響應數據 XML</BODY>
<ERROR code="NNNN">錯誤詳細信息</ERROR>
</Response>
關(guān)鍵規則:
a) Head元素值為OK或ERR;OK代表交易正常,ERR代表發(fā)生系統或業(yè)務(wù)異常;對于批量交易場(chǎng)景,部分交易異常必須返回OK值,且必須在返回BODY中標識出發(fā)生異常的交易記錄,避免下次全部重發(fā);
b) Head元素值為OK時(shí)返回BODY元素,為ERR時(shí)返回ERROR元素;BODY與ERROR元素不能同時(shí)存在;
c) ERROR元素中的code屬性值為四位數字,錯誤編碼的描述請參考文檔的最后一個(gè)部分。
² 批量交易記錄數限制為20條以下(參考順豐網(wǎng)站),特定業(yè)務(wù)可以自定義不支持批量交易或小于20的批量記錄數限制。
² 請求或正常響應數據XML中數據元素的定義需遵循將必要字段(包含有默認值的字段),可選字段及擴展字段進(jìn)行分開(kāi)定義的原則,同時(shí)字段盡量通過(guò)元素的屬性進(jìn)行定義,字段值限制在200字符以下(50個(gè)漢字以下);必要字段使用數據元素本身的屬性進(jìn)行定義,可選項字段在數據元素下定義“數據元素名+Option”元素并通過(guò)其屬性進(jìn)行定義,擴展字段使用數據元素下保留元素<Extra>的屬性進(jìn)行定義;必要字段的數目盡量控制在10個(gè)以下;如:
<Order id="XXXX" …>
<OrderOption payment="XXXX" …/>
<Extra e1="XXXX" …/>
</Order>
OrderOption元素的屬性及值由具體的業(yè)務(wù)數據定義;Extra元素最大支持20個(gè)屬性,屬性名為e1,…,e20,只支持字符串值。
² 盡量通過(guò)客戶(hù)個(gè)性化服務(wù)配置的方式減少接口報文需要傳遞的字段量,如在訂單報文中加 入發(fā)貨點(diǎn)代碼的方式,可以在后臺基于客戶(hù)+發(fā)貨點(diǎn)代碼的方式配置月結賬號等等數據,避免在接口報文中傳遞附加的月結賬號。
² 請求與響應報文元素命名采用大寫(xiě)字母開(kāi)頭的單詞序列,如“OrderResponse”;屬性名統一使用小寫(xiě),如“orderid”;子元素在定義表格中一律使用“/”徑表示,如“outeTrackingResponse/Route”;
通用對外服務(wù)接口當前已經(jīng)定義了快遞類(lèi)服務(wù)接口,其參考地址參見(jiàn):
Http://bsp-oip/sf-express.com/bsp-ois/ws/expressService
3 快遞類(lèi)服務(wù)接口
3.1 下訂單(含篩選)
3.1.1 功能描述
下單接口根據客戶(hù)需要,可提供以下三個(gè)功能:
1) 客戶(hù)系統向順豐下發(fā)訂單。
2) 為訂單分配運單號。
3) 篩單。
3.1.2 接口主信息定義
服務(wù)名稱(chēng) OrderService 批量交易限制 不支持 接口類(lèi)型 接入 協(xié)議類(lèi)型 WEBSERVICE 接口方法 public String sfexpressService(String XML); 數據元素<請求> Order 必要字段名 類(lèi)型(約束) 默認值 描述 orderid String(64) 客戶(hù) 訂 單號, 建議 英文字 母 +YYMMDD(日 期)+流水號,如:TB1207300000001 express_type String(5) 標準快遞 快件產(chǎn)品類(lèi)別
1 標準快遞
2 順豐特惠j_company String(100) _SYSTEM 寄件方公司名稱(chēng),_SYSTEM表示如果不提供,將從系統配置獲取 j_contact String(30) _SYSTEM 寄件方聯(lián)系人,_SYSTEM表示如果不提供,將從系統配置獲取 j_tel String(20) _SYSTEM 寄件方聯(lián)系電話(huà),_SYSTEM表示如果不提供,將從系統配置獲取 j_address String(150) _SYSTEM 寄件方詳細地址,包括省市區,示例:“廣東省深圳市福田區新洲十一街萬(wàn)基商務(wù)大廈10樓” , _SYSTEM 表示如果不提供,將從系 統配置獲取 d_company String(100) 到件方公司名稱(chēng) d_contact String(30) 到件方聯(lián)系人 d_tel String(20) 到件方聯(lián)系電話(huà) d_address String(150) 到件方詳細地址,示例:“廣東省深圳市福田區新洲十一街萬(wàn)基商務(wù)大廈10 樓” parcel_quantity Number(5) 1 包裹數,如果生成運單號碼,需要提供此項。
一個(gè)包裹對應一個(gè)運單號,數據必須準確。pay_method Number(1) _SYSTEM 付款方式:1:寄方付 2:收方付 3:第三方付,默認為 1。_SYSTEM 表示如果不提供,將從系統配置獲取 j_province String(30) _SYSTEM 寄件方所在省份字段填寫(xiě)要求:必須是標準的省名稱(chēng)稱(chēng)謂如:廣東省 j_city String(100) _SYSTEM 寄件方所屬城市名稱(chēng)
字段填寫(xiě)要求:必須是標準的城市稱(chēng)謂 如: 深圳市d_province String(30) 到件方所在省份字段填寫(xiě)要求:必須是標準的
省名稱(chēng)稱(chēng)謂 如:廣東省d_city String(100) 到件方所屬城市名稱(chēng)
字段填寫(xiě)要求:必須是標準的城市稱(chēng)謂 如: 深圳市數據元素<響應>應> OrderResponse 字段名 類(lèi)型(約束) 是否非空 描述 orderid String(64) 否 訂單號 mailno String(20) 運單號,可多個(gè)單號,如子母件,以逗號分隔 origincode String(10) 否 原寄地代碼 destcode String(10) 否 目的地代碼 filter_result Number(2) 篩單結果:1-人工確認,2-可收派 3-不可以收派 remark String(100) 1-收方超范圍,2-派方超范圍,3-其他原因
3.1.3 可選字段信息
數據元素 Order/OrderOption 字段名 類(lèi)型(約束) 描述 custid String(20) 月結卡號_SYSTEM 可配置 template String(30) 模板選擇 j_shippercode String(30) 寄件方代碼 d_deliverycode String(30) 到件方代碼 cargo String(4000) 貨物名稱(chēng),可有多個(gè)貨物,如果有多個(gè)貨物,以逗號分隔,
如:手機,IPAD,充電器“ 需生成電子運單,此字段必傳cargo_count String(4000) 貨物數量,多個(gè)貨物時(shí)以逗號分隔,且與 cargo 中描述的貨
物相對應
如:2,1,3cargo_unit String(4000) 貨物單位,多個(gè)貨物時(shí)以逗號分隔,且與 cargo 中描述的貨
物相對應
如:個(gè),臺,本cargo_weight String(4000) 貨物重量,多個(gè)貨物時(shí)以逗號分隔,且與 cargo 中描述的貨
物相對應
如:1.5,1.0,3.0cargo_amount String(4000) 貨物單價(jià),多個(gè)貨物時(shí)以逗號分隔,且與 cargo 中描述的貨
物相對應
如:1000,2000,1500cargo_total_weight Number(10,2) 訂單貨物總重量,單位 KG,如果提供此值,必須>0 sendstarttime date 要求上門(mén)取件開(kāi)始時(shí)間,格式:YYYY-MM-DD
HH24:MM:SS,示例:2012-7-30 09:30:00,默認
為系統收到訂單的系統時(shí)間mailno String(4000) 運單號,一個(gè)訂單只能有一個(gè)主單號,如果是子母單的情況,
請以,分隔,主單在第一個(gè)位置,
如 “755123456789,001123456789,002123456789“remark String(100) 備注 數據元素 OrderOption/AddedService 字段名 類(lèi)型(約束) 描述 name(定義對應關(guān)系) String(20) 增值服務(wù)名,如COD 等 value String(30) 增值服務(wù)值1 Value1 String(30) 增值服務(wù)值2 Value2 String(30) 增值服務(wù)值3 Value3 String(30) 增值服務(wù)值4 Value4 String(30) 增值服務(wù)值5
增值服務(wù)傳值說(shuō)明:
服務(wù) NAME 說(shuō)明 備注 代收貨款 COD value 為貨款,value1 為客戶(hù)編碼 保價(jià) INSURE value 為聲明價(jià)值 MSG MSG value 為手機號碼 包裝費 PKFEE value 為包裝費費用 SMS SMS value 為手機號碼,且與收件方的手機號相同.
value1 為個(gè)性化文字。特殊保價(jià) SINSURE value 為服務(wù)費。 特殊配送
特殊增值服務(wù)費SDELIVERY
SADDSERVICEvalue 為服務(wù)費。
value 為服務(wù)費
3.1.4 擴展字段信息
遵循擴展字段規范
3.1.5 應用場(chǎng)景XML實(shí)例
² 場(chǎng)景1
場(chǎng)景描述:客戶(hù)下單
請求XML:
<Request service=”OrderService” lang="zh-CN">
<Head>j_custid(客戶(hù)卡號),checkwork(校驗碼)</Head>
<Body>
<Order orderid=”訂單號” express_type=”快件類(lèi)型”j_company=”寄件方公司名稱(chēng)”
j_contact=”寄件方聯(lián)系人”j_tel=”聯(lián)系電話(huà)”j_address=”寄件地址”d_company=”到件方公司名稱(chēng)”d_contact=”到件方聯(lián)系人”d_tel=”聯(lián)系電話(huà)”d_address=”到件方地址” parcel_quantity=”包裹數”pay_method=”付款方式”>
<OrderOption custid=”月結卡號”j_shippercode=”寄件方代碼”d_deliverycode=”到
件方代碼”cargo=”貨物名稱(chēng)”cargo_total_weight=”總重量”insurance_amount=”申明價(jià)值”sendstarttime=”要求上門(mén)收件時(shí)間” mailno=”運單號” remark=”備注”>
<AddedService name=”增值服務(wù) 1” value=”值 1” value1=”值 2” value2=”值 3” value3=”值 4”
value4=”值 5”/>
<!-- ...// <AddedService>可有多個(gè)-->
</OrderOption>
<Extra e1=”擴展字段” e2=”擴展字段” e3=”擴展字段” e4=”擴展字段” e5=”擴展字段” e6=”擴展字 段” e7=”擴展字段” e8=”擴展字段” e9=”擴展字段” e10=”擴展字段” e11=”擴展字段” e12=”擴展字 段” e13=”擴展字段” e14=”擴展字段” e15=”擴展字段” e16=”擴展字段” e17=”擴展字段” e18=”擴展 字段” e19=”擴展字段” e20=”擴展字段”/>
</Order>
</Body>
</Request>
響應XML:
訂單處理成功:
<Response service=”OrderService”>
<Head>OK</Head>
<Body>
<OrderResponse orderid=”訂單號” mailno=”主單,子單 1,子單 2,…,子單 n” originCode=”原寄地代碼” destCode=”目的地代碼” filter_result=”篩單結果” remark=”備注”/>
</Body>
</Response>
訂單處理失。
<Response service=”OrderService”>
<Head>ERR</Head>
<ERROR code="NNNN">錯誤詳細信息</ERROR>
</Response>
3.2 訂單發(fā)貨確認
3.2.1 功能描述
該接口用于客戶(hù)在確定將貨物交付給順豐托運后,將運單上的一些重要信息,如快件重量、寄件時(shí)間,通過(guò)此接口發(fā)送給順豐。
3.2.2 接口主信息定義
服務(wù)名稱(chēng) OrderConfirmService 批量交易限制 不支持 接口類(lèi)型 接入 協(xié)議類(lèi)型 WEBSERVICE 接口方法 public String sfexpressService(String XML); 數據元素<請求> OrderConfirm 必要字段名 類(lèi)型(約束) 默認值 描述 orderid String(64) 訂單號 mailno String(20) 運單號 數據元素<響應> OrderConfirmResponse 字段名 類(lèi)型(約束) 是否非空 描述 orderid String(64) 否 訂單號 mailno String(20) 否 運單號 res_status Number(1) 備注 1-訂單號與運單不匹配
2 成功
3.2.3 可選字段信息
數據元素 OrderConfirm/OrderConfirmOption 字段名 類(lèi)型(約束) 描述 weight Number(10,2) 訂單重量,單位 KG volume String(100) 托寄物的長(cháng),寬,高,以逗號分隔,單位 CM,精確到小數點(diǎn) 1 位。
3.2.4 擴展字段信息
遵循擴展字段規范
3.2.5 應用場(chǎng)景XML實(shí)例
² 場(chǎng)景1
場(chǎng)景描述:
請求 XML:
<Request service=”OrderConfirmService” lang="zh-CN">
<Head>custid(客戶(hù)卡號),checkwork(校驗碼)</Head>
<Body>
<OrderConfirm orderid=”訂單號” mailno=”運單號”>
<OrderConfirmOption weight=”快件重量” volume=”托寄物的長(cháng),寬,高”/>
<Extra e1=”擴展字段” e2=”擴展字段” e3=”擴展字段” e4=”擴展字段” e5=”擴展字段” e6=”擴展字 段” e7=”擴展字段” e8=”擴展字段” e9=”擴展字段” e10=”擴展字段” e11=”擴展字段” e12=”擴展字 段” e13=”擴展字段” e14=”擴展字段” e15=”擴展字段” e16=”擴展字段” e17=”擴展字段” e18=”擴展 字段” e19=”擴展字段” e20=”擴展字段”/>
</OrderConfirm>
</Body>
</Request>
響應 XML:
訂單確認成功:
<Response service=”OrderConfirmService”>
<Head>OK</Head>
<Body>
<OrderConfirmResponse orderid=”訂單號” mailno=”運單號” remark=”備注”/>
</Body>
</Response>
訂單確認失。
<Response service=”OrderConfirmService”>
<Head>ERR</Head>
<ERROR code="NNNN">錯誤詳細信息</ERROR>
</Response>
3.3 訂單篩選
3.3.1 功能描述
客戶(hù)系統通過(guò)此接口向順豐企業(yè)服務(wù)平臺發(fā)送自動(dòng)篩單請求,用于判斷客戶(hù)的收、派地址是否屬于順豐的收派范圍。系統會(huì )根據收派雙方的地址自動(dòng)判斷是否在順豐的收派范圍內。如果屬于范圍內則返回可收派,否則返回不可收派。
3.3.2 接口主信息定義
服務(wù)名稱(chēng) OrderFilterService 批量交易限制 <=5 筆 接口類(lèi)型 接入 協(xié)議類(lèi)型 WEBSERVICE 接口方法 public String sfexpressService(String XML); 數據元素<請求> OrderFilter 必要字段名 類(lèi)型(約束) 默認值 描述 filter_type Number(1) 1 篩單類(lèi)別:1-自動(dòng)篩單(系統根據地址庫進(jìn)行判斷,并返回結果)2-可人工篩單(系統首先根據地址庫判斷,如果無(wú)法自動(dòng)判斷是否收派,系統將生成需要人工判斷的任務(wù),后續由人工處理,處理結束后,順豐可主動(dòng)推送給客戶(hù)系統) orderid String(64) 如果
filter_type=2, 則必須提供
客戶(hù)訂單號
d_address
String(150)到件方詳細地址,需要包括省市區,如:廣東省深圳市福田區新洲 十一街萬(wàn)基商務(wù)大廈。 數據元素<響應> OrderFilterResponse 字段名 類(lèi)型(約束) 是否非空 描述 orderid String(64) 訂單號,如果需要順豐提供人工篩單,需要提供此項值 filter_result Number(2) 否 篩單結果:1-人工確認,2-可收派
3-不可以收派origincode String(10) 原寄地代碼 destcode String(10) 目的地代碼,如果可收派,此項不能為空 remark String(100) 1-收方超范圍,2-派方超范圍,3-其他原因
3.3.3 可選字段信息
數據元素 OrderFilter/OrderFilterOption 字段名 類(lèi)型(約束) 默認值 描述 j_tel String(20) 寄件方電話(huà) country String (50) CN 寄件人所在國家
province
String (30)寄件人所在省份,必須是標準的省名稱(chēng)稱(chēng)謂,示
例:“廣東省”(省字不要省略)
city
String (100)寄件方所屬城市名稱(chēng),必須是標準的城市稱(chēng)謂,示
例:“深圳市”(市字不要省略)
county
String (30)寄件人所在縣/區,必須是標準的縣/區稱(chēng)謂,示 例:“福田區”(區字不要省略) d_country String(50) CN 到件方國家
d_province
String (30)到件方所在省份,必須是標準的省名稱(chēng)稱(chēng)謂,示
例:“廣東省”(省字不要省略)
d_city
String (100)到件方所屬城市名稱(chēng),必須是標準的城市稱(chēng)謂,示
例:“深圳市”(市字不要省略)
d_county
String (30)到件方所在縣/區,必須是標準的縣/區稱(chēng)謂,示 例:“福田區”(區字不要省略)
j_address
String(150)寄件方詳細地址,示例:“廣東省深圳市福田區新 洲十一街萬(wàn)基商務(wù)大廈 10 樓” d_tel String(23) 到件方電話(huà)
3.3.4 擴展字段信息
無(wú)。
3.3.5 應用場(chǎng)景 XML 實(shí)例
² 場(chǎng)景1
場(chǎng)景描述:
請求XML:
<Request service=”OrderFilterService” lang="zh-CN">
<Head>j_custid(客戶(hù)卡號),checkwork(校驗碼)</Head>
<Body>
<OrderFilter filter_type=”篩單類(lèi)別” orderid=”訂單號” d_address=”到件方地址”>
<OrderFilterOption j_tel=”寄件方電話(huà)” j_address=”寄件方地址” d_tel=”到件方電話(huà)”/>
</OrderFilter>
<!--...//最多包括 5 個(gè)<OrderFiler>-->
</Body>
</Request>
響應 XML:
篩單處理成功:
<Response service=”OrderFilterService”>
<Head>OK</Head>
<Body>
<OrderFilterResponse orderid=”訂單號” filter_result=”是否可收派” origincode=”原寄地
代碼” destcode=”目的地代碼” remark=”備注”/>
...
</Body>
</Response>
篩單處理失。
<Response service=”OrderFilterService”>
<Head>ERR</Head>
<ERROR code="NNN">錯誤詳細信息</ERROR>
</Response>
3.4 人工篩選結果推送
3.4.1 功能描述
如果客戶(hù)通過(guò)訂單篩選接口得到的反饋結果為:3-待確認時(shí),如果訂單篩選時(shí),提供了訂單號且 apply_type=2,當完成人工篩單時(shí),順豐系統將人工篩單的結果推送給客戶(hù)系統。
請客戶(hù)系統提供一個(gè)符合以下規范的 HTTP URL,以便順豐向客戶(hù)系統推送人工篩單數據。
1)順豐以HTTP POST的方式向客戶(hù)系統推送數據。
2)請求方法的編碼格式:“application/x-www-form-urlencoded; charset=UTF-8”
3)推送的篩單結果以XML格式,通過(guò)POST方式發(fā)送給客戶(hù)系統。
4)一個(gè)POST方法最多推送5條篩單數據。
5)對xml內容進(jìn)行URL編碼(字符集為UTF-8)。
6)客戶(hù)系統在接收到請求后,需要先對收到的內容進(jìn)行URL解碼,得到相應的XML。然后從XML中 獲取相應的篩單數據。
7)在客戶(hù)系統正確處理XML信息后,向順豐返回響應信息,考慮到處理的效率,篩單推送認為批 量成功或失敗。
3.4.2 接口主信息定義
服務(wù)名稱(chēng) OrderFilterPushService 批量交易限制 <=5 筆 接口類(lèi)型 推送 協(xié)議類(lèi)型 HTTP 接口方法 無(wú) 數據元素<請求> OrderFilterResult 必要字段名 類(lèi)型(約束) 默認值 描述 orderid String(64) 訂單號,如果需要順豐提供人工篩單,需要提供此項值 filter_result Number(2) 否 篩單結果: 2-可收派 3-不可以收派 origincode String(10) 原寄地代碼 destcode String(10) 目的地代碼,如果可收派,此項不能為空 remark String(100) 1-收方超范圍,2-派方超范圍,3-其他原因 mailno String(30) 運單號 數據元素<響應> OrderFilterResultResponse 字段名 類(lèi)型(約束) 是否非空 描述 orderid String(4000) 否 成功接收的人工篩單訂單號,如果有多個(gè)訂單號,以逗號分隔,如”123,124” orderid_error String(4000) 未成功接收的人工篩單訂單號,如果有多個(gè)訂單號,以逗號分隔,如”123,124”,這
部分訂單的篩單數據順豐會(huì )定
時(shí)重發(fā)。
3.4.3 可選字段信息
無(wú)
3.4.4 擴展字段信息
無(wú)
3.4.5 應用場(chǎng)景 XML 實(shí)例
² 場(chǎng)景1
場(chǎng)景描述:
請求 XML:
<Request service=”OrderFilterPushService”>
<Head>OK</Head>
<Body>
<OrderFilterResult orderid=”訂單號” filter_result=”是否可收派” origincode=”原寄地代碼”destCode=”目的地代碼” remark=”備注”/>
<!--...//最多包括 5 個(gè)<OrderFilterResult> -->
</Body>
</Request>
響應 XML:
成功響應:
<Response service=”OrderFilterPushService”>
<Head>OK</Head>
</Response>
失敗響應:
<Response service=”OrderFilterPushService”>
<Head>ERR</Head>
<ERROR code="NNNN">錯誤詳細信息</ERROR>
</Response>
3.5 路由查詢(xún)
3.5.1 功能描述
提供客戶(hù)系統通過(guò)接口查詢(xún)客戶(hù)通過(guò)順豐承運的運單路由的功能,支持單個(gè)或批量運單路由查詢(xún)的功能,批量查詢(xún)中,最多不能超過(guò)10個(gè)運單號。同一批次,只允許查詢(xún)同一種語(yǔ)言的運單路由。
路由查詢(xún)接口支持兩類(lèi)查詢(xún)方式:
1) 根據運單號查詢(xún):查詢(xún)請求中提供客戶(hù)卡號與運單號,系統將驗證客戶(hù)卡號與所有請求運單號的歸屬關(guān)系,系統只返回具有正確歸屬關(guān)系的運單路由信息。
2) 根據訂單號查詢(xún):查詢(xún)請求中提供客戶(hù)卡號與訂單號,系統將驗證客戶(hù)卡號與所有請求訂單號的歸屬關(guān)系,對于歸屬關(guān)系正確的訂單號,找到對應的運單號,然后返回訂單對應運單號的路由信息。適用于通過(guò)企業(yè)服務(wù)平臺下發(fā)過(guò)訂單的客戶(hù)。
3.5.2 接口主信息定義
服務(wù)名稱(chēng) RouteService 批量交易限制 <=10 筆 接口類(lèi)型 接入 協(xié)議類(lèi)型 WEBSERVICE 接口方法 public String sfexpressService(String xml); 數據元素<請求> RouteRequest 必要字段名 類(lèi)型(約束) 默認值 描述 tracking_type Number(2) 1 查詢(xún)類(lèi)別, tracking_type字段說(shuō)明:1-根據運單號查詢(xún),order節點(diǎn)中 track_number將被當作運單號處理,2-根據訂單號查詢(xún),order 節點(diǎn)中track_number將被當作訂單號處理 tracking_number String(4000) 查詢(xún)號,如果tracking_type=1,則此值 為運單號。如果tracking_type=2,則此值 為訂單號 如果有多個(gè)單號,以逗號分隔,如”123,124,125” 數據元素<響應> RouteResponse 字段名 類(lèi)型(約束) 是否非空 描述 mailno String(20) 否 運單號 orderid String(64) 訂單號 數據元素<響應> RouteResponse/Route 字段名 類(lèi)型(約束) 是否非空 描述 accept_time Date 否 路由發(fā)生的時(shí)間 accept_address String(100) 否 路由發(fā)生的地點(diǎn) remark String(150) 否 具體描述 opcode String(20) 操作碼
3.5.3 可選字段信息
無(wú)
3.5.4 擴展字段信息
無(wú)
3.5.5 應用場(chǎng)景 XML 實(shí)例
² 場(chǎng)景1
場(chǎng)景描述:根據運單號查詢(xún)
請求 XML:
<Request service=”RouteService” lang="zh-CN">
<Head>custid(客戶(hù)卡號),checkwork(校驗碼)</Head>
<Body>
<RouteRequest tracking_type=”查詢(xún)類(lèi)別” tracking_number=”單號 1,單號 2,…,單號 n”/>
</Body>
</Request>
響應 XML:
路由查詢(xún)成功:
<Response service=”RouteService”>
<Head>OK</Head>
<Body>
<RouteResponse mailno=”運單號” orderid=”訂單號”>
<Route accept_time=”路由發(fā)生時(shí)間” accept_address=”路由發(fā)生地點(diǎn)” remark=”詳細說(shuō)明”
opCode=”操作碼”/>
<!--...//可包括多個(gè)<Route>-->
</RouteResponse>
<!--...//最多包括 10 個(gè)<RouteResponse>-->
</Body>
</Response>
路由查詢(xún)失。
<Response service=”RouteService”>
<Head>ERR</Head>
<ERROR code="NNNN">錯誤詳細信息</ERROR>
</Response>
失敗響應:
<Response service=”RouteService”>
<Head>ERR</Head>
<ERROR code="NNNN">錯誤詳細信息</ERROR>
</Response>
3.6 路由推送
3.6.1 功能描述
該接口用于向客戶(hù)系統定時(shí)推送運單的路由信息。需要客戶(hù)系統提供一個(gè)符合以下規范的HTTP URL,以便順豐向客戶(hù)系統推送路由數據。推送方式為增量推送,對于同一個(gè)運單的路由,不重復推送。
1) 順豐以HTTP POST的方式向客戶(hù)系統推送數據。
2) 請求方法的編碼格式:“application/x-www-form-urlencoded; charset=UTF-8”
3) 推送的路由數據以XML格式,通過(guò)POST方式發(fā)送給客戶(hù)系統。
4) 一個(gè)POST方法最多推送10條路由數據。
5) 對xml內容進(jìn)行URL編碼(字符集為UTF-8)。
6) 客戶(hù)系統在接收到請求后,需要先對收到的內容進(jìn)行URL解碼,得到相應的XML。然后從XML中獲取相應的路由信息。
在客戶(hù)系統正確處理XML信息后,向順豐返回響應信息,考慮到處理的效率,路由推送認為批量成功或失敗。
3.6.2 接口主信息定義
服務(wù)名稱(chēng) RoutePushService 批量交易限制 <=10 筆 接口類(lèi)型 推送 協(xié)議類(lèi)型 HTTP 接口方法 無(wú) 數據元素<請求> WaybillRoute 必要字段名 類(lèi)型(約束) 默認值 描述 id Number(15) 路由編號,每一個(gè) id 代表一條不同的路由 mailno String(20) 否 運單號 orderid String(64) 訂單號 accept_time Date 否 路由產(chǎn)生時(shí)間 accept_address String(100) 否 路由發(fā)生城市 remark String(300) 否 路由說(shuō)明 opcode String(20) 操作碼 數據元素<響應> WaybillRouteResponse 字段名 類(lèi)型(約束) 是否非空 描述 id String(4000) 否 成功接收的路由編號,如果有多個(gè)路由編號,以逗號分隔,如“123,124,125“ id_error String(4000) 否 未成功接收的路由編號,如果有多個(gè)路由編號,以逗號分 隔,如“123,124,125“,這部分路由編號,順豐會(huì )定時(shí)重發(fā)
3.6.3 可選字段信息
無(wú)
3.6.4 擴展字段信息
無(wú)
3.6.5 應用場(chǎng)景 XML 實(shí)例
² 場(chǎng)景1
場(chǎng)景描述:
請求 XML:
<Request service=”RoutePushService” lang="zh-CN">
<Head>custid(客戶(hù)卡號),checkwork(校驗碼)</Head>
<Body>
<WaybillRoute id=”路由編號” mailno=”運單號” orderid=”訂單號” accept_time=”路由發(fā)生時(shí)
間” accept_address=”路由發(fā)生地點(diǎn)” remark=”詳細說(shuō)明” opcode=”操作碼”/>
<!--//...最多 10 個(gè)<WaybillRoute>-->
</Body>
</Request>
響應 XML:
<Response service=”RoutePushService”>
<Head>OK</Head>
</Response>
4 附錄
4.1 原因代碼表
原因代碼 描述 分類(lèi) 61** 缺少必要參數 6101 請求數據缺少必選項 缺少必要參數 6102 寄件方公司名稱(chēng)為空 關(guān)鍵字段校驗不合法 6103 寄方聯(lián)系人為空 6104 寄方所在省為空 6105 寄方所在城市為空 6106 寄件方詳細地址為空 6107 到件方公司名稱(chēng)為空 6108 到件方聯(lián)系人為空 6109 到件方所在省為空 6110 到件方所在城市為空 6111 到件方地址為空 6112 到件方國家不能為空 6113 到件方所在省份不能為空 6114 必須提供客戶(hù)訂單號 6115 到件方所屬城市名稱(chēng)不能為空 6116 到件方所在縣/區不能為空 6117 到件方詳細地址不能為空 6118 訂單號不能為空 6119 到件方聯(lián)系電話(huà)不能為空 6120 快遞類(lèi)型不能為空 6121 寄件方聯(lián)系電話(huà)不能為空 6122 篩單類(lèi)別不合法 6123 運單號不能為空 6124 付款方式不能為空 6125 需生成電子運單,貨物名稱(chēng)等不能為空 6126 月結卡號不合法 6127 增值服務(wù)名不能為空 6128 增值服務(wù)名不合法 8*** 功能校驗 8000 報文 參數不合法 參數無(wú)效 8001 IP 未授權 參數無(wú)效 8002 服務(wù)(功能)未授權 8003 查詢(xún)單號超過(guò)最大限制 8004 路由查詢(xún)條數超限制 8005 查詢(xún)次數超限制 8006 已下單,無(wú)法接收訂單確認請求 8007 此訂單已經(jīng)確認,無(wú)法接收訂單確認請求 8008 此訂單人工篩單還未確認,無(wú)法接收訂單確認請求 8009 此訂單不可收派, 無(wú)法接收訂單確認請求。 8010 此訂單未篩單, 無(wú)法接收訂單確認請求。 8011 不存在該客戶(hù)卡號與運單號綁定關(guān)系 8012 不存在該客戶(hù)卡號與訂單號綁定關(guān)系 8013 未傳入查詢(xún)單號 8014 校驗碼錯誤 8015 未傳入運單號信息 8016 重復下單 8017 訂單號與運單號不匹配 8018 未獲取到訂單信息 8019 訂單已確認 8020 不存在該訂單跟運單綁定關(guān)系 8021 客戶(hù)卡號為空 8022 校驗碼為空 8023 服務(wù)名為空 8024 未下單 8025 未傳入服務(wù)或不提供該服務(wù) 8026 不存在的客戶(hù) 8027 不存在的業(yè)務(wù)模板 8028 客戶(hù)未配置此業(yè)務(wù) 8029 客戶(hù)未配置默認模板 8030 未找到這個(gè)時(shí)間的合法模板 8031 數據錯誤,未找到模板 8032 數據錯誤,未找到業(yè)務(wù)配置 8033 數據錯誤,未找到業(yè)務(wù)屬性 8034 重復注冊人工篩單結果推送 8035 生成電子運單,必須存在運單號 8036 注冊路由推送必須存在運單號 4*** 系統校驗 4001 系統發(fā)生數據錯誤或運行時(shí)異常 4002 報文解析錯誤
Unitrans世聯(lián)翻譯公司在您身邊,離您近的翻譯公司,心貼心的專(zhuān)業(yè)服務(wù),專(zhuān)業(yè)的全球語(yǔ)言翻譯與信息解決方案供應商,專(zhuān)業(yè)翻譯機構品牌。無(wú)論在本地,國內還是海外,我們的專(zhuān)業(yè)、星級體貼服務(wù),為您的事業(yè)加速!世聯(lián)翻譯公司在北京、上海、深圳等國際交往城市設有翻譯基地,業(yè)務(wù)覆蓋全國城市。每天有近百萬(wàn)字節的信息和貿易通過(guò)世聯(lián)走向全球!積累了大量政商用戶(hù)數據,翻譯人才庫數據,多語(yǔ)種語(yǔ)料庫大數據。世聯(lián)品牌和服務(wù)品質(zhì)已得到政務(wù)防務(wù)和國際組織、跨國公司和大中型企業(yè)等近萬(wàn)用戶(hù)的認可。 專(zhuān)業(yè)翻譯公司,北京翻譯公司,上海翻譯公司,英文翻譯,日文翻譯,韓語(yǔ)翻譯,翻譯公司排行榜,翻譯公司收費價(jià)格表,翻譯公司收費標準,翻譯公司北京,翻譯公司上海。