diff --git a/content/applications/inventory_and_mrp/inventory/shipping_receiving/setup_configuration.rst b/content/applications/inventory_and_mrp/inventory/shipping_receiving/setup_configuration.rst index e45ce6f9b..651a94967 100644 --- a/content/applications/inventory_and_mrp/inventory/shipping_receiving/setup_configuration.rst +++ b/content/applications/inventory_and_mrp/inventory/shipping_receiving/setup_configuration.rst @@ -12,6 +12,7 @@ Setup and configuration setup_configuration/labels setup_configuration/bpost setup_configuration/dhl_credentials + setup_configuration/fedex setup_configuration/sendcloud_shipping setup_configuration/starshipit_shipping setup_configuration/ups_credentials diff --git a/content/applications/inventory_and_mrp/inventory/shipping_receiving/setup_configuration/fedex.rst b/content/applications/inventory_and_mrp/inventory/shipping_receiving/setup_configuration/fedex.rst new file mode 100644 index 000000000..3b98d05ec --- /dev/null +++ b/content/applications/inventory_and_mrp/inventory/shipping_receiving/setup_configuration/fedex.rst @@ -0,0 +1,174 @@ +================= +FedEx integration +================= + +Integrating a FedEx account with Odoo's **Inventory** app makes it possible to :doc:`calculate +shipping rates `, and :doc:`generate shipping labels ` within Odoo. This is +accomplished by enabling the FedEx *shipping connector*, then configuring at least one *shipping +method*. + +.. note:: + This documentation contains configuration details specific to FedEx integration. See the + documentation on :doc:`third-party shippers ` for general shipper + integration instructions. + +Enable shipping connector +========================= + +To enable the shipping connector for FedEx, navigate to :menuselection:`Inventory app --> +Configuration --> Settings`. Scroll down to the :guilabel:`Shipping Connectors` section, and tick +the checkbox next to :guilabel:`FedEx Connector`. + +Finally, click :guilabel:`Save` to save the changes. After doing so, a :icon:`oi-arrow-right` +:guilabel:`FedEx Shipping Methods` button appears below :guilabel:`FedEx Connector`. + +.. image:: fedex/fsm-button.png + :align: center + :alt: The FedEx Shipping Methods button below the FedEx Connector. + +Configure shipping method +========================= + +Once the FedEx shipping connector is enabled, it is necessary to configure at least one shipping +method. After doing so, the shipping method can be included in sales orders (SOs), and used to +compute shipping costs, and print shipping labels. + +To enable a shipping method, navigate to :menuselection:`Inventory app --> Configuration --> +Settings`, and click the :guilabel:`FedEx Shipping Methods` button below the :guilabel:`FedEx +Connector` checkbox. Doing so opens a page that shows all existing FedEx shipping methods. + +.. note:: + To see all shipping methods for every shipper with a connector enabled, navigate to + :menuselection:`Inventory app --> Configuration --> Shipping Methods`. + +Select a shipping method to open its form. Alternatively, click :guilabel:`New` to open a blank +form, and configure a new shipping method. + +.. image:: fedex/fedex-form.png + :align: center + :alt: The form for a FedEx shipping method. + +.. important:: + Enabling the FedEx shipping connector automatically creates two default shipping methods: + :guilabel:`FedEx US` and :guilabel:`FedEx International`. Each of these methods are + pre-configured with test credentials, allowing them to be used for testing purposes. + + Before the shipping method can be used to create actual shipments, the test credentials must be + replaced with credentials from a valid FedEx account. + +General information +------------------- + +At the very top of a shipping method form are fields used to configure the way the method operates +in Odoo. In the :guilabel:`Provider` field, select :guilabel:`FedEx` from the drop-down menu, if it +is not already selected. + +The rest of the fields in this section are general to all shipping providers. For details on how to +fill them out, see the documentation on :doc:`third-party shippers `. + +Fedex Configuration tab +----------------------- + +The options in the :guilabel:`Fedex Configuration` tab of a FedEx shipping method form are used to +connect the method to a FedEx account, and configure the shipping details associated with the method +(drop-off type, package type, etc.). + +A FedEx business account is required to obtain the information needed to fill out the fields in this +tab. To create a new account, navigate to FedEx's `Open Account +`_ page, click on :guilabel:`Create Account`, and +follow the instructions. + +Developer Key and Meter Number fields +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +A *developer key* is used to integrate a FedEx account with an external service, like the Odoo +**Inventory** app. A *meter number* is a unique ID number used by FedEx to identify negotiated +shipping rates for each account. + +To get a developer key and meter number, begin by navigating to FedEx's `Developer Resource Center +`_. Then, click on the :guilabel:`FedEx Web +Services` drop-down menu. + +Click :guilabel:`Get Test Key` to start the process of getting a developer key and meter number +which can be used to configure a shipping method for testing purposes. + +Click :guilabel:`Get Production Key` to start the process of getting a developer key and meter +number, which can be used to configure a shipping method that generates real shipments with FedEx. + +After clicking either option, follow the instructions until the :guilabel:`Confirmation` screen is +reached. This screen displays the developer key and meter number. + +Once the developer key and meter number are determined, enter them in the :guilabel:`Developer Key` +and :guilabel:`Meter Number` fields on the :guilabel:`Fedex Configuration` tab of the shipping +method form. + +Password and Account Number fields +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +A *password* is used, along with a username, to log into a FedEx account. An *account number* is the +unique number assigned to each FedEx account. + +To find a FedEx account number, log in to a FedEx account at https://www.fedex.com. Click on the +account holder's name in the top-right corner of the screen, and select :menuselection:`My Profile` +from the drop-down menu. + +On the profile page, click :guilabel:`Account Management` on the left side of the screen. The +account number is displayed on this screen. + +Once the password and account number are determined, enter them in the :guilabel:`Password` and +:guilabel:`Account Number` fields on the :guilabel:`Fedex Configuration` tab of the shipping method +form. + +Shipping details +~~~~~~~~~~~~~~~~ + +The main section of the :guilabel:`Fedex Configuration` tab includes a number of additional fields +used provide information about the shipping method: + +- :guilabel:`Fedex Service Type`: The FedEx service used to ship a package. +- :guilabel:`Fedex Drop-Off Type`: The method for getting a package into FedEx's possession. +- :guilabel:`Fedex Package Type`: The type of package used for the shipping method. +- :guilabel:`Package Weight Unit`: The unit of measure used to weigh packages. +- :guilabel:`Package Length Unit`: The unit of measure used to determine the dimensions of packages. +- :guilabel:`Label Type`: The type of shipping label used for packages. +- :guilabel:`Label Format`: The file format used by Odoo to generate shipping labels. +- :guilabel:`Commercial Invoice Type`: The dimensions and type of the paper used to print invoices. + +.. important:: + The options that should be selected on the :guilabel:`Fedex Configuration` tab of a shipping + method depend on the negotiated shipping services of the associated FedEx account. To confirm the + available services for a FedEx account, visit the *Account Management* page after logging in to + the FedEx website, or speak with a customer service representative. + +Options section +~~~~~~~~~~~~~~~ + +The :guilabel:`Options` section of the :guilabel:`Fedex Configuration` tab provides a few additional +options to further configure the shipping method: + +- :guilabel:`Saturday Delivery`: Tick the checkbox to allow packages shipped with the delivery + method to be delivered on Saturdays. +- :guilabel:`Generate Return Label`: Tick the checkbox to automatically generate a return label upon + validation of a delivery order. +- :guilabel:`Duties paid by`: Use the drop-down menu to select whether duty charges should be paid + by the :guilabel:`Sender` or :guilabel:`Recipient`. + +Activate shipping method +======================== + +By default, shipping methods in Odoo are created within a *test environment*. This means they can +only be used for testing purposes, and are unable to generate actual shipping orders. + +To activate a shipping method in a *production environment*, click the :icon:`fa-stop` +:guilabel:`Test Environment` smart button at the top of the shipping method form. After doing so, +the smart buttons changes to read :icon:`fa-play` :guilabel:`Production Environment`. + +With the production environment enabled, validating a delivery order using the shipping method +generates an actual shipping label with FedEx. + +Click the :icon:`fa-play` :guilabel:`Production Environment` smart button to return the shipping +method to a test environment. + +.. warning:: + **Do not** enable the production environment for a shipping method before it is ready to be used + for actual shipping orders. Doing so may lead to the creation of unwanted charges with FedEx. diff --git a/content/applications/inventory_and_mrp/inventory/shipping_receiving/setup_configuration/fedex/fedex-form.png b/content/applications/inventory_and_mrp/inventory/shipping_receiving/setup_configuration/fedex/fedex-form.png new file mode 100644 index 000000000..9b7139c94 Binary files /dev/null and b/content/applications/inventory_and_mrp/inventory/shipping_receiving/setup_configuration/fedex/fedex-form.png differ diff --git a/content/applications/inventory_and_mrp/inventory/shipping_receiving/setup_configuration/fedex/fsm-button.png b/content/applications/inventory_and_mrp/inventory/shipping_receiving/setup_configuration/fedex/fsm-button.png new file mode 100644 index 000000000..707be4ae1 Binary files /dev/null and b/content/applications/inventory_and_mrp/inventory/shipping_receiving/setup_configuration/fedex/fsm-button.png differ