adjustLoyaltyPoints

mutation · in the family Refunds and payment corrections

What it does

Manually add or remove a customer’s loyalty points, with a reason.

ADJUST a member's points — the privileged manual correction: a SIGNED non-zero delta + the REQUIRED reason post ONE adjust entry + the CONDITIONED cached-balance apply (below-zero refuses CONFLICT/INSUFFICIENT_POINTS naming live figures; the ceiling refuses VALIDATION/INVALID). active|inactive targets only (CONFLICT/REF_STATE on doomed). Requires the unrestricted capability + the record's CURRENT revision.

What happens

Posts a signed points entry to the customer’s loyalty ledger — the history keeps every entry.

Careful

Points are a customer-facing promise. Adjustments are visible in the ledger and cannot be silently undone.

Who may call it

Capability area: Refunds and payment corrections — Refunds, corrective notes and voiding invoices.

Owner
Manager
Associate Manager
An API key whose scope allows api:adjustLoyaltyPoints

Arguments

Name	Type	Required	Notes
`memberId`	ID `ID!`	yes	No further notes.
`revision`	ID `ID!`	yes	The revision id you read on the record; the change is refused if an edit landed in the meantime.
`points`	Int `Int!`	yes	No further notes.
`reason`	String `String!`	yes	No further notes.

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 ExampleAdjustLoyaltyPoints($memberId: ID!, $revision: ID!, $points: Int!, $reason: String!) {
  adjustLoyaltyPoints(memberId: $memberId, revision: $revision, points: $points, reason: $reason) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    pointsBalance
    currentTier
    priceGroupId
    consumerId
  }
}

Variables:

{
  "memberId": "01900000-0000-7000-8000-80d971ae0000",
  "revision": "01900000-0000-7000-8000-b7960e180000",
  "points": 1,
  "reason": "Correcting a miscount."
}

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

Example response

{
  "data": {
    "adjustLoyaltyPoints": {
      "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)

Used in

Start a loyalty programme and enrol members