Back to Collection Items
func chilkatTest() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let http = CkoHttp()!
var success: Bool
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": "intercompany_use",
// "isTaxesPaid": false,
// "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": "other"
// },
// {
// "value": 10,
// "typeCode": "delivery"
// }
// ],
// "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"
// },
// "shipmentTrackingNumber": "123456790",
// "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": "reseller",
// "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": "reseller"
// },
// "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": "other"
// },
// "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": "private"
// },
// "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": "government",
// "registrationNumbers": [
// {
// "typeCode": "VAT",
// "number": "CZ123456789",
// "issuerCountryCode": "CZ"
// },
// {
// "typeCode": "VAT",
// "number": "CZ123456789",
// "issuerCountryCode": "CZ"
// }
// ]
// }
// }
// }
let json = CkoJsonObject()!
json.updateInt("content.exportDeclaration[0].lineItems[0].number", value: 1)
json.update("content.exportDeclaration[0].lineItems[0].description", value: "line item description")
json.updateInt("content.exportDeclaration[0].lineItems[0].price", value: 150)
json.updateInt("content.exportDeclaration[0].lineItems[0].quantity.value", value: 1)
json.update("content.exportDeclaration[0].lineItems[0].quantity.unitOfMeasurement", value: "BOX")
json.update("content.exportDeclaration[0].lineItems[0].manufacturerCountry", value: "CZ")
json.update("content.exportDeclaration[0].lineItems[0].weight.netValue.value", value: "<Error: Too many levels of nesting to fake this schema>")
json.update("content.exportDeclaration[0].lineItems[0].commodityCodes[0].typeCode.value", value: "<Error: Too many levels of nesting to fake this schema>")
json.update("content.exportDeclaration[0].lineItems[0].commodityCodes[0].value.value", value: "<Error: Too many levels of nesting to fake this schema>")
json.update("content.exportDeclaration[0].lineItems[0].exportReasonType", value: "intercompany_use")
json.updateBool("content.exportDeclaration[0].lineItems[0].isTaxesPaid", value: false)
json.update("content.exportDeclaration[0].lineItems[0].customerReferences[0].typeCode.value", value: "<Error: Too many levels of nesting to fake this schema>")
json.update("content.exportDeclaration[0].lineItems[0].customerReferences[0].value.value", value: "<Error: Too many levels of nesting to fake this schema>")
json.update("content.exportDeclaration[0].lineItems[0].customsDocuments[0].typeCode.value", value: "<Error: Too many levels of nesting to fake this schema>")
json.update("content.exportDeclaration[0].lineItems[0].customsDocuments[0].value.value", value: "<Error: Too many levels of nesting to fake this schema>")
json.update("content.exportDeclaration[0].invoice.number", value: "12345-ABC")
json.update("content.exportDeclaration[0].invoice.date", value: "2021-03-18")
json.update("content.exportDeclaration[0].invoice.function", value: "import")
json.update("content.exportDeclaration[0].invoice.customerReferences[0].typeCode", value: "CU")
json.update("content.exportDeclaration[0].invoice.customerReferences[0].value", value: "custref112")
json.update("content.exportDeclaration[0].incoterm", value: "DAP")
json.update("content.exportDeclaration[0].remarks[0].value", value: "declaration remark")
json.update("content.exportDeclaration[0].remarks[1].value", value: "declaration remark")
json.updateInt("content.exportDeclaration[0].additionalCharges[0].value", value: 10)
json.update("content.exportDeclaration[0].additionalCharges[0].typeCode", value: "other")
json.updateInt("content.exportDeclaration[0].additionalCharges[1].value", value: 10)
json.update("content.exportDeclaration[0].additionalCharges[1].typeCode", value: "delivery")
json.update("content.exportDeclaration[0].placeOfIncoterm", value: "port of departure or destination details")
json.update("content.exportDeclaration[0].recipientReference", value: "recipient reference")
json.update("content.exportDeclaration[0].exporter.id", value: "123")
json.update("content.exportDeclaration[0].exporter.code", value: "EXPCZ")
json.update("content.exportDeclaration[0].exportReasonType", value: "permanent")
json.update("content.exportDeclaration[0].shipmentType", value: "personal")
json.update("content.exportDeclaration[0].customsDocuments[0].typeCode", value: "972")
json.update("content.exportDeclaration[0].customsDocuments[0].value", value: "custdoc445")
json.update("content.currency", value: "EUR")
json.update("content.unitOfMeasurement", value: "metric")
json.update("shipmentTrackingNumber", value: "123456790")
json.update("plannedShipDate", value: "2020-04-20")
json.update("accounts[0].typeCode", value: "shipper")
json.update("accounts[0].number", value: "123456789")
json.update("accounts[1].typeCode", value: "shipper")
json.update("accounts[1].number", value: "123456789")
json.update("outputImageProperties.imageOptions[0].typeCode", value: "invoice")
json.update("outputImageProperties.imageOptions[0].templateName", value: "COMMERCIAL_INVOICE_P_10")
json.updateBool("outputImageProperties.imageOptions[0].isRequested", value: true)
json.update("customerDetails.sellerDetails.postalAddress.postalCode", value: "14800")
json.update("customerDetails.sellerDetails.postalAddress.cityName", value: "Prague")
json.update("customerDetails.sellerDetails.postalAddress.countryCode", value: "CZ")
json.update("customerDetails.sellerDetails.postalAddress.addressLine1", value: "V Parku 2308/10")
json.update("customerDetails.sellerDetails.postalAddress.provinceCode", value: "CZ")
json.update("customerDetails.sellerDetails.postalAddress.addressLine2", value: "addres2")
json.update("customerDetails.sellerDetails.postalAddress.addressLine3", value: "addres3")
json.update("customerDetails.sellerDetails.postalAddress.countyName", value: "Central Bohemia")
json.update("customerDetails.sellerDetails.contactInformation.phone", value: "+1123456789")
json.update("customerDetails.sellerDetails.contactInformation.companyName", value: "Company Name")
json.update("customerDetails.sellerDetails.contactInformation.fullName", value: "John Brew")
json.update("customerDetails.sellerDetails.contactInformation.email", value: "that@before.de")
json.update("customerDetails.sellerDetails.contactInformation.mobilePhone", value: "+60112345678")
json.update("customerDetails.sellerDetails.typeCode", value: "reseller")
json.update("customerDetails.sellerDetails.registrationNumbers[0].typeCode", value: "VAT")
json.update("customerDetails.sellerDetails.registrationNumbers[0].number", value: "CZ123456789")
json.update("customerDetails.sellerDetails.registrationNumbers[0].issuerCountryCode", value: "CZ")
json.update("customerDetails.sellerDetails.registrationNumbers[1].typeCode", value: "VAT")
json.update("customerDetails.sellerDetails.registrationNumbers[1].number", value: "CZ123456789")
json.update("customerDetails.sellerDetails.registrationNumbers[1].issuerCountryCode", value: "CZ")
json.update("customerDetails.buyerDetails.postalAddress.postalCode", value: "14800")
json.update("customerDetails.buyerDetails.postalAddress.cityName", value: "Prague")
json.update("customerDetails.buyerDetails.postalAddress.countryCode", value: "CZ")
json.update("customerDetails.buyerDetails.postalAddress.addressLine1", value: "V Parku 2308/10")
json.update("customerDetails.buyerDetails.postalAddress.provinceCode", value: "CZ")
json.update("customerDetails.buyerDetails.postalAddress.addressLine2", value: "addres2")
json.update("customerDetails.buyerDetails.postalAddress.addressLine3", value: "addres3")
json.update("customerDetails.buyerDetails.postalAddress.countyName", value: "Central Bohemia")
json.update("customerDetails.buyerDetails.contactInformation.phone", value: "+1123456789")
json.update("customerDetails.buyerDetails.contactInformation.companyName", value: "Company Name")
json.update("customerDetails.buyerDetails.contactInformation.fullName", value: "John Brew")
json.update("customerDetails.buyerDetails.contactInformation.email", value: "that@before.de")
json.update("customerDetails.buyerDetails.contactInformation.mobilePhone", value: "+60112345678")
json.update("customerDetails.buyerDetails.registrationNumbers[0].typeCode", value: "VAT")
json.update("customerDetails.buyerDetails.registrationNumbers[0].number", value: "CZ123456789")
json.update("customerDetails.buyerDetails.registrationNumbers[0].issuerCountryCode", value: "CZ")
json.update("customerDetails.buyerDetails.registrationNumbers[1].typeCode", value: "VAT")
json.update("customerDetails.buyerDetails.registrationNumbers[1].number", value: "CZ123456789")
json.update("customerDetails.buyerDetails.registrationNumbers[1].issuerCountryCode", value: "CZ")
json.update("customerDetails.buyerDetails.typeCode", value: "reseller")
json.update("customerDetails.importerDetails.postalAddress.postalCode", value: "14800")
json.update("customerDetails.importerDetails.postalAddress.cityName", value: "Prague")
json.update("customerDetails.importerDetails.postalAddress.countryCode", value: "CZ")
json.update("customerDetails.importerDetails.postalAddress.addressLine1", value: "V Parku 2308/10")
json.update("customerDetails.importerDetails.postalAddress.provinceCode", value: "CZ")
json.update("customerDetails.importerDetails.postalAddress.addressLine2", value: "addres2")
json.update("customerDetails.importerDetails.postalAddress.addressLine3", value: "addres3")
json.update("customerDetails.importerDetails.postalAddress.countyName", value: "Central Bohemia")
json.update("customerDetails.importerDetails.contactInformation.phone", value: "+1123456789")
json.update("customerDetails.importerDetails.contactInformation.companyName", value: "Company Name")
json.update("customerDetails.importerDetails.contactInformation.fullName", value: "John Brew")
json.update("customerDetails.importerDetails.contactInformation.email", value: "that@before.de")
json.update("customerDetails.importerDetails.contactInformation.mobilePhone", value: "+60112345678")
json.update("customerDetails.importerDetails.registrationNumbers[0].typeCode", value: "VAT")
json.update("customerDetails.importerDetails.registrationNumbers[0].number", value: "CZ123456789")
json.update("customerDetails.importerDetails.registrationNumbers[0].issuerCountryCode", value: "CZ")
json.update("customerDetails.importerDetails.registrationNumbers[1].typeCode", value: "VAT")
json.update("customerDetails.importerDetails.registrationNumbers[1].number", value: "CZ123456789")
json.update("customerDetails.importerDetails.registrationNumbers[1].issuerCountryCode", value: "CZ")
json.update("customerDetails.importerDetails.typeCode", value: "other")
json.update("customerDetails.exporterDetails.postalAddress.postalCode", value: "14800")
json.update("customerDetails.exporterDetails.postalAddress.cityName", value: "Prague")
json.update("customerDetails.exporterDetails.postalAddress.countryCode", value: "CZ")
json.update("customerDetails.exporterDetails.postalAddress.addressLine1", value: "V Parku 2308/10")
json.update("customerDetails.exporterDetails.postalAddress.provinceCode", value: "CZ")
json.update("customerDetails.exporterDetails.postalAddress.addressLine2", value: "addres2")
json.update("customerDetails.exporterDetails.postalAddress.addressLine3", value: "addres3")
json.update("customerDetails.exporterDetails.postalAddress.countyName", value: "Central Bohemia")
json.update("customerDetails.exporterDetails.contactInformation.phone", value: "+1123456789")
json.update("customerDetails.exporterDetails.contactInformation.companyName", value: "Company Name")
json.update("customerDetails.exporterDetails.contactInformation.fullName", value: "John Brew")
json.update("customerDetails.exporterDetails.contactInformation.email", value: "that@before.de")
json.update("customerDetails.exporterDetails.contactInformation.mobilePhone", value: "+60112345678")
json.update("customerDetails.exporterDetails.registrationNumbers[0].typeCode", value: "VAT")
json.update("customerDetails.exporterDetails.registrationNumbers[0].number", value: "CZ123456789")
json.update("customerDetails.exporterDetails.registrationNumbers[0].issuerCountryCode", value: "CZ")
json.update("customerDetails.exporterDetails.registrationNumbers[1].typeCode", value: "VAT")
json.update("customerDetails.exporterDetails.registrationNumbers[1].number", value: "CZ123456789")
json.update("customerDetails.exporterDetails.registrationNumbers[1].issuerCountryCode", value: "CZ")
json.update("customerDetails.exporterDetails.typeCode", value: "private")
json.update("customerDetails.ultimateConsigneeDetails.postalAddress.postalCode", value: "14800")
json.update("customerDetails.ultimateConsigneeDetails.postalAddress.cityName", value: "Prague")
json.update("customerDetails.ultimateConsigneeDetails.postalAddress.countryCode", value: "CZ")
json.update("customerDetails.ultimateConsigneeDetails.postalAddress.addressLine1", value: "V Parku 2308/10")
json.update("customerDetails.ultimateConsigneeDetails.postalAddress.provinceCode", value: "CZ")
json.update("customerDetails.ultimateConsigneeDetails.postalAddress.addressLine2", value: "addres2")
json.update("customerDetails.ultimateConsigneeDetails.postalAddress.addressLine3", value: "addres3")
json.update("customerDetails.ultimateConsigneeDetails.postalAddress.countyName", value: "Central Bohemia")
json.update("customerDetails.ultimateConsigneeDetails.contactInformation.phone", value: "+1123456789")
json.update("customerDetails.ultimateConsigneeDetails.contactInformation.companyName", value: "Company Name")
json.update("customerDetails.ultimateConsigneeDetails.contactInformation.fullName", value: "John Brew")
json.update("customerDetails.ultimateConsigneeDetails.contactInformation.email", value: "that@before.de")
json.update("customerDetails.ultimateConsigneeDetails.contactInformation.mobilePhone", value: "+60112345678")
json.update("customerDetails.ultimateConsigneeDetails.typeCode", value: "government")
json.update("customerDetails.ultimateConsigneeDetails.registrationNumbers[0].typeCode", value: "VAT")
json.update("customerDetails.ultimateConsigneeDetails.registrationNumbers[0].number", value: "CZ123456789")
json.update("customerDetails.ultimateConsigneeDetails.registrationNumbers[0].issuerCountryCode", value: "CZ")
json.update("customerDetails.ultimateConsigneeDetails.registrationNumbers[1].typeCode", value: "VAT")
json.update("customerDetails.ultimateConsigneeDetails.registrationNumbers[1].number", value: "CZ123456789")
json.update("customerDetails.ultimateConsigneeDetails.registrationNumbers[1].issuerCountryCode", value: "CZ")
http.setRequestHeader("Webstore-Platform-Name", value: "")
http.setRequestHeader("Shipping-System-Platform-Name", value: "")
http.setRequestHeader("Message-Reference", value: "d0e7832e-5c98-11ea-bc55-0242ac13")
http.setRequestHeader("Plugin-Version", value: "")
http.setRequestHeader("Content-Type", value: "application/json")
http.setRequestHeader("Plugin-Name", value: "")
http.setRequestHeader("Shipping-System-Platform-Version", value: "")
http.setRequestHeader("Accept", value: "application/json")
http.setRequestHeader("Message-Reference-Date", value: "Wed, 21 Oct 2015 07:28:00 GMT")
http.setRequestHeader("Webstore-Platform-Version", value: "")
var resp: CkoHttpResponse? = http.postJson3("https://api-mock.dhl.com/mydhlapi/invoices/upload-invoice-data", contentType: "application/json", json: json)
if http.lastMethodSuccess == false {
print("\(http.lastErrorText!)")
return
}
let sbResponseBody = CkoStringBuilder()!
resp!.getBodySb(sbResponseBody)
let jResp = CkoJsonObject()!
jResp.loadSb(sbResponseBody)
jResp.emitCompact = false
print("Response Body:")
print("\(jResp.emit()!)")
var respStatusCode: Int = resp!.statusCode.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(resp!.header!)")
print("Failed.")
resp = nil
return
}
resp = nil
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "warnings": [
// "some values provided may be invalid",
// "some values provided may be invalid"
// ],
// "status": "OK"
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
var strVal: String?
var status: String? = jResp.string(of: "status")
var i: Int = 0
var count_i: Int = jResp.size(ofArray: "warnings").intValue
while i < count_i {
jResp.i = i
strVal = jResp.string(of: "warnings[i]")
i = i + 1
}
}
Curl Command
curl -X POST
-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": "intercompany_use",
"isTaxesPaid": false,
"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": "other"
},
{
"value": 10,
"typeCode": "delivery"
}
],
"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"
},
"shipmentTrackingNumber": "123456790",
"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": "reseller",
"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": "reseller"
},
"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": "other"
},
"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": "private"
},
"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": "government",
"registrationNumbers": [
{
"typeCode": "VAT",
"number": "CZ123456789",
"issuerCountryCode": "CZ"
},
{
"typeCode": "VAT",
"number": "CZ123456789",
"issuerCountryCode": "CZ"
}
]
}
}
}'
https://api-mock.dhl.com/mydhlapi/invoices/upload-invoice-data
Postman Collection Item JSON
{
"name": "Upload Commercial invoice data",
"request": {
"method": "POST",
"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\": \"intercompany_use\",\n \"isTaxesPaid\": false,\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\": \"other\"\n },\n {\n \"value\": 10,\n \"typeCode\": \"delivery\"\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 \"shipmentTrackingNumber\": \"123456790\",\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\": \"reseller\",\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\": \"reseller\"\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\": \"other\"\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\": \"private\"\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\": \"government\",\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}}/invoices/upload-invoice-data",
"host": [
"{{baseUrl}}"
],
"path": [
"invoices",
"upload-invoice-data"
]
},
"description": "## Upload invoice data\nThe upload invoice data service can be used to upload Commerical Invoice data without 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.\nTo 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.\n\"PM\" service code is not enabled by default 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. When Commercial Invoice (CIN) data is uploaded prior to creating a shipment via MyDHL API Create Shipment service, it is \nmandatory 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": "POST",
"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\": \"intercompany_use\",\n \"isTaxesPaid\": false,\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\": \"other\"\n },\n {\n \"value\": 10,\n \"typeCode\": \"delivery\"\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 \"shipmentTrackingNumber\": \"123456790\",\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\": \"reseller\",\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\": \"reseller\"\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\": \"other\"\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\": \"private\"\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\": \"government\",\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}}/invoices/upload-invoice-data",
"host": [
"{{baseUrl}}"
],
"path": [
"invoices",
"upload-invoice-data"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"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": "application/json"
}
],
"cookie": [
],
"body": "{\n \"warnings\": [\n \"some values provided may be invalid\",\n \"some values provided may be invalid\"\n ],\n \"status\": \"OK\"\n}"
},
{
"name": "Wrong input parameters",
"originalRequest": {
"method": "POST",
"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\": \"intercompany_use\",\n \"isTaxesPaid\": false,\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\": \"other\"\n },\n {\n \"value\": 10,\n \"typeCode\": \"delivery\"\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 \"shipmentTrackingNumber\": \"123456790\",\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\": \"reseller\",\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\": \"reseller\"\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\": \"other\"\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\": \"private\"\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\": \"government\",\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}}/invoices/upload-invoice-data",
"host": [
"{{baseUrl}}"
],
"path": [
"invoices",
"upload-invoice-data"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"instance\": \"/expressapi/invoices/upload-invoice-data\",\n \"detail\": \"7099: Missing the Account Number and Shipper Reference in #/content/exportDeclaration/0/invoice/customerReferences/0/value with typeCode = 'CU' in request. Please check the request message and retry.\",\n \"title\": \"Bad request\",\n \"message\": \"Bad request\",\n \"status\": \"400\"\n}"
},
{
"name": "Process errors",
"originalRequest": {
"method": "POST",
"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\": \"intercompany_use\",\n \"isTaxesPaid\": false,\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\": \"other\"\n },\n {\n \"value\": 10,\n \"typeCode\": \"delivery\"\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 \"shipmentTrackingNumber\": \"123456790\",\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\": \"reseller\",\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\": \"reseller\"\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\": \"other\"\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\": \"private\"\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\": \"government\",\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}}/invoices/upload-invoice-data",
"host": [
"{{baseUrl}}"
],
"path": [
"invoices",
"upload-invoice-data"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"instance\": \"/expressapi/invoices/upload-invoice-data\",\n \"detail\": \"999: Process failure occurred. Process ID associated for that transaction (1234567890)\",\n \"title\": \"Internal Server Error\",\n \"message\": \"Internal Server Error\",\n \"code\": \"500\"\n}"
}
]
}
