BizKitHub
DocsAPI ReferenceProduct/bff/product/product-update
postProductAdmin BFF

/bff/product/product-update

Updates all editable fields of a product. Locale determines which translation to write to. If saving in the primary locale, base product columns are also updated. If the price changes, a price history entry is created and watchdog notifications are triggered. Custom fields can be batch-updated via customFieldsRaw. Read models for all locales are regenerated.

ProductpostBffProductProduct-update

Parameters

JSON body

Request body

application/json
namestringRequired

Product name (will be normalized and capitalized).

Length: 1–∞
ExampleMy Product
codestringRequired

Product code (used to identify the product).

Length: 1–∞
Examplemy-product
localestringRequired

Locale code for translation (e.g. "cs", "en").

Length: 2–5
Examplecs
slugstringOptional

URL slug. If not provided, keeps existing slug.

Examplemy-product
eanstringOptional

EAN barcode (validated, ignored if invalid).

Example8594000000123
shortDescriptionstringOptional

Short HTML description.

longDescriptionstringOptional

Long HTML description.

internalNotestringOptional

Internal note (admin only).

activebooleanOptional

Whether the product is active.

b2bbooleanOptional

Whether the product is B2B only.

showInFeedbooleanOptional

Whether the product appears in product feeds.

soldOutbooleanOptional

Whether the product is sold out.

pricenumberOptional

Price with VAT.

Example299.9
costnumberOptional

Internal cost in the organisation default currency. Defaults to 0 when omitted.

Example120
standardPricePercentagenumberOptional

Standard price percentage for discount calculation.

Example100
vatnumberOptional

VAT rate percentage.

Example21
sizeWidthMmnumberOptional

Product width in millimeters.

Example150
sizeHeightMmnumberOptional

Product height in millimeters.

Example200
sizeDepthMmnumberOptional

Product depth in millimeters.

Example50
weightGramsnumberOptional

Product weight in grams.

Example500
warehouseAllQuantitynumberOptional

Total warehouse stock quantity.

Example100
warehouseLimitnumberOptional

Minimum stock level before reorder alert.

Example10
customFieldsRawobjectOptional

Custom fields key-value map for batch update.

Response schema

1 status code documented

200Success
successbooleanRequired

Whether the product was updated.

customFieldsRawanyOptional

Echo of the custom fields that were updated, if provided.

Response example

application/json
{
  "success": false
}

Request example

POST /bff/product/product-update

post
curl -X POST "https://api.bizkithub.com/bff/product/product-update" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "name": "My Product",
  "code": "my-product",
  "locale": "cs",
  "slug": "my-product",
  "ean": "8594000000123",
  "shortDescription": "example_shortDescription",
  "longDescription": "example_longDescription",
  "internalNote": "example_internalNote",
  "active": false,
  "b2b": false,
  "showInFeed": false,
  "soldOut": false,
  "price": 299.9,
  "cost": 120,
  "standardPricePercentage": 100,
  "vat": 21,
  "sizeWidthMm": 150,
  "sizeHeightMm": 200,
  "sizeDepthMm": 50,
  "weightGrams": 500,
  "warehouseAllQuantity": 100,
  "warehouseLimit": 10,
  "customFieldsRaw": {}
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key