@@ -3,7 +3,7 @@ FedEx integration
3
3
=================
4
4
5
5
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.
7
7
This is accomplished by enabling the FedEx *shipping connector *, then configuring at least one
8
8
*shipping method *.
9
9
@@ -12,101 +12,107 @@ This is accomplished by enabling the FedEx *shipping connector*, then configurin
12
12
documentation on :doc: `third-party shippers <third_party_shipper >` for general shipper
13
13
integration instructions.
14
14
15
- Enable shipping connector
15
+ Enable delivery connector
16
16
=========================
17
17
18
- To enable the shipping connector for FedEx, navigate to :menuselection: `Inventory app -->
18
+ To enable the delivery connector for FedEx, navigate to :menuselection: `Inventory app -->
19
19
Configuration --> Settings `. Scroll down to the :guilabel: `Shipping Connectors ` section, and tick
20
20
the checkbox next to :guilabel: `FedEx Connector `.
21
21
22
22
Finally, click :guilabel: `Save ` to save the changes. After doing so, a :icon: `oi-arrow-right `
23
23
:guilabel: `FedEx Shipping Methods ` button appears below :guilabel: `FedEx Connector `.
24
24
25
25
.. image :: fedex/fsm-button.png
26
- :align: center
27
26
:alt: The FedEx Shipping Methods button below the FedEx Connector.
28
27
29
- Configure shipping method
28
+ Configure delivery method
30
29
=========================
31
30
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 delivery 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.
35
34
36
- To enable a shipping method, navigate to :menuselection: `Inventory app --> Configuration -->
35
+ To enable a delivery method, navigate to :menuselection: `Inventory app --> Configuration -->
37
36
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.
39
38
40
39
.. 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 `.
43
42
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.
46
45
47
46
.. 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.
50
48
51
49
.. important ::
52
50
Enabling the FedEx shipping connector automatically creates two default shipping methods:
53
51
:guilabel: `FedEx US ` and :guilabel: `FedEx International `. Each of these methods are
54
52
pre-configured with test credentials, allowing them to be used for testing purposes.
55
53
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
57
55
replaced with credentials from a valid FedEx account.
58
56
59
57
General information
60
58
-------------------
61
59
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
63
61
in Odoo. In the :guilabel: `Provider ` field, select :guilabel: `FedEx ` from the drop-down menu, if it
64
62
is not already selected.
65
63
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
67
65
fill them out, see the documentation on :doc: `third-party shippers <third_party_shipper >`.
68
66
69
67
Fedex Configuration tab
70
68
-----------------------
71
69
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
74
72
(drop-off type, package type, etc.).
75
73
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
78
76
<https://www.fedex.com/en-us/open-account.html> `_ page, click on :guilabel: `Create Account `, and
79
77
follow the instructions.
80
78
81
- Developer Key and Meter Number fields
82
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
79
+ Create API Project
80
+ ~~~~~~~~~~~~~~~~~~
83
81
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 `.
87
84
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.
91
87
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 .
94
90
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:
97
92
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 `
100
98
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.
104
101
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.
107
104
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
+ Account Number fields
113
+ ~~~~~~~~~~~~~~~~~~~~~
114
+
115
+ An *account number * is the unique number assigned to each FedEx account.
110
116
111
117
To find a FedEx account number, log in to a FedEx account at https://www.fedex.com. Click on the
112
118
account holder's name in the top-right corner of the screen, and select :menuselection: `My Profile `
@@ -116,35 +122,35 @@ On the profile page, click :guilabel:`Account Management` on the left side of th
116
122
account number is displayed on this screen.
117
123
118
124
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
125
+ :guilabel: `Account Number ` fields on the :guilabel: `Fedex Configuration ` tab of the delivery method
120
126
form.
121
127
122
- Shipping details
128
+ Delivery details
123
129
~~~~~~~~~~~~~~~~
124
130
125
131
The main section of the :guilabel: `Fedex Configuration ` tab includes a number of additional fields
126
- used provide information about the shipping method:
132
+ used provide information about the delivery method:
127
133
128
134
- :guilabel: `Fedex Service Type `: The FedEx service used to ship a package.
129
135
- :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.
136
+ - :guilabel: `Fedex Package Type `: The type of package used for the delivery method.
131
137
- :guilabel: `Package Weight Unit `: The unit of measure used to weigh packages.
132
138
- :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.
139
+ - :guilabel: `Label Type `: The type of delivery label used for packages.
140
+ - :guilabel: `Label Format `: The file format used by Odoo to generate delivery labels.
135
141
- :guilabel: `Commercial Invoice Type `: The dimensions and type of the paper used to print invoices.
136
142
137
143
.. 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
144
+ The options that should be selected on the :guilabel: `Fedex Configuration ` tab of a delivery
145
+ method depend on the negotiated delivery services of the associated FedEx account. To confirm the
140
146
available services for a FedEx account, visit the *Account Management * page after logging in to
141
147
the FedEx website, or speak with a customer service representative.
142
148
143
149
Options section
144
150
~~~~~~~~~~~~~~~
145
151
146
152
The :guilabel: `Options ` section of the :guilabel: `Fedex Configuration ` tab provides a few additional
147
- options to further configure the shipping method:
153
+ options to further configure the delivery method:
148
154
149
155
- :guilabel: `Saturday Delivery `: Tick the checkbox to allow packages shipped with the delivery
150
156
method to be delivered on Saturdays.
@@ -153,22 +159,22 @@ options to further configure the shipping method:
153
159
- :guilabel: `Duties paid by `: Use the drop-down menu to select whether duty charges should be paid
154
160
by the :guilabel: `Sender ` or :guilabel: `Recipient `.
155
161
156
- Activate shipping method
162
+ Activate delivery method
157
163
========================
158
164
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.
165
+ By default, delivery methods in Odoo are created within a *test environment *. This means they can
166
+ only be used for testing purposes, and are unable to generate actual delivery orders.
161
167
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,
168
+ To activate a delivery method in a *production environment *, click the :icon: `fa-stop `
169
+ :guilabel: `Test Environment ` smart button at the top of the delivery method form. After doing so,
164
170
the smart buttons changes to read :icon: `fa-play ` :guilabel: `Production Environment `.
165
171
166
- With the production environment enabled, validating a delivery order using the shipping method
167
- generates an actual shipping label with FedEx.
172
+ With the production environment enabled, validating a delivery order using the delivery method
173
+ generates an actual delivery label with FedEx.
168
174
169
- Click the :icon: `fa-play ` :guilabel: `Production Environment ` smart button to return the shipping
175
+ Click the :icon: `fa-play ` :guilabel: `Production Environment ` smart button to return the delivery
170
176
method to a test environment.
171
177
172
178
.. 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.
179
+ **Do not ** enable the production environment for a delivery method before it is ready to be used
180
+ for actual delivery orders. Doing so may lead to the creation of unwanted charges with FedEx.
0 commit comments