v1

latestOpenAPI 3.0.02026-07-24115101.2 MB
Contract - Products

Add a product to a product group

Use this endpoint to add a product to a specific product group in a contract. See Products for more information.

post/contracts/{contract_id}/product_groups/{product_group_id}/products

Path parameters

contract_idinteger required

The unique ID of the contract.

product_group_idinteger required

The unique ID of the product group.

Headers

x-oneflow-api-tokenstring required

The API key of your Oneflow account.

x-oneflow-user-emailstring email required
Example:john.doe@oneflow.com

The email address of a registered Oneflow user.

Request body

counterparty_lockboolean

If true, the counterpart can edit products in the contract.

descriptionstring

The product description.

idinteger

The product ID.

namestring

The product name. When creating a new product, it is mandatory to provide a product name.

Response

Returns the created product.

counterparty_lockboolean
created_frominteger nullable

This will be only available in the contract create response.

descriptionstring
idinteger required
namestring required