PATCH /shipments/{shipmentTrackingNumber}/upload-invoice-data

DHL Express shipment identification number

Please provide version of the plugin (applicable to 3PV only)

Default value: "application/json"

Please provide version of the shipping platform (applicable to 3PV only)

Please provide version of the webstore platform (applicable to 3PV only)

Optional reference date in the HTTP-date format https://tools.ietf.org/html/rfc7231#section-7.1.1.2

Please provide name of the webstore platform (applicable to 3PV only)

Please provide name of the shipping platform(applicable to 3PV only)

Please provide message reference

Please provide name of the plugin (applicable to 3PV only)

Here you need to define all the parties needed to ship the package

Please enter address and contact details related to buyer

Please enter address line 3

Please enter your suburb or county name

Please enter your postcode or leave empty if the address doesn't have a postcode

Please enter the city

Please enter your province or state code

Please enter ISO country code

Please enter address line 1

Please enter address line 2

Please enter the business party type of the buyer

Possible values:

• "direct_consumer"
• "business"
• "other"
• "reseller"
• "private"
• "government"

Please enter 2 character code of the country where the Registration Number has been issued by

VAT, Value-Added tax
EIN, Employer Identification Number
GST, Goods and Service Tax
SSN, Social Security Number
EOR, European Union Registration and Identification
DUN, Data Universal Numberin System
FED, Federal Tax ID
STA, State Tax ID
CNP, Brazil CNPJ/CPF Federal Tax
IE, Brazil type IE/RG Federal Tax
INN, Russia bank details section INN
KPP, Russia bank details section KPP
OGR, Russia bank details section OGRN
OKP, Russia bank details sectionOKPO
SDT, Overseas Registered Supplier or Import One-Stop-Shop or GB VAT (foreign) registration or AUSid GST Registration or VAT on E-Commerce
FTZ, Free Trade Zone ID
DAN, Deferment Account Duties Only
TAN, Deferment Account Tax Only
DTF, Deferment Account Duties, Taxes and Fees Only
RGP, EU Registered Exporters registration ID
DLI,Driver's License
NID,National Identity Card
,PAS:Passport
,MID:Manufacturer ID

Possible values:

• "FED"
• "STA"
• "SDT"
• "PAS"
• "DAN"
• "OGR"
• "SSN"
• "OKP"
• "MRN"
• "INN"
• "KPP"
• "VAT"
• "GST"
• "DLI"
• "MID"
• "CNP"
• "EOR"
• "EIN"
• "TAN"
• "RGP"
• "DTF"
• "IE"
• "DUN"
• "FTZ"
• "NID"

Default value: "VAT"

Please enter registration number

Please enter company name

Please enter email address

Please enter phone number

Please enter mobile phone number

Please enter full name

Please enter address and contact details related to exporter

Please enter address line 3

Please enter your suburb or county name

Please enter your postcode or leave empty if the address doesn't have a postcode

Please enter the city

Please enter your province or state code

Please enter ISO country code

Please enter address line 1

Please enter address line 2

Please enter the business party type of the exporter

Possible values:

• "direct_consumer"
• "business"
• "other"
• "reseller"
• "private"
• "government"

Please enter 2 character code of the country where the Registration Number has been issued by

VAT, Value-Added tax
EIN, Employer Identification Number
GST, Goods and Service Tax
SSN, Social Security Number
EOR, European Union Registration and Identification
DUN, Data Universal Numberin System
FED, Federal Tax ID
STA, State Tax ID
CNP, Brazil CNPJ/CPF Federal Tax
IE, Brazil type IE/RG Federal Tax
INN, Russia bank details section INN
KPP, Russia bank details section KPP
OGR, Russia bank details section OGRN
OKP, Russia bank details sectionOKPO
SDT, Overseas Registered Supplier or Import One-Stop-Shop or GB VAT (foreign) registration or AUSid GST Registration or VAT on E-Commerce
FTZ, Free Trade Zone ID
DAN, Deferment Account Duties Only
TAN, Deferment Account Tax Only
DTF, Deferment Account Duties, Taxes and Fees Only
RGP, EU Registered Exporters registration ID
DLI,Driver's License
NID,National Identity Card
,PAS:Passport
,MID:Manufacturer ID

Possible values:

• "FED"
• "STA"
• "SDT"
• "PAS"
• "DAN"
• "OGR"
• "SSN"
• "OKP"
• "MRN"
• "INN"
• "KPP"
• "VAT"
• "GST"
• "DLI"
• "MID"
• "CNP"
• "EOR"
• "EIN"
• "TAN"
• "RGP"
• "DTF"
• "IE"
• "DUN"
• "FTZ"
• "NID"

Default value: "VAT"

Please enter registration number

Please enter company name

Please enter email address

Please enter phone number

Please enter mobile phone number

Please enter full name

Please enter address and contact details related to ultimate consignee

Please enter address line 3

Please enter your suburb or county name

Please enter your postcode or leave empty if the address doesn't have a postcode

Please enter the city

Please enter your province or state code

Please enter ISO country code

Please enter address line 1

Please enter address line 2

Please enter the business party type of the ultimate consignee

Possible values:

• "direct_consumer"
• "business"
• "other"
• "reseller"
• "private"
• "government"

Please enter 2 character code of the country where the Registration Number has been issued by

VAT, Value-Added tax
EIN, Employer Identification Number
GST, Goods and Service Tax
SSN, Social Security Number
EOR, European Union Registration and Identification
DUN, Data Universal Numberin System
FED, Federal Tax ID
STA, State Tax ID
CNP, Brazil CNPJ/CPF Federal Tax
IE, Brazil type IE/RG Federal Tax
INN, Russia bank details section INN
KPP, Russia bank details section KPP
OGR, Russia bank details section OGRN
OKP, Russia bank details sectionOKPO
SDT, Overseas Registered Supplier or Import One-Stop-Shop or GB VAT (foreign) registration or AUSid GST Registration or VAT on E-Commerce
FTZ, Free Trade Zone ID
DAN, Deferment Account Duties Only
TAN, Deferment Account Tax Only
DTF, Deferment Account Duties, Taxes and Fees Only
RGP, EU Registered Exporters registration ID
DLI,Driver's License
NID,National Identity Card
,PAS:Passport
,MID:Manufacturer ID

Possible values:

• "FED"
• "STA"
• "SDT"
• "PAS"
• "DAN"
• "OGR"
• "SSN"
• "OKP"
• "MRN"
• "INN"
• "KPP"
• "VAT"
• "GST"
• "DLI"
• "MID"
• "CNP"
• "EOR"
• "EIN"
• "TAN"
• "RGP"
• "DTF"
• "IE"
• "DUN"
• "FTZ"
• "NID"

Default value: "VAT"

Please enter registration number

Please enter company name

Please enter email address

Please enter phone number

Please enter mobile phone number

Please enter full name

Please enter address and contact details related to seller

Please enter address line 3

Please enter your suburb or county name

Please enter your postcode or leave empty if the address doesn't have a postcode

Please enter the city

Please enter your province or state code

Please enter ISO country code

Please enter address line 1

Please enter address line 2

Please enter the business party type of the buyer

Possible values:

• "direct_consumer"
• "business"
• "other"
• "reseller"
• "private"
• "government"

Please enter 2 character code of the country where the Registration Number has been issued by

VAT, Value-Added tax
EIN, Employer Identification Number
GST, Goods and Service Tax
SSN, Social Security Number
EOR, European Union Registration and Identification
DUN, Data Universal Numberin System
FED, Federal Tax ID
STA, State Tax ID
CNP, Brazil CNPJ/CPF Federal Tax
IE, Brazil type IE/RG Federal Tax
INN, Russia bank details section INN
KPP, Russia bank details section KPP
OGR, Russia bank details section OGRN
OKP, Russia bank details sectionOKPO
SDT, Overseas Registered Supplier or Import One-Stop-Shop or GB VAT (foreign) registration or AUSid GST Registration or VAT on E-Commerce
FTZ, Free Trade Zone ID
DAN, Deferment Account Duties Only
TAN, Deferment Account Tax Only
DTF, Deferment Account Duties, Taxes and Fees Only
RGP, EU Registered Exporters registration ID
DLI,Driver's License
NID,National Identity Card
,PAS:Passport
,MID:Manufacturer ID

Possible values:

• "FED"
• "STA"
• "SDT"
• "PAS"
• "DAN"
• "OGR"
• "SSN"
• "OKP"
• "MRN"
• "INN"
• "KPP"
• "VAT"
• "GST"
• "DLI"
• "MID"
• "CNP"
• "EOR"
• "EIN"
• "TAN"
• "RGP"
• "DTF"
• "IE"
• "DUN"
• "FTZ"
• "NID"

Default value: "VAT"

Please enter registration number

Please enter company name

Please enter email address

Please enter phone number

Please enter mobile phone number

Please enter full name

Please enter address and contact details related to importer

Please enter address line 3

Please enter your suburb or county name

Please enter your postcode or leave empty if the address doesn't have a postcode

Please enter the city

Please enter your province or state code

Please enter ISO country code

Please enter address line 1

Please enter address line 2

Please enter the business party type of the importer

Possible values:

• "direct_consumer"
• "business"
• "other"
• "reseller"
• "private"
• "government"

Please enter 2 character code of the country where the Registration Number has been issued by

VAT, Value-Added tax
EIN, Employer Identification Number
GST, Goods and Service Tax
SSN, Social Security Number
EOR, European Union Registration and Identification
DUN, Data Universal Numberin System
FED, Federal Tax ID
STA, State Tax ID
CNP, Brazil CNPJ/CPF Federal Tax
IE, Brazil type IE/RG Federal Tax
INN, Russia bank details section INN
KPP, Russia bank details section KPP
OGR, Russia bank details section OGRN
OKP, Russia bank details sectionOKPO
SDT, Overseas Registered Supplier or Import One-Stop-Shop or GB VAT (foreign) registration or AUSid GST Registration or VAT on E-Commerce
FTZ, Free Trade Zone ID
DAN, Deferment Account Duties Only
TAN, Deferment Account Tax Only
DTF, Deferment Account Duties, Taxes and Fees Only
RGP, EU Registered Exporters registration ID
DLI,Driver's License
NID,National Identity Card
,PAS:Passport
,MID:Manufacturer ID

Possible values:

• "FED"
• "STA"
• "SDT"
• "PAS"
• "DAN"
• "OGR"
• "SSN"
• "OKP"
• "MRN"
• "INN"
• "KPP"
• "VAT"
• "GST"
• "DLI"
• "MID"
• "CNP"
• "EOR"
• "EIN"
• "TAN"
• "RGP"
• "DTF"
• "IE"
• "DUN"
• "FTZ"
• "NID"

Default value: "VAT"

Please enter registration number

Please enter company name

Please enter email address

Please enter phone number

Please enter mobile phone number

Please enter full name

Please enter address and contact details related to broker

Please enter address line 3

Please enter your suburb or county name

Please enter your postcode or leave empty if the address doesn't have a postcode

Please enter the city

Please enter your province or state code

Please enter ISO country code

Please enter address line 1

Please enter address line 2

Please enter the business party type of the broker

Possible values:

• "direct_consumer"
• "business"
• "other"
• "reseller"
• "private"
• "government"

Please enter 2 character code of the country where the Registration Number has been issued by

VAT, Value-Added tax
EIN, Employer Identification Number
GST, Goods and Service Tax
SSN, Social Security Number
EOR, European Union Registration and Identification
DUN, Data Universal Numberin System
FED, Federal Tax ID
STA, State Tax ID
CNP, Brazil CNPJ/CPF Federal Tax
IE, Brazil type IE/RG Federal Tax
INN, Russia bank details section INN
KPP, Russia bank details section KPP
OGR, Russia bank details section OGRN
OKP, Russia bank details sectionOKPO
SDT, Overseas Registered Supplier or Import One-Stop-Shop or GB VAT (foreign) registration or AUSid GST Registration or VAT on E-Commerce
FTZ, Free Trade Zone ID
DAN, Deferment Account Duties Only
TAN, Deferment Account Tax Only
DTF, Deferment Account Duties, Taxes and Fees Only
RGP, EU Registered Exporters registration ID
DLI,Driver's License
NID,National Identity Card
,PAS:Passport
,MID:Manufacturer ID

Possible values:

• "FED"
• "STA"
• "SDT"
• "PAS"
• "DAN"
• "OGR"
• "SSN"
• "OKP"
• "MRN"
• "INN"
• "KPP"
• "VAT"
• "GST"
• "DLI"
• "MID"
• "CNP"
• "EOR"
• "EIN"
• "TAN"
• "RGP"
• "DTF"
• "IE"
• "DUN"
• "FTZ"
• "NID"

Default value: "VAT"

Please enter registration number

Please enter company name

Please enter email address

Please enter phone number

Please enter mobile phone number

Please enter full name

The planned shipment date for the provided shipmentTrackingNumber. The date must be in the format: YYYY-MM-DD

Please enter all the DHL Express accounts and types to be used for this shipment.
Note: accounts/0/number with typeCode 'shipper' is mandatory if using POST method and no shipmentTrackingNumber is provided in request.

Please enter DHL Express acount type

Possible values:

• "shipper"
• "duties-taxes"
• "payer"

Please enter DHL Express account number

Here you can set invoice properties

Here the image options are defined for label, waybillDoc, invoice, receipt and QRcode

If set to true then the document is rendered otherwise not

Please enter the document type you want to wish set properties for

Possible values:

• "invoice"

Please enter DHL Express document template name.

Here you can define all the properties related to the content of the prospected shipment

Please enter Unit of measurement - metric,imperial

Possible values:

• "metric"
• "imperial"

Here you can find all details related to export declaration

Please provide the shipment was sent for Personal (Gift) or Commercial (Sale) reasons

Possible values:

• "commercial"
• "personal"

Please provide invoice related information

Please provide the purpose was the document details captured and are planned to be used. Note: export and import is only applicable for approve Sale In Transit customers

Possible values:

• "both"
• "export"
• "import"

Please enter commercial invoice number

Please provide Perfect Invoice related information

Please provide pre-calculated total of all line items plus additional charges plus indicativeCustomsValues

Please provide the pre-calculated import taxes (VAT/GST) value for the shipment

Please provide the pre-calculated import customs duties value for the shipment

Please provide the customer references at invoice level.
Note: customerReference/0/value with typeCode 'CU' is mandatory if using POST method and no shipmentTrackingNumber is provided in request. It is recommended to provide less than 20 customer references of 'MRN' type code

Please provide the invoice reference type code

Possible values:

• "FTR"
• "BKN"
• "UCN"
• "AES"
• "AAM"
• "DSC"
• "FF"
• "HWB"
• "COD"
• "SID"
• "MAB"
• "CID"
• "MRN"
• "AFD"
• "IPP"
• "RMA"
• "PD"
• "SWN"
• "CU"
• "OID"
• "ITN"
• "ANT"
• "CN"
• "ACL"
• "FN"
• "CDN"
• "ABT"
• "MWB"
• "LLR"
• "OBC"
• "SS"
• "PON"
• "ADA"
• "BOL"
• "IBC"
• "PRN"
• "RTL"

Please provide the invoice reference

Please enter commercial invoice date

Please provide pre-calculated total values

Please provide the pre-calculated total value of all line items

Please provide the total value of all line items plus additional charges if any

Please enter up to three remarks

Please enter remark text

Exporter related details

Please provide exporter Id

Please provide exporter code

Please enter additional charge to appear on the invoice
admin, Administration Charge
delivery, Delivery Charge
documentation, Documentation Charge
expedite, Expedite Charge
freight, Freight Charge
fuel surcharge, Fuel Surcharge
logistic, Logistic Charge
other, Other Charge
packaging, Packaging Charge
pickup, Pickup Charge
handling, Handling Charge
vat, VAT Charge
insurance, Insurance Cost

Please enter charge type

Possible values:

• "packaging"
• "delivery"
• "other"
• "freight"
• "fuel_surcharge"
• "documentation"
• "export"
• "vat"
• "reverse_charge"
• "handling"
• "pickup"
• "expedite"
• "insurance"
• "admin"
• "logistic"

Please provide the charge value

Name of port of departure, shipment or destination as required under the applicable delivery term.

Please provide the reason for export

Possible values:

• "defence_material"
• "permanent"
• "commercial_purpose_or_sale"
• "used_exhibition_goods_to_origin"
• "intercompany_use"
• "temporary"
• "return"
• "gift"
• "diplomatic_goods"
• "personal_belongings_or_personal_use"
• "sample"
• "return_to_origin"
• "warranty_replacement"

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.
EXW ExWorks
FCA Free Carrier
CPT Carriage Paid To
CIP Carriage and Insurance Paid To
DPU Delivered at Place Unloaded
DAP Delivered at Place
DDP Delivered Duty Paid
FAS Free Alongside Ship
FOB Free on Board
CFR Cost and Freight
CIF Cost, Insurance and Freight
DAF Delivered at Frontier
DAT Delivered at Terminal
DDU Delivered Duty Unpaid
DEQ Delivery ex Quay
DES Delivered ex Ship

Possible values:

• "CPT"
• "CIP"
• "DPU"
• "DAF"
• "DDP"
• "FOB"
• "CFR"
• "DEQ"
• "DES"
• "DAP"
• "DDU"
• "DAT"
• "FAS"
• "CIF"
• "EXW"
• "FCA"

Please enter details for each export line item

Please enter two letter ISO manufacturer country code

Please provide unit or article price line item value

Please provide if the Taxes is paid for the line item

Please provide description of the line item

Please provide line item number

Please provide Commodity codes for the shipment at item line level

Please provide type of the commodity code

Possible values:

• "inbound"
• "outbound"

Please provide the commodity code

Please provide monetary value of the line item x quantity

Please enter information about quantity for this line item

Please provide correct unit of measurement

Possible values;
BOX Boxes
2GM Centigram
2M3 Cubic Centimeters
3M3 Cubic Feet
M3 Cubic Meters
DPR Dozen Pairs
DOZ Dozen
2NO Each
PCS Pieces
GM Grams
GRS Gross
KG Kilograms
L Liters
M Meters
3GM Milligrams
3L Milliliters
X No Unit Required
NO Number
2KG Ounces
PRS Pairs
2L Gallons
3KG Pounds
CM2 Square Centimeters
2M2 Square Feet
3M2 Square Inches
M2 Square Meters
4M2 Square Yards
3M Yards
CM Centimeters
CONE Cone
CT Carat
EA Each
LBS Pounds
RILL Rill
ROLL Roll
SET Set
TU Time Unit
YDS Yard

Possible values:

• "PCS"
• "2KG"
• "DPR"
• "CM2"
• "RILL"
• "LBS"
• "2NO"
• "CM"
• "BOX"
• "SET"
• "DOZ"
• "GM"
• "M2"
• "ROLL"
• "NO"
• "TU"
• "YDS"
• "3M"
• "M"
• "PRS"
• "2GM"
• "2M2"
• "3M3"
• "4M2"
• "3KG"
• "CONE"
• "M3"
• "X"
• "KG"
• "EA"
• "2L"
• "3L"
• "L"
• "2M3"
• "3M2"
• "GRS"
• "3GM"
• "CT"

Please enter number of pieces in the line item

Please provide the reason for export

Possible values:

• "defence_material"
• "permanent"
• "commercial_purpose_or_sale"
• "used_exhibition_goods_to_origin"
• "intercompany_use"
• "temporary"
• "return"
• "gift"
• "diplomatic_goods"
• "personal_belongings_or_personal_use"
• "sample"
• "return_to_origin"
• "warranty_replacement"

Please provide the Customer References for the line item

Please provide the line item reference type code. Please refer to the YAML Reference Data Guide PDF file for valid enumeration values.

Possible values:

• "OET"
• "MAT"
• "AAM"
• "DTC"
• "OED"
• "ABW"
• "SON"
• "OOR"
• "DTM"
• "DGC"
• "DTQ"
• "ITR"
• "DOM"
• "OID"
• "MID"
• "PAN"
• "INB"
• "AAJ"
• "ALX"
• "CFR"
• "BRD"
• "MAK"
• "PON"
• "USM"
• "NLR"
• "AFE"
• "FOR"
• "USG"
• "DTR"
• "SE"
• "SME"

Please provide the line item reference

Please enter the weight information for line item. Either a netValue or grossValue must be provided for the line item.

Please enter the gross weight value

Please enter the net weight value

Please provide the customs documents details

Please provide the line item customs document type code. Please refer to the YAML Reference Data Guide PDF file for valid enumeration values.

Possible values:

• "CI2"
• "DOV"
• "PAS"
• "TCS"
• "PHY"
• "972"
• "IPA"
• "CSD"
• "PPY"
• "HWB"
• "BEX"
• "DEX"
• "INV"
• "PLI"
• "EXL"
• "PFI"
• "ATR"
• "VET"
• "CRL"
• "CHD"
• "DLI"
• "EU1"
• "LIC"
• "VEX"
• "JLC"
• "ELP"
• "HLC"
• "POA"
• "CHP"
• "CIT"
• "CIV"
• "FMA"
• "ATA"
• "TAD"
• "CPA"
• "ALC"
• "T2M"
• "LNP"
• "AHC"
• "CHA"
• "NID"
• "ROD"
• "DGD"
• "EU2"
• "EUS"
• "COO"

Please provide the line item customs document ID

Please enter recipient reference

Please provide the Customs Documents at invoice level

Please provide the Customs Document type code at invoice level. Please refer to the YAML Reference Data Guide PDF file for valid enumeration values.

Possible values:

• "CI2"
• "DOV"
• "PAS"
• "TCS"
• "PHY"
• "972"
• "IPA"
• "CSD"
• "PPY"
• "HWB"
• "BEX"
• "DEX"
• "INV"
• "PLI"
• "EXL"
• "PFI"
• "ATR"
• "VET"
• "CRL"
• "CHD"
• "DLI"
• "EU1"
• "LIC"
• "VEX"
• "JLC"
• "ELP"
• "HLC"
• "POA"
• "CHP"
• "CIT"
• "CIV"
• "FMA"
• "ATA"
• "TAD"
• "CPA"
• "ALC"
• "T2M"
• "LNP"
• "AHC"
• "CHA"
• "NID"
• "ROD"
• "DGD"
• "EU2"
• "EUS"
• "COO"

Please provide the Customs Document ID at invoice level

For customs purposes please advise on currency code of the indicated amount in invoice.