Line 17:
Line 17:
userdoc=This page|}}
userdoc=This page|}}
−
= Introduction =
+
=Introduction=
This module manages the product catalog.
This module manages the product catalog.
See also [[Module Services En|Modules Services]] to manage a catalog of services, or page [[Module Stocks En|Module Stocks]] to manage warehouses and stock.
See also [[Module Services En|Modules Services]] to manage a catalog of services, or page [[Module Stocks En|Module Stocks]] to manage warehouses and stock.
−
= Installation =
+
=Installation=
{{NoInstallModuleEn}}
{{NoInstallModuleEn}}
−
= Configuration =
+
=Configuration=
{{ActivationModuleEn}}
{{ActivationModuleEn}}
−
= Definition =
+
=Definition=
−
== Products ==
+
==Products==
A ''product'' is an object you sell to customers or it is an object you buy from suppliers. It is a physical object as opposed to [[ServicesEn|Services]].
A ''product'' is an object you sell to customers or it is an object you buy from suppliers. It is a physical object as opposed to [[ServicesEn|Services]].
A product follows this rules:
A product follows this rules:
−
* A product can be stocked into a warehouse (only products appears in module [[Module_StockEn|Stock]]. Services are not visible).
+
−
* A product can be delivered (only products appears in module [[Module Shipment|Shipment]]. Services are not visible. Services are realized but cannot be shipped).
+
*A product can be stocked into a warehouse (only products appears in module [[Module_StockEn|Stock]]. Services are not visible).
−
* A product is a material good. It's value often decreases with time (the value of a used product is less than a new product).
+
*A product can be delivered (only products appears in module [[Module Shipment|Shipment]]. Services are not visible. Services are realized but cannot be shipped).
+
*A product is a material good. It's value often decreases with time (the value of a used product is less than a new product).
Some fields are dedicated to products and not available for Services like:
Some fields are dedicated to products and not available for Services like:
−
* Weight
−
* Size
−
* Customs code = Commodity code = License code = HTS (An international 6 character code to define the category of product)
−
== Virtual products (kits, also called Pack products) ==
+
*Weight
−
A product or service may be a virtual (parent) product comprising other (real) products. This function is activated from the Products module or the Service configuration page. It allows "packages" or "kits" of products that for use in orders, invoices and inventory as a single element instead of the n products as Lot.
+
*Size
+
*Customs code = Commodity code = License code = HTS (An international 6 character code to define the category of product)
+
+
==Kits products (also called Pack Products or Virtual Products)==
+
A product or service may be registered as a Kit (a "parent") product, that is, containing other (single) products. This function is activated from the ''Products'' or the ''Service'' module settings page. It allows "packages" or "kits" of products to be dealt with as a single lot, within orders, invoices and inventory, instead of dealing individually with the components.
+
+
A Kit product complies with the following rules:
−
A virtual product complies with the following rules:
+
*When adding a product in a document (proposals, invoice, order), only the line of the virtual product (the "parent") is shown.
−
* When adding a product in a document (proposals, invoice, order), only the line of the virtual parent product is shown.
+
*The stock of each individual component inside the virtual product is incremented / decremented when the parent product is acquired / delivered.
−
* The stock of the individual components of the virtual product is incremented / decremented when the virtual product is incremented / decremented.
+
*A virtual product may itself be composed of other virtual products that contain other (single) products.
−
* A virtual product may itself be composed of other virtual products that contain the physical products.
Note:
Note:
−
It is not a function of "manufacturing / production" where the virtual product component products are consumed son of stock father for an additional product in stock.
−
Here, the sub-components produced a virtual product are decremented stock at the time of consumption of the virtual product and remain independent manner consumables byproducts other, unlike a manufacturing module, wherein when that a by-product is used to manufacture a father module, the products under the same stock is decremented if the father product is not yet distributed, and often this byproducts can no longer do the reverse way back in stock.
−
== Multiprices ==
+
This is meant as a distinct function from "manufacturing / production" where another "container" product uses the existing stock of its sub-components to produce an additional product which will then be kept in stock as such.
−
There are 3 types of multiprices in Dolibarr.
+
Here in fact, in the "kit product or service" function, the sub-components of a virtual product will only be decrementing the respective stock at the time of delivery of the virtual product. Till then, these sub-products remain at full disposal, to be possibly integrated in other sales processes as single independent products also.
−
*price per customer
+
−
*price per quantity
+
Again, the ''manufacturing'' module acted differently : from the moment it registered a "container product", it immediately purveyed that its by-products were unusable for any other purpose. Therefore, their stock was immediately decremented whether or not the container product left the store, as it was to be considered that the sub-components could no longer be reverse engineered as single products in stock.
−
*price per segment
−
===Price per segment===
+
==Rules to manage sales prices==
−
Dolibarr can accept several prices per customer segment. By default, there is 5 segments (so 5 groups of different customers), but you can change this number.
+
There are 4 ways to manage sales prices in Dolibarr.
−
Each customer can be into 1 and only 1 segment and will use the price defined for its segment (or segment 1 if the segment of customer is not defined).
−
As of v12 the REST API support getting but not setting multiprices per segment for a product. Price for a product and customer segment can be set from backoffice only.
+
*One and only one price per product
+
*Different prices per segment of customers (see next chapter)
+
*Different prices per customer
+
*Different prices per quantity (experimental)
−
== Categories ==
+
You must choose one and only one into the Setup of the module "Products".
−
Products can be added to one or multiple categories.
+
+
===Price per segment of customers===
+
Dolibarr can accept several prices per customer segment. By default, there are 5 segments (i.e. 5 groups of different customers), but you can also edit this figure.
+
Each customer can be associated with 1 and only 1 segment, and therefore he or she will be assigned the price defined for that segment (segment 1 if the customer segment is not yet defined).
+
+
As of v12 the REST API supports getting, but not setting, multiprices per segment for a product. Prices for a product and customer segment can be set from the backoffice only.
+
+
==Categories==
+
Products can be added to one or to multiple categories.
To set categories of a product with API, you must use the APIs /categories/...
To set categories of a product with API, you must use the APIs /categories/...
−
== Image ==
+
==Image==
A product can have one or multiple images. This can be manually set from the tab "Linked files" of a product.
A product can have one or multiple images. This can be manually set from the tab "Linked files" of a product.
To get or set an image of a product using the APIs, you must use the API /documents (with "modulepart" parameter = "product" or "service").
To get or set an image of a product using the APIs, you must use the API /documents (with "modulepart" parameter = "product" or "service").
−
== Variants ==
+
==Variants==
A product can have multiple variants, e.g. for sizes or colors.
A product can have multiple variants, e.g. for sizes or colors.
As of v12 the REST API supports both getting, setting and deleting variants for a product.
As of v12 the REST API supports both getting, setting and deleting variants for a product.
−
= Life cycle / Business rules =
+
=Life cycle / Business rules=
{{ToComplete}}
{{ToComplete}}
−
= Examples of use cases =
+
=Related videos=
−
{{ToComplete}}
+
<youtube width="200" height="120">Qm0k1G4BYsE</youtube>
−
{{ExamplesCaseEn
+
−
|name=UCMP01:
+
−
|situation=
+
(vocal in french but subtitles are available and review in this language)
−
|actions=
+
−
}}
+
<youtube width="200" height="120">pm5i_1ij2zw</youtube>