Sign in
items

Mark an item as a preferred part

Sets or clears the preferred-part flag on an item. The flag is read-only everywhere else and can only be changed here.

put/v1/items/{id}/preferred

Path parameters

idstring required

Item ID

Request body

is_preferredboolean

Response

OK

{"stackTrail":"components:schemas:models.ItemDetailsResponse:properties:additional_data","oasType":"schema","type":"unknown","description":"Additional structured data (dynamic categories like assembly details, tolerances, etc.)"}
business_idstring

Business this item belongs to

categorystring

Product category

created_atstring

Timestamps

idstring

Item identification

is_preferredboolean

Whether this item is flagged as a preferred part

manufacturerstring

Manufacturer name

part_numberstring

Part number / MPN

referencesstring[]

Reference identifiers (standards, cross-referenced part numbers, etc.)

spec_comparison_not_on_calloutinteger

SpecComparisonNotOnCallout counts catalogue attributes the extraction model could read in principle but was never asked about on THIS item, because they do not appear on its callout illustration. Reported as one figure rather than as rows: a row for each would imply the model tried and failed, when it was never asked. Only meaningful alongside SpecComparison.

{"stackTrail":"components:schemas:models.ItemDetailsResponse:properties:three_d_specs","oasType":"schema","type":"unknown","description":"Per-document mesh-measured 3D geometry (oriented bbox / volume / surface\narea) from document_geometry_descriptors, materialized on items.three_d_specs.\nPresent only for model_extraction items with CAD geometry; drives the \"3D\"\ngroup on the item detail page. Raw JSON array (ThreeDSpec[] on the frontend)."}
titlestring

Item title/description

updated_atstring

Changes

No recorded changes to this endpoint across all 7 revisions of this API.