Collection
object type
A collection — a consumer-facing curated or rule-driven grouping of Products (gift guides, seasonal edits). collectionType is canned + IMMUTABLE at birth: static = curated CollectionMember child records; dynamic = membership DERIVED from the stored predicate (stored + validated; EVALUATION is a deferred read-model slice, nothing evaluates yet). Member records on a dynamic collection are its PINS (manual-pins-first). inactive = STAGED/unpublished. NO per-org selection construct exists; decorations are first-class.
Fields
| Field | Type | Notes |
|---|---|---|
id | ID ID! | The record’s id — a UUID the platform assigned when the record was created; every reference to this record uses it. |
sysId | String String! | The group-scoped human-facing system id (CL-…). |
type | String String! | The kind of record — always Collection here. |
caption | String String! | The record’s display name — what people see it called. |
status | String String! | The FSM state: active | inactive | doomed. |
parentId | ID ID! | The parent org group; for a Collection parentId === rootId. |
rootId | ID ID! | The org-group family root. |
createdAt | String String! | When the record was created, as a UTC timestamp. |
updatedAt | String String! | When the record last changed, as a UTC timestamp. |
revisionNum | Int Int! | How many times this record has been edited; the first save is 0. |
revision | ID ID! | The OCC revision token — supply it on every mutation of this record; rotates on every write. |
refCaptions | RefCaption [RefCaption!]! | The server-composed captions of this record's declared references (the referenced-caption rule) — one row per referenced id; see RefCaption. |
collectionType | CollectionType CollectionType! | The canned collection kind — set at creation, IMMUTABLE thereafter. |
predicate | CollectionPredicate | The dynamic predicate. AND across supplied axes, OR within an axis; categoryIds match SUBTREES; evaluation is the deferred slice. |
excludedProductIds | ID [ID!] | Manual exclusions; wholesale-replace (an empty list releases); write-time-validated Product refs. |
sortMode | String | The canned sort mode. DYNAMIC only; stamped newest at create when omitted. |
code | String | Optional mutable merchant reference code; uniqueness NOT enforced. |