Skip to main content
inputKitItemConversionComponentInput

Fields

componentItemId
ID!
required

Unique ID of the item to add as a component. The item must be eligible to become a kit component - an inactive item, an item that is itself a kit, a configuration item, a variation-combination parent and a partial-quantity item are all rejected - and it must not be the item being converted. The same item may appear only once in the list.

quantity
Decimal!
required

How many units of the component item one unit of the kit consumes. Must be greater than zero. A component item that is not divisible additionally rejects a fractional quantity.

comment
String

Free-text comment on the component. At most 255 characters. Omitting the field and sending an explicit null are equivalent - both store and return an empty string, never null.

position
Int

Zero-based position of the component within the kit's component list. Positions are applied one component at a time in request order, each as a move within the list, after every component has been added; a later move can shift a component placed earlier. When omitted, the component keeps the position it has in this request. The positions in the response are authoritative. A value outside the list bounds is clamped to the nearest end rather than rejected. Read "position" in the response to learn where it ended up.