Update a product by ID

put https://{hostname}/v1/contracts/{contract_id}/products/{product_id}

Use this endpoint to update a specific product in a specific contract by the product ID. See Products for more information.

Path Params

contract_id

integer

required

The unique ID of the contract.

product_id

integer

required

The unique ID of the product.

Body Params

Request body parameters used for updating a product in a contract.

_private_ownerside

object

Contract product attributes that are private to the ownerside.

counterparty_lock

boolean

Defaults to false

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

description

string

length between 0 and 3000

The product description.

integer

The product ID.

name

string

length between 1 and 80

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

price_1

object | null

The object holds all price-related information for an individual product. Note that base_amount must be larger than discount_amount, except if the base_amount is 0, which is an exception to allow negative prices. See Products.

price_2

object | null

quantity

object

The object holds information about the quantity of an individual product. The default quantity type is multiple_choice. If the quantity type is single_choice or multiple_choice, the amount must be set to 0 or 1. If the quantity type is set to single_choice, the amount must be set to 1 at least for one product, and 0 for the rest of the products in the same product group with the quantity type single_choice.

Headers

x-oneflow-api-token

string

required

length between 40 and 40

The API key of your Oneflow account.

x-oneflow-user-email

string

required

The email address of a registered Oneflow user.

Responses

400

Invalid format or content of the request.

404

A required entity is missing.

409

A conflict occurred with the current state of the target resource.

Language

URL


xxxxxxxxxx
12
1
curl --request PUT \
2
     --url https://api.oneflow.com/v1/contracts/contract_id/products/product_id \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "counterparty_lock": false,
8
  "quantity": {
9
    "type": "quantity"
10
  }
11
}
12
'

Choose an example:

application/json

200Returns the newly updated product.