App. Docs
Item
The catalog entity that groups variants and provides global context like supplier, groups, tags, and listings.
Setup
- Navigate to Items and click “New Item”.
- Enter a concise item name. Use Tags for alternate names and keywords.
- Optionally add item options (e.g., Size, Color). Variants will be auto-generated.
- Assign a supplier, parent group, and image as needed.
- Save the item. You can refine variants, listings, and tags at any time.
Tip
Attributes
1type Item = {
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 options?: Json; // e.g. option definitions used to generate variants
16 note?: string; // rich text/plain notes
17 customFields?: Json; // user-defined fields
18 fractionalIndexOrderKey: string; // ordering key
19 salesChannelStaging?: boolean; // stage data before syncing to channels
20
21 // Hierarchy & grouping
22 groups: Group[]; // ancestor groups
23 parentGroupId?: string; // uuid
24 parentGroup?: Group | null;
25
26 // Discovery
27 tags: string[]; // used across all searches to strengthen discoverability
28
29 // Relations
30 variants: Variant[];
31 supplierId?: string; // uuid
32 supplier?: Supplier | null;
33 imageId?: string; // uuid
34 image?: File | null;
35 listings: Listing[];
36}Tags
Tags are an array of strings on the item used by all search experiences in the app. They allow the item name to stay concise while still making the item highly discoverable.
- Include alternate names, synonyms, abbreviations, and common misspellings.
- Add model/part numbers, supplier SKUs, and regional naming variations.
- Prefer short phrases (1–3 words). Avoid duplicating the item name.
- Case-insensitive; order doesn’t affect relevance.
Search Strength
Relations
An item groups one or more Variants. Inventory is tracked at the variant level. Items can be organized into Groups, linked to a Supplier (coming to docs), and surfaced on channels via Listings.
FAQ
Changelog
feat(variant): move packSize from item to variant
- Supports different pack sizes for variants under the same item (e.g., single, case of 6).
- Keeps inventory and deductions accurate at the sellable unit level.
feat(naming): rename Product to Item
- More general terminology so the app isn’t e‑commerce locked.
- Clearer across industries while preserving the same data model and relations.
