article
Represents a product or inventory item.
Schema
Identification
| Field |
Type |
Required |
Read-only |
Description |
id |
integer |
— |
✓ |
Internal product ID |
item_code |
string (1–15) |
Yes |
— |
Unique product code |
description |
string (1–60) |
Yes |
— |
Primary product description |
description_2 |
string (max 60) |
— |
— |
Secondary description |
bar_code |
string (max 20) |
— |
— |
Product barcode (EAN, etc.) |
suppliers_bar_code |
string (max 20) |
— |
— |
Supplier's barcode |
nomenclatura |
string |
— |
— |
Customs / tariff nomenclature code |
country_of_origin |
string (max 20) |
— |
— |
Country of origin (ISO code) |
Classification
| Field |
Type |
Description |
family |
string |
Product family code |
subfamily |
string |
Product subfamily |
section |
string (max 15) |
Section/department |
category |
string |
Product category code |
unit_of_measurement |
string (max 15) |
Default unit of measurement (e.g., UN, KG) |
obs |
string |
Observations / notes |
Dimensions & Packaging
| 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 percentage |
eco_tax |
number (double, ≥ 0) |
Eco-tax amount |
Stock & Costing
| Field |
Type |
Description |
stock |
number (double, ≥ 0) |
Current stock quantity |
safety_stock |
number (double, ≥ 0) |
Minimum safety stock level |
weighted_average_cost |
number (double, ≥ 0) |
Weighted average cost |
cost_by_serial_number |
boolean |
If true, cost is tracked per serial number |
vat_regime_for_gross_margin |
boolean |
VAT regime based on gross margin |
Example
{
"item_code": "WIDGET-A",
"description": "Widget Type A — Standard",
"description_2": "Pack of 10",
"family": "WIDGETS",
"category": "HARDWARE",
"unit_of_measurement": "UN",
"bar_code": "5601234567890",
"unit_price": 25.00,
"sales_tax": 23.0,
"stock": 150.0,
"safety_stock": 20.0,
"weighted_average_cost": 12.50
}
Used By