Skip to main content
POST
/
api
/
public
/
buyer
/
v1
/
buyer_products
Creates a buyer product with auto-match
curl --request POST \
  --url https://app.chemcloud.com.au/api/public/buyer/v1/buyer_products \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "raw_material_name": "Sodium Hydroxide 50%",
  "measurement_unit": "kg",
  "product_type": "Raw Material",
  "raw_material_code": "NAOH-50",
  "annual_usage": 10000,
  "typical_order_size": 1000,
  "frequency": "monthly",
  "container_type": "IBC",
  "target_approvals": 1,
  "priority_product": false,
  "active": true,
  "document_types": [
    "sds"
  ],
  "resource_values": [
    {
      "provider": "cin7_core",
      "value": "99999a99-b888-777c-666d-55555555555e"
    }
  ]
}
'
{
  "id": "99999a99-b888-777c-666d-55555555555e",
  "annual_usage": 10000,
  "frequency": "monthly",
  "raw_material_code": "NAOH-50",
  "raw_material_name": "Sodium Hydroxide 50%",
  "typical_order_size": 1000,
  "container_type": "IBC",
  "measurement_unit": "kg",
  "product_type": "Raw Material",
  "document_types": [
    "sds"
  ],
  "resource_values": [
    {
      "provider": "cin7_core",
      "value": "99999a99-b888-777c-666d-55555555555e"
    }
  ],
  "target_approvals": 1,
  "priority_product": false,
  "active": true,
  "created_at": "2025-12-31T23:13:11.862Z",
  "updated_at": "2025-12-31T23:13:11.862Z"
}

Authorizations

​
X-API-KEY
string
header
required

Body

application/json
​
raw_material_name
string
required

Internal name for this product

Example:

"Sodium Hydroxide 50%"

​
measurement_unit
enum<string>
required

Unit of measure purchased in

Available options:
EA,
L,
MT,
g,
kg,
mL
Example:

"kg"

​
product_type
enum<string>
required

Type of product

Available options:
Dye,
Fragrance,
Other,
Packaging,
Raw Material
Example:

"Raw Material"

​
raw_material_code
string

Internal code for this product

Example:

"NAOH-50"

​
annual_usage
integer

Annual usage of this product

Example:

10000

​
typical_order_size
integer

Typical volume of purchase

Example:

1000

​
frequency
string

Typical frequency of purchase

Example:

"monthly"

​
container_type
enum<string>

Typical pack size purchased in

Available options:
Bag,
Bottle,
Bulk,
Bulk Bag,
Drum,
Flexibag,
IBC,
ISOTank,
Pail,
Sample,
Tanker,
Unit
Example:

"IBC"

​
target_approvals
integer

Target number of approved materials for this product

Example:

1

​
priority_product
boolean

Priority product is one which is critical to your operation

Example:

false

​
active
boolean
Example:

true

​
document_types
enum<string>[]

Document types required for this product

Available options:
allergen_statement,
animal_testing_statement,
batch_coa,
bill_of_lading,
bill_of_lading_surrendered,
brcgs,
brochure,
certificate_of_origin,
commercial_invoice,
delivery_note,
email,
ethylene_oxide_dioxane_certificate,
fda_certificate,
fssc_22000,
gmo_free_statement,
gmp_certificate,
haccp,
halal_certificate,
impurities_statement,
internal_specification,
iso14001,
iso9001,
kosher_certificate,
multi_modal_dangerous_goods_form,
nanoparticle_statement,
nitrosamine_impurities,
other,
packing_declaration,
packing_list,
pif,
product_specification,
product_watchlist_batch,
proof_of_delivery,
purchase_order,
quality_agreement,
quarantine_document,
quote,
residual_solvent_statement,
rspo_certificate,
sample_coa,
sds,
specification_sheet,
supplier_questionnaire,
tds,
tga_certificate,
tse_certificate
​
resource_values
object[]

Response

201 - application/json

Buyer product created with new product when no match found

​
id
string<uuid>
Example:

"99999a99-b888-777c-666d-55555555555e"

​
annual_usage
integer | null

Annual usage of this product

Example:

10000

​
frequency
string | null

Typical frequency of purchase

Example:

"monthly"

​
raw_material_code
string | null

Internal code for this product

Example:

"NAOH-50"

​
raw_material_name
string | null

Internal name for this product

Example:

"Sodium Hydroxide 50%"

​
typical_order_size
integer | null

Typical volume of purchase

Example:

1000

​
container_type
enum<string>

Typical pack size purchased in

Available options:
Bag,
Bottle,
Bulk,
Bulk Bag,
Drum,
Flexibag,
IBC,
ISOTank,
Pail,
Sample,
Tanker,
Unit
Example:

"IBC"

​
measurement_unit
enum<string>

Unit of measure purchased in

Available options:
EA,
L,
MT,
g,
kg,
mL
Example:

"kg"

​
product_type
enum<string>

Type of product

Available options:
Dye,
Fragrance,
Other,
Packaging,
Raw Material
Example:

"Raw Material"

​
document_types
enum<string>[]

Document types required for this product

Available options:
allergen_statement,
animal_testing_statement,
batch_coa,
bill_of_lading,
bill_of_lading_surrendered,
brcgs,
brochure,
certificate_of_origin,
commercial_invoice,
delivery_note,
email,
ethylene_oxide_dioxane_certificate,
fda_certificate,
fssc_22000,
gmo_free_statement,
gmp_certificate,
haccp,
halal_certificate,
impurities_statement,
internal_specification,
iso14001,
iso9001,
kosher_certificate,
multi_modal_dangerous_goods_form,
nanoparticle_statement,
nitrosamine_impurities,
other,
packing_declaration,
packing_list,
pif,
product_specification,
product_watchlist_batch,
proof_of_delivery,
purchase_order,
quality_agreement,
quarantine_document,
quote,
residual_solvent_statement,
rspo_certificate,
sample_coa,
sds,
specification_sheet,
supplier_questionnaire,
tds,
tga_certificate,
tse_certificate
​
resource_values
object[]
​
target_approvals
integer

Target number of approved materials for this product

Example:

1

​
priority_product
boolean

Priority product is one which is critical to your operation

Example:

false

​
active
boolean
Example:

true

​
created_at
string<date-time>
Example:

"2025-12-31T23:13:11.862Z"

​
updated_at
string<date-time>
Example:

"2025-12-31T23:13:11.862Z"