Skip to main content
inputAddKitItemComponentCommandRequestInput

Fields

itemId
ID!
required

Unique ID of the item whose kit is extended.

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 kit item itself.

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. Applied after the component has been added; defaults to the end of the list. A value outside the list bounds is clamped to the nearest end rather than rejected - this is intentional and mirrors the domain, where the desktop client moves a component with the same clamping logic. Read the Position of the response to learn where it ended up.

idempotencyKey
String

Client-supplied idempotency key. When provided, a repeated request with the same key and payload replays the original result instead of re-executing the mutation.