AlmondTill/G3N API

On this page

loyaltyLedger

query · in the family Reading your records

What it does

A loyalty member’s points history — every earn, redemption, and adjustment.

The LoyaltyPointsEntry ledger of ONE member, NEWEST-FIRST + bounded: 'limit' clamps server-side; 'before' = the prior page's oldest entry id (exclusive). With the member GET (cached pointsBalance — stamped in the SAME transaction as every entry) this IS the points story (earn/redeem/redeem_reversal/clawback/adjust, -ref'd to their orders/returns with per-line details). Requires authentication; the member is tenant-scoped server-side.

What happens

Reads only.

Who may call it

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

Arguments

NameTypeRequiredNotes
memberIdID ID!yesNo further notes.
limitIntnoHow many records to answer at most; a page may hold fewer.
beforeIDnoNo further notes.

Returns

LoyaltyPointsEntry [LoyaltyPointsEntry!]! — ONE immutable points fact: the SIGNED points figure IS the balance direction; the parent member's pointsBalance was stamped in the SAME transaction. Corrections are NEW adjust entries, never edits.

Example request

query ExampleLoyaltyLedger($memberId: ID!, $limit: Int) {
  loyaltyLedger(memberId: $memberId, limit: $limit) {
    id
    parentId
    entryType
    points
    reason
    orderId
    returnId
    caption
    createdAt
  }
}

Variables:

{
  "memberId": "01900000-0000-7000-8000-80d971ae0000",
  "limit": 1
}

Example response

{
  "data": {
    "loyaltyLedger": [
      {
        "id": "01900000-0000-7000-8000-37386ae00000",
        "parentId": "01900000-0000-7000-8000-065235280000",
        "entryType": "earn",
        "points": 1,
        "reason": "Correcting a miscount.",
        "orderId": "01900000-0000-7000-8000-f6d8263a0000",
        "returnId": "01900000-0000-7000-8000-4d4c03d20000",
        "caption": "Blue jeans",
        "createdAt": "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

Used in