odoo-forge-bundle 0.1.0

package/payload/skills/odoo18-docs/references/docs/applications/inventory_and_mrp/inventory/shipping_receiving/setup_configuration/third_party_shipper.md

@@ -0,0 +1,339 @@
+---
+title: "Third-party shipping carriers"
+source_url: "https://docs.odoo.sbggai.top/applications/inventory_and_mrp/inventory/shipping_receiving/setup_configuration/third_party_shipper.html"
+---
+
+=============================
+# Third-party shipping carriers
+
+.. |SO| replace:: :abbr:`SO (Sales Order)`
+.. |DO| replace:: :abbr:`DO (Delivery Order)`
+
+.. _inventory/shipping/third_party:
+
+Users can link third-party shipping carriers to Odoo databases, in order to verify carriers'
+delivery to specific addresses, :doc:`automatically calculate shipping costs
+<../setup_configuration>`, and :doc:`generate shipping labels <labels>`.
+
+In Odoo, shipping carriers can be applied to a sales order (SO), invoice, or delivery order. For
+tips on resolving common issues when configuring shipping connectors, skip to the
+:ref:`Troubleshooting <inventory/shipping_receiving/third-party-troubles>` section.
+
+.. seealso::
+   - :doc:`dhl_credentials`
+   - :doc:`sendcloud_shipping`
+   - :doc:`ups_credentials`
+
+The following is a list of available shipping connectors in Odoo:
+
+.. list-table::
+   :header-rows: 1
+   :stub-columns: 1
+
+   * - Carrier
+     - Region availability
+   * - :doc:`DHL Express <dhl_credentials>`
+     - All
+   * - :doc:`Envia.com <envia_shipping>`
+     - All
+   * - :doc:`FedEx <fedex>`
+     - All
+   * - :doc:`UPS <ups_credentials>`
+     - All
+   * - US Postal Service
+     - United States of America
+   * - :doc:`Sendcloud <sendcloud_shipping>`
+     - Some European countries (see details below)
+   * - :doc:`Bpost <bpost>`
+     - Belgium
+   * - Easypost
+     - North America
+   * - Shiprocket
+     - India
+   * - :doc:`Starshipit <starshipit_shipping>`
+     - Australia and New Zealand
+
+> **important**:
+>    Other services from DHL are **not** supported.
+
+   Sendcloud currently supports shipping **from** Austria, Belgium, France, Germany, Italy, the
+   Netherlands, Spain, and the United Kingdom, and **to** any European country.
+
+# Configuration
+
+To ensure proper setup of a third-party shipping carrier with Odoo, follow these steps:
+
+#. :ref:`Install the shipping connector <inventory/shipping_receiving/shipping-connector>`.
+#. :ref:`Set up delivery method <inventory/shipping_receiving/configure-delivery-method>`.
+#. :ref:`Activate production environment <inventory/shipping_receiving/production-env>`.
+#. :ref:`Configure warehouse <inventory/shipping_receiving/configure-source-address>`.
+#. :ref:`Specify weight of products <inventory/shipping_receiving/configure-weight>`.
+
+.. _inventory/shipping_receiving/shipping-connector:
+
+## Install shipping connector
+
+To install shipping connectors, go to :menuselection:`Inventory app --> Configuration --> Settings`.
+
+Under the :guilabel:`Shipping Connectors` section, tick the third-party shipping carrier's checkbox
+to install it. Multiple third-party shipping connectors can be selected at once. Then, click
+:guilabel:`Save`.
+
+> **note**:
+>    :doc:`Delivery methods <../setup_configuration>` can also be integrated with operations in the
+   *Sales*, *eCommerce*, and *Website* apps. To install, refer to the :ref:`install apps and modules
+   <general/install>` documentation.
+
+.. image:: third_party_shipper/shipping-connectors.png
+   :align: center
+   :alt: Options of available shipping connectors in Odoo.
+
+.. _inventory/shipping_receiving/configure-delivery-method:
+
+## Delivery method
+
+To configure the API credentials, and activate the shipping carrier, begin by going to
+:menuselection:`Inventory app --> Configuration --> Shipping Methods`, and select the desired
+delivery method.
+
+> **note**:
+>    The list often includes **two** delivery methods from the same :guilabel:`Provider`: one for
+   international shipping and one for domestic shipping.
+
+   Additional delivery methods can be created for specific purposes, such as :doc:`packaging
+   <../../product_management/configure/packaging>`.
+
+.. seealso::
+   :doc:`Configure delivery methods <../setup_configuration>`
+
+> **note**:
+>    Ensure the delivery method is published when it should be available on the *Website* app. To
+   publish a delivery method on the website, click the desired delivery method, then click the
+   :guilabel:`Unpublished` smart button. Doing so changes that smart button to read:
+   :guilabel:`Published`.
+
+.. _inventory/shipping_receiving/shipping-methods-details:
+
+The :guilabel:`Shipping Method` page contains details about the provider, including:
+
+- :guilabel:`Shipping Method` (*Required field*): the name of the delivery method (e.g. `FedEx US`,
+  `FedEx EU`, etc.).
+- :guilabel:`Website`: configure shipping methods for an *eCommerce* page that is connected to a
+  specific website in the database. Select the applicable website from the drop-down menu, or leave
+  it blank to apply the method to all web pages.
+- :guilabel:`Provider` (*Required field*): choose the third-party delivery service, like FedEx. Upon
+  choosing a provider, the :guilabel:`Integration Level`, :guilabel:`Invoicing Policy` and
+  :guilabel:`Insurance Percentage` fields become available.
+- :guilabel:`Integration Level`: choose :guilabel:`Get Rate` to simply get an :ref:`estimated
+  shipment cost <inventory/shipping_receiving/third-party-so>` on an |SO| or invoice.
+
+  > **important**:
+>      Select :guilabel:`Get Rate and Create Shipment` to also :doc:`generate shipping labels
+     <labels>`.
+
+- :guilabel:`Company`: if the shipping method should apply to a specific company, select it from the
+  drop-down menu. Leave the field blank to apply the method to all companies.
+- :guilabel:`Delivery Product` (*Required field*): the delivery charge name that is added to the
+  |SO| or invoice.
+- :guilabel:`Invoicing Policy`: select and calculate an :guilabel:`Estimated cost` of shipping
+  directly from the shipping carrier. If the :guilabel:`Real cost` of shipping is wanted instead,
+  refer to :doc:`Invoice real shipping costs <invoicing>` document.
+- :guilabel:`Margin on Rate`: specify an additional percentage amount added to the base shipping
+  rate to cover extra costs, such as handling fees, packaging materials, exchange rates, etc.
+- :guilabel:`Free if order amount is above`: enables free shipping for orders surpassing a specified
+  amount entered in the corresponding :guilabel:`Amount` field.
+- :guilabel:`Insurance Percentage`: specify a percentage amount of the shipping costs reimbursed to
+  the senders if the package is lost or stolen in transit.
+
+.. figure:: third_party_shipper/fedex.png
+   :align: center
+   :alt: Screenshot of a FedEx shipping method.
+
+   **Shipping Method** configuration page for `FedEx US`.
+
+In the :guilabel:`Configuration` tab, fill out the API credential fields (e.g. API key, password,
+account number, etc.). Depending on the third-party shipping carrier chosen in the
+:guilabel:`Provider` field, the :guilabel:`Configuration` tab will contain different required
+fields. For more details about configuring specific carriers' credentials, refer to the following
+documents:
+
+.. seealso::
+   - :doc:`DHL credentials <dhl_credentials>`
+   - :doc:`Sendcloud credentials <sendcloud_shipping>`
+   - :doc:`UPS credentials <ups_credentials>`
+
+.. _inventory/shipping_receiving/production-env:
+
+## Production environment
+
+With the delivery method details configured, click the :guilabel:`Test Environment` smart button to
+set it to :guilabel:`Production Environment`.
+
+> **warning**:
+>    Setting the delivery method to :guilabel:`Production` creates **real** shipping labels, and users
+   are at risk of being charged through their carrier account (e.g. UPS, FedEx, etc.) **before**
+   users charge customers for shipping. Verify all configurations are correct before launching the
+   delivery method to :guilabel:`Production`.
+
+.. image:: third_party_shipper/production.png
+   :align: center
+   :alt: Show the "Test Environment" smart button.
+
+.. _inventory/shipping_receiving/configure-source-address:
+
+## Warehouse configuration
+
+Ensure the warehouse's :guilabel:`Address` (including ZIP code) and :guilabel:`Phone` number are
+entered accurately. To do that, go to :menuselection:`Inventory app --> Configuration -->
+Warehouses`, and select the desired warehouse.
+
+On the warehouse configuration page, open the warehouse contact page by clicking the
+:guilabel:`Company` field.
+
+.. image:: third_party_shipper/internal-link.png
+   :align: center
+   :alt: Highlight the "Company" field.
+
+Verify that the :guilabel:`Address` and :guilabel:`Phone` number are correct, as they are required
+for the shipping connector to work properly.
+
+.. image:: third_party_shipper/company.png
+   :align: center
+   :alt: Show company address and phone number.
+
+.. _inventory/shipping_receiving/configure-weight:
+
+## Product weight
+
+For the carrier integration to work properly, specify the weight of products by going to
+:menuselection:`Inventory app --> Products --> Products`, and selecting the desired product.
+
+Then, switch to the :guilabel:`Inventory` tab, and define the :guilabel:`Weight` of the product in
+the :guilabel:`Logistics` section.
+
+.. image:: third_party_shipper/product-weight.png
+   :align: center
+   :alt: Display the "Weight" field in the Inventory tab of the product form.
+
+.. _inventory/shipping_receiving/apply-third-party-carrier:
+
+# Apply third-party shipping carrier
+
+Shipping carriers can be applied on a :abbr:`SO (Sales Order)`, invoice, or delivery order.
+
+After configuring the third-party carrier's :ref:`delivery method
+<inventory/shipping_receiving/configure-delivery-method>` in Odoo, create or navigate to a quotation
+by going to :menuselection:`Sales app --> Orders --> Quotations`.
+
+.. _inventory/shipping_receiving/third-party-so:
+
+## Sales order
+
+To assign a third-party shipping carrier, and get an estimated cost of shipping, begin by going to
+:menuselection:`Sales app --> Orders --> Quotations`. Create or select an existing quotation, and
+add the cost of shipping through a third-party carrier to a quotation, by clicking the
+:guilabel:`Add Shipping` button in the bottom-right corner of the :guilabel:`Order Lines` tab.
+
+.. image:: third_party_shipper/add-shipping.png
+   :align: center
+   :alt: Show the "Add shipping" button at the bottom of a quotation.
+
+In the resulting :guilabel:`Add a shipping method` pop-up window, select the intended carrier from
+the :guilabel:`Shipping Method` drop-down menu. The :guilabel:`Cost` field is automatically filled
+based on:
+
+- the amount specified in the :guilabel:`Total Order Weight` field (if it is not provided, the sum
+  of :ref:`product weights <inventory/shipping_receiving/configure-weight>` in the order is used)
+- the distance between the warehouse's :ref:`source address
+  <inventory/shipping_receiving/configure-source-address>` and the customer's address.
+
+.. _inventory/shipping_receiving/third-party-rate:
+
+After selecting a third-party provider in the :guilabel:`Shipping Method` field, click
+:guilabel:`Get Rate` in the :guilabel:`Add a shipping method` pop-up window to get the estimated
+cost through the shipping connector. Then, click the :guilabel:`Add` button to add the delivery
+charge to the |SO| or invoice.
+
+.. seealso::
+   :doc:`Charge customers for shipping after product delivery <invoicing>`
+
+.. _inventory/shipping_receiving/third-party-do:
+
+## Delivery order
+
+For users making shipments without installing the *Sales* app, assign the shipping carrier to the
+delivery order, by first going to the :menuselection:`Inventory` app. Then, from the
+:guilabel:`Inventory Overview` dashboard, select the :guilabel:`Delivery Orders` operation type, and
+choose the desired delivery order that is not already marked as :guilabel:`Done` or
+:guilabel:`Cancelled`.
+
+In the :guilabel:`Additional info` tab, set the :guilabel:`Carrier` field to the desired third-party
+shipping carrier. When the delivery method is set to :ref:`production mode
+<inventory/shipping_receiving/configure-delivery-method>`, a :guilabel:`Tracking Reference` is
+provided.
+
+.. seealso::
+   :doc:`Generate shipping labels <labels>`
+
+.. image:: third_party_shipper/delivery-info.png
+   :align: center
+   :alt: Show the delivery order's "Additional info" tab.
+
+.. _inventory/shipping_receiving/third-party-troubles:
+
+# Troubleshooting
+
+Since shipping connectors can sometimes be complex to set up, here are some checks to try when
+things are not working as expected:
+
+#. Ensure the :ref:`warehouse information <inventory/shipping_receiving/configure-source-address>`
+   (e.g., address and phone number) in Odoo is correct **and** matches the records saved in the
+   shipping provider's website.
+#. Verify that the :ref:`package type <inventory/warehouses_storage/package-type>` and parameters
+   are valid for the shipping carrier. To check, ensure the shipment can be directly created on the
+   shipping carrier's website.
+#. When encountering a price mismatch between Odoo's estimated cost and the provider's charge, first
+   ensure the delivery method is set to :ref:`production environment
+   <inventory/shipping_receiving/production-env>`.
+
+   Then, create the shipment in both the carrier's website and Odoo, and verify the prices are the
+   same across Odoo, the shipping provider, and in the *debug logs*.
+
+   .. example::
+      When checking for a price mismatch in the debug logs, if the request says the package weighs
+      six kilograms, but the response from FedEx says the package weights seven kilograms, it
+      concludes that the issue is on FedEx's side.
+
+## Debug log
+
+Track shipping data inconsistencies by activating debug logging. To do that, go to the delivery
+method's configuration page (:menuselection:`Inventory app --> Configuration --> Shipping
+Method`), and select the desired shipping method. Click the :guilabel:`No Debugging` smart button to
+activate :guilabel:`Debug Requests`.
+
+.. image:: third_party_shipper/no-debug.png
+   :align: center
+   :alt: Show the "No Debug" smart button.
+
+With :guilabel:`Debug Requests` activated, each time the shipping connector is used to estimate the
+cost of shipping, records are saved in the :guilabel:`Logging` report. To access the report, turn on
+:ref:`developer mode <developer-mode>`, and go to :menuselection:`Settings app --> Technical -->
+Database Structure section --> Logging`.
+
+> **note**:
+>    Logs are created for a shipping method each time the :ref:`Get Rate
+   <inventory/shipping_receiving/third-party-rate>` button is clicked on :abbr:`SOs (Sales Orders)`
+   and invoices, **and** when a customer adds the shipping carrier to their order through the
+   *Website* app.
+
+.. image:: third_party_shipper/log.png
+   :align: center
+   :alt: Show how to find the "Logging" option from the "Technical" menu.
+
+Click the *HTTP request* line item to open a detailed page, and verify the correct information is
+sent from Odoo to the shipping carrier. In the *HTTP response*, verify that the same information is
+received.
+
+.. image:: third_party_shipper/logging.png
+   :align: center
+   :alt: Show debug request history in Settings > Technical > Logging.

package/payload/skills/odoo18-docs/references/docs/applications/inventory_and_mrp/inventory/shipping_receiving/setup_configuration/ups_credentials.md

@@ -0,0 +1,205 @@
+---
+title: "UPS integration"
+source_url: "https://docs.odoo.sbggai.top/applications/inventory_and_mrp/inventory/shipping_receiving/setup_configuration/ups_credentials.html"
+---
+
+===============
+# UPS integration
+
+UPS is a shipping carrier service that integrates with Odoo to coordinate shipping to all regions.
+Once integrated, users can create shipping methods that estimate shipping costs and :doc:`generate
+labels <labels>`.
+
+.. seealso::
+   :doc:`third_party_shipper`
+
+To set up the UPS shipping connector in Odoo, complete these steps:
+
+#. Create a UPS account to get :ref:`account number
+   <inventory/shipping_receiving/ups-account-number>`
+#. Create UPS developer account to get :ref:`client credentials
+   <inventory/shipping_receiving/ups-client-id>`
+#. Set up shipping method in Odoo
+
+> **warning**:
+>    When configuring a shipping method to use UPS, make sure the :guilabel:`Provider` is set to
+   :guilabel:`UPS`, **NOT** :guilabel:`UPS Legacy`.
+
+   If shipping methods currently exist with the :guilabel:`Provider` set to :guilabel:`UPS Legacy`,
+   archive them, and create new shipping methods using :guilabel:`UPS`, instead.
+
+# UPS account setup
+
+To get started, go to the [UPS website ](https://www.ups.com) and click the :guilabel:`Log In`
+button in the top-right corner to log in or create a UPS account.
+
+After logging in, click the profile icon in the top-right corner, and select :guilabel:`Accounts and
+Payment` from the drop-down menu.
+
+.. image:: ups_credentials/accounts-payment.png
+   :align: center
+   :alt: Show how to navigate to the "Accounts and Payment" page from the home screen.
+
+On the :guilabel:`Accounts and Payment Options` page, two accounts must be configured: an Odoo
+shipment account and a payment card.
+
+## Shipping account
+
+To add an Odoo shipment account, select :guilabel:`Add New Account` from the :guilabel:`Add a
+Payment Method` drop-down menu, and click :guilabel:`Add`.
+
+.. image:: ups_credentials/new-account.png
+   :align: center
+   :alt: Display "Add an account" option from the drop-down menu.
+
+On the next screen, labeled :guilabel:`Open a Shipping Account`, complete the forms to configure the
+shipping account type (e.g. :guilabel:`Business`) and if any regulated items will be shipped. Then
+finish the remaining three steps in the wizard to :guilabel:`Add Addresses`, :guilabel:`Verify
+Identity`, and :guilabel:`Explore Discounts`, with the last option being optional.
+
+When complete, submit the application on the last page of the wizard to finish setting up the
+shipping account.
+
+.. image:: ups_credentials/shipping-account.png
+   :align: center
+   :alt: Display UPS form to fill out company shipping information.
+
+.. _inventory/shipping_receiving/ups-account-number:
+
+## Get account number
+
+With the shipping account set up, the UPS :guilabel:`Account Number` becomes available. To access
+it, navigate to :menuselection:`Profile --> Accounts and Payment` and refer to the shipping
+account's :guilabel:`Number` field.
+
+.. image:: ups_credentials/account-number.png
+   :align: center
+   :alt: Show Account "Number" field for the shipping account.
+
+## Payment card
+
+Navigate back to the :guilabel:`Accounts and Payments` page and select the :guilabel:`Add Payment
+Card` option from the :guilabel:`Add a Payment Method` drop-down menu. Then, complete the form to
+add the credit card information.
+
+.. image:: ups_credentials/payment-card.png
+   :align: center
+   :alt: Show "Add Payment Card" option from the drop-down.
+
+# UPS developer account setup
+
+Next, log into the [UPS developer account ](http://developer.ups.com/) to generate the developer
+key. To begin, click the profile icon in the top-right corner, and choose the :guilabel:`Apps`
+option from the drop-down menu.
+
+.. image:: ups_credentials/apps.png
+   :align: center
+   :alt: Display the "Apps" drop-down option after clicking the profile picture icon.
+
+## Add app
+
+Then, click the :guilabel:`Add Apps` button to begin filling out the form. In the :guilabel:`I need
+API credentials because \*` field, select :guilabel:`I want to integrate UPS technology into my
+business`.
+
+Under the next label, :guilabel:`Choose an account to associate with these credentials. \*`, select
+:guilabel:`Add existing account` from the drop-down menu in the corresponding field, and then select
+the :ref:`account number <inventory/shipping_receiving/ups-account-number>` linked to the UPS
+account created in the previous step.
+
+.. image:: ups_credentials/developer-account-setup.png
+   :align: center
+   :alt: Show form to fill in the UPS account number.
+
+Click :guilabel:`Next`, and proceed to the :guilabel:`Add App` form, and fill out the fields:
+
+- :guilabel:`App Name`: Type the name to identify the app by.
+- :guilabel:`Callback URL`: Type the URL of the Odoo database, in the format:
+  `https://databaseName.odoo.com`. Do **not** include `www` in the URL.
+
+In the :guilabel:`Add Products` section on the right, search for and click the :guilabel:`+ (plus)`
+icon to add the following products to the app:
+
+- :guilabel:`Authorization (O Auth)`: Used to generate the authorization token to request
+  information from the UPS API.
+- :guilabel:`Address Validation`: Validates addresses at the street level in the United States and
+  Puerto Rico.
+- :guilabel:`Locator`: Enables search for UPS shipping locations based on type and available
+  services.
+- :guilabel:`Paperless Documents`: Enables the upload of document images to link to shipments.
+- :guilabel:`Shipping`: Enables UPS shipping services, such as preparing packages for shipment,
+  managing returns, and cancelling scheduled shipments.
+- :guilabel:`Rating`: Compare delivery services and shipping rates.
+
+Finally, click :guilabel:`Save` and accept UPS's terms and conditions.
+
+.. seealso::
+   [UPS API Catalog ](https://developer.ups.com/catalog?loc=en_US)
+
+.. image:: ups_credentials/add-app-development.png
+   :align: center
+   :alt: Show "Add Apps" form, where the app details are configured.
+
+.. _inventory/shipping_receiving/ups-client-id:
+
+## Client ID and Client Secret
+
+With the new app created, in the :menuselection:`Profile --> My Apps --> App` page, select the app
+from the :guilabel:`Credentials` section to view the UPS credentials.
+
+.. image:: ups_credentials/my-apps.png
+   :align: center
+   :alt: Show newly created app in the "My Apps" section.
+
+In the :guilabel:`Credentials` section, copy the :guilabel:`Client ID` and :guilabel:`Client Secret`
+key.
+
+.. image:: ups_credentials/credentials.png
+   :align: center
+   :alt: Display the "Client ID" and "Client Secret" key.
+
+# Setup in Odoo
+
+With the credentials obtained, configure the UPS shipping method in Odoo by going to
+:menuselection:`Inventory app --> Configuration --> Shipping Methods`.
+
+On the :guilabel:`Shipping Methods` page, click the :guilabel:`New` button.
+
+> **note**:
+>    For existing UPS shipping methods whose :guilabel:`Provider` is :guilabel:`UPS Legacy`, archive
+   it and create a new shipping method using :guilabel:`UPS`.
+
+In the :guilabel:`Provider` field, select :guilabel:`UPS`. Doing so reveals the :guilabel:`UPS
+Configuration` tab, where various fields must be entered. For details instructions on configuring
+the other fields on the shipping method, refer to the :doc:`Configure third-party carrier
+<third_party_shipper>` documentation.
+
+In the :guilabel:`UPS Configuration` tab, complete the following fields:
+
+- :guilabel:`UPS Account Number`: (*required*) Get the :ref:`account number
+  <inventory/shipping_receiving/ups-account-number>` from the UPS portal.
+- :guilabel:`UPS Client ID`: (*required*) Get the :ref:`Client ID
+  <inventory/shipping_receiving/ups-client-id>` from the UPS developer website.
+- :guilabel:`UPS Client Secret`: (*required*) Get the :ref:`Client Secret
+  <inventory/shipping_receiving/ups-client-id>` key from the UPS developer website.
+- :guilabel:`UPS Service Type`: Select from the drop-down menu the type of shipping service.
+- :guilabel:`UPS Package Type`: (*required*) Select from the drop-down menu the :doc:`package type
+  <../../product_management/configure/package>` that is supported for the shipping service.
+- :guilabel:`Package Weight Unit`: The unit of measure for the package weight.
+- :guilabel:`Package Size Unit`: The unit of measure for the package dimensions.
+- :guilabel:`Label Format`: Choose the label format shipping labels: :guilabel:`PDF`,
+  :guilabel:`ZPL`, :guilabel:`EPL`, or :guilabel:`SPL`.
+
+.. image:: ups_credentials/ups-configuration.png
+   :align: center
+   :alt: Show the "UPS Configuration" tab on the Shipping Methods form.
+
+In the :guilabel:`Options` section, the following features are available:
+
+- :guilabel:`Bill My Account`: Charge the user's UPS account for shipping in the *eCommerce* app.
+- :guilabel:`Collect on Delivery`: Collect payment from customers for shipping after the shipment is
+  delivered.
+- :guilabel:`Generate Return Label`: Print the return label for the order after the delivery order
+  is validated.
+- :guilabel:`Duties paid by`: Select whether duties or other fees are charged to the
+  :guilabel:`Sender` or :guilabel:`Recipient` of the order.