Glossary
The notes brainstorm overloads a few words — especially "vendor." This page fixes precise meanings used everywhere in these docs and in the data models. When in doubt, use these terms, not "vendor."
The three things "vendor" could mean
| Term used in docs | Means | In the notes called | Data model |
|---|---|---|---|
| Channel partner (Dealer / Distributor / Retailer) | A partner who buys and resells your brand through the tiered network; has sales, targets, offers/bonuses, ledger | "vendor" | ChannelPartner (DMS) |
| Service partner | A franchise / 3rd-party org that performs service (install, repair, AMC) on your behalf | "service partners" | ServicePartner (FSM) |
| Supplier | An upstream company you buy raw goods / spares from (procurement) | (implied) | Supplier (Inventory) |
Rule of thumb: "vendor" in the notes almost always means channel partner / dealer. The word "vendor" is avoided in code and schemas.
Core terms
| Term | Definition |
|---|---|
| Tenant | One company (brand) running on the platform in its own deployment. UTL Solar is the first tenant. |
| Tenant Config Contract | The env + config schema that rebrands/configures the app per tenant. See Multi-Tenancy. |
| Asset | A specific, serial-numbered unit a customer owns (not a catalog SKU). Lives in the Warranty & Asset Registry. |
| External asset | A serviceable unit not sold by this tenant (e.g. a competitor's product) registered only to enable a paid service visit. |
| SKU / Variant | A sellable catalog entry (Medusa product variant). |
| Kit / BOM | A bundle of SKUs sold as one system (e.g. "3 kW solar system"). |
| AMC | Annual Maintenance Contract — a paid service agreement with scheduled preventive visits. |
| FSM | Field Service Management — tickets, scheduling, dispatch, technician app. |
| DMS | Dealer/Distribution Management System — the channel-partner side. |
| PIM | Product Information Management — rich catalog data. |
| OMS | Order Management System. |
| Primary sales | HQ → Distributor. Secondary sales = Distributor → Dealer/Retailer. |
| Commissioning | The step that completes an install (site survey → install → commissioning report → activation). |
| Warranty decisioning | The rule engine deciding in-warranty (free) vs out-of-warranty (paid) at point of service. |
| Short ID | Human-friendly public identifier (nanoid) for "My Products" / warranty cards, alongside the internal UUID v7. |
Storage-ownership shorthand
| Tag | Meaning |
|---|---|
| (PG) | Lives in PostgreSQL — owned by Medusa (commerce). |
| (Mongo) | Lives in MongoDB — owned by a NestJS domain service or Payload. |
| (Redis) | Cache / queue / session only. |
See Polyglot Data Stores for the full ownership map.