Skip to content

Commit 7d34683

Browse files
committed
[IMP] inventory: dhl dev portal fixes
1 parent 9d96eb6 commit 7d34683

File tree

2 files changed

+45
-26
lines changed

2 files changed

+45
-26
lines changed

content/applications/inventory_and_mrp/inventory/shipping_receiving/setup_configuration/dhl_credentials.rst

Lines changed: 45 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -66,35 +66,48 @@ DHL Configuration
6666
The :guilabel:`DHL Configuration` tab on the shipping method form is used to connect the user's DHL
6767
account to Odoo, and configure the shipping method's details.
6868

69-
DHL SiteID, password, and account number
70-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
69+
DHL developer credentials
70+
~~~~~~~~~~~~~~~~~~~~~~~~~
7171

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.
72+
To integrate DHL with Odoo, developer credentials must be retrieved from DHL's Developer Portal.
73+
These credentials are used to link the user's DHL account to Odoo's **Inventory** app.
7474

7575
.. important::
76-
The SiteID and password are different credentials than the ones used to log in to a DHL account.
76+
The *SiteID* and *Password* are different credentials than the ones used to log in to a DHL
77+
account.
7778

78-
Here are two ways to obtain these DHL account credentials:
79+
With DHL Express Account
80+
************************
7981

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.
82+
If a DHL Express account is available, log into the `DHL Developer portal
83+
<https://developer.dhl.com/api-reference/dhl-express-mydhl-api#get-started-section/
84+
user-guide%get-access>`_ and `request a DHL API account number <https://developer.dhl.
85+
com/form/dhl-express-onboarding>`_.
8886

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.
87+
Then, in Odoo, on the shipping method form in the Odoo database. Enter the *DHL API Key* in the
88+
:guilabel:`DHL SiteID` field, and the *API Secret* in the :guilabel:`DHL Password` field.
9189

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.
90+
Without DHL Express Account
91+
***************************
9592

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.
93+
If a DHL Express account is **not** available:
94+
95+
#. Begin by opening a `DHL Express account
96+
<https://mydhl.express.dhl/gb/en/ship/open-account.html#/fs-step=connectors&fs-step=connectors>`_.
97+
#. Once the developer portal account has been confirmed, log in to the portal using the username and
98+
password. Click the user avatar in the top-right corner of the screen to open the user dashboard.
99+
#. On the dashboard, open the :guilabel:`Apps` tab, and create an app. Follow the four steps in the
100+
app creation flow (app name, needed apps, app status, confirmation) to complete the setup.
101+
102+
.. image:: dhl_credentials/create-dhl-app.png
103+
:alt: Setup to create DHL account.
104+
105+
#. After setting up the DHL Express account, go `here
106+
<https://developer.dhl.com/user/login?destination=/form/dhl-express-onboarding>`_ to get the *DHL
107+
API Key* and *API Secret* credentials.
108+
109+
Then, in Odoo, on the shipping method form, enter the *DHL API Key* in the :guilabel:`DHL SiteID`
110+
field, and the *API Secret* in the :guilabel:`DHL Password` field.
98111

99112
Shipping details
100113
~~~~~~~~~~~~~~~~
@@ -128,9 +141,15 @@ Additional settings are available in the :guilabel:`Options` section at the bott
128141
Turn on the DHL Connection
129142
==========================
130143

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.
144+
Once the DHL connection is set up, use the smart buttons at the top of the form to publish, turn on
145+
production mode or activate debug logging.
146+
147+
- :guilabel:`Unpublished`/:guilabel:`Published`: determines if this shipping method is available
148+
on the user's **eCommerce** website.
133149

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.
150+
- :guilabel:`Test Environment`/:guilabel:`Production Environment`: determines whether label creation
151+
is for testing and cancelled immediately (Test) or generate real shipping label that is charged
152+
to DHL account (Production).
153+
- :guilabel:`No Debug`/:guilabel:`Debug Requests`: determines whether API requests and responses are
154+
logged in Odoo (turn on :ref:`developer mode <developer-mode>` and go to :menuselection:`Settings
155+
app --> Technical --> Logging`).

0 commit comments

Comments
 (0)