世聯翻譯公司完成接口開發規范中文翻譯
時間:2018-09-11 14:14 來源:未知 作者:dongli 點擊:次
世聯翻譯公司完成接口開發規范中文翻譯
1 關于本手冊
1.1 資源
http://www.w3.org/XML/
1.2 支持
Please contact 599943@fedex.com
2 貨物跟蹤
2.1 貨物跟蹤服務介紹
您可以使用聯邦快遞國內限時貨物跟蹤服務獲得實時的貨物跟蹤信息。
2.2 根據運單號進行貨物跟蹤
2.2.1 說明
您可以通過運單號跟蹤國內限時服務的包裹。
2.2.2 請求格式
采用GET方法請求，具體樣例參見
2.2.3 應答格式
共有3種應答格式，詳見如下：
2.2.3.1 單件貨物詳細信息
樣例：
<?xml version="1.0" encoding="UTF-8"?>
<fedex-express>
<tracking>
<detail>
<tn>120120136268</tn>
<ptn></ptn>
<destination>深圳</destination>
<shipdate>2007-05-28 18:00:00</shipdate>
<sentby>顏紅霞</sentby>
<deliveredto>廖正宏</deliveredto>
<signedforby>楊昌元</signedforby>
<service>優先達</service>
<deliverydate>2007-05-29 15:23:00</deliverydate>
<status>到達聯邦快遞工作地點</status>
<activities>
<activity>
<datetime>2008-05-06 10:41:40</datetime>
<scan>到達聯邦快遞工作地點</scan>
<location>上海</location>
聯邦快遞國內服務接口開發規范
Page 3 Printed 12/21/2012
<details></details>
</activity>
<activity>
<datetime>2007-05-29 15:23:00</datetime>
<scan>已送達</scan>
<location>深圳</location>
<details></details>
</activity>
<activity>
<datetime>2007-05-29 08:30:52</datetime>
<scan>貨件已裝車，派送途中</scan>
<location>深圳</location>
<details></details>
</activity>
<activity>
<datetime>2007-05-29 07:40:18</datetime>
<scan>位于當地的聯邦快遞遞送站</scan>
<location>深圳</location>
<details></details>
</activity>
<activity>
<datetime>2007-05-28 18:00:00</datetime>
<scan>已取件</scan>
<location>上海</location>
<details></details>
</activity>
</activities>
</detail>
</tracking>
</fedex-express>
字段含義：
字段名 含義 類型
tn 運單號 String
ptn 主運單號，為空時表示改件為一票一件 String
destination 目的地 String
shipdate 寄件日期 String
sentby 寄件人 String
deliveredto 收件人 String
signedforby 簽收人 String
servicetype 服務類型 String
deliverydate 收件日期 String
status 該件貨物最新狀態 String
datetime 該件貨物該次活動時間 String
scancode 該件貨物該次活動內容 String
location 該件貨物該次活動地點 String
details 該件貨物該次活動詳細信息 String
2.2.3.2 多件貨物匯總
樣例：
<?xml version="1.0" encoding="UTF-8"?>
<fedex-express>
<tracking>
<summary>
<single>
<ts>
<tn>120120136268</tn>
<status>到達聯邦快遞工作地點</status>
<datetime>2008-05-06 10:41:40</datetime>
<destination>深圳</destination>
<service>優先達</service>
</ts>
<ts>
<tn>120120136268</tn>
<status>到達聯邦快遞工作地點</status>
<datetime>2008-05-06 10:41:40</datetime>
<destination>深圳</destination>
<service>優先達</service>
</ts>
</single>
<mps>
<ts>
<tn>120120004950</tn>
<status>遞送例外情況</status>
<datetime>2007-06-18 12:27:49</datetime>
<destination>長沙</destination>
<service>優先達</service>
</ts>
</mps>
<missing>
<tn>230120136268</tn>
<tn>230120136268</tn>
</missing>
<invalid>
<tn>123</tn>
</invalid>
<exception></exception>
</summary>
</tracking>
</fedex-express>
字段含義：
字段名 含義 類型
tn 運單號 String
status 該件貨物最新狀態 String
datetime 該件貨物最新狀態時間 String
destination 目的地 String
service 服務 String
2.2.3.3 一票多件匯總
樣例：
<?xml version="1.0" encoding="UTF-8"?>
<fedex-express>
<tracking>
<mps>
<ts isp="true">
<tn>120120004950</tn>
<status>遞送例外情況</status>
<datetime>2007-06-18 12:27:49</datetime>
<destination>長沙</destination>
<service>優先達</service>
</ts>
<ts isp="false">
<tn>210116898750</tn>
<status>遞送例外情況</status>
<datetime>2007-06-18 12:27:49</datetime>
<destination>長沙</destination>
<service>優先達</service>
</ts>
</mps>
</tracking>
</fedex-express>
字段含義：
字段名 含義 類型
tn 運單號 String
status 該件貨物最新狀態 String
datetime 該件貨物最新狀態時間 String
destination 目的地 String
service 服務 String
2.2.4 查詢單個運單
2.2.4.1 請求方法：
本查詢支持中文和英文，默認為中文：
GET http://example.example.ex/service/track/xxxxxxxxxxxx
英文訪問地址為:
GET http://example.example.ex/service/track.en/xxxxxxxxxxxx
2.2.4.2 應答：
如果該件貨物為一票多件，返回內容為匯總信息，參見2.2.3.3，如欲查詢該票貨物下某一件貨物詳細信息，需要再次發送請求，請求方法為:
GET http://example.example.ex/service/track/xxxxxxxxxxxx/XXXXXXXXXXXX
獲得的應答內容參見2.2.3.1
如果該件貨物為一票一件，返回內容參見2.2.3.1
如果該件貨物未能正常查詢出來，返回內容參見2.2.3.2
2.2.5 查詢多個運單
2.2.5.1 請求方法
GET http://example.example.ex/service/track/xxxxxxxxxxxx,xxxxxxxxxxxx
運單號之間以“，”分隔。
2.2.5.2 應答
返回內容為匯總信息，參見2.2.3.2，如欲查詢其中某一件貨物詳細信息，需要再次發送請求，請求方法為：
GET http://example.example.ex/service/track/xxxxxxxxxxxx,xxxxxxxxxxxx/XXXXXXXXXX如果該件貨物為一票一件，返回內容參見2.2.3.1
如果該件貨物為一票多件，返回內容為匯總信息，參見2.2.3.3，如欲查詢該票貨物下某一件貨物詳細信息，需要再次發送請求，請求方法為:
GET
http://example.example.ex/service/track/xxxxxxxxxxxx,xxxxxxxxxxxx/XXXXXXXXXXXX/xxxxxxxxxxxx
獲得的應答內容參見2.2.3.1
2.3 根據訂單號進行貨物跟蹤請求接口及應答
2.3.1 說明
您可以通過訂單號跟蹤國內限時服務的包裹。
2.3.2 請求格式
采用GET方法請求，具體樣例參見
2.3.3 應答格式
共有2種應答格式，詳見如下：
2.3.3.1 單件貨物詳細信息
樣例：
<?xml version="1.0" encoding="UTF-8"?>
<fedex-express>
<tracking order=”0953770932427”>
<detail>
<tn>120120136268</tn>
<ptn></ptn>
<destination>深圳</destination>
<shipdate>2007-05-28 18:00:00</shipdate>
<sentby>顏紅霞</sentby>
<deliveredto>廖正宏</deliveredto>
<signedforby>楊昌元</signedforby>
<service>優先達</service>
<deliverydate>2007-05-29 15:23:00</deliverydate>
<status>到達聯邦快遞工作地點</status>
<activities>
<activity>
<datetime>2008-05-06 10:41:40</datetime>
<scan>到達聯邦快遞工作地點</scan>
<location>上海</location>
<details></details>
</activity>
<activity>
<datetime>2007-05-29 15:23:00</datetime>
<scan>已送達</scan>
<location>深圳</location>
<details></details>
</activity>
<activity>
<datetime>2007-05-29 08:30:52</datetime>
<scan>貨件已裝車，派送途中</scan>
<location>深圳</location>
<details></details>
</activity>
<activity>
<datetime>2007-05-29 07:40:18</datetime>
<scan>位于當地的聯邦快遞遞送站</scan>
<location>深圳</location>
<details></details>
</activity>
<activity>
<datetime>2007-05-28 18:00:00</datetime>
<scan>已取件</scan>
<location>上海</location>
字段含義：
字段名 含義 類型
order 訂單號 String
tn 運單號 String
ptn 主運單號，為空時表示改件為一票一件 String
destination 目的地 String
shipdate 寄件日期 String
sentby 寄件人 String
deliveredto 收件人 String
signedforby 簽收人 String
servicetype 服務類型 String
deliverydate 收件日期 String
status 該件貨物最新狀態 String
datetime 該件貨物該次活動時間 String
scancode 該件貨物該次活動內容 String
location 該件貨物該次活動地點 String
details 該件貨物該次活動詳細信息 String
2.3.3.2 一票多件匯總
樣例：
<?xml version="1.0" encoding="UTF-8"?>
<fedex-express order=”0953770932427”>
<tracking>
<mps>
<ts isp="true">
<tn>120120004950</tn>
<status>遞送例外情況</status>
<datetime>2007-06-18 12:27:49</datetime>
<destination>長沙</destination>
<details></details>
</activity>
</activities>
</detail>
</tracking>
</fedex-express>
<service>優先達</service>
</ts>
<ts isp="false">
<tn>210116898750</tn>
<status>遞送例外情況</status>
<datetime>2007-06-18 12:27:49</datetime>
<destination>長沙</destination>
<service>優先達</service>
</ts>
</mps>
</tracking>
</fedex-express>
字段含義：
字段名 含義 類型
order 訂單號 String
tn 運單號 String
status 該件貨物最新狀態 String
datetime 該件貨物最新狀態時間 String
destination 目的地 String
service 服務 String
2.3.4 查詢訂單
2.3.4.1 請求方法：
本查詢支持中文和英文，默認為中文：
GET http://example.example.ex/service/mctrack/xxxx/xxxxxxxxxxxx
英文訪問地址為:
GET http://example.example.ex/service/mctrack.en/xxxx/xxxxxxxxxxxx
2.3.4.2 應答：
如果該件貨物為一票多件，返回內容為匯總信息，參見2.3.3.2，如欲查詢該票貨物下某一件貨物詳細信息，需要再次發送請求，請求方法為:
GET http://example.example.ex/service/mctrack/xxxx/xxxxxxxxxxxx/XXXXXXXXXXXX
獲得的應答內容參見2.3.3.1
如果該件貨物為一票一件，返回內容參見2.3.3.1
2.4 訪問地址
由于不同客戶使用的訪問地址可能不同，具體地址請和銷售部門聯系，謝謝。
3 SERVICE CHECKING
3.1 Service Checking 服務v1.2介紹
您可以通過提供一個郵編對（始發地郵編及目的地郵編）來查詢兩個郵編對之間存在的服務、遞送時限、電話取件截止時間等信息。
3.2 請求格式
采用POST 方法請求/ecs/service/
3.2.1 請求頭格式：
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified">
<xs:element name="RequestDocument" type="RequestDocumentType" />
<xs:complexType name="RequestDocumentType">
<xs:sequence>
<xs:element name="head" type="RequestDocumentHeadType"
minOccurs="1" maxOccurs="1" /> <!-- head of request -->
<xs:element name="body" type="xs:anyType" minOccurs="1"
maxOccurs="1" /> <!-- content of request -->
</xs:sequence>
</xs:complexType>
<xs:complexType name="RequestDocumentHeadType">
<xs:sequence>
<xs:element name="serialId" minOccurs="0" maxOccurs="1"
nillable="true"> <!-- serial id to match with the message request/response
pair -->
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:pattern
value="[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" />
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="serviceId" type="xs:string" minOccurs="1"
maxOccurs="1" /> <!-- service id -->
<xs:element name="requesterId" type="xs:string" minOccurs="1"
maxOccurs="1" /> <!-- requester id -->
</xs:sequence>
<xs:attribute name="version" type="xs:string" default="1.0" /> <!-- schema version -->
</xs:complexType>
</xs:schema>
3.2.2 請求體格式
即RequestDocument的body內部的格式
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
targetNamespace="http://cndxp.apac.fedex.com/ecs/remote/schema"
xmlns="http://cndxp.apac.fedex.com/ecs/remote/schema"
elementFormDefault="qualified">
<xs:complexType name="LogisticServicePublicRequestType">
<xs:sequence>
<xs:element name="senderPostalCode" type="xs:string"
minOccurs="1" maxOccurs="1" />
<xs:element name="recipientPostalCode" type="xs:string"
minOccurs="1" maxOccurs="1" />
<xs:element name="pickupDate" type="xs:string"
minOccurs="1" maxOccurs="1" />
</xs:sequence>
<xs:attribute name="version" type="xs:string" default="1.0" /> <!-- schema version -->
</xs:complexType>
</xs:schema>
具體參見樣例
3.2.3 請求樣例：
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<RequestDocument xmlns:sch="http://cndxp.apac.fedex.com/ecs/remote/schema">
<head version="1.0"> 請求消息頭版本號，缺省為1.0
<serialId>1e690757-87e1-4b0a-84fa-2352f724ddd6</serialId> 消息對編號，uuid格式
<serviceId>SERVICE_0002</serviceId> 服務代碼，必填
<requesterId>CUSTOMER_ID</requesterId> 請求方代碼，必填，大小寫敏感
</head>
<body xsi:type="LogisticCodServicePublicRequestType" version="1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<senderPostalCode>200042</senderPostalCode> 始發地郵編，必填
<recipientPostalCode>100017</recipientPostalCode> 目的地郵編，必填
<pickupDate>2013-01-05</pickupDate> 取件日期，必填
</body>
</RequestDocument>
3.2.4 字段含義：
字段名 含義 類型
serialId 消息對編號 UUID
serviceId 服務代碼 String
requesterId 請求方代碼 String
senderPostalCode 始發地郵編 String
recipientPostalCode 目的地郵編 String
pickupDate 取件日期 String
3.3 應答格式
共有2 類應答格式，正常應答格式和異常應答格式。
3.3.1 應答頭格式：
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified">
<xs:element name="ResponseDocument" type="ResponseDocumentType" />
<xs:complexType name="ResponseDocumentType">
<xs:sequence>
<xs:element name="head" type="ResponseDocumentHeadType"
minOccurs="1" maxOccurs="1" /> <!-- head of response -->
<xs:element name="body" type="xs:anyType" minOccurs="1"
maxOccurs="1" nillable="true" /> <!-- content of response -->
</xs:sequence>
</xs:complexType>
<xs:complexType name="ResponseDocumentHeadType">
<xs:sequence>
<xs:element name="serialId" minOccurs="0" maxOccurs="1"
nillable="true"> <!-- serial id to match with the message request/response
pair -->
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:pattern
value="[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" />
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="serviceId" type="xs:string" minOccurs="1"
maxOccurs="1" /> <!-- service id -->
<xs:element name="successFlag" type="xs:boolean"
minOccurs="1" maxOccurs="1" /> <!-- "true": success; "false": fail -->
<xs:element name="errorCode" type="xs:string" minOccurs="0"
maxOccurs="1" nillable="true" /> <!-- predefined error code if the
successFlag is false -->
<xs:element name="errorMessage" type="xs:string"
minOccurs="0" maxOccurs="1" nillable="true" /> <!-- the detail error
message of the error code -->
</xs:sequence>
<xs:attribute name="version" type="xs:string" default="1.0" /> <!-- schema version -->
</xs:complexType>
</xs:schema>
3.3.2 應答體格式：
即ResponseDocument的body 內部的格式
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
targetNamespace="http://cndxp.apac.fedex.com/ecs/remote/schema"
xmlns="http://cndxp.apac.fedex.com/ecs/remote/schema"
elementFormDefault="qualified">
<xs:complexType name="LogisticServicePublicResponseType">
<xs:sequence>
<xs:element name="logisticService" type="LogisticServicePublicType"
minOccurs="0" maxOccurs="unbounded" nillable="true" />
</xs:sequence>
<xs:attribute name="version" type="xs:string" default="1.0" /> <!-- schema version -->
</xs:complexType>
<xs:complexType name="LogisticServicePublicType">
<xs:sequence>
<xs:element name="serviceCode" type="xs:string" minOccurs="1"
maxOccurs="1" /> <!-- FedEx logistic service code -->
<xs:element name="cutOffTime" type="xs:string" minOccurs="1"
maxOccurs="1" /> <!-- latest pickup time -->
<xs:element name="isCod" type=”xs:int"
minOccurs="1" maxOccurs="1" />
<xs:element name="transitDays" type=”xs:int"
minOccurs="1" maxOccurs="1" />
<xs:element name="transitDate" type="xs:string"
minOccurs=”1” maxOccurs=”1”/>
</xs:sequence>
</xs:complexType>
</xs:schema>
詳見如下樣例
3.3.3 正常應答樣例：
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ResponseDocument xmlns:sch="http://cndxp.apac.fedex.com/ecs/remote/schema">
<head version="1.0"> 響應消息頭版本號，缺省為1.0
<serialId>1e690757-87e1-4b0a-84fa-2352f724ddd6</serialId> 消息對編號，UUID格式（與所處理的請求消息的消息編號一致）
<serviceId>SERVICE_0002</serviceId> 服務代碼
<successFlag>true</successFlag> 服務是否正常響應，若為true，則從body 中獲取響應內容
</head>
<body xsi:type="sch:LogisticServicePublicResponseType" version="1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">響應消息體版本號，缺省為1.0
<logisticService>
<serviceCode>PDS</serviceCode> 服務代碼
<cutOffTime>17:30:00</cutOffTime> 截止取件時間
<isCod>1</isCod> 有COD 業務
<transitDays>1</transitDays> 運送天數
<transitDate>2013-01-03 18:00:00</transitDate> 預計送達日期時間
</logisticService>
<logisticService>
<serviceCode>99TS</serviceCode> 服務代碼
<cutOffTime>17:30:00</cutOffTime> 截止取件時間
<isCod>1</ isCod> 有COD 業務
<transitDays>3</transitDays> 運送天數
<transitDate>2013-01-05 18:00:00</transitDate> 預計送達日期時間
</logisticService>
</body>
</ResponseDocument>
3.3.4 異常應答樣例（請求中沒有填寫始發地郵編）：
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ResponseDocument xmlns:sch="http://cndxp.apac.fedex.com/ecs/remote/schema">
<head version="1.0">
<serviceId>SERVICE_0002</serviceId>
<successFlag>false</successFlag> 服務是否正常響應，若為false，則從errorCode中獲取異常代碼，從errorMessage中獲取異常信息
<errorCode>BUS_ERR_000004</errorCode> 異常代碼,BUS前綴為業務異常，SYS前綴為系統異常
<errorMessage>Not found sender postal code!</errorMessage> 異常消息
</head>
<body xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
</ResponseDocument>
3.3.5 異常應答樣例（請求中沒有填寫目的地郵編）：
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ResponseDocument xmlns:sch="http://cndxp.apac.fedex.com/ecs/remote/schema">
<head version="1.0">
<serviceId>SERVICE_0002</serviceId>
<successFlag>false</successFlag>
<errorCode>BUS_ERR_000005</errorCode>
<errorMessage>Not found recipient postal code!</errorMessage>
</head>
<body xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
</ResponseDocument>
3.3.6 字段含義：
字段名 含義 類型
serialId 消息對編號 UUID
serviceId 服務代碼 String
successFlag 服務是否正常響應(若為false, 則從errorCode 中獲取異 Boolean
常代碼，從errorMessage 中獲取異常信息)
serviceCode 服務代碼 String
cutOffTime 截至取件時間 String
isCod COD 業務：1=有，0=無 Int
transitDays 運輸天數 Int
TransitDate 預計派送日期時間YYYY-MM-DD hh24:mi:ss String
errorCode 異常代碼(BUS 前綴為業務異常，SYS 前綴為系統異常) String
errorMessage 異常消息 String
3.4 異常代碼
3.4.1 業務異常代碼：
異常代碼 含義
BUS_ERR_000001 NOT_FOUND_REQUEST_SERVICE
BUS_ERR_000002 NOT_FOUND_REQUEST_BODY
BUS_ERR_000003 MISMATCH_REQUEST_BODY_TYPE
BUS_ERR_000004 NOT_FOUND_SENDER_POSTAL
BUS_ERR_000005 NOT_FOUND_RECIPIENT_POSTAL
BUS_ERR_000006 RAISED_BY_INERNAL_SERVICE_QUERY_LOGISTIC_SERVICE
BUS_ERR_000007 ILLEGAL_INTERNAL_SERVICE_REQUEST_FORMAT
BUS_ERR_000008 ILLEGAL_INTERNAL_SERVICE_RESPONSE_FORMAT
BUS_ERR_000009 FAIL_CONVERT_INTERNAL_SERVICE_RESPONSE_TO_XML
BUS_ERR_0000010 NOT_FOUND_PICKUP_DATE
BUS_ERR_0000011 NOT_FOUND_SERVICE_SUPPORT_MESSAGE
BUS_ERR_0000012 NOT_FOUND_MSG_FROM_POSTAL_SERVICE
BUS_ERR_0000013 ERR_FORMAT_PICKUP_DATE
3.4.2 系統異常代碼：
異常代碼 含義
SYS_ERR_0000 CAUSED_BY_SYSTEM_OF_SERVICE_QUERY_LOGISTIC_SERVICE
01
SYS_ERR_0000 CAUSED_BY_SYSTEM_OF_INERNAL_SERVICE_QUERY_LOGISTIC_S
02 ERVICE
3.5 服務地址
請和Sales 聯系。
Version Date Description of Change By
V 1.0 March 16, 2009 First Draft Li-xi Yao
V 1.1 August16, 2009 Adding tracking by order Li-xi Yao
V 1.2 Sep 26, 2009 Example update Xing-Kun Tang
V 1.3 Sep 22, 2011 Append Service Checking Ian Bao
V 1.3.1 Oct 11, 2011 CUSTOMER_ID Ian Bao
V 1.3.2 Dec 29, 2011 Change Key Contact & Doc Management Han-Yue Li
V 1.3.3 Dec 21, 2012 PDS Han-Yue Li
|
