GET /shipments/{shipmentTrackingNumber}/get-image
The Get Image service can be used to retrieve customer's own uploaded Commercial Invoice, Waybill Document or supporting documents that uploaded during shipment creation.
Servers
- https://api-mock.dhl.com/mydhlapi
- https://express.api.dhl.com/mydhlapi/test
- https://express.api.dhl.com/mydhlapi
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
shipmentTrackingNumber |
String | Yes |
DHL Express shipment identification number |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Plugin-Version |
String | No |
Please provide version of the plugin (applicable to 3PV only) |
Shipping-System-Platform-Version |
String | No |
Please provide version of the shipping platform (applicable to 3PV only) |
Webstore-Platform-Version |
String | No |
Please provide version of the webstore platform (applicable to 3PV only) |
Message-Reference-Date |
String | No |
Optional reference date in the HTTP-date format https://tools.ietf.org/html/rfc7231#section-7.1.1.2 |
Webstore-Platform-Name |
String | No |
Please provide name of the webstore platform (applicable to 3PV only) |
Shipping-System-Platform-Name |
String | No |
Please provide name of the shipping platform(applicable to 3PV only) |
Message-Reference |
String | No |
Please provide message reference |
Plugin-Name |
String | No |
Please provide name of the plugin (applicable to 3PV only) |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
pickupYearAndMonth |
String | Yes |
Please provide the pickup's date in YYYY-MM format |
typeCode |
String | Yes |
Please provide correct document type. Possible values:
|
allInOnePDF |
Boolean | No |
Option to return all the document images in a single PDF file |
compressedPackage |
Boolean | No |
Option to return all the document images in a compressed package |
shipperAccountNumber |
String | Yes |
DHL Express customer shipper account number |
encodingFormat |
String | No |
Please provide the document image encoding format in pdf or tiff format Possible values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.