MyDHL API Reference Data Guide (2.13.1)
MyDHL API Reference Data Guide (2.13.1)
DOCUMENT CONTROL
REVISION HISTORY:
Version Release Date Comments
List of Reference Data supported for export declaration’s invoice and line
2.7.2 26/Feb/2023
item level’s reference type code and customs document type code.
1. Added Dangerous Goods Details used in Shipment POST method.
2. Added HTTP Response Status Codes section.
3. Added General Errors section.
4. Added Rating and Product API Errors section.
5. Added Rating and Product API Warnings section.
6. Added Electronic Proof of Delivery API Errors section.
7. Added Upload Image API Errors section.
8. Added Create Shipment API Errors section.
2.8.0 07/May/2023 9. Added Create Shipment API Warnings section.
10. Added Upload Invoice Data API Errors section.
11. Added Get Image API Errors section.
12. Added Tracking API Errors section.
13. Added Pickup API Errors section.
14. Added Identifier API Errors section.
15. Added Address API Errors section.
16. Added Address API Warnings section.
The information contained in this document is the property Deutsche Post DHL.
No part of its contents may be divulged to third parties without the express written approval of
DHL Express.
All rights reserved; no part of this document may be reproduced, stored in a retrieval
system, or transmitted in any form or by any other means, electronic, mechanical,
photocopying, recording otherwise without the prior written permission of DHL Express.
This document may not be lent, resold, hired out or otherwise disposed of by way of trade in
any form, binding or cover other than that in which it is published, without the prior written
permission of DHL Express.
This document contains (as detailed) the latest information received in time to be
incorporated for publication. However, DHL Express reserves the right to modify the
information contained herein without published notification.
Deutsche Post World Net offers no warranty, express or implied, regarding its accuracy,
sufficiency, merchantability, or fitness for any purpose of the information contained herein.
Any use made thereof is made entirely at the risk and for the account of the user.
The requirements and specifications outlined in this manual are governed by DHL’s Terms
and Conditions of Carriage, found on DHL’s website, www.DHL.com.
AUDIENCE
This document is intended to serve as a guide to assist DHL customers and third party
developers during the integration development process. The primary audience of this
document is intended to be a trading partner’s technical resources and internal MyDHL API
support staff.
CONTENT.........................................................................................................................................................5
Reference Data Guide ...................................................................................................................................6
1. exportDeclaration\invoice\customerReferences\typeCode ................................................6
2. exportDeclaration\customsDocuments\typeCode .................................................................7
3. exportDeclaration\lineitems\customerReferences\typeCode ............................................9
4. exportDeclaration\lineitems\customsDocuments\typeCode .......................................... 10
5. valueAddedServicesDefinition\dangerousGoods ................................................................ 12
6. HTTP RESPONSE STATUS CODES ............................................................................................ 13
7. GENERAL ERRORS ........................................................................................................................ 13
8. RATING AND PRODUCT API ERRORS ....................................................................................... 13
9. RATING AND PRODUCT API WARNINGS ................................................................................. 22
10. ELECTRONIC PROOF OF DELIVERY (EPOD) API ERRORS .............................................. 22
11. UPLOAD IMAGE API ERRORS ................................................................................................. 22
12. CREATE SHIPMENT API ERRORS .......................................................................................... 23
13. CREATE SHIPMENT API WARNINGS .................................................................................... 31
14. UPLOAD INVOICE DATA API ERRORS .................................................................................. 32
15. GET IMAGE API ERRORS ......................................................................................................... 33
16. TRACKING API ERRORS ........................................................................................................... 33
17. PICKUP API ERRORS ................................................................................................................ 34
18. IDENTIFIER API ERRORS ......................................................................................................... 36
19. ADDRESS API ERRORS ............................................................................................................ 36
20. ADDRESS API WARNINGS ...................................................................................................... 37
21. REFRENCE DATA API ERRORS............................................................................................... 37
Reference Data Guide
1. exportDeclaration\invoice\customerReferences\typeCode
Listed below are allowed invoice level reference type codes:
Reference
Description
type code
ACL Parent Shipment ID for BBX
CID Customer Identifier
CN Contract Number
CU Consignor reference number
ITN US Export declaration reference ID
MRN Movement Reference number
UCN Unique reference of a consignment (UCRN)
OID Order Number
PON Purchase Order Number
RMA RMA Number
AAM AWB Ref #
ABT Goods Declaration number
ADA Buyer Reference number
AES AES Post Clearance
AFD 1496 Item number
ANT Consignee Reference number
BKN Booking Number
BOL Bill of Lading Number
CDN Customs Declaration number
COD Cash On Delivery
DSC Weltpaket Reference
FF Freight forwarder's reference number
FN Freight bill number
FTR Post Clearance Exemption US
HWB Shipment Identifiers
IBC Inbound center reference number
IPP Insurance Policy Provider
LLR Load list reference
MAB Master Airwaybill Number
MWB MAWB Reference number
OBC Outbound center reference number
PD Vendor Reference Number
PRN Pickup request number
RTL Return Leg waybill number
SID Shipment ID 15 Digit CODA
SS Seller Reference number
SWN Original Waybill number (Return)
Note: Multiple unique reference number of ‘MRN’ reference type is allowed at Invoice Reference
Type level.
2. exportDeclaration\customsDocuments\typeCode
Listed below are allowed Customs document type codes:
Document
Description
Type Code
972 T2LF Dispense Paiement Droits
AHC Analysis and Health Certificate
ATA ATA Carnet
ATR Preference Certificate ATR
CHD CHED-D (Common Health Entry Document for Feed and Food of Non-Animal Origin
CHP CHED-P (Common Health Entry Document for Products)
CIT CITES Certificate
COO Generic Certificate of Origin
DEX Duty Exemption Certificate
EU1 Preference Certificate EUR1
EU2 Preferential Declaration of Origin on the Invoice - EUR2
EUS End Use Authorization
FMA Certificate of Origin (Form A)
PHY Phytosanitary Certificate
VET Veterinary Entry Document
VEX VAT Exemption Certificate
Document
Description
Type Code
CRL Control Document
CSD Consolidated Customs Entry
PCH Proof of Purchase
CI2 Export-only Invoice
CIV Customs Invoice Value
DOV Invoice
INV Commercial Invoice
PFI Pro-Forma
ALC Agricultural License
HLC Health Products Regulatory Authority (HPRA) Licensing Requirements
JLC Justice License
LIC Specific Export Licenses
LNP License or Permit
PLI Permits & Licenses
DLI Driver's License
NID National Identity Card
PAS Passport
CHA Power of Attorney
CPA Consignee Power of Attorney
POA Power of Attorney (Customer-based)
BEX Branch Letter of Exemption
DGD Dangerous Goods Declaration
IPA Intellectual Property Authorization
T2M T2M Transport Accompanying Document
TAD TAD Transport Accompanying Document T1
TCS Transportation Charges Statement
ROD Receipt on Delivery
EXL DCE Export of Customs Data
HWB House Waybill
ELP Export Licenses and Permits
3. exportDeclaration\lineitems\customerReferences\typeCode
Listed below are allowed item level reference type
codes:
Reference type
Description
Code
AFE Export Control Classification Number (ECCN)
AAJ Delivery Order number
ABW Stock Keeping Unit
ALX Model
BRD Brand
DGC Dangerous Goods Content Identifier
DTC DDTC Eligibility indicator
DTM DDTC UOM
DTQ DDTC Quantity
DTR DDTC Registraton No
INB In Bond shipment
ITR DDTC ITAR Exemption No
MAK Make
MID Manufacturers IDentification code
OED Original Export Date
OET Original Export OB Tracking ID
OID Order ID
OOR Original Outbound Carrier
PAN Part No
PON Purchase Order Number
SE Serial number
SON Sales order No
SME DDTC SME Indicator
USM DDTC USML Category Code
AAM AWB Ref #
CFR ECCN License Exemption (CFR#)
DOM Domestic indicator CoO (US)
FOR Foreign indicator CoO (US)
USG Usage
MAT Material
NLR ECCN No License Required Indicator
DDS Due Diligence Statement Reference Number
4. exportDeclaration\lineitems\customsDocuments\typeCode
Customs
Document Description
Type Code
972 T2LF Dispense Paiement Droits
AHC Analysis and Health Certificate
ATA ATA Carnet
ATR Preference Certificate ATR
CHD CHED-D (Common Health Entry Document for Feed and Food of Non-Animal Origin
CHP CHED-P (Common Health Entry Document for Products)
CIT CITES Certificate
COO Generic Certificate of Origin
DEX Duty Exemption Certificate
EU1 Preference Certificate EUR1
EU2 Preferential Declaration of Origin on the Invoice - EUR2
EUS End Use Authorization
FMA Certificate of Origin (Form A)
PHY Phytosanitary Certificate
Customs
Document Description
Type Code
VET Veterinary Entry Document
VEX VAT Exemption Certificate
CRL Control Document
CSD Consolidated Customs Entry
PCH Proof of Purchase
CI2 Export-only Invoice
CIV Customs Invoice Value
DOV Invoice
INV Commercial Invoice
PFI Pro-Forma
ALC Agricultural License
HLC Health Products Regulatory Authority (HPRA) Licensing Requirements
JLC Justice License
LIC Specific Export Licenses
LNP License or Permit
PLI Permits & Licenses
DLI Driver's License
NID National Identity Card
PAS Passport
CHA Power of Attorney
CPA Consignee Power of Attorney
POA Power of Attorney (Customer-based)
BEX Branch Letter of Exemption
DGD Dangerous Goods Declaration
IPA Intellectual Property Authorization
T2M T2M Transport Accompanying Document
TAD TAD Transport Accompanying Document T1
TCS Transportation Charges Statement
ROD Receipt on Delivery
EXL DCE Export of Customs Data
HWB House Waybill
ELP Export Licenses and Permits
5. valueAddedServicesDefinition\dangerousGoods
Content ID Content short description Service Code Service Name
(serviceCode)
(contentID)
969 Metal PI969 Section II (LiBa with HM Lithium Metal PI969 Section
equipment) II
966 Ion PI966 Section II (LiBa with HD Lithium Ion PI966 Section II
equipment)
Status
Description
Code
The request succeeded. The result meaning of "success" depends on the HTTP method: -
GET: The resource has been fetched and transmitted in the message body.
200
POST / PATCH: The resource describing the result of the action is transmitted in the
message body.
201 The request succeeded, and a new resource was created as a result.
The server cannot or will not process the request due to something that is perceived to be a
400 client error (e.g., malformed request syntax, invalid request message framing, or deceptive
request routing).
Although the HTTP standard specifies "unauthorized", semantically this response means
401
"unauthenticated". That is, the client must authenticate itself to get the requested response.
The client does not have access rights to the content; that is, it is unauthorized, so the
403 server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's
identity is known to the server.
The server cannot find the requested resource. In the browser, this means the URL is not
recognized. In an API, this can also mean that the endpoint is valid but the resource itself
404 does not exist. Servers may also send this response instead of 403 Forbidden to hide the
existence of a resource from an unauthorized client. This response code is probably the
most well known due to its frequent occurrence on the web.
422 The request was well-formed but was unable to be followed due to semantic errors.
500 The server has encountered a situation it does not know how to handle.
7. GENERAL ERRORS
Unexpected errors are handled with a standard error message. These error messages also
contain a process id number, which is used during troubleshooting or follow-up.
Error
Error Message
Code
999 Process failure occurred. Process ID associated for that transaction (<sessionID>)
9001 The x-version header value is invalid.
Warning
Warning Message
Code
200200 Duty calculation is not possible since full import HS code is not available.
200201 Landed cost is estimated based on full Import HS code retrieved from product catalogue.
200202 Ballpark landed cost is returned.
The provided HS code is not a valid full Import HS code. Ballpark landed cost is estimated
200203
using the provided 6-digit HS Code.
Provided Import HS code (full or 6-digit) is invalid. Landed cost is estimated based on full
200204
Import HS code retrieved from product catalogue.
200205 Provided Import HS code (full or 6-digit) is invalid. Ballpark landed cost is returned.
200030 Standard duty is not applicable (<INPUT HS CODE>).
200031 Standard duty is not applicable (<INPUT HS CODE>). This tariff code maybe prohibited.
Error
Error Message
Code
100000 Service operation execution finished successfully
100002 Service operation request message data validation failed
100010 When requesting ePod details account number and customer role must be provided
Error
Error Message
Code
803 Account not allowed for this service. Please contact your DHL Express representative.
996 The requested product(s) not available based on your search criteria.
Invalid typeCode #/customerDetails/{0}/registrationNumbers/{1}/typeCode: {2} is not a
997
valid value, please update and try again.
The shipment date cannot be in the past or more than 10 days in future. Please check the
998
shipment date and retry.
998 The account number is not found or invalid. Please check the account number and retry.
The account number is not allowed for PaperLessTrade. Please check the account number
998
and retry.
998 Process failure occurred. Process ID associated for that transaction (<Process ID>)
1001 The requested product(s) not available based on your search criteria.
1003 Pick-up service is not provided on this day.
1004 Product not available between this origin and destination.
Invalid combination of #/RequestValueAddedServices and #/getAdditionalInformation
6016
where typeCode=allValueAddedServices, please update and try again.
Requested services cannot be used together <followed by list of couples "service code –
6017
service code" separated by ", ">
Requested service XX requires also usage of one of following services < the XX will be
6018 replaced by Dependent service (service code) followed by list of Required services (service
codes) separated by ", ">
6019 RequestValueAddedServicesGroup cannot be used if request contains required service(s).
6020 Strict validation failed.
Requested service(s) requires usage of just ONE service from – followed by service-service
6021 group(s) violated, in from: (DependentService -> list of Required services separated by "-" –
each dependent group in separated in brackets e.g. (PZ -> PT-PU-PV-PW)
Document image data #/documentImages/0/content failed in validation due to wrong data.
7003
Please provide valid image instead of text data.
Signature image data in #/content/exportDeclaration/invoice/signatureImage failed in
7004
validation due to wrong data. Please provide valid image instead of text data.
Customer logo image data failed in validation due to wrong data. Please provide valid image
7005
instead of text data.
#/valueAddedServices/serviceCode must be set to "WY" or "PK" for Paperless Trade (PLT)
7007
shipment.
Requested product(s) not available with requested service(s) <followed by list of couples
7008
"products global/local code – service code" separated by ", ">
The '#/outputImageProperties/customerLogos/0/content' cannot be exceed <configurable
7009
logo image size>. Please check the Customer Logo image size and retry.
7011 Email address for shipment email notification is required. Please update and re-try.
You are not allowed to prepare Paperless Trade (PLT) shipment . Please contact your DHL
7012
account manager.
7013 Pickup is not allowed for this shipment date. Please update and re-try again.
Shipment consolidation is not possible for the shipper country. Please contact your DHL
7014
account manager.
DocumentImages cannot be provided with Packages (piece details) in request message.
7015
Please check the request message and retry.
Missing “IncludePreviousPieceLabels” in the request message. Please check the request
7016
message and retry.
Exceeded the maximum pieces allowed for a single shipment. Please check the request
7017
message and retry.
7018 Image Upload is not supported for non-PLT shipment.
7019 An email with invalid format has been provided. Please update and try again.
The Piece weight must be greater than <global or customer profile level> <global or
7022 customer profile level minimum weight>. Please update #/content/packages/0/weight
field value and try again.
The Customs Value must be greater than <global or customer profile level><global or
7023 customer profile level minimum weight>. Please update #/content/declaredValue field
value and try again.
The Paperless Trade (PLT) image file size of the export documentation is too large. Please
7024
ensure that this does not exceed ''{0}'' and is either a pdf, jpg or png file type.
Document image data #/documentImages/0/content cannot exceed <configurable
7025
document image size>. Please check the document image size and try again.
Failure to upload the Paperless Trade (PLT) image. Please check the document image and
7027
try again or contact your DHL technical representative.
Net weight value must be greater than <global or customer profile level> <global or
7028 customer profile level minimum weight>. Please update
#content/exportDeclaration/lineItems/0/weight/netValue field value and try again.
7029 Failure to send email.
Unsupported combination. #/outputImageProperties/allDocumentsInOneImage option is
7030
only allowed for PDF output types. Please update and try again.
7031 Image upload is not possible for this shipment at this point.
For #/outputImageProperties/imageOptions/0/typeCode = 'invoice' and
#/outputImageProperties/imageOptions/0/isRequested = 'true', then fields within
7032
#/content/exportDeclaration/invoice section are required. Please check the request
message and try again.
Packages section is required to be provided in the request message to perform shipment
7033
consolidation. Please check the request message and try again.
Unit Price value must be greater than <”global or customer profile level” + global or
7034 customer profile level minimum Customs Value>. Please update
#/content/exportDeclaration/lineItems/0/price field value and retry it again. ”
Shipment charges is mandatory for a CASH shipment. Please provide shipment charges and
7035
resubmit.
Request labels to fit A4 format is applicable for label type of PDF. Please update and re-try
7036
again
Customer is not allowed to request courier pickup. Please contact your DHL account
7037
manager.
Document image data #/documentImages/0/content failed in validation due to wrong data.
7057
Please provide valid image instead of text data.
Invalid unitOfMeasurement
7069 #/content/exportDeclaration/lineItems/{0}/quantity/unitOfMeasurement: {1} is not a valid
value, please update and try again.
Invalid typeCode #/content/customerDetails/{0}/typeCode: {1} is not a valid value, please
7070
update and try again.
Invalid typeCode #/content/exportDeclaration/customsDocuments/{0}/typeCode: {1} is
7071
not a valid value, please update and try again.
Invalid exportReasonType #/content/exportDeclaration/exportReasonType: {0} is not a
valid value, please update and try again.
7072
Invalid exportReasonType #/content/exportDeclaration/lineItems/{0}/exportReasonType:
{1} is not a valid value, please update and try again.
Duplicate values found in
7073 #/content/exportDeclaration/invoice/customerReferences/0/typeCode, please update and
try again
Invalid typeCode #/content/exportDeclaration/invoice/customerReferences/{0}/typeCode:
7074 {1} is not a valid value, please update and try again.
Duplicate values found in #/content/exportDeclaration/additionalCharges/0/typeCode,
7075
please update and try again.
Invalid typeCode #/content/exportDeclaration/additionalCharges/{0}/typeCode: {1} is not
7076
a valid value, please update and try again.
Duplicate values found in
7077 #/content/exportDeclaration/lineItems/0/customerReferences/0/typeCode, please update
and try again.
Invalid typeCode
7078 #/content/exportDeclaration/lineItems/{0}/customerReferences/{1}/typeCode: {2} is not a
valid value, please update and try again.
Invalid typeCode
7079 #/content/exportDeclaration/lineItems/{0}/customsDocuments/{1}/typeCode: {2} is not a
valid value, please update and try again.
Missing required field PlaceOfIncoterm #/content/exportDeclaration/placeOfIncoterm,
7080
please update and try again.
Missing required field typeCode
7082
#/content/exportDeclaration/additionalCharges/0/typeCode, please update and try again.
Element isRequested value "N" for typeCode value "label" is only valid for Label-Free
7083
Shipment
If using Label-Free template, please ensure to provide the DHL Express Label-Free Service
7084
code and Advance Shipment Service Code under #/valueAddedServices/0/serviceCode
For the feature "{0}" as LID, please ensure to provide the DHL Express Label-Free Service
7085 code under #/content/packages/0/customerReferences/0/typeCode
#/content/packages/0/customerReferences/0/value is not well formatted. (Expected
7086
Sample Format : 'DHL0123456789123YY')
You are not authorized to prepare Label-Free shipment. Please contact your DHL account
7087
manager.
If using label template for LBBX, the Parent Shipment\u0027s IdentificationNumber field is
7092 required: #/identifiers/0/value where #/identifiers/0/typeCode=\u0027parentId\u0027.
Please update the request and retry.
You are not authorized to prepare shipment with feature
7093
#/valueAddedServices/0/serviceCode = "PM". Please contact your DHL account manager.
ExportDeclaration cannot be provided with feature Service Type = ’PM’. Please check the
7094
request and retry.
ShipmentReference with ShipmentReferenceType = ‘CU’ is required for feature Service
7095
Type = ’PM’. Please check the request and retry.
The provided Shipment Identification Number is invalid. Please check the request message
7096
and retry.
Exceeded the maximum invoices allowed for a single shipment. Please check the request
7097
message and retry.
Duplicate values found in <xpath>/InvoiceNumber. Please check the request message and
7098
retry.
Missing the Shipper Reference in
7099 #/content/exportDeclaration/0/invoice/customerReferences/0/value with typeCode = ‘CU’
in request. Please check the request message and retry.
7100 Invalid value of country code in <xpath>. Please check the request message and retry.
7101 Invalid value NumberTypeCode <xpath>. Please update and try again.
Duplicate values found in
7104 #/content/exportDeclaration/0/invoice/customerReferences/0/typeCode, please update
and try again
Duplicate values found in #/content/exportDeclaration/0/additionalCharges/0/typeCode,
7107
please update and try again.
Missing line item Net weight or Gross Weight at <xpath>, please update the request and try
7114
again.
UploadCINData is not allowed for your username. Please contact your DHL sales
7115
representative.
7116 Duplicate values found in #/customerDetails/{0}/registrationNumbers/typeCode.
Provided Piece Identification Number Data Identifier is invalid. Please check the request
7118
message and retry.
7119 Invalid incoterm #/content/incoterm: {0} is not a valid value, please update and try again.
Required either #/outputImageProperties/imageOptions where typeCode=invoice or
7120
provide #/documentImages
#/content/exportDeclaration is mandatory when provided product is dutiable, please
7121
update and try again.
#/outputImageProperties/imageOptions/0/templateName where typeCode=invoice is not
7122
a valid value
You are not authorized to prepare shipment with serviceCode of {0}. Please contact your
7123
DHL account manager.
7124 Not authorized to bypass PLT Validation. Please contact your DHL Express representative.
Domestic shipment for Mexico is not allowed for your username. Please contact your DHL
7125
sales representative.
COMMERCIAL_INVOICE_P_10 or COMMERCIAL_INVOICE_L_10 must be used as the
Commercial Invoice Template #/outputImageProperties/imageOptions/0/templateName
7126
where typeCode=invoice for Import Customs Duties or Import Taxes to be shown in the
Commercial Invoice.
7127 Invalid value of country code in {role}. Please check the request message and retry.
7128 Invalid value found in #/customerDetails/{0}/registrationNumbers{0}/issuerCountryCode.
Country code in #/content/exportDeclaration/lineItems/{0}/manufacturerCountry: {1} is
7129
not a valid value, please update and try again.
The dangerous goods custom description(s) has exceeded the combined value of 200
7132
characters.
COMMERCIAL_INVOICE_P_10 or COMMERCIAL_INVOICE_L_10 must be used as the
Commercial Invoice Template #/outputImageProperties/imageOptions/{0}/templateName
7133
where typeCode=invoice for Import Customs Duties or Import Taxes to be shown in the
Commercial Invoice.
Duplicate values found in #/content/exportDeclaration/lineItems/number, please update
7136
and try again.
7139 Request message must contain content/declaredValueCurrency for declarable shipments.
7140 Request message must contain content/incoterm for declarable shipments.
7141 Request message must contain all precalculated value fields.
7142 Shipment data validation has failed, please contact customer support, or try again later.
Shipment description must contain at least 3 characters. Please update
7143
#/content/content/description field value and try again.
Export line item description must contain at least 3 characters. Please update
7144
#/content/exportdeclaration/lineitems/{0}/description field value and try again.
#/content/declaredValueCurrency is required if #/content/exportDeclaration or
7145
#/content/declaredValue is provided.
Field
ShipmentRequest/RequestedShipment/ShipmentInfo/DocumentImages/DocumentImage/
7146 DocumentImage or
ShipmentRequest/RequestedShipment/ShipmentInfo/LabelOptions/RequestDHLCustomsI
nvoice is mandatory when ServiceType is set as PJ.
The shipment description #/content/description <GSS-
7147 $.ShpPcdDetailsMsg.Bd.Shp[0].DatElGrp[n].DatEl.Val.$>. Please update the shipment
description and retry.
#/outputImageProperties/imageOptions/{0}/templateName where
7148
typeCode=shipmentReceipt is not a valid value.
#/outputImageProperties/imageOptions/{0}/typeCode=receipt and
7149 #/outputImageProperties/imageOptions/{1}/typeCode=shipmentReceipt cannot both have
isRequested=true set. Please check the request and try again.
Invalid value combination of languageCode, languageCountryCode and languageScriptCode
7150 provided in #/outputImageProperties/imageOptions/ where typeCode = 'shipmentReceipt'
provided, please update and try again.
#/outputImageProperties/splitDocumentsByPages=true required when
7151 #/getAdditionalInformation/typeCode='linkLabelsByPieces' is provided with
isRequested=true. Please check the request and try again.
#/outImageProperties/allDocumentsInOneImage option is not allowed when
7152 #/getAdditionalInformation/typeCode=linkLabelsByPieces is provided with
isRequested=true. Please check the request and try again.
#/content/packages/referenceNumber must be provided for all packages. Please check the
7153
request and try again.
Duplicate values found in #/content/packages/referenceNumber, please update and try
7154
again.
Line Item Description contains invalid characters. Characters which are not allowed are
7156
{0}. Please remove any invalid characters and try again.
You are not authorized to prepare shipment with feature Service Type = ‘{0}’. Please
7157
contact your DHL account manager.
8003 Account not allowed for this service. Please contact your DHL Express representative.
8003 Account not allowed for this service. Please contact your DHL Express representative.
8007 The Shipper Account is invalid.
8032 Not authorized to use this service. Please contact your DHL Express representative.
Product code provided not matching the account's network type code. Please update and
8035
try again.
8036 Product code is not allowed for account number’s network type code.
20001 Neither local nor Network Product Code is present.
20002 Origin country code is absent.
20003 Origin service area code is absent.
20004 Destination country code is absent.
20017 Neither destination postcode nor destination code is present.
30001 Maximum length of local specific code exceeded.
30002 Invalid postcode format.
40001 Product short name is not found.
40002 Product content code is not found.
40004 Destination code is not found
50003 More than one destination service area codes are found.
90001 Unclassified error.
90002 Invalid XML.
90003 Error while accessing the cache.
99999 GLS servers are not reachable.
100002 The Dangerous Goods Content ID requested is invalid. Please update and try again
The Dry Ice Net Weight is missing in the request for the Dangerous Goods Content ID: 901.
100002
Please update and try again.
The UN code is missing in the request for the Dangerous Goods Content ID: E01. Please
100002
update and try again
340001 The origin country code could not be found. Please check the country code.
340002 The destination country code could not be found. Please check the country code.
340003 The payment country code could not be found.
The location information is missing. At least one attribute post code, city name or suburb
340004
name should be provided
340005 The pickup date is missing. The pickup date is a mandatory field.
340006 The ready time is missing. This is a mandatory parameter.
340007 The commodity code could not be found, please check the commodity code.
340008 The piece weight is missing. This is mandatory information.
340009 The number of pieces is missing.
340010 The total shipment volume is missing.
340011 The maximum piece weight is missing.
340012 The maximum piece height is missing.
340013 The maximum piece length is missing.
340014 The maximum piece width/diameter is missing.
340015 The declared value is missing.
340016 The piece type is invalid.
340017 The unit of weight is missing.
340018 The declared value cannot exceed the limit set for the country.
340019 Unknown unit of measure for weight.
340020 Unknown unit of measure for dimensions.
340021 The currency is missing.
340022 The maximum piece weight is greater than the total shipment weight.
340023 Unknown currency symbol.
340024 The global or local product code(s) missing.
340025 The global or local service code(s) missing.
340026 Invalid combination of units of weight and dimension.
340027 Invalid product service combination.
340028 The unit of measure is missing.
340029 UOM should be same for all dimensions
340030 Unknown Generic Criteria code
340031 The format of the dimensions is not correct. Please check the dimensions format.
340032 The format of the weight is not correct. Please check the weight format.
340033 Invalid ready time format
340035 The unit of dimension is missing
340036 Outbound departure date should have format YYYY-MM-DD
340038 VLDPICKUP = N set in the request then Facility Departure Date should be part of request
VLDPICKUP = Y set in the request then Facility Departure Date should NOT be part of
340039
request
340040 The only allowed operators are 'eq'- equal, 'ge' - greater than or equal, 'gt' - greater than
340041 Generic criterion OSINFO cannot be used if request contains required service(s)
400201 Failure during booking
400202 Missing field(s)",
400203 Error occurred while creating GNS521 file
400204 Error while uploading manifest file to FTP server
400205 Error while transforming result to XML
410101 The shipment weight exceeds max
410102 The shipment height exceeds max
410103 The shipment length exceeds max
410104 The shipment width/diameter exceeds max
410105 The requested product(s) not available
410106 The piece weight exceeds max
410107 The piece height exceeds max
410108 The piece length exceeds max
410109 The piece width/diameter exceeds max
410110 The shipment weight exceeds min
410111 The shipment height exceeds min
410112 The shipment length is not within the restrictions
410113 The shipment width/diameter under min
410114 The min piece dimension not reached
410115 The mid piece dimension not reached
410116 The max piece dimension not reached
410117 The minimum piece weight not met
410118 Number of pieces exceeded
410119 The min shipment dimension not reached
410120 The mid shipment dimension not reached
410121 The max shipment dimension not reached
410122 The minimum shipment weight not met
410123 The max shipment declared value exceeded
410124 Geographical market rule applied
410125 Minimal inbound currency value not met
410126 Maximum inbound currency value exceeded
410127 Minimum number of pieces not met
410128 Minimal outbound currency value not met
410129 Maximum outbound currency value exceeds
410130 Minimal number of pallet not met
410131 Maximum number of pallet exceeds
410132 Minimal pallet weight not met
410133 Maximum pallet weight exceeds
410134 The max(length; width; height) piece exceeds max
410135 Requested product(s) not available at origin <list of products global/local separated by ", ">
Requested product(s) not available at destination <list of products global/local separated
410136
by ", ">
Product filtered out on delivery side because actual delivery time configured in TTS is
410137
greater than marketed delivery time configured in GREF <list of products separated by ", ">
410138 Requested product(s) not available at payer <list of products global/local separated by ", ">
Requested product(s) available only with contractual agreement <list of products
410139
global/local separated by ", ">
Requested product(s) not available in required network <list of products global/local
410140
separated by ", ">
Requested product(s) not available with requested service(s) – followed by list of couples
410145
"products global/local code – service code" separated by ", "
Requested services cannot be used together <followed by list of couples "service code –
410146
service code" separated by ", ">
Requested service XX requires also usage of one of following services < the XX will be
410147 replaced by Dependent service (service code) followed by list of Required services (service
codes) separated by ", ">
410201 Pick-up service is not provided on this day.
410202 The pickup date is outside of sliding window: dateFrom-dateTo
410203 Ready time is outside of pickup window
410301 Product not available between this origin and destination (network segment).
410302 Temporary network target change
410303 Avaliable products removed by Marketed filtering
410304 No products available
410501 Pickup PL ambiguity rule applied. More than 1 PL is available for the given PL attributes.
410502 Pickup PL fallback rule applied : PS->CP
410503 Pickup PL fallback rule applied : PS->CP->P
410504 Pickup PL fallback rule applied : PS->CP->P->C
410505 Pickup PL fallback rule applied : CP->P
410506 Pickup PL fallback rule applied : CP->P->C
410507 Pickup PL fallback rule applied : P->C
410508 Pickup PL fallback rule applied : S->C
410509 Delivery PL ambiguity rule applied. More than 1 PL is available for the given PL attributes.
410510 Delivery PL fallback rule applied : PS->CP
410511 Delivery PL fallback rule applied : PS->CP->P
410512 Delivery PL fallback rule applied : PS->CP->P->C
410513 Delivery PL fallback rule applied : CP->P
410514 Delivery PL fallback rule applied : CP->P->C
410515 Delivery PL fallback rule applied : P->C
410517 The origin facility is suspended
410518 The destination facility is suspended
Booking adapter error response failure PU009a, 'Pickup NOT scheduled. There is no
410928
weekend pickup service at the location.
Booking adapter error response failure PU003, Routing Service could not determine Origin
410928
Service Area. No pickup scheduled
Booking adapter error response failure PU004, Account number or account type is some
410928 type of external billing account. Pickup Service requires a domestically billed shipper
account. No pickup scheduled
Booking adapter error response failure PU005, Account number is not found in IBS records.
410928
No pickup scheduled
Booking adapter error response failure PU007a, Account numberspecified has a credit
410928
status of CUTDirected to IBS. No pickup scheduled
Booking adapter error response failure PU007b, Account number does not have a credit
410928
standing of "good standing" or "removed from credit suspension" No pickup scheduled
Booking adapter error response failure PU009a, The pickup date is a weekend at the origin
410928
service area that has no pickup service. No pickup scheduled
Booking adapter error response failure PU009b, The Pickup Ready-by time from the client
410928 is before the Station Pickup start time or after the Station Pickup end time. No pickup
scheduled
Booking adapter error response failure PU009c, The pickup date is a holiday at (origin
410928
service area). No pickup scheduled
Booking adapter error response failure PU011a, The pickup request time is less than 1 hour
410928
of the station pickup end time. No pickup scheduled.
Booking adapter error response failure PU011b, At least one day of advance notice is
410928
required for pickup at <location>. Sufficient notice not provided. No pickup scheduled
Booking adapter error response failure PU012, Ready by time is past the station ready by
410928
cutoff of <x>. No pickup scheduled.
Booking adapter error response failure PU013a, Insufficient time between pickup request
410928
time and pickup end time. Pickups require at least one hour before station pickup end time.
Booking adapter error response failure PU013b, Insufficient time between (current time),
410928 and (closing time). A business pickup requires one hour. A residence pickup requires two
hours.
411402 ShipmentManifest consumer timed out.
420501 The origin country code could not be found. Please check the country code.
420502 The destination country code could not be found. Please check the country code.
420503 The payment country code could not be found.
420504 The origin location is invalid. Please check the data.
420505 The destination location is invalid. Please check the data.
420506 Postcode not found. Expected formats: <country specific post code format>
Warning
Warning Message
Code
Provided BypassPLTError is ignored. Your username is setup for no products and services
7986
validation.
7986 Shipment description(s) not validated.
Provided BypassPLTError is ignored. Please provide ServiceType value as WY to bypass
7987
PLT lane validation.
Please note on printing the hardcopy of all the shipment paperwork and affix it to the
7988
package.
Please note on printing the hardcopy of all the shipment paperwork and affix it to the
7988
package.
Provided Piece Identification Number Data Identifier is ignored. Please provide
7989
UseOwnPieceIdentificationNumber value as Y to use own piece identification number.
Rendered commercial invoice PDF can only print certain number of shipping roles and
7990
addresses.
7991 Rate Request service failure. No charges returned in response message.
7992 State or Province code has been replaced to valid GREF State or Provicen Code.
7993 No Estimated Delivery Date details returned in response message.
7994 Transliteration texts is not supported for the requested Shipper's Country Code.
7995 No charges returned in response message.
7996 Shipment's destination country is not On Demand Delivery deployed country.
Shipment Waybill Number, Origin Service Area Code, Destination Service Area Code or
7997
Shipper Account Number value is not available in request message. Please re-check.
Account not white-listed for this On Demand Delivery service. Please contact your DHL
7998
account manager.
7999 Incorrect ODD request type is provided. Please re-check the generic type.
Error
Error Message
Code
The provided Shipment Identification Number is invalid. Please check the request message
7096
and retry.
Exceeded the maximum invoices allowed for a single shipment. Please check the request
7097
message and retry.
Duplicate values found in #/content/exportDeclaration/${indexValue}/invoice/number.
7098
Please check the request message and retry.
Missing the Account Number and Shipper Reference in
7099 #/content/exportDeclaration/${indexValue}/invoice/customerReferences/0/value with
typeCode = 'CU' in request. Please check the request message and retry.
7100 The #/customerDetails/{0}/postalAddress/countryCode value provided is invalid.
Duplicate values found in
7104 #/content/exportDeclaration/{0}/invoice/customerReferences/{1}/typeCode, please
update and try again.
Duplicate values found in
7107 #/content/exportDeclaration/{0}/additionalCharges/{1}/typeCode, please update and try
again.
Duplicate values found in
7111 #/content/exportDeclaration/{0}/lineItems/{1}/customerReferences/{2}/typeCode, please
update and try again.
Missing Net Weight or Gross Weight in
7114 #/content/exportDeclaration/{0}/lineItems/{1}/weight, please update the request and try
again.
UploadInvoiceData is not allowed for your username. Please contact your DHL sales
7115
representative.
7117 Duplicate values found in #/customerDetails/{0}Details/registrationNumbers/typeCode.
The #/customerDetails/{0}/registrationNumbers/{1}/issuerCountryCode value provided is
7130
invalid.
The #/content/exportDeclaration/[{0}]/lineItems/[{1}]/manufacturerCountry value
7131
provided is invalid
COMMERCIAL_INVOICE_P_10 or COMMERCIAL_INVOICE_L_10 must be used as the
Commercial Invoice Template
7133 UploadInvoiceDataRequest/InvoiceData/ShipmentInfo/OutputImageOptions/CustomsInvoi
ceTemplate for Import Customs Duties or Import Taxes to be shown in the Commercial
Invoice.
Child nodes exceed limit ---
7135 UploadInvoiceDataRequest/InvoiceData/ExportDeclarations/ExportDeclaration[{0}]/Invoic
eReferences/InvoiceReference, please update and try again.
Duplicate values found in #/content/exportDeclaration/lineItems/number, please update
7137
and try again
7141 Request message must contain all precalculated value fields.
8007 ERROR: The Shipper Account is invalid. Please use a valid Shipper account and retry.
Error
Error Message
Code
The provided Shipment Identification Number is invalid. Please check the request message
1501
and retry.
1502 Number of typeCode parameters exceeded maximum limit. Please update and try again.
1504 No document images found for the provided search criteria.
1505 Unable to query document due to shipment data not found.
encodingFormat TIFF is not applicable in combination with allInOnePDF = true. Please
1506
check the request message and retry.
The provided DocumentTypeName[n] is invalid. Please check the request message and
1507
retry
Incomplete parameters to retrieve Customs Entry. Please contact your DHL Express
1508
representative
The provided DocumentTypeName is not allowed for this user. Please contact your DHL
1509
Express representative.
8001 The account number is not found or invalid. Please check the account number and retry.
8003 Account not allowed for this service. Please contact your DHL Express representative.
8032 Not authorized to use this service. Please contact your DHL Express representative.
Error
Error Message
Code
801 The account number is not found or invalid. Please check the account number and retry.
8032 Not authorized to use this service. Please contact your DHL Express representative.
- No Shipments Found for ReferenceID | <shipmentReference>
You do not have the necessary permissions to view controlled access data for this shipment.
1011
If you believe this is an error, please contact your DHL Express representative.
Parameter requestControlledAccessData is not allowed for your username. Please contact
1012
your DHL Express representative.
Error
Error Message
Code
The pickup request is past the booking cutoff time for the pickup location (this includes
5001
taking the time zone into consideration if applicable).
The Pickup time window for a collection to take place is too small (Pickup Location close
5002
time – PickupTimestamp).
The Pickup time window overlap is too small. Please ensure that the overlap between your
5003 provided request and the courier pickup window has the minimum required Pickup Time
window overlap.
5004 The pickup request must be at least {X hrs} before the provided PickupLocationClose time.
The minimum pickup time window overlap for your requested origin is a minimum of {X}
minutes with a same day pickup initiated latest by {A} today. Please note that couriers are
5005
available for a pickup at the requested origin between {B} and {C}. Times are based on the
origin timezone.
5006 Pickup is not allowed for this shipment date. Please update and re-try again.
Recipient address is required for remote booking request. Please provide the Recipient
5007
section and retry.
UnitOfMeasurement is required for booking request. Please provide the
5008
UnitOfMeasurement and retry.
Pickup/Contact/CompanyName is required for booking request. Please provide the
5010
CompanyName and retry.
Recipient/Contact/CompanyName is required for booking request. Please provide the
5012
CompanyName and retry.
At least one piece details is required for booking request. Please provide the Packages
5013
section and retry.
5018 Account number must be provided to the booking request.
5019 The shipment date cannot be in the past. Please check the shipment date and retry.
The shipment date cannot be more than 10 days in future. Please check the shipment date
5020
and retry.
5021 Pickup Location Close Time is not well formatted.(Expected Sample Format : '17:10')
Pickup Time Stamp is not well formatted.(Expected Sample Format : '2010-02-
5022
11T17:10:09 GMT+01:00’)
The Pickup Location Close Time cannot be earlier than Shipment Time. Please check the
5023
request and retry.
For Remote Booking, Shipper/Pickup Country Code must be different from Booking
5024
Requestor Country Code. Please check the request message and retry.
5555 Update of booking was not successful. Requested Pickup was not found.
The Original Shipper Account Number must match with the Shipper Account Number used
5556 previously to create/update successful pickup request. Please check the Original Shipper
Account Number and retry.
The Original Shipper Account Number element is mandatory. Please provide the
5557
updatePickupRequest/OriginalShipperAccountNumber and retry.
8003 Account not allowed for this service. Please contact your DHL Express representative.
8003 Account not allowed for this service. Please contact your DHL Express representative.
8032 Not authorized to use this service. Please contact your DHL Express representative.
8032 Not authorized to use this service. Please contact your DHL Express representative.
201003 The input message has missing Account Number
201004 The input message has missing Pickup Country
201009 The input message has missing Pickup Route
201019 The input message has missing GMT offset
201045 The input message has missing Pickup Date
201049 The input message has missing company name
201050 The input message has missing Telephone
201055 The input message has missing application name
201056 The input message has missing pickup service area
201067 The input message has missing address
201071 The input message has missing ready time
201110 The input message has missing delivery address
201111 The input message has missing delivery telephone number
201112 The input message has missing delivery company name
201113 The input message has missing delivery contact person name
201114 The input message has missing delivery country code
201115 The input message has missing destination Service Area
201118 The input message has missing default payment type
201200 Either pickup route or sector should be present
201204 The input message has missing close time
201206 The input message has missing payer account number
201210 The input message has missing requestor address
201211 The input message has missing requestor city
201212 The input message has missing requestor company name
201213 The input message has missing requestor contact person name
201216 The input message has missing requestor telephone number
201217 The input message has missing booking event state code
201218 The input message has missing Payer (Billing) Country
202003 The input message has invalid Account Number
202004 The input message has invalid Pickup Country
202007 The input message has invalid Account Sequence
202009 The input message has invalid Pickup Route
202012 The input message has invalid Service Area
202019 The input message has invalid GMT Offset
202023 The input message has invalid local product code
202024 The input message has invalid Dest Service Area
202025 The input message has invalid Dest Facility
202044 The input message has invalid Number Of Pieces
202048 The input message has invalid Facility
202062 There are not enough characters in Contact Person
202064 The input message has invalid Pickup Type
202067 The input message has invalid City
202072 The input message has invalid Default Pay Type
202073 The input message has invalid Payer (Billing) Country
202110 Close Time must be later than ready time
202113 Phone Number Length below Minimum Supported Length
202114 Pickup date is a holiday for country XX
202115 Ready time cannot be greater than close time
202118 The input message has invalid piece type
202121 The input message has invalid weight/length unit
202122 The difference between ready time and close time must be at least XX minutes
202123 Account payment is not allowed for stopped credit customer
202124 Remote Booking can only be made by IMP Account
202128 The Pickup date is earlier than the current date
202129 The input message has invalid delivery country code
202131 Account payment is not allowed for cut credit customer
202132 Account payment is not allowed for cash customer
202137 Total shipments value exceeded 99999999.999
202140 Remote Booking is not supported by this interface, please contact CS Advisor
202141 Invalid payer account number
202401 No billing address found
202405 No pickup address found
Error
Error Message
Code
801 The account number is not found or invalid. Please check the account number and retry.
Error
Error Message
Code
3001 The identified service area for the given address is currently suspended.
3002 The identified service area for the given address is currently unavailable.
3003 The identified service area for the given address is not yet open.
3004 The identified service area for the given address is closed.
3005 The identified service area for the given address has an unknown status.
3006 The origin country code could not be found. Please check the country code.
3007 The origin/destination location is invalid. Please check the data.
3008 PostalCode not found. Expected formats: <country-specific post code format.>
3009 Address validation failed.
3010 At least a City or PostalCode must be provided in the request.
3011 Service is unavailable for the given origin address.
8003 Account not allowed for this service. Please contact your DHL Express representative.
8032 Not authorized to use this service. Please contact your DHL Express representative.
20. ADDRESS API WARNINGS
The following table contains the possible warnings for Address API.
Warning
Warning Message
Code
3998 Partial match result found.
3999 Multiple matches found.
Error
Error Message
Code
5025 Parameters not having correct format: datasetName (valid parameters for datasetName
are [value from configuration list] )
Parameters not having correct format: filterByAttribute is invalid for datasetName [value of
provided datasetName] (valid parameters for datasetName are [value from configuration
5026 list] )
Parameters not having correct format: comparisonOperator is not supported for
5027 datasetName [value of provided datasetName]
Parameters not having correct format: filterByValue and filterByAttribute must be provided
5028 together
Parameters not having correct format: queryString must be provided in format
5029 [filterByAttribute:filterByValue:comparisonOperator]
5030 No reference data found
5031 Too many filter parameters
5032 Not authorized to use this service. Please contact your DHL Express representative.
Requested datasetName is not allowed for your username. Please contact your DHL
5033 Express representative.
Parameters not having correct format: filterByAttribute within the queryString is invalid for
datasetName [value of provided datasetName] (valid parameters for datasetName are
5034 [value from configuration list] )
Parameters not having correct format: comparisonOperator within the queryString is not
5035 supported for datasetName [value of provided datasetName]
Query Parameter name(s) not having correct format (valid query parameter names are
5036 [value from configuration list] )
Parameters not having correct format: datasetName=all cannot be used in combination
5037 with other query parameters.
5038 Missing mandatory parameter: datasetName