createLoyaltyMember

mutation · in the family Loyalty member

What it does

Create a new customer’s membership in your loyalty program at your organization.

ENROLL a LoyaltyMember into a program in the caller's org group.

Who may call it

Capability area: Selling — Ringing sales, serving customers and issuing invoices.

• Owner
• Manager
• Associate Manager
• Sales Associate
• Cashier
• An API key whose scope allows api:createLoyaltyMember

Arguments

Returns

LoyaltyMember LoyaltyMember! — A LoyaltyMember — ONE enrollment of ONE customer identity into ONE LoyaltyProgram (parentId = the program). Enrollment REQUIRES identity: the inline customer block with email REQUIRED (trim+lowercase-normalized — anonymous/walk-in cannot earn); the (program × normalized email) UNIQ marker reserves IN the create transaction — a LIVE holder refuses CONFLICT/MEMBER_EXISTS naming the holder (the email is never echoed), while a DOOMED member's identity RE-ENROLLS fresh (an identity is not a bearer money key — the explicit contrast with the instrument-code BURN). pointsBalance is the CACHED LoyaltyPointsEntry ledger sum (PK=LOYLEDGER#<memberId>), stamped in the SAME transaction as every entry (the / law), with every draw CONDITIONED balance ≥ draw — points NEVER go negative (CONFLICT/INSUFFICIENT_POINTS names live figures) and cap at 1000000000. Earn/redeem ride the Order PLACE transaction; cancel claws back IN the cancel transaction (spent-below-earned REFUSES the cancel); returns claw earn + restore redemption EXACTLY off the entries' per-line details in the refund flip transaction. adjustLoyaltyPoints is the ONLY manual points surface. Doom is gated by CONFLICT/BALANCE_OUTSTANDING while points remain (zero via reason-coded adjust FIRST); tier assignment is a manual edit v1.

Example request

mutation ExampleCreateLoyaltyMember($input: NewLoyaltyMemberInput!) {
  createLoyaltyMember(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    pointsBalance
    currentTier
    priceGroupId
    consumerId
  }
}

Variables:

{
  "input": {
    "caption": "Blue jeans",
    "programId": "01900000-0000-7000-8000-892c2b660000",
    "customer": {
      "name": "Blue jeans",
      "email": "<the person’s email address>"
    }
  }
}

Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.

Example response

{
  "data": {
    "createLoyaltyMember": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "LM-EXMP-0000-000F",
      "type": "LoyaltyMember",
      "caption": "Blue jeans",
      "status": "active",
      "parentId": "01900000-0000-7000-8000-065235280000",
      "rootId": "01900000-0000-7000-8000-a093dd800000",
      "createdAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "revisionNum": 1,
      "revision": "01900000-0000-7000-8000-b7960e180000",
      "pointsBalance": 1,
      "currentTier": "<current tier>",
      "priceGroupId": "01900000-0000-7000-8000-c7ffbf680000",
      "consumerId": "01900000-0000-7000-8000-6e8c92ec0000"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer

• VALIDATION/INVALID — Something in the request is not valid. (VALIDATION)
• AUTHN/REQUIRED — Sign in to do this. (AUTHN)
• AUTHZ/FORBIDDEN — Your role does not allow this action. (AUTHZ)
• RATE_LIMIT/THROTTLED — Too many requests in a short time. (RATE_LIMIT)
• NOT_FOUND/* — That record could not be found. (NOT_FOUND)
• CONFLICT/* — The record’s state, or a change made in the meantime, does not allow this; the codes are on the CONFLICT page. (CONFLICT)
• VALIDATION/VERSION_REQUIRED — The request did not say which app version it came from. (VALIDATION)

Dry run

Add dryRun: true to the request envelope (extensions.at) to rehearse this call: every check runs, the write is rehearsed against the current records and nothing is stored; the answer is the refusal a real call would give, or the record it would create. Every response to a rehearsal carries dryRun: true, so a rehearsed record is never mistaken for a saved one.

Used in

• Start a loyalty programme and enrol members