Skip to main content
POST
/
api
/
products
/
{product_id}
/
materials
Create a product material
curl --request POST \
  --url https://clarus-api.com/api/products/{product_id}/materials \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "data": {
    "type": "product_materials",
    "attributes": {
      "child_product_id": 88,
      "quantity": 4
    }
  }
}
'
{
  "data": {
    "id": "1",
    "type": "product_materials",
    "attributes": {
      "quantity": 4,
      "parent_product_id": 150,
      "child_product_id": 88
    }
  }
}

​
Request Structure

{
  "data": {
    "type": "product_materials",
    "attributes": {
      "child_product_id": 88,
      "quantity": 4
    }
  }
}
Defines a component line on a bill-of-materials product. The parent product is taken from the URL ({product_id}) and must be a bill of materials.
FieldRequiredDescription
child_product_idYesComponent product
quantityYesQuantity per parent (> 0)

Authorizations

​
Authorization
string
header
required

OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.

​
X-Clarus-Subdomain
string
header
required

The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.

Path Parameters

​
product_id
integer
required

The parent (bill-of-materials) product ID

Body

application/json
​
data
object
required

Response

Created successfully

The response is of type object.