AlmondTill/G3N API

On this page

loyaltyProgram

query · in the family Loyalty program

What it does

Look up one record — your loyalty program — how customers earn and redeem points.

A LoyaltyProgram by id, within the caller's OWN org-group family; requires authentication. A cross-tenant id reads as null (not-found) AND trips the rootId tripwire server-side.

What happens

Reads only — changes nothing.

Who may call it

Capability area: Reading your records — Looking up and listing the records of your organization.

Arguments

NameTypeRequiredNotes
idID ID!yesThe id of the record.

Returns

LoyaltyProgram — A LoyaltyProgram — the points engine's GROUP-scoped rule master: members EARN points on net merchandise spend (floor(base × earnRate.points ÷ earnRate.perMinor) — floor ONCE at the order level over the FINAL post-redemption discounted taxable bases, storedValue lines excluded) and REDEEM them as a PRE-TAX DISCOUNT at the step-2 position 4 (source=loyalty LINE entries — after manual → coupon → promotion; the taxonomy law: loyalty is a DISCOUNT, categorically NOT a tender — no loyalty tender type exists). currency is EXPLICIT + IMMUTABLE at birth (a group's orgs may differ in defaultCurrency — orders in another currency refuse the attach; FX = the deferral). Earn multipliers COMPOUND multiplicatively across three families — tier × active bonus window × MAX(matching predicate rows, never stacked) — each family ≤ 8 rows. Org participation is the canned-pool selection (organizationIds ABSENT = every org in the group). The effective window is half-open [startAt, endAt) — an EVALUATION gate, never FSM states. At most 8 ACTIVE per org group. Doom is -gated by non-doomed members (doom the members first); deactivate stays FREE. Tier ASSIGNMENT is a manual member edit v1 (the auto-evaluation sweeper is a NAMED deferral); points expiry/transfer, redemption caps, ecom/non-sale loyalty and fraud velocity are the NAMED deferrals.

Example request

query ExampleLoyaltyProgram($id: ID!) {
  loyaltyProgram(id: $id) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    currency
    organizationIds
    startAt
    endAt
  }
}

Variables:

{
  "id": "01900000-0000-7000-8000-37386ae00000"
}

Example response

{
  "data": {
    "loyaltyProgram": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "LP-EXMP-0000-000F",
      "type": "LoyaltyProgram",
      "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",
      "currency": "USD",
      "organizationIds": [
        "01900000-0000-7000-8000-60e064dc0000"
      ],
      "startAt": "2027-01-31T00:00:00.000Z",
      "endAt": "2027-01-31T00:00:00.000Z"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": null,
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer