Skip to content

Product

API Name: Product

Main entity of the product catalog.

Fields

Field Type Required Description
name varchar Product name
type enum Product type
referenceIdentifier varchar - SKU / Reference ID
category link - Product category
measureUnit enum Measure unit
weight float - Weight
photo image - Product photo
description wysiwyg - Product description
url url - Web link
attachments attachmentMultiple - Attachments
pricingType enum - Pricing type
costPrice currency - Cost price
costPriceWithTax currency - Cost price with VAT
salesPrice currency - Sales price
salesPriceWithTax currency - Sales price with VAT
priceMarkup percentage - Markup percentage
priceMargin percentage - Margin percentage
coefficient float - Coefficient (default: 1)
taxClass link - Tax class
taxRate percentage - Tax rate
primarySupplier link - Primary supplier
suppliers linkMultiple - Suppliers (virtual)
eans linkMultiple - EAN codes
productSerials linkMultiple - Serial numbers
productSupplierItems linkMultiple - Supplier items
serialTotalCount int - Total serial numbers
serialActiveCount int - Active serial numbers
teams linkMultiple - Teams

Enum Values type

Value Description Icon
Warehouse Item Physical stock item fas fa-boxes
Service Service item fas fa-cogs

Enum Values pricingType

Value Description
No Price No pricing
Fixed Sales Price Fixed sales price
Markup over Cost Markup over cost
Profit Margin Profit margin
Same as Cost Price Same as cost price
Purchasing Coefficient Purchasing coefficient
Sales Coefficient Sales coefficient

Relationships

Relationship Type Target Entity
category belongsTo ProductCategory
taxClass belongsTo TaxClass
primarySupplier belongsTo Account
eans hasChildren Ean
productSerials hasMany ProductSerial
productSupplierItems hasMany ProductSupplierItem
suppliers hasMany Account