A product group is the equivalent of a product table in the Oneflow application . Each product group contains a list of products .
š§ You can add up to 150 products in total to all product groups in one contract .
The table below displays all the attributes available for the product_groups array.
Attribute Type Description created_time string(datetime) The date and time when the product group was created. updated_time string(datetime) The date and time when the product group was last updated.
Attribute Type Description columns array The list of objects containing each column's details. See Columns . counterpart_edit boolean Indicates whether or not the counterparty can edit the quantity of products in this product group. hide_price_summation boolean Indicates whether or not to display price sums. name object Includes the product group name details. See Name . price_affixes object Includes the affixes of the prices. See Price affixes . price_precision integer Defines the number of decimal places, ranging from 0 to 4, for the base price, discount amount, and discounted price. quantity_precision integer Defines the number of decimal places, ranging from 0 to 4, for the quantities. (This applies only to quantities of type 'quantity'. See Quantity . ) tax_1 object Defines the label of the tax column. A preferred label can be defined for the tax. (If this field not added, the default label will be 'Tax'). See Tax 1 .
The table below shows all the attributes available for each column in the columns array.
Attribute Type Description enabled boolean Indicates whether or not to enable the column. key string(enum) The key of the column. Can be one of thename, description, price_1, price_2, count label string The label of the column.
The table below shows all the attributes available for the name object.
Attribute Type Description enabled boolean Indicates whether the product group's name is enabled or disabled. label string Name of the product group.
The table below shows all the attributes available for the price_affixes object.
Attribute Type Description postfix string Indicates the postfix of the prices. prefix string Indicates the prefix of the prices.
The table below shows all the attributes available for the tax_1 object.
Attribute Type Description label string Label of the tax field.
The table below shows all the attributes available for each column in the enabled_columns array.
Attribute Type Description enabled boolean Indicates whether the column is enabled or not. key string(enum) The key of the column. Can be one of thename, description, price_1, price_2, count
The table below shows all the attributes available for each product in the products array.
Attribute Type Description created_time string(datetime) The date and time when the product was created. custom_id string A custom identifier you can use to address the products in a contract. Each custom_id must be unique for the products in a contract. updated_time string(datetime) The date and time when the product was last updated.
Attribute Type Description amount object Final price including discount. Calculated from the base amount. See Final amount . base_amount object The base price of one item of product excluding discounts. See Base amount . discount_amount object This value should not be more than the base price. If the base amount is 0, a negative final price is possible. See Base amount . discount_percent string(percent) The percentage discount from the base price. The result is rounded to three decimal places. tax_1 object The tax value can be added as a percentage, the key should be percentage and value can be any number from 0 to 100. See Tax amount .
Attribute Type Description amount string(amount) An amount that indicates a certain quantity. This value can be negative.
š§ The discount_amount and the discount_percent attributes are mutually exclusive in any input. In the output, one of them will always be set to 0.
Attribute Type Description key string(enum) The key is predefined and should be "percentage". (Currently only the tax percentage is supported) value string(amount) Value indicates the tax percentage and 0 to 100 values are supported with three decimal places.
The quantity of the purchased products.
Describes the item quantity enumeration type.
Name Description multiple_choice Adds a checkbox to the product. The product quantity for this type must be 1 (checked) or 0 (unchecked). You can select one of several checkboxes. single_choice Adds a radio button to the product. As with the checkbox, you must specify the product quantity for this type as 1 (checked) or 0 (unchecked). You can select at most one radio button in one product table, meaning that while many products in a product table can have a single_choice, you can select only 1. quantity Adds a number field to a product to enter the number of products. If no other quantity type is specified, the default quantity type is quantity.
A product table with all quantity types. Starting from the top: multiple_choice, single_choice, and quantity.
