Docs API Reference Product Parameter/bff/product-parameter/add

/bff/product-parameter/add

Creates a new parameter definition. For enum/color types, add predefined values afterwards via /value-add. DB-level constraints enforce: variant_forming only for enum/color; multi_value only for enum/color.

Product ParameterpostBffProduct-parameterAdd

Parameters

JSON body

Request body

application/json

namestringRequired

Display name (e.g. "Weight", "Color", "Material").

Length: 1–∞

ExampleWeight

codestringOptional

URL-friendly code. Auto-generated from name if not provided.

Exampleweight

groupCodestringOptional

Code of the group to assign the parameter to. Omit for ungrouped.

Exampletechnical-specs

type"string" | "number" | "boolean" | "enum" | "color"Optional

Parameter data type. "string" = free text, "number" = numeric with optional unit, "boolean" = true/false, "enum" = predefined list of values, "color" = predefined colors with hex codes.

unitstringOptional

Unit label for number type (e.g. "mm", "kg", "W").

Examplekg

filterablebooleanOptional

Show in frontend filters. Defaults to false.

comparablebooleanOptional

Show in product comparison. Defaults to false.

variantFormingbooleanOptional

Whether this parameter creates product variants. Only allowed for enum/color type. Defaults to false.

multiValuebooleanOptional

Allow multiple values per product. Only allowed for enum/color type. Defaults to false.

positionnumberOptional

Sort order position. Defaults to 0.

Example0

Response schema

1 status code documented

200Success

idnumberRequired

ID of the created parameter.

codestringRequired

Final code after slugification.

Response example

application/json

{
  "id": 0,
  "code": "example_code"
}

Request example

POST /bff/product-parameter/add

post

curl -X POST "https://api.bizkithub.com/bff/product-parameter/add" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "name": "Weight",
  "code": "weight",
  "groupCode": "technical-specs",
  "unit": "kg",
  "filterable": false,
  "comparable": false,
  "variantForming": false,
  "multiValue": false,
  "position": 0
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key