Metadata-Version: 2.4
Name: trytond_stock_package_shipping
Version: 8.0.1
Summary: Package shipping for Tryton
Project-URL: homepage, https://www.tryton.org/
Project-URL: documentation, https://docs.tryton.org/modules-stock-package-shipping/
Project-URL: changelog, https://docs.tryton.org/modules-stock-package-shipping/releases.html
Project-URL: forum, https://www.tryton.org/forum
Project-URL: issues, https://bugs.tryton.org/tryton
Project-URL: repository, https://code.tryton.org/tryton
Project-URL: funding, https://www.tryton.org/donate
Author: B2CK SRL
Author-email: Nicolas Évrard <nicolas.evrard@b2ck.com>
Maintainer-email: Tryton <foundation@tryton.org>
License-Expression: GPL-3.0-or-later
License-File: COPYRIGHT
License-File: LICENSE
Keywords: stock,tryton
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Plugins
Classifier: Framework :: Tryton
Classifier: Topic :: Office/Business
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10
Requires-Dist: python-sql>=0.4
Requires-Dist: trytond-carrier<8.1,>=8.0
Requires-Dist: trytond-product-measurements<8.1,>=8.0
Requires-Dist: trytond-product<8.1,>=8.0
Requires-Dist: trytond-stock-package<8.1,>=8.0
Requires-Dist: trytond-stock-shipment-cost<8.1,>=8.0
Requires-Dist: trytond-stock-shipment-measurements<8.1,>=8.0
Requires-Dist: trytond-stock<8.1,>=8.0
Requires-Dist: trytond<8.1,>=8.0
Provides-Extra: test
Requires-Dist: proteus<8.1,>=8.0; extra == 'test'
Requires-Dist: trytond-customs<8.1,>=8.0; extra == 'test'
Description-Content-Type: text/x-rst

Stock Package Shipping Module
#############################

This module is the base module required to interact with shipping service
providers.

Carrier
*******

The Carrier model adds the following field:

- *Shipping Service*: The shipping service of the carrier.

This field is programmatically filled by the modules providing support for
shipping companies.

Package Type
************

The Package Type model has been added the following fields:

- *Length*: The length of the packages of this type
- *Length Unit*: The unit of measure of this length
- *Length Digits*: The precision of length
- *Height*: The height of the packages of this type
- *Height Unit*: The unit of measure of this height
- *Height Digits*: The precision of height
- *Width*: The width of the packages of this type
- *Width Unit*: The unit of measure of this width
- *Width Digits*: The precision of width

Package
*******

The Package model has been added the following fields:

- *Shipping Reference*: The shipping reference provided by the shipping service
- *Shipping Label*: The shipping label provided by the shipping service
- *Weight*: A function field computing the weight of the package with its
  content

Shipment Out
************

The Shipment Out model will check once in the Packed state if the shipment is a
valid shipment for the shipping service. He does that by calling a method that
is by convention named ``validate_packing_<shipping service>``.

Once a shipment is packed, the user can create the shipping for each packages
with the shipping service by clicking on the *Create Shipping* button. This
button triggers a wizard that is overridden in shipping service specific
modules. The starting state of the wizard is a ``StateTransition``. Its linked
method is overridden in shipping service modules in order to communicate with
the service.

