Throughout This Page
You can jump to the specified sections by clicking on these titles.
Setting Up DHL Parcel UK Cloud
This document provides a step-by-step guide to integrating DHL Parcel UK Cloud with the Shipping API. Follow these instructions to integrate DHL Parcel UK Cloud into your system:
By following these steps, you will successfully configure the DHL Parcel UK Cloud integration with your Shipping API.
The Authentication Process
An authentication process is initiated when you add your customer number, trading account, client ID, and secret into the system. This process involves calling DHL to fetch the trading location ID, a crucial element required for ad hoc collection customers.
There are three potential outcomes of this authentication process:
- Successful Response: The authentication is successful, and the trading location ID is retrieved as expected.
- Failed Response: If the account number provided is not found or any other authentication failure occurs, a failed response is generated.
- Partial Success: Sometimes, the authentication process may result in partial success. Although the authentication succeeds in this scenario, the trading location ID is not found. Consequently, ad hoc collections become impossible. However, to alert users about this limitation, an amber warning is issued, stating: "No trading location ID found, ad hoc collections will not be possible."
This authentication mechanism ensures secure integration of DHL Parcel UK Cloud services with customer accounts while providing clear feedback on authentication status and any potential limitations encountered.
Set Up a Collection Using the API
This process ensures the smooth addition of DHL Parcel UK Cloud to the courier directory and facilitates the creation of collections as needed.
You can submit the below JSON payload to the following endpoint:
https://production.courierapi.co.uk/api/couriers/v1/DHLParcelUKCloud/create-collection
For initiating a collection, referred to as a pickup by DHL, the following JSON code serves as an example. This action is necessary only when a daily collection has not been pre-scheduled with the courier. Utilise the provided code structure:
{
"auth_company": "xxx",
"testing": false,
"collection": {
"customer_account_number": "CUS-049XX4",
"trading_location_id": "A0V3L0000012X49XXX",
"time_ready": "16:00",
"latest_time": "17:00",
"instructions": "Please pick up from door 12 at the back of the warehouse."
}
}