0% found this document useful (0 votes)
755 views85 pages

XMLServices7.0 CapabilityAndQuoteService

This document provides information about DHL's Capability and Quote Service including: - An overview of the service and how it allows customers to request shipping quotes and validate addresses. - Details on the request and response schemas including required elements like shipment details, addresses, and available services. - Descriptions of common response elements like quoted services, rates, and notes on eligibility or errors. - Error response schemas to communicate status and issues with a request. The service enables shipping cost estimates and validation of addresses and services for international deliveries through a standardized XML interface.

Uploaded by

Mohamad Yassine
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
755 views85 pages

XMLServices7.0 CapabilityAndQuoteService

This document provides information about DHL's Capability and Quote Service including: - An overview of the service and how it allows customers to request shipping quotes and validate addresses. - Details on the request and response schemas including required elements like shipment details, addresses, and available services. - Descriptions of common response elements like quoted services, rates, and notes on eligibility or errors. - Error response schemas to communicate status and issues with a request. The service enables shipping cost estimates and validation of addresses and services for international deliveries through a standardized XML interface.

Uploaded by

Mohamad Yassine
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 85

Reference Document-XMLServices 7.

PROGRAMME & DEVELOPMENT SERVICES

XML
Services
Ver 7.0

Reference Document – Capability and Quote Service

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc -1–
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

Table Of Contents
1 INTRODUCTION .............................................................................................................................. 5

1.1 Implementation of the Service .............................................................................................................................5

1.2 About the Capabilty and Quote Service .............................................................................................................5

1.3 About the Data Element Definition Tables .........................................................................................................5


2 CAPABILITY AND QUOTE SERVICE REQUEST ..................................................................... 7
3 CAPABILITY AND QUOTE SERVICE REQUEST SCHEMA .................................................. 7

3.1 Request Element ...................................................................................................................................................9


3.1.1 ServiceHeader Element ..................................................................................................................................9
3.1.2 MetaData Element ....................................................................................................................................... 11

3.2 From Element ..................................................................................................................................................... 12


3.2.1 DCTFrom Element........................................................................................................................................ 12

3.3 BkgDetails Element ......................................................................................................................................... 14


3.3.1 PaymentCountryCode Element ................................................................................................................ 20
3.3.2 Date Element ............................................................................................................................................ 20
3.3.3 ReadyTime Element ................................................................................................................................. 20
3.3.4 ReadyTimeGMTOffset Element .............................................................................................................. 21
3.3.5 DimensionUnit Element ........................................................................................................................... 21
3.3.6 WeightUnit Element ................................................................................................................................. 21
3.3.7 NumberOfPieces Element ........................................................................................................................ 22
3.3.8 ShipmentWeight Element ......................................................................................................................... 22
3.3.9 Volume Element ....................................................................................................................................... 22
3.3.10 MaxPieceWeight Element ................................................................................................................... 22
3.3.11 MaxPieceHeight Element .................................................................................................................... 22
3.3.12 MaxPieceDepth Element ..................................................................................................................... 23
3.3.13 MaxPieceWidth Element ..................................................................................................................... 23
3.3.14 Pieces Element ..................................................................................................................................... 23
3.3.15 PaymentAccountNumber Element ............................................................................................................... 27
3.3.16 IsDutiable Element....................................................................................................................................... 27
3.3.17 NetworkTypeCode Element ......................................................................................................................... 28
3.3.18 QtdShp Element ........................................................................................................................................... 28
3.3.19 InsuredValue Element .................................................................................................................................. 31
3.3.20 InsuredCurrency Element ............................................................................................................................ 31
3.3.21 PaymentType Element ................................................................................................................................. 31
3.3.22 AcctPickupCloseTime Element ................................................................................................................... 31

3.4 To Element ........................................................................................................................................................ 32


3.4.1 DCTTo Element ............................................................................................................................................ 32

3.5 Dutiable Element .............................................................................................................................................. 34


3.5.1 DCTDutiable Element .................................................................................................................................. 34

3.6 Generic Request Element ........................................................................................................................... 35


3.6.1 GenReq Element ........................................................................................................................................... 35
4 CAPABILITY AND QUOTE SERVICE RESPONSE SCHEMA .............................................. 39

4.1 Response Element ........................................................................................................................................ 41


4.1.1 ServiceHeader Element ........................................................................................................................ 41

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc -2–
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

4.2 BkgDetails Element .......................................................................................................................................... 42


4.2.1 QtdShp Element........................................................................................................................................ 43

4.3 Srvs Element ..................................................................................................................................................... 71


4.3.1 GlobalProductCode Element .................................................................................................................... 72
4.3.2 MrkSrv Element ....................................................................................................................................... 72
4.3.3 SBTP Element .......................................................................................................................................... 76

4.4 Note Element .................................................................................................................................................... 79


4.4.1 ActionStatus Element ............................................................................................................................... 80
4.4.2 Condition Element .................................................................................................................................... 80
5 CAPABILITY AND QUOTE SERVICE ERROR RESPONSE SCHEMA ............................... 82

5.1 Capability and Quote service error Response Data Element Definitions ...................................................... 82

5.2 Response Element .............................................................................................................................................. 82


5.2.1 ServiceHeader Element ............................................................................................................................ 82
5.2.2 Status Element ............................................................................................................................................ 84
5.2.3 ActionStatus Element .................................................................................................................................. 85
5.2.4 Condition Element .................................................................................................................................... 85

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc -3–
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

XML Release Date Comments


Services
version
5.2 20 March 2016 Minor updates for valid values definition table on
1. Section 3.2.1 postal code and suburbs
elements
2. Section 3.3 PaymentCountryCode elements

5.2 22 July 2016 Update on section 1.2 on usage of the DCT and
Shipment request
6.1 20th Nov 2017 1. Updated/added new fields for Request and
Response for of Global Schema v1.0 schema.
a. Section 3.6.1: GenReq element
b. Section 4.2.3.33:
PickupWindowEarliestTime element
c. Section 4.2.3.34:
PickupWindowLatestTime element
d. Section 4.2.3.35: BookingCutoffOffset
element
e. Section 4.2.3.36: DeliveryDate element
f. Section 4.2.3.37: PickupLeadTime
element
g. Section 4.2.3.38: PickupCloseTime
element
h. Section 4.2.3.39: WeightChargeDisc
element
i. Section 4.2.3.40: QtdShpExChrgDisc
element
j. Section 4.2.3.27 QtdShpExChrg element
k. Section 4.2.3.32 WeightChargeTaxDet
element
l. Section 4.2.3.39 WeigthChargeDisc
element
m. Section 4.2.3.40 QtdShpChrgDisc element

2. Updated metadata for request level in section


3.

6.2 21st Nov 2017 Rename document from v6.1 to v6.2.


1st March 2018 CN Change Request – change wording “Country”
to “Country/Region”
29th August Updated section 3.3.7 NumberOfPieces to 999.
2018
3rd October, Updated section 4.2.3.14 ExchangeRate Element
2018
Note: Only Major changes will increase the version number.

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc -4–
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

1 Introduction
This document describes the XML public interface for the Capability and Quote service. The
document specifies the XML message document used to invoke these service functions, and the
response XML message document from the service.
In this document are the Capability Request and Capability Response schema. Tables describe the
data elements to be found in each schema.
Note: These schema confirm to the May 2, 2001 XML Schema recommendation of the W3C. For
more information see the XML Schema page of the W3C Web site at
http://www.w3c.org/XML/Schema.

1.1 Implementation of the Service


This service is implemented using XML messaging. The customer/partner is responsible for
sending an XML message in the format displayed in the Request schema in this document. The
customer/partner is responsible for implementing the capability service to receive XML messages
in the format displayed in the Response schema in this document.

1.2 About the Capabilty and Quote Service


The Capability and Quote service is used to provide Capability, Transit Time and Price for the
complete set of DHL Express Products and Services and from anywhere to anywhere. Users have
option to request information for specific product or service or get information about all available
options.

Capability service will provide list of products, booking and pick-up cutoff times, transit time and
expected delivery date. In addition to the information provided by Capability service, the Quote
service will provide account specific or standard book rate price for requested products and
services.

Please notice the difference between the GetQuote service and the GetCapability service.
The GetCapability service will return capabilities, while GetQuote will return price AND
capabilities. If price is not needed, then GetCapability service could be used. This will
slightly speed up the response time.

1.3 About the Data Element Definition Tables


The following tables describe the elements found in the Capability and Quote service Request and
Response messages. In the tables:
 Element Name is the data element’s name within the XML document. 

 Datatype/Format indicates the data element’s type or format if no specific datatype is listed (for
example, text strings). To view the complete set of the datatypes for all XML Shipping Services,
 see the document entitled XML Shipping Services: Datatype Definitions. 
 Definition is a short description of the data element. 

 Req(uired) indicates whether an element is required and the number of times the element can occur
in the message. Each element occurs only once, unless otherwise specified. If the element can

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc -5–
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

 occur more than once, the maximum number of occurrences is indicated in parentheses. 
 M indicates that the segment is mandatory. 

 O indicates that the segment is optional. 

 C indicates that segment is conditional. The condition that triggers the requirement of the
segment is indicated in Definition. 

• Type indicates the value type—either numeric, alphanumeric (indicated in the table as A/N), date,
or integer.
• Length indicates the length of the value. Any special format of the field value is indicated in
parentheses.
 Valid Values indicates required values, if any. Where specific values are expected, the value passed
in the message is indicated in bold text, followed by the literal meaning in parentheses. 

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc -6–
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

2 Capability and Quote service Request

The following is the Capability and Quote service request schema. The schema has been defined
based on GetCapability and GetQuote request. Following the schema is a table outlining the data
elements found in the schema. Each element in the schema is defined in brief wherever it occurs.

3 Capability and Quote service Request Schema


Following is the schema of Capability and Quote service request. All XML request for Capability
and Quote service should confirm to the following schema file.

Global Schema version 2.0:

<?xml version="1.0"?>
<xsd:schema targetNamespace="http://www.dhl.com" xmlns:dhl="http://www.dhl.com/datatypes_global"
xmlns="http://www.dhl.com" xmlns:dct="http://www.dhl.com/DCTRequestdatatypes"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" elementFormDefault="unqualified">
<xsd:import namespace="http://www.dhl.com/datatypes_global" schemaLocation="datatypes_global_v62.xsd" />
<xsd:import namespace="http://www.dhl.com/DCTRequestdatatypes" schemaLocation="DCTRequestdatatypes_global.xsd" />
<xsd:element name="DCTRequest">
<xsd:complexType>
<xsd:sequence>
<xsd:choice minOccurs="1" maxOccurs="1">
<xsd:element name="GetQuote">
<xsd:annotation>
<xsd:documentation>Root element of Capability request</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="Request" type="dhl:Request" />
<xsd:element name="From" type="dct:DCTFrom" minOccurs="1" />
<xsd:element name="BkgDetails" minOccurs="1" type="dct:BkgDetailsType" />
<xsd:element name="To" minOccurs="1" type="dct:DCTTo" />
<xsd:element name="Dutiable" minOccurs="0" type="dct:DCTDutiable" />
<xsd:element name="GenReq" minOccurs="0" type="dct:GenReq" />
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="GetCapability">
<xsd:annotation>
<xsd:documentation>Root element of Capability request</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="Request" type="dhl:Request" />
<xsd:element name="From" type="dct:DCTFrom" minOccurs="1" />
<xsd:element name="BkgDetails" minOccurs="1" type="dct:BkgDetailsType" />
<xsd:element name="To" minOccurs="1" type="dct:DCTTo" />
<xsd:element name="Dutiable" minOccurs="0" type="dct:DCTDutiable" />
<xsd:element name="GenReq" minOccurs="0" type="dct:GenReq" />
</xsd:sequence>

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc -7–
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

</xsd:complexType>
</xsd:element>
</xsd:choice>
</xsd:sequence>
<xsd:attribute name="schemaVersion" type="xsd:decimal" use="required" fixed="2.0" />
</xsd:complexType>
</xsd:element>
</xsd:schema>

Capability and Quote service Request Data Element Definitions


The following table describes the data elements found in the Capability and Quote service Request :

Element Datatype/Format Req Definition Valid Values


Name
DCTRequest xsd:complexType M Identifies the capability request type
GetQuote xsd:complexType M Capability request type of GetQuote to
retrieve the capabilities and price information
based on the list of products.
GetCapability xsd:complexType M Capability request type of GetCapability to
retrieve the capabilities information based on
the list of products.

GetQuote and GetCapability Request Data Element Definitions


The following table describes the data elements found in the GetQuote and GetCapability request schema:

Element Datatype/Format Req Definition Valid Values


Name
Request dhl:Request M Identifies the message as a
request message
From dct:DCTFrom M Origin address of the shipment
BkgDetails dct:BkgDetailsType M Details of the shipment
To dct:DCTTo M Destination address of the
shipment
Dutiable dct:DCTDutiable O For international shipments, Non-dutiable or Doc: These are
shipments with no monetary value
information that defines the and are known as documents or
general correspondence.
types of duties to be levied.
Domestic shipments are Dutiable or Non Doc: All other
shipments classified as dutiable
considered Non-dutiable or
shipments by Customs may be levied
Doc. customs duties and taxes for entrance
into the destination country/region.

Please work with your DHL


representative if you have questions
about shipment dutiable status.

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc -8–
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

Element Datatype/Format Req Definition Valid Values


Name
GenReq dct:GenReq O Supports generic request Supported request criteria:
OSINFO - find all valid product and
criteria. service combinations
NXTPU - if pickup is not possible on
requested pickup day, find next
possible pickup
FCNTWTYCD - To specify facility
network type
CUSTAGRIND - customer
agreement indicator for product and
services
VLDTRT_DD - validate ready time
against pickup window start on DDI
products

3.1 Request Element


The element contains the header information for the message. It is present in both the request and
response XML message. The request element contains a complex data type ServiceHeader.

<xsd:complexType name="Request">
<xsd:annotation>
<xsd:documentation>Generic request header</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="ServiceHeader" type="ServiceHeader"/>
<xsd:element name="MetaData" type="MetaData" />
</xsd:sequence>
</xsd:complexType>

3.1.1 ServiceHeader Element


The Service Header element contains the header information about the request message. This
element must be declared only once in the Request element.

<xsd:complexType name="ServiceHeader">
<xsd:annotation>
<xsd:documentation>Standard routing header</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="MessageTime" type="xsd:dateTime"
minOccurs="0">
<xsd:annotation>
<xsd:documentation>Time this message is sent</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="MessageReference" type="MessageReference"
minOccurs="0"> <xsd:annotation>
<xsd:documentation>A string, peferably number, to uniquely identify individual messages.
Minimum length must be 28 and maximum length is 32</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="SiteID" type="SiteID"/>
<xsd:element name="Password" type="Password" />

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc -9–
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

</xsd:sequence>
</xsd:complexType>

ServiceHeader Element Definitions


The following table describes the data elements found in the ServiceHeader schema:
Element Name Datatype/Format Req Definition Valid Values
MessageTime xsd:dateTime O Identifies the message time. It is a
mandatory field in request message
MessageReference MessageReference O Message reference number.
SiteID SiteID M Identifies the sender of the request
message. It is a mandatory field in the
request message.
Password Password M Authenticates the sender of the
message. It is a mandatory field in
request message.

3.1.1.1 MessageTime Element


The Message Time element contains the time at which the message was send by the
requestor. The format of the should be YYYY-MM-DD(T)hh-mm-ss-Time Zone
where “T” is the separator between date and time.
e.g. 2002-12-02T13:23:18-07:00

<xsd:element name="MessageTime" type="xsd:dateTime" minOccurs="0">


<xsd:annotation>
<xsd:documentation>Time this message is sent</xsd:documentation>
</xsd:annotation>
</xsd:element>

3.1.1.2 Message Reference Element


The Message Reference element contains the unique reference to the message, so
that trace of a particular message can be done easily. It must be of minimum
length of 28 and maximum 32.

<xsd:element name="MessageReference" type="MessageReference" minOccurs="0">


<xsd:annotation>
<xsd:documentation>A string, peferably number, to uniquely identify individual
messages. Minimum length must be 28 and maximum length is 32
</xsd:documentation>
</xsd:annotation>
</xsd:element>

3.1.1.3 SiteID Element


The site id element is used to identify the requestor of the message. Each
partner/customer is provided with the site id and password. Each request message
received is validated with this before proceeding forward.

<xsd:simpleType name="SiteID">
<xsd:annotation>
<xsd:documentation>Site ID used for verifying the sender</xsd:documentation> </xsd:annotation>

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 10 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

<xsd:restriction base="xsd:string">
<xsd:minLength value="6"/>
<xsd:maxLength value="12"/>
</xsd:restriction>
</xsd:simpleType>

3.1.1.4 Password Element


The password element is used to identify the requestor of the message. Each partner/customer is
provided with the site id and password. Each request message received is validated with this before
proceeding forward.

<xsd:simpleType name="Password">
<xsd:annotation>
<xsd:documentation>Password used for verifying the sender</xsd:documentation>
</xsd:annotation>
<xsd:restriction base="xsd:string">
<xsd:minLength value="8"/>
<xsd:maxLength value="20"/>
</xsd:restriction>
</xsd:simpleType>

3.1.2 MetaData Element


The Metadata element is used to identify the software name and software version used by
customer or third party vendor. It is mandatory field.

<xsd:complexType name="MetaData">
<xsd:annotation>
<xsd:documentation>MetaData header</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="SoftwareName">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:maxLength value="30" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="SoftwareVersion">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:maxLength value="10" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>

Element
Name Datatype/Format Req Definition Valid Values
Software Name xsd:string M Identifies the software name. Eg. Application Name
Max length: 30 characters
Software Version xsd:string M Identifies the software version. Eg. Application Version
Max length: 10 characters Number

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 11 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

3.2.2.1 Software Name

The Software Name element is used to identify the software name used by customer or third party
vendor. It is mandatory field.

<xsd:element name="SoftwareName">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:maxLength value="30" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

3.2.2.2 Software Version

The Software Version element is used to identify the software version used by customer or third
party vendor. It is mandatory field.
<xsd:element name="SoftwareVersion">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:maxLength value="10" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

3.2 From Element


From element is used to identify the origin address of the shipment.

<xsd:element name="From" type="dct:DCTFrom" minOccurs="1" />

3.2.1 DCTFrom Element


<xsd:complexType name="DCTFrom">
<xsd:sequence>
<xsd:element name="CountryCode" minOccurs="1">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="2" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="Postalcode" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:maxLength value="12" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="City" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:maxLength value="45" />

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 12 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="Suburb" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:maxLength value="45" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>

DCTFrom Element Definitions

The following table describes the data elements found in the DCTFrom schema:

Element Datatype/Format Req Definition Valid Values


Name
CountryCode xsd:string M Origin Country/Region Code Please refer to the Reference Data
(DHL Country/Region).
Postalcode xsd:string O Origin Postal code <= 12 characters.Required for
countries with postcodes and in
correct format. Please refer to the
Reference Data (DHL
Country/Region – Postcode
format).
City xsd:string O Origin city <= 45 characters.
Although not required, City name
will provide more accurate
information for larger postcodes
with multiple cities.
Suburb xsd:string O Origin suburb <= 45 characters.
Required for countries where
DHL has suburb level capability
variation. Please refer to the
Reference Data (DHL
Country/Region).

3.2.1.1 CountryCode Element


The CountryCode element contains the country/region code of the origin address.

<xsd:element name="CountryCode" minOccurs="1">


<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="2" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

3.2.1.2 Postalcode Element


The Postalcode element contains the postal code of the origin address. It is required for countries
with postcodes and in correct format. Please refer to the Reference Data (DHL Country/Region) –
Postcode format.
<xsd:element name="Postalcode" minOccurs="0">
<xsd:simpleType>

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 13 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

<xsd:restriction base="xsd:string">
<xsd:maxLength value="12" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

3.2.1.3 City Element


The City element contains the city of the origin address.

<xsd:element name="City" minOccurs="0">


<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:maxLength value="45" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

Note: Using a CDATA definition is recommended for contents of this element.


It is allowed to use without CDATA definition for extended characters and request XML
must be saved in UTF-8 format. This field support Cyrillic characters.
3.2.1.4 Suburb Element
The Suburb element contains the suburb of the origin address.

<xsd:element name="Suburb" minOccurs="0">


<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:maxLength value="45" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

Note: Using a CDATA definition is recommended for contents of this element.


It is allowed to use without CDATA definition for extended characters and request XML
must be saved in UTF-8 format. This field support Cyrillic characters.

3.3 BkgDetails Element


BkgDetails element is used to identify the shipment related information.

<xsd:element name="BkgDetails" minOccurs="1" type="dct:BkgDetailsType" />

<xsd:complexType name="BkgDetailsType">
<xsd:sequence>
<xsd:element name="PaymentCountryCode" minOccurs="1">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="2" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="Date" minOccurs="1">
<xsd:simpleType>
<xsd:restriction base="xsd:date" />
</xsd:simpleType>
</xsd:element>

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 14 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

<xsd:element name="ReadyTime">
<xsd:simpleType>
<xsd:annotation>
<xsd:documentation> Time in hours and minutes (PTnHnM)</xsd:documentation>
</xsd:annotation>
<xsd:restriction base="xsd:duration"/>
</xsd:simpleType>
</xsd:element>
<xsd:element name="ReadyTimeGMTOffset" minOccurs="0">
<xsd:simpleType>
<xsd:annotation>
<xsd:documentation>Time in hours and minutes (HH:MM)</xsd:documentation>
</xsd:annotation>
<xsd:restriction base="xsd:string">
<xsd:minLength value="0"></xsd:minLength>
<xsd:maxLength value="6"></xsd:maxLength>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="DimensionUnit" minOccurs="1">
<xsd:simpleType>
<xsd:annotation>
<xsd:documentation>Dimension Unit I (inches);Centimeters (CM)</xsd:documentation>
</xsd:annotation>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="IN" />
<xsd:enumeration value="CM" />
<xsd:maxLength value="3"></xsd:maxLength>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="WeightUnit" minOccurs="1">
<xsd:simpleType>
<xsd:annotation>
<xsd:documentation>Kilogram (KG),Pounds (LB)</xsd:documentation>
</xsd:annotation>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="KG" />
<xsd:enumeration value="LB" />
<xsd:maxLength value="3"></xsd:maxLength>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="NumberOfPieces" minOccurs="0" maxOccurs="999">
<xsd:simpleType>
<xsd:restriction base="xsd:positiveInteger">
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="ShipmentWeight" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="15"/>
<xsd:fractionDigits value="3"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="Volume" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="15"/>
<xsd:fractionDigits value="3"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="MaxPieceWeight" minOccurs="0">
<xsd:simpleType>

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 15 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="15"/>
<xsd:fractionDigits value="3"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="MaxPieceHeight" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="10"/>
<xsd:fractionDigits value="3"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="MaxPieceDepth" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="10"/>
<xsd:fractionDigits value="3"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="MaxPieceWidth" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="10"/>
<xsd:fractionDigits value="3"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="Pieces" minOccurs="0">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="Piece" type="PieceType" maxOccurs="999" minOccurs="1">
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="PaymentAccountNumber" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:maxLength value="12"></xsd:maxLength>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="IsDutiable" minOccurs="0">
<xsd:simpleType>
<xsd:annotation>
<xsd:documentation>Y - Dutiable/Non-Doc, N -Non-dutiable/Doc</xsd:documentation>
</xsd:annotation>
<xsd:restriction base="xsd:string">
<xsd:length value="1" />
<xsd:enumeration value="Y" />
<xsd:enumeration value="N" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="NetworkTypeCode" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="2" />
<xsd:enumeration value="DD" />
<xsd:enumeration value="TD" />
<xsd:enumeration value="AL" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 16 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

<xsd:element name="QtdShp" minOccurs="0" maxOccurs="unbounded" type="QtdShpType" />


<xsd:element name=”InsuredValue” minOccurs=”0”>
<xsd:simpleType>
<xsd:restriction base=”xsd:decimal”>
<xsd:totalDigits value=”18”/>
<xsd:fractionDigits value=”3”/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name=”InsuredCurrency” minOccurs=”0”>
<xsd:simpleType>
<xsd:restriction base=”xsd:string”>
<xsd:length value=”3”></xsd:length>
</xsd:restriction>
<xsd:element name="PaymentType" minOccurs="0">
<xsd:annotation>
<xsd:documentation>Payment type - by method of payment ( DHL account)</xsd:documentation>
</xsd:annotation>
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="D" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="AcctPickupCloseTime" minOccurs="0">
<xsd:annotation>
<xsd:documentation>Account's Pickup Close Time to be retrieved from GCDB or
specified by customer</xsd:documentation>
</xsd:annotation>
<xsd:simpleType>
<xsd:restriction base="xsd:dateTime"/>
</xsd:simpleType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:sequence>
</xsd:complexType>

BkgDetailsType Element Definitions


The following table describes the data elements found in the BkgDetailsType schema:

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 17 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

Element Name Datatype/Format Req Definition Valid Values


PaymentCountryCode xsd:string M Payment Country/Region Please refer to the Reference
Data (DHL Country/Region).
Code
Note: This element is based off of
the billing account number being
used for the country/region that
the account belongs to.
Date xsd:date M Shipment Date
ReadyTime xsd:duration M Time when the shipment can P indicates the period (required)
T indicates the start of a time
be picked up. Used to section
nH indicates the number of hours
calculate the available
nM indicates the number of
capabilities and do a next day minutes
skip if all pickup times have
Eg. PT10H21M
passed for the requested day.
ReadyTimeGMTOffset xsd:string O Ready time GMT Offset. +/-(HH:MM)

This is attribute is not used.


DimensionUnit xsd:string M Dimension unit of IN (Inches)
CM (Centimetres)
measurement
WeightUnit xsd:string M Weight unit of measurement KG (Kilograms)
LB (Pounds)
NumberOfPieces xsd:postivieInteger O Number of pieces. Required <= 999

when no piece details are


given.
ShipmentWeight xsd:decimal O Total shipment weight. Decimal (15,3)

Required when no piece


detgails are given.
Volume xsd:decimal O Total volume (LxWxH) for Decimal (15,3)

the shipment. For multi-piece


shipment please add volumes
of individual pieces.
Volumetric weight will be
calculated using this Volume.

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 18 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

Element Name Datatype/Format Req Definition Valid Values


MaxPieceWeight xsd:decimal O If no piece detgails are given, Decimal (15,3)

the weight of the heaviest


piece should be provided in
order to check restrictions.
MaxPieceHeight xsd:decimal O If piece details are not Decimal (10,3)

provide then this column can


contain the longest height
(longest side) for a piece in
order to check the
restrictions.
MaxPieceDepth xsd:decimal O If piece details are not Decimal (10,3)

provided then this column


can contain the longest height
(longest side) for a piece in
order to check the
restrictions.
MaxPieceWidth xsd:decimal O If piece details are not Decimal (10,3)

provided then this column


can contain the longest width
(longest smallest side) or
diameter for a piece in order
to check the restrictions.
Pieces PieceType O Pieces segment when
individual pieces are
specified to get accurate
dimensional weight and
apply all the
weight/dimension
restrictions.
PaymentAccountNumber xsd:string O Payment Account Number. <=12 characters

Note that payment account


number must belong to the
country/region with
PaymentCountryCode above
IsDutiable xsd:string M Dutiable flag Y – Dutiable/Non-Doc
N – Non-Dutiable/Doc

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 19 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

Element Name Datatype/Format Req Definition Valid Values


NetworkTypeCode xsd:string O Network type code AL – Both Time and Day Definite
DD - Day Definite
Note: blank value or missing TD - Time Definite
node will only return TD
products from EU and both
TD & DD products from AP
and AM countries.
QtdShp QtdShpType O Shipment and Product related
information
InsuredValue xsd:decimal O Insurance amount Decimal(18,3)

InsuredCurrency xsd:string O Insurance currency code Please refer to the Reference Data
(DHL Country/Region).
PaymentType xsd:string O Method of payment ( DHL D=DHL Account

account)
AcctPickupCloseTime xsd:dateTime O Account's Pickup Close Time
to be retrieved from GCDB
or specified by customer

3.3.1 PaymentCountryCode Element


The PaymentCountryCode element contains the country/region of payment.

<xsd:element name="PaymentCountryCode" minOccurs="1">


<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="2" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

3.3.2 Date Element


The Date element contains the pickup date of the shipment. If the pu date is holiday, or weekend
and in TTS is not set pu capability, DCT can't offer pickup on that date. PU date is shifted just in
case the ready by time is after cut off time.

Note: This is only applicable to GetCapability service.

<xsd:element name="Date" minOccurs="1">


<xsd:simpleType>
<xsd:restriction base="xsd:date" />
</xsd:simpleType>
</xsd:element>

3.3.3 ReadyTime Element


The ReadyTime element contains the time when the shipment can be picked up.

Note: This is only applicable to GetCapability service.

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 20 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

<xsd:element name="ReadyTime">
<xsd:simpleType>
<xsd:annotation>
<xsd:documentation> Time in hours and minutes (PTnHnM)</xsd:documentation>
</xsd:annotation>
<xsd:restriction base="xsd:duration"/>
</xsd:simpleType>
</xsd:element>

3.3.4 ReadyTimeGMTOffset Element


The ReadyTimeGMTOffset element contains the shipment pickup ready time GMT
Offset.
Note: This is only applicable to GetCapability service.
<xsd:element name="ReadyTimeGMTOffset" minOccurs="0">
<xsd:simpleType>
<xsd:annotation>
<xsd:documentation>Time in hours and minutes (HH:MM)</xsd:documentation>
</xsd:annotation>
<xsd:restriction base="xsd:string">
<xsd:minLength value="0"></xsd:minLength>
<xsd:maxLength value="6"></xsd:maxLength>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

3.3.5 DimensionUnit Element


The DimensionUnit element contains the unit of measurement for the piece element.

<xsd:element name="DimensionUnit" minOccurs="1">


<xsd:simpleType>
<xsd:annotation>
<xsd:documentation>Dimension Unit IN(inches);Centimeters (CM)</xsd:documentation>
</xsd:annotation>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="IN" />
<xsd:enumeration value="CM" />
<xsd:maxLength value="3"></xsd:maxLength>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

3.3.6 WeightUnit Element


The WeightUnit element contains the unit measurement for the shipment weight.

<xsd:element name="WeightUnit" minOccurs="1">


<xsd:simpleType>
<xsd:annotation>
<xsd:documentation>Kilogram (KG),Pounds (LB)</xsd:documentation>
</xsd:annotation>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="KG" />
<xsd:enumeration value="LB" />
<xsd:maxLength value="3"></xsd:maxLength>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 21 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

3.3.7 NumberOfPieces Element


The NumberOfPieces element contains the total number of pieces for the shipment.

<xsd:element name="NumberOfPieces" minOccurs="0" maxOccurs="999">


<xsd:simpleType>
<xsd:restriction base="xsd:positiveInteger">
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

3.3.8 ShipmentWeight Element


The ShipmentWeight element contains the total weight for the shipment.

<xsd:element name="ShipmentWeight" minOccurs="0">


<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="15"/>
<xsd:fractionDigits value="3"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

3.3.9 Volume Element


The Volume element contains the total volume (Length * Width * Height) for the shipment. For
multi piece shipment, specify the volumes of individual pieces. Volumetric weight will be
calculated by DCT using this Volume.

<xsd:element name="Volume" minOccurs="0">


<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="15"/>
<xsd:fractionDigits value="3"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

3.3.10 MaxPieceWeight Element


The MaxPieceWeight element contains the maximum piece weight. If no piece details are given,
the weight of the heaviest piece should be provided in order to check the restrictions.

<xsd:element name="MaxPieceWeight" minOccurs="0">


<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="15"/>
<xsd:fractionDigits value="3"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

3.3.11 MaxPieceHeight Element


The MaxPieceHeight element contains the maximum piece height. If no piece details are
provided, this field value contains the longest height available for a piece in order to check
the restrictions.
Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 22 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

<xsd:element name="MaxPieceHeight" minOccurs="0">


<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="10"/>
<xsd:fractionDigits value="3"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

3.3.12 MaxPieceDepth Element


The MaxPieceDepth element contains the maximum piece depth or length. If no piece details are
provided, this field value contains the longest length available for a piece in order to check the
restrictions.

<xsd:element name="MaxPieceDepth" minOccurs="0">


<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="10"/>
<xsd:fractionDigits value="3"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

3.3.13 MaxPieceWidth Element


The MaxPieceWidth element contains the maximum piece width. If no piece details are provided,
this field value contains the longest width available or diameter for a piece in order to check the
restrictions.

<xsd:element name="MaxPieceWidth" minOccurs="0">


<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="10"/>
<xsd:fractionDigits value="3"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

3.3.14 Pieces Element


The Pieces element contains each individual pieces information which preferable to get more
accurate dimensional weight and apply all the weight or dimension restrictions.

<<xsd:element name="Pieces" minOccurs="0">


<xsd:complexType>
<xsd:sequence>
<xsd:element name="Piece" type="PieceType" maxOccurs="999" minOccurs="1">
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>

3.3.14.1 PieceType Element

<xsd:complexType name="PieceType">

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 23 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

<xsd:sequence>
<xsd:element name="PieceID" minOccurs="1">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:pattern value="[0-9]+"></xsd:pattern>
<xsd:length value="35" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="PackageTypeCode" default="BOX" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="3" />
<xsd:enumeration value="FLY" />
<xsd:enumeration value="COY" />
<xsd:enumeration value="NCY" />
<xsd:enumeration value="PAL" />
<xsd:enumeration value="DBL" />
<xsd:enumeration value="BOX" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="Height" minOccurs="0">
<xsd:annotation>
<xsd:documentation>required if width and depth are specified</xsd:documentation>
</xsd:annotation>
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="10"/>
<xsd:fractionDigits value="3"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="Depth" minOccurs="0">
<xsd:annotation>
<xsd:documentation>required if width and height are specified</xsd:documentation>
</xsd:annotation>
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="10"/>
<xsd:fractionDigits value="3"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="Width" minOccurs="0">
<xsd:annotation>
<xsd:documentation>required if height and depth are specified</xsd:documentation>
</xsd:annotation>
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="10"/>
<xsd:fractionDigits value="3"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="Weight" minOccurs="1" >
<xsd:simpleType>

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 24 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="15"/>
<xsd:fractionDigits value="3"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>

PieceType Element Definitions


The following table describes the data elements found in the PieceType schema:

Element Datatype/Format Req Definition Valid Values


Name
PieceID xsd:string O Piece sequence number. Note: only Integer values are
Required if piece details are supported in this field.
being provided.
PackageTypeCode xsd:string O Piece type Default value is 'BOX'

FLY=Flyer/Smalls - pieces that are


too small, thin or light to be sorted on
a standard conveyor, or for which it
makes sense to group pieces into
larger units for sort purposes.

COY=Parcels/Conveyables - pieces
that can be handled onto a system,
less than 31.5 kg and up to
60*60*120cm.

NCY=Non-conveyables - Pieces that


cannot on their own be sorted on
standard conveyor.

PAL=Pallets – large, irregular or


heavy pieces, Palletized with weight
upto 1000 KG.

DBL=Double Pallets – large,


irregular or heavy pieces, Palletized
with weight upto 1000 KG.

BOX=Parcels that are conveyable


have the shape of a box. Up to 70kg.
Height xsd:decimal O Piece height. Required if width Decimal(10,3)

and depth are specified


Depth xsd:decimal O Piece length or depth. Required Decimal(10,3)

if height and width are


specified.
Width xsd:decimal O Piece width. Required if height Decimal(10,3)

and depth are specified.


Weight xsd:decimal O Piece Weight. Required if piece Decimal(15,3)

details are being provided.

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 25 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

3.3.14.1.1 PieceID Element


The PieceID element contains the piece sequence number. Maximum length is 35 characters and
only the value must be an integer.

<xsd:element name="PieceID" minOccurs="1">


<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:pattern value="[0-9]+"></xsd:pattern>
<xsd:length value="35" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

3.3.14.1.2 PackageTypeCode Element


The PackageTypeCode element contains the piece packaging type. The default value is ‘BOX’.

<xsd:element name="PackageTypeCode" default="BOX" minOccurs="0">


<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="3" />
<xsd:enumeration value="FLY" />
<xsd:enumeration value="COY" />
<xsd:enumeration value="NCY" />
<xsd:enumeration value="PAL" />
<xsd:enumeration value="DBL" />
<xsd:enumeration value="BOX" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

3.3.14.1.3 Height Element


The Height element contains the height of the piece.

<xsd:element name="Height" minOccurs="0">


<xsd:annotation>
<xsd:documentation>required if width and depth are specified</xsd:documentation>
</xsd:annotation>
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="10"/>
<xsd:fractionDigits value="3"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

3.3.14.1.4 Depth Element


The Depth element contains the depth or length of the piece.

<xsd:element name="Depth" minOccurs="0">


<xsd:annotation>
<xsd:documentation>required if width and height are specified</xsd:documentation>
</xsd:annotation>
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="10"/>
<xsd:fractionDigits value="3"/>

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 26 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

</xsd:restriction>
</xsd:simpleType>
</xsd:element>

3.3.14.1.5 Width Element


The Width element contains the width or diameter of the piece.

<xsd:element name="Width" minOccurs="0">


<xsd:annotation>
<xsd:documentation>required if height and depth are specified</xsd:documentation>
</xsd:annotation>
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="10"/>
<xsd:fractionDigits value="3"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

3.3.14.1.6 Weight Element


The Weight element contains the weight of the piece.

<xsd:element name="Weight" minOccurs="1" >


<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="15"/>
<xsd:fractionDigits value="3"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

3.3.15 PaymentAccountNumber Element


The PaymentAccountNumber element contains the payer account number.

<xsd:element name="PaymentAccountNumber" minOccurs="0">


<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:maxLength value="12"></xsd:maxLength>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

3.3.16 IsDutiable Element


The IsDutiable element indicates whether the shipment is dutiable or not.

<xsd:element name="IsDutiable" minOccurs="0">


<xsd:simpleType>
<xsd:annotation>
<xsd:documentation>Y - Dutiable/Non-Doc, N -Non-dutiable/Doc</xsd:documentation>
</xsd:annotation>
<xsd:restriction base="xsd:string">
<xsd:length value="1" />
<xsd:enumeration value="Y" />
<xsd:enumeration value="N" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 27 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

3.3.17 NetworkTypeCode Element


The NetworkTypeCode element indicates the product belongs to the Day Definite (DD) or Time
Definite (TD) network.

Note: blank value or missing node will only return TD products from EU and both TD & DD
products from AP and AM countries.

<xsd:element name="NetworkTypeCode" minOccurs="0">


<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="2" />
<xsd:enumeration value="DD" />
<xsd:enumeration value="TD" />
<xsd:enumeration value="AL" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

3.3.18 QtdShp Element


The QtdShp element contains the details of the shipment.

<xsd:element name="QtdShp" minOccurs="0" maxOccurs="unbounded" type="QtdShpType" />

3.3.18.1 QtdShpType Element

<xsd:complexType name="QtdShpType">
<xsd:sequence>
<xsd:element name="GlobalProductCode" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:pattern value="[A-Z0-9]+"></xsd:pattern>
<xsd:minLength value="0"></xsd:minLength>
<xsd:maxLength value="6"></xsd:maxLength>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="LocalProductCode" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:minLength value="0"></xsd:minLength>
<xsd:maxLength value="6"></xsd:maxLength>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="QtdShpExChrg" minOccurs="0" maxOccurs="unbounded" type="QtdShpExChrgType">
</xsd:element>
</xsd:sequence>
</xsd:complexType>

QtdShpType Element Definitions

The following table describes the data elements found in the QtdShpType schema:

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 28 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

Element Datatype/Format Req Definition Valid Values


Name
GlobalProductCode xsd:string O Global Product Code A to Z and 0 to 9. Please refer to the
Reference Data and use appropriate
Global codes.
LocalProductCode xsd:string O Local Product Code Use appropriate Local codes enabled
for the country/region.

QtdShpExChrg QtdShpExChrgType O Request price or check


availability of available
Services.

3.3.18.1.1 GlobalProductCode Element

The GlobalProductCode element is the global product code for the shipment. The valid values are
A to Z and 0 to 9. Please refer to the Reference Data and use appropriate Global codes enabled for
the country/region.

<xsd:element name="GlobalProductCode" minOccurs="0">


<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:pattern value="[A-Z0-9]+"></xsd:pattern>
<xsd:minLength value="0"></xsd:minLength>
<xsd:maxLength value="6"></xsd:maxLength>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

3.3.18.1.2 LocalProductCode Element

The LocalProductCode element is the country/region billing product code for the shipment.

<xsd:element name="LocalProductCode" minOccurs="0">


<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:minLength value="0"></xsd:minLength>
<xsd:maxLength value="6"></xsd:maxLength>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

3.3.18.1.3 QtdShpExChrg Element

The QtdShpExChrg element contains the optional services information associate with the product
for the shipment.
Note: This is only applicable to GetQuote service.

<xsd:element name="QtdShpExChrg"
minOccurs="0" maxOccurs="unbounded" type="QtdShpExChrgType">
</xsd:element>

3.3.18.1.3.1 QtdShpExChrgType Element

<xsd:complexType name="QtdShpExChrgType">
<xsd:sequence>

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 29 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

<xsd:element name="SpecialServiceType" minOccurs="0">


<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:maxLength value="6"></xsd:maxLength>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="LocalSpecialServiceType" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:maxLength value="3"></xsd:maxLength>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>

QtdShpChrgType Element Definitions


The following table describes the data elements found in the QtdShpChrgType schema:

Element Name Datatype/Format Req Definition Valid Values


SpecialServiceType xsd:string O Global Charge Code for <= 6 characters
Use 'OSINFO' to get complete list
service of available Optional services
(XCH) and possible Surcharge
(SCH) and Fees (FEE).
LocalSpecialServiceType xsd:string O Local Charge Code for Charge codes mapping change by
country/region hence only use the
service charge codes as returned by
Capability service.

3.3.18.1.3.1.1 SpecialServiceType Element

The SpecialServiceType element is the global charge code of the service for the shipment.

Note: This is only applicable to GetQuote service.

<xsd:element name="SpecialServiceType" minOccurs="0">


<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:maxLength value="6"></xsd:maxLength>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

3.3.18.1.3.1.2 LocalSpecialServiceType Element

The LocalSpecialServiceType element is the local charge code of the service for the shipment.
Charge codes mapping change by country/region hence only use the charge codes as returned by
Capability service.

Note: This is only applicable to GetQuote service.


<xsd:element name="LocalSpecialServiceType" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 30 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

<xsd:maxLength value="3"></xsd:maxLength>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

3.3.19 InsuredValue Element


The InsuredValue element contains the Insurance amount.

Note: This is only applicable to GetQuote service.

<xsd:element name="InsuredValue" minOccurs="0">


<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="18"/>
<xsd:fractionDigits value="3"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

3.3.20 InsuredCurrency Element


The InsuredCurrency element contains the currency code of Insurance amount. Please refer to the
Reference Data (DHL Country/Region) for currency codes.

Note: This is only applicable to GetQuote service.

<xsd:element name="InsuredCurrency" minOccurs="0">


<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="3"></xsd:length>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

3.3.21 PaymentType Element


The PaymentType element contains the type of payment used for the shipment. It is an optional
field. Payment type is only by DHL Account.

<xsd:element name="PaymentType" minOccurs="0">


<xsd:annotation>
<xsd:documentation>Payment type - by method of payment ( DHL account)</xsd:documentation>
</xsd:annotation>
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="D" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

3.3.22 AcctPickupCloseTime Element


The AcctPickupCloseTime element contains the accounts pickup close time. Accounts pickup close
time to be retrieved from GCDB or specified by customer. It is an optional field.

<xsd:element name="AcctPickupCloseTime" minOccurs="0">


<xsd:annotation>
<xsd:documentation>Account's Pickup Close Time to be retrieved from GCDB or specified by customer

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 31 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

</xsd:documentation>
</xsd:annotation>
<xsd:simpleType>
<xsd:restriction base="xsd:dateTime"/>
</xsd:simpleType>
</xsd:element>

3.4 To Element
To element is used to identify the destination address of the shipment.

<xsd:element name="To" minOccurs="1" type="dct:DCTTo" />

3.4.1 DCTTo Element

<xsd:complexType name="DCTTo">
<xsd:sequence>
<xsd:element name="CountryCode" minOccurs="1">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="2" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="Postalcode" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:maxLength value="12" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="City" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:maxLength value="45" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="Suburb" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:maxLength value="45" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>

DCTTo Element Definitions


The following table describes the data elements found in the DCTTo schema:

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 32 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

Element Datatype/Format Req Definition Valid Values


Name
CountryCode xsd:string M Destination Country/Region Please refer to the Reference Data
Code (DHL Country/Region).
Postalcode xsd:string O/M Destination Postal code <= 12 characters. Required for
countries with postcodes and in
correct format. Please refer to the
Reference Data (DHL
Country/Region – Postcode format).
City xsd:string C Destination city <= 45 characters. City is required for
some countries, please check
Reference Data. City name will
provide more accurate information
for larger postcodes with multiple
cities.
Suburb xsd:string O Destination suburb <= 45 characters. Required for
countries where DHL has suburb
level capability variation. Please refer
to the Reference Data (DHL
Country/Region).

3.4.1.1 CountryCode Element


The CountryCode element contains the country/region code of the destination address.

<xsd:element name="CountryCode" minOccurs="1">


<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="2" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

3.4.1.2 Postalcode Element


The Postalcode element contains the postal code of the destination address. It is required for
countries with postcodes and in correct format. Please refer to the Reference Data (DHL
Country/Region – Postcode format).
<xsd:element name="Postalcode" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:maxLength value="12" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

3.4.1.3 City Element


The City element contains the city of the destination address.

<xsd:element name="City" minOccurs="0">


<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:maxLength value="45" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 33 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

Note: Using a CDATA definition is recommended for contents of this element.


It is allowed to use without CDATA definition for extended characters and request XML
must be saved in UTF-8 format. This field support Cyrillic characters.

3.4.1.4 Suburb Element


The Suburb element contains the suburb of the destination address.
<xsd:element name="Suburb" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:maxLength value="45" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

Note: Using a CDATA definition is recommended for contents of this element.


It is allowed to use without CDATA definition for extended characters and request XML
must be saved in UTF-8 format. This field support Cyrillic characters.

3.5 Dutiable Element


For non-domestic shipments, The Dutiable element provides informations which defines the
types of duties to be levied.
<xsd:element name="Dutiable" minOccurs="0" type="dct:DCTDutiable"

3.5.1 DCTDutiable Element


<xsd:complexType name="DCTDutiable">
<xsd:sequence>
<xsd:element name="DeclaredCurrency" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="3" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="DeclaredValue" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:float">
<xsd:minInclusive value="0.000" />
<xsd:maxInclusive value="999999999999999999.999" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>

DCTDutiable Element Definitions


The following table describes the data elements found in the DCTDutiable schema:

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 34 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

Element Datatype/Format Req Definition Valid Values


Name
DeclaredCurrency xsd:string O DHL currency code (Required if Please refer to the Reference
Data (DHL Country/Region).
declared value is given.)
DeclaredValue xsd:float O Declared value. It is required for non-
doc or dutiable products. Please refer
to Reference Data (Global Product
Codes).

3.5.1.1 DeclaredCurrency Element


The DeclaredCurrency element contains the DHL currency code in which declared value
should be levied.This field is required if Declared value is given. Please refer to the
Reference Data (DHL Country/Region) for Currency Code.

<xsd:element name="DeclaredCurrency" minOccurs="0">


<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="3" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

3.5.1.2 DeclaredValue Element


The DeclaredValue element contains the shipment’s monetary value. It is required for non-doc or
dutiable products. Please refer to Reference Data (Global Product Codes).
<xsd:element name="DeclaredValue" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:float">
<xsd:minInclusive value="0.000" />
<xsd:maxInclusive value="999999999999999999.999" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

3.6 Generic Request Element


<xsd:element name="GenReq" minOccurs="0" type="dct:GenReq" />

3.6.1 GenReq Element


<xsd:complexType name="GenReq">
<xsd:sequence>
<xsd:element name="OSINFO" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="1" />
<xsd:enumeration value="Y" />
<xsd:enumeration value="N" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="NXTPU" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 35 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

<xsd:length value="1" />


<xsd:enumeration value="Y" />
<xsd:enumeration value="N" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="FCNTWTYCD" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="2" />
<xsd:enumeration value="DD" />
<xsd:enumeration value="TD" />
<xsd:enumeration value="AL" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="CUSTAGRIND" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="1" />
<xsd:enumeration value="Y" />
<xsd:enumeration value="N" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="VLDTRT_DD" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="1" />
<xsd:enumeration value="Y" />
<xsd:enumeration value="N" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>

GenReq Element Definitions


The following table describes the data elements found in the GenReq schema:
Element Datatype/Format Req Definition Valid Values
Name
OSINFO xsd:string O It finds all valid product and service Y: Yes
combinations. N: No
NXTPU xsd:string O If pickup isn’t possible on requested pickup Y: Yes
day. It finds next possible pickup. N: No
FCNTWTYCD xsd:string O It specifies the facility network code. DD
TD
AL
CUSTAGRIND xsd:string O Specifies customer agreement indicator for Y: Yes
product and services. N: No
VLDTRT_DD xsd:string O Specifies whether the validation is required on Y: Yes
ready time against the pickup window start time N: No
on DDI product

3.6.1.1 OSINFO Element

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 36 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

The OSINFO element finds all valid product and service combinations. If not provided the default
value is N.
<xsd:element name="OSINFO" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="1" />
<xsd:enumeration value="Y" />
<xsd:enumeration value="N" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

3.6.1.2 NXTPU Element

The NXTPU element finds the next pickup day if pickup isn’t possible on requested pickup day. If
not provided the default value is N.
<xsd:element name="NXTPU" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="1" />
<xsd:enumeration value="Y" />
<xsd:enumeration value="N" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

3.6.1.2 FCNTWTYCD Element

The FCNTWTYCD element specifies the facility network code. If not provided the default value is
AL.
<xsd:element name="FCNTWTYCD" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="2" />
<xsd:enumeration value="DD" />
<xsd:enumeration value="TD" />
<xsd:enumeration value="AL" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

3.6.1.2 CUSTAGRIND Element

The CUSTAGRIND element specifies customer agreement indicator for product and services.
If not provided, DCT will not validate product or service' customer agreement indicator.
<xsd:element name="CUSTAGRIND" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="1" />
<xsd:enumeration value="Y" />
<xsd:enumeration value="N" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 37 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

3.6.1.2 VLDTRT_DD Element

The VLDTRT_DD element specifies whether the validation is required on ready time against the
pickup window start time for DDI product. If not provided, DCT will validate the ready time
against pickup window start time (VLDTRT_DD='Y').
<xsd:element name="VLDTRT_DD" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="1" />
<xsd:enumeration value="Y" />
<xsd:enumeration value="N" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 38 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

4 Capability and Quote service Response Schema

Following is the schema of Capability response. All successful Capability and Quote
service response confirm to the following schema file.

Global Schema v2.0:

<?xml version="1.0"?>
<xsd:schema targetNamespace="http://www.dhl.com" xmlns:dhl="http://www.dhl.com/datatypes"
xmlns:dct="http://www.dhl.com/DCTResponsedatatypes" xmlns="http://www.dhl.com"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" elementFormDefault="unqualified">
<xsd:import namespace="http://www.dhl.com/datatypes_global" schemaLocation="datatypes_global.xsd" />
<xsd:import namespace="http://www.dhl.com/DCTResponsedatatypes" schemaLocation=" DCTResponsedatatypes_global-2.0.xsd" />
<xsd:element name="DCTResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:choice minOccurs="1" maxOccurs="1">
<xsd:element name="GetQuoteResponse">
<xsd:annotation>
<xsd:documentation>Root element of shipment validation request
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="Response">
<xsd:complexType>
<xsd:annotation>
<xsd:documentation>Generic response header</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="ServiceHeader" type="ServiceHeader" />
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="BkgDetails" minOccurs="0" type="dct:BkgDetailsType" maxOccurs="1" />
<xsd:element name="Srvs" minOccurs="0" maxOccurs="1">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="Srv" type="dct:SrvType" minOccurs="0" maxOccurs="unbounded">
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="Note" minOccurs="0" type="dct:NoteType" maxOccurs="1" />
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="GetCapabilityResponse">
<xsd:annotation>
<xsd:documentation>Root element of shipment validation request</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="Response">
<xsd:complexType>
<xsd:annotation>
<xsd:documentation>Generic response header</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="ServiceHeader" type="ServiceHeader" />
</xsd:sequence>

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 39 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

</xsd:complexType>
</xsd:element>
<xsd:element name="BkgDetails" minOccurs="0" type="dct:BkgDetailsType" maxOccurs="1" />
<xsd:element name="Srvs" minOccurs="0" maxOccurs="1">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="Srv" type="dct:SrvType" minOccurs="0" maxOccurs="unbounded">
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="Note" minOccurs="0" type="dct:NoteType" maxOccurs="1" />
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:choice>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:complexType name="ServiceHeader">
<xsd:annotation>
<xsd:documentation>Standard routing header</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="MessageTime" type="xsd:dateTime" minOccurs="0">
<xsd:annotation>
<xsd:documentation>Time this message is sent</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="MessageReference" type="xsd:string" minOccurs="0">
<xsd:annotation>
<xsd:documentation>A string, peferably number, to uniquely identify individual messages. Minimum length must be 28 and
maximum length is 32</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="SiteID" type="xsd:string" />
</xsd:sequence>
</xsd:complexType>
</xsd:schema>

Capability and Quote service Response Data Element Definitions


The Capability and Quote service Response schema contains the following elements:

Element Name Datatype/Format Req Definition Valid Values


DCTResponse xsd:complexType M Identifies the capability or quote response type
GetQuoteResponse xsd:complexType M Response type of GetQuote to retrieve the
capabilities and price information based on the
list of products.
GetCapabilityResponse xsd:complexType M Response type of GetCapability to retrieve the
capabilities information based on the list of
products.
ServiceHeader xsd:complexType M Service header element

GetQuote and GetCapability Response Data Element


The following table describes the data elements found in the GetQuote and GetCapability response schema:

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 40 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

Element Datatype/Format Req Definition Valid Values


Name
Response xsd:complexType M Identifies the message as a
response message
BkgDetails dct:BkgDetailsType O Details of the shipment. Note
that multiple booking details
can be returned if the origin or
destination is serviced by
multiple facility or service area.
Srvs dct:SrvType O Description of the found
products.
Note dct:NoteType O Messages and error codes of
the response message.

4.1 Response Element


The element contains the header information for the message. It is present in both
the request and response XML message. The request element contains a complex
datatype ServiceHeader.
<xsd:element name="Response">
<xsd:complexType>
<xsd:annotation>
<xsd:documentation>Generic response header</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="ServiceHeader" type="ServiceHeader"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>

4.1.1 ServiceHeader Element


The Service Header element contains the header information about the response
message. This element must be declared only once in the Response element.
<xsd:complexType name="ServiceHeader">
<xsd:annotation>
<xsd:documentation>Standard routing header</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="MessageTime" type="xsd:dateTime" minOccurs="0">
<xsd:annotation>
<xsd:documentation>Time this message is sent</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="MessageReference" type="xsd:string" minOccurs="0">
<xsd:annotation>
<xsd:documentation>A string, peferably number, to uniquely identify individual messages. Minimum
length must be 28 and maximum length is 32</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="SiteID" type="xsd:string"/>
</xsd:sequence>

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 41 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

</xsd:complexType>

ServiceHeader Element Definitions


The following table describes the data elements found in the ServiceHeader schema:

Element Name Datatype/Format Req Definition Valid Values


MessageTime xsd:dateTime O Identifies the message time.
MessageReference xsd:string O Message reference number.
SiteID xsd:string M Identifies the sender of the response
message.

4.1.1.1 MessageTime Element


The Message Time element contains the time at which the message was send by the
requestor. The format of the should be YYYY-MM-DD(T)hh-mm-ss-Time Zone
where “T” is the separator between date and time.
e.g. 2002-12-02T13:23:18-07:00
<xsd:element name="MessageTime" type="xsd:dateTime"
minOccurs="0"> <xsd:annotation>
<xsd:documentation>Time this message is
sent</xsd:documentation> </xsd:annotation>
</xsd:element>

4.1.1.2 Message Reference Element


The Message Reference element contains the unique reference to the message, so that
trace of a particular message can be done easily. It must be of minimum length of 28
and maximum 32.

<xsd:element name="MessageReference" type="MessageReference" minOccurs="0">


<xsd:annotation>
<xsd:documentation>A string, peferably number, to uniquely identify individual messages.
Minimum length must be 28 and maximum length is 32
</xsd:documentation>
</xsd:annotation>
</xsd:element>

4.1.1.3 SiteID Element


The site id element is used to identify the requestor of the message. Each partner/customer
is provided with the site id and password.

<xsd:simpleType name="SiteID">
<xsd:annotation>
<xsd:documentation>Site ID used for verifying the sender</xsd:documentation>
</xsd:annotation>
<xsd:restriction base="xsd:string">
<xsd:minLength value="6"/>
<xsd:maxLength value="12"/>
</xsd:restriction>
</xsd:simpleType>

4.2 BkgDetails Element


BkgDetails element is used to identify the shipment related information.

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 42 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

<xsd:element name="BkgDetails" minOccurs="0" type="dct:BkgDetailsType" maxOccurs="1"/>

<xsd:complexType name="BkgDetailsType">
<xsd:sequence>
<xsd:element name="QtdShp" minOccurs="0" maxOccurs="unbounded" type="QtdShpType" />
</xsd:sequence>
</xsd:complexType>

BkgDetailsType Element Definitions


The following table describes the data elements found in the BkgDetailsType schema:

Element Name Datatype/Format Req Definition Valid Values


QtdShp QtdShpType O Capabilities or/and price related
response available for a given list of
products

4.2.1 QtdShp Element


The QtdShp element is a complex type of element which contains the child elements for
capabilities or/and price related details in response available for the given list of products.

<xsd:element name="QtdShp" minOccurs="0" maxOccurs="unbounded" type="QtdShpType" />

<xsd:complexType name="QtdShpType">
<xsd:sequence>
<xsd:element name="OriginServiceArea" minOccurs="1" maxOccurs="1" type="OrgnSvcAreaType" />
<xsd:element name="DestinationServiceArea" minOccurs="1" maxOccurs="1" type="DestSvcAreaType" />
<xsd:element name="GlobalProductCode" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:maxLength value="6"></xsd:maxLength>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="LocalProductCode" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:maxLength value="3"></xsd:maxLength>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="ProductShortName" type="xsd:string" minOccurs="0" maxOccurs="1">
</xsd:element>
<xsd:element name="LocalProductName" type="xsd:string" minOccurs="0" maxOccurs="1">
</xsd:element>
<xsd:element name="NetworkTypeCode" type="xsd:string" minOccurs="0" maxOccurs="1">
</xsd:element>
<xsd:element name="POfferedCustAgreement" type="xsd:string" minOccurs="0" maxOccurs="1">
</xsd:element>
<xsd:element name="TransInd" type="xsd:string" minOccurs="0" maxOccurs="1"></xsd:element>
<xsd:element name="PickupDate" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:date" />
</xsd:simpleType>
</xsd:element>
<xsd:element name="PickupCutoffTime" type="xsd:string" minOccurs="0" maxOccurs="1"></xsd:element>
<xsd:element name="BookingTime" minOccurs="0">
<xsd:simpleType>
<xsd:annotation>
<xsd:documentation>Booking Time
</xsd:documentation>
</xsd:annotation>
<xsd:restriction base="xsd:duration" />

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 43 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

</xsd:simpleType>
</xsd:element>
<xsd:element name="CurrencyCode" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="3" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="ExchangeRate" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="18" />
<xsd:fractionDigits value="6" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="WeightCharge" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="18" />
<xsd:fractionDigits value="3" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="WeightChargeTax" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="18" />
<xsd:fractionDigits value="3" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="weightChargeTaxRate" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="6" />
<xsd:fractionDigits value="3" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="TotalTransitDays" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:int"></xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="PickupPostalLocAddDays" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:int"></xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="DeliveryPostalLocAddDays" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:int"></xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="DeliveryDate" minOccurs="0" maxOccurs="unbounded" type="DeliveryDate" />
<xsd:element name="DeliveryTime" minOccurs="0">
<xsd:simpleType>
<xsd:annotation>
<xsd:documentation>Delivery Time
</xsd:documentation>
</xsd:annotation>
<xsd:restriction base="xsd:duration" />
</xsd:simpleType>
</xsd:element>
<xsd:element name="DeliveryTimeGMTOffset" minOccurs="0">
<xsd:simpleType>
<xsd:annotation>
<xsd:documentation>Delivery Time GMT Offset
</xsd:documentation>
</xsd:annotation>
<xsd:restriction base="xsd:string">
<xsd:maxLength value="6" />
</xsd:restriction>

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 44 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

</xsd:simpleType>
</xsd:element>
<xsd:element name="DimensionalWeight" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="15" />
<xsd:fractionDigits value="3" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="WeightUnit" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:maxLength value="3"></xsd:maxLength>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="PickupDayOfWeekNum" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="1" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="DestinationDayOfWeekNum" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="1" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="QuotedWeight" type="QuotedWeight" minOccurs="0" />
<xsd:element name="QuotedWeightUOM" type="QuotedWeightUOM" minOccurs="0" />
<xsd:element name="QtdShpExChrg" minOccurs="0" type="QtdShpExChrgType" maxOccurs="unbounded" />
<xsd:element name="PricingDate" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:date" />
</xsd:simpleType>
</xsd:element>
<xsd:element name="ShippingCharge" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="18" />
<xsd:fractionDigits value="3" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="TotalTaxAmount" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="18" />
<xsd:fractionDigits value="3" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="TotalDiscount" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="18" />
<xsd:fractionDigits value="3" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="QtdSInAdCur" minOccurs="0" type="QtdSInAdCurType" maxOccurs="unbounded" />
<xsd:element name="WeightChargeTaxDet" minOccurs="0" type="WeightChargeTaxDetType"
maxOccurs="unbounded" />
<xsd:element name="PickupWindowEarliestTime" minOccurs="1">
<xsd:simpleType>
<xsd:annotation>
<xsd:documentation>Pickup window start time</xsd:documentation>
</xsd:annotation>
<xsd:restriction base="xsd:string" />
</xsd:simpleType>
</xsd:element>
<xsd:element name="PickupWindowLatestTime" minOccurs="1">

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 45 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

<xsd:simpleType>
<xsd:annotation>
<xsd:documentation>Pickup window end time</xsd:documentation>
</xsd:annotation>
<xsd:restriction base="xsd:string" />
</xsd:simpleType>
</xsd:element>
<xsd:element name="BookingCutoffOffset" minOccurs="1">
<xsd:simpleType>
<xsd:annotation>
<xsd:documentation>Booking cut off time offset</xsd:documentation>
</xsd:annotation>
<xsd:restriction base="xsd:string" />
</xsd:simpleType>
</xsd:element>
<xsd:element name="PickupLeadTime" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="1" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="PickupCloseTime" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="1" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="WeightChargeDisc" minOccurs="0" type="WeightChargeDisc" maxOccurs="unbounded" />
<xsd:element name="QtdShpExChrgDisc" minOccurs="0" type="QtdShpExChrgDisc" maxOccurs="unbounded" />
</xsd:sequence>
</xsd:complexType>

QtdShpType Element Definitions


The following table describes the data elements found in the QtdShpType schema:

Element Name Datatype/Format Req Definition Valid Values


OriginServiceArea OrgnSvcAreaType M Origin address details OriginServiceArea
DestSvcAreaType M Destination address details DestinationServiceArea
DestinationServiceAr
ea
GlobalProductCode xsd:string O Global product code <= 6 characters.
LocalProductCode xsd:string O Local product code <=3 characters
Global product name. It’s recommended
to display Global name instead of Local
ProductShortName xsd:string O name.
LocalProductName xsd:string O Local product name.
DD=Day Definite
NetworkTypeCode xsd:string O Network type code TD=Time Definite
POfferedCustAgree xsd:string O Indicates that the product only can be 1 character
ment offered to customers with prior
agreement.
Y – Show products to all
Web User Interface indicator. If users (incl. cash, credit card)
TransInd xsd:string O value=Y, show on website open for all N – Only show products to
users users with DHL account
PickupDate xsd:date O Pick up date
Pick up cut off time before which courier
PickupCutoffTime xsd:duration O will pick-up the shipment

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 46 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

Element Name Datatype/Format Req Definition Valid Values


Booking cut off time before which pick-
BookingTime xsd:duration O up booking request must be completed.
CurrencyCode xsd:string O Currency code in which price is returned

ExchangeRate xsd:decimal O The exchange rate between EUR and


Charge Currency Code Decimal(18,6)
WeightCharge xsd:decimal O Weight price including Tax Decimal(18,3)
WeightChargeTax xsd:decimal O Tax for weight quote Decimal (18,3)
weightChargeTaxRa xsd:decimal O Tax rate for weight charge Decimal(6,3)
te
TotalTransitDays xsd:int O Number of total transit days
In-forwarding days – this is the
PickupPostalLocAd xsd:int O additional transit delays (in days) for
dDays shipments picked up from this city/postal
area to arrival at the DHL Service Area
On-forwarding days – this is the
DeliveryPostalLocA xsd:int O additional transit delay (in days) for
ddDays shipments delivered to this city/postal
area following arrival at the DHL
Service Area
DeliveryDate xsd:date O Estimated Delivery date
DeliveryTime xsd:duration O Committed delivery by time (actual Interval hour to minute
delivery can occur before this time)
Delivery time GMT Offset. This attribute
DeliveryTimeGMT is not used and times is local time at <= 6 chars
Offset xsd:string O destination. Eg. “-09:30”
DimensionalWeight xsd:decimal O Volumetric weight Decimal(15,3)
WeightUnit xsd:string O Volumetric weight unit of measurement <= 3 chars
PickupDayOfWeek xsd:string O Pickup day of the week number
1 character
Num
0=Sunday
1=Monday
2=Tuesday
3=Wednesday
4=Thursday
5=Friday
6=Saturday
7=Holiday
DestinationDayOfW xsd:string O Destination day of the week number
1 character
eekNum
0=Sunday
1=Monday
2=Tuesday
3=Wednesday
4=Thursday
5=Friday
6=Saturday
7=Holiday

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 47 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

Element Name Datatype/Format Req Definition Valid Values


QuotedWeight QuotedWeight O Quoted weight
QuotedWeightUOM QuotedWeightUOM O Quoted weight unit of measurement
QtdShpExChrg QtdShpExChrgType O Optional services information
PricingDate xsd:date O Pricing or Current date
ShippingCharge xsd:decimal O Total quote with tax (weight and all Decimal(18,3)
applicable charges)
TotalTaxAmount xsd:decimal O Total tax (weight and all applicable Decimal(18,3)
charges)
TotalDiscount xsd:decimal O Total discount Decimal(18,3)
WeightChargeTaxD WeightChargeTaxDetType O Weight Charge Tax breakdown pricing
et details

QtdSInAdCur QtdSInAdCurType O Optional Services Information


PickupWindowEarli
estTime xsd:string M The Pickup window earliest time
PickupWindowLates
tTime xsd:string M The Pickup wondow latest time
BookingCutoffOffse
t xsd:string M Booking cutoff offset
PickupLeadTime xsd:string O Pickup lead time
PickupCloseTime xsd:string O Pickup closing time
WeightChargeDisc WeightChargeDisc O Weight charge discount
QtdShpExChrgDisc QtdShpExChrgDisc O Extra charges discount

4.2.3.1 OriginServiceArea Element


The OriginServiceArea element is a complex type of element which contains the child
elements for origin service area and facility code details.

<xsd:element name="OriginServiceArea" minOccurs="1" maxOccurs="1" type="OrgnSvcAreaType" />


<xsd:complexType name="OrgnSvcAreaType">
<xsd:sequence>
<xsd:element name="FacilityCode" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="3" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="ServiceAreaCode" minOccurs="1">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="3" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
</xsd:sequence>

OrgnSvcAreaType Element Definitions


The following table describes the data elements found in the OrgnSvcAreaType schema:

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 48 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

Element Name Datatype/Format Req Definition Valid Values


FacilityCode xsd:string O Origin Facility Code
ServiceAreaCode xsd:string M Origin Service Area code

4.2.3.1.1 FacilityCode Element


The FacilityCode element is the origin facility code of the shipment.
<xsd:element name="FacilityCode" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="3" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.2.3.1.2 ServiceAreaCode Element


The ServiceAreaCode element is the origin service area code of the shipment.
<xsd:element name="ServiceAreaCode" minOccurs="1">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="3" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.2.3.2 DestinationServiceArea Element


The DestinationServiceArea element is a complex type of element which contains the
child elements for destination service area and facility code details.

<xsd:element name="DestinationServiceArea" minOccurs="1" maxOccurs="1" type="DestSvcAreaType" />


<xsd:complexType name="DestSvcAreaType">
<xsd:sequence>
<xsd:element name="FacilityCode" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="3" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="ServiceAreaCode" minOccurs="1">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="3" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>

DestSvcAreaType Element Definitions


The following table describes the data elements found in the DestSvcAreaType schema:

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 49 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

Element Name Datatype/Format Req Definition Valid Values


FacilityCode xsd:string O Destination Facility Code
ServiceAreaCode xsd:string M Destination Service Area code

4.2.3.1.1 FacilityCode Element


The FacilityCode element is the origin facility code of the shipment.
<xsd:element name="FacilityCode" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="3" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.2.3.1.2 ServiceAreaCode Element


The ServiceAreaCode element is the origin service area code of the shipment.
<xsd:element name="ServiceAreaCode" minOccurs="1">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="3" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.2.3.3 GlobalProductCode Element


The GlobalProductCode element is the global product code of the shipment. Please refer to the
Reference Data and use appropriate Global codes enabled for the country/region.
<xsd:element name="GlobalProductCode" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:maxLength value="6"></xsd:maxLength>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.2.3.4 LocalProductCode Element


The LocalProductCode element is the local product code of the shipment.
<xsd:element name="LocalProductCode" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:maxLength value="3"></xsd:maxLength>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.2.3.5 ProductShortName Element


The ProductShortName element is the global product name of the shipment.
<xsd:element name="ProductShortName" type="xsd:string" minOccurs="0" maxOccurs="1">
</xsd:element>

4.2.3.6 LocalProductName Element


The LocalProductName element is the local product name of the shipment.

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 50 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

<xsd:element name="LocalProductName" type="xsd:string" minOccurs="0" maxOccurs="1">


</xsd:element>

4.2.3.7 NetworkTypeCode Element


The NetworkTypeCode element is the network type of the product in the shipment.
<xsd:element name="NetworkTypeCode" type="xsd:string" minOccurs="0" maxOccurs="1">
</xsd:element>

4.2.3.8 POfferedCustAgreement Element


The POfferedCustAgreement element indicates that the product or service or solution only can be
offered to a customer agreement that are not default to a billing entity.
<xsd:element name="POfferedCustAgreement" type="xsd:string" minOccurs="0" maxOccurs="1">
</xsd:element>

4.2.3.9 TransInd Element


The TransInd element indicates the web user interface indicator. If value of Y, it is show on the
Web user interface.
<xsd:element name="TransInd" type="xsd:string" minOccurs="0" maxOccurs="1"></xsd:element>

4.2.3.10 PickupDate Element


The PickupDate element is the pick up date.
<xsd:element name="PickupDate" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:date" />
</xsd:simpleType>
</xsd:element>

4.2.3.11 PickupCutoffTime Element


The PickupCutoffTime element is the pick up cut off time.
<xsd:element name="PickupCutoffTime" minOccurs="0">
<xsd:simpleType>
<xsd:annotation>
<xsd:documentation>Pickup Cut off Time</xsd:documentation>
</xsd:annotation>
<xsd:restriction base="xsd:duration"/>
</xsd:simpleType>
</xsd:element>

4.2.3.12 BookingTime Element


The BookingTime element is the booking cut off time.
<xsd:element name="BookingTime" minOccurs="0">
<xsd:simpleType>
<xsd:annotation>
<xsd:documentation>Booking Time</xsd:documentation>
</xsd:annotation>
<xsd:restriction base="xsd:duration"/>
</xsd:simpleType>
</xsd:element>

4.2.3.13 CurrencyCode Element


The CurrencyCode element is the currency code in which the price is returned. Please refer to the
Reference Data (DHL Country/Region) for currency code.
Note: This is only applicable to GetQuote service.
<xsd:element name="CurrencyCode" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 51 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

<xsd:length value="3" />


</xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.2.3.14 ExchangeRate Element


The ExchangeRate element is the exchange rate between EUR and charge currency code.
Note: This is only applicable to GetQuote service.
<xsd:element name="ExchangeRate" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="18"/>
<xsd:fractionDigits value="6"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.2.3.15 WeightCharge Element


The WeightCharge element is the weight price including tax.
Note: This is only applicable to GetQuote service.
<xsd:element name="WeightCharge" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="18"/>
<xsd:fractionDigits value="3"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.2.3.16 WeightChargeTax Element


The WeightChargeTax element is the tax for weight quote.
Note: This is only applicable to GetQuote service.
<xsd:element name="WeightChargeTax" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="18"/>
<xsd:fractionDigits value="3"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.2.3.17 TotalTransitDays Element


The TotalTransitDays element is the number of transit days.
<xsd:element name="TotalTransitDays" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:int"></xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.2.3.18 PickupPostalLocAddDays Element

The PickupPostalLocAddDays element is the in-forwarding days. This is additional transit delays
(in days) for shipment picked up from the mentioned city or postal area to arrival at the service area.
<xsd:element name="PickupPostalLocAddDays" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:int"></xsd:restriction>
</xsd:simpleType>
</xsd:element>

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 52 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

4.2.3.19 DeliveryPostalLocAddDays Element

The DeliveryPostalLocAddDays element is the on-forwarding days. This is additional transit delays
(in days) for shipment delivered to the mentioned city or postal area following arrival at the service
area.
<xsd:element name="DeliveryPostalLocAddDays" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:int"></xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.2.3.20 DeliveryDate Element


The DeliveryDate element is the date the shipment is delivered.
<xsd:complexType name="DeliveryDate">
<xsd:sequence>
<xsd:element name="DeliveryType" type="xsd:string" minOccurs="0" maxOccurs="1" />
<xsd:element name="DlvyDateTime" type="xsd:string" minOccurs="0" maxOccurs="1" />
<xsd:element name="DeliveryDateTimeOffset" type="xsd:string" minOccurs="0" maxOccurs="1" />
</xsd:sequence>
</xsd:complexType>

4.2.3.20.1 DeliveryType Element

The DeliveryType element defines the type of Delivery.


<xsd:element name="DeliveryType" type="xsd:string" minOccurs="0" maxOccurs="1" />

4.2.3.20.2 DlvyDateTime Element


The DlvyDateTime element is the delivery date and time.
<xsd:element name="DlvyDateTime" type="xsd:string" minOccurs="0" maxOccurs="1" />

4.2.3.20.3 DeliveryTimeGMTOffset Element


The DeliveryTimeGMTOffset element is the GMT offset of the delivery time.
<xsd:element name="DeliveryTimeGMTOffset" minOccurs="0">
<xsd:simpleType>
<xsd:annotation>
<xsd:documentation>Delivery Time GMT Offset</xsd:documentation>
</xsd:annotation>
<xsd:restriction base="xsd:string">
<xsd:maxLength value="6" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.2.3.21 DeliveryTime Element


The DeliveryTime element is the commited delivery by time (actual delivery can occur before this
time).
<xsd:element name="DeliveryTime" minOccurs="1">
<xsd:simpleType>
<xsd:annotation>
<xsd:documentation>Delivery Time</xsd:documentation>
</xsd:annotation>
<xsd:restriction base="xsd:duration"/>
</xsd:simpleType>
</xsd:element>

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 53 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

4.2.3.22 DimensionalWeight Element


The DimensionalWeight element is the volumetric weight of the shipment.
<xsd:element name="DimensionalWeight" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="15"/>
<xsd:fractionDigits value="3"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

NOTE:
For XML Services – DCT Capability and Quote existing global schema prior v1.0:
For scenario when no estimated tariff returned from pricing engine, the volumetric weight is populated with the highest value
by comparing both Declared Weight and Volumentric Weight value.

4.2.3.23 WeightUnit Element

The WeightUnit element is the volumetric weight unit of measurement of the shipment.
<xsd:element name="WeightUnit" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:maxLength value="3"></xsd:maxLength>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.2.3.24 PickupDayOfWeekNum Element


The PickupDayOfWeekNum element is the pickup day in week number.
<xsd:element name="PickupDayOfWeekNum" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="1" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.2.3.25 DestinationDayOfWeekNum Element


The DestinationDayOfWeekNum element is the destination day in week number.
<xsd:element name="DestinationDayOfWeekNum" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="1" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.2.3.26 QuotedWeight Element


The QuotedWeight element is the quoted weight of the shipment.
<xsd:simpleType name="QuotedWeight">
<xsd:annotation>
<xsd:documentation>Weight of piece or shipment</xsd:documentation>
</xsd:annotation>
<xsd:restriction base="xsd:decimal">
<xsd:fractionDigits value="3" />
<xsd:minInclusive value="0.000" />
<xsd:maxInclusive value="999999.999" />
<xsd:totalDigits value="10" />
</xsd:restriction>

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 54 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

</xsd:simpleType>

4.2.3.27 QuotedWeightUOM Element

The QuotedWeightUOM element is the quoted weight unit of measurement of the shipment.
<xsd:simpleType name="QuotedWeightUOM">
<xsd:annotation>
<xsd:documentation>WeightUOM</xsd:documentation>
</xsd:annotation>
<xsd:restriction base="xsd:string">
<xsd:minLength value="1" />
<xsd:maxLength value="3" />
<xsd:enumeration value="KG" />
<xsd:enumeration value="LB" />
</xsd:restriction>
</xsd:simpleType>

4.2.3.28 QtdShpExChrg Element


The QtdShpExChrg element contains the optional services information for the shipment.
NOTE:
For XML Services – DCT Capability and Quote new global schema v1.0:
For scenario when no estimated tariff returned from pricing engine, the automatic surcharges such as YI (9:00 Premium),
YJ (10:30 Premium) or YK (12:00 Premium) which relates to the specific product will not be returned in DCT Capability
and Quote response as it is not available.

<xsd:element name="QtdShpExChrg" minOccurs="0" type="QtdShpExChrgType" maxOccurs="unbounded"/>

<xsd:complexType name="QtdShpExChrgType">
<xsd:sequence>
<xsd:element name="SpecialServiceType" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:maxLength value="6"></xsd:maxLength>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="LocalServiceType " minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:maxLength value="3"></xsd:maxLength>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="GlobalServiceName" type="xsd:string" minOccurs="0" maxOccurs="1">
</xsd:element>
<xsd:element name="LocalServiceTypeName" type="xsd:string" minOccurs="0"
maxOccurs="1"></xsd:element>
<xsd:element name="SOfferedCustAgreement" type="xsd:string" minOccurs="0" maxOccurs="1"/>
<xsd:element name="ChargeCodeType" type="xsd:string" minOccurs="0"></xsd:element>
<xsd:element name="InsPrmRateInPercentage" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="8"/>
<xsd:fractionDigits value="4"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="CurrencyCode" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="3" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="ChargeValue" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 55 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

<xsd:totalDigits value="18"/>
<xsd:fractionDigits value="3"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="ChargeTaxAmount" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="18"/>
<xsd:fractionDigits value="3"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="ChargeTaxRate" minOccurs="0" maxOccurs="unbounded">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="6"/>
<xsd:fractionDigits value="3"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="ChargeTaxAmountDet" minOccurs="0" type="ChargeTaxAmountDetType"
maxOccurs="unbounded"/>
<xsd:element name="QtdSExtrChrgInAdCur" minOccurs="0" type="QtdSExtrChrgInAdCurType"
maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>

QtdShpExChrgType Element Definitions


The following table describes the data elements found in the QtdShpExChrgType schema:

Element Name Datatype/Format Req Definition Valid Values


SpecialServiceType xsd:string O Global/Network Charge Code for service <= 6 characters
LocalServiceType xsd:string O Local Charge Code for service <=3 characters
GlobalServiceName xsd:string O Global service name for service. It’s
recommended to display Global name instead
of Local name.
LocalServiceTypeName xsd:string O Local service name for service

SOfferedCustAgreement xsd:string O Indicates that the product or service or


solution only can be offered to customers
with prior agreement.

ChargeCodeType xsd:string O Special service charge code type for service. XCH=Extra charge
XCH type charge codes are Optional Services FEE=Fee
and should be displayed to users for selection. SCH=Surcharge
Other charges may be automatically returned NRI=Non Revenue Item
when applicable.
InsPrmRateInPercentage xsd:decimal O Provides the insurance premium rate in Decimal(8,4)
percentage
CurrencyCode xsd:string O Currency code of the service charge amount

ChargeValue xsd:decimal O Service charge amount with Tax Decimal(18,3)


ChargeTaxAmount xsd:decimal O Service charge tax amount Decimal(18,3)
ChargeTaxRate xsd:decimal O Service charge tax rate Decimal(6,3)
ChargeTaxAmountDet ChargeTaxAmountDetT O Optional services tax breakdown pricing
ype details

QtdSExtrChrgInAdCur QtdSExtrChrgInAdCurT O Optional services charges in additional multi


ype currencies

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 56 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

4.2.3.28.1 SpecialServiceType Element


The SpecialServiceType element is the global or network charge code of the service.
<xsd:element name="SpecialServiceType" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:maxLength value="6"></xsd:maxLength>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.2.3.28.2 LocalServiceType Element


The LocalServiceType element is the local charge code of the service.
<xsd:element name="LocalServiceType" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:maxLength value="3"></xsd:maxLength>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.2.3.28.3 GlobalServiceName Element


The GlobalServiceName element is the global service name of the service.
<xsd:element name="GlobalServiceName" type="xsd:string" minOccurs="0" maxOccurs="1">
</xsd:element>

4.2.3.28.4 LocalServiceTypeName Element


The LocalServiceTypeName element is the local service name of the service.
<xsd:element name="LocalServiceTypeName" type="xsd:string" minOccurs="0" maxOccurs="1">
</xsd:element>

4.2.3.28.5 SOfferedCustAgreement Element


The SOfferedCustAgreement element indicates that the service or solution only can be offered to a
customer agreement that are not default to a billing entity.
<xsd:element name="SOfferedCustAgreement" type="xsd:string" minOccurs="0" maxOccurs="1"/>

4.2.3.28.6 ChargeCodeType Element


The ChargeCodeType element indicates special service charge code type of the service.
<xsd:element name="ChargeCodeType" type="xsd:string" minOccurs="0"></xsd:element>

4.2.3.28.7 InsPrmRateInPercentage Element


The InsPrmRateInPercentage element indicates the insurance premium rate in percentage.
Note: This is only applicable to GetQuote service if it it is available.
<xsd:element name="InsPrmRateInPercentage" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="8"/>
<xsd:fractionDigits value="4"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.2.3.28.8 CurrencyCode Element

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 57 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

The CurrencyCode element indicates the currency code of the service charge value.
Note: This is only applicable to GetQuote service.
<xsd:element name="CurrencyCode" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="3" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.2.3.28.9 ChargeValue Element


The ChargeValue element is the service charge value.
Note: This is only applicable to GetQuote service.
<xsd:element name="ChargeValue" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="18"/>
<xsd:fractionDigits value="3"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.2.3.28.10 ChargeTaxAmount Element


The ChargeTaxAmount element is the service tax amount.
Note: This is only applicable to GetQuote service.
<xsd:element name="ChargeTaxAmount" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="18"/>
<xsd:fractionDigits value="3"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.2.3.28.11 ChargeTaxRate Element


The ChargeTaxRate element is the service charge tax rate.
Note: This is only applicable to GetQuote service.
<xsd:element name="ChargeTaxRate" minOccurs="0" maxOccurs="unbounded">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="6" />
<xsd:fractionDigits value="3" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.2.3.28.12 ChargeTaxAmountDet Element


The ChargeTaxAmountDet element is the optional services tax breakdown pricing details.
Note: This is only applicable to GetQuote service.
<xsd:element name="ChargeTaxAmountDet" minOccurs="0" type="ChargeTaxAmountDetType"
maxOccurs="unbounded"/>

<xsd:complexType name="ChargeTaxAmountDetType">
<xsd:sequence>

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 58 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

<xsd:element name="TaxTypeRate" minOccurs="0">


<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="18"/>
<xsd:fractionDigits value="6"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="TaxTypeCode" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:maxLength value="6"></xsd:maxLength>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="TaxAmount" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="18"/>
<xsd:fractionDigits value="3"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="BaseAmount" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="18"/>
<xsd:fractionDigits value="3"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>

ChargeTaxAmountDetType Element Definitions


The following table describes the data elements found in the ChargeTaxAmountDetType schema:

Element Name Datatype/Format Req Definition Valid Values


TaxTypeRate xsd:decimal O Tax type rates for extra charge Decimal (18,6)

TaxTypeCode xsd:string O Tax type code for extra charge 6 characters


TaxAmount xsd:decimal O Tax type amount for extra charge Decimal (18,3)
BaseAmount xsd:decimal O The base amount for a tax type amount Decimal (18,3)
calculation for extra charge. Currency is
specified in parent element
<CurrencyCode> in section 4.2.3.29.8.

4.2.3.28.12.1 TaxTypeRate Element


The TaxTypeRate element contains the tax type rate for the extra charge.
<xsd:element name="TaxTypeRate" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="18"/>
<xsd:fractionDigits value="6"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.2.3.28.12.2 TaxTypeCode Element


The TaxTypeCode element contains the tax type code for the extra charge.
<xsd:element name="TaxTypeCode" minOccurs="0">
<xsd:simpleType>

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 59 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

<xsd:restriction base="xsd:string">
<xsd:maxLength value="6"></xsd:maxLength>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.2.3.28.12.3 TaxAmount Element


The TaxAmount element contains the tax type amount for the extra charge.
<xsd:element name="TaxAmount" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="18"/>
<xsd:fractionDigits value="3"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.2.3.28.12.4 BaseAmount Element


The BaseAmount element contains the base amount for a tax type amount calculation for extra
charge. Currency is specified in parent element <CurrencyCode> in section 4.2.3.29.8
<xsd:element name="BaseAmount" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="18"/>
<xsd:fractionDigits value="3"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.2.3.28.13 QtdSExtrChrgInAdCur Element


The QtdSExtrChrgInAdCur element is the optional services charges in additional multi currencies.
Note: This is only applicable to GetQuote service.

<xsd:element name="QtdSExtrChrgInAdCur" minOccurs="0" type="QtdSExtrChrgInAdCurType"


maxOccurs="unbounded"/>

<xsd:complexType name="QtdSExtrChrgInAdCurType">
<xsd:sequence>
<xsd:element name="ChargeValue" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="18"/>
<xsd:fractionDigits value="3"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="ChargeExchangeRate" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="18"/>
<xsd:fractionDigits value="6"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="ChargeTaxAmount" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="18"/>
<xsd:fractionDigits value="3"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="CurrencyCode" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 60 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

<xsd:length value="3" />


</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="CurrencyRoleTypeCode" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="5" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="ChargeTaxAmountDet" minOccurs="0" type="ChargeTaxAmountDetType"
maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 61 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

QtdSExtrChrgInAdCurType Element Definitions


The following table describes the data elements found in the QtdSExtrChrgInAdCurType schema:

Element Name Datatype/Format Req Definition Valid Values


ChargeValue xsd:decimal O An amount of fee quoted for the extra Decimal (18,3)
service provided by DHL

ChargeExchangeRat xsd:decimal O The exchange rate for the currency being Decimal (18,6)
e defined against base currency
ChargeTaxAmount xsd:decimal O The amount of tax that has been levied Decimal (18,3)
on the extra charge
CurrencyCode xsd:string O The three characters alphabetic unique 3 characters
Currency ID identified issued by the ISO
for an internationally recognized
currency
CurrencyRoleTypeC xsd:string O Defines a role in which is a currency 5 characters. The roles
ode used. can be:
BILLCU – Billing currency
PULCL – Country/Region of
pickup
local currency
INVCU – Invoice currency
BASEC – Base currency

ChargeTaxAmountD ChargeTaxAmountDetType O Charge tax breakdown pricing details in


et the defined currency for extra charge

4.2.3.28.13.1 ChargeValue Element


The ChargeValue element is the service charge or fee quoted for the extra service provided by DHL.
<xsd:element name="ChargeValue" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="18"/>
<xsd:fractionDigits value="3"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.2.3.28.13.2 ChargeExchangeRate Element


The ChargeExchangeRate element is the exchange rate for the currency beign defined against base
currency for the extra charge.
<xsd:element name="ChargeExchangeRate" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="18"/>
<xsd:fractionDigits value="6"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.2.3.28.13.3 ChargeTaxAmount Element


The ChargeTaxAmount element is the amount of tax that has been levied on the extra charge.
<xsd:element name="ChargeTaxAmount" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="18"/>

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 62 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

<xsd:fractionDigits value="3"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.2.3.28.13.4 CurrencyCode Element


The CurrencyCode element is the three characters alphabetic unique Currency ID identified issued
by the ISO for an internationally recognized currency used in extra charge calculation.
<xsd:element name="CurrencyCode" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="3" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.2.3.28.13.5 CurrencyRoleTypeCode Element


The CurrencyRoleTypeCode element is the roles in which the currency used in extra charge
calculation.

<xsd:element name="CurrencyRoleTypeCode" minOccurs="0">


<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="5" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.2.3.28.13.6 ChargeTaxAmountDet Element


The ChargeTaxAmountDet element contains the charge tax breakdown pricing dtails in the defined
currency for extra charge.
<xsd:element name="ChargeTaxAmountDet" minOccurs="0" type="ChargeTaxAmountDetType"
maxOccurs="unbounded"/>
<xsd:complexType name="ChargeTaxAmountDetType">
<xsd:sequence>
<xsd:element name="TaxTypeRate" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="8"/
<xsd:fractionDigits value="6"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="TaxTypeCode" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:maxLength value="6"></xsd:maxLength>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="TaxAmount" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="18"/>
<xsd:fractionDigits value="3"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="BaseAmount" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="18"/>
<xsd:fractionDigits value="3"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 63 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

</xsd:sequence>
</xsd:complexType>

ChargeTaxAmountDetType Element Definitions


The following table describes the data elements found in the ChargeTaxAmountDetType schema:

Element Name Datatype/Format Req Definition Valid Values


TaxTypeRate xsd:decimal O Tax type rates for extra charge Decimal (8,6)

TaxTypeCode xsd:string O Tax type code for extra charge 6 characters


TaxAmount xsd:decimal O Tax type amount for extra charge Decimal (18,3)
BaseAmount xsd:decimal O The base amount for a tax type amount Decimal (18,3)
calculation for extra charge. Currency is
specified in parent element
<CurrencyCode> in section
4.2.3.29.13.4.

4.2.3.28.13.6.1 TaxTypeRate Element


The TaxTypeRate element contains the tax type rate for the extra charge.
<xsd:element name="TaxTypeRate" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="8"/
<xsd:fractionDigits value="6"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.2.3.28.13.6.2 TaxTypeCode Element


The TaxTypeCode element contains the tax type code for the extra charge.
<xsd:element name="TaxTypeCode" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:maxLength value="6"></xsd:maxLength>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.2.3.28.13.6.3 TaxAmount Element


The TaxAmount element contains the tax type amount for the extra charge.
<xsd:element name="TaxAmount" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="18"/>
<xsd:fractionDigits value="3"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.2.3.28.13.6.4 BaseAmount Element


The BaseAmount element contains the base amount for a tax type amount calculation for extra
charge. Currency is specified in parent element <CurrencyCode> in section 4.2.3.29.13.4.
<xsd:element name="BaseAmt" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="18"/>
<xsd:fractionDigits value="3"/>

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 64 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

</xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.2.3.29 PricingDate Element


The PricingDate element is the date of the price.
Note: This is only applicable to GetQuote service.
<xsd:element name="PricingDate" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:date" />
</xsd:simpleType>
</xsd:element>

4.2.3.30 ShippingCharge Element


The ShippingCharge element is the total quote with tax for weight and all applicable charges.
Note: This is only applicable to GetQuote service.
<xsd:element name="ShippingCharge" minOccurs="0" >
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="18"/>
<xsd:fractionDigits value="3"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.2.3.31 TotalTaxAmount Element


The TotalTaxAmount element is the total tax for weight and all applicable charges.
Note: This is only applicable to GetQuote service.
<xsd:element name="TotalTaxAmount" minOccurs="0" >
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="18"/>
<xsd:fractionDigits value="3"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.2.3.32 TotalDiscount Element

The TotalDiscount element is the total discount of the shipment.


Note: This is only applicable to GetQuote service.

<xsd:element name="TotalDiscount" minOccurs="0">


<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="18" />
<xsd:fractionDigits value="3" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.2.3.33 WeightChargeTaxDet Element


The WeightChargeTaxDet element contains the weight charge tax breakdown pricing details.
Note: This is only applicable to GetQuote service.
<xsd:element name="WeightChargeTaxDet" minOccurs="0" type="WeightChargeTaxDetType" maxOccurs="unbounded"/>

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 65 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

<xsd:complexType name="WeightChargeTaxDetType">
<xsd:sequence>
<xsd:element name="TaxTypeRate" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="8" />
<xsd:fractionDigits value="6" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="TaxTypeCode" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:maxLength value="6"></xsd:maxLength>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="WeightChargeTax" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="18" />
<xsd:fractionDigits value="3" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="BaseAmt" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="18" />
<xsd:fractionDigits value="3" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>

WeightChargeTaxDetType Element Definitions


The following table describes the data elements found in the WeightChargeTaxDetType schema:

Element Name Datatype/Format Req Definition Valid Values


TaxTypeRate xsd:decimal O Tax type rates for weight charge Decimal (8,6)

TaxTypeCode xsd:string O Tax type code for weight charge 6 characters


WeightChargeTax xsd:decimal O Tax type amount for weight charge Decimal (18,3)
BaseAmt xsd:decimal O The base amount for a tax type amount Decimal (18,3)
calculation. Currency is specified in
parent element <CurrencyCode> in
section 4.2.3.29.8

4.2.3.33.1 TaxTypeRate Element


The TaxTypeRate element contains the tax type rate for the weight charge.
<xsd:element name="TaxTypeRate" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="8"/>
<xsd:fractionDigits value="6"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.2.3.33.2 TaxTypeCode Element


The TaxTypeCode element contains the tax type code for the weight charge.
<xsd:element name="TaxTypeCode" minOccurs="0">
<xsd:simpleType>

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 66 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

<xsd:restriction base="xsd:string">
<xsd:maxLength value="6"></xsd:maxLength>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.2.3.33.3 WeightChargeTax Element


The WeightChargeTax element contains the tax type amount for the weight charge.
<xsd:element name="WeightChargeTax" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="18"/>
<xsd:fractionDigits value="3"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.2.3.33.4 BaseAmt Element


The BaseAmt element contains the base amount for a tax type amount calculation. Currency is
specified in parent element <CurrencyCode> in section 4.2.3.29.8
<xsd:element name="BaseAmt" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="18"/>
<xsd:fractionDigits value="3"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.2.3.34 QtdSInAdCur Element

The QtdSInAdCur element contains the optional services information.

<xsd:element name="QtdSInAdCur" minOccurs="0" type="QtdSInAdCurType" maxOccurs="unbounded" />


<xsd:complexType name="QtdSInAdCurType">
<xsd:sequence>
<xsd:element name="CustomsValue" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="18" />
<xsd:fractionDigits value="3" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="ExchangeRate" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="18" />
<xsd:fractionDigits value="6" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="CurrencyCode" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="3" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="CurrencyRoleTypeCode" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="5" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 67 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

<xsd:element name="WeightCharge" minOccurs="0">


<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="18" />
<xsd:fractionDigits value="3" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="TotalAmount" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="18" />
<xsd:fractionDigits value="3" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="TotalTaxAmount" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="18" />
<xsd:fractionDigits value="3" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="WeightChargeTax" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="18" />
<xsd:fractionDigits value="3" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="WeightChargeTaxDet" minOccurs="0"
type="WeightChargeTaxDetType" maxOccurs="unbounded" />
</xsd:sequence>
</xsd:complexType>

Element Name Datatype/Format Req Definition Valid Values


CustomsValue xsd:decimal O The Customs Value Decimal(18,3)
ExchangeRate xsd:decimal O The exchange rate between EUR
and Charge Currency Code. Decimal(18,6)
CurrencyCode xsd:string O Currency code in which price is
returned
3 chars
CurrencyRoleTy xsd:string O Defines a role in which is a 5 characters. The roles
peCode currency used. can be:
BILLCU – Billing
currency
PULCL –
Country/Region of pickup
local currency
INVCU – Invoice
currency
BASEC – Base currency
WeightCharge xsd:decimal O The WeightCharge element is the Decimal(18,3)
weight price including tax.
TotalAmount xsd:decimal O The Total Amount Decimal(18,3)
TotalTaxAmount xsd:decimal O The Total Tax Amount Decimal(18,3)
WeightChargeTa xsd:decimal O Tax type amount for weight Decimal (18,3)
x charge
WeightChargeTa xsd:decimal O The WeightChargeTaxDet
xDet element contains the weight

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 68 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

charge tax breakdown pricing


details.

4.2.3.35 PickupWindowEarliestTime Element


The PickupWindowEarliestTime element contains the pickup window earliest time.
<xsd:element name="PickupWindowEarliestTime" minOccurs="1">
<xsd:simpleType>
<xsd:annotation>
<xsd:documentation>Pickup window start time</xsd:documentation>
</xsd:annotation>
<xsd:restriction base="xsd:string" />
</xsd:simpleType>
</xsd:element>

4.2.3.36 PickupWindowLatestTime Element


The PickupWindowLatestTime element contains the pickup window latest time.
<xsd:element name="PickupWindowLatestTime" minOccurs="1">
<xsd:simpleType>
<xsd:annotation>
<xsd:documentation>Pickup window end time</xsd:documentation>
</xsd:annotation>
<xsd:restriction base="xsd:string" />
</xsd:simpleType>
</xsd:element>

4.2.3.37 BookingCutoffOffset Element


The BookingCutoffOffset element contains the booking cutoff offset.
<xsd:element name="BookingCutoffOffset" minOccurs="1">
<xsd:simpleType>
<xsd:annotation>
<xsd:documentation>Booking cut off time offset</xsd:documentation>
</xsd:annotation>
<xsd:restriction base="xsd:string" />
</xsd:simpleType>
</xsd:element>

4.2.3.38 PickupLeadTime Element


The PickupLeadTime element contains the pickup lead time details.
<xsd:element name="PickupLeadTime" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="1" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.2.3.39 PickupCloseTime Element


The PickupCloseTime element contains the pickup close time details.
<xsd:element name="PickupCloseTime" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="1" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 69 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

4.2.3.40 WeightChargeDisc Element


The WeightChargeDisc element contains the weight charge discount details.
<xsd:element name="WeightChargeDisc" minOccurs="0" type="WeightChargeDisc" maxOccurs="unbounded" />
<xsd:complexType name="WeightChargeDisc">
<xsd:sequence>
<xsd:element name="DiscAmt" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="18" />
<xsd:fractionDigits value="3" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="BaseAmount" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="18" />
<xsd:fractionDigits value="3" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="CurrencyCode" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="3" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="DiscType" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="1" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="DiscPercentage" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="18" />
<xsd:fractionDigits value="3" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>

WeightChargeDisc Element Definitions


The following table describes the data elements found in the WeightChargeDisc schema:

Element Name Datatype/Format Req Definition Valid Values


Discount Amount
DiscAmt xsd:decimal O Decimal(18,3)
BaseAmount xsd:decimal O Base Amount Decimal(18,3)
Currency Code 3 characters
CurrencyCode xsd:string O
Discount Type 1 character
DiscType xsd:string O
Discount Percentage
DiscPercentage xsd:decimal O Decimal(18,3)

4.2.3.41 QtdShpExChrgDisc Element


The QtdShpExChrgDisc element contains the extra charge’s weight charge discount details.
<xsd:element name="QtdShpExChrgDisc" minOccurs="0" type="QtdShpExChrgDisc" maxOccurs="unbounded" />

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 70 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

<xsd:complexType name="QtdShpExChrgDisc">
<xsd:sequence>
<xsd:element name="DiscAmt" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="5" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="BaseAmt" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="18" />
<xsd:fractionDigits value="3" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="CurrencyCode" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="3" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="CurrencyRoleTypeCode" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="5" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="DiscPercentage" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:decimal">
<xsd:totalDigits value="18" />
<xsd:fractionDigits value="3" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>

QtdShpExChrgDisc Element Definitions


The following table describes the data elements found in the QtdShpExChrgDisc schema:
Datatype/For
Element Name mat Req Definition Valid Values
DiscAmt xsd:string O Discount Amount 5 characters
BaseAmt xsd:decimal O Base Amount Decimal(18,3)
3 characters
CurrencyCode xsd:string O Currency Code
5 characters
CurrencyRoleTypeCode xsd:string Os Currency Role Type Code
DiscPercentage xsd:decimal O Discount Percentage Decimal(18,3)

4.3 Srvs Element

Srvs element is used to identify marketed service description of the found product.

<xsd:element name="Srvs" minOccurs="0" maxOccurs="1">


<xsd:complexType>
<xsd:sequence>
<xsd:element name="Srv" type="dct:SrvType" minOccurs="0" maxOccurs="unbounded">
</xsd:element>

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 71 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

</xsd:sequence>
</xsd:complexType>
</xsd:element>

<xsd:complexType name="SrvType">
<xsd:sequence>
<xsd:element name="GlobalProductCode" type="xsd:string" minOccurs="1" maxOccurs="1">
</xsd:element>
<xsd:element name="MrkSrv" type="MrkSrvType" minOccurs="0" maxOccurs="unbounded">
</xsd:element>
<xsd:element name="SBTP" type="SBTPType" minOccurs="0" maxOccurs="1"></xsd:element>
</xsd:sequence>
</xsd:complexType>

SrvType Element Definitions


The following table describes the data elements found in the SrvType schema:

Element Name Datatype/Format Req Definition Valid Values


GlobalProductCode xsd:string M Global product code
MrkSrv MrkSrvType O Marketed service type and its description
SBTP SBTPType O Service combination and restrictions is
only returned when user requests
‘OSINFO’

4.3.1 GlobalProductCode Element


The GlobalProductCode element is the global product code corresponding to QtdShp element in
BkgDetails.
<xsd:element name="GlobalProductCode" type="xsd:string" minOccurs="1" maxOccurs="1">
</xsd:element>

4.3.2 MrkSrv Element


The MrkSrv element is the marketed service type with its description.
<xsd:element name="MrkSrv" type="MrkSrvType" minOccurs="0" maxOccurs="unbounded">
</xsd:element>

<xsd:complexType name="MrkSrvType">
<xsd:sequence>
<xsd:choice>
<xsd:element name="LocalProductCode" type="xsd:string" minOccurs="0" maxOccurs="1"/>
<xsd:element name="LocalServiceType" type="xsd:string" minOccurs="0" maxOccurs="1"/>
</xsd:choice>
<xsd:choice>
<xsd:element name="ProductShortName" type="xsd:string" minOccurs="0" maxOccurs="1"/>
<xsd:element name="GlobalServiceName" type="xsd:string" minOccurs="0" maxOccurs="1"/>
</xsd:choice>
<xsd:choice>
<xsd:element name="LocalProductName" type="xsd:string" minOccurs="0" maxOccurs="1"/>
<xsd:element name="LocalServiceTypeName" type="xsd:string" minOccurs="0" maxOccurs="1"/>
</xsd:choice>
<xsd:choice>
<xsd:element name="ProductDesc" type="xsd:string" minOccurs="0" maxOccurs="1"/>
<xsd:element name="ServiceDesc" type="xsd:string" minOccurs="0" maxOccurs="1"/>
</xsd:choice>
<xsd:element name="NetworkTypeCode" type="xsd:string" minOccurs="0" maxOccurs="1">
</xsd:element>
<xsd:choice>
<xsd:element name="POfferedCustAgreement" type="xsd:string" minOccurs="0" maxOccurs="1"/>
<xsd:element name="SOfferedCustAgreement" type="xsd:string" minOccurs="0" maxOccurs="1"/>

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 72 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

</xsd:choice>
<xsd:element name="TransInd" type="xsd:string" minOccurs="0" maxOccurs="1">
</xsd:element>
<xsd:element name="ChargeCodeType" type="xsd:string" minOccurs="0" maxOccurs="unbounded">
</xsd:element>
<xsd:element name="MrkSrvInd" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="1" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="LocalProductCtryCd" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="2" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="LocalProductDesc" type="xsd:string" minOccurs="0" maxOccurs="1" />
<xsd:element name="GlobalProductDesc" type="xsd:string" minOccurs="0" maxOccurs="1" />
<xsd:element name="GlobalServiceType" type="xsd:string" minOccurs="0" maxOccurs="1" />
<xsd:element name="BillingServiceIndicator" type="xsd:string" minOccurs="0" maxOccurs="1" />
<xsd:element name="LocalServiceName" type="xsd:string" minOccurs="0" maxOccurs="1" />
</xsd:sequence>
</xsd:complexType>

MrkSrvType Element Definitions


The following table describes the data elements found in the MrkSrvType schema:

Element Name Datatype/Format Req Definition Valid Values


LocalProductCode xsd:string O Local product code
LocalServiceType xsd:string O Local charge code of the service
ProductShortName xsd:string O Global product name
GlobalServiceName xsd:string O Global service name of the service
LocalProductName xsd:string O Local product name
LocalServiceTypeN
ame xsd:string O Local service name of the service
ProductDesc xsd:string O Product description if it is product details
ServiceDesc xsd:string O Service description if it is service details
DD=Day Definite
NetworkTypeCode xsd:string O Network type code for product TD=Time Definite
POfferedCustAgree xsd:string O Indicates that the product only can be
ment offered to customers with prior
agreement
SOfferedCustAgree xsd:string O Indicates that the service can be offered
ment to customers with prior agreement.
Web User Interface indicator. If Y – Show products to all
TransInd xsd:string O value=Y, show on website open for all users (incl. cash, credit card)
users N – Only show products to
users with DHL account
Special service charge code type for
ChargeCodeType xsd:string O service. XCH type charge codes are XCH=Extra charge
Optional Services and should be FEE=Fee
displayed to users for selection. Other SCH=Surcharge
charges may be automatically returned NRI=Non Revenue Item
when applicable.
MrkSrvInd xsd:string O By default, client should only offer those
services that are marked as “Y” 1 char (Y/N)

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 73 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

LocalProductCtryCd xsd:string O Local Product Country/Region Code


LocalProductDesc xsd:string O Local Product Description
GlobalProductDesc xsd:string O Global Product Description
GlobalServiceType xsd:string O Global Service Type
BillingServiceIndica
tor xsd:string O Billing Service Indicator
LocalServiceName xsd:string O Local Service Name

4.3.1.1 LocalProductCode Element


The LocalProductCide element is the local product code.
<xsd:element name="LocalProductCode" type="xsd:string" minOccurs="0" maxOccurs="1"/>

4.3.1.2 LocalServiceType Element


The LocalServiceType element is the local charge code of the service.
<xsd:element name="LocalServiceType" type="xsd:string" minOccurs="0" maxOccurs="1"/>

4.3.1.3 ProductShortName Element


The ProductShortName element is the global product name.
<xsd:element name="ProductShortName" type="xsd:string" minOccurs="0" maxOccurs="1"/>

4.3.1.4 GlobalServiceName Element


The GlobalServiceName element is the global service name of the service.
<xsd:element name="GlobalServiceName" type="xsd:string" minOccurs="0" maxOccurs="1"></xsd:element>

4.3.1.5 LocalProductName Element


The LocalProductName element is the local product name.
<xsd:element name="LocalProductName" type="xsd:string" minOccurs="0" maxOccurs="1"/>

4.3.1.6 LocalServiceTypeName Element


The LocalServiceTypeName element is the local service name of the service.
<xsd:element name="LocalServiceTypeName" type="xsd:string" minOccurs="0" maxOccurs="1">
</xsd:element>

4.3.1.7 ProductDesc Element


The ProductDesc element is the product description if it is available for the product.
<xsd:element name="ProductDesc" type="xsd:string" minOccurs="0" maxOccurs="1"/>

4.3.1.8 ServiceDesc Element


The ServiceDesc element is the service description if it is available for the service.
<xsd:element name="ServiceDesc" type="xsd:string" minOccurs="0" maxOccurs="1"/>

4.3.1.9 NetworkTypeCode Element


The NetworkTypeCode element is the network type code for the product.
<xsd:element name="NetworkTypeCode" type="xsd:string" minOccurs="0" maxOccurs="1">

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 74 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

</xsd:element>

4.3.1.10POfferedCustAgreement Element
The POfferedCustAgreement element indicates that the product only can be offered to a customer
agreement that are not default to a billing entity.
<xsd:element name="POfferedCustAgreement" type="xsd:string" minOccurs="0" maxOccurs="1"/>

4.3.1.11SOfferedCustAgreement Element
The SOfferedCustAgreement element indicates that the service or solution only can be offered to a
customer agreement that are not default to a billing entity.
<xsd:element name="SOfferedCustAgreement" type="xsd:string" minOccurs="0" maxOccurs="1">
</xsd:element>

4.3.1.12TransInd Element
The TransInd element indicates the web user interface indicator. If value of Y, it is show on the
Web user interface.
<xsd:element name="TransInd" type="xsd:string" minOccurs="0" maxOccurs="1"></xsd:element>

4.3.1.13ChargeCodeType Element
The ChargeCodeType element is the charge coed type of the service.
<xsd:element name="ChargeCodeType" type="xsd:string" minOccurs="0" maxOccurs="unbounded">
</xsd:element>

4.3.1.14 MrkSrvInd Element


The MrkSrvInd element is the services that allowed for marketed. By default, client should only
offer those services that are marked as “Y”.
<xsd:element name="MrkSrvInd" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="1" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.3.1.15 LocalProductCtryCd Element


The LocalProductCtryCd element is the country/region code for the defined local product code.
<xsd:element name="LocalProductCtryCd" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="2" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.3.1.16 LocalProductDesc
The LocalProductDesc element is the local product description.

<xsd:element name="LocalProductDesc" type="xsd:string" minOccurs="0" maxOccurs="1" />

4.3.1.17 GlobalProductDesc
The GlobalProductDesc element is the global product description.

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 75 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

<xsd:element name="GlobalProductDesc" type="xsd:string" minOccurs="0" maxOccurs="1" />

4.3.1.18 GlobalServiceType
The GlobalServiceType element is the global service type name.
<xsd:element name="GlobalServiceType" type="xsd:string" minOccurs="0" maxOccurs="1" />

4.3.1.19 BillingServiceIndicator
The BillingServiceIndicator element is the billing service indicator.

<xsd:element name="BillingServiceIndicator" type="xsd:string" minOccurs="0" maxOccurs="1" />

4.3.1.20 LocalServiceName

The LocalServiceName element is the local service name.


<xsd:element name="LocalServiceName" type="xsd:string" minOccurs="0" maxOccurs="1" />

4.3.3 SBTP Element


The SBTP element consists the service combination and restrictions details are returned only when
user requests ‘OSINFO’.

<xsd:element name="SBTP" type="SBTPType" minOccurs="0" maxOccurs="1"></xsd:element>

<xsd:complexType name="SBTPType">
<xsd:sequence>
<xsd:element name="Prod" type="ProdType" minOccurs="0" maxOccurs="1"></xsd:element>
</xsd:sequence>
</xsd:complexType>

SBTPType Element Definitions


The following table describes the data elements found in the SBTPType schema:

Element Name Datatype/Format Req Definition Valid Values


Prod ProdType O Service combination and restrictions
ProdType VldSrvComb O Sub-list of the service combination and
restriction

4.3.1.21Prod Element
The Prod element is complex type and consists of the ProdType with the list of service combination
and restrictions details.
<xsd:complexType name="ProdType">
<xsd:sequence>
<xsd:element name="VldSrvComb" minOccurs="0" maxOccurs="unbounded">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="SpecialServiceType" type="xsd:string" minOccurs="0" maxOccurs="1">
</xsd:element>
<xsd:element name="LocalServiceType" type="xsd:string" minOccurs="0" maxOccurs="unbounded">
</xsd:element>
<xsd:element name="CombRSrv" minOccurs="0" maxOccurs="unbounded">
<xsd:complexType>
<xsd:sequence>

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 76 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

<xsd:element name="RestrictedSpecialServiceType" minOccurs="0" type="xsd:string"


maxOccurs="1">
</xsd:element>
<xsd:element name="RestrictedLocalServiceType" type="xsd:string" minOccurs="0"
maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="TotalDiscount" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="1" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>

ProdType and VldSrvComb Element Definitions


The following table describes the data elements found in the ProdType and VldSrvComb schema:

Element Name Datatype/Format Req Definition Valid Values


SpecialServiceType xsd:string O Global/network charge code of the
service
LocalServiceType xsd:string O Local charge code of the service

CombRSrv Complextype O Restricted service combination details

TotalDiscount xsd:string M Total Discount

4.3.1.21.1 SpecialServiceType Element


The SpecialServiceType element is the global or network charge code of the service.
<xsd:element name="SpecialServiceType" type="xsd:string" minOccurs="0" maxOccurs="1">
</xsd:element>

4.3.1.21.2 LocalServiceType Element


The LocalServiceType element is the local charge code of the service.
<xsd:element name="LocalServiceType" type="xsd:string" minOccurs="0" maxOccurs="unbounded">
</xsd:element>

4.3.1.21.3 CombRSrv Element


The CombRSrv element is complex type and consists of the restricted service combination details.
<xsd:element name="CombRSrv" minOccurs="0" maxOccurs="unbounded">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="RestrictedSpecialServiceType" minOccurs="0" type="xsd:string" maxOccurs="1">
</xsd:element>
<xsd:element name="RestrictedLocalServiceType" type="xsd:string" minOccurs="0"
maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>

CombRSrv Element Definitions

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 77 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

The following table describes the data elements found in the CombRSrv schema:

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 78 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

Element Name Datatype/Format Req Definition Valid Values


RestrictedSpecialServ xsd:string O Restricted Global/network charge Null value indicates that above Charge
iceType code code can be combined with every
service
A value indicates that above Charge
code can only be combined with this
charge code and only with all other
charge codes together in group of
restricted services

RestrictedLocalServic xsd:string O Restricted Local charge code Null value indicates that above Charge
eType code can be combined with every
service

A value indicates that above Charge


code can only be combined with this
charge code and only with all other
charge codes together in group of
restricted services

4.3.1.21.3.1 RestrictedSpecialServiceType Element


The RestrictedSpecialServiceType element is the restriced global or network charge code of the
service.
<xsd:element name="RestrictedSpecialServiceType" minOccurs="0" type="xsd:string" maxOccurs="1">
</xsd:element>

4.3.1.21.3.2 RestrictedLocalServiceType Element


The RestrictedLocalServiceType element is the restriced local charge code of the service.
<xsd:element name="RestrictedLocalServiceType" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/>

4.3.1.21.4 TotalDiscount Element

<xsd:element name="TotalDiscount" minOccurs="0">


<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:length value="1" />
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.4 Note Element

Note element is used to identify messages and error codes of the response message for capability and
quote service.

<xsd:element name="Note" minOccurs="0" type="dct:NoteType" maxOccurs="1" />

<xsd:complexType name="NoteType">
<xsd:sequence>
<xsd:element name="ActionStatus" type="xsd:string" minOccurs="0" maxOccurs="1"/>
<xsd:element name="Condition" minOccurs="0" maxOccurs="unbounded">

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 79 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

<xsd:complexType>
<xsd:sequence>
<xsd:element name="ConditionCode" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:minLength value="0"></xsd:minLength>
<xsd:maxLength value="10"></xsd:maxLength>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="ConditionData" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>

NoteType Element Definitions


The following table describes the data elements found in the NoteType schema:

Element Name Datatype/Format Req Definition Valid Values


Action Status xsd:string O
Note for the capability and quote service
Condition complextype O response

4.4.1 ActionStatus Element


<xsd:element name="ActionStatus" type="xsd:string" minOccurs="0" maxOccurs="1"/>

4.4.2 Condition Element


The Condition element is an optional field. It is a complex element which consists of
ConditionCode and ConditionData.
<xsd:element name="Condition" minOccurs="0" maxOccurs="unbounded">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="ConditionCode" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:minLength value="0"></xsd:minLength>
<xsd:maxLength value="10"></xsd:maxLength>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="ConditionData" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 80 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

Element Name Datatype/Format Req Definition Valid Values


Please refer to the Reference
ConditionCode xsd:string O Code for the condition Data (Error Messages)
ConditionData xsd:string O Data for the condition

4.4.1.1 ConditionCode Element


The condition code element contains the code for the condtion.

<xsd:element name="ConditionCode" minOccurs="0">


<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:minLength value="0"></xsd:minLength>
<xsd:maxLength value="10"></xsd:maxLength>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>

4.4.1.2 ConditionData Element


The Condition Data element contains the data for the condition.

<xsd:element name="ConditionData" minOccurs="0">


<xsd:simpleType>
<xsd:restriction base="xsd:string"></xsd:restriction>
</xsd:simpleType>
</xsd:element>

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 81 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

5 Capability and Quote service Error Response Schema


Following is the schema of Capability and Quote service error response. All
Capability and Quote service error response confirm to the following schema
file.
<?xml version="1.0" encoding="UTF-8"?>
<xsd:schema targetNamespace="http://www.dhl.com" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns="http://www.dhl.com" xmlns:dhl="http://www.dhl.com/datatypes" elementFormDefault="unqualified">
<xsd:import namespace="http://www.dhl.com/datatypes" schemaLocation="datatypes.xsd"/>
<xsd:element name="ErrorResponse">
<xsd:annotation>
<xsd:documentation>Generic error response root element</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="Response" type="dhl:ErrorResponse"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:schema>

5.1 Capability and Quote service error Response Data Element Definitions
The Capability and Quote service error Response schema contains the following four elements.

Element Name Datatype/Format Req Definition Valid Values


Error Response of the
Response dhl:ErrorResponse M Capability and Quote service

5.2 Response Element


The Response element contains the header and error information for the
message. The response element contains following complex datatypes.
<xsd:complexType name="ErrorResponse">
<xsd:annotation>
<xsd:documentation>Generic response header</xsd:documentation> </xsd:annotation>
<xsd:sequence>
<xsd:element name="ServiceHeader" type="ServiceHeader"/>
<xsd:element name="Status" type="Status"/>
</xsd:sequence>
</xsd:complexType>

5.2.1 ServiceHeader Element


The Service Header element contains the header information about the
request message. This element must be declared only once in the Request
element.
<xsd:complexType name="ServiceHeader"> <xsd:annotation>
<xsd:documentation>Standard routing header</xsd:documentation> </xsd:annotation>
<xsd:sequence>

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 82 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

<xsd:element name="MessageTime" type="xsd:dateTime" minOccurs="0">


<xsd:annotation>
<xsd:documentation>Time this message is sent</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="MessageReference" type="MessageReference" minOccurs="0">
<xsd:annotation>
<xsd:documentation>A string, peferably number, to uniquely identify individual messages.
Minimum length must be 28 and maximum length is 32
</xsd:documentation>
</xsd:annotation> </xsd:element>
<xsd:element name="SiteID" type="SiteID"/>
<xsd:element name="Password" type="Password"/>
</xsd:sequence> </xsd:complexType>

Element
Name Datatype/Format Req Definition Valid Values
MessageTime xsd:dateTime O Identifies the message time.
MessageReference MessageReference O Message reference number.
SiteID SiteID M Identifies the sender of the request
message. It is a mandatory field in the
request message.
Password Password M Authenticates the sender of the message.
It is a mandatory field in request
message.

5.2.1.1 MessageTime Element


The Message Time element contains the time at which the message was send by the
requestor. The format of the should be YYYY-MM-DD(T)hh-mm-ss-Time Zone where “T”
is the separator between date and time.
e.g. 2002-12-02T13:23:18-07:00

<xsd:element name="MessageTime" type="xsd:dateTime" minOccurs="0">


<xsd:annotation>
<xsd:documentation>Time this message is sent</xsd:documentation>
</xsd:annotation>
</xsd:element>

5.2.1.2 Message Reference Element


The Message Reference element should contain a unique reference to the message,
so that trace of a particular message can be done easily. It must be of minimum
length of 28 and maximum 32. The value can be decided by customer
<xsd:element name="MessageReference"> <xsd:annotation>
<xsd:documentation>Reference to the requested Message</xsd:documentation>
</xsd:annotation>
<xsd:restriction base="xsd:string">
<xsd:minLength value="28"/>
<xsd:maxLength value="32"/>
</xsd:restriction>
</xsd:simpleType>

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 83 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

5.2.1.3 SiteID Element


The site id element is used to identify the requestor of the message. Each partner/customer
is provided with the site id and password. Each request message received is validated with
this before proceeding forward.

<xsd:simpleType name="SiteID">
<xsd:annotation>
<xsd:documentation>Site ID used for verifying the sender</xsd:documentation>
</xsd:annotation>
<xsd:restriction base="xsd:string">
<xsd:minLength value="6"/>
<xsd:maxLength value="12"/>
</xsd:restriction>
</xsd:simpleType>

5.2.1.4 Password Element

The password element is used to verify the identity the requestor of the message.
Each partner/customer is provided with the site id and password. Each request
message received is validated with this before proceeding forward. In response
message this element is not come out.

<xsd:simpleType name="Password">
<xsd:annotation>
<xsd:documentation>Password used for verifying the sender</xsd:documentation>
</xsd:annotation>
<xsd:restriction base="xsd:string">
<xsd:minLength value="8"/>
<xsd:maxLength value="20"/>
</xsd:restriction>
</xsd:simpleType>

5.2.2 Status Element


The Status element is an complex element which consists of two child elements
“ActionStatus” and “Condition” element. The Staus element is returned by the backend
service while processing the Capability and Quote request. The element is a mandatory
element.

<xsd:complexType name="Status">
<xsd:annotation>
<xsd:documentation>Status/Exception signal element</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="ActionStatus" type="xsd:string"/>
<xsd:element name="Condition" type="Condition" minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 84 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0

Element
Name Datatype/Format Req Definition Valid Values
ActionStatus xsd:string M Response for the Capability and Quote
request
Condition Condition O Note for the Capability and Quote
response

5.2.3 ActionStatus Element


The Action status is returned by the the backend service in error response to
the Capability and Quote request send to it. It is a mandatory field in the
Status Segment.
<xsd:element name="ActionNote" type="xsd:string"/>

5.2.4 Condition Element


The Condition element is an optional field. It is a complex element which
consists of ConditionCode and ConditionData.

<xsd:complexType name="Condition">
<xsd:sequence>
<xsd:element name="ConditionCode" type="xsd:string"/>
<xsd:element name="ConditionData" type="xsd:string" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>

Element Name Datatype/Format Req Definition Valid Values


ConditionCode xsd:string M Code for the condition Please refer to the Reference
Data (Error Messages)
ConditionData xsd:string O Data for the condition

5.2.4.1 ConditionCode Element


The condition code element contains the code for the condtion. It is a
mandatory field in the Condtion segment.

<xsd:element name="ConditionCode" type="xsd:string"/>

5.2.4.2 ConditionData Element


The Condition Data element contains the data for the condition. It is an
optional field in the Condition segment.
<xsd:element name="ConditionData" type="xsd:string" minOccurs="0"/>

Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 85 –
DHL PROPRIETARY AND CONFIDENTIAL

You might also like

pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy