{ "info": { "_postman_id": "dbc4836f-d2b2-486d-ba31-546b2a02687e", "name": "MyDHL API REST", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "name": "Rating", "item": [ { "name": "Rates", "request": { "method": "POST", "header": [ { "key": "Content-Type", "type": "text", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\r\n \"customerDetails\": {\r\n \"shipperDetails\": {\r\n \"postalCode\": \"SL3 0BB\",\r\n \"cityName\": \"Colnbrook\",\r\n \"countryCode\": \"GB\",\r\n \"addressLine1\": \"addres1\",\r\n \"addressLine2\": \"addres2\",\r\n \"addressLine3\": \"addres3\"\r\n },\r\n \"receiverDetails\": {\r\n \"postalCode\": \"14800\",\r\n \"cityName\": \"Prague\",\r\n \"countryCode\": \"CZ\",\r\n \"addressLine1\": \"addres1\",\r\n \"addressLine2\": \"addres2\",\r\n \"addressLine3\": \"addres3\"\r\n }\r\n },\r\n \"accounts\": [\r\n {\r\n \"typeCode\": \"shipper\",\r\n \"number\": \"redacted\"\r\n }\r\n ],\r\n \"productCode\": \"P\",\r\n \"plannedShippingDateAndTime\": \"2021-01-11T13:00:00GMT+00:00\",\r\n \"unitOfMeasurement\": \"metric\",\r\n \"isCustomsDeclarable\": true,\r\n \"monetaryAmount\": [\r\n {\r\n \"typeCode\": \"declaredValue\",\r\n \"value\": 100,\r\n \"currency\": \"GBP\"\r\n }\r\n ],\r\n \"packages\": [\r\n {\r\n \"weight\": 10.5,\r\n \"dimensions\": {\r\n \"length\": 25,\r\n \"width\": 35,\r\n \"height\": 15\r\n }\r\n }\r\n ]\r\n}" }, "url": { "raw": "https://express.api.dhl.com/mydhlapi/test/rates", "protocol": "https", "host": [ "express", "api", "dhl", "com" ], "path": [ "mydhlapi", "test", "rates" ] } }, "response": [] }, { "name": "Landed Costs", "request": { "method": "POST", "header": [ { "key": "Content-Type", "type": "text", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\r\n \"customerDetails\": {\r\n \"shipperDetails\": {\r\n \"postalCode\": \"90210\",\r\n \"cityName\": \"Beverly Hills\",\r\n \"countryCode\": \"US\"\r\n },\r\n \"receiverDetails\": {\r\n \"postalCode\": \"SL3 0BB\",\r\n \"cityName\": \"Colnbrook\",\r\n \"countryCode\": \"GB\"\r\n }\r\n },\r\n \"accounts\": [\r\n {\r\n \"typeCode\": \"shipper\",\r\n \"number\": \"redacted\"\r\n }\r\n ],\r\n \"productCode\": \"P\",\r\n \"localProductCode\": \"P\",\r\n \"unitOfMeasurement\": \"metric\",\r\n \"currencyCode\": \"GBP\",\r\n \"isCustomsDeclarable\": true,\r\n \"isDTPRequested\": false,\r\n \"getCostBreakdown\": true,\r\n \"packages\": [\r\n {\r\n \"weight\": 10.5,\r\n \"dimensions\": {\r\n \"length\": 25,\r\n \"width\": 35,\r\n \"height\": 15\r\n }\r\n }\r\n ],\r\n \"items\": [\r\n {\r\n \"number\": 1,\r\n \"name\": \"KNITWEAR COTTON\",\r\n \"description\": \"KNITWEAR 100% COTTON REDUCTION PRICE FALL COLLECTION\",\r\n \"manufacturerCountry\": \"CN\",\r\n \"partNumber\": \"12345555\",\r\n \"quantity\": 2,\r\n \"quantityType\": \"prt\",\r\n \"unitPrice\": 120,\r\n \"unitPriceCurrencyCode\": \"EUR\",\r\n \"customsValue\": 120,\r\n \"customsValueCurrencyCode\": \"EUR\",\r\n \"commodityCode\": \"6110129090\",\r\n \"weight\": 5,\r\n \"weightUnitOfMeasurement\": \"metric\",\r\n \"category\": \"APPAREL\",\r\n \"brand\": \"SHOE 1\",\r\n \"goodsCharacteristics\": [\r\n {\r\n \"typeCode\": \"IMPORTER\",\r\n \"value\": \"Registered\"\r\n }\r\n ]\r\n }\r\n ]\r\n}" }, "url": { "raw": "https://express.api.dhl.com/mydhlapi/test/landed-cost", "protocol": "https", "host": [ "express", "api", "dhl", "com" ], "path": [ "mydhlapi", "test", "landed-cost" ] } }, "response": [] } ] }, { "name": "Product", "item": [ { "name": "Product Request", "request": { "method": "GET", "header": [], "url": { "raw": "https://express.api.dhl.com/mydhlapi//products?accountNumber=123456789&originCountryCode=CZ&originPostalCode=14800&originCityName=Prague&destinationCountryCode=CZ&destinationPostalCode=14800&destinationCityName=Prague&weight=5&length=15&width=10&height=5&plannedShippingDate=2020-02-26&isCustomsDeclarable=true&unitOfMeasurement=metric", "protocol": "https", "host": [ "express", "api", "dhl", "com" ], "path": [ "mydhlapi", "", "products" ], "query": [ { "key": "accountNumber", "value": "123456789", "description": "DHL Express customer account number" }, { "key": "originCountryCode", "value": "CZ", "description": "A short text string code (see values defined in ISO 3166) specifying the shipment origin country" }, { "key": "originPostalCode", "value": "14800", "description": "Text specifying the postal code for an address. https://gs1.org/voc/postalCode" }, { "key": "originCityName", "value": "Prague", "description": "Text specifying the city name" }, { "key": "destinationCountryCode", "value": "CZ", "description": "A short text string code (see values defined in ISO 3166) specifying the shipment destination country." }, { "key": "destinationPostalCode", "value": "14800", "description": "Text specifying the postal code for an address. https://gs1.org/voc/postalCode" }, { "key": "destinationCityName", "value": "Prague", "description": "Text specifying the city name" }, { "key": "weight", "value": "5", "description": "Gross weight of the shipment including packaging." }, { "key": "length", "value": "15", "description": "Total length of the shipment including packaging." }, { "key": "width", "value": "10", "description": "Total width of the shipment including packaging." }, { "key": "height", "value": "5", "description": "Total height of the shipment including packaging." }, { "key": "plannedShippingDate", "value": "2020-02-26", "description": "Timestamp represents the date you plan to ship your prospected shipment" }, { "key": "isCustomsDeclarable", "value": "true" }, { "key": "unitOfMeasurement", "value": "metric", "description": "The UnitOfMeasurement node conveys the unit of measurements used in the operation." } ] } }, "response": [] } ] }, { "name": "Shipment", "item": [ { "name": "Domestic Shipment", "request": { "method": "POST", "header": [ { "key": "Content-Type", "type": "text", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\r\n \"plannedShippingDateAndTime\": \"2021-05-24T18:00:31GMT+01:00\",\r\n \"pickup\": {\r\n \"isRequested\": false\r\n },\r\n \"productCode\": \"N\",\r\n \"accounts\": [\r\n {\r\n \"number\": \"enter DHL account number\",\r\n \"typeCode\": \"shipper\"\r\n }\r\n ],\r\n \"customerDetails\": {\r\n \"shipperDetails\": {\r\n \"postalAddress\": {\r\n \"cityName\": \"Colnbrook\",\r\n \"countryCode\": \"GB\",\r\n \"postalCode\": \"SL3 0BB\",\r\n \"addressLine1\": \"Address Line 1\"\r\n },\r\n \"contactInformation\": {\r\n \"phone\": \"+4412345678\",\r\n \"companyName\": \"Company Name\",\r\n \"fullName\": \"John Brew\",\r\n \"email\": \"a@b.com\"\r\n },\r\n \"registrationNumbers\": [\r\n {\r\n \"number\": \"GB12345\",\r\n \"issuerCountryCode\": \"GB\",\r\n \"typeCode\": \"VAT\"\r\n },\r\n {\r\n \"number\": \"GB12345\",\r\n \"issuerCountryCode\": \"GB\",\r\n \"typeCode\": \"EOR\"\r\n }\r\n ],\r\n \"typeCode\": \"business\"\r\n },\r\n \"receiverDetails\": {\r\n \"postalAddress\": {\r\n \"cityName\": \"Colnbrook\",\r\n \"countryCode\": \"GB\",\r\n \"postalCode\": \"SL3 0BB\",\r\n \"addressLine1\": \"Address Line 1\",\r\n \"addressLine2\": \"Address Line 2\",\r\n \"addressLine3\": \"Address Line 3\"\r\n },\r\n \"contactInformation\": {\r\n \"phone\": \"1212345678\",\r\n \"companyName\": \"Company Name\",\r\n \"fullName\": \"John Brew\",\r\n \"email\": \"a@b.com\"\r\n },\r\n \"typeCode\": \"business\"\r\n }\r\n },\r\n \"customerReferences\": [\r\n {\r\n \"value\": \"TEST\",\r\n \"typeCode\": \"CU\"\r\n }\r\n ],\r\n \"content\": {\r\n \"unitOfMeasurement\": \"metric\",\r\n \"isCustomsDeclarable\": false,\r\n \"incoterm\": \"DAP\",\r\n \"description\": \"Test Description\",\r\n \"packages\": [\r\n {\r\n \"customerReferences\": [\r\n {\r\n \"value\": \"Customer reference\",\r\n \"typeCode\": \"CU\"\r\n }\r\n ],\r\n \"weight\": 22.5,\r\n \"description\": \"Piece content description\",\r\n \"dimensions\": {\r\n \"length\": 15,\r\n \"width\": 15,\r\n \"height\": 40\r\n }\r\n }\r\n ]\r\n }\r\n}" }, "url": { "raw": "https://express.api.dhl.com/mydhlapi/test/shipments", "protocol": "https", "host": [ "express", "api", "dhl", "com" ], "path": [ "mydhlapi", "test", "shipments" ] } }, "response": [] }, { "name": "PLT Own Invoice", "request": { "method": "POST", "header": [ { "key": "Content-Type", "type": "text", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\r\n \"plannedShippingDateAndTime\": \"2021-05-24T17:30:00GMT+01:00\",\r\n \"pickup\": {\r\n \"isRequested\": false\r\n },\r\n \"productCode\": \"P\",\r\n \"accounts\": [\r\n {\r\n \"typeCode\": \"shipper\",\r\n \"number\": \"enter DHL account number\"\r\n }\r\n ],\r\n \"valueAddedServices\": [\r\n {\r\n \"serviceCode\": \"WY\"\r\n }\r\n ],\r\n \"customerDetails\": {\r\n \"shipperDetails\": {\r\n \"postalAddress\": {\r\n \"addressLine1\": \"Address Line 1\",\r\n \"addressLine2\": \"Address Line 2\",\r\n \"addressLine3\": \"Address Line 3\",\r\n \"postalCode\": \"SL3 0BB\",\r\n \"cityName\": \"Colnbrook\",\r\n \"countryCode\": \"GB\"\r\n },\r\n \"contactInformation\": {\r\n \"companyName\": \"Company Name\",\r\n \"fullName\": \"John Brew\",\r\n \"phone\": \"1212345678\",\r\n \"email\": \"a@b.com\"\r\n },\r\n \"registrationNumbers\": [\r\n {\r\n \"number\": \"GB12345\",\r\n \"issuerCountryCode\": \"GB\",\r\n \"typeCode\": \"VAT\"\r\n },\r\n {\r\n \"number\": \"GB12345\",\r\n \"issuerCountryCode\": \"GB\",\r\n \"typeCode\": \"EOR\"\r\n }\r\n ],\r\n \"typeCode\": \"business\"\r\n },\r\n \"receiverDetails\": {\r\n \"postalAddress\": {\r\n \"addressLine1\": \"Address Line 1\",\r\n \"addressLine2\": \"Address Line 2\",\r\n \"addressLine3\": \"Address Line 3\",\r\n \"postalCode\": \"90210\",\r\n \"cityName\": \"Beverly Hills\",\r\n \"countryCode\": \"US\",\r\n \"provinceCode\": \"CA\"\r\n },\r\n \"contactInformation\": {\r\n \"companyName\": \"Company Name\",\r\n \"fullName\": \"John Brew\",\r\n \"phone\": \"+1123456789\",\r\n \"email\": \"a@b.com\"\r\n },\r\n \"registrationNumbers\": [\r\n {\r\n \"number\": \"GB12345\",\r\n \"issuerCountryCode\": \"GB\",\r\n \"typeCode\": \"VAT\"\r\n },\r\n {\r\n \"number\": \"GB12345\",\r\n \"issuerCountryCode\": \"GB\",\r\n \"typeCode\": \"EOR\"\r\n }\r\n ],\r\n \"typeCode\": \"business\"\r\n }\r\n },\r\n \"customerReferences\": [\r\n {\r\n \"value\": \"TEST\",\r\n \"typeCode\": \"CU\"\r\n }\r\n ],\r\n \"content\": {\r\n \"packages\": [\r\n {\r\n \"customerReferences\": [\r\n {\r\n \"value\": \"Piece reference\",\r\n \"typeCode\": \"CU\"\r\n }\r\n ],\r\n \"weight\": 22.5,\r\n \"dimensions\": {\r\n \"length\": 15,\r\n \"width\": 15,\r\n \"height\": 40\r\n },\r\n \"description\": \"Piece content description\"\r\n }\r\n ],\r\n \"isCustomsDeclarable\": true,\r\n \"declaredValue\": 150,\r\n \"declaredValueCurrency\": \"GBP\",\r\n \"exportDeclaration\": {\r\n \"lineItems\": [\r\n {\r\n \"number\": 1,\r\n \"description\": \"line item description\",\r\n \"price\": 150,\r\n \"priceCurrency\": \"GBP\",\r\n \"quantity\": {\r\n \"value\": 1,\r\n \"unitOfMeasurement\": \"BOX\"\r\n },\r\n \"commodityCodes\": [\r\n {\r\n \"typeCode\": \"outbound\",\r\n \"value\": \"HS1234567890\"\r\n }\r\n ],\r\n \"exportReasonType\": \"permanent\",\r\n \"manufacturerCountry\": \"CZ\",\r\n \"weight\": {\r\n \"netValue\": 10,\r\n \"grossValue\": 10\r\n }\r\n }\r\n ],\r\n \"additionalCharges\": [\r\n {\r\n \"value\": 10,\r\n \"typeCode\": \"freight\"\r\n }\r\n ],\r\n \"invoice\": {\r\n \"number\": \"12345-ABC\",\r\n \"date\": \"2020-03-18\",\r\n \"signatureName\": \"Brewer\",\r\n \"signatureTitle\": \"Mr.\"\r\n },\r\n \"exportReason\": \"Sold To Receiver\",\r\n \"placeOfIncoterm\": \"Beverly Hills\",\r\n \"shipmentType\": \"commercial\"\r\n },\r\n \"description\": \"shipment description\",\r\n \"incoterm\": \"DAP\",\r\n \"unitOfMeasurement\": \"metric\"\r\n },\r\n \"documentImages\": [\r\n {\r\n \"typeCode\": \"INV\",\r\n \"imageFormat\": \"PDF\",\r\n \"content\": \"encoded invoice\"\r\n }\r\n ]\r\n}" }, "url": { "raw": "https://express.api.dhl.com/mydhlapi/test/shipments", "protocol": "https", "host": [ "express", "api", "dhl", "com" ], "path": [ "mydhlapi", "test", "shipments" ] } }, "response": [] }, { "name": "PLT Render Invoice", "request": { "method": "POST", "header": [ { "key": "Content-Type", "type": "text", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\r\n \"plannedShippingDateAndTime\": \"2021-05-24T18:00:31GMT+01:00\",\r\n \"pickup\": {\r\n \"isRequested\": false\r\n },\r\n \"productCode\": \"P\",\r\n \"accounts\": [\r\n {\r\n \"typeCode\": \"shipper\",\r\n \"number\": \"enter DHL account number\"\r\n }\r\n ],\r\n \"valueAddedServices\": [\r\n {\r\n \"serviceCode\": \"WY\"\r\n }\r\n ],\r\n \"outputImageProperties\": {\r\n \"encodingFormat\": \"pdf\",\r\n \"imageOptions\": [\r\n {\r\n \"typeCode\": \"invoice\",\r\n \"templateName\": \"COMMERCIAL_INVOICE_P_10\",\r\n \"isRequested\": true,\r\n \"invoiceType\": \"commercial\"\r\n }\r\n ]\r\n },\r\n \"customerDetails\": {\r\n \"shipperDetails\": {\r\n \"postalAddress\": {\r\n \"addressLine1\": \"Address Line 1\",\r\n \"addressLine2\": \"Address Line 2\",\r\n \"addressLine3\": \"Address Line 3\",\r\n \"postalCode\": \"SL3 0BB\",\r\n \"cityName\": \"Colnbrook\",\r\n \"countryCode\": \"GB\"\r\n },\r\n \"contactInformation\": {\r\n \"companyName\": \"Company Name\",\r\n \"fullName\": \"John Brew\",\r\n \"phone\": \"1212345678\",\r\n \"email\": \"a@b.com\"\r\n },\r\n \"registrationNumbers\": [\r\n {\r\n \"number\": \"GB12345\",\r\n \"issuerCountryCode\": \"GB\",\r\n \"typeCode\": \"VAT\"\r\n },\r\n {\r\n \"number\": \"GB12345\",\r\n \"issuerCountryCode\": \"GB\",\r\n \"typeCode\": \"EOR\"\r\n }\r\n ],\r\n \"typeCode\": \"business\"\r\n },\r\n \"receiverDetails\": {\r\n \"postalAddress\": {\r\n \"addressLine1\": \"Address Line 1\",\r\n \"addressLine2\": \"Address Line 2\",\r\n \"addressLine3\": \"Address Line 3\",\r\n \"postalCode\": \"90210\",\r\n \"cityName\": \"Beverly Hills\",\r\n \"countryCode\": \"US\",\r\n \"provinceCode\": \"CA\"\r\n },\r\n \"contactInformation\": {\r\n \"companyName\": \"Company Name\",\r\n \"fullName\": \"John Brew\",\r\n \"phone\": \"+1123456789\",\r\n \"email\": \"a@b.com\"\r\n },\r\n \"registrationNumbers\": [\r\n {\r\n \"number\": \"GB12345\",\r\n \"issuerCountryCode\": \"GB\",\r\n \"typeCode\": \"VAT\"\r\n },\r\n {\r\n \"number\": \"GB12345\",\r\n \"issuerCountryCode\": \"GB\",\r\n \"typeCode\": \"EOR\"\r\n }\r\n ],\r\n \"typeCode\": \"business\"\r\n }\r\n },\r\n \"customerReferences\": [\r\n {\r\n \"value\": \"Customer reference\",\r\n \"typeCode\": \"CU\"\r\n }\r\n ],\r\n \"content\": {\r\n \"packages\": [\r\n {\r\n \"customerReferences\": [\r\n {\r\n \"value\": \"Piece reference\",\r\n \"typeCode\": \"CU\"\r\n }\r\n ],\r\n \"weight\": 22.5,\r\n \"dimensions\": {\r\n \"length\": 15,\r\n \"width\": 15,\r\n \"height\": 40\r\n },\r\n \"description\": \"Piece content description\"\r\n }\r\n ],\r\n \"isCustomsDeclarable\": true,\r\n \"declaredValue\": 150,\r\n \"declaredValueCurrency\": \"GBP\",\r\n \"exportDeclaration\": {\r\n \"lineItems\": [\r\n {\r\n \"number\": 1,\r\n \"description\": \"line item description\",\r\n \"price\": 150,\r\n \"priceCurrency\": \"GBP\",\r\n \"quantity\": {\r\n \"value\": 1,\r\n \"unitOfMeasurement\": \"BOX\"\r\n },\r\n \"commodityCodes\": [\r\n {\r\n \"typeCode\": \"outbound\",\r\n \"value\": \"HS1234567890\"\r\n }\r\n ],\r\n \"exportReasonType\": \"permanent\",\r\n \"manufacturerCountry\": \"CZ\",\r\n \"weight\": {\r\n \"netValue\": 10,\r\n \"grossValue\": 10\r\n }\r\n }\r\n ],\r\n \"additionalCharges\": [\r\n {\r\n \"value\": 10,\r\n \"typeCode\": \"freight\"\r\n }\r\n ],\r\n \"invoice\": {\r\n \"number\": \"12345-ABC\",\r\n \"date\": \"2020-03-18\",\r\n \"signatureName\": \"Brewer\",\r\n \"signatureTitle\": \"Mr.\"\r\n },\r\n \"exportReason\": \"Sold To Receiver\",\r\n \"placeOfIncoterm\": \"Beverly Hills\",\r\n \"shipmentType\": \"commercial\"\r\n },\r\n \"description\": \"shipment description\",\r\n \"incoterm\": \"DAP\",\r\n \"unitOfMeasurement\": \"metric\"\r\n }\r\n}" }, "url": { "raw": "https://express.api.dhl.com/mydhlapi/test/shipments", "protocol": "https", "host": [ "express", "api", "dhl", "com" ], "path": [ "mydhlapi", "test", "shipments" ] } }, "response": [] }, { "name": "PLT Render Invoice DDP", "request": { "method": "POST", "header": [ { "key": "Content-Type", "type": "text", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\r\n \"plannedShippingDateAndTime\": \"2021-03-31T18:00:31GMT+01:00\",\r\n \"pickup\": {\r\n \"isRequested\": false\r\n },\r\n \"productCode\": \"P\",\r\n \"accounts\": [\r\n {\r\n \"typeCode\": \"shipper\",\r\n \"number\": \"enter DHL account number\"\r\n },\r\n {\r\n \"typeCode\": \"duites-taxes\",\r\n \"number\": \"enter DHL duty account number\"\r\n }\r\n ],\r\n \"valueAddedServices\": [\r\n {\r\n \"serviceCode\": \"WY\"\r\n },\r\n {\r\n \"serviceCode\": \"DD\"\r\n }\r\n ],\r\n \"outputImageProperties\": {\r\n \"encodingFormat\": \"pdf\",\r\n \"imageOptions\": [\r\n {\r\n \"typeCode\": \"invoice\",\r\n \"templateName\": \"COMMERCIAL_INVOICE_P_10\",\r\n \"isRequested\": true,\r\n \"invoiceType\": \"commercial\"\r\n }\r\n ]\r\n },\r\n \"customerDetails\": {\r\n \"shipperDetails\": {\r\n \"postalAddress\": {\r\n \"addressLine1\": \"Address Line 1\",\r\n \"addressLine2\": \"Address Line 2\",\r\n \"addressLine3\": \"Address Line 3\",\r\n \"postalCode\": \"SL3 0BB\",\r\n \"cityName\": \"Colnbrook\",\r\n \"countryCode\": \"GB\"\r\n },\r\n \"contactInformation\": {\r\n \"companyName\": \"Company Name\",\r\n \"fullName\": \"John Brew\",\r\n \"phone\": \"1212345678\",\r\n \"email\": \"a@b.com\"\r\n },\r\n \"registrationNumbers\": [\r\n {\r\n \"number\": \"GB12345\",\r\n \"issuerCountryCode\": \"GB\",\r\n \"typeCode\": \"VAT\"\r\n },\r\n {\r\n \"number\": \"GB12345\",\r\n \"issuerCountryCode\": \"GB\",\r\n \"typeCode\": \"EOR\"\r\n }\r\n ],\r\n \"typeCode\": \"business\"\r\n },\r\n \"receiverDetails\": {\r\n \"postalAddress\": {\r\n \"addressLine1\": \"Address Line 1\",\r\n \"addressLine2\": \"Address Line 2\",\r\n \"addressLine3\": \"Address Line 3\",\r\n \"postalCode\": \"90210\",\r\n \"cityName\": \"Beverly Hills\",\r\n \"countryCode\": \"US\",\r\n \"provinceCode\": \"CA\"\r\n },\r\n \"contactInformation\": {\r\n \"companyName\": \"Company Name\",\r\n \"fullName\": \"John Brew\",\r\n \"phone\": \"+1123456789\",\r\n \"email\": \"a@b.com\"\r\n },\r\n \"registrationNumbers\": [\r\n {\r\n \"number\": \"GB12345\",\r\n \"issuerCountryCode\": \"GB\",\r\n \"typeCode\": \"VAT\"\r\n },\r\n {\r\n \"number\": \"GB12345\",\r\n \"issuerCountryCode\": \"GB\",\r\n \"typeCode\": \"EOR\"\r\n }\r\n ],\r\n \"typeCode\": \"business\"\r\n }\r\n },\r\n \"customerReferences\": [\r\n {\r\n \"value\": \"Customer reference\",\r\n \"typeCode\": \"CU\"\r\n }\r\n ],\r\n \"content\": {\r\n \"packages\": [\r\n {\r\n \"customerReferences\": [\r\n {\r\n \"value\": \"Piece reference\",\r\n \"typeCode\": \"CU\"\r\n }\r\n ],\r\n \"weight\": 22.5,\r\n \"dimensions\": {\r\n \"length\": 15,\r\n \"width\": 15,\r\n \"height\": 40\r\n },\r\n \"description\": \"Piece content description\"\r\n }\r\n ],\r\n \"isCustomsDeclarable\": true,\r\n \"declaredValue\": 150,\r\n \"declaredValueCurrency\": \"GBP\",\r\n \"exportDeclaration\": {\r\n \"lineItems\": [\r\n {\r\n \"number\": 1,\r\n \"description\": \"line item description\",\r\n \"price\": 150,\r\n \"priceCurrency\": \"GBP\",\r\n \"quantity\": {\r\n \"value\": 1,\r\n \"unitOfMeasurement\": \"BOX\"\r\n },\r\n \"commodityCodes\": [\r\n {\r\n \"typeCode\": \"outbound\",\r\n \"value\": \"HS1234567890\"\r\n }\r\n ],\r\n \"exportReasonType\": \"permanent\",\r\n \"manufacturerCountry\": \"CZ\",\r\n \"weight\": {\r\n \"netValue\": 10,\r\n \"grossValue\": 10\r\n }\r\n }\r\n ],\r\n \"additionalCharges\": [\r\n {\r\n \"value\": 10,\r\n \"typeCode\": \"freight\"\r\n }\r\n ],\r\n \"invoice\": {\r\n \"number\": \"12345-ABC\",\r\n \"date\": \"2020-03-18\",\r\n \"signatureName\": \"Brewer\",\r\n \"signatureTitle\": \"Mr.\"\r\n },\r\n \"exportReason\": \"Sold To Receiver\",\r\n \"placeOfIncoterm\": \"Colnbrook\",\r\n \"shipmentType\": \"commercial\"\r\n },\r\n \"description\": \"shipment description\",\r\n \"incoterm\": \"DDP\",\r\n \"unitOfMeasurement\": \"metric\"\r\n }\r\n}" }, "url": { "raw": "https://express.api.dhl.com/mydhlapi/test/shipments", "protocol": "https", "host": [ "express", "api", "dhl", "com" ], "path": [ "mydhlapi", "test", "shipments" ] } }, "response": [] }, { "name": "PLT Render Invoice IOR", "request": { "method": "POST", "header": [ { "key": "Content-Type", "type": "text", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\r\n \"plannedShippingDateAndTime\": \"2021-05-24T18:00:31GMT+01:00\",\r\n \"pickup\": {\r\n \"isRequested\": false\r\n },\r\n \"productCode\": \"P\",\r\n \"accounts\": [\r\n {\r\n \"typeCode\": \"shipper\",\r\n \"number\": \"enter DHL account number\"\r\n },\r\n {\r\n \"typeCode\": \"duties-taxes\",\r\n \"number\": \"enter destination DHL duty account number\"\r\n }\r\n ],\r\n \"valueAddedServices\": [\r\n {\r\n \"serviceCode\": \"WY\"\r\n }\r\n ],\r\n \"outputImageProperties\": {\r\n \"encodingFormat\": \"pdf\",\r\n \"imageOptions\": [\r\n {\r\n \"typeCode\": \"invoice\",\r\n \"templateName\": \"COMMERCIAL_INVOICE_P_10\",\r\n \"isRequested\": true,\r\n \"invoiceType\": \"commercial\"\r\n }\r\n ]\r\n },\r\n \"customerDetails\": {\r\n \"shipperDetails\": {\r\n \"postalAddress\": {\r\n \"addressLine1\": \"Address Line 1\",\r\n \"addressLine2\": \"Address Line 2\",\r\n \"addressLine3\": \"Address Line 3\",\r\n \"postalCode\": \"SL3 0BB\",\r\n \"cityName\": \"Colnbrook\",\r\n \"countryCode\": \"GB\"\r\n },\r\n \"contactInformation\": {\r\n \"companyName\": \"Company Name\",\r\n \"fullName\": \"John Brew\",\r\n \"phone\": \"1212345678\",\r\n \"email\": \"a@b.com\"\r\n },\r\n \"registrationNumbers\": [\r\n {\r\n \"number\": \"GB12345\",\r\n \"issuerCountryCode\": \"GB\",\r\n \"typeCode\": \"VAT\"\r\n },\r\n {\r\n \"number\": \"GB12345\",\r\n \"issuerCountryCode\": \"GB\",\r\n \"typeCode\": \"EOR\"\r\n }\r\n ],\r\n \"typeCode\": \"business\"\r\n },\r\n \"receiverDetails\": {\r\n \"postalAddress\": {\r\n \"addressLine1\": \"Address Line 1\",\r\n \"addressLine2\": \"Address Line 2\",\r\n \"addressLine3\": \"Address Line 3\",\r\n \"postalCode\": \"90210\",\r\n \"cityName\": \"Beverly Hills\",\r\n \"countryCode\": \"US\",\r\n \"provinceCode\": \"CA\"\r\n },\r\n \"contactInformation\": {\r\n \"companyName\": \"Company Name\",\r\n \"fullName\": \"John Brew\",\r\n \"phone\": \"+1123456789\",\r\n \"email\": \"a@b.com\"\r\n },\r\n \"registrationNumbers\": [\r\n {\r\n \"number\": \"GB12345\",\r\n \"issuerCountryCode\": \"GB\",\r\n \"typeCode\": \"VAT\"\r\n },\r\n {\r\n \"number\": \"GB12345\",\r\n \"issuerCountryCode\": \"GB\",\r\n \"typeCode\": \"EOR\"\r\n }\r\n ],\r\n \"typeCode\": \"business\"\r\n },\r\n \"importerDetails\": {\r\n \"postalAddress\": {\r\n \"addressLine1\": \"Address Line 1\",\r\n \"addressLine2\": \"Address Line 2\",\r\n \"addressLine3\": \"Address Line 3\",\r\n \"postalCode\": \"90210\",\r\n \"cityName\": \"Beverly Hills\",\r\n \"countryCode\": \"US\",\r\n \"provinceCode\": \"CA\"\r\n },\r\n \"contactInformation\": {\r\n \"companyName\": \"Company Name\",\r\n \"fullName\": \"John Brew\",\r\n \"phone\": \"+1123456789\",\r\n \"email\": \"a@b.com\"\r\n },\r\n \"registrationNumbers\": [\r\n {\r\n \"number\": \"GB12345\",\r\n \"issuerCountryCode\": \"GB\",\r\n \"typeCode\": \"VAT\"\r\n },\r\n {\r\n \"number\": \"GB12345\",\r\n \"issuerCountryCode\": \"GB\",\r\n \"typeCode\": \"EOR\"\r\n }\r\n ],\r\n \"typeCode\": \"business\"\r\n }\r\n },\r\n \"customerReferences\": [\r\n {\r\n \"value\": \"Customer reference\",\r\n \"typeCode\": \"CU\"\r\n }\r\n ],\r\n \"content\": {\r\n \"packages\": [\r\n {\r\n \"customerReferences\": [\r\n {\r\n \"value\": \"Piece reference\",\r\n \"typeCode\": \"CU\"\r\n }\r\n ],\r\n \"weight\": 22.5,\r\n \"dimensions\": {\r\n \"length\": 15,\r\n \"width\": 15,\r\n \"height\": 40\r\n },\r\n \"description\": \"Piece content description\"\r\n }\r\n ],\r\n \"isCustomsDeclarable\": true,\r\n \"declaredValue\": 150,\r\n \"declaredValueCurrency\": \"GBP\",\r\n \"exportDeclaration\": {\r\n \"lineItems\": [\r\n {\r\n \"number\": 1,\r\n \"description\": \"line item description\",\r\n \"price\": 150,\r\n \"priceCurrency\": \"GBP\",\r\n \"quantity\": {\r\n \"value\": 1,\r\n \"unitOfMeasurement\": \"BOX\"\r\n },\r\n \"commodityCodes\": [\r\n {\r\n \"typeCode\": \"outbound\",\r\n \"value\": \"HS1234567890\"\r\n }\r\n ],\r\n \"exportReasonType\": \"permanent\",\r\n \"manufacturerCountry\": \"CZ\",\r\n \"weight\": {\r\n \"netValue\": 10,\r\n \"grossValue\": 10\r\n }\r\n }\r\n ],\r\n \"additionalCharges\": [\r\n {\r\n \"value\": 10,\r\n \"typeCode\": \"freight\"\r\n }\r\n ],\r\n \"invoice\": {\r\n \"number\": \"12345-ABC\",\r\n \"date\": \"2020-03-18\",\r\n \"signatureName\": \"Brewer\",\r\n \"signatureTitle\": \"Mr.\"\r\n },\r\n \"exportReason\": \"Sold To Receiver\",\r\n \"placeOfIncoterm\": \"Beverly Hills\",\r\n \"shipmentType\": \"commercial\"\r\n },\r\n \"description\": \"shipment description\",\r\n \"incoterm\": \"DAP\",\r\n \"unitOfMeasurement\": \"metric\"\r\n }\r\n}" }, "url": { "raw": "https://express.api.dhl.com/mydhlapi/test/shipments", "protocol": "https", "host": [ "express", "api", "dhl", "com" ], "path": [ "mydhlapi", "test", "shipments" ] } }, "response": [] }, { "name": "EPOD", "request": { "method": "GET", "header": [], "url": { "raw": "https://express.api.dhl.com/mydhlapi/shipments/1111111111/proof-of-delivery?shipperAccountNumber=123456789&content=epod-summary", "protocol": "https", "host": [ "express", "api", "dhl", "com" ], "path": [ "mydhlapi", "shipments", "1111111111", "proof-of-delivery" ], "query": [ { "key": "shipperAccountNumber", "value": "123456789", "description": "DHL Express customer shipper account number" }, { "key": "content", "value": "epod-summary", "description": "Available values : epod-detail, epod-summary, epod-detail-esig, epod-summary-esig, epod-table" } ] } }, "response": [] } ] }, { "name": "Tracking", "item": [ { "name": "Tracking (Single Shipment)", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true, "accept-encoding": true, "connection": true, "host": true, "user-agent": true } }, "request": { "method": "GET", "header": [], "url": { "raw": "https://express.api.dhl.com/mydhlapi/test/shipments/7957673080/tracking?trackingView=all-checkpoints&levelOfDetail=all", "protocol": "https", "host": [ "express", "api", "dhl", "com" ], "path": [ "mydhlapi", "test", "shipments", "7957673080", "tracking" ], "query": [ { "key": "trackingView", "value": "all-checkpoints", "description": "Available values : all-checkpoints, last-checkpoint, shipment-details-only, advance-shipment, bbx-children" }, { "key": "levelOfDetail", "value": "all", "description": "Available values : shipment, piece, all" } ] } }, "response": [] }, { "name": "Tracking (Multiple Shipments)", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true, "accept-encoding": true, "connection": true, "host": true, "user-agent": true } }, "request": { "method": "GET", "header": [], "url": { "raw": "https://express.api.dhl.com/mydhlapi/test/tracking?shipmentTrackingNumber=7957673080&shipmentTrackingNumber=5786696720&shipperAccountNumber=8066924740&dateRangeFrom=2021-01-01&dateRangeTo=2021-06-01&trackingView=all-checkpoints&levelOfDetail=all", "protocol": "https", "host": [ "express", "api", "dhl", "com" ], "path": [ "mydhlapi", "test", "tracking" ], "query": [ { "key": "shipmentTrackingNumber", "value": "7957673080", "description": "DHL Express shipment identification number" }, { "key": "shipmentTrackingNumber", "value": "5786696720", "description": "DHL Express shipment identification number" }, { "key": "shipperAccountNumber", "value": "8066924740", "description": "DHL Express shipment identification number" }, { "key": "dateRangeFrom", "value": "2021-01-01", "description": "When tracking by Shipment reference you need to restrict the search by timeframe. Please provide the start of the period." }, { "key": "dateRangeTo", "value": "2021-06-01", "description": "When tracking by Shipment reference you need to restrict the search by timeframe.Please provide the end of the period." }, { "key": "trackingView", "value": "all-checkpoints", "description": "Available values : all-checkpoints, last-checkpoint, shipment-details-only, advance-shipment, bbx-children" }, { "key": "levelOfDetail", "value": "all", "description": "Available values : shipment, piece, all" } ] } }, "response": [] } ], "description": "https://developer.dhl.com/api-reference/dhl-express-mydhl-api#reference-docs-section%tracking", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }, { "name": "Pickup", "item": [ { "name": "Create Pickup", "request": { "method": "POST", "header": [ { "key": "Content-Type", "type": "text", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\r\n \"plannedPickupDateAndTime\": \"2020-12-02T14:00:31GMT+01:00\",\r\n \"closeTime\": \"18:00\",\r\n \"location\": \"reception\",\r\n \"locationType\": \"residence\",\r\n \"accounts\": [\r\n {\r\n \"typeCode\": \"shipper\",\r\n \"number\": \"redacted\"\r\n }\r\n ],\r\n \"specialInstructions\": [\r\n {\r\n \"value\": \"please ring door bell\",\r\n \"typeCode\": \"TBD\"\r\n }\r\n ],\r\n \"customerDetails\": {\r\n \"shipperDetails\": {\r\n \"postalAddress\": {\r\n \"postalCode\": \"SL3 0BB\",\r\n \"cityName\": \"Colnbrook\",\r\n \"countryCode\": \"GB\",\r\n \"addressLine1\": \"address1\",\r\n \"addressLine2\": \"addres2\",\r\n \"addressLine3\": \"addres3\"\r\n },\r\n \"contactInformation\": {\r\n \"email\": \"that@before.de\",\r\n \"phone\": \"+1123456789\",\r\n \"mobilePhone\": \"+60112345678\",\r\n \"companyName\": \"Company Name\",\r\n \"fullName\": \"John Brew\"\r\n }\r\n }\r\n },\r\n \"shipmentDetails\": [\r\n {\r\n \"productCode\": \"P\",\r\n \"localProductCode\": \"P\",\r\n \"isCustomsDeclarable\": true,\r\n \"unitOfMeasurement\": \"metric\",\r\n \"packages\": [\r\n {\r\n \"weight\": 10.5,\r\n \"dimensions\": {\r\n \"length\": 25,\r\n \"width\": 35,\r\n \"height\": 15\r\n }\r\n }\r\n ]\r\n }\r\n ]\r\n}" }, "url": { "raw": "https://express.api.dhl.com/mydhlapi/test/pickups", "protocol": "https", "host": [ "express", "api", "dhl", "com" ], "path": [ "mydhlapi", "test", "pickups" ] } }, "response": [] }, { "name": "Update Pickup", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "type": "text", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\r\n \"dispatchConfirmationNumber\": \"CBJ201220123456\",\r\n \"originalShipperAccountNumber\": \"123456789\",\r\n \"plannedPickupDateAndTime\": \"2019-08-04T14:00:31GMT+01:00\",\r\n \"closeTime\": \"18:00\",\r\n \"location\": \"reception\",\r\n \"locationType\": \"residence\",\r\n \"accounts\": [\r\n {\r\n \"typeCode\": \"shipper\",\r\n \"number\": \"123456789\"\r\n }\r\n ],\r\n \"specialInstructions\": [\r\n {\r\n \"value\": \"please ring door bell\",\r\n \"typeCode\": \"TBD\"\r\n }\r\n ],\r\n \"remark\": \"string\",\r\n \"customerDetails\": {\r\n \"shipperDetails\": {\r\n \"postalAddress\": {\r\n \"postalCode\": \"14800\",\r\n \"cityName\": \"Prague\",\r\n \"countryCode\": \"CZ\",\r\n \"provinceCode\": \"CZ\",\r\n \"addressLine1\": \"V Parku 2308/10\",\r\n \"addressLine2\": \"addres2\",\r\n \"addressLine3\": \"addres3\",\r\n \"countyName\": \"Central Bohemia\"\r\n },\r\n \"contactInformation\": {\r\n \"email\": \"that@before.de\",\r\n \"phone\": \"+1123456789\",\r\n \"mobilePhone\": \"+60112345678\",\r\n \"companyName\": \"Company Name\",\r\n \"fullName\": \"John Brew\"\r\n }\r\n },\r\n \"receiverDetails\": {\r\n \"postalAddress\": {\r\n \"postalCode\": \"14800\",\r\n \"cityName\": \"Prague\",\r\n \"countryCode\": \"CZ\",\r\n \"provinceCode\": \"CZ\",\r\n \"addressLine1\": \"V Parku 2308/10\",\r\n \"addressLine2\": \"addres2\",\r\n \"addressLine3\": \"addres3\",\r\n \"countyName\": \"Central Bohemia\"\r\n },\r\n \"contactInformation\": {\r\n \"email\": \"that@before.de\",\r\n \"phone\": \"+1123456789\",\r\n \"mobilePhone\": \"+60112345678\",\r\n \"companyName\": \"Company Name\",\r\n \"fullName\": \"John Brew\"\r\n }\r\n },\r\n \"bookingRequestorDetails\": {\r\n \"postalAddress\": {\r\n \"postalCode\": \"14800\",\r\n \"cityName\": \"Prague\",\r\n \"countryCode\": \"CZ\",\r\n \"provinceCode\": \"CZ\",\r\n \"addressLine1\": \"V Parku 2308/10\",\r\n \"addressLine2\": \"addres2\",\r\n \"addressLine3\": \"addres3\",\r\n \"countyName\": \"Central Bohemia\"\r\n },\r\n \"contactInformation\": {\r\n \"email\": \"that@before.de\",\r\n \"phone\": \"+1123456789\",\r\n \"mobilePhone\": \"+60112345678\",\r\n \"companyName\": \"Company Name\",\r\n \"fullName\": \"John Brew\"\r\n }\r\n },\r\n \"pickupDetails\": {\r\n \"postalAddress\": {\r\n \"postalCode\": \"14800\",\r\n \"cityName\": \"Prague\",\r\n \"countryCode\": \"CZ\",\r\n \"provinceCode\": \"CZ\",\r\n \"addressLine1\": \"V Parku 2308/10\",\r\n \"addressLine2\": \"addres2\",\r\n \"addressLine3\": \"addres3\",\r\n \"countyName\": \"Central Bohemia\"\r\n },\r\n \"contactInformation\": {\r\n \"email\": \"that@before.de\",\r\n \"phone\": \"+1123456789\",\r\n \"mobilePhone\": \"+60112345678\",\r\n \"companyName\": \"Company Name\",\r\n \"fullName\": \"John Brew\"\r\n }\r\n }\r\n },\r\n \"shipmentDetails\": [\r\n {\r\n \"productCode\": \"D\",\r\n \"localProductCode\": \"D\",\r\n \"accounts\": [\r\n {\r\n \"typeCode\": \"shipper\",\r\n \"number\": \"123456789\"\r\n }\r\n ],\r\n \"valueAddedServices\": [\r\n {\r\n \"serviceCode\": \"II\",\r\n \"localServiceCode\": \"II\",\r\n \"value\": 100,\r\n \"currency\": \"GBP\",\r\n \"method\": \"cash\"\r\n }\r\n ],\r\n \"isCustomsDeclarable\": true,\r\n \"declaredValue\": 150,\r\n \"declaredValueCurrency\": \"CZK\",\r\n \"unitOfMeasurement\": \"metric\",\r\n \"shipmentTrackingNumber\": \"123456790\",\r\n \"packages\": [\r\n {\r\n \"typeCode\": \"3BX\",\r\n \"weight\": 10.5,\r\n \"dimensions\": {\r\n \"length\": 25,\r\n \"width\": 35,\r\n \"height\": 15\r\n }\r\n }\r\n ]\r\n }\r\n ]\r\n}" }, "url": { "raw": "https://express.api.dhl.com/mydhlapi/test/pickups/*dispatchConfirmationNumber*", "protocol": "https", "host": [ "express", "api", "dhl", "com" ], "path": [ "mydhlapi", "test", "pickups", "*dispatchConfirmationNumber*" ] } }, "response": [] }, { "name": "Cancel Pickup", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "type": "text", "value": "application/json" } ], "url": { "raw": "https://api-mock.dhl.com/mydhlapi/pickups/PRG999126012345?requestorName=Fred%20Brent&reason=Unplanned%20leave", "protocol": "https", "host": [ "api-mock", "dhl", "com" ], "path": [ "mydhlapi", "pickups", "PRG999126012345" ], "query": [ { "key": "requestorName", "value": "Fred%20Brent", "description": "Name of the person requesting to cancel the scheduled pickup" }, { "key": "reason", "value": "Unplanned%20leave", "description": "Provide why scheduled pickup is being cancelled" } ] } }, "response": [] } ] }, { "name": "Address", "item": [ { "name": "Address Validate", "request": { "method": "GET", "header": [], "url": { "raw": "https://express.api.dhl.com/mydhlapi/test/address-validate?type=delivery&countryCode=GB&postalCode=SL3 0BB&cityName=Colnbrook&strictValidation=true", "protocol": "https", "host": [ "express", "api", "dhl", "com" ], "path": [ "mydhlapi", "test", "address-validate" ], "query": [ { "key": "type", "value": "delivery", "description": "delivery/pickup" }, { "key": "countryCode", "value": "GB", "description": "A short text string code (see values defined in ISO 3166) specifying the shipment origin country" }, { "key": "postalCode", "value": "SL3 0BB", "description": "Text specifying the postal code for an address. https://gs1.org/voc/postalCode" }, { "key": "cityName", "value": "Colnbrook", "description": "Text specifying the city name" }, { "key": "strictValidation", "value": "true", "description": "If set to true service will return no records when exact valid match not found" } ] } }, "response": [] } ] } ], "auth": { "type": "basic", "basic": [ { "key": "password", "value": "{{password}}", "type": "string" }, { "key": "username", "value": "{{username}}", "type": "string" } ] }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }