XMLServices7.0 CapabilityAndQuoteService
XMLServices7.0 CapabilityAndQuoteService
XML
Services
Ver 7.0
Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc -1–
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0
Table Of Contents
1 INTRODUCTION .............................................................................................................................. 5
Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc -2–
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0
5.1 Capability and Quote service error Response Data Element Definitions ...................................................... 82
Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc -3–
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0
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
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.
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.
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
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.
<?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>
Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc -8–
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0
<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>
<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>
<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>
<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>
<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
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>
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>
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>
The following table describes the data elements found in the DCTFrom schema:
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>
<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
Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 17 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0
Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 18 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0
Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 19 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0
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
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>
Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 21 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0
<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>
COY=Parcels/Conveyables - pieces
that can be handled onto a system,
less than 31.5 kg and up to
60*60*120cm.
Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 25 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0
Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 26 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 27 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0
Note: blank value or missing node will only return TD products from EU and both TD & DD
products from AP and AM countries.
<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>
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
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.
The LocalProductCode element is the country/region billing product code for the shipment.
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>
<xsd:complexType name="QtdShpExChrgType">
<xsd:sequence>
Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 29 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0
The SpecialServiceType element is the global charge code of the service for the shipment.
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.
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>
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: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>
Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 32 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0
Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 33 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0
Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 34 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0
Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 35 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0
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>
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>
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>
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
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
Following is the schema of Capability response. All successful Capability and Quote
service response confirm to the following schema file.
<?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>
Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 40 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0
Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 41 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0
</xsd:complexType>
<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>
Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 42 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0
<xsd:complexType name="BkgDetailsType">
<xsd:sequence>
<xsd:element name="QtdShp" minOccurs="0" maxOccurs="unbounded" type="QtdShpType" />
</xsd:sequence>
</xsd:complexType>
<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>
Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 46 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0
Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 47 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0
Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 48 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0
Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 49 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0
Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 50 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0
Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 51 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0
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
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>
Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 53 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0
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.
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>
Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 54 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0
</xsd:simpleType>
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>
<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>
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
Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 56 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0
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>
<xsd:complexType name="ChargeTaxAmountDetType">
<xsd:sequence>
Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 58 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0
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>
<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
Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 61 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0
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
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>
Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 63 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0
</xsd:sequence>
</xsd:complexType>
Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 64 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
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>
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>
Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 67 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0
Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 68 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0
Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 69 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0
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>
Srvs element is used to identify marketed service description of the found product.
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>
<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>
Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 73 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0
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.16 LocalProductDesc
The LocalProductDesc element is the local product description.
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
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.
4.3.1.20 LocalServiceName
<xsd:complexType name="SBTPType">
<xsd:sequence>
<xsd:element name="Prod" type="ProdType" minOccurs="0" maxOccurs="1"></xsd:element>
</xsd:sequence>
</xsd:complexType>
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
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
RestrictedLocalServic xsd:string O Restricted Local charge code Null value indicates that above Charge
eType code can be combined with every
service
Note element is used to identify messages and error codes of the response message for capability and
quote service.
<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>
Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 80 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0
Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 81 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0
5.1 Capability and Quote service error Response Data Element Definitions
The Capability and Quote service error Response schema contains the following four elements.
Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 82 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0
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.
Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 83 –
DHL PROPRIETARY AND CONFIDENTIAL
Reference Document-XMLServices 7.0
<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>
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>
<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
<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>
Doc.Ref.:XMLServices7.0_CapabilityAndQuoteService.doc - 85 –
DHL PROPRIETARY AND CONFIDENTIAL