@@ -22,9 +22,8 @@ to :menuselection:`Inventory app --> Configuration --> Settings`.
22
22
Scroll down to the :guilabel: `Shipping Connectors ` section, and tick the checkbox next to
23
23
:guilabel: `DHL Express Connector `. Finally, click :guilabel: `Save ` to apply the changes.
24
24
25
- Once the connector has been enabled, a :icon: `fa-arrow-right ` :guilabel: `DHL Shipping Methods ` link
26
- appears below the setting. Click the link to open a page showing all shipping methods configured for
27
- DHL.
25
+ Then, click the :icon: `fa-arrow-right ` :guilabel: `DHL Shipping Methods ` link to open a page showing
26
+ all shipping methods with the *Provider * set to DHL.
28
27
29
28
Configure DHL shipping method
30
29
=============================
@@ -66,35 +65,48 @@ DHL Configuration
66
65
The :guilabel: `DHL Configuration ` tab on the shipping method form is used to connect the user's DHL
67
66
account to Odoo, and configure the shipping method's details.
68
67
69
- DHL SiteID, password, and account number
70
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
68
+ DHL developer credentials
69
+ ~~~~~~~~~~~~~~~~~~~~~~~~~
71
70
72
- A DHL SiteID, password, and account number are used to link a DHL account with third-party services,
73
- like Odoo's **Inventory ** app.
71
+ To integrate DHL with Odoo, developer credentials must be retrieved from DHL's Developer Portal.
72
+ These credentials are used to link the user's DHL account to Odoo's **Inventory ** app.
74
73
75
74
.. important ::
76
- The SiteID and password are different credentials than the ones used to log in to a DHL account.
75
+ The *SiteID * and *Password * are different credentials than the ones used to log in to a DHL
76
+ account.
77
77
78
- Here are two ways to obtain these DHL account credentials:
78
+ With DHL Express Account
79
+ ************************
79
80
80
- - **If a DHL Express account is available **: Log into the `DHL Developer portal
81
- <https://developer.dhl.com/api-reference/dhl-express-mydhl-api#get-started-section/
82
- user-guide%get-access> `_, and then `request a DHL API account number <https://developer.dhl.
83
- com/form/dhl-express-onboarding> `_.
84
- - **If a DHL Express account is unavailable **: Follow DHL's steps to `obtain a DHL Express account
85
- <https://developer.dhl.com/api-reference/dhl-express-mydhl-api#get-started-section/user-guide%get-
86
- access:~:text=around%20the%20world.-,User%20Guide,-Get%20Access> `_, and then follow the steps in
87
- the previous bullet.
81
+ If a DHL Express account is available, log into the `DHL Developer portal
82
+ <https://developer.dhl.com/api-reference/dhl-express-mydhl-api#get-started-section/
83
+ user-guide%get-access> `_ and `request a DHL API account number <https://developer.dhl.
84
+ com/form/dhl-express-onboarding> `_.
88
85
89
- Once the developer portal account has been confirmed, log in to the portal using the username and
90
- password. Click on the user avatar in the top-right corner of the screen to open the user dashboard .
86
+ Then, in Odoo, on the shipping method form, enter the * DHL API Key * in the :guilabel: ` DHL SiteID `
87
+ field, and the * API Secret * in the :guilabel: ` DHL Password ` field .
91
88
92
- On the dashboard, click on the :guilabel: `Apps ` tab, and select an app. In the
93
- :guilabel: `Credentials ` section, click the :guilabel: `Show key ` button below the :guilabel: `API Key `
94
- and :guilabel: `API Secret ` fields.
89
+ Without DHL Express Account
90
+ ***************************
95
91
96
- Return to the shipping method form in the Odoo database. Enter the *DHL API Key * in the
97
- :guilabel: `DHL SiteID ` field, and the *API Secret * in the :guilabel: `DHL Password ` field.
92
+ If a DHL Express account is **not ** available:
93
+
94
+ #. Begin by opening a `DHL Express account
95
+ <https://mydhl.express.dhl/gb/en/ship/open-account.html#/fs-step=connectors&fs-step=connectors> `_.
96
+ #. Once the developer portal account has been confirmed, log in to the portal using the username and
97
+ password. Click the user avatar in the top-right corner of the screen to open the user dashboard.
98
+ #. On the dashboard, open the :guilabel: `Apps ` tab, and create an app. Follow the four steps in the
99
+ app creation flow (app name, needed apps, app status, confirmation) to complete the setup.
100
+
101
+ .. image :: dhl_credentials/create-dhl-app.png
102
+ :alt: Setup to create DHL account.
103
+
104
+ #. After setting up the DHL Express account, go `here
105
+ <https://developer.dhl.com/user/login?destination=/form/dhl-express-onboarding> `_ to get the *DHL
106
+ API Key * and *API Secret * credentials.
107
+
108
+ Then, in Odoo, on the shipping method form, enter the *DHL API Key * in the :guilabel: `DHL SiteID `
109
+ field, and the *API Secret * in the :guilabel: `DHL Password ` field.
98
110
99
111
Shipping details
100
112
~~~~~~~~~~~~~~~~
@@ -128,9 +140,15 @@ Additional settings are available in the :guilabel:`Options` section at the bott
128
140
Turn on the DHL Connection
129
141
==========================
130
142
131
- Once the DHL connection is set up, use the buttons at the top of the form to turn on or debug the
132
- connection.
143
+ Once the DHL connection is set up, use the smart buttons at the top of the form to publish, turn on
144
+ production mode or activate debug logging.
145
+
146
+ - :guilabel: `Unpublished `/:guilabel: `Published `: determines if this shipping method is available
147
+ on the user's **eCommerce ** website.
133
148
134
- - **Unpublished/Published **: turns the connection on or off.
135
- - **Test Environment/Production Environment **: sets whether requests actually get sent to DHL.
136
- - **No Debug/Debug Requests **: determines whether error logging occurs for requests to DHL.
149
+ - :guilabel: `Test Environment `/:guilabel: `Production Environment `: determines whether label creation
150
+ is for testing and cancelled immediately (Test) or generate real shipping label that is charged
151
+ to DHL account (Production).
152
+ - :guilabel: `No Debug `/:guilabel: `Debug Requests `: determines whether API requests and responses are
153
+ logged in Odoo (turn on :ref: `developer mode <developer-mode >` and go to :menuselection: `Settings
154
+ app --> Technical --> Logging `).
0 commit comments