This API allows you to retrieve rewards that are available to be linked to an catalog promotion.

👍
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


URI	/api_gateway/rewards/core/v1/reward/brand/{brandId}/available
HTTP Method	GET
Pagination	No
Batch support	No
Rate limit information	None

API endpoint example

https://eucrm.cc.capillarytech.com/api_gateway/rewards/core/v1/reward/brand/1/available

Request path parameters

Parameter Name	Data Type	Description
brandId*	String	You can use the API and retrieve the brand ID of your brand.

Request query parameters

Parameter Name	Data Type	Description
startDate	Date Time	The start date of the reward.
endDate	Date Time	the end date of the reward.

https://eucrm.cc.capillarytech.com/api_gateway/rewards/core/v1/reward/brand/1/available?startDate=2022-04-20T08:55Z&endDate=2022-11-30T08:55Z

Response parameters

Parameter Name	Data Type	Description
success	Boolean	Indicates if the operation was successful.
code	Integer	The HTTP status code of the operation.
message	String	Descriptive message about the operation's outcome.
id	Integer	Unique identifier for each reward.
name	String	Name of the reward.
startTime	DateTime	Start time and date for the reward's validity.
endTime	DateTime	End time and date for the reward's validity.
type	String	Type of reward.
priority	Integer	Priority level of the reward.
enabled	Boolean	Indicates if the reward is active.
intouchPoints	Integer	The number of points customers need to burn to purchase the reward.
redemptionType	String	Type of redemption for the reward.
groupName	String	Name of the group associated with the reward.
groupRank	Integer	Rank of the group associated with the reward.
rewardRank	Integer	Rank of the reward within its category or program.
customFields	Object	Custom fields associated with the reward.
status	Enum	Indicates the current state of the reward. Example: LIVE, UPCOMING, ENDED

{
    "status": {
        "success": true,
        "code": 6101,
        "message": "Reward details fetched successfully"
    },
    "rewardList": [
        {
            "id": 1,
            "name": "Test Marvel",
            "startTime": "2021-04-30 13:35:15",
            "endTime": "2022-05-30 15:55:55",
            "type": "VOUCHER",
            "priority": 1,
            "enabled": false,
            "intouchPoints": 1,
            "redemptionType": "INTOUCH_REWARD",
            "groupName": null,
            "groupRank": null,
            "rewardRank": null,
            "customFields": {}
        },
        {
            "id": 2,
            "name": "Test Marvel 2",
            "startTime": "2021-05-03 13:35:15",
            "endTime": "2022-05-14 21:25:55",
            "type": "VOUCHER",
            "priority": 2,
            "enabled": false,
            "intouchPoints": 1,
            "redemptionType": "INTOUCH_REWARD",
            "groupName": null,
            "groupRank": null,
            "rewardRank": null,
            "customFields": {}
        },
        {
            "id": 3,
            "name": "Test Marvel 3",
            "startTime": "2021-05-03 15:35:15",
            "endTime": "2022-05-14 21:25:55",
            "type": "VOUCHER",
            "priority": 3,
            "enabled": false,
            "intouchPoints": 1,
            "redemptionType": "INTOUCH_REWARD",
            "groupName": null,
            "groupRank": null,
            "rewardRank": null,
            "customFields": {}
        },
        {
            "id": 4,
            "name": "10% off on clothing",
            "startTime": "2021-05-10 18:45:14",
            "endTime": "2023-12-11 07:29:14",
            "type": "VOUCHER",
            "priority": 1,
            "enabled": false,
            "intouchPoints": 100,
            "redemptionType": "INTOUCH_REWARD",
            "groupName": null,
            "groupRank": null,
            "rewardRank": null,
            "customFields": {}
        },
        {
            "id": 7,
            "name": "15% off on Skinny Jeans",
            "startTime": "2021-05-10 18:50:08",
            "endTime": "2023-05-11 18:29:08",
            "type": "VOUCHER",
            "priority": 2,
            "enabled": false,
            "intouchPoints": 200,
            "redemptionType": "INTOUCH_REWARD",
            "groupName": null,
            "groupRank": null,
            "rewardRank": null,
            "customFields": {}
        },
        {
            "id": 8,
            "name": "200 off on shirts",
            "startTime": "2021-05-10 18:54:18",
            "endTime": "2023-12-29 13:29:18",
            "type": "VOUCHER",
            "priority": 3,
            "enabled": false,
            "intouchPoints": 500,
            "redemptionType": "INTOUCH_REWARD",
            "groupName": null,
            "groupRank": null,
            "rewardRank": null,
            "customFields": {}
        },
        {
            "id": 9,
            "name": "Flat 50% off on shoes",
            "startTime": "2021-05-10 19:13:16",
            "endTime": "2023-12-31 12:43:16",
            "type": "VOUCHER",
            "priority": 4,
            "enabled": false,
            "intouchPoints": 300,
            "redemptionType": "INTOUCH_REWARD",
            "groupName": null,
            "groupRank": null,
            "rewardRank": null,
            "customFields": {}
        },
        {
            "id": 10,
            "name": "10% off on Shoes & Accessories",
            "startTime": "2021-05-11 06:59:42",
            "endTime": "2023-12-31 17:59:42",
            "type": "VOUCHER",
            "priority": 5,
            "enabled": false,
            "intouchPoints": 350,
            "redemptionType": "INTOUCH_REWARD",
            "groupName": null,
            "groupRank": null,
            "rewardRank": null,
            "customFields": {}
        },
        {
            "id": 11,
            "name": "Free Perfume",
            "startTime": "2021-05-11 07:04:00",
            "endTime": "2023-12-31 03:04:00",
            "type": "VOUCHER",
            "priority": 6,
            "enabled": false,
            "intouchPoints": 450,
            "redemptionType": "INTOUCH_REWARD",
            "groupName": null,
            "groupRank": null,
            "rewardRank": null,
            "customFields": {}
        },
        {
            "id": 12,
            "name": "Baseball Caps",
            "startTime": "2021-05-11 07:05:38",
            "endTime": "2023-12-31 07:05:38",
            "type": "VOUCHER",
            "priority": 7,
            "enabled": false,
            "intouchPoints": 150,
            "redemptionType": "INTOUCH_REWARD",
            "groupName": null,
            "groupRank": null,
            "rewardRank": null,
            "customFields": {}
        },
        {
            "id": 749,
            "name": "Cart Promotion",
            "startTime": "2022-07-27 04:51:59",
            "endTime": "2029-11-21 19:21:59",
            "type": "VOUCHER",
            "priority": 1,
            "enabled": false,
            "intouchPoints": 100,
            "redemptionType": "CART_PROMOTION",
            "groupName": null,
            "groupRank": null,
            "rewardRank": null,
            "customFields": {}
        },
        {
            "id": 1922,
            "name": "Demo Promo",
            "startTime": "2022-10-19 05:23:40",
            "endTime": "2029-11-14 01:23:40",
            "type": "VOUCHER",
            "priority": 12,
            "enabled": false,
            "intouchPoints": 50,
            "redemptionType": "INTOUCH_REWARD",
            "groupName": null,
            "groupRank": null,
            "rewardRank": null,
            "customFields": {}
        },
        {
            "id": 1923,
            "name": "Marvel Demo for CS HUB",
            "startTime": "2022-10-19 05:54:10",
            "endTime": "2022-10-31 05:54:10",
            "type": "VOUCHER",
            "priority": 1,
            "enabled": false,
            "intouchPoints": 200,
            "redemptionType": "INTOUCH_REWARD",
            "groupName": null,
            "groupRank": null,
            "rewardRank": null,
            "customFields": {}
        },
        {
            "id": 2271,
            "name": "test1234",
            "startTime": "2022-10-20 12:09:40",
            "endTime": "2032-11-18 08:09:40",
            "type": "VOUCHER",
            "priority": 1,
            "enabled": false,
            "intouchPoints": 300,
            "redemptionType": "INTOUCH_REWARD",
            "groupName": null,
            "groupRank": null,
            "rewardRank": null,
            "customFields": {}
        },
        {
            "id": 5156,
            "name": "BELANJA50",
            "startTime": "2022-10-31 21:16:26",
            "endTime": "2032-11-24 10:16:26",
            "type": "VOUCHER",
            "priority": 1,
            "enabled": false,
            "intouchPoints": 3000,
            "redemptionType": "INTOUCH_REWARD",
            "groupName": null,
            "groupRank": null,
            "rewardRank": null,
            "customFields": {}
        },
        {
            "id": 6221,
            "name": "Personal Stylist for 1 Visit",
            "startTime": "2022-11-05 10:25:12",
            "endTime": "2032-08-18 00:55:12",
            "type": "VOUCHER",
            "priority": 1,
            "enabled": false,
            "intouchPoints": 150,
            "redemptionType": "INTOUCH_REWARD",
            "groupName": null,
            "groupRank": null,
            "rewardRank": null,
            "customFields": {}
        },
        {
            "id": 7581,
            "name": "Free Name Embroiding",
            "startTime": "2022-11-10 13:39:45",
            "endTime": "2026-11-17 19:39:45",
            "type": "VOUCHER",
            "priority": 1,
            "enabled": false,
            "intouchPoints": 150,
            "redemptionType": "INTOUCH_REWARD",
            "groupName": null,
            "groupRank": null,
            "rewardRank": null,
            "customFields": {}
        }
    ]
}

Get available brand rewards

👍
Note

Prerequisites

Resource information

API endpoint example

Request path parameters

Request query parameters

Response parameters

👍Note

Prerequisites

Resource information

API endpoint example

Request path parameters

Request query parameters

Response parameters

👍
Note