DELETE /pickups/{dispatchConfirmationNumber}
The Cancel Pickup service can be used to cancel a DHL Express pickup booking 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 |
|---|---|---|---|
dispatchConfirmationNumber |
String | Yes |
Shipment pickup confirmation number for example |
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 |
|---|---|---|---|
requestorName |
String | Yes |
Name of the person requesting to cancel the scheduled pickup |
reason |
String | Yes |
Provide why scheduled pickup is being cancelled |
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.