Oneflow Integration Platform

Use the Oneflow API to build powerful integrations to automate your contract management.

Product group

A product group is the equivalent of a product table in the Oneflow application. Each product group contains a list of products.

🚧

Note:

You can add up to 150 products to a single contract.

The table below displays all the attributes available for the product_groups array.

AttributeTypeDescription
_private_ownersideobjectThe product group attributes that are visible only to the owner-side party. See Private owner-side product group.
idinteger(signed_integer_id)The ID of the product group.
productsarrayThe list of products in this product group. See Products.

Private owner-side product group

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.

Products

The table below shows all the attributes available for each product in the products array.

AttributeTypeDescription
_private_ownersideobjectSee Private owner-side product.
counterparty_lockbooleanIndicates if the counterparty can edit the product in the contract. It defaults to false.
descriptionstring(RTF)The description of the product in rich text format.
idinteger(signed_integer_id)The ID of the product.
namestringThe name of the product.
price_1objectAll pricing information for a product. See Price.
price_2objectInformation about alternative pricing for a product, such as a monthly payment plan. See Price.
quantityobjectInformation about the product quantity. See Quantity.

Private owner-side product

Attribute

Type

Description

created_time

string(datetime)

The date and time when the product was created.

updated_time

string(datetime)

The date and time when the product was last updated.

Price

AttributeTypeDescription
amountobjectFinal price including discount. Calculated from the base amount. See Final amount.
base_amountobjectThe base price of one item of product excluding discounts. See Base amount.
discount_amountobjectThis 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_percentstring(percent)The percentage discount from the base price. The result is rounded to three decimal places.

Final amount

AttributeTypeDescription
amountstring(signed_amount)An amount. This value can be negative.

Base amount

AttributeTypeDescription
amountstring(amount)An amount that indicates a certain quantity. This value can be negative.

🚧

Note:

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.

Quantity

The quantity of the purchased products.

AttributeTypeDescription
amountintegerThe number of individual products selected.
typestring(enum)One of the product's Quantity type

Quantity type

Describes the item quantity enumeration type.

NameDescription
multiple_choiceAdds 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_choiceAdds 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.
quantityAdds 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.`A product table with all quantity types. Starting from the top: `multiple_choice,` `single_choice,` and `quantity.`

A product table with all quantity types. Starting from the top: multiple_choice, single_choice, and quantity.

Updated 2 days ago


Product group


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.