DHL Parcel UK Cloud

Setting Up DHL Parcel UK Cloud

This document provides a step-by-step guide to integrating DHL Parcel UK Cloud with Voila. Follow these instructions to integrate DHL Parcel UK Cloud into your system:

1. Begin by navigating to the left panel and hovering your cursor over "API Accounts."
2. Click the plus icon to initiate the setup process under your preferred API Account.
3. In the first row, choose "DHL Parcel UK Cloud" from the list of available options.
4. The following fields are required for setting up DHL Parcel UK Cloud integration:
   • Company: Enter any identifier you prefer.
   • Testing: This is a simple yes or no selection. If enabled, the information will not be transmitted to the courier through their API, making it suitable for testing.
   • Client_ID, Client_Secret, Pickup_Account: You can obtain these credentials in two ways:
     
     • Through your Account Manager: If you are unsure who your account manager is, DHL's customer service team can assist you.
     • Via the DHL Developers Portal: Visit the DHL Developers Portal to request the necessary credentials.
   • Notes: Use this field to enter relevant information or notes regarding this courier. It will only be visible to you.
5. To complete the setup, click on "Save Changes." 

By following these steps, you will successfully configure the DHL Parcel UK Cloud integration with your Voila account.

Click to Play or Pause the video

The Authentication Process

An authentication process is initiated when you add your customer number, trading account, client ID, and secret to 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:

1. Successful Response: The authentication is successful, and the trading location ID is retrieved as expected.
2. Failed Response: If the account number provided is not found or any other authentication failure occurs, a failed response is generated.
3. 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

The following JSON code serves as an example for initiating a collection, referred to as a pickup by DHL. 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."
    }
}