Product

The representation of a product or service is called a Product object. Products are identified by a unique incremental ID.

Attribute	Type	Description
id	integer	Unique identifier for the product.
code	string	Visual identifier code of the product.
code_cup	string	Code UPC of the product.
origin_product_id	integer	ID of the parent product.
updated_at	datetime	Last updated date.
created_at	datetime	Created date.
category_id	integer	ID of the product categories.
type	integer	The product type. Possible values are : 1: Product 4: Service 7: Product used for assembly 8: Service used for assembly 11: Assembling 12: Gift card
status	integer	Statut of the product. 1 for active, 0 for inactive.
name_fr	string	Product french name.
additional_fr	string	Short french description.
guaranty_fr	string	Description of the french product guaranty.
name_en	string	Product english name.
additional_en	string	Short english description.
guaranty_en	string	Description of the english product guaranty.
tags	string	Comma separated list of id tag.
price	numeric	Product price.
price_return	numeric	Product price for the return invoice.
special_price	numeric	Special price for the product.
special_price_return	numeric	Special price for the product in return invoice.
special_price_from	date	Start date for the special price.
special_price_to	date	End date for the special price.
change_from	date	Date for the new price effective.
change_price	numeric	New price.
change_return	numeric	New price for return invoice.
dimensions_length	numeric	Length dimension of the product.
dimensions_width	numeric	Width dimension of the product.
dimensions_height	numeric	Height dimension of the product.
weight	numeric	Weight of the product.
weight_unit	integer	Id of the unit for the weight.
unit	integer	Id of the unit for the product.
provider_id	integer	Id of the provider.
provider_reference	string	Reference of the provider.
price_cost	numeric	Cost price at the provider.
order_unit	integer	Id of the unit for the order.
other_fee	numeric	Other price fee.
quantity_case	numeric	Quantity per case.
quantity_min	numeric	Quantity minimum.
quantity_order	numeric	Quantity for order.
location	string	Location of the product.
is_bank_hour	boolean	Product is use for bank hour.
is_subscription	boolean	Product is use for subscription.
invoice_display	boolean	Product is display on invoice.
invoice_order	integer	Position of the product on invoice.
submission_display	boolean	Product is display on submission.
submission_order	integer	Position of the product on submission.
is_reccuring	boolean	Product is recurring.
recurring_renewal	boolean	Recurring product is auto renewal.
recurring_type	integer	Id of the type of recurring. Possible values are : 1: annual 2: quarterly 3: monthly 4: fortnightly 5: weekly
recurring_limit	integer	Limit of renewal. 0 for unlimited.
short_description_fr	string	Short french description of the product.
description_fr	string	French description of the product.
short_description_en	string	Short english description of the product.
description_en	string	English description of the product.
notes_fr	string	French notes for the product.
notes_en	string	English notes for the product.
note_invoice	boolean	Add the note to the invoice automatically