Difference between revisions of "Module Products"
m Tag: 2017 source edit |
m (Some editing for comprehension to match the French description of the virtual product module description.) |
||
| 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: | ||
| − | |||
| − | |||
| − | |||
| − | == Virtual products (kits, also called Pack products) == | + | *Weight |
| − | A product or service may be a virtual (parent) product | + | *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)== | ||
| + | A product or service may be registered as a virtual (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 virtual 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 parent | + | |
| − | * The stock of | + | *When adding a product in a document (proposals, invoice, order), only the line of the virtual product (the "parent") is shown. |
| − | * A virtual product may itself be composed of other virtual products that contain | + | *The stock of each individual component inside the virtual product is incremented / decremented when the parent product is acquired / delivered. |
| + | *A virtual product may itself be composed of other virtual products that contain other (single) products. | ||
Note: | Note: | ||
| − | + | 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 to be kept in stock. | |
| − | Here, the sub-components | + | Here in fact, in the "virtual product or service" function, the sub-components of a virtual product are only decrementing the stock at the time of delivery of the virtual product. Till then, these sub-products remain at disposal to be integrated in the sales process as single independent products also. Again, the ''manufacturing'' module on the contrary, from the moment it registered a "container product", immediately purveyed that its by-products were unusable for any other purpose. Therefore, their stock was 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. |
| − | == Rules to manage | + | ==Rules to manage sales prices== |
There are 4 ways to manage sale price of products in Dolibarr. | There are 4 ways to manage sale price of products in Dolibarr. | ||
| + | |||
*One and only one price per product | *One and only one price per product | ||
*Price per segment of customers | *Price per segment of customers | ||
| Line 62: | Line 66: | ||
===Price per segment of customers=== | ===Price per segment of customers=== | ||
| − | Dolibarr can accept several prices per customer segment. By default, there | + | Dolibarr can accept several prices per customer segment. By default, there are 5 segments (i.e. 5 groups of different customers), but you can change this number. |
| − | Each customer can be | + | 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 | + | 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 == | + | ==Categories== |
| − | Products can be added to one or multiple 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}} | ||
| − | = Related videos = | + | =Related videos= |
<youtube width="200" height="120">Qm0k1G4BYsE</youtube> | <youtube width="200" height="120">Qm0k1G4BYsE</youtube> | ||
Revision as of 22:06, 22 September 2020
| Products | |
|---|---|
| Numero/ID of module | 50 |
| User doc. of module | This page |
| Developer doc. of module | Module Products (developer) |
Introduction
This module manages the product catalog.
See also Modules Services to manage a catalog of services, or page Module Stocks to manage warehouses and stock.
Installation
This module is included with the Dolibarr distribution, so there is no need to install it.
Configuration
To use this module, you must first enable it using an administrator account, via the menu option "Home - Setup - Modules".
Choose the tab where the module is listed. Then click on "Activate".
The module is now activated.
If a cog icon appears 
on module thumb or at end of the line of the module, click on it to access the setup page specific to the module.
Definition
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 Services.
A product follows this rules:
- A product can be stocked into a warehouse (only products appears in module Stock. Services are not visible).
- A product can be delivered (only products appears in module 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:
- 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)
A product or service may be registered as a virtual (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 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.
- The stock of each individual component inside the virtual product is incremented / decremented when the parent product is acquired / delivered.
- A virtual product may itself be composed of other virtual products that contain other (single) products.
Note: 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 to be kept in stock. Here in fact, in the "virtual product or service" function, the sub-components of a virtual product are only decrementing the stock at the time of delivery of the virtual product. Till then, these sub-products remain at disposal to be integrated in the sales process as single independent products also. Again, the manufacturing module on the contrary, from the moment it registered a "container product", immediately purveyed that its by-products were unusable for any other purpose. Therefore, their stock was 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.
Rules to manage sales prices
There are 4 ways to manage sale price of products in Dolibarr.
- One and only one price per product
- Price per segment of customers
- Price per customer
- price per quantity (experimental)
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 change this number. 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/...
Image
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").
Variants
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.
Life cycle / Business rules
|
|
Page waiting to complete. To complete, create an account, go back and clic on "Modify".
Page en attente d'être complété. Pour compléter, créez un compte, revenez et cliquez sur "Modifier".
Página a completar. Para completarla, cree una cuenta, vuelva a la página y haga clic en "editar"
Seite wartet auf Vervollständigung. Um zu helfen, erstelle ein Konto, gehe zurück und klicke auf "Bearbeiten".
Related videos