<aside> 💡 Follow the guide below to pass what3words addresses to consignments and carriers using Sorted Ship Consigments or reach out to your Sorted Account Manager

</aside>

You can now pass what3words addresses to your consignments and carriers using Sorted Ship Consignments. Any carrier who supports what3words can use the what3words addresses in combination with traditional address data for their deliveries.

If a carrier does not support what3words in their set-up, the locations won’t be passed, therefore preventing any issues.

How to pass on a what3words address

The instructions below explain how to pass what3words addresses to your consignments. To do so, you must pass a metadata KeyValue equal to “What3Words” and the associated StringValue to be accepted and stored against a consignment. Where provided, this detail will be passed to a carrier.

Follow the instructions below to implement what3words into your API calls:

1. Using an appropriate API call, prepare the metadata array.
   1. Note: View the Ship Consignments API Reference for all Sorted’s API methods
2. Populate the KeyValue property with “What3Words”.
   1. Note: This field is required. Make sure this property equals “What3Words” exactly.
3. Finally, the StringValue must contain the 3 word values.
   1. Note: Populate this property with the 3 words required, separated with ‘.’ between each word.

Please find an example metadata array below:

With the instruction above complete, this integration will pass the what3words values to your consignments.

You can check this by clicking a consignment in Ship Consignments and clicking the Metadata tab of the selected consignment.

How to collect and pass on what3words addresses from your end customers

In order to pass on what3words addresses to DPD UK, clients need to capture what3words addresses from their customers, in the same way you capture and store traditional address information.

If you are an eCommerce retailer - you can integrate what3words onto your online eCommerce website, which is as simple as adding an optional address capture field on checkout/account pages. We have all the developer documentations available for this on our website: https://what3words.com/business/ecommerce