<aside> 💡 To use what3words with DHL eCommerce UK or for further integration support, please get in touch with your DHL Account Manager or visit this page

</aside>

DHL eCommerce UK (formerly DHL Parcel UK/ UK Mail) now accepts your customers’ what3words addresses.

If you are an existing customer who has a DHL eCommerce UK API integration, you can offer your customers the ability to add and save their what3words within your order processing, checkout page, or your customer account profiles. See more about how to integrate and use via API below.

what3words is also available for DHL customers using the Ship platform. See more about how to use what3words in Ship below.

<aside> ⚠️ To collect what3words addresses from your customers, you’ll first need to add a what3words address field to your checkout page or CRM. To do so you can use one of our existing plugins or the what3words API. You can take a look at these options and find out more information here or read section below.

</aside>

Using what3words with DHL eCommerce UK via API ****

what3words is available on DHL eCommerce UK’s Cloud API (Shipping Label API). Documentation can be found here: https://developer.dhl.com/api-reference/parcel-uk#get-started-section

DHL’s Shipping Label API is used to create shipments and optionally a label.

A what3words address may be added to the consignee address information of an order, for the DHL courier to use to execute the last-mile delivery.

To locate the what3words field in the API guide: https://developer.dhl.com/api-reference/parcel-uk#reference-docs-section

  1. Click ‘Reference Docs’ on the left.
  2. Click ‘Shipping Label API V1’ from the resulting dropdown list.
  3. See the ‘Shipping Label API V1’ title in the main contents, then under ‘Endpoints’ expand the ‘POST /shipping/v1/label’ entry.
  4. Scroll down a bit and click ‘show data schema’.
  5. The what3words field can be seen in: shipments > consigneeAddress > what3words > words You should map any what3words addresses you collect on orders to the ‘words’ field (type = string).

Untitled.png

Note that the latitude/longitude fields within ‘geo’ are for creating orders when specifying this information up-front. You do not need to provide this so can just ignore these fields.