App. Docs
Group
Categorise items with hierarchical groups. Use the Information tab to see totals like cost and an estimated valuation based on listing prices and approximate sales.
Setup
- Navigate to items page. From the item page or item edit page, groups can be created/edited via the group tree
- Give the group a clear name and optional colour. Colours help visually segment your catalog in tables and filters.
- Groups can be nested. Assign a parent group to build a hierarchy.
- Open the group menu and select Information to view cost and valuation totals for the group (and descendants).
Groups tree
On desktop, the groups tree appears in an expandable panel on the left of the Items table. On mobile, tap the page title to open a sheet that displays the groups tree.
Information tab
Metric
Total Cost
Sum of inventory cost for items inside the group hierarchy. This provides an instant view of your capital tied up in stock for the category.
Metric
Estimated Valuation
An estimate based on current listing prices and approximate sales/velocity. Use it to compare potential revenue against your total cost.
Attributes
group.schema.ts
1type Group = {
2 // Identity & audit
3 id: string; // uuid
4 modifiedAt?: Date;
5 modifiedById?: string; // uuid
6 modifiedByEmail?: string;
7 modifiedByEndpoint?: string;
8
9 // Company scoping
10 companyId: string; // uuid
11 company: Company;
12
13 // Core
14 name: string;
15 colour?: string;
16 fractionalIndexOrderKey: string; // ordering key
17
18 // Relations
19 products: Item[]; // direct child items
20 allDescendantProducts: Item[]; // items under this group recursively
21 parentGroupId?: string; // uuid
22 parentGroup?: Group | null;
23 childGroups: Group[];
24 descendantGroups: Group[];
25 ancestorGroups: Group[];
26}