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

/bff/product-parameter/product-assign

Assigns a parameter value to a product. Exactly one value field must be provided based on the parameter type: valueCode for enum/color, valueString for string, valueNumber for number, valueBoolean for boolean. For multi-value enum/color parameters, call this endpoint multiple times with different valueCodes. For scalar types (string, number, boolean), only one assignment per product+parameter(+variant) is allowed.

Product ParameterpostBffProduct-parameterProduct-assign

Parameters

JSON body

Request body

application/json

productCodestringRequired

Product code to assign the parameter value to.

Examplemy-product

parameterCodestringRequired

Parameter code to assign.

Examplecolor

valueCodestringOptional

Predefined value code (required for enum/color parameters).

Examplered

valueStringstringOptional

Free-text value (for string-type parameters).

ExampleCotton blend

valueNumbernumberOptional

Numeric value (for number-type parameters).

Example500

valueBooleanbooleanOptional

Boolean value (for boolean-type parameters).

Exampletrue

variantCodestringOptional

Variant code for variant-level assignment. Omit for product-level assignment.

Examplevariant-xl

Response schema

1 status code documented

200Success

successbooleanRequired

Whether the value was assigned.

Response example

application/json

{
  "success": false
}

Request example

POST /bff/product-parameter/product-assign

post

curl -X POST "https://api.bizkithub.com/bff/product-parameter/product-assign" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "productCode": "my-product",
  "parameterCode": "color",
  "valueCode": "red",
  "valueString": "Cotton blend",
  "valueNumber": 500,
  "valueBoolean": true,
  "variantCode": "variant-xl"
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key