RST formatting fixes
Just some small RST tweaks, so the PR can pass the minimal checks and align with the marketing team's guidelines: - Wrapped lines to stay within the 100-character limit. - Removed the align tag from images (we no longer use it). - Cleaned up extra whitespace on empty lines.
This commit is contained in:
Felicious
parent
1fd4efac6e
commit
9ee5113939
@ -1,8 +1,9 @@
|
||||
=====================
|
||||
Envia.com Integration
|
||||
Envia.com integration
|
||||
=====================
|
||||
|
||||
Envia is a shipping service aggregator that facilitates the integration in several continents. Once integrated, users can select shipping carriers on inventory operations in their Odoo database.
|
||||
Envia is a shipping service aggregator that facilitates the integration in several continents. Once
|
||||
integrated, users can select shipping carriers on inventory operations in their Odoo database.
|
||||
|
||||
Setup in Envia
|
||||
==============
|
||||
@ -13,24 +14,25 @@ Create an account and activate carriers
|
||||
If you don’t have an account, we recommend heading to `Envia.com <https://www.envia.com>`_.
|
||||
|
||||
.. image:: envia_shipping/Envia_Registry_Process.png
|
||||
:align: center
|
||||
:alt: Registry process in website with Envia.com.
|
||||
|
||||
|
||||
.. tip::
|
||||
Make sure to select the appropriate country for your main billing. If you have multicountry operations, you can also create two separate accounts, but the billing will be done in the main currency.
|
||||
|
||||
Make sure to select the appropriate country for your main billing. If you have multicountry
|
||||
operations, you can also create two separate accounts, but the billing will be done in the main
|
||||
currency.
|
||||
|
||||
.. note::
|
||||
Envia will send an SMS or WhatsApp message to confirm your email address and phone number.
|
||||
|
||||
Generate Envia.com credentials
|
||||
------------------------------
|
||||
|
||||
Go to Envia.com, navigate to :menuselection:`Developers --> API Keys`, on the left menu, then click :guilabel:`add` to generate a new key.
|
||||
Go to Envia.com, navigate to :menuselection:`Developers --> API Keys`, on the left menu, then click
|
||||
:guilabel:`add` to generate a new key.
|
||||
|
||||
This API key is the one we will request in Odoo, you can always come back for it.
|
||||
|
||||
.. image:: envia_shipping/envia_token.png
|
||||
:align: center
|
||||
:alt: API Keys in Envia.com.
|
||||
|
||||
Setup in Odoo
|
||||
@ -65,33 +67,40 @@ Fill out the following fields in the New Delivery Method form:
|
||||
- In the :guilabel:`Envia Configuration` tab, enter the :guilabel:`Envia Sandbox Access Token`.
|
||||
- Manually :guilabel:`Save` the form by clicking the cloud icon next to the :guilabel:`Shipping
|
||||
Methods / New` breadcrumbs.
|
||||
- :guilabel:`Insurance percentage`: If insurance is needed, place a percentage of the value to insure, if not, it can be left as 0. Keep in mind that the insurance price is calculated only after the
|
||||
label has been generated. This also applies to LTL shipments.
|
||||
|
||||
- :guilabel:`Insurance percentage`: If insurance is needed, place a percentage of the value to
|
||||
insure, if not, it can be left as 0. Keep in mind that the insurance price is calculated only
|
||||
after the label has been generated. This also applies to LTL shipments.
|
||||
|
||||
.. tip::
|
||||
It is mandatory to fill both the production and sandbox tokens, but it could be left with just a random character as it is not validated at this point.
|
||||
It is mandatory to fill both the production and sandbox tokens, but it could be left with just a
|
||||
random character as it is not validated at this point.
|
||||
|
||||
Additional considerations for the :guilabel:`Envia Default Package`:
|
||||
|
||||
- The package is specified in :guilabel:`mm` and :guilabel:`kg`. Keep in mind that the weight is for the container alone and not its contents,
|
||||
it can be left as 0 for no reported weight and 0 in max weight for no specified limit weight.
|
||||
- :guilabel:`Envia Package Type`: It is set to Box by default. Make sure to select the appropriate one since it will be used to display available carriers and options as they change depending on this field.
|
||||
|
||||
- The package is specified in :guilabel:`mm` and :guilabel:`kg`. Keep in mind that the weight is for
|
||||
the container alone and not its contents, it can be left as 0 for no reported weight and 0 in max
|
||||
weight for no specified limit weight.
|
||||
- :guilabel:`Envia Package Type`: It is set to Box by default. Make sure to select the appropriate
|
||||
one since it will be used to display available carriers and options as they change depending on
|
||||
this field.
|
||||
|
||||
|
||||
Once previous fields are properly set, sync the carriers. A pop-up window will appear, select a carrier and a service level from the list:
|
||||
Once previous fields are properly set, sync the carriers. A pop-up window will appear, select a
|
||||
carrier and a service level from the list:
|
||||
|
||||
.. image:: envia_shipping/envia_popup.png
|
||||
:align: center
|
||||
:alt: Envia.com carrier and services popup.
|
||||
|
||||
|
||||
.. important::
|
||||
Envia keeps the main currency of the account fixed. In order to provide more precise conversions for the costs of shipping, specify the currency that is set for your account on Envia.
|
||||
If necessary, Odoo offers the option to change your country. By default it uses the country associated with your company.
|
||||
Envia keeps the main currency of the account fixed. In order to provide more precise conversions
|
||||
for the costs of shipping, specify the currency that is set for your account on Envia. If
|
||||
necessary, Odoo offers the option to change your country. By default it uses the country
|
||||
associated with your company.
|
||||
|
||||
.. note::
|
||||
If more than one shipping option is needed, create more shipping methods in Odoo and modify any parameter like the package, carrier, or service.
|
||||
If more than one shipping option is needed, create more shipping methods in Odoo and modify any
|
||||
parameter like the package, carrier, or service.
|
||||
|
||||
.. _inventory/shipping_receiving/envia-shipping-info:
|
||||
|
||||
@ -101,19 +110,24 @@ Shipping information
|
||||
To use Envia.com to generate shipping labels, the following information **must** be filled out
|
||||
accurately and completely in Odoo:
|
||||
|
||||
#. **Customer information**: When creating a quotation, ensure the selected :guilabel:`Customer` has a valid phone number, email address, and shipping address.
|
||||
#. **Customer information**: When creating a quotation, ensure the selected :guilabel:`Customer` has
|
||||
a valid phone number, email address, and shipping address.
|
||||
|
||||
To verify, select the :guilabel:`Customer` field to open their contact page. Here, Add their shipping address in the :guilabel:`Contact` field, along with their :guilabel:`Mobile` number and
|
||||
To verify, select the :guilabel:`Customer` field to open their contact page. Here, Add their shipping address in the :guilabel:`Contact` field, along with their :guilabel:`Mobile` number and
|
||||
:guilabel:`Email` address.
|
||||
|
||||
#. **Product weight**: Ensure all products in a delivery order have a specified :guilabel:`Weight` in the :guilabel:`Inventory` tab of their product form. Refer to the :ref:`Product weight section <inventory/shipping_receiving/configure-weight>` of this article for detailed instructions.
|
||||
#. **Product weight**: Ensure all products in a delivery order have a specified :guilabel:`Weight`
|
||||
in the :guilabel:`Inventory` tab of their product form. Refer to the :ref:`Product weight section
|
||||
<inventory/shipping_receiving/configure-weight>` of this article for detailed instructions.
|
||||
|
||||
#. **Warehouse address**: By default all packages will be sent from the specified address in the warehouse, make sure to set the address for correct label generation.
|
||||
#. **Warehouse address**: By default all packages will be sent from the specified address in the
|
||||
warehouse, make sure to set the address for correct label generation.
|
||||
|
||||
Address filling guide
|
||||
---------------------
|
||||
|
||||
Each country has rules regarding how an address is filled. This is a comprehensive guide of each country's expected fields exceptions:
|
||||
Each country has rules regarding how an address is filled. This is a comprehensive guide of each
|
||||
country's expected fields exceptions:
|
||||
|
||||
.. list-table::
|
||||
:header-rows: 1
|
||||
@ -160,92 +174,104 @@ Each country has rules regarding how an address is filled. This is a comprehensi
|
||||
- Locality
|
||||
- State
|
||||
|
||||
|
||||
|
||||
Countries not listed here should be filled as normal.
|
||||
|
||||
.. note::
|
||||
For some countries, the zip code is not commonly requested. If empty, Odoo will use Envia's zip approximation services to get the zip code.
|
||||
For Colombia, the zip code is extracted from the city selected in city_id if the localization is installed, otherwise Odoo will use the zip field.
|
||||
For some countries, the zip code is not commonly requested. If empty, Odoo will use Envia's zip
|
||||
approximation services to get the zip code.
|
||||
|
||||
For Colombia, the zip code is extracted from the city selected in city_id if the localization is
|
||||
installed, otherwise Odoo will use the zip field.
|
||||
|
||||
.. note::
|
||||
Colombia and Mexico have a list of cities referred to as city_id in Odoo. If city_id is set, it will be used as the city field. If not set, then Odoo will try to use the city field.
|
||||
Colombia and Mexico have a list of cities referred to as city_id in Odoo. If city_id is set, it
|
||||
will be used as the city field. If not set, then Odoo will try to use the city field.
|
||||
|
||||
.. note::
|
||||
In Mexico, some carriers might require the :guilabel:`Colony` field, commonly known as neighborhood. It is not always mandatory, but if required the installation of the :guilabel:`EDI for Mexico (Advanced Features)` module will be needed.
|
||||
|
||||
In Mexico, some carriers might require the :guilabel:`Colony` field, commonly known as
|
||||
neighborhood. It is not always mandatory, but if required the installation of the :guilabel:`EDI
|
||||
for Mexico (Advanced Features)` module will be needed.
|
||||
|
||||
.. note::
|
||||
In Brazil the address is split to comply with regulation, so street_name is used for the street name only. street_number1 is used for the street number and street_number2 is used for the complement.
|
||||
This logic also applies if the :guilabel:`Extended Addresses` module is installed.
|
||||
In Brazil the address is split to comply with regulation, so street_name is used for the street
|
||||
name only. street_number1 is used for the street number and street_number2 is used for the
|
||||
complement. This logic also applies if the :guilabel:`Extended Addresses` module is installed.
|
||||
|
||||
|
||||
|
||||
Generate labels with Envia
|
||||
==========================
|
||||
|
||||
When creating a quotation in Odoo, add shipping and the :guilabel:`Envia.com shipping product`.
|
||||
Then, :guilabel:`Validate` the delivery. Shipping label documents are automatically generated in the chatter, which include the following:
|
||||
When creating a quotation in Odoo, add shipping and the :guilabel:`Envia.com shipping product`.
|
||||
Then, :guilabel:`Validate` the delivery. Shipping label documents are automatically generated in the
|
||||
chatter, which include the following:
|
||||
|
||||
#. :guilabel:`Shipping label(s)` depending on the number of packages.
|
||||
#. :guilabel:`Return label(s)` if the Envia.com connector is configured for returns.
|
||||
|
||||
.. important::
|
||||
When labels are created, Envia.com automatically charges the configured account and the final amount is logged in the chatter. If multi-currency operations occur, the amount logged will be
|
||||
When labels are created, Envia.com automatically charges the configured account and the final
|
||||
amount is logged in the chatter. If multi-currency operations occur, the amount logged will be
|
||||
calculated using Odoo's rate. Actual rates may vary.
|
||||
|
||||
Additionally, the tracking number is now available.
|
||||
|
||||
.. note::
|
||||
Brazilian Authorities might request the invoice related to the shipping (NFe). It is recommended to physically attach the invoice of the order along with the label.
|
||||
|
||||
Brazilian Authorities might request the invoice related to the shipping (NFe). It is recommended
|
||||
to physically attach the invoice of the order along with the label.
|
||||
|
||||
International shipping
|
||||
----------------------
|
||||
|
||||
For international shipments it is required to fill both the :guilabel:`HS code` and the country of :guilabel:`Origin of Goods`, both can be found on the product’s :guilabel:`Inventory tab`.
|
||||
For international shipments it is required to fill both the :guilabel:`HS code` and the country of
|
||||
:guilabel:`Origin of Goods`, both can be found on the product’s :guilabel:`Inventory tab`.
|
||||
|
||||
LTL Shipments
|
||||
-------------
|
||||
LTL shipment labels can be generated through the connector. The insurance for LTL shipments is covered under the insurance percentage value at the delivery method’s form.
|
||||
|
||||
.. important::
|
||||
For Mexico, since a Bill of Landing needs to be created for the shipment, Odoo is required to send the UNSPSC code of the contents, as well as a unit of measure for transportation which is
|
||||
LTL shipment labels can be generated through the connector. The insurance for LTL shipments is
|
||||
covered under the insurance percentage value at the delivery method’s form.
|
||||
|
||||
.. important::
|
||||
For Mexico, since a Bill of Landing needs to be created for the shipment, Odoo is required to
|
||||
send the UNSPSC code of the contents, as well as a unit of measure for transportation which is
|
||||
**X8A - Pallet de madera** as default.
|
||||
|
||||
.. note::
|
||||
Additional services are available when you select `pallet` as an option, which allows to select additional services like lift assistance and deliveries during weekends.
|
||||
Additional services are available when you select `pallet` as an option, which allows to select
|
||||
additional services like lift assistance and deliveries during weekends.
|
||||
|
||||
.. _inventory/shipping_receiving/setup_configuration/cancel:
|
||||
|
||||
Tracking and cancellation
|
||||
=========================
|
||||
Shipments registered with Envia can be tracked using the Tracking smart button from the delivery order or using the tracking link from the customer portal.
|
||||
|
||||
Shipments registered with Envia can be tracked using the Tracking smart button from the delivery
|
||||
order or using the tracking link from the customer portal.
|
||||
|
||||
.. image:: envia_shipping/envia_customer_portal_tracking.png
|
||||
:align: center
|
||||
:alt: Customer portal tracking.
|
||||
|
||||
Cancellations can be requested directly, see :ref:`Cancel section <inventory/shipping_receiving/setup_configuration/cancel>`
|
||||
|
||||
Cancellations can be requested directly, see :ref:`Cancel section
|
||||
<inventory/shipping_receiving/setup_configuration/cancel>`
|
||||
|
||||
FAQ
|
||||
===
|
||||
|
||||
Measuring volumetric weight
|
||||
---------------------------
|
||||
|
||||
Many carriers have several measurements for weight. There is the actual weight of the products in the parcel, and the volumetric weight.
|
||||
Volumetric weight is the volume that a package occupies when in transit, i.e. the physical size of a package.
|
||||
|
||||
.. note::
|
||||
Due to volumetric weight, it is possible that the actual weight in the label is higher than the calculated value.
|
||||
|
||||
Many carriers have several measurements for weight. There is the actual weight of the products in
|
||||
the parcel, and the volumetric weight. Volumetric weight is the volume that a package occupies when
|
||||
in transit, i.e. the physical size of a package.
|
||||
|
||||
.. note::
|
||||
Due to volumetric weight, it is possible that the actual weight in the label is higher than the
|
||||
calculated value.
|
||||
|
||||
Which printing options are available?
|
||||
-------------------------------------
|
||||
|
||||
On Envia.com in :menuselection:`Settings > Print options and Carriers printing options` for each of your carriers are displayed, make sure to use the appropriate format for the chosen carrier.
|
||||
|
||||
On Envia.com in :menuselection:`Settings --> Print options and Carriers printing options` for each
|
||||
of your carriers are displayed, make sure to use the appropriate format for the chosen carrier.
|
||||
|
||||
The needed service is not available
|
||||
-----------------------------------
|
||||
@ -256,9 +282,12 @@ For available carriers, make sure that they are enabled through Envia.
|
||||
Who will pay customs duties?
|
||||
----------------------------
|
||||
|
||||
It’s important to make sure that if there are exports to other countries, use Envia’s carrier settings to configure whether it is paid by the sender or the receiver.
|
||||
It’s important to make sure that if there are exports to other countries, use Envia’s carrier
|
||||
settings to configure whether it is paid by the sender or the receiver.
|
||||
|
||||
What is "Envia error"?
|
||||
----------------------
|
||||
|
||||
It’s a message that appears when there’s an error in Envia. This message mentions what went wrong in their platform so it can be addressed.
|
||||
It’s a message that appears when there’s an error in Envia. This message mentions what went wrong in
|
||||
their platform so it can be addressed.
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user