A sequence number defined by the (soap-) client. The sequenceNumber is
returned by the webservice within the result of the createShipment operation, so
that the client is able to assign the shipment information of the response to the
shipment data of the request.
The version of the webservice and the version of the software
build.
The version of the webservice implementation.
The shipmentdata for creating a shipment.
The version of the webservice implementation for which the
requesting client is developed.
ShipmentOrder is the highest parent element that contains all
data with respect to one shipment order.
The shipmentdata for validating a shipment.
The version of the webservice implementation for which the
requesting client is developed.
ShipmentOrder is the highest parent element that contains all
data with respect to one shipment order.
The status of the operation and the shipment identifier (if
available).
The version of the webservice implementation.
Success status after processing the overall
request.
The operation's success status for every single ShipmentOrder
will be returned by one CreationState element. It is identifiable via
SequenceNumber.
The status of the operation and the shipment identifier (if
available).
The version of the webservice implementation.
Success status after processing the overall
request.
The operation's success status for every single ShipmentOrder
will be returned by one CreationState element. It is identifiable via
SequenceNumber.
The identifier for the shipment for which the label url is
requested.
The version of the webservice implementation for which the
requesting client is developed.
Dial to determine label ouput format. Must be either 'URL' or 'B64' = Base64encoded: it is possible to request an URL for receiving the label as PDF stream, or to request the label as base64encoded binary data directly. If not defined by client, web service defaults to 'URL'.
The status of the operation and requested urls for getting the
label.
The version of the webservice implementation.
Success status after processing the overall
request.
For every ShipmentNumber requested, one LabelData node is
returned that contains the status of the label retrieval operation and
the URL for the label (if available).
The identifier for the shipment which should be
manifested.
The version of the webservice implementation for which the
requesting client is developed.
The identifier of the shipment. The shipment number is read
from ShipmentNumberType->shipmentNumber
The status of the operation
The version of the webservice implementation.
Status of the request (value of zero means, the request was
processed without error; value greater than zero indicates that an error
occurred).
The status of the operation for the corresponding
shipment.
The identifier for the shipment which should be
deleted.
The version of the webservice implementation for which the
requesting client is developed.
In order to delete previously created DD shipment orders,
ShipmentNumber. ShipmentNumber is required. This parent element inherits
from ShipmentNumberType, therefore all following subelements are valid
according to schema, however the web service accepts shipmentNumber
only. Note: you can delete more than one shipment by passing multiple
ShipmentNumber containers.
The status of the operation.
The version of the webservice implementation.
Success status after processing the overall
request.
For every ShipmentNumber requested, one DeletionState node is
returned that contains the status of the respective deletion
operation.
The identifier for the shipment for which the export document url is
requested.
The version of the webservice implementation for which the
requesting client is developed.
To request export documents, ShipmentNumber.
ShipmentNumber is required. This parent element inherits from
ShipmentNumberType, therefore all following subelements are valid
according to schema, however the web service accepts shipmentNumber
only.
Dial to determine label ouput format. Must be either 'URL' or 'B64' = Base64encoded: it is possible to request an URL for receiving the label as PDF stream, or to request the label as base64encoded binary data directly. If not defined by client, web service defaults to 'URL'.
The status of the operation and requested export
document.
The version of the webservice implementation.
Status of the request (value of zero means, the request was
processed without error; value greater than zero indicates that an error
occurred).
Contains the result of the document processing: in case of no
errors, a base64 encoded PDF is contained; also, the status of this
particular document generation and the passed shipment number are
returned.
The request data for the manifest document
The version of the webservice implementation for which the
requesting client is developed.
Date in format yyyy-mm-dd
The status of the operation and requested export
document.
The version of the webservice implementation.
Status of the request (value of zero means, the request was
processed without error; value greater than zero indicates that an error
occurred).
The Base64 encoded pdf data for receiving the
manifest.
The shipmentdata for creating a shipment.
The version of the webservice implementation for which the
requesting client is developed.
The ShipmentNumber of the shipment, which sould be updated.
ShipmentNumber is required. This parent element inherits from
ShipmentNumberType, therefore all following subelements are valid
according to schema, however the web service accepts shipmentNumber
only.
ShipmentOrder contains an update of all data of the selected
shipment order.
The status of the operation and the shipment identifier (if
available).
The version of the webservice implementation.
Success status after processing the overall
request.
The operation's success status for every single ShipmentOrder will be
returned by one UpdateState element. It is identifiable via ShipmentNumber.
The operation's success status for every single ShipmentOrder will be
returned by one CreationState element. It is identifiable via SequenceNumber.
Identifier for ShipmentOrder set by client application in
CreateShipment request. The defined value is looped through and returned
unchanged by the web service within the response of createShipment. The
client can therefore assign the status information of the response to the
correct ShipmentOrder of the request.
For successful operations, a shipment number is created and
returned. Depending on the invoked product.
The operation's success status for every single ShipmentOrder will be
returned by one CreationState element. It is identifiable via SequenceNumber.
Identifier for ShipmentOrder set by client application in
CreateShipment request. The defined value is looped through and returned
unchanged by the web service within the response of createShipment. The
client can therefore assign the status information of the response to the
correct ShipmentOrder of the request.
Success status of processing a particular shipment.
The status information used in different situations.
Overall status of the entire request: A value of zero means, the
request was processed without error. A value greater than zero indicates
that an error occurred. The detailed mapping and explanation of returned
status codes is contained in the list.
Explanation of the statuscode and potential errors.
Explanation of the statuscode and potential errors.
Information about each piece (e.g. the generated licence plate). For
every piece, a PieceInformation container holds the license plate
number.
For every piece a piece number is created that is of one of the
following types (mostly licensePlate).
Data for the creation of a shipment.
Free field to to tag multiple shipment orders individually by
client. Essential for later mapping of response data returned by webservice
upon createShipment operation. Allows client to assign the shipment
information of the response to the correct shipment order of the
request.
Is the core element of a ShipmentOrder.
It contains all relevant information of the shipment.
Contains the information of the shipment product
code, weight and size characteristics and services to be used.
Contains relevant information about
the Shipper.
Contains relevant information about
Receiver.
To be used if a return label address shall be generated.
For international shipments, this section contains
information about the exported goods relevant for customs. For
international shipments: commercial invoice, dispatch note (CP71) and
customs declaration (CN23) are printed into returned label information.
Data is also transferred as electronic declaration to customs.
For european shipments. For
international shipments, ExportDocument can contain one or more positions in child
element.
If set to true (=1), the label will be only be printable, if the
receiver address is valid.
Dial to determine label ouput format. Must be either 'URL' or 'B64' = Base64encoded: it is possible to request an URL for receiving the label as PDF stream, or to request the label as base64encoded binary data directly. If not defined by client, web service defaults to 'URL'.
Data for the creation of a shipment.
Free field to to tag multiple shipment orders individually by
client. Essential for later mapping of response data returned by webservice
upon createShipment operation. Allows client to assign the shipment
information of the response to the correct shipment order of the
request.
Is the core element of a ShipmentOrder.
It contains all relevant information of the shipment.
Contains the information of the shipment product
code, weight and size characteristics and services to be used.
Contains relevant information about
the Shipper.
Contains relevant information about
Receiver.
To be used if a return label address shall be generated.
For international shipments, this section contains
information about the exported goods relevant for customs. For
international shipments: commercial invoice, dispatch note (CP71) and
customs declaration (CN23) are printed into returned label information.
Data is also transferred as electronic declaration to customs.
For european shipments. For
international shipments, ExportDocument can contain one or more positions in child
element.
If set to true (=1), the label will be only be printable, if the
receiver address is valid.
The data of the shipper or return receiver.
Name of the Return Receiver
Contains address data.
Information about communication.
The data of the shipper of a shipment.
The receiver data.
The address data of the receiver.
The address of the receiver is a german Packstation.
The address of the receiver is a german Postfiliale.
The address of the receiver is a european Parcelshop.
Information about communication.
The receiver data of a shipment.
Identity data (used for ident services).
First name of the person to be verified. Field length must be
less than or equal to 30.
Last name of the person to be verified. Field length must be less
than or equal to 30.
Name of the street of registered address. Field length must be
less than or equal to 30.
House number of registered address. Field length must be less
than or equal to 10.
Postcode of registered address. Field length must be less than or
equal to 15.
City of registered address. Field length must be less than or
equal to 30.
Person's date of birth. Format must be yyyy-mm-dd.
Person's nationality. Field length must be less than or equal to
30.
Details of a shipment.
Determines the DHL Paket product to be ordered.
V01PAK: DHL PAKET;
V53WPAK: DHL PAKET International;
V54EPAK: DHL Europaket;
V06PAK: DHL PAKET Taggleich;
V06TG: Kurier Taggleich;
V06WZ: Kurier Wunschzeit;
V86PARCEL: DHL PAKET Austria;
V87PARCEL: DHL PAKET Connect;
V82PARCEL: DHL PAKET International
A reference number that the client can assign for better association purposes. Appears on shipment label.
Date of shipment should be close to current date and must not be
in the past. Iso format required: yyyy-mm-dd.
DHL account number (14 digits).
A reference number that the client can assign for better association purposes. Appears on return shipment label.
Details of a shipment.
extends the ShipmentDetailsType
For every parcel specified, contains weight in kg, length in cm, width in cm and height in cm.
Use one dedicated Service node for each service to be
booked with the shipment product. Add another Service node for
booking a further service and so on. Successful booking of a
particular service depends on account permissions and product's
service combinatorics. I.e. not every service is allowed for every
product, or can be combined with all other allowed services. The
service bundles that contain all services are the
following.
Mechanism to send notifications by email after successful
manifesting of shipment.
Bank data can be provided here for different purposes.
E.g. if COD is booked as service, bank data must be provided by DHL
customer (mandatory server logic). The collected money will be
transferred to specified bank account.
Item/Piece data.
The weight of the piece in kg
The length of the piece in cm.
The width of the piece in cm.
The height of the piece in cm.
Item/Piece data of a shipment.
GKV shipment services.
can be
Day of Delivery for product:
V06TG: Kurier Taggleich;
V06WZ: Kurier Wunschzeit
Timeframe of delivery for product:
V06TG: Kurier Taggleich;
V06WZ: Kurier Wunschzeit
Preferred Time of delivery for product:
V01PAK: DHL PAKET
V06PAK: DHL PAKET TAGGLEICH
Individual sender requirements for product:
V06TG: Kurier Taggleich
V06WZ: Kurier Wunschzeit
Service for package return.
Service of immediatly shipment return in case of
non sucessful delivery for product:
V06PAK: DHL PAKET TAGGLEICH
Service Notice of non-deliverability.
Shipment handling for product:
V06TG: Kurier Taggleich;
V06WZ: Kurier Wunschzeit
Service "Endorsement".
Service visual age check
Service preferred location
Service preferred neighbour
The details field should be set to the preferred neighbours name.
Service preferred neighbour
GoGreen
DHL Kurier Verderbliche Ware
Invoke service personal handover.
Invoke service No Neighbour Delivery.
Invoke service Named Person Only.
Invoke service return receipt.
Premium for fast and safe delivery of international
shipments.
Service Cash on delivery.
Insure shipment with higher than standard amount.
Service to ship bulky goods.
Service configuration for IdentCheck.
Indicates, if the option is on/off
Indicates, if the option is on/off
Details of the Service (freetext)
Indicates, if the option is on/off
Type of the Service (List of Types)
Indicates, if the option is on/off
Service endorsement is used to specify handling if recipient not met
There are the following types are allowed:
For Germany:
SOZU (Return immediately),
ZWZU (2nd attempt of Delivery);
for International:
IMMEDIATE (Sending back immediately to sender),
AFTER_DEADLINE (Sending back immediately to sender after expiration of time),
ABANDONMENT (Abandonment of parcel at the hands of sender (free of charge))
Indicates, if the option is on/off
Individual details for handling (freetext)
Indicates, if the option is on/off
Number of Days to hold shipment before shipment will be returend
to sender
Indicates, if the option is on/off
Service VisualCheckOfAge is used to specify the minimum age of the recipient
There are the following types are allowed:
• A16
• A18
Indicates, if the option is on/off
Timeframe of delivery, if the option is used: ValidValues are
10001200: 10:00 until 12:00;
12001400: 12:00 until 14:00
14001600: 14:00 until 16:00;
16001800: 16:00 until 18:00
18002000: 18:00 until 20:00;
19002100: 19:00 until 21:00
Indicates, if the option is on/off
Day of Delivery, if the option is used: Date in format
yyyy-mm-dd
Indicates, if the option is on/off
Please enter the Amount that should be insured
Indicates, if the option is on/off
Configuration whether the transmission fee to be added to the COD amount or not by DHL.
Select the option then the new COD amount will automatically printed on the shipping label and will transferred to the end of the day to DHL.
Do not select the option and the specified COD amount remains unchanged.
Money amount to be collected. Mandatory if COD is chosen.
Attention: Please add the additional 2 EURO transmittal fee when entering the COD Amount
Indicates, if the option is on/off
Indicates, if the option is on/off
Mandatory if unfree is chosen. 0= cash / 1=
invoice.
Paid by third party, e.g. Receiver. DHL account
number mandatory if PaymentType 1 = invoice is selected.
Field length must be less than or equal to 10.
Surname (family name) of the person for ident check.
Given name (first name) of the person for ident check.
date of birth (DOB) of the person for ident check,
if the option is used: Date in format yyyy-mm-dd
minimum age of the person for ident check
Indicates, if the option is on/off
Notification type
Email address of the recipient. If more than 70 characters are entered, the E-Mail address is automatically shortened and transferred. Mandatory if Notification is set.
The data of the export document for a shipment.
In case invoice has a number, client app can provide it in this
field.
Export type ("OTHER", "PRESENT", "COMMERCIAL_SAMPLE",
"DOCUMENT", "RETURN_OF_GOODS") (depends on chosen product -> only
mandatory for international, non EU shipments).
Description mandatory if ExportType is OTHER.
Element provides terms of trades,
incoterms codes:
DDP (Delivery Duty Paid)
DXV (Delivery duty paid (excl. VAT ))
DDU (DDU - Delivery Duty Paid)
DDX (Delivery duty paid (excl. Duties, taxes and VAT)
are vaild values.
PlaceOfCommital is a Locaton
Additional custom fees to be payed.
The permit number.
The attestation number.
Sets an electronic export notification.
One or more child elements for
every position to be defined within the Export Document.
Each one contains description, country code of origin, amount, net weight, customs value.
Multiple positions only possible for international shipments, other than EU shipments.
Description of the unit / position
Country's ISO-Code (ISO-2- Alpha) of the unit / position
Customs tariff number of the unit / position
Quantity of the unit / position
Net weight of the unit / position.
customs value amount of the unit / position
Person->salutation
Company Name 1 (mandatory): cis:NameType->Company->name1
Company Name 2 (optional) : cis:NameType->Company->name2
Contact Name (mandatory): cis:CommunicationType->contactPerson
Street Name (mandatory): cis:NativeAddressType->streetName
Street Number (mandatory): cis:NativeAddressType->streetNumber
Add. Address (optional) : cis:NativeAddressType->careOfName
Postcode (mandatory): cis:NativeAddressType->zip
City Name (mandatory): cis:NativeAddressType->city
ISO Country Code (mandatory): cis:NativeAddressType->Origin->CountryType->countryISOType
Phone Number (mandatory): cis:CommunicationType->phone
Email Address (mandatory): cis:CommunicationType->email
]]>
Mandatory if further address is to be specified.
Determines whether further address is one of the
following types.
Extra data for name extension.
Contains address data.
Info about communication.
The status of the getLabel operation and the url for requesting the label
(if available).
Success status of processing retrieval of particular shipment
label.
For successful and unsuccessful operations, the requested
ShipmentNumber of the label to be retrieved is returned. This is no matter
if it the operation could be performed or not.
If label output format was requested as 'URL' via
LabelResponseType, this element will be returned. It contains the URL to
access the PDF label. This is default output format if not specified other
by client in labelResponseType.
Depending on setting in customer profile all labels or just the shipmentlabel.
Label as base64 encoded pdf data,
depending on setting in customer profile all labels or just the shipmentlabel.
If label output format was requested as 'URL' via
LabelResponseType, this element will be returned. It contains the URL to
access the PDF label. This is default output format if not specified other
by client in labelResponseType.
Depending on setting in customer profile all labels or just the returnshipmentlabel.
Label as base64 encoded pdf data,
depending on setting in customer profile all labels or just the returnshipmentlabel.
If label output format was requested as 'URL' via
LabelResponseType, this element will be returned. It contains the URL to
access the PDF label. This is default output format if not specified other
by client in labelResponseType.
Depending on setting in customer profile all labels or just the export documents.
Label as base64 encoded pdf data,
depending on setting in customer profile all labels or just the export documents.
If label output format was requested as 'URL' via
LabelResponseType, this element will be returned. It contains the URL to
access the PDF label. This is default output format if not specified other
by client in labelResponseType.
Depending on setting in customer profile all labels or just the cod related documents.
Label as base64 encoded pdf data,
depending on setting in customer profile all labels or just the cod related documents.
The status of the getLabel operation and the url for requesting the label
(if available)
ShipmentNumber
Status of the request (value of zero means, the request was
processed without error; value greater than zero indicates that an error
occurred).
Export doc as base64 encoded pdf data
URL for downloading the Export doc as pdf
The status of a doManifest operation.
ShipmentNumber
Status of the request (value of zero means, the request was
processed without error; value greater than zero indicates that an error
occurred).
The status of a deleteShipment operation.
For successful and unsuccessful operations, the requested
ShipmentNumber to be deleted is returned. This is no matter if the operation
could be performed or not.
Success status of processing the deletion of particular
shipment.
The data for a pickup order.
The version of the webservice implementation for which the
requesting client is developed.
Contains information in further leaf elements about product,
DHL account, pickup date and time, pickup location, amount of pieces,
pallets, and shipments, moreover weight and volume weight, size.
The pickup address.
The address and contact information of the
orderer.
The data for a pickup order.
The version of the webservice implementation.
Success status after processing the request.
The confirmation number of the successfully created pickup
order. It can later be used for cancelling a pickup order. Confirmation
number is not available for each pickup type.
If available, a shipment number is returned.
The details of a pickup order.
Pickup date in format yyyy-mm-dd. Mandatory if pickup is booked
along with shipment order.
Earliest time for pickup. Format is hh:mm.
Lates time for pickup. Format is hh:mm.
Remarks to be considered when pickup is done.
Area to further detail pickup location beyond address.
Company->name1
Contact Name (mandatory): cis:CommunicationType->contactPerson
Street Name (mandatory): cis:NativeAddressType->streetName
Street Number (mandatory): cis:NativeAddressType->streetNumber
Add. Address (optional) : cis:NativeAddressType->careOfName
Postcode (mandatory): cis:NativeAddressType->zip
City Name (mandatory): cis:NativeAddressType->city
ISO Country Code (mandatory): cis:NativeAddressType->Origin->CountryType->countryISOType
Phone Number (mandatory): cis:CommunicationType->phone
Email Address (mandatory): cis:CommunicationType->email
]]>
Determines whether pickup address is one of the following
types.
Data fields for pickup address.
Info about communication.
Person->salutation
Company Name 1 (mandatory): cis:NameType->Company->name1
Company Name 2 (optional) : cis:NameType->Company->name2
Contact Name (mandatory): cis:CommunicationType->contactPerson
Street Name (mandatory): cis:NativeAddressType->streetName
Street Number (mandatory): cis:NativeAddressType->streetNumber
Add. Address (optional) : cis:NativeAddressType->careOfName
Postcode (mandatory): cis:NativeAddressType->zip
City Name (mandatory): cis:NativeAddressType->city
ISO Country Code (mandatory): cis:NativeAddressType->Origin->CountryType->countryISOType
Phone Number (mandatory): cis:CommunicationType->phone
Email Address (mandatory): cis:CommunicationType->email
]]>
Determines whether orderer contact address is of the following
type.
Optional name appendix.
Data fields for orderer's address.
Info about communication.
The data of the pickup order.
Depending on whether a DD pickup or TD pickup is invoked, this
field contains either the 10-digit EKP number (DD pickups) or the 9-digit
accountNumberExpress (TD pickups).
Pickup date in format yyyy-mm-dd.
Earliest time for pickup. Format is hh:mm.
Lates time for pickup. Format is hh:mm.
Remarks to be considered when pickup is done. Mandatory if 'TDI'
is selected.
Area to further detail pickup location beyond address. Mandatory
for TDN and TDI, optional for DDN and DDI.
Number of pieces to be picked up.
Number of pallets to be picked up.
The weight of all shipment's pieces in kg. Field length must be
less than or equal to 22.
Number of shipments to be picked up.
The total volumetric weight of all pieces in kg. Calculated by
piece = length x width x height in centimetres / 5000. Field length must be
less than or equal to 22.
The maximum length in cm.
The maximum width in cm.
The maximum height in cm.
The data for cancelling a pickup order.
The version of the webservice implementation for which the
requesting client is developed.
The confirmation number of the pickup order which should be
cancelled. Use value from pickup response attribute 'ConfirmationNumber'
to cancel respective pickup order. Note: only one pickup can be deleted
at a time.
The status of the cancel pickup operation.
The version of the webservice implementation.
Success status after processing the request.
Identity data (used e.g. for ident services)
If driving license shall be used for verifying
identity.
ID number of the driving license. Mandatory if
DrivingLicense is chosen as identity
instrument.
Name of certifying authority of the driving
license. Mandatory if DrivingLicense is chosen as identity
instrument.
If identity card shall be used for verifying
identity.
Number of the identity card. Mandatory if
IdentityCard is chosen as identity instrument. Field length
must be less than or equal to 20.
Name of certifying card authority. Mandatory if
IdentityCard is chosen as identity instrument. Field length
must be less than or equal to 30.
If a bank card shall be used for verifying
identity.
Type of bank card. Mandatory if BankCard is
chosen as identity instrument.
Number of bank card. Mandatory if BankCard is
chosen as identity instrument.
Name of bank. Mandatory if BankCard is chosen as
identity instrument.
Bank code. Mandatory if BankCard is chosen as
identity instrument.
Type of Packstation (Receiver is in Germany)
includes
Number of the packstation
Post Nummer of the receiver
Postcode
City name.
Type of Postfiliale (Receiver is in Germany)
includes
Number of the postfiliale
Post Nummer of the receiver
Postcode
City name.
Type of ParcelShop (Receiver is in Europe)
includes
Number of the ParcelShop
Name of street of the ParcelShop
House number of the ParcelShop
Postcode
City name.
The status of the operation and the shipment identifier (if
available).
The version of the webservice implementation.
Success status after processing the overall
request.
The operation's success status for every single ShipmentOrder
will be returned by one CreationState element. It is identifiable via
SequenceNumber.
The version of the webservice implementation for which the
requesting client is developed.
includes
The number of the major release. E.g. the '2' in version "2.1.".
The number of the minor release. E.g. the '1' in version "2.1.".
Optional build id to be addressed.