App. Docs
Stock Status
Company-scoped labels that classify stock into operational states. Drive filtering, counts, and delivery workflows.
Defaults
When a company is created, three stock statuses are provisioned by default: New, Sold, and Drafted. You can add more and customize names and colours per company.
Types
A status has a type which drives logic and grouping:
- AVAILABLE: Counted as sellable/available to promise.
- ON_ORDER: Inbound pipeline (e.g., purchase orders). Sequenced for delivery actions.
- UNAVAILABLE: Not sellable (e.g., damaged, quarantined, reserved, sold).
Sequencing for ON_ORDER
ON_ORDER statuses participate in a company-level sequence stored on the Company (e.g., StockStatusSequence), including thresholds used by delivery workflows. Actions can be configured to occur before/after each threshold to reflect your receiving process (booked, dispatched, received, QA, shelved).
Attributes
stock-status.schema.ts
1type StockStatus = {
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 // Display & behavior
14 name: string;
15 colour?: string;
16 type: StockStatusType; // AVAILABLE | ON_ORDER | UNAVAILABLE
17
18 // Relations
19 stocks: Stock[];
20}