Skip to main content

Items

An Item is the fundamental unit in the GPM module. The item catalogue is the master register of everything the platform can sell, book, compare, or categorise — radiology procedures, insurance products, subscription plans, credit bundles, and the category nodes that organise them.

What an item contains

Identity

Each item has a human-readable item_key (e.g. RAD-CT, CAT-INS-HOME) plus up to three additional key segments for composite identification. The combination of these keys, the owning organisation, and the tenant is unique. Every item also has a display name and long description, both with internationalised (_i18n) counterparts for multi-language support.

Physical attributes

Items that represent physical goods carry unit-of-measure details (primary and secondary UOM), mass, volume, and three-dimensional measurements. Units of measure come from a central register, so the platform handles unit conversions consistently.

Behavioural flags

Behavioural flags describe how an item behaves in the system:

FlagMeaning
purchasedItem can be purchased
shippedItem can be shipped
stockedItem is held in inventory
transactedItem appears in transactions
assetItem is tracked as an asset
returnableItem can be returned

A radiology procedure, for example, would typically be flagged as transacted but not shipped or stocked.

Organisation and sourcing

Each item belongs to an owning organisation. Additional details track the inventory organisation (which warehouse holds stock) and the source — how and from where the item is obtained.

Lifecycle

Every item carries an effectivity window (start_date / end_date), an active flag for soft deletion, and standard audit details such as who created, updated, and owns the item.

Item types

Each item has an item type, such as CATEGORY, SERVICE, INSURANCE_PRODUCT, PLAN, or CREDIT_BUNDLE. These types are examples of the standard catalogue setup, not a fixed limit. The type list is extensible so new product and service domains can introduce item types that match their own catalogue needs.

Category items have an additional rule: once a category is used as a parent in the catalogue hierarchy, it remains a category. This protects the integrity of the category tree.

Ownership and authorisation

Each item belongs to an owning organisation, and access is controlled from that ownership. Within a tenant, items belonging to public catalogue types, such as categories, services, and insurance products, can also be visible to unauthenticated marketplace users.

Marketplace visibility

Items with types MERCHANT_CATEGORY, CATEGORY, SERVICE, or INSURANCE_PRODUCT — or items linked to a public price list — are visible to unauthenticated users. This allows the marketplace storefront to display catalogue items without requiring login.

Bulk import

Bulk import supports creating items in batches. An optional relationship field allows imported items to be linked to a parent category during import, and batch status information shows whether each import has been processed successfully.