family
Represents a product family — a grouping layer above individual articles, sharing common attributes like pricing, tax, and logistics defaults.
Schema
Identification
| Field |
Type |
Required |
Read-only |
Description |
id |
integer |
— |
✓ |
Internal family ID |
family_code |
string (1–15) |
Yes |
— |
Unique family code |
description |
string (1–60) |
Yes |
— |
Primary description |
description_2 |
string (max 60) |
— |
— |
Secondary description |
Classification
| Field |
Type |
Description |
family |
string |
Parent family code |
subfamily |
string |
Subfamily code |
section |
string (max 15) |
Section/department |
category |
string |
Category code |
unit_of_measurement |
string (max 15) |
Default unit of measurement |
obs |
string |
Observations / notes |
Barcodes & Trade
| Field |
Type |
Description |
bar_code |
string (max 20) |
Barcode |
suppliers_bar_code |
string (max 20) |
Supplier barcode |
nomenclatura |
string |
Customs tariff code |
country_of_origin |
string (max 20) |
Country of origin |
Dimensions
| Field |
Type |
Description |
gross_weight |
string (max 15) |
Gross weight |
net_weight |
string (max 15) |
Net weight |
volume_per_unit |
string (max 15) |
Volume per unit |
number_of_packages_per_unit |
string (max 15) |
Packages per unit |
Pricing & Tax
| Field |
Type |
Description |
unit_price |
number (double, ≥ 0) |
Default selling price |
sales_tax |
number (float, 0–100) |
VAT/sales tax rate |
eco_tax |
number (double, ≥ 0) |
Eco-tax amount |
Stock
| Field |
Type |
Description |
stock |
number (double, ≥ 0) |
Aggregated stock quantity |
safety_stock |
number (double, ≥ 0) |
Safety stock level |
weighted_average_cost |
number (double, ≥ 0) |
Weighted average cost |
cost_by_serial_number |
boolean |
Cost tracked per serial number |
vat_regime_for_gross_margin |
boolean |
VAT based on gross margin |
Example
{
"id": 10,
"family_code": "WIDGETS",
"description": "Widgets Product Line",
"category": "HARDWARE",
"unit_price": 20.00,
"sales_tax": 23.0,
"unit_of_measurement": "UN"
}
Used By