Sign in

This API retrieves the configurations and rules associated with how customers can redeem points for discounts, coupons, or other rewards.

get/api/v4.0/integrations/configurations/redemption

Query parameters

customerIdstring

Unique identifier for the customer that you can reference across the customer's whole lifetime. Could be a database ID, random string, email or anything that uniquely identifies the customer. If provided, the API will return redemption configurations that match the customer based on various criteria, such as RFM, tiers, segments and specific customer attributes. This approach ensures that the redemption options are personalized and relevant to each customer's unique profile and engagement history.

Response

Redemption configurations retrieved successfully

redemptionFactornumber

This factor indicates the value of each loyalty point in terms of currency, defining how many currency units can be obtained by redeeming points. Example: If the redemptionFactor is set to 0.1, this means that a customer can redeem 10 points for 1 USD.

Example response

{
  "redemptionFactor": 0.1,
  "redemptionRules": [
    {
      "id": 2138,
      "pointsToRedeem": 100,
      "valueOfPoint": 25,
      "ruleType": "percentage_discount_settings",
      "coupon": {
        "couponType": "percentage_discount",
        "discountValue": 25,
        "collections": [
          {
            "collectionId": "455218036961",
            "collectionName": "Automated Collection"
          }
        ],
        "options": {
          "name": "Redemption Rule Name",
          "expiryAfter": 14,
          "usageLimit": 2,
          "capping": 50,
          "minOrderValue": 150,
          "codePrefix": "SUMMER",
          "redeemInstructions": "Enter the coupon code at checkout to apply the discount."
        }
      },
      "image": "https://s3.us-east-2.amazonaws.com/gameball.stg.uploads/uploads%2fClient_2933%2f936f65d8-e06d-4e28-b423-b5282999801bgameball.webp",
      "creationDate": "2025-02-10T10:12:16.783408",
      "isActive": true
    }
  ]
}

Changes

Changed in 2 of the 38 revisions of this API.11