Get all brand rewards using Brand ID

This API is used to retrieve list of rewards owned by brands based on filters.

👍

Note

For detailed information about our APIs and for hands-on testing, refer documentation in API overview and step-by-step guide on making your first API call in Make your first API call .

Prerequisites

  • Authentication: Basic or OAuth authentication
  • Default access group

Resource information

URIapi_gateway/rewards/core/v1/reward/list/brand/{BrandID}
HTTP MethodGET
PaginationYes Default - 100
Batch supportNo
Rate limit informationNone

API endpoint example

https://eu.api.capillarytech.com/api_gateway/rewards/core/v1/reward/list/brand/1?page=0&size=20&redemptionType=MILES&rewardName=gold&vendorIds=18,19

Request path parameters

Parameter NameData TypeDescription
brandId*StringUnique identifier of the brand.

Request query parameters

Parameter NameData TypeDescription
PageIntegerAllows to retrieve details of a specific page.
SizeLongResults to show per page. Default - 100
ownerTypeEnumModule for which the reward was created. Supported values: Loyalty program, Milestones, Campaigns, Journeys, Goodwill.
ownerIdStringUnique identifier of the owner to claim the reward.
startDateLongStart date of the reward. Any rewards between the specified start and end date will be displayed. If either the start or end date falls within the timeline, the reward will still be included in the response. If the start date is used as a filter, the end date must also be specified, and vice versa. Format for startDate is in epoch.
rewardStatusEnumIndicates the current state of the reward. Supported values:
LIVE: The reward is currently available for redemption.
UPCOMING: The reward will be available in the future.
ENDED: The reward is no longer available.
vendorIdsIntegerA collection of identifiers for vendors associated with the reward. Multiple vendorIds are supported by a comma (","). For example: VendorIds=36,32. There is no specific limit on the number of vendorIds.
redemptionTypeEnumSpecifies the category of reward redemption available. It indicates how users can redeem the reward. Supported values: GAMES, AUCTION, CART_PROMOTION, CASH_WALLET, VENDOR_ONLY_REWARD, VOUCHER, CASH_BACK, INTOUCH_REWARD, PHYSICAL_REWARD, CHARITY, MILES, GIFT_CARD, SWEEPSTAKES, VENDOR_INTOUCH_REWARD, CARD_DISC.
rewardNameStringThe name of the reward which was created. rewardName supports Partial Search. Users can search for a reward using part of its name, and results that match the partial input will be returned. For example: Searching for "Gold" could return "Gold Star Reward" or "Golden Points".
enabledBooleanA boolean indicating whether the reward is currently active or inactive for users.
https://eu.api.capillarytech.com/api_gateway/rewards/core/v1/reward/list/brand/1?page=0&size=20&startDate=1727254620000&endDate=1752244980000&rewardType=CHARITY&rewardStatus=LIVE

Response parameters

ParameterDescription
statusObject containing the status of the reward details
successIndicates if the operation was successful
codeStatus code of the operation
messageStatus message
rewardListList of rewards
idUnique identifier of the reward. This is the reward ID which was generated during reward creation.
nameName of the reward
startTimeStart time of the reward availability
endTimeEnd time of the reward availability
typeType of the reward.
priorityPriority of the reward
enabledIndicates if the reward is enabled
intouchPointsPoints required for the reward
redemptionTypeType of redemption for the reward
customFieldsCustom fields for additional information
statusIndicates the current state of the reward. Example: LIVE, UPCOMING, ENDED
intouchSeriesIdCoupon series ID or cart promotion ID when intouch reward is selected.
vendorIdUnique ID of the vendor.
vendorNameName of the vendor.
vendorRedemptionIdUnique vendor redemption ID which was generated from this API.
vendorRedemptionNameName of the vendor redemption.
lastUpdatedOnDate on which the Reward was last updated.
lastUpdatedByName of the user by which the Reward was last updated.
ownersList of owners of the reward
ownerTypeModule for which the reward was created.
ownerIdUnique identifier of the owner to claim the reward.
pagingDtoThe object containing paging details
paymentConfigsThe list of payment mode supported by the reward.
groupsAn array containing information about groups and rewards associated with reward.
lastIndicates if it is the last page
totalElementsTotal number of elements
totalPagesTotal number of pages
numberOfElementsNumber of elements in the current page
firstIndicates if it is the first page
sizeThe number of items or records returned in a single API response.
numberCurrent page number
{
    "status": {
        "success": true,
        "code": 6101,
        "message": "Reward details fetched successfully"
    },
    "rewardList": [
        {
            "id": 20867,
            "name": "name_first",
            "startTime": "2024-11-01 03:53:01",
            "endTime": "2027-01-15 07:26:45",
            "type": "VOUCHER",
            "priority": 1,
            "enabled": true,
            "intouchPoints": 1,
            "redemptionType": "SWEEPSTAKES",
            "customFields": {},
            "owners": null,
            "paymentConfigs": [
                {
                    "paymentMode": "CASH",
                    "id": 813,
                    "cash": 25.0000
                }
            ],
            "groups": [
                {
                    "groupName": "groupName014",
                    "groupRank": 8
                }
            ],
            "rewardRank": 10,
            "status": "UPCOMING",
            "intouchSeriesId": null,
            "vendorRedemptionId": 1627,
            "vendorRedemptionName": "demo vendor for physicalReward",
            "vendorId": 17,
            "vendorName": "testVendor002",
            "lastUpdatedOn": 1725359777000,
            "lastUpdatedBy": null
        }
    ],
    "pagingDto": {
        "last": true,
        "totalElements": 1,
        "totalPages": 1,
        "numberOfElements": 1,
        "first": true,
        "size": 10,
        "number": 0
    }
}
{
    "status": {
        "success": true,
        "code": 6101,
        "message": "Reward details fetched successfully"
    },
    "rewardList": [
        {
            "id": 265893,
            "name": "testreward1",
            "startTime": "2024-11-14 06:11:00",
            "endTime": "2025-07-11 14:43:00",
            "type": "VOUCHER",
            "priority": 1,
            "enabled": true,
            "intouchPoints": 500,
            "redemptionType": "INTOUCH_REWARD",
            "customFields": {
                "testdate": "2020-01-01 01:01:01",
                "CF1": "Custom field 1"
            },
            "owners": [
                {
                    "ownerType": "LOYALTY_PROGRAM",
                    "ownerId": "469"
                }
            ],
            "paymentConfigs": [
                {
                    "paymentMode": "FREE",
                    "id": 1955
                }
            ],
            "groups": [],
            "rewardRank": 1,
            "status": "LIVE",
            "intouchSeriesId": "415446",
            "vendorRedemptionId": null,
            "vendorRedemptionName": null,
            "vendorId": null,
            "vendorName": null,
            "lastUpdatedOn": 1731564635000,
            "lastUpdatedBy": null
        },
        {
            "id": 265892,
            "name": "testreward1",
            "startTime": "2024-11-14 06:10:00",
            "endTime": "2025-07-11 14:43:00",
            "type": "VOUCHER",
            "priority": 1,
            "enabled": true,
            "intouchPoints": 500,
            "redemptionType": "INTOUCH_REWARD",
            "customFields": {
                "testdate": "2020-01-01 01:01:01",
                "CF1": "Custom field 1"
            },
            "owners": [
                {
                    "ownerType": "LOYALTY_PROGRAM",
                    "ownerId": "469"
                }
            ],
            "paymentConfigs": [
                {
                    "paymentMode": "POINTS",
                    "id": 1954,
                    "points": 100.0000
                }
            ],
            "groups": [],
            "rewardRank": 1,
            "status": "LIVE",
            "intouchSeriesId": "415446",
            "vendorRedemptionId": null,
            "vendorRedemptionName": null,
            "vendorId": null,
            "vendorName": null,
            "lastUpdatedOn": 1731564549000,
            "lastUpdatedBy": null
        },
        {
            "id": 265891,
            "name": "testreward1",
            "startTime": "2024-11-14 06:08:00",
            "endTime": "2025-07-11 14:43:00",
            "type": "VOUCHER",
            "priority": 1,
            "enabled": true,
            "intouchPoints": 500,
            "redemptionType": "INTOUCH_REWARD",
            "customFields": {
                "testdate": "2020-01-01 01:01:01",
                "CF1": "Custom field 1"
            },
            "owners": [
                {
                    "ownerType": "LOYALTY_PROGRAM",
                    "ownerId": "469"
                }
            ],
            "paymentConfigs": [
                {
                    "paymentMode": "POINTS",
                    "id": 1953,
                    "points": 100.0000
                }
            ],
            "groups": [],
            "rewardRank": 1,
            "status": "LIVE",
            "intouchSeriesId": "415446",
            "vendorRedemptionId": null,
            "vendorRedemptionName": null,
            "vendorId": null,
            "vendorName": null,
            "lastUpdatedOn": 1731564479000,
            "lastUpdatedBy": null
        }
    ],
    "pagingDto": {
        "last": true,
        "totalElements": 3,
        "totalPages": 1,
        "numberOfElements": 3,
        "first": true,
        "size": 20,
        "number": 0
    }
}
{
    "status": {
        "success": false,
        "code": 3004,
        "message": "Brand not found"
    }
}

API-specific error codes

Error codeDescription
3004Brand not found
Language
Credentials
Basic
base64
:
URL
Click Try It! to start a request and see the response here!