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