PATCH /shipments/{shipmentTrackingNumber}/upload-image
The upload-image service can be used to upload PLT images to a previously created shipment. The PLT images for the shipment can be uploaded before the shipment has been physically collected by DHL courier. However, the original shipment must contain WY as the special service otherwise, an error will be returned when the customer wants to use the reupload function in this upload-image service. IMPORTANT: Please note that at least 10mins must be given between the initial createShipment request and then the upload-image request (including subsequent upload-image request).
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 |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
originalPlannedShippingDate |
String | Yes | |
accounts[] |
Array | Yes |
Please enter all the DHL Express accounts and types to be used for this shipment |
accounts[].typeCode |
String | Yes |
Please enter DHL Express acount type Possible values:
|
accounts[].number |
String | Yes |
Please enter DHL Express account number |
documentImages[] |
Array | Yes |
This section is to support multiple base64 encoded string with the image of export documentation for Paperless Trade images. When an invalid base64 encoded string is provided, an error message will be returned |
documentImages[].typeCode |
String | No |
Please provide correct document type you wish to upload Possible values:
Default value: "INV" |
documentImages[].imageFormat |
String | No |
Please provide the image file format for the document you want to upload Possible values:
Default value: "PDF" |
documentImages[].content |
String | Yes |
Please provide the base64 encoded document |
productCode |
String | Yes |
Please enter DHL Express Global Product code |
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.