GET /

Get Product Data

GET

/product/{product_key}

Retrieve full product details including docs and counter.

Returns a ProductFull object for product_key, enriched with:

• docs: list of document files in the product doc folder.
• counter: the associated Counter document if counter_key is set.

Emits: (direct query — no event class)

Required scope: product:catalogue:read

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

string

Required

Responses

Successful Response

Content-Type

application/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",

  

"docs": [

  

  

{

  

  

  

"name": "assembly-drawing-rev-c.pdf",

  

  

  

"size": 204800

  

  

}

  

],

  

"img_name": "image.jpg",

  

"counter": {

  

  

"_id": "string",

  

  

"_key": "string",

  

  

"_rev": "string",

  

  

"name": "Work Order Counter",

  

  

"next_tick": 1,

  

  

"template": [

  

  

  

[

  

  

  

  

"WO-",

  

  

  

  

"%Y",

  

  

  

  

"-",

  

  

  

  

"%m",

  

  

  

  

"-"

  

  

  

]

  

  

],

  

  

"frequency": "month",

  

  

"reset_date": "2026-05-01T00:00:00Z"

  

}

}

Samples

Powered by VitePress OpenAPI