POST /shipments
Create Shipment
The ShipmentRequest Operation will allow you to generate an AWB number and piece IDs, generate a shipping label, transmit manifest shipment detail to DHL, and optionally book a courier for the pickup of a shipment. The key elements in the response of the Shipment Request will be a base64 encoded PDF label and the Shipment and Piece identification numbers, which you can use for tracking on the DHL web site. While the RateRequest and ShipmentRequest services can be used independently, DHL recommends the use of RateRequest to first validate the products available for the shipper/receiver. The global product codes which are output during the RateResponse can be used directly as input into the Shipment Request, as both perform similar validations in terms of service capability.
Servers
- https://api-mock.dhl.com/mydhlapi
- https://express.api.dhl.com/mydhlapi/test
- https://express.api.dhl.com/mydhlapi
Request headers
Name | Type | Required | Description |
---|---|---|---|
Plugin-Version |
String | No |
Please provide version of the plugin (applicable to 3PV only) |
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Shipping-System-Platform-Version |
String | No |
Please provide version of the shipping platform (applicable to 3PV only) |
Webstore-Platform-Version |
String | No |
Please provide version of the webstore platform (applicable to 3PV only) |
Message-Reference-Date |
String | No |
Optional reference date in the HTTP-date format https://tools.ietf.org/html/rfc7231#section-7.1.1.2 |
Webstore-Platform-Name |
String | No |
Please provide name of the webstore platform (applicable to 3PV only) |
Shipping-System-Platform-Name |
String | No |
Please provide name of the shipping platform(applicable to 3PV only) |
Message-Reference |
String | No |
Please provide message reference |
Plugin-Name |
String | No |
Please provide name of the plugin (applicable to 3PV only) |
Query parameters
Name | Type | Required | Description |
---|---|---|---|
strictValidation |
Boolean | No |
If set to true, indicate strict DCT validation of address details, and validation of product and service(s) combination provided in request. Default value: false |
bypassPLTError |
Boolean | No |
Option to bypass PLT - WY service code lane capability validation |
validateDataOnly |
Boolean | No |
If set to true, indicate to perform shipment data compliant validation on the shipment information. Default value: false |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
estimatedDeliveryDate |
Object | No |
Estimated delivery date option for QDDF or QDDC. |
estimatedDeliveryDate.isRequested |
Boolean | Yes |
Please indicate if requesting to get EDD for this shipment. Estimated Delivery Date Type. QDDF: is the fastest transit time as quoted to the customer at booking or shipment creation. When clearance or any other non-transport operational component is expected to impact transit time, QDDF does not constitute DHL's service commitment. QDDC: cconstitutes DHL's service commitment as quoted at booking or shipment creation. QDDC builds in clearance time, and potentially other special operational non-transport component(s), when relevant. Default value: false |
estimatedDeliveryDate.typeCode |
String | No |
Please indicate the EDD type being requested Possible values:
|
customerDetails |
Object | Yes |
Here you need to define all the parties needed to ship the package |
customerDetails.buyerDetails |
Object | No |
Please enter address and contact details related to buyer |
customerDetails.buyerDetails.postalAddress |
Object | Yes | |
customerDetails.buyerDetails.postalAddress.addressLine3 |
String | No |
Please enter address line 3 |
customerDetails.buyerDetails.postalAddress.countyName |
String | No |
Please enter your suburb or county name |
customerDetails.buyerDetails.postalAddress.provinceName |
String | No |
Please enter your state or province name |
customerDetails.buyerDetails.postalAddress.postalCode |
String | Yes |
Please enter your postcode or leave empty if the address doesn't have a postcode |
customerDetails.buyerDetails.postalAddress.cityName |
String | Yes |
Please enter the city |
customerDetails.buyerDetails.postalAddress.provinceCode |
String | No |
Please enter your province or state code |
customerDetails.buyerDetails.postalAddress.countryName |
String | No |
Please enter your country name |
customerDetails.buyerDetails.postalAddress.countryCode |
String | Yes |
Please enter ISO country code |
customerDetails.buyerDetails.postalAddress.addressLine1 |
String | Yes |
Please enter address line 1 |
customerDetails.buyerDetails.postalAddress.addressLine2 |
String | No |
Please enter address line 2 |
customerDetails.buyerDetails.typeCode |
String | No |
Please enter the business party type of the buyer Possible values:
|
customerDetails.buyerDetails.bankDetails[] |
Array | No | |
customerDetails.buyerDetails.bankDetails[].settlementForeignCurrency |
String | No |
To be mapped in commercial Invoice - Russia Bank Settlement Account Number in RUR field |
customerDetails.buyerDetails.bankDetails[].name |
String | No |
To be mapped in commercial Invoice - Russia Bank Name field |
customerDetails.buyerDetails.bankDetails[].settlementLocalCurrency |
String | No |
To be mapped in commercial Invoice - Russia Bank Settlement Account Number in RUR field |
customerDetails.buyerDetails.registrationNumbers[] |
Array | No | |
customerDetails.buyerDetails.registrationNumbers[].issuerCountryCode |
String | Yes |
Please enter 2 character code of the country where the Registration Number has been issued by |
customerDetails.buyerDetails.registrationNumbers[].typeCode |
String | Yes |
VAT, Value-Added tax Possible values:
Default value: "VAT" |
customerDetails.buyerDetails.registrationNumbers[].number |
String | Yes |
Please enter registration number |
customerDetails.buyerDetails.contactInformation |
Object | Yes | |
customerDetails.buyerDetails.contactInformation.companyName |
String | Yes |
Please enter company name |
customerDetails.buyerDetails.contactInformation.email |
String | No |
Please enter email address |
customerDetails.buyerDetails.contactInformation.phone |
String | Yes |
Please enter phone number |
customerDetails.buyerDetails.contactInformation.mobilePhone |
String | No |
Please enter mobile phone number |
customerDetails.buyerDetails.contactInformation.fullName |
String | Yes |
Please enter full name |
customerDetails.exporterDetails |
Object | No |
Please enter address and contact details related to exporter |
customerDetails.exporterDetails.postalAddress |
Object | Yes | |
customerDetails.exporterDetails.postalAddress.addressLine3 |
String | No |
Please enter address line 3 |
customerDetails.exporterDetails.postalAddress.countyName |
String | No |
Please enter your suburb or county name |
customerDetails.exporterDetails.postalAddress.provinceName |
String | No |
Please enter your state or province name |
customerDetails.exporterDetails.postalAddress.postalCode |
String | Yes |
Please enter your postcode or leave empty if the address doesn't have a postcode |
customerDetails.exporterDetails.postalAddress.cityName |
String | Yes |
Please enter the city |
customerDetails.exporterDetails.postalAddress.provinceCode |
String | No |
Please enter your province or state code |
customerDetails.exporterDetails.postalAddress.countryName |
String | No |
Please enter your country name |
customerDetails.exporterDetails.postalAddress.countryCode |
String | Yes |
Please enter ISO country code |
customerDetails.exporterDetails.postalAddress.addressLine1 |
String | Yes |
Please enter address line 1 |
customerDetails.exporterDetails.postalAddress.addressLine2 |
String | No |
Please enter address line 2 |
customerDetails.exporterDetails.typeCode |
String | No |
Please enter the business party type of the exporter Possible values:
|
customerDetails.exporterDetails.bankDetails[] |
Array | No | |
customerDetails.exporterDetails.bankDetails[].settlementForeignCurrency |
String | No |
To be mapped in commercial Invoice - Russia Bank Settlement Account Number in RUR field |
customerDetails.exporterDetails.bankDetails[].name |
String | No |
To be mapped in commercial Invoice - Russia Bank Name field |
customerDetails.exporterDetails.bankDetails[].settlementLocalCurrency |
String | No |
To be mapped in commercial Invoice - Russia Bank Settlement Account Number in RUR field |
customerDetails.exporterDetails.registrationNumbers[] |
Array | No | |
customerDetails.exporterDetails.registrationNumbers[].issuerCountryCode |
String | Yes |
Please enter 2 character code of the country where the Registration Number has been issued by |
customerDetails.exporterDetails.registrationNumbers[].typeCode |
String | Yes |
VAT, Value-Added tax Possible values:
Default value: "VAT" |
customerDetails.exporterDetails.registrationNumbers[].number |
String | Yes |
Please enter registration number |
customerDetails.exporterDetails.contactInformation |
Object | Yes | |
customerDetails.exporterDetails.contactInformation.companyName |
String | Yes |
Please enter company name |
customerDetails.exporterDetails.contactInformation.email |
String | No |
Please enter email address |
customerDetails.exporterDetails.contactInformation.phone |
String | Yes |
Please enter phone number |
customerDetails.exporterDetails.contactInformation.mobilePhone |
String | No |
Please enter mobile phone number |
customerDetails.exporterDetails.contactInformation.fullName |
String | Yes |
Please enter full name |
customerDetails.shipperDetails |
Object | Yes |
Please enter address and contact details related to shipper |
customerDetails.shipperDetails.postalAddress |
Object | Yes | |
customerDetails.shipperDetails.postalAddress.addressLine3 |
String | No |
Please enter address line 3 |
customerDetails.shipperDetails.postalAddress.countyName |
String | No |
Please enter your suburb or county name |
customerDetails.shipperDetails.postalAddress.provinceName |
String | No |
Please enter your state or province name |
customerDetails.shipperDetails.postalAddress.postalCode |
String | Yes |
Please enter your postcode or leave empty if the address doesn't have a postcode |
customerDetails.shipperDetails.postalAddress.cityName |
String | Yes |
Please enter the city |
customerDetails.shipperDetails.postalAddress.provinceCode |
String | No |
Please enter your province or state code |
customerDetails.shipperDetails.postalAddress.countryName |
String | No |
Please enter your country name |
customerDetails.shipperDetails.postalAddress.countryCode |
String | Yes |
Please enter ISO country code |
customerDetails.shipperDetails.postalAddress.addressLine1 |
String | Yes |
Please enter address line 1 |
customerDetails.shipperDetails.postalAddress.addressLine2 |
String | No |
Please enter address line 2 |
customerDetails.shipperDetails.typeCode |
String | No |
Please enter the business party role type of the shipper Possible values:
|
customerDetails.shipperDetails.bankDetails[] |
Array | No | |
customerDetails.shipperDetails.bankDetails[].settlementForeignCurrency |
String | No |
To be mapped in commercial Invoice - Russia Bank Settlement Account Number in RUR field |
customerDetails.shipperDetails.bankDetails[].name |
String | No |
To be mapped in commercial Invoice - Russia Bank Name field |
customerDetails.shipperDetails.bankDetails[].settlementLocalCurrency |
String | No |
To be mapped in commercial Invoice - Russia Bank Settlement Account Number in RUR field |
customerDetails.shipperDetails.registrationNumbers[] |
Array | No | |
customerDetails.shipperDetails.registrationNumbers[].issuerCountryCode |
String | Yes |
Please enter 2 character code of the country where the Registration Number has been issued by |
customerDetails.shipperDetails.registrationNumbers[].typeCode |
String | Yes |
VAT, Value-Added tax Possible values:
Default value: "VAT" |
customerDetails.shipperDetails.registrationNumbers[].number |
String | Yes |
Please enter registration number |
customerDetails.shipperDetails.contactInformation |
Object | Yes | |
customerDetails.shipperDetails.contactInformation.companyName |
String | Yes |
Please enter company name |
customerDetails.shipperDetails.contactInformation.email |
String | No |
Please enter email address |
customerDetails.shipperDetails.contactInformation.phone |
String | Yes |
Please enter phone number |
customerDetails.shipperDetails.contactInformation.mobilePhone |
String | No |
Please enter mobile phone number |
customerDetails.shipperDetails.contactInformation.fullName |
String | Yes |
Please enter full name |
customerDetails.ultimateConsigneeDetails |
Object | No |
Please enter address and contact details related to ultimate consignee |
customerDetails.ultimateConsigneeDetails.postalAddress |
Object | Yes | |
customerDetails.ultimateConsigneeDetails.postalAddress.addressLine3 |
String | No |
Please enter address line 3 |
customerDetails.ultimateConsigneeDetails.postalAddress.countyName |
String | No |
Please enter your suburb or county name |
customerDetails.ultimateConsigneeDetails.postalAddress.provinceName |
String | No |
Please enter your state or province name |
customerDetails.ultimateConsigneeDetails.postalAddress.postalCode |
String | Yes |
Please enter your postcode or leave empty if the address doesn't have a postcode |
customerDetails.ultimateConsigneeDetails.postalAddress.cityName |
String | Yes |
Please enter the city |
customerDetails.ultimateConsigneeDetails.postalAddress.provinceCode |
String | No |
Please enter your province or state code |
customerDetails.ultimateConsigneeDetails.postalAddress.countryName |
String | No |
Please enter your country name |
customerDetails.ultimateConsigneeDetails.postalAddress.countryCode |
String | Yes |
Please enter ISO country code |
customerDetails.ultimateConsigneeDetails.postalAddress.addressLine1 |
String | Yes |
Please enter address line 1 |
customerDetails.ultimateConsigneeDetails.postalAddress.addressLine2 |
String | No |
Please enter address line 2 |
customerDetails.ultimateConsigneeDetails.typeCode |
String | No |
Please enter the business party role type of the ultimate consignee |
customerDetails.ultimateConsigneeDetails.bankDetails |
Object | No |
Should your country require registration numbers, such as VAT, EOR etc., please declare it here |
customerDetails.ultimateConsigneeDetails.bankDetails.issuerCountryCode |
String | Yes |
Please enter 2 character code of the country where the Registration Number has been issued by |
customerDetails.ultimateConsigneeDetails.bankDetails.typeCode |
String | Yes |
VAT, Value-Added tax Possible values:
Default value: "VAT" |
customerDetails.ultimateConsigneeDetails.bankDetails.number |
String | Yes |
Please enter registration number |
customerDetails.ultimateConsigneeDetails.registrationNumbers[] |
Array | No | |
customerDetails.ultimateConsigneeDetails.registrationNumbers[].issuerCountryCode |
String | Yes |
Please enter 2 character code of the country where the Registration Number has been issued by |
customerDetails.ultimateConsigneeDetails.registrationNumbers[].typeCode |
String | Yes |
VAT, Value-Added tax Possible values:
Default value: "VAT" |
customerDetails.ultimateConsigneeDetails.registrationNumbers[].number |
String | Yes |
Please enter registration number |
customerDetails.ultimateConsigneeDetails.contactInformation |
Object | Yes | |
customerDetails.ultimateConsigneeDetails.contactInformation.companyName |
String | Yes |
Please enter company name |
customerDetails.ultimateConsigneeDetails.contactInformation.email |
String | No |
Please enter email address |
customerDetails.ultimateConsigneeDetails.contactInformation.phone |
String | Yes |
Please enter phone number |
customerDetails.ultimateConsigneeDetails.contactInformation.mobilePhone |
String | No |
Please enter mobile phone number |
customerDetails.ultimateConsigneeDetails.contactInformation.fullName |
String | Yes |
Please enter full name |
customerDetails.importerDetails |
Object | No |
Please enter address and contact details related to importer |
customerDetails.importerDetails.postalAddress |
Object | Yes | |
customerDetails.importerDetails.postalAddress.addressLine3 |
String | No |
Please enter address line 3 |
customerDetails.importerDetails.postalAddress.countyName |
String | No |
Please enter your suburb or county name |
customerDetails.importerDetails.postalAddress.provinceName |
String | No |
Please enter your state or province name |
customerDetails.importerDetails.postalAddress.postalCode |
String | Yes |
Please enter your postcode or leave empty if the address doesn't have a postcode |
customerDetails.importerDetails.postalAddress.cityName |
String | Yes |
Please enter the city |
customerDetails.importerDetails.postalAddress.provinceCode |
String | No |
Please enter your province or state code |
customerDetails.importerDetails.postalAddress.countryName |
String | No |
Please enter your country name |
customerDetails.importerDetails.postalAddress.countryCode |
String | Yes |
Please enter ISO country code |
customerDetails.importerDetails.postalAddress.addressLine1 |
String | Yes |
Please enter address line 1 |
customerDetails.importerDetails.postalAddress.addressLine2 |
String | No |
Please enter address line 2 |
customerDetails.importerDetails.typeCode |
String | No |
Please enter the business party type of the importer Possible values:
|
customerDetails.importerDetails.bankDetails[] |
Array | No | |
customerDetails.importerDetails.bankDetails[].settlementForeignCurrency |
String | No |
To be mapped in commercial Invoice - Russia Bank Settlement Account Number in RUR field |
customerDetails.importerDetails.bankDetails[].name |
String | No |
To be mapped in commercial Invoice - Russia Bank Name field |
customerDetails.importerDetails.bankDetails[].settlementLocalCurrency |
String | No |
To be mapped in commercial Invoice - Russia Bank Settlement Account Number in RUR field |
customerDetails.importerDetails.registrationNumbers[] |
Array | No | |
customerDetails.importerDetails.registrationNumbers[].issuerCountryCode |
String | Yes |
Please enter 2 character code of the country where the Registration Number has been issued by |
customerDetails.importerDetails.registrationNumbers[].typeCode |
String | Yes |
VAT, Value-Added tax Possible values:
Default value: "VAT" |
customerDetails.importerDetails.registrationNumbers[].number |
String | Yes |
Please enter registration number |
customerDetails.importerDetails.contactInformation |
Object | Yes | |
customerDetails.importerDetails.contactInformation.companyName |
String | Yes |
Please enter company name |
customerDetails.importerDetails.contactInformation.email |
String | No |
Please enter email address |
customerDetails.importerDetails.contactInformation.phone |
String | Yes |
Please enter phone number |
customerDetails.importerDetails.contactInformation.mobilePhone |
String | No |
Please enter mobile phone number |
customerDetails.importerDetails.contactInformation.fullName |
String | Yes |
Please enter full name |
customerDetails.sellerDetails |
Object | No |
Please enter address and contact details related to seller |
customerDetails.sellerDetails.postalAddress |
Object | Yes | |
customerDetails.sellerDetails.postalAddress.addressLine3 |
String | No |
Please enter address line 3 |
customerDetails.sellerDetails.postalAddress.countyName |
String | No |
Please enter your suburb or county name |
customerDetails.sellerDetails.postalAddress.provinceName |
String | No |
Please enter your state or province name |
customerDetails.sellerDetails.postalAddress.postalCode |
String | Yes |
Please enter your postcode or leave empty if the address doesn't have a postcode |
customerDetails.sellerDetails.postalAddress.cityName |
String | Yes |
Please enter the city |
customerDetails.sellerDetails.postalAddress.provinceCode |
String | No |
Please enter your province or state code |
customerDetails.sellerDetails.postalAddress.countryName |
String | No |
Please enter your country name |
customerDetails.sellerDetails.postalAddress.countryCode |
String | Yes |
Please enter ISO country code |
customerDetails.sellerDetails.postalAddress.addressLine1 |
String | Yes |
Please enter address line 1 |
customerDetails.sellerDetails.postalAddress.addressLine2 |
String | No |
Please enter address line 2 |
customerDetails.sellerDetails.typeCode |
String | No |
Please enter the business party role type of the seller Possible values:
|
customerDetails.sellerDetails.bankDetails[] |
Array | No | |
customerDetails.sellerDetails.bankDetails[].settlementForeignCurrency |
String | No |
To be mapped in commercial Invoice - Russia Bank Settlement Account Number in RUR field |
customerDetails.sellerDetails.bankDetails[].name |
String | No |
To be mapped in commercial Invoice - Russia Bank Name field |
customerDetails.sellerDetails.bankDetails[].settlementLocalCurrency |
String | No |
To be mapped in commercial Invoice - Russia Bank Settlement Account Number in RUR field |
customerDetails.sellerDetails.registrationNumbers[] |
Array | No | |
customerDetails.sellerDetails.registrationNumbers[].issuerCountryCode |
String | Yes |
Please enter 2 character code of the country where the Registration Number has been issued by |
customerDetails.sellerDetails.registrationNumbers[].typeCode |
String | Yes |
VAT, Value-Added tax Possible values:
Default value: "VAT" |
customerDetails.sellerDetails.registrationNumbers[].number |
String | Yes |
Please enter registration number |
customerDetails.sellerDetails.contactInformation |
Object | Yes | |
customerDetails.sellerDetails.contactInformation.companyName |
String | Yes |
Please enter company name |
customerDetails.sellerDetails.contactInformation.email |
String | No |
Please enter email address |
customerDetails.sellerDetails.contactInformation.phone |
String | Yes |
Please enter phone number |
customerDetails.sellerDetails.contactInformation.mobilePhone |
String | No |
Please enter mobile phone number |
customerDetails.sellerDetails.contactInformation.fullName |
String | Yes |
Please enter full name |
customerDetails.brokerDetails |
Object | No |
Please enter address and contact details related to broker |
customerDetails.brokerDetails.postalAddress |
Object | Yes | |
customerDetails.brokerDetails.postalAddress.addressLine3 |
String | No |
Please enter address line 3 |
customerDetails.brokerDetails.postalAddress.countyName |
String | No |
Please enter your suburb or county name |
customerDetails.brokerDetails.postalAddress.provinceName |
String | No |
Please enter your state or province name |
customerDetails.brokerDetails.postalAddress.postalCode |
String | Yes |
Please enter your postcode or leave empty if the address doesn't have a postcode |
customerDetails.brokerDetails.postalAddress.cityName |
String | Yes |
Please enter the city |
customerDetails.brokerDetails.postalAddress.provinceCode |
String | No |
Please enter your province or state code |
customerDetails.brokerDetails.postalAddress.countryName |
String | No |
Please enter your country name |
customerDetails.brokerDetails.postalAddress.countryCode |
String | Yes |
Please enter ISO country code |
customerDetails.brokerDetails.postalAddress.addressLine1 |
String | Yes |
Please enter address line 1 |
customerDetails.brokerDetails.postalAddress.addressLine2 |
String | No |
Please enter address line 2 |
customerDetails.brokerDetails.typeCode |
String | No |
Please enter the business party role type of the broker |
customerDetails.brokerDetails.bankDetails |
Object | No |
Should your country require registration numbers, such as VAT, EOR etc., please declare it here |
customerDetails.brokerDetails.bankDetails.issuerCountryCode |
String | Yes |
Please enter 2 character code of the country where the Registration Number has been issued by |
customerDetails.brokerDetails.bankDetails.typeCode |
String | Yes |
VAT, Value-Added tax Possible values:
Default value: "VAT" |
customerDetails.brokerDetails.bankDetails.number |
String | Yes |
Please enter registration number |
customerDetails.brokerDetails.registrationNumbers[] |
Array | No | |
customerDetails.brokerDetails.registrationNumbers[].issuerCountryCode |
String | Yes |
Please enter 2 character code of the country where the Registration Number has been issued by |
customerDetails.brokerDetails.registrationNumbers[].typeCode |
String | Yes |
VAT, Value-Added tax Possible values:
Default value: "VAT" |
customerDetails.brokerDetails.registrationNumbers[].number |
String | Yes |
Please enter registration number |
customerDetails.brokerDetails.contactInformation |
Object | Yes | |
customerDetails.brokerDetails.contactInformation.companyName |
String | Yes |
Please enter company name |
customerDetails.brokerDetails.contactInformation.email |
String | No |
Please enter email address |
customerDetails.brokerDetails.contactInformation.phone |
String | Yes |
Please enter phone number |
customerDetails.brokerDetails.contactInformation.mobilePhone |
String | No |
Please enter mobile phone number |
customerDetails.brokerDetails.contactInformation.fullName |
String | Yes |
Please enter full name |
customerDetails.receiverDetails |
Object | Yes |
Please enter address and contact details related to receiver |
customerDetails.receiverDetails.postalAddress |
Object | Yes | |
customerDetails.receiverDetails.postalAddress.addressLine3 |
String | No |
Please enter address line 3 |
customerDetails.receiverDetails.postalAddress.countyName |
String | No |
Please enter your suburb or county name |
customerDetails.receiverDetails.postalAddress.provinceName |
String | No |
Please enter your state or province name |
customerDetails.receiverDetails.postalAddress.postalCode |
String | Yes |
Please enter your postcode or leave empty if the address doesn't have a postcode |
customerDetails.receiverDetails.postalAddress.cityName |
String | Yes |
Please enter the city |
customerDetails.receiverDetails.postalAddress.provinceCode |
String | No |
Please enter your province or state code |
customerDetails.receiverDetails.postalAddress.countryName |
String | No |
Please enter your country name |
customerDetails.receiverDetails.postalAddress.countryCode |
String | Yes |
Please enter ISO country code |
customerDetails.receiverDetails.postalAddress.addressLine1 |
String | Yes |
Please enter address line 1 |
customerDetails.receiverDetails.postalAddress.addressLine2 |
String | No |
Please enter address line 2 |
customerDetails.receiverDetails.typeCode |
String | No |
Please enter the business party type of the receiver Possible values:
|
customerDetails.receiverDetails.bankDetails[] |
Array | No | |
customerDetails.receiverDetails.bankDetails[].settlementForeignCurrency |
String | No |
To be mapped in commercial Invoice - Russia Bank Settlement Account Number in RUR field |
customerDetails.receiverDetails.bankDetails[].name |
String | No |
To be mapped in commercial Invoice - Russia Bank Name field |
customerDetails.receiverDetails.bankDetails[].settlementLocalCurrency |
String | No |
To be mapped in commercial Invoice - Russia Bank Settlement Account Number in RUR field |
customerDetails.receiverDetails.registrationNumbers[] |
Array | No | |
customerDetails.receiverDetails.registrationNumbers[].issuerCountryCode |
String | Yes |
Please enter 2 character code of the country where the Registration Number has been issued by |
customerDetails.receiverDetails.registrationNumbers[].typeCode |
String | Yes |
VAT, Value-Added tax Possible values:
Default value: "VAT" |
customerDetails.receiverDetails.registrationNumbers[].number |
String | Yes |
Please enter registration number |
customerDetails.receiverDetails.contactInformation |
Object | Yes | |
customerDetails.receiverDetails.contactInformation.companyName |
String | Yes |
Please enter company name |
customerDetails.receiverDetails.contactInformation.email |
String | No |
Please enter email address |
customerDetails.receiverDetails.contactInformation.phone |
String | Yes |
Please enter phone number |
customerDetails.receiverDetails.contactInformation.mobilePhone |
String | No |
Please enter mobile phone number |
customerDetails.receiverDetails.contactInformation.fullName |
String | Yes |
Please enter full name |
customerDetails.payerDetails |
Object | No |
Please enter address and contact details related to payer |
customerDetails.payerDetails.postalAddress |
Object | Yes | |
customerDetails.payerDetails.postalAddress.addressLine3 |
String | No |
Please enter address line 3 |
customerDetails.payerDetails.postalAddress.countyName |
String | No |
Please enter your suburb or county name |
customerDetails.payerDetails.postalAddress.provinceName |
String | No |
Please enter your state or province name |
customerDetails.payerDetails.postalAddress.postalCode |
String | Yes |
Please enter your postcode or leave empty if the address doesn't have a postcode |
customerDetails.payerDetails.postalAddress.cityName |
String | Yes |
Please enter the city |
customerDetails.payerDetails.postalAddress.provinceCode |
String | No |
Please enter your province or state code |
customerDetails.payerDetails.postalAddress.countryName |
String | No |
Please enter your country name |
customerDetails.payerDetails.postalAddress.countryCode |
String | Yes |
Please enter ISO country code |
customerDetails.payerDetails.postalAddress.addressLine1 |
String | Yes |
Please enter address line 1 |
customerDetails.payerDetails.postalAddress.addressLine2 |
String | No |
Please enter address line 2 |
customerDetails.payerDetails.typeCode |
String | No |
Please enter the business party role type of the payer Possible values:
|
customerDetails.payerDetails.bankDetails[] |
Array | No | |
customerDetails.payerDetails.bankDetails[].settlementForeignCurrency |
String | No |
To be mapped in commercial Invoice - Russia Bank Settlement Account Number in RUR field |
customerDetails.payerDetails.bankDetails[].name |
String | No |
To be mapped in commercial Invoice - Russia Bank Name field |
customerDetails.payerDetails.bankDetails[].settlementLocalCurrency |
String | No |
To be mapped in commercial Invoice - Russia Bank Settlement Account Number in RUR field |
customerDetails.payerDetails.registrationNumbers[] |
Array | No | |
customerDetails.payerDetails.registrationNumbers[].issuerCountryCode |
String | Yes |
Please enter 2 character code of the country where the Registration Number has been issued by |
customerDetails.payerDetails.registrationNumbers[].typeCode |
String | Yes |
VAT, Value-Added tax Possible values:
Default value: "VAT" |
customerDetails.payerDetails.registrationNumbers[].number |
String | Yes |
Please enter registration number |
customerDetails.payerDetails.contactInformation |
Object | Yes | |
customerDetails.payerDetails.contactInformation.companyName |
String | Yes |
Please enter company name |
customerDetails.payerDetails.contactInformation.email |
String | No |
Please enter email address |
customerDetails.payerDetails.contactInformation.phone |
String | Yes |
Please enter phone number |
customerDetails.payerDetails.contactInformation.mobilePhone |
String | No |
Please enter mobile phone number |
customerDetails.payerDetails.contactInformation.fullName |
String | Yes |
Please enter full name |
getRateEstimates |
Boolean | No |
Please advise if you want to get rate estimates for given shipment Default value: false |
prepaidCharges[] |
Array | No |
Please provide any charges you have already paid for this shipment, like freight paid upfront. To allow using this section please contact your DHL Express representative |
prepaidCharges[].method |
String | Yes |
Please enter method you have used to pay the charges. At this moment only cash is supported Possible values:
|
prepaidCharges[].typeCode |
String | Yes |
Please enter type of prepaid charge. At this moment only freight is supported Possible values:
|
prepaidCharges[].value |
Number | Yes |
Please enter nominal value related to the charge |
prepaidCharges[].currency |
String | Yes |
Please enter currency for the value you have entered into value field |
plannedShippingDateAndTime |
String | Yes |
Identifies the date and time the package is tendered. Both the date and time portions of the string are expected to be used. The date should not be a past date or a date more than 10 days in the future. The time is the local time of the shipment based on the shipper's time zone. The date component must be in the format: YYYY-MM-DD; the time component must be in the format: HH:MM:SS using a 24 hour clock. The date and time parts are separated by the letter T (e.g. 2006-06-26T17:00:00 GMT+01:00). |
pickup |
Object | Yes | |
pickup.isRequested |
Boolean | Yes |
Please advise if a pickup is needed for this shipment Default value: false |
pickup.location |
String | No |
Provides information on where the package should be picked up by DHL courier. |
pickup.pickupDetails |
Object | No |
Please enter address and contact details related to your pickup |
pickup.pickupDetails.postalAddress |
Object | Yes | |
pickup.pickupDetails.postalAddress.addressLine3 |
String | No |
Please enter address line 3 |
pickup.pickupDetails.postalAddress.countyName |
String | No |
Please enter your suburb or county name |
pickup.pickupDetails.postalAddress.provinceName |
String | No |
Please enter your state or province name |
pickup.pickupDetails.postalAddress.postalCode |
String | Yes |
Please enter your postcode or leave empty if the address doesn't have a postcode |
pickup.pickupDetails.postalAddress.cityName |
String | Yes |
Please enter the city |
pickup.pickupDetails.postalAddress.provinceCode |
String | No |
Please enter your province or state code |
pickup.pickupDetails.postalAddress.countryName |
String | No |
Please enter your country name |
pickup.pickupDetails.postalAddress.countryCode |
String | Yes |
Please enter ISO country code |
pickup.pickupDetails.postalAddress.addressLine1 |
String | Yes |
Please enter address line 1 |
pickup.pickupDetails.postalAddress.addressLine2 |
String | No |
Please enter address line 2 |
pickup.pickupDetails.typeCode |
String | No |
Please enter the business party type related to the pickup. Possible values:
|
pickup.pickupDetails.bankDetails[] |
Array | No | |
pickup.pickupDetails.bankDetails[].settlementForeignCurrency |
String | No |
To be mapped in commercial Invoice - Russia Bank Settlement Account Number in RUR field |
pickup.pickupDetails.bankDetails[].name |
String | No |
To be mapped in commercial Invoice - Russia Bank Name field |
pickup.pickupDetails.bankDetails[].settlementLocalCurrency |
String | No |
To be mapped in commercial Invoice - Russia Bank Settlement Account Number in RUR field |
pickup.pickupDetails.registrationNumbers[] |
Array | No | |
pickup.pickupDetails.registrationNumbers[].issuerCountryCode |
String | Yes |
Please enter 2 character code of the country where the Registration Number has been issued by |
pickup.pickupDetails.registrationNumbers[].typeCode |
String | Yes |
VAT, Value-Added tax Possible values:
Default value: "VAT" |
pickup.pickupDetails.registrationNumbers[].number |
String | Yes |
Please enter registration number |
pickup.pickupDetails.contactInformation |
Object | Yes | |
pickup.pickupDetails.contactInformation.companyName |
String | Yes |
Please enter company name |
pickup.pickupDetails.contactInformation.email |
String | No |
Please enter email address |
pickup.pickupDetails.contactInformation.phone |
String | Yes |
Please enter phone number |
pickup.pickupDetails.contactInformation.mobilePhone |
String | No |
Please enter mobile phone number |
pickup.pickupDetails.contactInformation.fullName |
String | Yes |
Please enter full name |
pickup.pickupRequestorDetails |
Object | No |
Please enter address and contact details of the individual requesting the pickup |
pickup.pickupRequestorDetails.postalAddress |
Object | Yes | |
pickup.pickupRequestorDetails.postalAddress.addressLine3 |
String | No |
Please enter address line 3 |
pickup.pickupRequestorDetails.postalAddress.countyName |
String | No |
Please enter your suburb or county name |
pickup.pickupRequestorDetails.postalAddress.provinceName |
String | No |
Please enter your state or province name |
pickup.pickupRequestorDetails.postalAddress.postalCode |
String | Yes |
Please enter your postcode or leave empty if the address doesn't have a postcode |
pickup.pickupRequestorDetails.postalAddress.cityName |
String | Yes |
Please enter the city |
pickup.pickupRequestorDetails.postalAddress.provinceCode |
String | No |
Please enter your province or state code |
pickup.pickupRequestorDetails.postalAddress.countryName |
String | No |
Please enter your country name |
pickup.pickupRequestorDetails.postalAddress.countryCode |
String | Yes |
Please enter ISO country code |
pickup.pickupRequestorDetails.postalAddress.addressLine1 |
String | Yes |
Please enter address line 1 |
pickup.pickupRequestorDetails.postalAddress.addressLine2 |
String | No |
Please enter address line 2 |
pickup.pickupRequestorDetails.typeCode |
String | No |
Please enter the business party type of the pickup requestor. Possible values:
|
pickup.pickupRequestorDetails.bankDetails[] |
Array | No | |
pickup.pickupRequestorDetails.bankDetails[].settlementForeignCurrency |
String | No |
To be mapped in commercial Invoice - Russia Bank Settlement Account Number in RUR field |
pickup.pickupRequestorDetails.bankDetails[].name |
String | No |
To be mapped in commercial Invoice - Russia Bank Name field |
pickup.pickupRequestorDetails.bankDetails[].settlementLocalCurrency |
String | No |
To be mapped in commercial Invoice - Russia Bank Settlement Account Number in RUR field |
pickup.pickupRequestorDetails.registrationNumbers[] |
Array | No | |
pickup.pickupRequestorDetails.registrationNumbers[].issuerCountryCode |
String | Yes |
Please enter 2 character code of the country where the Registration Number has been issued by |
pickup.pickupRequestorDetails.registrationNumbers[].typeCode |
String | Yes |
VAT, Value-Added tax Possible values:
Default value: "VAT" |
pickup.pickupRequestorDetails.registrationNumbers[].number |
String | Yes |
Please enter registration number |
pickup.pickupRequestorDetails.contactInformation |
Object | Yes | |
pickup.pickupRequestorDetails.contactInformation.companyName |
String | Yes |
Please enter company name |
pickup.pickupRequestorDetails.contactInformation.email |
String | No |
Please enter email address |
pickup.pickupRequestorDetails.contactInformation.phone |
String | Yes |
Please enter phone number |
pickup.pickupRequestorDetails.contactInformation.mobilePhone |
String | No |
Please enter mobile phone number |
pickup.pickupRequestorDetails.contactInformation.fullName |
String | Yes |
Please enter full name |
pickup.closeTime |
String | No |
The latest time the location premises is available to dispatch the DHL Express shipment. (HH:MM) |
pickup.specialInstructions[] |
Array | No |
Details special pickup instructions you may wish to send to the DHL Courier. |
pickup.specialInstructions[].typeCode |
String | No |
for future use |
pickup.specialInstructions[].value |
String | Yes |
Any special instructions user wish to send to the courier for the order pick-up. |
localProductCode |
String | No |
Please enter DHL Express Local Product code. Important when shipping domestic products. |
accounts[] |
Array | Yes |
Please enter all the DHL Express accounts and types to be used for this shipment |
accounts[].typeCode |
String | Yes |
Please enter DHL Express acount type Possible values:
|
accounts[].number |
String | Yes |
Please enter DHL Express account number |
outputImageProperties |
Object | No |
Here you can modify label, waybillDoc, invoice and shipment receipt properties |
outputImageProperties.splitTransportAndWaybillDocLabels |
Boolean | No |
When set to true it will generate a single PDF or thermal output file for the Transport Label, a single PDF or thermal output file for the Waybill document and a single PDF file consisting of Commercial Invoice and Shipment Receipt. The default value is false, a single PDF or thermal output image file consists of Transport Label and single PDF or thermal output image file for Waybill Document will be returned in create shipment response. |
outputImageProperties.printerDPI |
Number | No |
Printer DPI Resolution for X-axis and Y-axis (in DPI) for transport label and waybill document output Possible values:
|
outputImageProperties.customerBarcodes[] |
Array | No |
Customer barcodes to be printed on supported transport label templates |
outputImageProperties.customerBarcodes[].symbologyCode |
String | Yes |
Please enter valid Symbology code Possible values:
|
outputImageProperties.customerBarcodes[].textBelowBarcode |
String | No |
Please tner text below customer barcode |
outputImageProperties.customerBarcodes[].content |
String | Yes |
Please enter barcode content |
outputImageProperties.customerLogos[] |
Array | No |
Customer Logo Image to be printed on transport label |
outputImageProperties.customerLogos[].fileFormat |
String | Yes |
Please specify image file format Possible values:
|
outputImageProperties.customerLogos[].content |
String | Yes |
Please provide base64 encoded logo image |
outputImageProperties.imageOptions[] |
Array | No |
Here the image options are defined for label, waybillDoc, invoice, QRcode and shipment receipt |
outputImageProperties.imageOptions[].isRequested |
Boolean | No |
To be used for waybillDoc, invoice, shipment receipt and QRcode. If set to true then the document is provided otherwise not |
outputImageProperties.imageOptions[].invoiceType |
String | No |
Please advise what type of customs documentation is required Possible values:
|
outputImageProperties.imageOptions[].labelFreeText |
String | No |
Additional customer label free text that can be printed in certain label.Note: Applicable only to ECOM26_A6_002, ECOM_TC_A4 and ECOM26_84CI_001. |
outputImageProperties.imageOptions[].numberOfCopies |
Number | No |
You can ask up to 2 waybillDoc copies to be provided |
outputImageProperties.imageOptions[].labelCustomerDataText |
String | No |
Additional customer label text that can be printed in certain label.Note: Applicable only to ECOM26_84_A4_001, ECOM_TC_A4 and ECOM26_84CI_001 |
outputImageProperties.imageOptions[].templateName |
String | No |
Please enter DHL Express document template name. |
outputImageProperties.imageOptions[].hideAccountNumber |
Boolean | No |
To be used for waybillDoc. If set to true then account information will not be printed on the waybillDoc |
outputImageProperties.imageOptions[].encodingFormat |
String | No |
Please provide the format of the QR Code output format. Possible values:
|
outputImageProperties.imageOptions[].fitLabelsToA4 |
Boolean | No |
To print respective Transport Label and Waybill document into A4 margin PDF. |
outputImageProperties.imageOptions[].shipmentReceiptCustomerDataText |
String | No |
Declaration text that can be printed in certain shipment receipt template |
outputImageProperties.imageOptions[].languageCode |
String | No |
Please enter ISO 3 letters language code for invoice or shipment receipt |
outputImageProperties.imageOptions[].languageCountryCode |
String | No |
Please enter ISO 2 letters language country code for invoice or shipment receipt |
outputImageProperties.imageOptions[].renderDHLLogo |
Boolean | No |
DHL Logo to be printed in Transport Label or Waybill Document |
outputImageProperties.imageOptions[].typeCode |
String | Yes |
Please enter the document type you want to wish set properties for Possible values:
|
outputImageProperties.imageOptions[].languageScriptCode |
String | No |
Please enter ISO 4 letters language script code for shipment receipt |
outputImageProperties.allDocumentsInOneImage |
Boolean | No |
When set to true it will generate a single PDF or thermal output image file consists of Transport Label, Waybill Document, Shipment Receipt and Commercial Invoice. |
outputImageProperties.splitDocumentsByPages |
Boolean | No |
When set to true it will generate a single PDF or thermal output image file for each page for the Transport Label and single PDF or thermal output image file for Waybill Document will be returned in the create shipment response. The default value is false, a single PDF or thermal output image file for each page for Transport Label and single PDF or thermal output image file for Waybill Document will be returned in create shipment response. |
outputImageProperties.receiptAndLabelsInOneImage |
Boolean | No |
When set to true it will generate a single PDF file consisting of Transport Label, Waybill Document and Shipment Receipt. The default value is false, a single PDF or thermal output image file consists of Transport Label + Waybill Document and single PDF file for Shipment Receipt will be returned in create shipment response. Applicable only when #/outputImageProperties/imageOptions/0/typeCode is 'receipt' and #/outputImageProperties/encodingFormat is PDF. |
outputImageProperties.encodingFormat |
String | No |
Please provide the format of the output documents. Note that invoice and shipment receipt will always come back as PDF Possible values:
Default value: "pdf" |
outputImageProperties.splitInvoiceAndReceipt |
Boolean | No |
When set to true it will generate a single PDF or thermal output image file consisting of Transport Label + Waybill Document, a single file consist of Commercial Invoice and a single file consist of Shipment Receipt. The default value is false, a single PDF or thermal output image file consists of Transport Label + Waybill Document and single PDF or thermal output image file for Shipment Receipt and Customs Invoice will be returned in create shipment response. |
documentImages[] |
Array | No |
This section is to support multiple base64 encoded string with the image of export documentation for Paperless Trade images. When an invalid base64 encoded string is provided, an error message will be returned |
documentImages[].typeCode |
String | No |
Please provide correct document type you wish to upload Possible values:
Default value: "INV" |
documentImages[].imageFormat |
String | No |
Please provide the image file format for the document you want to upload Possible values:
Default value: "PDF" |
documentImages[].content |
String | Yes |
Please provide the base64 encoded document |
requestOndemandDeliveryURL |
Boolean | No |
Determines whether to request the On Demand Delivery (ODD) link. When set to true it will provide an URL link for the specified Waybill Number, Shipper Account Number. The default value is false, no ODD link URL is provided in the response message. |
parentShipment |
Object | No |
Please provide the parent (mother) shipment details |
parentShipment.packagesCount |
Number | No |
Please provide the parent (mother) shipment's Number of Packages |
parentShipment.productCode |
String | No |
Please provide the parent (mother) Product Code |
valueAddedServices[] |
Array | No |
This section communicates additional shipping services, such as Insurance (or Shipment Value Protection). |
valueAddedServices[].serviceCode |
String | Yes |
Please enter DHL Express value added service code. For detailed list of all available service codes for your prospect shipment please invoke GET /products or GET /rates |
valueAddedServices[].method |
String | No |
Payment method code (e.g. Cash) |
valueAddedServices[].dangerousGoods[] |
Array | No |
The DangerousGoods section indicates if there is dangerous good content within the shipment. |
valueAddedServices[].dangerousGoods[].unCodes[] |
Array | No |
Please enter UN code(s) |
valueAddedServices[].dangerousGoods[].dryIceTotalNetWeight |
Number | No |
Please enter dry ice total net weight when shipping dry ice |
valueAddedServices[].dangerousGoods[].contentId |
String | Yes |
Please enter valid DHL Express Dangerous good content id (please contact your DHL Express IT representative for the relevant content ID code if you are shipping Dan |
valueAddedServices[].dangerousGoods[].customDescription |
String | No |
The customDescription node contains the customized Dangerous Goods statement to declare contents accurately. The customDescription node value will be displayed in the Transport Label and Waybill Document, replacing the default IATA Dangerous Goods statement constructed based on contentId node. |
valueAddedServices[].value |
Number | No |
Please enter monetary value of service (e.g. Insured Value) |
valueAddedServices[].currency |
String | No |
Please enter currency code (e.g. Insured Value currency code) |
identifiers[] |
Array | No |
Identifiers section is on the shipment level where you can optionaly provide a DHL Express waybill number. This has to be enabled by your DHL Express IT contact. |
identifiers[].dataIdentifier |
String | No |
Please enter value of Piece Data Identifier. Note: Piece identification data should be same for all the pieces provided in single shipment. |
identifiers[].typeCode |
String | Yes |
Please provide type of the identifier you want to set value for Possible values:
|
identifiers[].value |
String | Yes |
Please enter value of your identifier (WB number, PieceID) |
getAdditionalInformation[] |
Array | No |
Provides additional information in the response like service area details, routing code and pickup-related information |
getAdditionalInformation[].isRequested |
Boolean | Yes | |
getAdditionalInformation[].typeCode |
String | No |
Provide type code of data that can be returned in response. Values can be pickupDetails, optionalShipmentData, transliterateResponse and linkLabelsByPieces (link label image generated for each package level) Possible values:
|
onDemandDelivery |
Object | No |
Here you can provide data in case you wish to use DHL Express On demand delivery service |
onDemandDelivery.whereToLeave |
String | No |
In ase your deliveryOption is 'neighbour' please specify where to leave the package Possible values:
|
onDemandDelivery.neighbourHouseNumber |
String | No |
In case you wish to leave the package with neighbour please provide the neighbour's house number |
onDemandDelivery.authorizerName |
String | No |
In case your delivery option is 'signatureRelease' please provide name of the person who is authorized to sign and receive the package |
onDemandDelivery.servicePointId |
String | No |
In case your delivery option is 'servicepoint' please provide unique DHL Express Service point location ID of where the parcel should be delieverd (please contact your local DHL Express Account Manager to obtain the list of the servicepoint IDs) |
onDemandDelivery.location |
String | No |
If delivery option is signatureDelivery please specify location where to leave the shipment |
onDemandDelivery.deliveryOption |
String | Yes |
Please choose from one of the delivery options Possible values:
|
onDemandDelivery.gateCode |
String | No |
Please provide entry code to gain access to an apartment complex or gate |
onDemandDelivery.specialInstructions |
String | No |
Please enter additional information that might be useful for the DHL Express courier. This field is conditionally mandatory if selected location is 'Other'. |
onDemandDelivery.requestedDeliveryDate |
String | No |
for future use |
onDemandDelivery.neighbourName |
String | No |
In case you wish to leave the package with neighbour please provide the neighbour's name |
shipmentNotification[] |
Array | No |
This is to support sending email notification once the shipment is created. The email will contain the basic information on the shipper, recipient, waybill number, and shipment information |
shipmentNotification[].languageCode |
String | No |
Please enter three letter lanuage code in which you wish to receive the notification in Default value: "eng" |
shipmentNotification[].languageCountryCode |
String | No |
Please enter two letter language country code Default value: "UK" |
shipmentNotification[].bespokeMessage |
String | No |
Please enter your message which will be added to the DHL Express notification email |
shipmentNotification[].typeCode |
String | Yes |
Please enter channel type to send the notification by. At this moment only email is supported Possible values:
|
shipmentNotification[].receiverId |
String | Yes |
Please enter notification receiver email address |
getTransliteratedResponse |
Boolean | No |
If set to true, response will return transliterated text of shipper and receiver details. |
content |
Object | Yes |
Here you can define all the properties related to the content of the prospected shipment |
content.packages[] |
Array | Yes |
Here you can define properties per package |
content.packages[].dimensions |
Object | Yes |
Dimensions of the package |
content.packages[].dimensions.height |
Number | Yes |
Height of the package |
content.packages[].dimensions.length |
Number | Yes |
Length of the package |
content.packages[].dimensions.width |
Number | Yes |
Width of the package |
content.packages[].labelText[] |
Array | No |
This allows you to enter up to two bespoke texts on the DHL Express Tranport label. To use this feature please set outputImageProperties/imageOptions/templateName as ECOM26_84CI_003 for typeCode=label |
content.packages[].labelText[].caption |
String | Yes |
Please enter caption to be printed in the tag value |
content.packages[].labelText[].value |
String | Yes |
Please enter value to be printed for the respective tag in caption |
content.packages[].labelText[].position |
String | Yes |
Position of the bespoke text Possible values:
|
content.packages[].identifiers[] |
Array | No |
Identifiers section is on the package level where you can optionaly provide a DHL Express waybill number. This has to be enabled by your DHL Express IT contact. |
content.packages[].identifiers[].dataIdentifier |
String | No |
Please enter value of Piece Data Identifier. Note: Piece identification data should be same for all the pieces provided in single shipment. |
content.packages[].identifiers[].typeCode |
String | Yes |
Please provide type of the identifier you want to set value for Possible values:
|
content.packages[].identifiers[].value |
String | Yes |
Please enter value of your identifier (WB number, PieceID) |
content.packages[].typeCode |
String | No |
Please contact your DHL Express representative if you wish to use a DHL specific package otherwise ignore this element. Possible values:
|
content.packages[].description |
String | No |
Please enter description of content for each package |
content.packages[].labelBarcodes[] |
Array | No |
This allows you to define up to two bespoke barcodes on the DHL Express Tranport label. To use this feature please set outputImageProperties/imageOptions/templateName as ECOM26_84CI_003 for typeCode=label |
content.packages[].labelBarcodes[].symbologyCode |
String | Yes |
Please enter valid Symbology code Possible values:
|
content.packages[].labelBarcodes[].textBelowBarcode |
String | Yes |
Please enter text below customer barcode |
content.packages[].labelBarcodes[].content |
String | Yes |
Please enter barcode content |
content.packages[].labelBarcodes[].position |
String | Yes |
Position of the bespoke barcode Possible values:
|
content.packages[].referenceNumber |
Number | No |
Please enter package reference number. If package reference number is provided for at least one package, then package reference number must be provided for all packages. |
content.packages[].customerReferences[] |
Array | No |
Here you can declare your customer references for each package |
content.packages[].customerReferences[].typeCode |
String | No |
Please provide reference type Possible values:
Default value: "CU" |
content.packages[].customerReferences[].value |
String | Yes |
Please provide reference |
content.packages[].labelDescription |
String | No |
Please enter additional customer description |
content.packages[].weight |
Number | Yes |
The weight of the package. |
content.description |
String | Yes |
Please enter description of your shipment |
content.declaredValue |
Number | No |
For customs purposes please advise on declared value of the shipment |
content.unitOfMeasurement |
String | Yes |
Please enter Unit of measurement - metric,imperial Possible values:
|
content.isCustomsDeclarable |
Boolean | Yes |
For customs purposes please advise if your shipment is dutiable (true) or non dutiable (false).Note:If the shipment is dutiable, exportDeclaration element must be provided. |
content.declaredValueCurrency |
String | No |
For customs purposes please advise on declared value currency code of the shipment |
content.USFilingTypeValue |
String | No |
This is used for the US AES4, FTR and ITN numbers to be printed on the Transport Label |
content.incoterm |
String | Yes |
The Incoterms rules are a globally-recognized set of standards, used worldwide in international and domestic contracts for the delivery of goods, illustrating responsibilities between buyer and seller for costs and risk, as well as cargo insurance. Possible values:
|
content.exportDeclaration |
Object | No |
Here you can find all details related to export declaration |
content.exportDeclaration.exportReference |
String | No |
Please enter export reference |
content.exportDeclaration.declarationNotes[] |
Array | No |
Please provide up to three dcelaration notes |
content.exportDeclaration.declarationNotes[].value |
String | Yes | |
content.exportDeclaration.remarks[] |
Array | No |
Please enter up to three remarks. |
content.exportDeclaration.remarks[].value |
String | Yes |
Please enter remark text |
content.exportDeclaration.exporter |
Object | No |
Exporter related details |
content.exportDeclaration.exporter.id |
String | No |
Please provide exporter Id |
content.exportDeclaration.exporter.code |
String | No |
Please provide exporter code |
content.exportDeclaration.additionalCharges[] |
Array | No |
Please enter additional charge to appear on the invoice |
content.exportDeclaration.additionalCharges[].caption |
String | No |
Please enter charge caption |
content.exportDeclaration.additionalCharges[].typeCode |
String | Yes |
Please enter charge type Possible values:
|
content.exportDeclaration.additionalCharges[].value |
Number | Yes |
Please provide the charge value |
content.exportDeclaration.placeOfIncoterm |
String | No |
Name of port of departure, shipment or destination as required under the applicable delivery term. |
content.exportDeclaration.licenses[] |
Array | No |
Please provide details about export and import licenses |
content.exportDeclaration.licenses[].typeCode |
String | Yes |
Please provide type of the license Possible values:
|
content.exportDeclaration.licenses[].value |
String | Yes |
Please provide the license |
content.exportDeclaration.packageMarks |
String | No |
Please enter package marks |
content.exportDeclaration.destinationPortName |
String | No |
Please provide destination port details |
content.exportDeclaration.customsDocuments[] |
Array | No |
Please provide the Customs Documents at invoice level |
content.exportDeclaration.customsDocuments[].typeCode |
String | Yes |
Please provide the Customs Document type code at invoice level Possible values:
|
content.exportDeclaration.customsDocuments[].value |
String | Yes |
Please provide the Customs Document ID at invoice level |
content.exportDeclaration.shipmentType |
String | No |
Please provide the shipment was sent for Personal (Gift) or Commercial (Sale) reasons Possible values:
|
content.exportDeclaration.invoice |
Object | No |
Please provide invoice related information |
content.exportDeclaration.invoice.number |
String | Yes |
Please enter commercial invoice number |
content.exportDeclaration.invoice.indicativeCustomsValues |
Object | No |
indicativeCustomsValues contains child nodes importCustomsDutyValue and importTaxesValue. |
content.exportDeclaration.invoice.indicativeCustomsValues.totalWithImportDutiesAndTaxes |
Number | No |
Please provide pre-calculated total of all line items plus additional charges plus indicativeCustomsValues |
content.exportDeclaration.invoice.indicativeCustomsValues.importTaxesValue |
Number | No |
Please provide the pre-calculated import taxes (VAT/GST) value for the shipment |
content.exportDeclaration.invoice.indicativeCustomsValues.importCustomsDutyValue |
Number | No |
Please provide the pre-calculated import customs duties value for the shipment |
content.exportDeclaration.invoice.totalGrossWeight |
Number | No |
Please provide the total gross weight |
content.exportDeclaration.invoice.termsOfPayment |
String | No |
Please provide the terms of payment |
content.exportDeclaration.invoice.signatureImage |
String | No |
Please provide the signature image |
content.exportDeclaration.invoice.date |
String | Yes |
Please enter commercial invoice date |
content.exportDeclaration.invoice.totalNetWeight |
Number | No |
Please provide the total net weight |
content.exportDeclaration.invoice.preCalculatedTotalValues |
Object | No |
Please provide pre-calculated total values |
content.exportDeclaration.invoice.preCalculatedTotalValues.preCalculatedTotalGoodsValue |
Number | Yes |
Please provide the pre-calculated total value of all line items |
content.exportDeclaration.invoice.preCalculatedTotalValues.preCalculatedTotalInvoiceValue |
Number | Yes |
Please provide the total value of all line items plus additional charges if any |
content.exportDeclaration.invoice.signatureName |
String | No |
Please enter who has signed the invoce |
content.exportDeclaration.invoice.signatureTitle |
String | No |
Please provide title of person who has signed the invoice |
content.exportDeclaration.invoice.customerDataTextEntries[] |
Array | No |
Customer data text to be printed in |
content.exportDeclaration.invoice.customerReferences[] |
Array | No |
Please provide the customer references at invoice level. It is recommended to provide less than 20 customer references of 'MRN' type code. |
content.exportDeclaration.invoice.customerReferences[].typeCode |
String | Yes |
Please provide the invoice reference type code Possible values:
|
content.exportDeclaration.invoice.customerReferences[].value |
String | Yes |
Please provide the invoice reference |
content.exportDeclaration.invoice.instructions[] |
Array | No |
Shipment instructions for customs invoice printing purposes. Printed only when using Customs Invoice template COMMERCIAL_INVOICE_04. If using Customs Invoice template COMMERCIAL_INVOICE_04, recommended max length is 120 characters. |
content.exportDeclaration.payerVATNumber |
String | No |
Please provide Payer VAT number |
content.exportDeclaration.exportReason |
String | No |
Please enter export reason |
content.exportDeclaration.exportReasonType |
String | No |
Please provide the reason for export Possible values:
|
content.exportDeclaration.lineItems[] |
Array | Yes |
Please enter details for each export line item |
content.exportDeclaration.lineItems[].price |
Number | Yes |
Please provide unit or article price line item value |
content.exportDeclaration.lineItems[].isTaxesPaid |
Boolean | No |
Please provide if the Taxes is paid for the line item |
content.exportDeclaration.lineItems[].description |
String | Yes |
Please provide description of the line item |
content.exportDeclaration.lineItems[].number |
Integer | Yes |
Please provide line item number |
content.exportDeclaration.lineItems[].quantity |
Object | Yes |
Please enter information about quantity for this line item |
content.exportDeclaration.lineItems[].quantity.unitOfMeasurement |
String | Yes |
Please provide correct unit of measurement Possible values:
|
content.exportDeclaration.lineItems[].quantity.value |
Integer | Yes |
Please enter number of pieces in the line item |
content.exportDeclaration.lineItems[].customsDocuments[] |
Array | No |
Please provide the customs documents details |
content.exportDeclaration.lineItems[].customsDocuments[].typeCode |
String | Yes |
Please provide the line item customs document type code Possible values:
|
content.exportDeclaration.lineItems[].customsDocuments[].value |
String | Yes |
Please provide the line item customs document ID |
content.exportDeclaration.lineItems[].manufacturerCountry |
String | Yes |
Please enter two letter ISO manufacturer country code |
content.exportDeclaration.lineItems[].commodityCodes[] |
Array | No |
Please provide Commodity codes for the shipment at item line level |
content.exportDeclaration.lineItems[].commodityCodes[].typeCode |
String | Yes |
Please provide type of the commodity code Possible values:
|
content.exportDeclaration.lineItems[].commodityCodes[].value |
String | Yes |
Please provide the commodity code |
content.exportDeclaration.lineItems[].preCalculatedLineItemTotalValue |
Number | No |
Please provide monetary value of the line item x quantity |
content.exportDeclaration.lineItems[].exportReasonType |
String | No |
Please provide the reason for export Possible values:
|
content.exportDeclaration.lineItems[].customerReferences[] |
Array | No |
Please provide the Customer References for the line item |
content.exportDeclaration.lineItems[].customerReferences[].typeCode |
String | Yes |
Please provide the line item reference type code. Please refer to the YAML Reference Data Guide PDF file for valid enumeration values. Possible values:
|
content.exportDeclaration.lineItems[].customerReferences[].value |
String | Yes |
Please provide the line item reference |
content.exportDeclaration.lineItems[].weight |
Object | Yes |
Please enter the weight information for line item |
content.exportDeclaration.lineItems[].weight.grossValue |
Number | Yes |
Please enter the gross weight value |
content.exportDeclaration.lineItems[].weight.netValue |
Number | Yes |
Please enter the net weight value |
content.exportDeclaration.lineItems[].additionalInformation[] |
Array | No |
Please provide the additional information |
content.exportDeclaration.recipientReference |
String | No |
Please enter recipient reference |
customerReferences[] |
Array | No |
Here you can declare your customer references |
customerReferences[].typeCode |
String | No |
Please provide reference type Possible values:
Default value: "CU" |
customerReferences[].value |
String | Yes |
Please provide reference |
productCode |
String | Yes |
Please enter DHL Express Global Product code |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.