Overview
Integrate with WooCommerce to import your orders and create shipment labels.
The integration can also write back tracking information to these orders after printing your shipment labels.
1. Generate your API key in WooCommerce
In order to import orders from your store, DHL Express Commerce needs some information which can be found in your WooCommerce dashboard.
- From your WooCommerce dashboard, select WooCommerce > Settings.
- Click the Advanced tab.
- Select REST API near the top of the screen, then click Add Key.
- In the Description field, enter 'Integration'.
- Select a user.
- In the Permissions menu, select Read/Write.
- Click Generate API key.
- Copy the Consumer Key and Consumer Secret. You will have to paste this in the DHL Express Commerce integration settings.
Note: If you want to use the Legacy Version 1 or Legacy Version 2 integrations, you will need to enable the Legacy API on WooCommerce. Using the legacy integrations is not recommended.
- From your WooCommerce dashboard, select WooCommerce > Settings.
- Click the Advanced tab.
- Click Legacy API near the top of the screen.
- Tick Enable the legacy REST API.
- Click Save changes.
2. Add WooCommerce as an integration
- Log in to DHL Express Commerce
- In your account, go to Settings, then select Integrations.
- Click Add a new integration, and select WooCommerce from the list.
- Select the Enable WooCommerce checkbox.
- Under WooCommerce API version, select Latest Version 3.
- Enter your store URL.
If you do not know your store URL, check your WooCommerce dashboard > Settings > General > Site Address (URL). - Paste your Consumer Key and Consumer Secret copied from WooCommerce.
- Enter or select your Status to import.
- Fill out any other details as required.
- (Optional) Select Enable writeback to the customer instructions field. DHL Express Commerce will write-back the Tracking Number, Carrier Name and Tracking URL in the instruction field.
- (Optional) Select Enable customer notifications when creating order note on writeback. Customer notifications will automatically be sent when DHL Express Commerce writes back the tracking details in a note.
- Click Save.
Note: If the writeback feature is blocked or fails to work, change the Order Update Method to 'POST'. DHL Express Commerce > Settings > Platforms > WooCommerce > Settings > Order Update Method > 'POST'
3. Set your writeback method
Writeback is when DHL Express Commerce sends back tracking information to WooCommerce.
With the Latest Version 3 WooCommerce integration you can configure two different writeback methods.
To configure your writeback method follow the below steps:
- In your DHL Express Commerce account, go to Settings, then select Integrations.
- Click Settings next to WooCommerce.
- Scroll down until you see the option Writeback Method.
- From the dropdown select either of the two options:
- Create an Order Note
- Update using Shipment Tracking Plugin
Create an Order Note
When an order in DHL Express Commerce is printed or manifested, DHL Express Commerce will set the order status to complete in WooCommerce, and add an order note to the order.
You can also set the order note created to also trigger a notification to the customer. To do this enable the Enable customer notifications when creating order note tickbox option in WooCommerce settings when you have the Create an Order Note writeback method selected.
Update using Shipment Tracking Plugin
By using the plugin to add these fields, you can setup other integrations with WooCommerce (like Amazon, eBay and The Iconic) to read from these fields for the purpose of writing back to those platforms when an order is shipped.
4. Live rates at checkout
To activate live DHL Express shipping rates at your WooCommerce checkout, see this article.