PUT /
Replace Product
PUT
/product/{product_key}
Fully replace a product document.
Performs a full document replace (not a merge) — all fields in the document
will reflect new_product_data. The _key in the payload must match
product_key.
Emits: (direct transaction — no event class)
Required scope: product:catalogue:update
Authorizations
OAuth2PasswordBearer
password Flow
Token URL
"/api/auth"Scopes:
"admin"User can access and edit users and system settings"library"User can access and edit products"production"User can access and edit production plans"operator"User can access the operator panel and make production declarations
Parameters
Path Parameters
product_key*
Type
Requiredstring
Request Body
application/json
JSON "_key": "prod-001", "code": "PROD-A-001", "description": "Aluminium bracket, anodised black, 50x30mm", "active": true, "image": false, "tags": [ { "_id": "string", "_key": "string", "_rev": "string", "name": "Urgent", "description": "Flag items that require immediate attention.", "color": "#E53935" } ], "counter_key": "counter-001", "traceability_level": "form_only", "manage_inventory": false, "allow_negative_inventory": false, "serial_code_on_creation": false, "trash": false, "created": "2026-01-10T09:00:00", "updated": "2026-03-22T14:30:00", "cost": { "target": 72900, "average": 69471.44737498405 }, "technical_batch_qt": 10, "minimum_order_qt": 1, "process_phases": [ [ "phase-001", "phase-002" ] ], "production_notes": "Use calibrated torque wrench — see WI-042.", "throughput_time_target": 86400, "processing_time_target": 3600, "kpi_window_size": 30, "kpi_window_type": "count", "metadata": [ { "custom_field_key": "cf-001", "value": "RAL 9005", "label": "Surface Colour", "hint": "Select the RAL colour code" } ], "default_production_position_key": "pos-001", "default_consumption_position_key": "pos-002"
{
}
Responses
Successful Response
application/json
JSON "additionalProperties": "string"
{
}