上海翻譯公司完成開發(fā)規(guī)范英文翻譯

Specification for Interface Development of FedEx Domestic Service

 

1 About this Manual 

1.1 Resource

http://www.w3.org/XML/

1.2 Support 

Please contact [email protected]

 

2 Article tracking 

2.1 Introduction of article tracking service 

You can acquire the real-time article tracking information through FedEx domestic time-limited article tracking service 

2.2 Article tracking according to Transport tracking number 

2.2.1 Description 

You can track the package under time-limited service through Transport tracking number. 

2.2.2 Request format 

Adopt GET way for applying in specific samples. 

2.2.3 Response format 

Three Response Formats are provided as follows for details. 

2.2.3.1 Detailed information for single article  

Samples Sample ：

<?xml version="1.0" encoding="UTF-8"?>

<fedex-express>

<tracking>

<detail>

<tn>120120136268</tn>

<ptn></ptn>

<destination>Shenzhen</destination>

<shipdate>2007-05-28 18:00:00</shipdate>

<sentby>Yan Hongxia</sentby>

<deliveredto>Liao Zhenghong</deliveredto>

<signedforby>Yang Changyuan</signedforby>

<service>Preferentially delivered </service>

<deliverydate>2007-05-29 15:23:00</deliverydate>

<status>Arrival at FexEx working site</status>

<activities>

<activity>

<datetime>2008-05-06 10:41:40</datetime>

<scan>Arrival at FexEx working site</scan>

<location>Shanghai</location>

Specification for Interface Development of FedEx Domestic Service 

Page 3 Printed 12/21/2012

<details></details>

</activity>

<activity>

<datetime>2007-05-29 15:23:00</datetime>

<scan>Delivered </scan>

<location>Shenzhen</location>

<details></details>

</activity>

<activity>

<datetime>2007-05-29 08:30:52</datetime>

<scan>Articles being loaded in delivering process </scan>

<location>Shenzhen</location>

<details></details>

</activity>

<activity>

<datetime>2007-05-29 07:40:18</datetime>

<scan>At the local FedEx delivery office </scan>

<location>Shenzhen</location>

<details></details>

</activity>

<activity>

<datetime>2007-05-28 18:00:00</datetime>

<scan>Article received </scan>

<location>Shanghai</location>

<details></details>

</activity>

</activities>

</detail>

</tracking>

</fedex-express>

 

Field meaning ：

Field name  Meaning  Type 

tn  Transport tracking number String 

ptn  If Transport tracking number is null, it means the article is one-order-for-one-piece type. String 

destination  Destination  String 

shipdate  Posting date & time   String 

sentby  Sender  String 

deliveredto  Recipient   String 

signedforby  Receiver by signature    String 

servicetype  Service type  String 

deliverydate  Article-receiving date   String 

status  Updated status ofthe article   String 

datetime  Date & time of the article posting service  String 

scancode  Contents of the article posting service  String 

location  Places of the article posting service  String 

details  Detailed information of the article posting service  String 

 

2.2.3.2 Summary of variant articles

Sample ：

<?xml version="1.0" encoding="UTF-8"?>

<fedex-express>

<tracking>

<summary>

<single>

<ts>

<tn>120120136268</tn>

<status>Arrival at FexEx working site</status>

<datetime>2008-05-06 10:41:40</datetime>

<destination>Shenzhen</destination>

<service>Preferentially delivered</service>

</ts>

<ts>

<tn>120120136268</tn>

<status>Arrival at FexEx working site</status>

<datetime>2008-05-06 10:41:40</datetime>

<destination>Shenzhen</destination>

<service>Preferentially delivered</service>

</ts>

</single>

<mps>

<ts>

<tn>120120004950</tn>

<status>Exception cases of delivery </status>

<datetime>2007-06-18 12:27:49</datetime>

<destination>Changsha</destination>

<service>Preferentially delivered</service>

</ts>

</mps>

<missing>

<tn>230120136268</tn>

<tn>230120136268</tn>

</missing>

<invalid>

<tn>123</tn>

</invalid>

<exception></exception>

</summary>

</tracking>

</fedex-express>

 

Field meaning ：

Field name  Meaning  Type 

tn  Transport tracking number String 

status  Updated status ofthe article   String 

datetime  Updated time status of the article   String 

destination  Destination  String 

service  Service String 

2.2.3.3 Summary of one-order-for-variant-articles 

Sample ：

<?xml version="1.0" encoding="UTF-8"?>

<fedex-express>

<tracking>

<mps>

<ts isp="true">

<tn>120120004950</tn>

<status>Exception cases of delivery </status>

<datetime>2007-06-18 12:27:49</datetime>

<destination>Changsha</destination>

<service>Preferentially delivered</service>

</ts>

<ts isp="false">

<tn>210116898750</tn>

<status>Exception cases of delivery </status>

<datetime>2007-06-18 12:27:49</datetime>

<destination>Changsha</destination>

<service>Preferentially delivered</service>

</ts>

</mps>

</tracking>

</fedex-express>

 

Field meaning ：

Field name  Meaning  Type 

tn  Transport tracking number String 

status  Updated status ofthe article   String 

datetime  Updated time status of the article   String 

destination  Destination  String 

service  Service String 

 

2.2.4 Inquiring single order 

2.2.4.1 Request method 

This inquiry supports Chinese and English version. Chinese is the defaulted version. 

GET http://example.example.ex/service/track/xxxxxxxxxxxx

English website is 

GET http://example.example.ex/service/track.en/xxxxxxxxxxxx

2.2.4.2 Reply

If the article is one-order-for-variant-pieces, the returned contents are summarized information, referring to 2.2.3.3. If someone wants to inquire some specific article’s detailed information under the order, request shall be sent again as per the following request method. 

GET http://example.example.ex/service/track/xxxxxxxxxxxx/XXXXXXXXXXXX

The obtained replied contents refer to 2.2.3.1

 

If the article is one-order-for-one-piece, the returned contents refer to 2.2.3.1

If the article cannot be inquired normally, the returned contents refer to 2.2.3.2

 

2.2.5 Inquiring variant orders 

2.2.5.1 Request method 

GET http://example.example.ex/service/track/xxxxxxxxxxxx,xxxxxxxxxxxx

Transport tracking number is separated by “，”.

2.2.5.2 Response 

The returned contents are summarized information, referring to 2.2.3.2. If someone wants to inquire some specific article’s detailed information under the order, request shall be sent again as per the following request method. 

 

GET http://example.example.ex/service/track/xxxxxxxxxxxx,xxxxxxxxxxxx/XXXXXXXXXX 

If the article is one-order-for-one-piece, the returned contents refer to 2.2.3.1.

If the article is one-order-for-variant-pieces, the returned contents are summarized information, referring to 2.2.3.3. If someone wants to inquire some specific article’s detailed information under the order, request shall be sent again as per the following request method. 

GET

http://example.example.ex/service/track/xxxxxxxxxxxx,xxxxxxxxxxxx/XXXXXXXXXXXX/xxxxxxxxxxxx

The obtained replied contents refer to 2.2.3.1

2.3 Adopt articles tracking request interface and response according to Transport tracking number

2.3.1 Description 

You may track the packages under domestic time-limited service according to Transport tracking number. 

2.3.2 Request format 

Adopt GET way for applying, referring to Sample specifically. 

2.3.3 Response format 

Two Response formats are provided as follows for details. 

2.3.3.1 Detailed information for single article 

Sample ：

<?xml version="1.0" encoding="UTF-8"?>

<fedex-express>

<tracking order=”0953770932427”>

<detail>

<tn>120120136268</tn>

<ptn></ptn>

<destination>Shenzhen</destination>

<shipdate>2007-05-28 18:00:00</shipdate>

<sentby>Yang Hongxia</sentby>

<deliveredto>Liao Zhenghong</deliveredto>

<signedforby>Yang Changyuan</signedforby>

<service>Preferentially delivered</service>

<deliverydate>2007-05-29 15:23:00</deliverydate>

<status>Arrival at FexEx working site</status>

<activities>

<activity>

<datetime>2008-05-06 10:41:40</datetime>

<scan>Arrival at FexEx working site</scan>

<location>Shanghai</location>

<details></details>

</activity>

<activity>

<datetime>2007-05-29 15:23:00</datetime>

<scan>Delivered </scan>

<location>Shenzhen</location>

<details></details>

</activity>

<activity>

<datetime>2007-05-29 08:30:52</datetime>

<scan>Articles being loaded in delivering process </scan>

<location>Shenzhen</location>

<details></details>

</activity>

<activity>

<datetime>2007-05-29 07:40:18</datetime>

<scan>At the local FedEx delivery office </scan>

<location>Shenzhen</location>

<details></details>

</activity>

<activity>

<datetime>2007-05-28 18:00:00</datetime>

<scan>Article received </scan>

<location>Shanghai</location>

Field meaning ：

Field name  Meaning  Type 

order  Order tracking number String 

tn  Transport tracking number String 

ptn  If Transport tracking number is null, it means the article is one-order-for-one-piece type. String 

destination  Destination  String 

shipdate  Posting date & time   String 

sentby  Sender  String 

deliveredto  Recipient   String 

signedforby  Receiver by signature    String 

servicetype  Service type  String 

deliverydate  Article-receiving date   String 

status  Updated status ofthe article   String 

datetime  Date & time of the article posting service  String 

scancode  Contents of the article posting service  String 

location  Places of the article posting service  String 

details  Detailed information of the article posting service  String 

 

2.3.3.2 Summary of one-order-for-variant-articles 

Sample ：

<?xml version="1.0" encoding="UTF-8"?>

<fedex-express order=”0953770932427”>

<tracking>

<mps>

<ts isp="true">

<tn>120120004950</tn>

<status>Exception cases of delivery </status>

<datetime>2007-06-18 12:27:49</datetime>

<destination>Changsha</destination>

<details></details>

</activity>

</activities>

</detail>

</tracking>

</fedex-express>

<service>Preferentially delivered</service>

</ts>

<ts isp="false">

<tn>210116898750</tn>

<status>Exception cases of delivery </status>

<datetime>2007-06-18 12:27:49</datetime>

<destination>Changsha</destination>

<service>Preferentially delivered</service>

</ts>

</mps>

</tracking>

</fedex-express>

Field meaning ：

Field name  Meaning  Type 

order  Order tracking number String 

tn  Transport tracking number String 

status  Updated status ofthe article   String 

datetime  Updated time status of the article   String 

destination  Destination  String 

service  Service String 

2.3.4 Inquiring order 

2.3.4.1 Request method 

This inquiry supports Chinese and English version. Chinese is the defaulted version. 

GET http://example.example.ex/service/mctrack/xxxx/xxxxxxxxxxxx

English website is 

GET http://example.example.ex/service/mctrack.en/xxxx/xxxxxxxxxxxx

2.3.4.2 Response 

If the article is one-order-for-variant-pieces, the returned contents are summarized information, referring to 2.2.3.2. If someone wants to inquire some specific article’s detailed information under the order, request shall be sent again as per the following request method. 

GET http://example.example.ex/service/mctrack/xxxx/xxxxxxxxxxxx/XXXXXXXXXXXX

The obtained replied contents refer to 2.3.3.1

If the article is one-order-for-one-piece, the returned contents refer to 2.3.3.1.

2.4 Access address 

In view of different access address for different customers, please contact the sales department for specific address. Thanks. 

3 SERVICE CHECKING

3.1 Introduction of Service Checking service v1.2 

You inquire the information like the existing service, delivery time limit and deadline of getting articles by telephone between two post codes by providing a pair of post codes (Post code of commencement place and destination).

3.2 Response format 

Adopt POST method for request /ecs/service/

3.2.1 Request for head format

<?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 Request for body format 

That is, the internal body format of RequestDocument

<?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>

Specifically, refer to Sample 

3.2.3 Request Sample ：

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<RequestDocument xmlns:sch="http://cndxp.apac.fedex.com/ecs/remote/schema">

<head version="1.0"> Request message version number, 1.0 for default. 

 

<serialId>1e690757-87e1-4b0a-84fa-2352f724ddd6</serialId> Message pair number ，uuid format

<serviceId>SERVICE_0002</serviceId> Service code, necessarily filled in

<requesterId>CUSTOMER_ID</requesterId> Request party code ，necessarily filled in, capital and small letter sensitive 

</head>

<body xsi:type="LogisticCodServicePublicRequestType" version="1.0"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<senderPostalCode>200042</senderPostalCode> Commencement place code ，necessarily filled in

<recipientPostalCode>100017</recipientPostalCode> Destination post code，necessarily filled in

<pickupDate>2013-01-05</pickupDate> Date of getting articles ，necessarily filled in

</body>

</RequestDocument>

 

3.2.4 Field meaning ：

Field name  Meaning  Type 

serialId  Message pair number  UUID 

serviceId  Service code String 

requesterId  Request party code  String 

senderPostalCode  Commencement place code  String 

recipientPostalCode  Destination post code String 

pickupDate  Date of getting articles  String 

 

3.3 Response format 

Two response formats are provided, normal response format and exception  response format. 

3.3.1 Response head format 

<?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 Response body format 

That is, the internal body format of ResponseDocument. 

<?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>

 

For details, refer to the following Sample 

3.3.3 Normal response sample ：

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<ResponseDocument xmlns:sch="http://cndxp.apac.fedex.com/ecs/remote/schema">

<head version="1.0"> Response message head version number, default value is 1.0.

<serialId>1e690757-87e1-4b0a-84fa-2352f724ddd6</serialId>  Number of information pairs, UUID format (Information number must be identical with the request message for treating). 

<serviceId>SERVICE_0002</serviceId> Service code

<successFlag>true</successFlag>  Whether service responds normally or not; if true, get response content from body. 

</head>

<body xsi:type="sch:LogisticServicePublicResponseType" version="1.0"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Response message body version number, default value is 1.0.

<logisticService>

<serviceCode>PDS</serviceCode> Service code

<cutOffTime>17:30:00</cutOffTime> Deadline for getting articles 

<isCod>1</isCod> with COD business 

<transitDays>1</transitDays> Delivery days

<transitDate>2013-01-03 18:00:00</transitDate> Expected delivered date and time 

</logisticService>

<logisticService>

<serviceCode>99TS</serviceCode> Service code

<cutOffTime>17:30:00</cutOffTime> Deadline for getting articles 

<isCod>1</ isCod> with COD business 

<transitDays>3</transitDays> Delivery days

<transitDate>2013-01-05 18:00:00</transitDate> Expected delivered date and time 

</logisticService>

</body>

</ResponseDocument>

 

3.3.4 Exception  reply Sample （Post code of commencement place is not filled in the request）：

<?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> Whether service responds normally or not; if false, get exception  code from errorCode and get exception  message from errorMessage. 

<errorCode>BUS_ERR_000004</errorCode> Exception code, BUS prefix indicates business exception and SYS prefix indicates system exception 

<errorMessage>Not found sender postal code!</errorMessage> Exception message 

</head>

<body xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>

</ResponseDocument>

 

3.3.5 Exception  reply Sample （Post code of destination place is not filled in the request ）：

<?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 Field meaning ：

Field name  Meaning  Type 

serialId  Message pair number  UUID 

serviceId  Service code String 

successFlag  Boolean 

Whether service responds normally or not; if false, get exception code from errorCode and get exception message from errorMessage.

serviceCode  Service code String 

cutOffTime  Up to the time of getting articles  String 

isCod  COD business：1=existing，0=null Int 

transitDays  Delivery date Int 

TransitDate  Expected delivery date:YYYY-MM-DD hh24:mi:ss  String 

errorCode  Exception code(BUS prefix indicates business exception; SYS prefix indicates system exception)  String 

errorMessage  Exception message  String 

3.4 Exception code

3.4.1Business exception code：

Exception code Meaning 

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 System exception code：

Exception code Meaning 

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 Service address 

Please contact the sales personnel 

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