getCustomerActivity

Retrieve a paginated, newest-first feed of the customer’s loyalty activity: point earnings, redemptions, and cashback rows combined into a single list.

Usage

MageSDK.getCustomerActivity({ limit: 20, offset: 0 }).then(function(resp) {
  if (resp.success) {
    resp.data.activity.forEach(function(row) {
      var value = MageSDK.formatSignedLoyaltyValue(
        row.points,
        resp.data.loyaltyMode,
        resp.data.currency
      );
      console.log(row.name, value);
    });
  }
});

Parameters

limit

number

default:"10"

Maximum number of rows to return.

offset

number

default:"0"

Number of rows to skip, for pagination.

Response

success

boolean

Whether the request was successful.

data.points

number

The customer’s current balance, in the shop’s loyalty unit.

data.pointsNextExpiryAt

string | null

When the next tranche of points expires, or null.

data.hasCashback

boolean

Whether the shop runs cashback. When true, cashback rows may appear in the feed.

data.activity

array

The activity rows.

Show Activity entry properties

string

The row ID.

type

string

"earning", "redemption", or "cashback".

name

string

A display name for the row.

points

number

The point value of the row (0 for cashback rows). Positive for earnings, representing the amount moved.

refundedPoints

number

Amount later reversed, if any.

status

string

Row status, e.g. "APPROVED", "EXPIRED", "PENDING", "REFUNDED", "PARTIALLY_REFUNDED".

createdAt

string

ISO 8601 timestamp of the event.

pointsExpiryAt

string | null

Expiry timestamp, set only for future-dated points drops.

amount

number

Cashback rows only. The money amount of the cashback.

refundedAmount

number

Cashback rows only. Any clawed-back portion.

currencySymbol

string

Cashback rows only. The currency symbol for amount.

data.pagination

object

{ hasMore, totalCount }. Use with offset to page through the feed.

data.content

object

Merchant-configured { greeting, description } copy for the activity block.

data.loyaltyMode

string

"points" or "store_credit". In store-credit mode points values are minor currency units. See Loyalty modes.

data.currency

string

The shop’s ISO currency code.

Sample response

{
  "success": true,
  "data": {
    "points": 450,
    "pointsNextExpiryAt": "2025-01-01T00:00:00.000Z",
    "hasCashback": false,
    "activity": [
      {
        "id": "cer_abc",
        "type": "earning",
        "name": "Points for purchase",
        "points": 150,
        "refundedPoints": 0,
        "status": "APPROVED",
        "createdAt": "2024-06-01T12:00:00.000Z",
        "pointsExpiryAt": null
      },
      {
        "id": "cr_abc",
        "type": "redemption",
        "name": "£5 off your next order",
        "points": 500,
        "refundedPoints": 0,
        "status": "USED",
        "createdAt": "2024-05-20T09:00:00.000Z",
        "pointsExpiryAt": null
      }
    ],
    "pagination": {
      "hasMore": false,
      "totalCount": 2
    },
    "content": {
      "greeting": "Your activity",
      "description": "Everything you've earned and redeemed."
    },
    "loyaltyMode": "points",
    "currency": "GBP"
  }
}

JavaScript SDK

Methods

Usage

Parameters

Response

Sample response

​Usage

​Parameters

​Response

​Sample response

Usage

Parameters

Response

Sample response