SIGNALS Docs
Reader View

Related items

Offer or include catalogue items alongside a principal item, with separate quantities and prices.

Overview

Related items link catalogue items that are supplied together. A moving-head fixture might have a clamp, safety bond and power cable as related items. Each link records a quantity and whether the linked item is included automatically or supplied free.

Related items are distinct from kit components. Components describe a kit's bill of materials. Related items are offered or included alongside the principal item.

Route: /catalogue-items/{id}/related-items

The Related items tab lists the linked catalogue items, their type, quantity, inclusion flags and display order. Each row has Edit and Remove actions. Removing a link retires its composition identity; it does not delete the linked catalogue item.

Click Add related item, search the catalogue by name, select an item and enter its quantity and inclusion flags. An item cannot link to itself, repeat the same link, introduce a cycle or exceed the nesting depth limit.

Field Description
catalogue_item_id The principal catalogue item
related_catalogue_item_id The linked catalogue item
quantity Exact quantity per principal item, with up to two decimal places
included Automatically create a child line when the principal is added to a rental
included_free Give the child line an explicit zero price
sort_order Display order among the principal item's related items

included and included_free are independent. An included item uses its own normal price unless Included free is selected. An optional item is added manually; the free flag still applies when it is added from the captured definition.

Rental lines

Both automatic and manual related-item additions create rental lines with line_type: related_item. They have their own pricing and availability demand beneath the principal line. component remains the role for bill-of-materials lines.

Nested included items multiply exact quantities through the tree. Changing the principal quantity scales its automatically generated subtree; manual quantities remain independent. Removing the principal removes its subtree.

Each link has a stable logical identity. Reorder and edit preserve it, removal retires it, and restoring the relationship reuses it. Rental lines pin an immutable catalogue composition revision, so later catalogue edits do not alter their captured definitions. Clone and quote-version operations retain this composition and remap the parent line references.

API access

Related items use /api/v1/catalogue_items/{catalogueItem}/related_items and /related_items/{relatedItem} for list, create, update and delete operations. Responses use RelatedItemData, a related_item:<id> reference and the related_catalogue_item_id field. Catalogue-item responses and picker results expose related_items.

The list also accepts shared ID and timestamp filters, including filter[updated_at][gte] for incremental reads. Use include_deleted=true to include soft-deleted links; deleted_at identifies tombstones in list responses. A filter[deleted_at] condition also includes deleted links. The collection is not paginated.

Kit bill-of-materials operations continue to use /components and KitComponentData. See the API reference for request and response shapes.