Skip to content

Importing Items

To import items, you must provide a CSV file containing the required item information.

The available columns for this table are:

ColumnDescription
codeRequired. Between 1 and 256 characters.
nameRequired. Between 1 and 50 characters.
descriptionOptional. Maximum 256 characters.
weightOptional. Numeric value.
weight_unitOptional. See Weight Units.
uom_quantityOptional. Numeric value.
uom_amountOptional. Numeric value.
uom_unitOptional. See UOM Units.
activeOptional. A valid boolean value. Defaults to true.

Validation Rules

If either weight or weight_unit is provided, both fields are required:

  • weight
  • weight_unit

If any of the three Unit of Measure (UOM) fields are provided, then all three must be provided:

  • uom_quantity
  • uom_amount
  • uom_unit

Weight Units

The following weight units are supported:

Unit
mg
g
kg
oz
lbs

UOM Units

The following units are supported for units of measure:

Unit
mg
g
kg
oz
lbs
ml
l
pieces

Example CSV

All Columns

csv
code,name,description,weight,weight_unit,uom_quantity,uom_amount,uom_unit,active
ITEM001,Whole Milk,Fresh whole milk,500,g,4,500,ml,true

Required Columns Only

csv
code,name
ITEM001,Whole Milk