The product object

Attribute

Description

id

Unique identifier for the object.

name

The product’s unique name.

uom

The 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_name

A string used to group similar items for better organization and analysis.

is_producible

If you make the product, this enables creating product recipes and production operations for the product and adding it to manufacturing orders.

default_supplier_id

The 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_purchasable

If you purchase the product from suppliers and sell directly to your customers without any production process, you can make a product purchasable.

type

Indicating the item type. Product objects are of type "product".

additional_info

A string attached to the object to add any internal comments, links to external files, additional instructions, etc.

purchase_uom

If 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_rate

The conversion rate between the purchase and product UoMs. If used, product must have a purchase_uom that is different from uom.

batch_tracked

Batch tracking enables you to assign batch numbers and expiration dates to manufactured items.

variants

An array of product variant objects.

created_at

The timestamp when the product was created.

updated_at

The timestamp when the product was last updated.

configs

An array of product variant configurations.

The product config object

Attribute

Description

id

Unique identifier for the object.

name

Name of the variant option (e.g. color, size).

values

An array of values for a variant option. (e.g. blue, green, red).