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

23 body

23 total
Body · 23
namestringRequired

Product name (will be normalized and capitalized).

Length: 1–∞
codestringRequired

Product code (used to identify the product).

Length: 1–∞
localestringRequired

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

Length: 2–5
slugstring

URL slug. If not provided, keeps existing slug.

eanstring

EAN barcode (validated, ignored if invalid).

shortDescriptionstring

Short HTML description.

longDescriptionstring

Long HTML description.

internalNotestring

Internal note (admin only).

activeboolean

Whether the product is active.

b2bboolean

Whether the product is B2B only.

showInFeedboolean

Whether the product appears in product feeds.

soldOutboolean

Whether the product is sold out.

pricenumber

Price with VAT.

costnumber

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

standardPricePercentagenumber

Standard price percentage for discount calculation.

vatnumber

VAT rate percentage.

sizeWidthMmnumber

Product width in millimeters.

sizeHeightMmnumber

Product height in millimeters.

sizeDepthMmnumber

Product depth in millimeters.

weightGramsnumber

Product weight in grams.

warehouseAllQuantitynumber

Total warehouse stock quantity.

warehouseLimitnumber

Minimum stock level before reorder alert.

customFieldsRawobject

Custom fields key-value map for batch update.

Request

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": {}
}'

Response

JSON payload

{
  "success": false
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key