Overview
-
The steps below will guide you through integrating your DEAR platform with DHL Express Commerce. Once completed, your orders will be imported into DHL Express Commerce and the tracking information will be written back when you print a label.
What you need to get started:
Before getting started with DEAR you will need a few things.
-
Your DEAR Account Id
- Your DEAR API Key
If you do not have the above fields, follow the below steps:
- Log into DEAR Inventory System
- Go to Integration > DEAR API
- Create a new API application
- Save the new API application and note down the Account ID and the Key
How to set up DEAR:
To enable DEAR on your account:
- Go to DHL Express Commerce > Settings > Integrations > Add a new integration > DEAR
- Recommended: Select Version 2 for the API version.
- Enter in the Account ID and Key from DEAR
- Click Save
Writeback
DHL Express Commerce will update your orders with carrier and tracking information when shipped. By default, DHL Express Commerce will use "DEFAULT Carrier" when updating your orders in the DEAR Inventory System.
If you wish to have your DEAR orders to be updated with the specific carrier name then you will need to set up Carrier Mappings in DHL Express Commerce.
- Go to Settings > Integrations > DEAR > Courier Mappings
- Click Add a new mapping
- From the courier drop down, select one of your enabled couriers
- In the courier name to use textbox, enter in the courier name you have defined in DEAR
- When done, click the tick icon
When writeback is attempted for the courier specified, we will send back the courier name you have defined in this field
Additional Configuration
-
Status to import
- Use this option to specify what status orders should be in to import into DHL Express Commerce. You can specify multiple by separating each status with a semi colon. For example: Ordering;Picked
-
Advanced Sales
- If you are using DEAR's Advanced Sales - Multiple Fulfillments you can configure your DHL Express Commerce integration to import each fulfilment and a single order, instead of importing the overall sales orders.
To do this, you will need to be on DEAR Version 2 and select "Import Sale Fulfillments instead of Sales". This means you will have multiple DHL Express Commerce orders for the one order in DEAR allowing you to ship them separately with ease.
- Import Memo/Order Notes
- By default DHL Express Commerce does not import memo's from DEAR. If you would like these to import into the delivery instructions field, select the option you would like from the memo drop down. Alternatively you can import the order notes by selecting Import order note into delivery instructions
-
API Limits
- DEAR has an API limit of 60 calls per 60 seconds. This can occasionally mean that the writeback to DEAR will fail, or that the import will fail. These both will retry again should they fail.