.NET Core C# / DHL Express APIs (MyDHL API) / Upload Commercial Invoice data for your DHL Express shipment
Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Chilkat.Http http = new Chilkat.Http();
bool success;
http.BasicAuth = true;
http.Login = "<Basic Auth Username>";
http.Password = "<Basic Auth Password>";
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "content": {
// "exportDeclaration": [
// {
// "lineItems": [
// {
// "number": 1,
// "description": "line item description",
// "price": 150,
// "quantity": {
// "value": 1,
// "unitOfMeasurement": "BOX"
// },
// "manufacturerCountry": "CZ",
// "weight": {
// "netValue": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// },
// "commodityCodes": [
// {
// "typeCode": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "value": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// }
// ],
// "exportReasonType": "defence_material",
// "isTaxesPaid": true,
// "customerReferences": [
// {
// "typeCode": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "value": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// }
// ],
// "customsDocuments": [
// {
// "typeCode": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "value": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// }
// ]
// }
// ],
// "invoice": {
// "number": "12345-ABC",
// "date": "2021-03-18",
// "function": "import",
// "customerReferences": [
// {
// "typeCode": "CU",
// "value": "custref112"
// }
// ]
// },
// "incoterm": "DAP",
// "remarks": [
// {
// "value": "declaration remark"
// },
// {
// "value": "declaration remark"
// }
// ],
// "additionalCharges": [
// {
// "value": 10,
// "typeCode": "pickup"
// },
// {
// "value": 10,
// "typeCode": "pickup"
// }
// ],
// "placeOfIncoterm": "port of departure or destination details",
// "recipientReference": "recipient reference",
// "exporter": {
// "id": "123",
// "code": "EXPCZ"
// },
// "exportReasonType": "permanent",
// "shipmentType": "personal",
// "customsDocuments": [
// {
// "typeCode": "972",
// "value": "custdoc445"
// }
// ]
// }
// ],
// "currency": "EUR",
// "unitOfMeasurement": "metric"
// },
// "plannedShipDate": "2020-04-20",
// "accounts": [
// {
// "typeCode": "shipper",
// "number": "123456789"
// },
// {
// "typeCode": "shipper",
// "number": "123456789"
// }
// ],
// "outputImageProperties": {
// "imageOptions": [
// {
// "typeCode": "invoice",
// "templateName": "COMMERCIAL_INVOICE_P_10",
// "isRequested": true
// }
// ]
// },
// "customerDetails": {
// "sellerDetails": {
// "postalAddress": {
// "postalCode": "14800",
// "cityName": "Prague",
// "countryCode": "CZ",
// "addressLine1": "V Parku 2308/10",
// "provinceCode": "CZ",
// "addressLine2": "addres2",
// "addressLine3": "addres3",
// "countyName": "Central Bohemia"
// },
// "contactInformation": {
// "phone": "+1123456789",
// "companyName": "Company Name",
// "fullName": "John Brew",
// "email": "that@before.de",
// "mobilePhone": "+60112345678"
// },
// "typeCode": "business",
// "registrationNumbers": [
// {
// "typeCode": "VAT",
// "number": "CZ123456789",
// "issuerCountryCode": "CZ"
// },
// {
// "typeCode": "VAT",
// "number": "CZ123456789",
// "issuerCountryCode": "CZ"
// }
// ]
// },
// "buyerDetails": {
// "postalAddress": {
// "postalCode": "14800",
// "cityName": "Prague",
// "countryCode": "CZ",
// "addressLine1": "V Parku 2308/10",
// "provinceCode": "CZ",
// "addressLine2": "addres2",
// "addressLine3": "addres3",
// "countyName": "Central Bohemia"
// },
// "contactInformation": {
// "phone": "+1123456789",
// "companyName": "Company Name",
// "fullName": "John Brew",
// "email": "that@before.de",
// "mobilePhone": "+60112345678"
// },
// "registrationNumbers": [
// {
// "typeCode": "VAT",
// "number": "CZ123456789",
// "issuerCountryCode": "CZ"
// },
// {
// "typeCode": "VAT",
// "number": "CZ123456789",
// "issuerCountryCode": "CZ"
// }
// ],
// "typeCode": "business"
// },
// "importerDetails": {
// "postalAddress": {
// "postalCode": "14800",
// "cityName": "Prague",
// "countryCode": "CZ",
// "addressLine1": "V Parku 2308/10",
// "provinceCode": "CZ",
// "addressLine2": "addres2",
// "addressLine3": "addres3",
// "countyName": "Central Bohemia"
// },
// "contactInformation": {
// "phone": "+1123456789",
// "companyName": "Company Name",
// "fullName": "John Brew",
// "email": "that@before.de",
// "mobilePhone": "+60112345678"
// },
// "registrationNumbers": [
// {
// "typeCode": "VAT",
// "number": "CZ123456789",
// "issuerCountryCode": "CZ"
// },
// {
// "typeCode": "VAT",
// "number": "CZ123456789",
// "issuerCountryCode": "CZ"
// }
// ],
// "typeCode": "government"
// },
// "exporterDetails": {
// "postalAddress": {
// "postalCode": "14800",
// "cityName": "Prague",
// "countryCode": "CZ",
// "addressLine1": "V Parku 2308/10",
// "provinceCode": "CZ",
// "addressLine2": "addres2",
// "addressLine3": "addres3",
// "countyName": "Central Bohemia"
// },
// "contactInformation": {
// "phone": "+1123456789",
// "companyName": "Company Name",
// "fullName": "John Brew",
// "email": "that@before.de",
// "mobilePhone": "+60112345678"
// },
// "registrationNumbers": [
// {
// "typeCode": "VAT",
// "number": "CZ123456789",
// "issuerCountryCode": "CZ"
// },
// {
// "typeCode": "VAT",
// "number": "CZ123456789",
// "issuerCountryCode": "CZ"
// }
// ],
// "typeCode": "government"
// },
// "ultimateConsigneeDetails": {
// "postalAddress": {
// "postalCode": "14800",
// "cityName": "Prague",
// "countryCode": "CZ",
// "addressLine1": "V Parku 2308/10",
// "provinceCode": "CZ",
// "addressLine2": "addres2",
// "addressLine3": "addres3",
// "countyName": "Central Bohemia"
// },
// "contactInformation": {
// "phone": "+1123456789",
// "companyName": "Company Name",
// "fullName": "John Brew",
// "email": "that@before.de",
// "mobilePhone": "+60112345678"
// },
// "typeCode": "other",
// "registrationNumbers": [
// {
// "typeCode": "VAT",
// "number": "CZ123456789",
// "issuerCountryCode": "CZ"
// },
// {
// "typeCode": "VAT",
// "number": "CZ123456789",
// "issuerCountryCode": "CZ"
// }
// ]
// }
// }
// }
Chilkat.JsonObject json = new Chilkat.JsonObject();
json.UpdateInt("content.exportDeclaration[0].lineItems[0].number",1);
json.UpdateString("content.exportDeclaration[0].lineItems[0].description","line item description");
json.UpdateInt("content.exportDeclaration[0].lineItems[0].price",150);
json.UpdateInt("content.exportDeclaration[0].lineItems[0].quantity.value",1);
json.UpdateString("content.exportDeclaration[0].lineItems[0].quantity.unitOfMeasurement","BOX");
json.UpdateString("content.exportDeclaration[0].lineItems[0].manufacturerCountry","CZ");
json.UpdateString("content.exportDeclaration[0].lineItems[0].weight.netValue.value","<Error: Too many levels of nesting to fake this schema>");
json.UpdateString("content.exportDeclaration[0].lineItems[0].commodityCodes[0].typeCode.value","<Error: Too many levels of nesting to fake this schema>");
json.UpdateString("content.exportDeclaration[0].lineItems[0].commodityCodes[0].value.value","<Error: Too many levels of nesting to fake this schema>");
json.UpdateString("content.exportDeclaration[0].lineItems[0].exportReasonType","defence_material");
json.UpdateBool("content.exportDeclaration[0].lineItems[0].isTaxesPaid",true);
json.UpdateString("content.exportDeclaration[0].lineItems[0].customerReferences[0].typeCode.value","<Error: Too many levels of nesting to fake this schema>");
json.UpdateString("content.exportDeclaration[0].lineItems[0].customerReferences[0].value.value","<Error: Too many levels of nesting to fake this schema>");
json.UpdateString("content.exportDeclaration[0].lineItems[0].customsDocuments[0].typeCode.value","<Error: Too many levels of nesting to fake this schema>");
json.UpdateString("content.exportDeclaration[0].lineItems[0].customsDocuments[0].value.value","<Error: Too many levels of nesting to fake this schema>");
json.UpdateString("content.exportDeclaration[0].invoice.number","12345-ABC");
json.UpdateString("content.exportDeclaration[0].invoice.date","2021-03-18");
json.UpdateString("content.exportDeclaration[0].invoice.function","import");
json.UpdateString("content.exportDeclaration[0].invoice.customerReferences[0].typeCode","CU");
json.UpdateString("content.exportDeclaration[0].invoice.customerReferences[0].value","custref112");
json.UpdateString("content.exportDeclaration[0].incoterm","DAP");
json.UpdateString("content.exportDeclaration[0].remarks[0].value","declaration remark");
json.UpdateString("content.exportDeclaration[0].remarks[1].value","declaration remark");
json.UpdateInt("content.exportDeclaration[0].additionalCharges[0].value",10);
json.UpdateString("content.exportDeclaration[0].additionalCharges[0].typeCode","pickup");
json.UpdateInt("content.exportDeclaration[0].additionalCharges[1].value",10);
json.UpdateString("content.exportDeclaration[0].additionalCharges[1].typeCode","pickup");
json.UpdateString("content.exportDeclaration[0].placeOfIncoterm","port of departure or destination details");
json.UpdateString("content.exportDeclaration[0].recipientReference","recipient reference");
json.UpdateString("content.exportDeclaration[0].exporter.id","123");
json.UpdateString("content.exportDeclaration[0].exporter.code","EXPCZ");
json.UpdateString("content.exportDeclaration[0].exportReasonType","permanent");
json.UpdateString("content.exportDeclaration[0].shipmentType","personal");
json.UpdateString("content.exportDeclaration[0].customsDocuments[0].typeCode","972");
json.UpdateString("content.exportDeclaration[0].customsDocuments[0].value","custdoc445");
json.UpdateString("content.currency","EUR");
json.UpdateString("content.unitOfMeasurement","metric");
json.UpdateString("plannedShipDate","2020-04-20");
json.UpdateString("accounts[0].typeCode","shipper");
json.UpdateString("accounts[0].number","123456789");
json.UpdateString("accounts[1].typeCode","shipper");
json.UpdateString("accounts[1].number","123456789");
json.UpdateString("outputImageProperties.imageOptions[0].typeCode","invoice");
json.UpdateString("outputImageProperties.imageOptions[0].templateName","COMMERCIAL_INVOICE_P_10");
json.UpdateBool("outputImageProperties.imageOptions[0].isRequested",true);
json.UpdateString("customerDetails.sellerDetails.postalAddress.postalCode","14800");
json.UpdateString("customerDetails.sellerDetails.postalAddress.cityName","Prague");
json.UpdateString("customerDetails.sellerDetails.postalAddress.countryCode","CZ");
json.UpdateString("customerDetails.sellerDetails.postalAddress.addressLine1","V Parku 2308/10");
json.UpdateString("customerDetails.sellerDetails.postalAddress.provinceCode","CZ");
json.UpdateString("customerDetails.sellerDetails.postalAddress.addressLine2","addres2");
json.UpdateString("customerDetails.sellerDetails.postalAddress.addressLine3","addres3");
json.UpdateString("customerDetails.sellerDetails.postalAddress.countyName","Central Bohemia");
json.UpdateString("customerDetails.sellerDetails.contactInformation.phone","+1123456789");
json.UpdateString("customerDetails.sellerDetails.contactInformation.companyName","Company Name");
json.UpdateString("customerDetails.sellerDetails.contactInformation.fullName","John Brew");
json.UpdateString("customerDetails.sellerDetails.contactInformation.email","that@before.de");
json.UpdateString("customerDetails.sellerDetails.contactInformation.mobilePhone","+60112345678");
json.UpdateString("customerDetails.sellerDetails.typeCode","business");
json.UpdateString("customerDetails.sellerDetails.registrationNumbers[0].typeCode","VAT");
json.UpdateString("customerDetails.sellerDetails.registrationNumbers[0].number","CZ123456789");
json.UpdateString("customerDetails.sellerDetails.registrationNumbers[0].issuerCountryCode","CZ");
json.UpdateString("customerDetails.sellerDetails.registrationNumbers[1].typeCode","VAT");
json.UpdateString("customerDetails.sellerDetails.registrationNumbers[1].number","CZ123456789");
json.UpdateString("customerDetails.sellerDetails.registrationNumbers[1].issuerCountryCode","CZ");
json.UpdateString("customerDetails.buyerDetails.postalAddress.postalCode","14800");
json.UpdateString("customerDetails.buyerDetails.postalAddress.cityName","Prague");
json.UpdateString("customerDetails.buyerDetails.postalAddress.countryCode","CZ");
json.UpdateString("customerDetails.buyerDetails.postalAddress.addressLine1","V Parku 2308/10");
json.UpdateString("customerDetails.buyerDetails.postalAddress.provinceCode","CZ");
json.UpdateString("customerDetails.buyerDetails.postalAddress.addressLine2","addres2");
json.UpdateString("customerDetails.buyerDetails.postalAddress.addressLine3","addres3");
json.UpdateString("customerDetails.buyerDetails.postalAddress.countyName","Central Bohemia");
json.UpdateString("customerDetails.buyerDetails.contactInformation.phone","+1123456789");
json.UpdateString("customerDetails.buyerDetails.contactInformation.companyName","Company Name");
json.UpdateString("customerDetails.buyerDetails.contactInformation.fullName","John Brew");
json.UpdateString("customerDetails.buyerDetails.contactInformation.email","that@before.de");
json.UpdateString("customerDetails.buyerDetails.contactInformation.mobilePhone","+60112345678");
json.UpdateString("customerDetails.buyerDetails.registrationNumbers[0].typeCode","VAT");
json.UpdateString("customerDetails.buyerDetails.registrationNumbers[0].number","CZ123456789");
json.UpdateString("customerDetails.buyerDetails.registrationNumbers[0].issuerCountryCode","CZ");
json.UpdateString("customerDetails.buyerDetails.registrationNumbers[1].typeCode","VAT");
json.UpdateString("customerDetails.buyerDetails.registrationNumbers[1].number","CZ123456789");
json.UpdateString("customerDetails.buyerDetails.registrationNumbers[1].issuerCountryCode","CZ");
json.UpdateString("customerDetails.buyerDetails.typeCode","business");
json.UpdateString("customerDetails.importerDetails.postalAddress.postalCode","14800");
json.UpdateString("customerDetails.importerDetails.postalAddress.cityName","Prague");
json.UpdateString("customerDetails.importerDetails.postalAddress.countryCode","CZ");
json.UpdateString("customerDetails.importerDetails.postalAddress.addressLine1","V Parku 2308/10");
json.UpdateString("customerDetails.importerDetails.postalAddress.provinceCode","CZ");
json.UpdateString("customerDetails.importerDetails.postalAddress.addressLine2","addres2");
json.UpdateString("customerDetails.importerDetails.postalAddress.addressLine3","addres3");
json.UpdateString("customerDetails.importerDetails.postalAddress.countyName","Central Bohemia");
json.UpdateString("customerDetails.importerDetails.contactInformation.phone","+1123456789");
json.UpdateString("customerDetails.importerDetails.contactInformation.companyName","Company Name");
json.UpdateString("customerDetails.importerDetails.contactInformation.fullName","John Brew");
json.UpdateString("customerDetails.importerDetails.contactInformation.email","that@before.de");
json.UpdateString("customerDetails.importerDetails.contactInformation.mobilePhone","+60112345678");
json.UpdateString("customerDetails.importerDetails.registrationNumbers[0].typeCode","VAT");
json.UpdateString("customerDetails.importerDetails.registrationNumbers[0].number","CZ123456789");
json.UpdateString("customerDetails.importerDetails.registrationNumbers[0].issuerCountryCode","CZ");
json.UpdateString("customerDetails.importerDetails.registrationNumbers[1].typeCode","VAT");
json.UpdateString("customerDetails.importerDetails.registrationNumbers[1].number","CZ123456789");
json.UpdateString("customerDetails.importerDetails.registrationNumbers[1].issuerCountryCode","CZ");
json.UpdateString("customerDetails.importerDetails.typeCode","government");
json.UpdateString("customerDetails.exporterDetails.postalAddress.postalCode","14800");
json.UpdateString("customerDetails.exporterDetails.postalAddress.cityName","Prague");
json.UpdateString("customerDetails.exporterDetails.postalAddress.countryCode","CZ");
json.UpdateString("customerDetails.exporterDetails.postalAddress.addressLine1","V Parku 2308/10");
json.UpdateString("customerDetails.exporterDetails.postalAddress.provinceCode","CZ");
json.UpdateString("customerDetails.exporterDetails.postalAddress.addressLine2","addres2");
json.UpdateString("customerDetails.exporterDetails.postalAddress.addressLine3","addres3");
json.UpdateString("customerDetails.exporterDetails.postalAddress.countyName","Central Bohemia");
json.UpdateString("customerDetails.exporterDetails.contactInformation.phone","+1123456789");
json.UpdateString("customerDetails.exporterDetails.contactInformation.companyName","Company Name");
json.UpdateString("customerDetails.exporterDetails.contactInformation.fullName","John Brew");
json.UpdateString("customerDetails.exporterDetails.contactInformation.email","that@before.de");
json.UpdateString("customerDetails.exporterDetails.contactInformation.mobilePhone","+60112345678");
json.UpdateString("customerDetails.exporterDetails.registrationNumbers[0].typeCode","VAT");
json.UpdateString("customerDetails.exporterDetails.registrationNumbers[0].number","CZ123456789");
json.UpdateString("customerDetails.exporterDetails.registrationNumbers[0].issuerCountryCode","CZ");
json.UpdateString("customerDetails.exporterDetails.registrationNumbers[1].typeCode","VAT");
json.UpdateString("customerDetails.exporterDetails.registrationNumbers[1].number","CZ123456789");
json.UpdateString("customerDetails.exporterDetails.registrationNumbers[1].issuerCountryCode","CZ");
json.UpdateString("customerDetails.exporterDetails.typeCode","government");
json.UpdateString("customerDetails.ultimateConsigneeDetails.postalAddress.postalCode","14800");
json.UpdateString("customerDetails.ultimateConsigneeDetails.postalAddress.cityName","Prague");
json.UpdateString("customerDetails.ultimateConsigneeDetails.postalAddress.countryCode","CZ");
json.UpdateString("customerDetails.ultimateConsigneeDetails.postalAddress.addressLine1","V Parku 2308/10");
json.UpdateString("customerDetails.ultimateConsigneeDetails.postalAddress.provinceCode","CZ");
json.UpdateString("customerDetails.ultimateConsigneeDetails.postalAddress.addressLine2","addres2");
json.UpdateString("customerDetails.ultimateConsigneeDetails.postalAddress.addressLine3","addres3");
json.UpdateString("customerDetails.ultimateConsigneeDetails.postalAddress.countyName","Central Bohemia");
json.UpdateString("customerDetails.ultimateConsigneeDetails.contactInformation.phone","+1123456789");
json.UpdateString("customerDetails.ultimateConsigneeDetails.contactInformation.companyName","Company Name");
json.UpdateString("customerDetails.ultimateConsigneeDetails.contactInformation.fullName","John Brew");
json.UpdateString("customerDetails.ultimateConsigneeDetails.contactInformation.email","that@before.de");
json.UpdateString("customerDetails.ultimateConsigneeDetails.contactInformation.mobilePhone","+60112345678");
json.UpdateString("customerDetails.ultimateConsigneeDetails.typeCode","other");
json.UpdateString("customerDetails.ultimateConsigneeDetails.registrationNumbers[0].typeCode","VAT");
json.UpdateString("customerDetails.ultimateConsigneeDetails.registrationNumbers[0].number","CZ123456789");
json.UpdateString("customerDetails.ultimateConsigneeDetails.registrationNumbers[0].issuerCountryCode","CZ");
json.UpdateString("customerDetails.ultimateConsigneeDetails.registrationNumbers[1].typeCode","VAT");
json.UpdateString("customerDetails.ultimateConsigneeDetails.registrationNumbers[1].number","CZ123456789");
json.UpdateString("customerDetails.ultimateConsigneeDetails.registrationNumbers[1].issuerCountryCode","CZ");
http.SetRequestHeader("Webstore-Platform-Name","");
http.SetRequestHeader("Shipping-System-Platform-Name","");
http.SetRequestHeader("Message-Reference","d0e7832e-5c98-11ea-bc55-0242ac13");
http.SetRequestHeader("Plugin-Version","");
http.SetRequestHeader("Content-Type","application/json");
http.SetRequestHeader("Plugin-Name","");
http.SetRequestHeader("Shipping-System-Platform-Version","");
http.SetRequestHeader("Accept","application/json");
http.SetRequestHeader("Message-Reference-Date","Wed, 21 Oct 2015 07:28:00 GMT");
http.SetRequestHeader("Webstore-Platform-Version","");
Chilkat.StringBuilder sbRequestBody = new Chilkat.StringBuilder();
json.EmitSb(sbRequestBody);
Chilkat.HttpResponse resp = http.PTextSb("PATCH","https://api-mock.dhl.com/mydhlapi/shipments/:shipmentTrackingNumber/upload-invoice-data",sbRequestBody,"utf-8","application/json",false,false);
if (http.LastMethodSuccess == false) {
Debug.WriteLine(http.LastErrorText);
return;
}
Debug.WriteLine(Convert.ToString(resp.StatusCode));
Debug.WriteLine(resp.BodyStr);
Curl Command
curl -X PATCH
-u '<Basic Auth Username>:<Basic Auth Password>'
-H "Message-Reference: d0e7832e-5c98-11ea-bc55-0242ac13"
-H "Message-Reference-Date: Wed, 21 Oct 2015 07:28:00 GMT"
-H "Plugin-Name: "
-H "Plugin-Version: "
-H "Shipping-System-Platform-Name: "
-H "Shipping-System-Platform-Version: "
-H "Webstore-Platform-Name: "
-H "Webstore-Platform-Version: "
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"content": {
"exportDeclaration": [
{
"lineItems": [
{
"number": 1,
"description": "line item description",
"price": 150,
"quantity": {
"value": 1,
"unitOfMeasurement": "BOX"
},
"manufacturerCountry": "CZ",
"weight": {
"netValue": {
"value": "<Error: Too many levels of nesting to fake this schema>"
}
},
"commodityCodes": [
{
"typeCode": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"value": {
"value": "<Error: Too many levels of nesting to fake this schema>"
}
}
],
"exportReasonType": "defence_material",
"isTaxesPaid": true,
"customerReferences": [
{
"typeCode": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"value": {
"value": "<Error: Too many levels of nesting to fake this schema>"
}
}
],
"customsDocuments": [
{
"typeCode": {
"value": "<Error: Too many levels of nesting to fake this schema>"
},
"value": {
"value": "<Error: Too many levels of nesting to fake this schema>"
}
}
]
}
],
"invoice": {
"number": "12345-ABC",
"date": "2021-03-18",
"function": "import",
"customerReferences": [
{
"typeCode": "CU",
"value": "custref112"
}
]
},
"incoterm": "DAP",
"remarks": [
{
"value": "declaration remark"
},
{
"value": "declaration remark"
}
],
"additionalCharges": [
{
"value": 10,
"typeCode": "pickup"
},
{
"value": 10,
"typeCode": "pickup"
}
],
"placeOfIncoterm": "port of departure or destination details",
"recipientReference": "recipient reference",
"exporter": {
"id": "123",
"code": "EXPCZ"
},
"exportReasonType": "permanent",
"shipmentType": "personal",
"customsDocuments": [
{
"typeCode": "972",
"value": "custdoc445"
}
]
}
],
"currency": "EUR",
"unitOfMeasurement": "metric"
},
"plannedShipDate": "2020-04-20",
"accounts": [
{
"typeCode": "shipper",
"number": "123456789"
},
{
"typeCode": "shipper",
"number": "123456789"
}
],
"outputImageProperties": {
"imageOptions": [
{
"typeCode": "invoice",
"templateName": "COMMERCIAL_INVOICE_P_10",
"isRequested": true
}
]
},
"customerDetails": {
"sellerDetails": {
"postalAddress": {
"postalCode": "14800",
"cityName": "Prague",
"countryCode": "CZ",
"addressLine1": "V Parku 2308/10",
"provinceCode": "CZ",
"addressLine2": "addres2",
"addressLine3": "addres3",
"countyName": "Central Bohemia"
},
"contactInformation": {
"phone": "+1123456789",
"companyName": "Company Name",
"fullName": "John Brew",
"email": "that@before.de",
"mobilePhone": "+60112345678"
},
"typeCode": "business",
"registrationNumbers": [
{
"typeCode": "VAT",
"number": "CZ123456789",
"issuerCountryCode": "CZ"
},
{
"typeCode": "VAT",
"number": "CZ123456789",
"issuerCountryCode": "CZ"
}
]
},
"buyerDetails": {
"postalAddress": {
"postalCode": "14800",
"cityName": "Prague",
"countryCode": "CZ",
"addressLine1": "V Parku 2308/10",
"provinceCode": "CZ",
"addressLine2": "addres2",
"addressLine3": "addres3",
"countyName": "Central Bohemia"
},
"contactInformation": {
"phone": "+1123456789",
"companyName": "Company Name",
"fullName": "John Brew",
"email": "that@before.de",
"mobilePhone": "+60112345678"
},
"registrationNumbers": [
{
"typeCode": "VAT",
"number": "CZ123456789",
"issuerCountryCode": "CZ"
},
{
"typeCode": "VAT",
"number": "CZ123456789",
"issuerCountryCode": "CZ"
}
],
"typeCode": "business"
},
"importerDetails": {
"postalAddress": {
"postalCode": "14800",
"cityName": "Prague",
"countryCode": "CZ",
"addressLine1": "V Parku 2308/10",
"provinceCode": "CZ",
"addressLine2": "addres2",
"addressLine3": "addres3",
"countyName": "Central Bohemia"
},
"contactInformation": {
"phone": "+1123456789",
"companyName": "Company Name",
"fullName": "John Brew",
"email": "that@before.de",
"mobilePhone": "+60112345678"
},
"registrationNumbers": [
{
"typeCode": "VAT",
"number": "CZ123456789",
"issuerCountryCode": "CZ"
},
{
"typeCode": "VAT",
"number": "CZ123456789",
"issuerCountryCode": "CZ"
}
],
"typeCode": "government"
},
"exporterDetails": {
"postalAddress": {
"postalCode": "14800",
"cityName": "Prague",
"countryCode": "CZ",
"addressLine1": "V Parku 2308/10",
"provinceCode": "CZ",
"addressLine2": "addres2",
"addressLine3": "addres3",
"countyName": "Central Bohemia"
},
"contactInformation": {
"phone": "+1123456789",
"companyName": "Company Name",
"fullName": "John Brew",
"email": "that@before.de",
"mobilePhone": "+60112345678"
},
"registrationNumbers": [
{
"typeCode": "VAT",
"number": "CZ123456789",
"issuerCountryCode": "CZ"
},
{
"typeCode": "VAT",
"number": "CZ123456789",
"issuerCountryCode": "CZ"
}
],
"typeCode": "government"
},
"ultimateConsigneeDetails": {
"postalAddress": {
"postalCode": "14800",
"cityName": "Prague",
"countryCode": "CZ",
"addressLine1": "V Parku 2308/10",
"provinceCode": "CZ",
"addressLine2": "addres2",
"addressLine3": "addres3",
"countyName": "Central Bohemia"
},
"contactInformation": {
"phone": "+1123456789",
"companyName": "Company Name",
"fullName": "John Brew",
"email": "that@before.de",
"mobilePhone": "+60112345678"
},
"typeCode": "other",
"registrationNumbers": [
{
"typeCode": "VAT",
"number": "CZ123456789",
"issuerCountryCode": "CZ"
},
{
"typeCode": "VAT",
"number": "CZ123456789",
"issuerCountryCode": "CZ"
}
]
}
}
}'
https://api-mock.dhl.com/mydhlapi/shipments/:shipmentTrackingNumber/upload-invoice-data
Postman Collection Item JSON
{
"name": "Upload Commercial Invoice data for your DHL Express shipment",
"request": {
"method": "PATCH",
"header": [
{
"description": "Please provide message reference\n",
"key": "Message-Reference",
"value": "d0e7832e-5c98-11ea-bc55-0242ac13"
},
{
"description": "Optional reference date in the HTTP-date format https://tools.ietf.org/html/rfc7231#section-7.1.1.2",
"key": "Message-Reference-Date",
"value": "Wed, 21 Oct 2015 07:28:00 GMT"
},
{
"description": "Please provide name of the plugin (applicable to 3PV only)\n",
"key": "Plugin-Name",
"value": " "
},
{
"description": "Please provide version of the plugin (applicable to 3PV only)\n",
"key": "Plugin-Version",
"value": " "
},
{
"description": "Please provide name of the shipping platform(applicable to 3PV only)\n",
"key": "Shipping-System-Platform-Name",
"value": " "
},
{
"description": "Please provide version of the shipping platform (applicable to 3PV only)\n",
"key": "Shipping-System-Platform-Version",
"value": " "
},
{
"description": "Please provide name of the webstore platform (applicable to 3PV only)\n",
"key": "Webstore-Platform-Name",
"value": " "
},
{
"description": "Please provide version of the webstore platform (applicable to 3PV only)\n",
"key": "Webstore-Platform-Version",
"value": " "
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"content\": {\n \"exportDeclaration\": [\n {\n \"lineItems\": [\n {\n \"number\": 1,\n \"description\": \"line item description\",\n \"price\": 150,\n \"quantity\": {\n \"value\": 1,\n \"unitOfMeasurement\": \"BOX\"\n },\n \"manufacturerCountry\": \"CZ\",\n \"weight\": {\n \"netValue\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"commodityCodes\": [\n {\n \"typeCode\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"value\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n }\n ],\n \"exportReasonType\": \"defence_material\",\n \"isTaxesPaid\": true,\n \"customerReferences\": [\n {\n \"typeCode\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"value\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n }\n ],\n \"customsDocuments\": [\n {\n \"typeCode\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"value\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n }\n ]\n }\n ],\n \"invoice\": {\n \"number\": \"12345-ABC\",\n \"date\": \"2021-03-18\",\n \"function\": \"import\",\n \"customerReferences\": [\n {\n \"typeCode\": \"CU\",\n \"value\": \"custref112\"\n }\n ]\n },\n \"incoterm\": \"DAP\",\n \"remarks\": [\n {\n \"value\": \"declaration remark\"\n },\n {\n \"value\": \"declaration remark\"\n }\n ],\n \"additionalCharges\": [\n {\n \"value\": 10,\n \"typeCode\": \"pickup\"\n },\n {\n \"value\": 10,\n \"typeCode\": \"pickup\"\n }\n ],\n \"placeOfIncoterm\": \"port of departure or destination details\",\n \"recipientReference\": \"recipient reference\",\n \"exporter\": {\n \"id\": \"123\",\n \"code\": \"EXPCZ\"\n },\n \"exportReasonType\": \"permanent\",\n \"shipmentType\": \"personal\",\n \"customsDocuments\": [\n {\n \"typeCode\": \"972\",\n \"value\": \"custdoc445\"\n }\n ]\n }\n ],\n \"currency\": \"EUR\",\n \"unitOfMeasurement\": \"metric\"\n },\n \"plannedShipDate\": \"2020-04-20\",\n \"accounts\": [\n {\n \"typeCode\": \"shipper\",\n \"number\": \"123456789\"\n },\n {\n \"typeCode\": \"shipper\",\n \"number\": \"123456789\"\n }\n ],\n \"outputImageProperties\": {\n \"imageOptions\": [\n {\n \"typeCode\": \"invoice\",\n \"templateName\": \"COMMERCIAL_INVOICE_P_10\",\n \"isRequested\": true\n }\n ]\n },\n \"customerDetails\": {\n \"sellerDetails\": {\n \"postalAddress\": {\n \"postalCode\": \"14800\",\n \"cityName\": \"Prague\",\n \"countryCode\": \"CZ\",\n \"addressLine1\": \"V Parku 2308/10\",\n \"provinceCode\": \"CZ\",\n \"addressLine2\": \"addres2\",\n \"addressLine3\": \"addres3\",\n \"countyName\": \"Central Bohemia\"\n },\n \"contactInformation\": {\n \"phone\": \"+1123456789\",\n \"companyName\": \"Company Name\",\n \"fullName\": \"John Brew\",\n \"email\": \"that@before.de\",\n \"mobilePhone\": \"+60112345678\"\n },\n \"typeCode\": \"business\",\n \"registrationNumbers\": [\n {\n \"typeCode\": \"VAT\",\n \"number\": \"CZ123456789\",\n \"issuerCountryCode\": \"CZ\"\n },\n {\n \"typeCode\": \"VAT\",\n \"number\": \"CZ123456789\",\n \"issuerCountryCode\": \"CZ\"\n }\n ]\n },\n \"buyerDetails\": {\n \"postalAddress\": {\n \"postalCode\": \"14800\",\n \"cityName\": \"Prague\",\n \"countryCode\": \"CZ\",\n \"addressLine1\": \"V Parku 2308/10\",\n \"provinceCode\": \"CZ\",\n \"addressLine2\": \"addres2\",\n \"addressLine3\": \"addres3\",\n \"countyName\": \"Central Bohemia\"\n },\n \"contactInformation\": {\n \"phone\": \"+1123456789\",\n \"companyName\": \"Company Name\",\n \"fullName\": \"John Brew\",\n \"email\": \"that@before.de\",\n \"mobilePhone\": \"+60112345678\"\n },\n \"registrationNumbers\": [\n {\n \"typeCode\": \"VAT\",\n \"number\": \"CZ123456789\",\n \"issuerCountryCode\": \"CZ\"\n },\n {\n \"typeCode\": \"VAT\",\n \"number\": \"CZ123456789\",\n \"issuerCountryCode\": \"CZ\"\n }\n ],\n \"typeCode\": \"business\"\n },\n \"importerDetails\": {\n \"postalAddress\": {\n \"postalCode\": \"14800\",\n \"cityName\": \"Prague\",\n \"countryCode\": \"CZ\",\n \"addressLine1\": \"V Parku 2308/10\",\n \"provinceCode\": \"CZ\",\n \"addressLine2\": \"addres2\",\n \"addressLine3\": \"addres3\",\n \"countyName\": \"Central Bohemia\"\n },\n \"contactInformation\": {\n \"phone\": \"+1123456789\",\n \"companyName\": \"Company Name\",\n \"fullName\": \"John Brew\",\n \"email\": \"that@before.de\",\n \"mobilePhone\": \"+60112345678\"\n },\n \"registrationNumbers\": [\n {\n \"typeCode\": \"VAT\",\n \"number\": \"CZ123456789\",\n \"issuerCountryCode\": \"CZ\"\n },\n {\n \"typeCode\": \"VAT\",\n \"number\": \"CZ123456789\",\n \"issuerCountryCode\": \"CZ\"\n }\n ],\n \"typeCode\": \"government\"\n },\n \"exporterDetails\": {\n \"postalAddress\": {\n \"postalCode\": \"14800\",\n \"cityName\": \"Prague\",\n \"countryCode\": \"CZ\",\n \"addressLine1\": \"V Parku 2308/10\",\n \"provinceCode\": \"CZ\",\n \"addressLine2\": \"addres2\",\n \"addressLine3\": \"addres3\",\n \"countyName\": \"Central Bohemia\"\n },\n \"contactInformation\": {\n \"phone\": \"+1123456789\",\n \"companyName\": \"Company Name\",\n \"fullName\": \"John Brew\",\n \"email\": \"that@before.de\",\n \"mobilePhone\": \"+60112345678\"\n },\n \"registrationNumbers\": [\n {\n \"typeCode\": \"VAT\",\n \"number\": \"CZ123456789\",\n \"issuerCountryCode\": \"CZ\"\n },\n {\n \"typeCode\": \"VAT\",\n \"number\": \"CZ123456789\",\n \"issuerCountryCode\": \"CZ\"\n }\n ],\n \"typeCode\": \"government\"\n },\n \"ultimateConsigneeDetails\": {\n \"postalAddress\": {\n \"postalCode\": \"14800\",\n \"cityName\": \"Prague\",\n \"countryCode\": \"CZ\",\n \"addressLine1\": \"V Parku 2308/10\",\n \"provinceCode\": \"CZ\",\n \"addressLine2\": \"addres2\",\n \"addressLine3\": \"addres3\",\n \"countyName\": \"Central Bohemia\"\n },\n \"contactInformation\": {\n \"phone\": \"+1123456789\",\n \"companyName\": \"Company Name\",\n \"fullName\": \"John Brew\",\n \"email\": \"that@before.de\",\n \"mobilePhone\": \"+60112345678\"\n },\n \"typeCode\": \"other\",\n \"registrationNumbers\": [\n {\n \"typeCode\": \"VAT\",\n \"number\": \"CZ123456789\",\n \"issuerCountryCode\": \"CZ\"\n },\n {\n \"typeCode\": \"VAT\",\n \"number\": \"CZ123456789\",\n \"issuerCountryCode\": \"CZ\"\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/shipments/:shipmentTrackingNumber/upload-invoice-data",
"host": [
"{{baseUrl}}"
],
"path": [
"shipments",
":shipmentTrackingNumber",
"upload-invoice-data"
],
"variable": [
{
"key": "shipmentTrackingNumber",
"value": "dolor veniam officia non",
"description": "(Required) DHL Express shipment identification number"
}
]
},
"description": "## Upload Invoice Data with Shipment ID\nThe upload invoice data service can be used to upload Commerical Invoice data with Shipment Identification Number for your DHL Express shipment.Customer can provide Commercial Invoice data before Shipment Data via Create Shipment flow or vice versa.\n\nImportant Note: UploadInvoiceData service is not enabled by default and must be requested per customer. Use of this service is only enabled on exceptional basis and DHL Express recommends to submit shipment requests together with a commercial invoice data.To enable use of UploadInvoiceData service, please contact your DHL Express IT representative. To use UploadInvoiceData service, it is required that \"PM\" service code is provided in MyDHL API Create Shipment request. \"PM\" service code is not enabled by \ndefault for the customers, and needs to be enabled upon request.\n\nWhen Shipment is created via MyDHL API Create Shipment service before uploading the Commercial Invoice (CIN) data,it is mandatory to provide the Shipment Identification Number as received in MyDHL API Create Shipment service Response.\nWhen Commercial Invoice (CIN) data is uploaded prior to creating a shipment via MyDHL API Create Shipment service, it is mandatory to provide Invoice Reference Number with Invoice Reference Type value \"CU\" and Shipper Account Number. \n\nThese elements are mandatory to facilitate an effective data merge of the Commercial Invoice (CIN) data with Shipment Data. As an output customer will receive Notification element value '0' on successful upload of Commercial Invoice (CIN) data. \nDHL backend application performs the subsequent data merging process of the Shipment Data and Commercial Invoice data.\n"
},
"response": [
{
"name": "invoice data uploaded",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
},
{
"description": "Please provide message reference\n",
"key": "Message-Reference",
"value": "d0e7832e-5c98-11ea-bc55-0242ac13"
},
{
"description": "Optional reference date in the HTTP-date format https://tools.ietf.org/html/rfc7231#section-7.1.1.2",
"key": "Message-Reference-Date",
"value": "Wed, 21 Oct 2015 07:28:00 GMT"
},
{
"description": "Please provide name of the plugin (applicable to 3PV only)\n",
"key": "Plugin-Name",
"value": " "
},
{
"description": "Please provide version of the plugin (applicable to 3PV only)\n",
"key": "Plugin-Version",
"value": " "
},
{
"description": "Please provide name of the shipping platform(applicable to 3PV only)\n",
"key": "Shipping-System-Platform-Name",
"value": " "
},
{
"description": "Please provide version of the shipping platform (applicable to 3PV only)\n",
"key": "Shipping-System-Platform-Version",
"value": " "
},
{
"description": "Please provide name of the webstore platform (applicable to 3PV only)\n",
"key": "Webstore-Platform-Name",
"value": " "
},
{
"description": "Please provide version of the webstore platform (applicable to 3PV only)\n",
"key": "Webstore-Platform-Version",
"value": " "
}
],
"body": {
"mode": "raw",
"raw": "{\n \"content\": {\n \"exportDeclaration\": [\n {\n \"lineItems\": [\n {\n \"number\": 1,\n \"description\": \"line item description\",\n \"price\": 150,\n \"quantity\": {\n \"value\": 1,\n \"unitOfMeasurement\": \"BOX\"\n },\n \"manufacturerCountry\": \"CZ\",\n \"weight\": {\n \"netValue\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"commodityCodes\": [\n {\n \"typeCode\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"value\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n }\n ],\n \"exportReasonType\": \"defence_material\",\n \"isTaxesPaid\": true,\n \"customerReferences\": [\n {\n \"typeCode\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"value\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n }\n ],\n \"customsDocuments\": [\n {\n \"typeCode\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"value\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n }\n ]\n }\n ],\n \"invoice\": {\n \"number\": \"12345-ABC\",\n \"date\": \"2021-03-18\",\n \"function\": \"import\",\n \"customerReferences\": [\n {\n \"typeCode\": \"CU\",\n \"value\": \"custref112\"\n }\n ]\n },\n \"incoterm\": \"DAP\",\n \"remarks\": [\n {\n \"value\": \"declaration remark\"\n },\n {\n \"value\": \"declaration remark\"\n }\n ],\n \"additionalCharges\": [\n {\n \"value\": 10,\n \"typeCode\": \"pickup\"\n },\n {\n \"value\": 10,\n \"typeCode\": \"pickup\"\n }\n ],\n \"placeOfIncoterm\": \"port of departure or destination details\",\n \"recipientReference\": \"recipient reference\",\n \"exporter\": {\n \"id\": \"123\",\n \"code\": \"EXPCZ\"\n },\n \"exportReasonType\": \"permanent\",\n \"shipmentType\": \"personal\",\n \"customsDocuments\": [\n {\n \"typeCode\": \"972\",\n \"value\": \"custdoc445\"\n }\n ]\n }\n ],\n \"currency\": \"EUR\",\n \"unitOfMeasurement\": \"metric\"\n },\n \"plannedShipDate\": \"2020-04-20\",\n \"accounts\": [\n {\n \"typeCode\": \"shipper\",\n \"number\": \"123456789\"\n },\n {\n \"typeCode\": \"shipper\",\n \"number\": \"123456789\"\n }\n ],\n \"outputImageProperties\": {\n \"imageOptions\": [\n {\n \"typeCode\": \"invoice\",\n \"templateName\": \"COMMERCIAL_INVOICE_P_10\",\n \"isRequested\": true\n }\n ]\n },\n \"customerDetails\": {\n \"sellerDetails\": {\n \"postalAddress\": {\n \"postalCode\": \"14800\",\n \"cityName\": \"Prague\",\n \"countryCode\": \"CZ\",\n \"addressLine1\": \"V Parku 2308/10\",\n \"provinceCode\": \"CZ\",\n \"addressLine2\": \"addres2\",\n \"addressLine3\": \"addres3\",\n \"countyName\": \"Central Bohemia\"\n },\n \"contactInformation\": {\n \"phone\": \"+1123456789\",\n \"companyName\": \"Company Name\",\n \"fullName\": \"John Brew\",\n \"email\": \"that@before.de\",\n \"mobilePhone\": \"+60112345678\"\n },\n \"typeCode\": \"business\",\n \"registrationNumbers\": [\n {\n \"typeCode\": \"VAT\",\n \"number\": \"CZ123456789\",\n \"issuerCountryCode\": \"CZ\"\n },\n {\n \"typeCode\": \"VAT\",\n \"number\": \"CZ123456789\",\n \"issuerCountryCode\": \"CZ\"\n }\n ]\n },\n \"buyerDetails\": {\n \"postalAddress\": {\n \"postalCode\": \"14800\",\n \"cityName\": \"Prague\",\n \"countryCode\": \"CZ\",\n \"addressLine1\": \"V Parku 2308/10\",\n \"provinceCode\": \"CZ\",\n \"addressLine2\": \"addres2\",\n \"addressLine3\": \"addres3\",\n \"countyName\": \"Central Bohemia\"\n },\n \"contactInformation\": {\n \"phone\": \"+1123456789\",\n \"companyName\": \"Company Name\",\n \"fullName\": \"John Brew\",\n \"email\": \"that@before.de\",\n \"mobilePhone\": \"+60112345678\"\n },\n \"registrationNumbers\": [\n {\n \"typeCode\": \"VAT\",\n \"number\": \"CZ123456789\",\n \"issuerCountryCode\": \"CZ\"\n },\n {\n \"typeCode\": \"VAT\",\n \"number\": \"CZ123456789\",\n \"issuerCountryCode\": \"CZ\"\n }\n ],\n \"typeCode\": \"business\"\n },\n \"importerDetails\": {\n \"postalAddress\": {\n \"postalCode\": \"14800\",\n \"cityName\": \"Prague\",\n \"countryCode\": \"CZ\",\n \"addressLine1\": \"V Parku 2308/10\",\n \"provinceCode\": \"CZ\",\n \"addressLine2\": \"addres2\",\n \"addressLine3\": \"addres3\",\n \"countyName\": \"Central Bohemia\"\n },\n \"contactInformation\": {\n \"phone\": \"+1123456789\",\n \"companyName\": \"Company Name\",\n \"fullName\": \"John Brew\",\n \"email\": \"that@before.de\",\n \"mobilePhone\": \"+60112345678\"\n },\n \"registrationNumbers\": [\n {\n \"typeCode\": \"VAT\",\n \"number\": \"CZ123456789\",\n \"issuerCountryCode\": \"CZ\"\n },\n {\n \"typeCode\": \"VAT\",\n \"number\": \"CZ123456789\",\n \"issuerCountryCode\": \"CZ\"\n }\n ],\n \"typeCode\": \"government\"\n },\n \"exporterDetails\": {\n \"postalAddress\": {\n \"postalCode\": \"14800\",\n \"cityName\": \"Prague\",\n \"countryCode\": \"CZ\",\n \"addressLine1\": \"V Parku 2308/10\",\n \"provinceCode\": \"CZ\",\n \"addressLine2\": \"addres2\",\n \"addressLine3\": \"addres3\",\n \"countyName\": \"Central Bohemia\"\n },\n \"contactInformation\": {\n \"phone\": \"+1123456789\",\n \"companyName\": \"Company Name\",\n \"fullName\": \"John Brew\",\n \"email\": \"that@before.de\",\n \"mobilePhone\": \"+60112345678\"\n },\n \"registrationNumbers\": [\n {\n \"typeCode\": \"VAT\",\n \"number\": \"CZ123456789\",\n \"issuerCountryCode\": \"CZ\"\n },\n {\n \"typeCode\": \"VAT\",\n \"number\": \"CZ123456789\",\n \"issuerCountryCode\": \"CZ\"\n }\n ],\n \"typeCode\": \"government\"\n },\n \"ultimateConsigneeDetails\": {\n \"postalAddress\": {\n \"postalCode\": \"14800\",\n \"cityName\": \"Prague\",\n \"countryCode\": \"CZ\",\n \"addressLine1\": \"V Parku 2308/10\",\n \"provinceCode\": \"CZ\",\n \"addressLine2\": \"addres2\",\n \"addressLine3\": \"addres3\",\n \"countyName\": \"Central Bohemia\"\n },\n \"contactInformation\": {\n \"phone\": \"+1123456789\",\n \"companyName\": \"Company Name\",\n \"fullName\": \"John Brew\",\n \"email\": \"that@before.de\",\n \"mobilePhone\": \"+60112345678\"\n },\n \"typeCode\": \"other\",\n \"registrationNumbers\": [\n {\n \"typeCode\": \"VAT\",\n \"number\": \"CZ123456789\",\n \"issuerCountryCode\": \"CZ\"\n },\n {\n \"typeCode\": \"VAT\",\n \"number\": \"CZ123456789\",\n \"issuerCountryCode\": \"CZ\"\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/shipments/:shipmentTrackingNumber/upload-invoice-data",
"host": [
"{{baseUrl}}"
],
"path": [
"shipments",
":shipmentTrackingNumber",
"upload-invoice-data"
],
"variable": [
{
"key": "shipmentTrackingNumber",
"value": "dolor veniam officia non",
"description": "(Required) DHL Express shipment identification number"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Invocation-Id",
"value": "sed ut mollit",
"description": "Unique identifier of the transaction"
},
{
"key": "Message-Reference",
"value": "sed ut mollit",
"description": "Message reference provided by customer as part of reqeust or automatically generated when not provided"
},
{
"key": "Content-Language",
"value": "sed ut mollit",
"description": ""
},
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "Wrong input parameters",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
},
{
"description": "Please provide message reference\n",
"key": "Message-Reference",
"value": "d0e7832e-5c98-11ea-bc55-0242ac13"
},
{
"description": "Optional reference date in the HTTP-date format https://tools.ietf.org/html/rfc7231#section-7.1.1.2",
"key": "Message-Reference-Date",
"value": "Wed, 21 Oct 2015 07:28:00 GMT"
},
{
"description": "Please provide name of the plugin (applicable to 3PV only)\n",
"key": "Plugin-Name",
"value": " "
},
{
"description": "Please provide version of the plugin (applicable to 3PV only)\n",
"key": "Plugin-Version",
"value": " "
},
{
"description": "Please provide name of the shipping platform(applicable to 3PV only)\n",
"key": "Shipping-System-Platform-Name",
"value": " "
},
{
"description": "Please provide version of the shipping platform (applicable to 3PV only)\n",
"key": "Shipping-System-Platform-Version",
"value": " "
},
{
"description": "Please provide name of the webstore platform (applicable to 3PV only)\n",
"key": "Webstore-Platform-Name",
"value": " "
},
{
"description": "Please provide version of the webstore platform (applicable to 3PV only)\n",
"key": "Webstore-Platform-Version",
"value": " "
}
],
"body": {
"mode": "raw",
"raw": "{\n \"content\": {\n \"exportDeclaration\": [\n {\n \"lineItems\": [\n {\n \"number\": 1,\n \"description\": \"line item description\",\n \"price\": 150,\n \"quantity\": {\n \"value\": 1,\n \"unitOfMeasurement\": \"BOX\"\n },\n \"manufacturerCountry\": \"CZ\",\n \"weight\": {\n \"netValue\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"commodityCodes\": [\n {\n \"typeCode\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"value\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n }\n ],\n \"exportReasonType\": \"defence_material\",\n \"isTaxesPaid\": true,\n \"customerReferences\": [\n {\n \"typeCode\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"value\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n }\n ],\n \"customsDocuments\": [\n {\n \"typeCode\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"value\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n }\n ]\n }\n ],\n \"invoice\": {\n \"number\": \"12345-ABC\",\n \"date\": \"2021-03-18\",\n \"function\": \"import\",\n \"customerReferences\": [\n {\n \"typeCode\": \"CU\",\n \"value\": \"custref112\"\n }\n ]\n },\n \"incoterm\": \"DAP\",\n \"remarks\": [\n {\n \"value\": \"declaration remark\"\n },\n {\n \"value\": \"declaration remark\"\n }\n ],\n \"additionalCharges\": [\n {\n \"value\": 10,\n \"typeCode\": \"pickup\"\n },\n {\n \"value\": 10,\n \"typeCode\": \"pickup\"\n }\n ],\n \"placeOfIncoterm\": \"port of departure or destination details\",\n \"recipientReference\": \"recipient reference\",\n \"exporter\": {\n \"id\": \"123\",\n \"code\": \"EXPCZ\"\n },\n \"exportReasonType\": \"permanent\",\n \"shipmentType\": \"personal\",\n \"customsDocuments\": [\n {\n \"typeCode\": \"972\",\n \"value\": \"custdoc445\"\n }\n ]\n }\n ],\n \"currency\": \"EUR\",\n \"unitOfMeasurement\": \"metric\"\n },\n \"plannedShipDate\": \"2020-04-20\",\n \"accounts\": [\n {\n \"typeCode\": \"shipper\",\n \"number\": \"123456789\"\n },\n {\n \"typeCode\": \"shipper\",\n \"number\": \"123456789\"\n }\n ],\n \"outputImageProperties\": {\n \"imageOptions\": [\n {\n \"typeCode\": \"invoice\",\n \"templateName\": \"COMMERCIAL_INVOICE_P_10\",\n \"isRequested\": true\n }\n ]\n },\n \"customerDetails\": {\n \"sellerDetails\": {\n \"postalAddress\": {\n \"postalCode\": \"14800\",\n \"cityName\": \"Prague\",\n \"countryCode\": \"CZ\",\n \"addressLine1\": \"V Parku 2308/10\",\n \"provinceCode\": \"CZ\",\n \"addressLine2\": \"addres2\",\n \"addressLine3\": \"addres3\",\n \"countyName\": \"Central Bohemia\"\n },\n \"contactInformation\": {\n \"phone\": \"+1123456789\",\n \"companyName\": \"Company Name\",\n \"fullName\": \"John Brew\",\n \"email\": \"that@before.de\",\n \"mobilePhone\": \"+60112345678\"\n },\n \"typeCode\": \"business\",\n \"registrationNumbers\": [\n {\n \"typeCode\": \"VAT\",\n \"number\": \"CZ123456789\",\n \"issuerCountryCode\": \"CZ\"\n },\n {\n \"typeCode\": \"VAT\",\n \"number\": \"CZ123456789\",\n \"issuerCountryCode\": \"CZ\"\n }\n ]\n },\n \"buyerDetails\": {\n \"postalAddress\": {\n \"postalCode\": \"14800\",\n \"cityName\": \"Prague\",\n \"countryCode\": \"CZ\",\n \"addressLine1\": \"V Parku 2308/10\",\n \"provinceCode\": \"CZ\",\n \"addressLine2\": \"addres2\",\n \"addressLine3\": \"addres3\",\n \"countyName\": \"Central Bohemia\"\n },\n \"contactInformation\": {\n \"phone\": \"+1123456789\",\n \"companyName\": \"Company Name\",\n \"fullName\": \"John Brew\",\n \"email\": \"that@before.de\",\n \"mobilePhone\": \"+60112345678\"\n },\n \"registrationNumbers\": [\n {\n \"typeCode\": \"VAT\",\n \"number\": \"CZ123456789\",\n \"issuerCountryCode\": \"CZ\"\n },\n {\n \"typeCode\": \"VAT\",\n \"number\": \"CZ123456789\",\n \"issuerCountryCode\": \"CZ\"\n }\n ],\n \"typeCode\": \"business\"\n },\n \"importerDetails\": {\n \"postalAddress\": {\n \"postalCode\": \"14800\",\n \"cityName\": \"Prague\",\n \"countryCode\": \"CZ\",\n \"addressLine1\": \"V Parku 2308/10\",\n \"provinceCode\": \"CZ\",\n \"addressLine2\": \"addres2\",\n \"addressLine3\": \"addres3\",\n \"countyName\": \"Central Bohemia\"\n },\n \"contactInformation\": {\n \"phone\": \"+1123456789\",\n \"companyName\": \"Company Name\",\n \"fullName\": \"John Brew\",\n \"email\": \"that@before.de\",\n \"mobilePhone\": \"+60112345678\"\n },\n \"registrationNumbers\": [\n {\n \"typeCode\": \"VAT\",\n \"number\": \"CZ123456789\",\n \"issuerCountryCode\": \"CZ\"\n },\n {\n \"typeCode\": \"VAT\",\n \"number\": \"CZ123456789\",\n \"issuerCountryCode\": \"CZ\"\n }\n ],\n \"typeCode\": \"government\"\n },\n \"exporterDetails\": {\n \"postalAddress\": {\n \"postalCode\": \"14800\",\n \"cityName\": \"Prague\",\n \"countryCode\": \"CZ\",\n \"addressLine1\": \"V Parku 2308/10\",\n \"provinceCode\": \"CZ\",\n \"addressLine2\": \"addres2\",\n \"addressLine3\": \"addres3\",\n \"countyName\": \"Central Bohemia\"\n },\n \"contactInformation\": {\n \"phone\": \"+1123456789\",\n \"companyName\": \"Company Name\",\n \"fullName\": \"John Brew\",\n \"email\": \"that@before.de\",\n \"mobilePhone\": \"+60112345678\"\n },\n \"registrationNumbers\": [\n {\n \"typeCode\": \"VAT\",\n \"number\": \"CZ123456789\",\n \"issuerCountryCode\": \"CZ\"\n },\n {\n \"typeCode\": \"VAT\",\n \"number\": \"CZ123456789\",\n \"issuerCountryCode\": \"CZ\"\n }\n ],\n \"typeCode\": \"government\"\n },\n \"ultimateConsigneeDetails\": {\n \"postalAddress\": {\n \"postalCode\": \"14800\",\n \"cityName\": \"Prague\",\n \"countryCode\": \"CZ\",\n \"addressLine1\": \"V Parku 2308/10\",\n \"provinceCode\": \"CZ\",\n \"addressLine2\": \"addres2\",\n \"addressLine3\": \"addres3\",\n \"countyName\": \"Central Bohemia\"\n },\n \"contactInformation\": {\n \"phone\": \"+1123456789\",\n \"companyName\": \"Company Name\",\n \"fullName\": \"John Brew\",\n \"email\": \"that@before.de\",\n \"mobilePhone\": \"+60112345678\"\n },\n \"typeCode\": \"other\",\n \"registrationNumbers\": [\n {\n \"typeCode\": \"VAT\",\n \"number\": \"CZ123456789\",\n \"issuerCountryCode\": \"CZ\"\n },\n {\n \"typeCode\": \"VAT\",\n \"number\": \"CZ123456789\",\n \"issuerCountryCode\": \"CZ\"\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/shipments/:shipmentTrackingNumber/upload-invoice-data",
"host": [
"{{baseUrl}}"
],
"path": [
"shipments",
":shipmentTrackingNumber",
"upload-invoice-data"
],
"variable": [
{
"key": "shipmentTrackingNumber",
"value": "dolor veniam officia non",
"description": "(Required) DHL Express shipment identification number"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"instance\": \"/expressapi/shipments/1234567890/upload-invoice-data\",\n \"detail\": \"7096: The provided Shipment Identification Number is invalid. Please check the request message and retry.\",\n \"title\": \"Bad request\",\n \"message\": \"Bad request\",\n \"status\": \"400\"\n}"
},
{
"name": "Unprocessable Entity",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
},
{
"description": "Please provide message reference\n",
"key": "Message-Reference",
"value": "d0e7832e-5c98-11ea-bc55-0242ac13"
},
{
"description": "Optional reference date in the HTTP-date format https://tools.ietf.org/html/rfc7231#section-7.1.1.2",
"key": "Message-Reference-Date",
"value": "Wed, 21 Oct 2015 07:28:00 GMT"
},
{
"description": "Please provide name of the plugin (applicable to 3PV only)\n",
"key": "Plugin-Name",
"value": " "
},
{
"description": "Please provide version of the plugin (applicable to 3PV only)\n",
"key": "Plugin-Version",
"value": " "
},
{
"description": "Please provide name of the shipping platform(applicable to 3PV only)\n",
"key": "Shipping-System-Platform-Name",
"value": " "
},
{
"description": "Please provide version of the shipping platform (applicable to 3PV only)\n",
"key": "Shipping-System-Platform-Version",
"value": " "
},
{
"description": "Please provide name of the webstore platform (applicable to 3PV only)\n",
"key": "Webstore-Platform-Name",
"value": " "
},
{
"description": "Please provide version of the webstore platform (applicable to 3PV only)\n",
"key": "Webstore-Platform-Version",
"value": " "
}
],
"body": {
"mode": "raw",
"raw": "{\n \"content\": {\n \"exportDeclaration\": [\n {\n \"lineItems\": [\n {\n \"number\": 1,\n \"description\": \"line item description\",\n \"price\": 150,\n \"quantity\": {\n \"value\": 1,\n \"unitOfMeasurement\": \"BOX\"\n },\n \"manufacturerCountry\": \"CZ\",\n \"weight\": {\n \"netValue\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n },\n \"commodityCodes\": [\n {\n \"typeCode\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"value\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n }\n ],\n \"exportReasonType\": \"defence_material\",\n \"isTaxesPaid\": true,\n \"customerReferences\": [\n {\n \"typeCode\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"value\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n }\n ],\n \"customsDocuments\": [\n {\n \"typeCode\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n },\n \"value\": {\n \"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n }\n }\n ]\n }\n ],\n \"invoice\": {\n \"number\": \"12345-ABC\",\n \"date\": \"2021-03-18\",\n \"function\": \"import\",\n \"customerReferences\": [\n {\n \"typeCode\": \"CU\",\n \"value\": \"custref112\"\n }\n ]\n },\n \"incoterm\": \"DAP\",\n \"remarks\": [\n {\n \"value\": \"declaration remark\"\n },\n {\n \"value\": \"declaration remark\"\n }\n ],\n \"additionalCharges\": [\n {\n \"value\": 10,\n \"typeCode\": \"pickup\"\n },\n {\n \"value\": 10,\n \"typeCode\": \"pickup\"\n }\n ],\n \"placeOfIncoterm\": \"port of departure or destination details\",\n \"recipientReference\": \"recipient reference\",\n \"exporter\": {\n \"id\": \"123\",\n \"code\": \"EXPCZ\"\n },\n \"exportReasonType\": \"permanent\",\n \"shipmentType\": \"personal\",\n \"customsDocuments\": [\n {\n \"typeCode\": \"972\",\n \"value\": \"custdoc445\"\n }\n ]\n }\n ],\n \"currency\": \"EUR\",\n \"unitOfMeasurement\": \"metric\"\n },\n \"plannedShipDate\": \"2020-04-20\",\n \"accounts\": [\n {\n \"typeCode\": \"shipper\",\n \"number\": \"123456789\"\n },\n {\n \"typeCode\": \"shipper\",\n \"number\": \"123456789\"\n }\n ],\n \"outputImageProperties\": {\n \"imageOptions\": [\n {\n \"typeCode\": \"invoice\",\n \"templateName\": \"COMMERCIAL_INVOICE_P_10\",\n \"isRequested\": true\n }\n ]\n },\n \"customerDetails\": {\n \"sellerDetails\": {\n \"postalAddress\": {\n \"postalCode\": \"14800\",\n \"cityName\": \"Prague\",\n \"countryCode\": \"CZ\",\n \"addressLine1\": \"V Parku 2308/10\",\n \"provinceCode\": \"CZ\",\n \"addressLine2\": \"addres2\",\n \"addressLine3\": \"addres3\",\n \"countyName\": \"Central Bohemia\"\n },\n \"contactInformation\": {\n \"phone\": \"+1123456789\",\n \"companyName\": \"Company Name\",\n \"fullName\": \"John Brew\",\n \"email\": \"that@before.de\",\n \"mobilePhone\": \"+60112345678\"\n },\n \"typeCode\": \"business\",\n \"registrationNumbers\": [\n {\n \"typeCode\": \"VAT\",\n \"number\": \"CZ123456789\",\n \"issuerCountryCode\": \"CZ\"\n },\n {\n \"typeCode\": \"VAT\",\n \"number\": \"CZ123456789\",\n \"issuerCountryCode\": \"CZ\"\n }\n ]\n },\n \"buyerDetails\": {\n \"postalAddress\": {\n \"postalCode\": \"14800\",\n \"cityName\": \"Prague\",\n \"countryCode\": \"CZ\",\n \"addressLine1\": \"V Parku 2308/10\",\n \"provinceCode\": \"CZ\",\n \"addressLine2\": \"addres2\",\n \"addressLine3\": \"addres3\",\n \"countyName\": \"Central Bohemia\"\n },\n \"contactInformation\": {\n \"phone\": \"+1123456789\",\n \"companyName\": \"Company Name\",\n \"fullName\": \"John Brew\",\n \"email\": \"that@before.de\",\n \"mobilePhone\": \"+60112345678\"\n },\n \"registrationNumbers\": [\n {\n \"typeCode\": \"VAT\",\n \"number\": \"CZ123456789\",\n \"issuerCountryCode\": \"CZ\"\n },\n {\n \"typeCode\": \"VAT\",\n \"number\": \"CZ123456789\",\n \"issuerCountryCode\": \"CZ\"\n }\n ],\n \"typeCode\": \"business\"\n },\n \"importerDetails\": {\n \"postalAddress\": {\n \"postalCode\": \"14800\",\n \"cityName\": \"Prague\",\n \"countryCode\": \"CZ\",\n \"addressLine1\": \"V Parku 2308/10\",\n \"provinceCode\": \"CZ\",\n \"addressLine2\": \"addres2\",\n \"addressLine3\": \"addres3\",\n \"countyName\": \"Central Bohemia\"\n },\n \"contactInformation\": {\n \"phone\": \"+1123456789\",\n \"companyName\": \"Company Name\",\n \"fullName\": \"John Brew\",\n \"email\": \"that@before.de\",\n \"mobilePhone\": \"+60112345678\"\n },\n \"registrationNumbers\": [\n {\n \"typeCode\": \"VAT\",\n \"number\": \"CZ123456789\",\n \"issuerCountryCode\": \"CZ\"\n },\n {\n \"typeCode\": \"VAT\",\n \"number\": \"CZ123456789\",\n \"issuerCountryCode\": \"CZ\"\n }\n ],\n \"typeCode\": \"government\"\n },\n \"exporterDetails\": {\n \"postalAddress\": {\n \"postalCode\": \"14800\",\n \"cityName\": \"Prague\",\n \"countryCode\": \"CZ\",\n \"addressLine1\": \"V Parku 2308/10\",\n \"provinceCode\": \"CZ\",\n \"addressLine2\": \"addres2\",\n \"addressLine3\": \"addres3\",\n \"countyName\": \"Central Bohemia\"\n },\n \"contactInformation\": {\n \"phone\": \"+1123456789\",\n \"companyName\": \"Company Name\",\n \"fullName\": \"John Brew\",\n \"email\": \"that@before.de\",\n \"mobilePhone\": \"+60112345678\"\n },\n \"registrationNumbers\": [\n {\n \"typeCode\": \"VAT\",\n \"number\": \"CZ123456789\",\n \"issuerCountryCode\": \"CZ\"\n },\n {\n \"typeCode\": \"VAT\",\n \"number\": \"CZ123456789\",\n \"issuerCountryCode\": \"CZ\"\n }\n ],\n \"typeCode\": \"government\"\n },\n \"ultimateConsigneeDetails\": {\n \"postalAddress\": {\n \"postalCode\": \"14800\",\n \"cityName\": \"Prague\",\n \"countryCode\": \"CZ\",\n \"addressLine1\": \"V Parku 2308/10\",\n \"provinceCode\": \"CZ\",\n \"addressLine2\": \"addres2\",\n \"addressLine3\": \"addres3\",\n \"countyName\": \"Central Bohemia\"\n },\n \"contactInformation\": {\n \"phone\": \"+1123456789\",\n \"companyName\": \"Company Name\",\n \"fullName\": \"John Brew\",\n \"email\": \"that@before.de\",\n \"mobilePhone\": \"+60112345678\"\n },\n \"typeCode\": \"other\",\n \"registrationNumbers\": [\n {\n \"typeCode\": \"VAT\",\n \"number\": \"CZ123456789\",\n \"issuerCountryCode\": \"CZ\"\n },\n {\n \"typeCode\": \"VAT\",\n \"number\": \"CZ123456789\",\n \"issuerCountryCode\": \"CZ\"\n }\n ]\n }\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/shipments/:shipmentTrackingNumber/upload-invoice-data",
"host": [
"{{baseUrl}}"
],
"path": [
"shipments",
":shipmentTrackingNumber",
"upload-invoice-data"
],
"variable": [
{
"key": "shipmentTrackingNumber",
"value": "dolor veniam officia non",
"description": "(Required) DHL Express shipment identification number"
}
]
}
},
"status": "Unprocessable Entity (WebDAV) (RFC 4918)",
"code": 422,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"instance\": \"/expressapi/shipments/1234567890/upload-invoice-data\",\n \"detail\": \"#/content/exportDeclaration/0/additionalCharges: expected maximum item count: 5, found: 6\",\n \"title\": \"Validation error\",\n \"message\": \"Unprocessable Entity\",\n \"status\": \"422\"\n}"
}
]
}
