Shipment Validation Global response root element
The element contains the header information for the message. It is present in both the request and response XML message. The response element contains a complex datatype ServiceHeader
The RegionCode element indicates the shipment transaction originated from which region
The Note element is a complex element which consists of two child elements “ActionNote” and “Condition” element. The Note element is returned by the backend service while processing the Shipment validation request. The element is a mandatory element
The AirwayBillNumber element contains the DHL defines 10-digit waybill number. It is a mandatory field in the shipment validation response. If shipment validation request is successful, this is the actual waybill number assigned to the shipment
The DHLInvoiceLanguageCode identifies the Invoice Language code. It is a optional field
The DHLInvoiceType element identifies the type of invoice. It is a optional field
The BillingCode element identifies how the shipment is billed. It is a optional field
The CurrencyCode element identifies the shipment is billed in which currency
The CourierMessage element contains the courier message. It is an optional field
The DestinationServiceArea element contains the information of the shipment’s destination along with the facility code and the inbound sort code information
The OriginServiceArea element contains the information of the shipment’s origin along with the outbound sort code info
The PackageCharge element contains the package charge of the shipment. It is an optional field
The Rated element indicates whether shipment is rated or not. It is a mandatory field. Its value is either Y (Yes) or N (No). “N” indicates that no rates could be retrieved for the given search criteria. Value will be “N” for third party or receiver payment type. “N” value when shipper is payer indicates that rates could not be obtained because of system configuration or availability reasons
The ShipmentCharge element contains the shipment charge for the shipment. It is an optional field. This field will be filled if rated is ‘Y’
The shipmentcharges element consist of shipment details shipment charges. This element is optional
The WeightUnit element contains the unit by which the shipment weight is measured. It is a mandatory field
The ChargeableWeight element contains the weight that is used to calculate shipment charge. This is an optional field
The DimensionalWeight element contains the dimensional weight of the shipment. It is an optional field
The ReadyByTime element indicates the ready by time of the shipment
The PickupCharge element indicates pick up charges of the shipment
The CallInTime indicates the Callin time of the shipment
The DaysAdvanceNotice element indicates the advance days notice required for the shipment
The ConversionRate indicates the conversion rate of the shipment if any
Its value should be valid DHL Country/Region code. This element must be declared once in the response element. Please refer to the Reference Data (DHL Country/Region) for Country/Region codes
The Barcodes element contains the Barcode images for construction of Waybill and DHL Routing barcode. It is a mandatory field
Air Waybill Barcode
Origin Destination Barcode
Client ID Barcode
Barcode 2D
DHL Routing Barcode
No of pieces contained in shipment
The contents element contains the shipment content description. It is a mandatory field
This element identifies the reference information. It is an optional field
Consignee element contains the details of the Consignee (Receiver). This element should be declared once in the shipment validation response message
Shipper element contains the details of the Shipper. This element should be declared once in the Book Shipment validation Response message
This element contains the DHL account number. It is a mandatory field
This element contains the Customer ID
This element contains the date of the shipment. It is a mandatory field
The GlobalProductCode element contains the DHL Global product code for the shipment
The CustData element consists of customer data that required to be printed on shipment level in GLS transport label CI template
The SpecialService Element provides various special services for shipment. It is an optional field
The Billing element contains the billing information of the shipment
For non-domestic shipments, The Dutiable element provides informations which defines the types of duties to be levied
For non -domestic shipments, the ExportDeclaration element provides information which is used for export declarartion documents.It is a mandatory field
The NewShipper element indicates whether shipper is new or not. The valid values are Y (Yes) and N (No)
The DHL ISO Routing Barcode in plain text format. It contains destination Country/Region, destination zip code, transport products and associated product features
The DHL Routing barcode contains the data Identifier.The available values are 2L, 403
The Product content code indicates the DHL’s internal code of the product
The product short name indicates the type of the product name which the underlying transport service has been sold to the cusomter
The internal service code contains the DHL’s product handling relevant services or features
The delivery date code contains the date of delivery of the shipment
The delivery time code contains the time of delivery of the shipment
The Pieces element contains the License Plate information and barcode along with the piece details
The PLTStatus element indicates the shipper account’s PLT subscription status. The valid values are A, D and S.
For PLTStatus field value of 'A' – Active, it signifies it is a valid PLT registered customer and allowed to proceed for PLT shipment process.
For PLTStatus field value of 'D' – De-registered, XML-PI Shipment Validation service will stop the shipment processing and returned an error to the XML-PI client.
For PLTStatus field value of 'S' – Suspended, XML-PI Shipment Validation service will stop the shipment processing and return an error message to the XML-PI client.
The QtdSInAdCur element contains the multiple currency billing details returned for different billing role of shipment charges if available in DCT tariff. Note: For PLT shipment, it will be interface with DCT getQuote interface for tariff. For EU regular shipment, if it is switched to interface with DCT getQuote is configurable in XML Services application backend
The LabelImage element contains the GLS’s generated Global and Archive label image output if it is required by user via LabelImageFormat element in request XML
The ODDURLLink element contains the URL for the On Demand Delivery (ODD) page. This element is optional
The DGs element defines the details of the Dangerous Goods items that included in shipment
The Label element defines the required label template used and its customer’s barcode type, barcode code and barcode text if available in client’s request
Party that makes (or on whose behalf an agent or broker makes) the import declaration, and who is liable for the payment of duties (if any) on the imported goods. Normally, this party is named either as the consignee in the shipping documents and/or as the buyer in the exporter's invoice.
The party who is responsible for the legality of the shipment under applicable export control laws, which includes determining the proper export classification and authorization needed to ship the Items.The Exporter is usually the party who controls the transaction, acts as declarant in its own name and provides the corresponding instructions for the export, regardless of who files the export declaration. The Exporter may or may not be the Shipper.
The party that makes, offers or contracts to make a sale to an actual or potential buyer. Also called vendor.
The party responsible for the full or partial payment of associated charges/cost. There can be many payers related to the different elements linked to a Shipment (e.g Services, fiscal charges).