The product object

AttributeDescription
idUnique identifier for the object.
nameThe product’s unique name.
uomThe unit used to measure the quantity of the product (e.g. pcs, kg, m). This unit is also used for the item on orders and product recipes.
category_nameA string used to group similar items for better organization and analysis.
is_producibleIf you make the product, this enables creating product recipes and production operations for the product and adding it to manufacturing orders.
default_supplier_idThe supplier added to a purchase order automatically when the related product is added to the order. When used, the product must be marked as purchasable.
is_purchasableIf you purchase the product from suppliers and sell directly to your customers without any production process, you can make a product purchasable.
is_auto_assemblyMarks the product as a bundle/kit which will automatically create manufacturing orders when delivering a sales order. This ensures that the required components are assembled as part of the delivery process for bundled products
typeIndicating the item type. Product objects are of type "product".
additional_infoA string attached to the object to add any internal comments, links to external files, additional instructions, etc.
purchase_uomIf you are purchasing in a different unit of measure than the default unit of measure (used for tracking stock) for this item, you can define the purchase unit. Value null indicates that purchasing is done in same unit of measure. If value is not null, purchase_uom_conversion_rate must also be populated.
purchase_uom_conversion_rateThe conversion rate between the purchase and product UoMs. If used, product must have a purchase_uom that is different from uom.
batch_trackedBatch tracking enables you to assign batch numbers and expiration dates to manufactured items.
serial_trackedSerial tracking enables you to assign serial numbers to manufactured items.
operations_in_sequenceOperation in sequence enables you to perform manufacturing order operations in sequence.
variantsAn array of product variant objects.
created_atThe timestamp when the product was created.
updated_atThe timestamp when the product was last updated.
configsAn array of product variant configurations.

The product config object

AttributeDescription
idUnique identifier for the object.
nameName of the variant option (e.g. color, size).
valuesAn array of values for a variant option. (e.g. blue, green, red).