Examine rewards

Evaluates rewards assigned to a customer’s active Loyalty v2 program memberships. Use member_id to examine one membership only. Applies temporary customer and member metadata overrides without updating stored data. Returns reward availability by card, including points costs and applicable unavailability reasons.

POST /v2/loyalties/examine/rewards

Error

A valid request URL is required to generate request examples

200

{
  "customer": {
    "id": "cust_6onRrs4kCnvSVrTs5YtDPFBG",
    "source_id": "lx-rdmptr",
    "metadata": {
      "VIP": true
    },
    "object": "customer"
  },
  "rewards": [
    {
      "id": "lrew_128f4cab04147c8608",
      "name": "Free item coupon",
      "type": "DIGITAL",
      "metadata": {},
      "object": "reward"
    },
    {
      "id": "lrew_128f4c6710947c85d1",
      "name": "Minas Gerais 500",
      "type": "MATERIAL",
      "metadata": {},
      "object": "reward"
    },
    {
      "id": "lrew_1294cebb458e4904a0",
      "name": "Carioca shirt",
      "type": "MATERIAL",
      "metadata": {},
      "object": "reward"
    },
    {
      "id": "lrew_12b22d6ef31184e002",
      "name": "Carioca shorts",
      "type": "MATERIAL",
      "metadata": {},
      "object": "reward"
    },
    {
      "id": "lrew_12bb65405edf8d3dec",
      "name": "Carioca longsleeve",
      "type": "MATERIAL",
      "metadata": {},
      "object": "reward"
    }
  ],
  "memberships": [
    {
      "member": {
        "id": "lmbr_128f962dbc8c4ba5dc",
        "customer_id": "cust_6onRrs4kCnvSVrTs5YtDPFBG",
        "program_id": "lprg_128f58429f4c4bf7b2",
        "metadata": {},
        "object": "member"
      },
      "program": {
        "id": "lprg_128f58429f4c4bf7b2",
        "name": "AnnualProgram",
        "metadata": {},
        "object": "program"
      },
      "cards": [
        {
          "card": {
            "id": "lcrd_128f962dbd8c4ba5e1",
            "card_definition_id": "lcdef_128f4a88414c4bed69",
            "card_type": "INDIVIDUAL",
            "code": "AnnualTime-7M7ShPGfme",
            "object": "card"
          },
          "rewards": [
            {
              "reward": {
                "id": "lrew_128f4cab04147c8608",
                "object": "reward"
              },
              "status": "AVAILABLE",
              "cost": {
                "points": 300,
                "object": "reward_cost"
              },
              "object": "reward_estimation"
            },
            {
              "reward": {
                "id": "lrew_128f4c6710947c85d1",
                "object": "reward"
              },
              "status": "AVAILABLE",
              "cost": {
                "points": 150,
                "object": "reward_cost"
              },
              "object": "reward_estimation"
            },
            {
              "reward": {
                "id": "lrew_1294cebb458e4904a0",
                "object": "reward"
              },
              "status": "AVAILABLE",
              "cost": {
                "points": 500,
                "object": "reward_cost"
              },
              "object": "reward_estimation"
            }
          ],
          "object": "card_estimation"
        },
        {
          "card": {
            "id": "lcrd_128f962dbd8c4ba5df",
            "card_definition_id": "lcdef_128f495f720c4bec8c",
            "card_type": "INDIVIDUAL",
            "code": "SummerTime-7z8dWawICd",
            "object": "card"
          },
          "rewards": [
            {
              "reward": {
                "id": "lrew_12b22d6ef31184e002",
                "object": "reward"
              },
              "status": "UNAVAILABLE",
              "cost": {
                "points": 321,
                "object": "reward_cost"
              },
              "unavailability_reasons": [
                {
                  "reason": "insufficient_balance",
                  "details": {
                    "required": 321,
                    "available": 10,
                    "missing": 311
                  },
                  "object": "reward_unavailability_reason"
                }
              ],
              "object": "reward_estimation"
            }
          ],
          "object": "card_estimation"
        }
      ],
      "object": "member_rewards_opportunity"
    }
  ],
  "object": "rewards_examine_result"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

{
  "code": 404,
  "key": "not_found",
  "message": "Resource not found",
  "details": "Cannot find customer with id cust_6onRrs4kCnvSVrTs5YtDPFB",
  "request_id": "v-12c2e64d5d4a67cddc",
  "resource_id": "cust_6onRrs4kCnvSVrTs5YtDPFB",
  "resource_type": "customer"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

Authorizations

X-App-Id & X-App-TokenbearerAuth

X-App-Id · string · header · required

X-App-Token · string · header · required

Body

application/json

Request body for examining rewards.

customer_identification · object · required

Identifies the customer or loyalty member to examine.

Show child attributes

customer · object

Provides temporary customer metadata overrides for the examination. Merges them with stored metadata without updating the customer.

Show child attributes

member · object

Provides temporary member metadata overrides for the examination. Requires customer_identification.type to be member_id. Merges them with stored metadata without updating the member.

Show child attributes

Response

200

application/json

Rewards examination result

customer · object · required

Identifies the customer used for the examination.

Show child attributes

rewards · object[] · required

Lists rewards included in the returned card estimations.

Show child attributes

memberships · object[] · required

Reward opportunities per program membership.

Show child attributes

object · string · required

Object type marker. Always rewards_examine_result.

Allowed value: "rewards_examine_result"