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

10 body

10 total

Body · 10

namestringRequired

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

Length: 1–∞

codestring

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

groupCodestring

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

typestring | string | string | string | string

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.

unitstring

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

filterableboolean

Show in frontend filters. Defaults to false.

comparableboolean

Show in product comparison. Defaults to false.

variantFormingboolean

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

multiValueboolean

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

positionnumber

Sort order position. Defaults to 0.

Request

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
}'

Response

JSON payload

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

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key