Get redeemed reward’s details

Management This method returns detailed information about a specific Reward.

get

Authorizations

AuthorizationstringRequired

Open Loyalty has the JWT authorization. To learn what a JSON Web Token is and how it works, check out Introduction to JSON Web Tokens https://jwt.io/introduction/

Obtain an access token

Send a request with the parameters username and password

Definition

POST /api/admin/login_check Go to definition
POST /api/{storeCode}/member/login_check Go to definition

Example

curl {HOST}/api/admin/login_check
    -H 'Content-Type: application/json;charset=UTF-8'
    -H 'Accept: application/json, text/plain, */*'
    --data-binary '{"username":"admin","password":"password"}'

Example Response

{
    "token":"eyJhbGciOiJSUzI1NiIsInR5cCI6...",
    "refresh_token":"0558f8bb29948c4e54c443f..."
}

Using JSON Web Token

Add authorization header to each request
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...
You can now access any API method you want under the /api prefix.

Example

curl {HOST}/api/{storeCode}/analytics/members
    -H 'Accept: application/json'
    -H 'Content-type: application/x-www-form-urlencoded'
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...'

Refresh JSON Web Token

You can refresh token using refresh_token that was given during login.
There are two endpoints
To refresh admin token POST /api/token/refresh Go to definition
To refresh member token POST /api/{storeCode}/token/refresh Go to definition

Path parameters

storeCodestringRequired

Store code

rewardstring · uuidRequired

Reward ID

Responses

200

Returned when successful

application/json

rewardstringOptional

namestringOptional

levelsstring · uuid[]Optional

segmentsstring · uuid[]Optional

categoriesstring · uuid[]Optional

brandIconbooleanOptional

rewardIdstring · uuidOptional

targetstring · enumOptionalPossible values:

activebooleanOptional

costInPointsnumberOptional

taxnumberOptional

taxPriceValuenumberOptional

pricenumberOptional

featuredbooleanOptional

publicbooleanOptional

photosobject[]Optional

createdAtstring · date-timeOptional

notIssuedCouponsnumberOptional

fulfillmentTrackingbooleanOptionalDeprecated

couponValuenumberOptional

usageLeftnumberOptionalDeprecated

usageLeftForCustomernumberOptionalDeprecated

401

Unauthorized

application/json

403

Forbidden.

application/json

404

Not found.

application/json

get/api/{storeCode}/reward/{reward}

GET /api/{storeCode}/reward/{reward} HTTP/1.1
Host: openloyalty.localhost
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "reward": "text",
  "name": "text",
  "levels": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "segments": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "categories": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "brandIcon": true,
  "rewardId": "123e4567-e89b-12d3-a456-426614174000",
  "target": "level",
  "active": true,
  "costInPoints": 1,
  "activity": {
    "allTime": true
  },
  "visibility": {
    "allTime": true
  },
  "tax": 1,
  "taxPriceValue": 1,
  "price": 1,
  "labels": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "featured": true,
  "public": true,
  "photos": [
    {}
  ],
  "createdAt": "2026-01-01T00:00:00.000Z",
  "usageLimit": {
    "general": 1,
    "perUser": 1
  },
  "notIssuedCoupons": 1,
  "limitUsages": {
    "general": {
      "interval": {
        "type": "calendarHours"
      },
      "currentValue": 1,
      "limitValue": 1
    },
    "perMember": {
      "interval": {
        "type": "calendarHours"
      },
      "currentValue": 1,
      "limitValue": 1
    }
  },
  "translations": [
    {
      "name": "text",
      "id": 1,
      "locale": "text"
    }
  ],
  "couponGenerator": {
    "length": 1,
    "characterSet": "text"
  },
  "couponValue": 1,
  "segmentNames": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "levelNames": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "categoryNames": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "unitsConversion": {
    "ratio": 1,
    "rounding": "up"
  },
  "customFields": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  },
  "fortuneWheel": {
    "rules": [
      {
        "name": "text",
        "description": "text",
        "effects": [
          {
            "effect": "give_reward",
            "rewardId": "6a861f8a-6906-4002-8b9c-4db407e810ea",
            "couponValueRule": "23"
          }
        ],
        "chance": 0.5
      }
    ],
    "limits": {
      "points": {
        "interval": {
          "type": "days"
        },
        "value": 1
      },
      "pointsPerMember": {
        "interval": {
          "type": "days"
        },
        "value": 1
      },
      "executionsPerMember": {
        "interval": {
          "type": "days"
        },
        "value": 1
      }
    }
  }
}