Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit b1d6b70

Browse files
jero-odooslinkousFelicious
committed
[IMP] Inventory: Fedex Configuration update
closes #14094 X-original-commit: 165a638 Signed-off-by: Jessica Rogers (jero) <[email protected]> Co-authored-by: Zaz Linkous <[email protected]> Co-authored-by: Felicia Kuan <[email protected]>
1 parent 3aaad99 commit b1d6b70

File tree

5 files changed

+77
-61
lines changed

5 files changed

+77
-61
lines changed

‎content/applications/inventory_and_mrp/inventory/shipping_receiving/setup_configuration/fedex.rst

Lines changed: 77 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ FedEx integration
33
=================
44

55
Integrating a FedEx account with Odoo's **Inventory** app makes it possible to :doc:`calculate
6-
shipping rates <../setup_configuration>`, and :doc:`generate shipping labels <labels>` within Odoo.
6+
delivery rates <../setup_configuration>`, and :doc:`generate delivery labels <labels>` within Odoo.
77
This is accomplished by enabling the FedEx *shipping connector*, then configuring at least one
88
*shipping method*.
99

@@ -23,90 +23,106 @@ Finally, click :guilabel:`Save` to save the changes. After doing so, a :icon:`oi
2323
:guilabel:`FedEx Shipping Methods` button appears below :guilabel:`FedEx Connector`.
2424

2525
.. image:: fedex/fsm-button.png
26-
:align: center
2726
:alt: The FedEx Shipping Methods button below the FedEx Connector.
2827

29-
Configure shipping method
28+
Configure delivery method
3029
=========================
3130

32-
Once the FedEx shipping connector is enabled, it is necessary to configure at least one shipping
33-
method. After doing so, the shipping method can be included in sales orders (SOs), and used to
34-
compute shipping costs, and print shipping labels.
31+
Once the FedEx shipping connector is enabled, it is necessary to configure at least one delivery
32+
method. After doing so, the delivery method can be included in sales orders (SOs), and used to
33+
compute delivery costs, and print delivery labels.
3534

36-
To enable a shipping method, navigate to :menuselection:`Inventory app --> Configuration -->
35+
To enable a delivery method, navigate to :menuselection:`Inventory app --> Configuration -->
3736
Settings`, and click the :guilabel:`FedEx Shipping Methods` button below the :guilabel:`FedEx
38-
Connector` checkbox. Doing so opens a page that shows all existing FedEx shipping methods.
37+
Connector` checkbox. Doing so opens a page that shows all existing FedEx delivery methods.
3938

4039
.. note::
41-
To see all shipping methods for every shipper with a connector enabled, navigate to
42-
:menuselection:`Inventory app --> Configuration --> Shipping Methods`.
40+
To see all delivery methods for every shipper with a connector enabled, navigate to
41+
:menuselection:`Inventory app --> Configuration --> Delivery Methods`.
4342

44-
Select a shipping method to open its form. Alternatively, click :guilabel:`New` to open a blank
45-
form, and configure a new shipping method.
43+
Select a delivery method to open its form. Alternatively, click :guilabel:`New` to open a blank
44+
form, and configure a new delivery method.
4645

4746
.. image:: fedex/fedex-form.png
48-
:align: center
49-
:alt: The form for a FedEx shipping method.
47+
:alt: The form for a FedEx delivery method.
5048

5149
.. important::
5250
Enabling the FedEx shipping connector automatically creates two default shipping methods:
5351
:guilabel:`FedEx US` and :guilabel:`FedEx International`. Each of these methods are
5452
pre-configured with test credentials, allowing them to be used for testing purposes.
5553

56-
Before the shipping method can be used to create actual shipments, the test credentials must be
54+
Before the delivery method can be used to create actual shipments, the test credentials must be
5755
replaced with credentials from a valid FedEx account.
5856

5957
General information
6058
-------------------
6159

62-
At the very top of a shipping method form are fields used to configure the way the method operates
60+
At the very top of a delivery method form are fields used to configure the way the method operates
6361
in Odoo. In the :guilabel:`Provider` field, select :guilabel:`FedEx` from the drop-down menu, if it
6462
is not already selected.
6563

66-
The rest of the fields in this section are general to all shipping providers. For details on how to
64+
The rest of the fields in this section are general to all delivery providers. For details on how to
6765
fill them out, see the documentation on :doc:`third-party shippers <third_party_shipper>`.
6866

6967
Fedex Configuration tab
7068
-----------------------
7169

72-
The options in the :guilabel:`Fedex Configuration` tab of a FedEx shipping method form are used to
73-
connect the method to a FedEx account, and configure the shipping details associated with the method
70+
The options in the :guilabel:`Fedex Configuration` tab of a FedEx delivery method form are used to
71+
connect the method to a FedEx account, and configure the delivery details associated with the method
7472
(drop-off type, package type, etc.).
7573

76-
A FedEx business account is required to obtain the information needed to fill out the fields in this
77-
tab. To create a new account, navigate to FedEx's `Open Account
74+
A FedEx developer account is required to obtain the information needed to fill out the fields in
75+
this tab. To create a new account, navigate to FedEx's `Open Account
7876
<https://www.fedex.com/en-us/open-account.html>`_ page, click on :guilabel:`Create Account`, and
7977
follow the instructions.
8078

81-
Developer Key and Meter Number fields
82-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
79+
Create API Project
80+
~~~~~~~~~~~~~~~~~~
8381

84-
A *developer key* is used to integrate a FedEx account with an external service, like the Odoo
85-
**Inventory** app. A *meter number* is a unique ID number used by FedEx to identify negotiated
86-
shipping rates for each account.
82+
After creating a `developer account <https://developer.fedex.com/api/en-us/home.html>`_, navigate to
83+
the :guilabel:`My Projects` tab, and click :guilabel:`CREATE API PROJECT`.
8784

88-
To get a developer key and meter number, begin by navigating to FedEx's `Developer Resource Center
89-
<https://www.fedex.com/en-us/developer/web-services.html>`_. Then, click on the :guilabel:`FedEx Web
90-
Services` drop-down menu.
85+
On the :guilabel:`Tell us about your API needs` popup, select `Ships with FedEX and needs to
86+
integrate FedEx APIs into their system` in the :guilabel:`I work for a company that:` drop-down.
9187

92-
Click :guilabel:`Get Test Key` to start the process of getting a developer key and meter number
93-
which can be used to configure a shipping method for testing purposes.
88+
.. image:: fedex/fed-ex-api-needs.png
89+
:alt: Pop-up on FedEx website to select API needs.
9490

95-
Click :guilabel:`Get Production Key` to start the process of getting a developer key and meter
96-
number, which can be used to configure a shipping method that generates real shipments with FedEx.
91+
Next, when prompted to `Select API(s) for your project`, make sure to enable the following APIs:
9792

98-
After clicking either option, follow the instructions until the :guilabel:`Confirmation` screen is
99-
reached. This screen displays the developer key and meter number.
93+
- :guilabel:`Ship, Rate & Other APIs`
94+
- :guilabel:`Address Validation API`
95+
- :guilabel:`Rates and Transit Times API`
96+
- :guilabel:`Ship API`
97+
- :guilabel:`Trade Documents Upload API`
10098

101-
Once the developer key and meter number are determined, enter them in the :guilabel:`Developer Key`
102-
and :guilabel:`Meter Number` fields on the :guilabel:`Fedex Configuration` tab of the shipping
103-
method form.
99+
.. image:: fedex/select-apis.png
100+
:alt: Page on FedEx website where users select the APIs needed for project.
104101

105-
Password and Account Number fields
106-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
102+
Enter a :guilabel:`Project name`, then select any countries where packages will be shipped to, or
103+
delivered from.
107104

108-
A *password* is used, along with a username, to log into a FedEx account. An *account number* is the
109-
unique number assigned to each FedEx account.
105+
.. image:: fedex/country-selector.png
106+
:alt: Page on FedEx website where users select the countries they ship to and from.
107+
108+
To move the project to production, click the :guilabel:`Production key` tab. From there, link a
109+
:guilabel:`Shipping Account`. Copy the `API Key`, `Secret Key`, and `Account` number, then paste
110+
them into the appropriate fields on the :guilabel:`Delivery Methods` form.
111+
112+
Certification process
113+
~~~~~~~~~~~~~~~~~~~~~
114+
115+
To enable the creation of FedEx shipping labels, the API must be certified. On the sidebar menu in
116+
the FedEx `developer portal <https://developer.fedex.com/api/en-us/home.html>`_, click
117+
:guilabel:`API Certification`, and follow the required instructions.
118+
119+
.. note::
120+
These certification often require reaching out to the FedEx support team via email.
121+
122+
Account Number fields
123+
~~~~~~~~~~~~~~~~~~~~~
124+
125+
An *account number* is the unique number assigned to each FedEx account.
110126

111127
To find a FedEx account number, log in to a FedEx account at https://www.fedex.com. Click on the
112128
account holder's name in the top-right corner of the screen, and select :menuselection:`My Profile`
@@ -116,35 +132,35 @@ On the profile page, click :guilabel:`Account Management` on the left side of th
116132
account number is displayed on this screen.
117133

118134
Once the password and account number are determined, enter them in the :guilabel:`Password` and
119-
:guilabel:`Account Number` fields on the :guilabel:`Fedex Configuration` tab of the shipping method
135+
:guilabel:`Account Number` fields on the :guilabel:`Fedex Configuration` tab of the delivery method
120136
form.
121137

122-
Shipping details
138+
Delivery details
123139
~~~~~~~~~~~~~~~~
124140

125141
The main section of the :guilabel:`Fedex Configuration` tab includes a number of additional fields
126-
used provide information about the shipping method:
142+
used provide information about the delivery method:
127143

128144
- :guilabel:`Fedex Service Type`: The FedEx service used to ship a package.
129145
- :guilabel:`Fedex Drop-Off Type`: The method for getting a package into FedEx's possession.
130-
- :guilabel:`Fedex Package Type`: The type of package used for the shipping method.
146+
- :guilabel:`Fedex Package Type`: The type of package used for the delivery method.
131147
- :guilabel:`Package Weight Unit`: The unit of measure used to weigh packages.
132148
- :guilabel:`Package Length Unit`: The unit of measure used to determine the dimensions of packages.
133-
- :guilabel:`Label Type`: The type of shipping label used for packages.
134-
- :guilabel:`Label Format`: The file format used by Odoo to generate shipping labels.
149+
- :guilabel:`Label Type`: The type of delivery label used for packages.
150+
- :guilabel:`Label Format`: The file format used by Odoo to generate delivery labels.
135151
- :guilabel:`Commercial Invoice Type`: The dimensions and type of the paper used to print invoices.
136152

137153
.. important::
138-
The options that should be selected on the :guilabel:`Fedex Configuration` tab of a shipping
139-
method depend on the negotiated shipping services of the associated FedEx account. To confirm the
154+
The options that should be selected on the :guilabel:`Fedex Configuration` tab of a delivery
155+
method depend on the negotiated delivery services of the associated FedEx account. To confirm the
140156
available services for a FedEx account, visit the *Account Management* page after logging in to
141157
the FedEx website, or speak with a customer service representative.
142158

143159
Options section
144160
~~~~~~~~~~~~~~~
145161

146162
The :guilabel:`Options` section of the :guilabel:`Fedex Configuration` tab provides a few additional
147-
options to further configure the shipping method:
163+
options to further configure the delivery method:
148164

149165
- :guilabel:`Saturday Delivery`: Tick the checkbox to allow packages shipped with the delivery
150166
method to be delivered on Saturdays.
@@ -153,22 +169,22 @@ options to further configure the shipping method:
153169
- :guilabel:`Duties paid by`: Use the drop-down menu to select whether duty charges should be paid
154170
by the :guilabel:`Sender` or :guilabel:`Recipient`.
155171

156-
Activate shipping method
172+
Activate delivery method
157173
========================
158174

159-
By default, shipping methods in Odoo are created within a *test environment*. This means they can
160-
only be used for testing purposes, and are unable to generate actual shipping orders.
175+
By default, delivery methods in Odoo are created within a *test environment*. This means they can
176+
only be used for testing purposes, and are unable to generate actual delivery orders.
161177

162-
To activate a shipping method in a *production environment*, click the :icon:`fa-stop`
163-
:guilabel:`Test Environment` smart button at the top of the shipping method form. After doing so,
178+
To activate a delivery method in a *production environment*, click the :icon:`fa-stop`
179+
:guilabel:`Test Environment` smart button at the top of the delivery method form. After doing so,
164180
the smart buttons changes to read :icon:`fa-play` :guilabel:`Production Environment`.
165181

166-
With the production environment enabled, validating a delivery order using the shipping method
167-
generates an actual shipping label with FedEx.
182+
With the production environment enabled, validating a delivery order using the delivery method
183+
generates an actual delivery label with FedEx.
168184

169-
Click the :icon:`fa-play` :guilabel:`Production Environment` smart button to return the shipping
185+
Click the :icon:`fa-play` :guilabel:`Production Environment` smart button to return the delivery
170186
method to a test environment.
171187

172188
.. warning::
173-
**Do not** enable the production environment for a shipping method before it is ready to be used
174-
for actual shipping orders. Doing so may lead to the creation of unwanted charges with FedEx.
189+
**Do not** enable the production environment for a delivery method before it is ready to be used
190+
for actual delivery orders. Doing so may lead to the creation of unwanted charges with FedEx.

‎content/applications/inventory_and_mrp/inventory/shipping_receiving/setup_configuration/fedex/country-selector.png

31.6 KB
Loading

‎content/applications/inventory_and_mrp/inventory/shipping_receiving/setup_configuration/fedex/fed-ex-api-needs.png

26.4 KB
Loading

‎content/applications/inventory_and_mrp/inventory/shipping_receiving/setup_configuration/fedex/fedex-form.png

-1.54 KB
Loading

‎content/applications/inventory_and_mrp/inventory/shipping_receiving/setup_configuration/fedex/select-apis.png

36.5 KB
Loading

0 commit comments

Comments
 (0)