# Consumer

object type

A Consumer — the B2C SHOPPER identity: WHO shops, as a per-merchant-group person (parentId === rootId — NOT a global identity; federated cross-merchant identity is the lock's flagged-not-now). B2C-SIMPLE INLINE: the NORMALIZED login email + displayName + bounded phones + the inline address book (≤16; shipping/billing roles + at most ONE default per side). the identity-marker rule: the (group × normalized email) UNIQ marker AMONG LIVE HOLDERS IS the login index — a live/suspended holder refuses CONFLICT/IDENTITY_TAKEN; ⚠ on erase (doom) the identifiers BURN within the group. FSM = the identity-family roster: active ⇄ suspended (the merchant abuse/fraud hold: punitive, ≠ the operational admin-pause; sessions go INERT via the live-status gate, reactivation restores) → doomed via erase (the DE-IDENTIFICATION terminal — PII scrub machinery lands; v1 the marker burns). Credentials NEVER ride this record; self-service rides the CONSUMER SESSION channel (consumerRegister/consumerLogin + the CONSUMER_SESSION_OPERATIONS roster); staff manage via THIS face. SEARCHABLE (the customer-book law). priceGroupId = the binding — the SUPERSEDE carrier: a consumer-named order resolves eligibility HERE, present-or-absent, NO member fall-through.

## Fields

| Field | Type | Notes |
| --- | --- | --- |
| `id` | [ID](/types/#scalars) `ID!` | The record’s id — a UUID the platform assigned when the record was created; every reference to this record uses it. |
| `sysId` | [String](/types/#scalars) `String!` | The group-scoped human-facing system id (CN-…). |
| `type` | [String](/types/#scalars) `String!` | The kind of record — always `Consumer` here. |
| `caption` | [String](/types/#scalars) `String!` | The record’s display name — what people see it called. |
| `status` | [String](/types/#scalars) `String!` | The FSM state: active \| suspended \| doomed. |
| `parentId` | [ID](/types/#scalars) `ID!` | The parent org group; for a Consumer parentId === rootId. |
| `rootId` | [ID](/types/#scalars) `ID!` | The org-group family root. |
| `createdAt` | [String](/types/#scalars) `String!` | When the record was created, as a UTC timestamp. |
| `updatedAt` | [String](/types/#scalars) `String!` | When the record last changed, as a UTC timestamp. |
| `revisionNum` | [Int](/types/#scalars) `Int!` | How many times this record has been edited; the first save is 0. |
| `revision` | [ID](/types/#scalars) `ID!` | The OCC revision token — supply it on every mutation of this record; rotates on every write. |
| `refCaptions` | [RefCaption](/types/RefCaption/) `[RefCaption!]!` | The server-composed captions of this record's declared references (the referenced-caption rule) — one row per referenced id; see RefCaption. |
| `email` | [String](/types/#scalars) `String!` | The login identity — stored NORMALIZED (trim + lowercase, the class); the (group × email) UNIQ marker rides it. |
| `displayName` | [String](/types/#scalars) | The shopper display name; absent ⇒ the caption carries the identity line (the normalized email). |
| `phones` | [String](/types/#scalars) `[String!]!` | Contact phones — bounded (≤4); may be empty. A supplied list REPLACES WHOLESALE on edit. |
| `addresses` | [ConsumerAddress](/types/ConsumerAddress/) `[ConsumerAddress!]!` | The inline B2C address book — bounded (≤16); at most ONE default per side across the book; a supplied book REPLACES WHOLESALE on edit. |
| `priceGroupId` | [ID](/types/#scalars) | The CustomerPriceGroup binding. Gated in-tenant + ACTIVE at set; a group dying AFTER assignment DEGRADES at evaluation (never a cart-killing throw). Optional + editable. |
| `tagIds` | [ID](/types/#scalars) `[ID!]` | The Tag attachment set — wholesale-replace list, empty releases; absent = untagged. STAFF custody (the priceGroupId law): each ref gated in-tenant + ACTIVE; a tag with live wearers cannot be doomed. The segment tag axis reads it. |
| `locale` | [String](/types/#scalars) | Preferred locale — canonical BCP-47 core (the ONE / locale shape, case-canonical STRICT: ll / ll-CC / ll-Ssss\[-CC]); the i18n resolution consumes it. |
| `displayCurrency` | [String](/types/#scalars) | DISPLAY-ONLY currency preference (ISO-4217 alpha-3, SHAPE + SET membership since): render prices in this currency where a conversion exists. ⚠ NEVER an evaluation input — carts/orders/documents stay org-currency. |
| `dateOfBirth` | [String](/types/#scalars) | Date-only YYYY-MM-DD, calendar-real, ≥ 1900-01-01; the not-in-the-future half rides the KIT write gate. Drives the age-restricted-sale gate WHEN that builds (data-only now — the named deferral) + the birthday registries. |
| `commsFrequency` | [String](/types/#scalars) | Contact-cadence preference AMONG CONSENTED channels — immediate \| daily \| weekly \| monthly (canned v1 registry; enforcement = the comms build's named deferral). |
| `commsFormat` | [String](/types/#scalars) | Message-format preference — plain \| rich (canned v1 registry). |
| `commsTopics` | [String](/types/#scalars) `[String!]` | Comms topic interests ('about what') — ≤ 16, each trimmed 1..64; a supplied list REPLACES WHOLESALE on edit (the book law). |
| `interests` | [String](/types/#scalars) `[String!]` | General interest tags (the segment raw material) — ≤ 16, each trimmed 1..64; a supplied list REPLACES WHOLESALE on edit. |
| `preferredLogicalFacilityId` | [ID](/types/#scalars) | The preferred store/LF: gated in-tenant + ACTIVE LF at write (the priceGroupId gate class); an LF dying LATER degrades at read — never a profile-killing throw. |

## Used by

- [consumer](/reference/consumer/consumer/)
- [createConsumer](/reference/consumer/createConsumer/)
- [eraseConsumer](/reference/consumer/eraseConsumer/)
- [suspendConsumer](/reference/consumer/suspendConsumer/)
- [unsuspendConsumer](/reference/consumer/unsuspendConsumer/)
- [updateConsumer](/reference/consumer/updateConsumer/)