Get reward details by ID

This API retrieves a reward's details using the reward ID.

๐Ÿ‘

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

API Specification

URI/api_gateway/rewards/core/v1/reward/{rewardId}/brand/{brandId}
HTTP MethodGET
PaginationNo
Batch supportNo
Rate limit informationNone

API endpoint example

https://eucrm.cc.capillarytech.com/api_gateway/core/v1/reward/55724/brand/47

Request path parameters

Parameter NameData TypeDescription
rewardId*StringUnique identifier of the reward. Ex: 112295
brandId*StringYou can use the API and retrieve the brand ID of your brand.
https://eucrm.cc.capillarytech.com/api_gateway/core/v1/reward/55724/brand/47

Response parameters

ParameterDatatypeDescription
successBooleanIndicates whether the request was successful
codeIntegerStatus code associated with the response
messageStringDescriptive message about the response status
idIntegerUnique identifier for the reward
typeEnumType of the reward.
Supported values: POINTS, VOUCHER, PHYSICAL_VOUCHER, FREE_VOUCHER.
startDateStringStart date and time of the reward's validity
endDateStringEnd date and time of the reward's validity
enabledBooleanIndicates if the reward is currently enabled
priorityIntegerPriority of the reward, used for sorting or processing
intouchPointsIntegerThe number of points customers need to burn to purchase the reward.
intouchSeriesIdStringCoupon series ID or cart promotion ID when intouch reward is selected.
tierStringTier classification of the reward, e.g., SILVER
redemptionTypeEnumType of intouch reward or vendor reward.
Supported values: INTOUCH_REWARD, VENDOR_INTOUCH_REWARD, VENDOR_ONLY_REWARD, CART_PROMOTION.
vendorIdIntegerIdentifier for the vendor associated with the reward
vendorRedemptionIntegerRedemption value or code at the vendor
languageSpecificInfoArrayArray of objects containing language-specific details
nameStringName of the reward in a specific language
descriptionStringDescription of the reward in a specific language
termNConditionsIdStringID for the terms and conditions associated with the reward
termNConditionsUrlStringURL to the terms and conditions document
imageIdStringIdentifier for the main image associated with the reward
imageUrlStringURL to the main image associated with the reward
thumbnailIdStringIdentifier for the thumbnail image associated with the reward
thumbnailUrlStringURL to the thumbnail image associated with the reward
enabledBooleanIndicates if the language-specific information is enabled
customFieldsObjectObject containing key-value pairs for custom fields specific to the reward
paymentConfigsObjectThe paymentConfigs object includes the type of payment mode used to purchase the reward. The ID is the unique identifier for the payment mode configuration used.
paymentModeEnumThe type of payment mode used to redeem the reward.
For example: POINTS, FREE, CASH, POINTS_CASH, CONV_RATIO.
idIntegerUnique identifier for the payment configuration
segmentObjectCustomer Segmentation is a logical grouping of audiences based on shared characteristics. Segments are used to tailor the marketing efforts of brands effectively. For more information on segments refer here .
segmentIdIntegerSegment ID is a unique identifier used to retrieve specific segment information.
partitionIdIntegerThe Partition ID is a unique identifier used to retrieve information. You can pass one or more Partition IDs to access the desired data.

{
    "status": {
        "success": true,
        "code": 6001,
        "message": "Reward fetched successfully"
    },
    "reward": {
        "id": 55724,
        "type": "POINTS",
        "startDate": "2024-04-10 11:51:50",
        "endDate": "2025-11-29 11:09:49",
        "enabled": true,
        "priority": 1,
        "intouchPoints": 0,
        "intouchSeriesId": null,
        "tier": "SILVER",
        "group": null,
        "tillId": null,
        "programId": null,
        "label": null,
        "redemptionType": "MILES",
        "vendorId": 138,
        "vendorRedemption": 5166,
        "communications": null,
        "categories": null,
        "geography": null,
        "languageSpecificInfo": [
            {
                "rewardId": 55724,
                "languageCode": "en",
                "name": " INTOUCH Enabled",
                "description": "Description",
                "termNConditionsId": "EXDR12987R",
                "termNConditionsUrl": "https://s3.amazonaws.com/crm-nightly-new-solutions/testOrg_marvel_20230822_147/EXDR12987R?X-Amz-Security-Token=FwoGZXIvYXdzEJX%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDDNv4AWezGCyejIFzyLWAciB8nJGUyt8yBSJ5x%2FZlBibuImGQnnmrAMjyZA9tBEjbZFaZ7V835gOKe0U5UygwArf%2BCq3xbk273ZXUt4MWI1W9DhFAm995OGvDZbo8hOaSSvYfcKZNa0X7UWLI2tnG1gotqVFrbRAbQfJWqNv5Gm7GTn%2BQFVVP2t4izxO49H0UfuZNNLwUAxQ70FYv7sdjnvMyPO7iC9TOQf969pKOIeJOTvGxrNk%2FR5x5LA430cVikg02XBAsRKIoXiDaaN5Qldyxtaxg7uVB%2B1He%2FUCZOmlHdilXl0on8f5sAYyLaeq749YY2Vo%2BOGBMuh0jByX4fFwG5RZFWfYoBb8aYnFfWCBkjBkmp9hf%2BAskA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240416T114015Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAXCQYYRKNO2RXSZOF%2F20240416%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=66d511a22d270ede7df418849ee351433701390d95b57f58a808ebcc3003631c",
                "imageId": "EXDR12987U",
                "imageUrl": "https://s3.amazonaws.com/crm-nightly-new-solutions/testOrg_marvel_20230822_147/EXDR12987U?X-Amz-Security-Token=FwoGZXIvYXdzEJX%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDDNv4AWezGCyejIFzyLWAciB8nJGUyt8yBSJ5x%2FZlBibuImGQnnmrAMjyZA9tBEjbZFaZ7V835gOKe0U5UygwArf%2BCq3xbk273ZXUt4MWI1W9DhFAm995OGvDZbo8hOaSSvYfcKZNa0X7UWLI2tnG1gotqVFrbRAbQfJWqNv5Gm7GTn%2BQFVVP2t4izxO49H0UfuZNNLwUAxQ70FYv7sdjnvMyPO7iC9TOQf969pKOIeJOTvGxrNk%2FR5x5LA430cVikg02XBAsRKIoXiDaaN5Qldyxtaxg7uVB%2B1He%2FUCZOmlHdilXl0on8f5sAYyLaeq749YY2Vo%2BOGBMuh0jByX4fFwG5RZFWfYoBb8aYnFfWCBkjBkmp9hf%2BAskA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240416T114015Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3599&X-Amz-Credential=ASIAXCQYYRKNO2RXSZOF%2F20240416%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=06e6d6d0ed4d9a6ed35c470dd7b850b64e05e9d296536cb540973d4ca52567d7",
                "thumbnailId": "EXDR12987T",
                "thumbnailUrl": "https://s3.amazonaws.com/crm-nightly-new-solutions/testOrg_marvel_20230822_147/EXDR12987T?X-Amz-Security-Token=FwoGZXIvYXdzEJX%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDDNv4AWezGCyejIFzyLWAciB8nJGUyt8yBSJ5x%2FZlBibuImGQnnmrAMjyZA9tBEjbZFaZ7V835gOKe0U5UygwArf%2BCq3xbk273ZXUt4MWI1W9DhFAm995OGvDZbo8hOaSSvYfcKZNa0X7UWLI2tnG1gotqVFrbRAbQfJWqNv5Gm7GTn%2BQFVVP2t4izxO49H0UfuZNNLwUAxQ70FYv7sdjnvMyPO7iC9TOQf969pKOIeJOTvGxrNk%2FR5x5LA430cVikg02XBAsRKIoXiDaaN5Qldyxtaxg7uVB%2B1He%2FUCZOmlHdilXl0on8f5sAYyLaeq749YY2Vo%2BOGBMuh0jByX4fFwG5RZFWfYoBb8aYnFfWCBkjBkmp9hf%2BAskA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240416T114015Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAXCQYYRKNO2RXSZOF%2F20240416%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=5deeab87c79a60b4b66c13a9c9f7279c05048e9a0b3e2da7c134c8c95f7f2be9",
                "enabled": true,
                "images": [],
                "videos": [],
                "customFields": {
                    "047e": "defaultValue",
                    "fe8b": "defaultValue",
                    "9c9d": "defaultValue",
                }
            }
        ],
        "customFields": {
            "047e": "defaultValue",
            "fe8b": "defaultValue",
        },
        "owners": null,
        "supplementaryCriteriaRO": [],
        "groupName": null,
        "groupRank": null,
        "rewardRank": null,
        "restrictions": null,
        "rewardRevenueMeta": [],
        "rewardRevenueDefaults": [],
        "paymentConfigs": [
            {
                "paymentMode": "CONV_RATIO",
                "id": 11,
                "conversionRatio": 0.3300
            }
        ]
    }
}
{
    "status": {
        "success": true,
        "code": 6001,
        "message": "Reward fetched successfully"
    },
    "reward": {
        "id": 10345,
        "type": "FREE_VOUCHER",
        "startDate": "2027-08-04 16:07:33",
        "endDate": "2030-07-13 13:28:34",
        "enabled": true,
        "priority": 1,
        "intouchPoints": 0,
        "intouchSeriesId": "1137472",
        "tier": "SILVER",
        "group": null,
        "tillId": null,
        "programId": null,
        "label": null,
        "redemptionType": "INTOUCH_REWARD",
        "vendorId": null,
        "vendorRedemption": null,
        "communications": [
            4
        ],
        "categories": [
            5
        ],
        "geography": [
            {
                "countryId": 7,
                "cityId": 0,
                "areaId": 0,
                "longitude": null,
                "latitude": null
            }
        ],
        "languageSpecificInfo": [
            {
                "rewardId": 10345,
                "languageCode": "en",
                "name": " English",
                "description": "Description",
                "termNConditionsId": "EXDR12987R",
                "termNConditionsUrl": "https://s3.us-west-2.amazonaws.com/devenv-crm-solutionsvannnld9gg/marvel_automation/EXDR12987R?X-Amz-Security-Token=FwoGZXIvYXdzEFYaDAmO5%2BOghhq7tkfHQCLcAU0KD0%2FoSaHi86uZqwwKnlyLLLkav2HoSiu8fCORqjfjG%2BmvR5IWPKr9dO0CbPgegVzS7IaAtZrg4kWxT5YLFoNU%2FYrYHrkq9XvYFdAKE6PtORKL0TjkSJwI05AROBYNi1CSsW8fbEGL%2F7L835wni987cDSGA36w7kG2i7vQjKf%2BnEWTw27lZBFX8owsIReRh9rbUEBV%2F21TTxWfyJ7TG9D%2BbCLY2%2FPFLa8xaUZrAUJJhHq1Rvyat8NC3XrmoOTxHcugqC1aXO9WmFuuHTI%2FXs9ze4q8Tct9XV9BTm8ojvaEswYyLe%2FjCMXncDG%2FJA6HTe7taQ9dz93IQ%2BpP1yTcXkwzwPClp3gVE0JiMXoBqjUh9g%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240606T044027Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAXCQYYRKNP4ICX5WD%2F20240606%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Signature=82f9c88bb9ec8afe4cc8d973c1887beb2356605aa2099d6c03e6a7c60b104175",
                "imageId": "EXDR12987U",
                "imageUrl": "https://s3.us-west-2.amazonaws.com/devenv-crm-solutionsvannnld9gg/marvel_automation/EXDR12987U?X-Amz-Security-Token=FwoGZXIvYXdzEFYaDAmO5%2BOghhq7tkfHQCLcAU0KD0%2FoSaHi86uZqwwKnlyLLLkav2HoSiu8fCORqjfjG%2BmvR5IWPKr9dO0CbPgegVzS7IaAtZrg4kWxT5YLFoNU%2FYrYHrkq9XvYFdAKE6PtORKL0TjkSJwI05AROBYNi1CSsW8fbEGL%2F7L835wni987cDSGA36w7kG2i7vQjKf%2BnEWTw27lZBFX8owsIReRh9rbUEBV%2F21TTxWfyJ7TG9D%2BbCLY2%2FPFLa8xaUZrAUJJhHq1Rvyat8NC3XrmoOTxHcugqC1aXO9WmFuuHTI%2FXs9ze4q8Tct9XV9BTm8ojvaEswYyLe%2FjCMXncDG%2FJA6HTe7taQ9dz93IQ%2BpP1yTcXkwzwPClp3gVE0JiMXoBqjUh9g%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240606T044027Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAXCQYYRKNP4ICX5WD%2F20240606%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Signature=6cd4bb990abbcb9d82820379519087a1a996ca874b7d6d4c353c50b762f4838c",
                "thumbnailId": "EXDR12987T",
                "thumbnailUrl": "https://s3.us-west-2.amazonaws.com/devenv-crm-solutionsvannnld9gg/marvel_automation/EXDR12987T?X-Amz-Security-Token=FwoGZXIvYXdzEFYaDAmO5%2BOghhq7tkfHQCLcAU0KD0%2FoSaHi86uZqwwKnlyLLLkav2HoSiu8fCORqjfjG%2BmvR5IWPKr9dO0CbPgegVzS7IaAtZrg4kWxT5YLFoNU%2FYrYHrkq9XvYFdAKE6PtORKL0TjkSJwI05AROBYNi1CSsW8fbEGL%2F7L835wni987cDSGA36w7kG2i7vQjKf%2BnEWTw27lZBFX8owsIReRh9rbUEBV%2F21TTxWfyJ7TG9D%2BbCLY2%2FPFLa8xaUZrAUJJhHq1Rvyat8NC3XrmoOTxHcugqC1aXO9WmFuuHTI%2FXs9ze4q8Tct9XV9BTm8ojvaEswYyLe%2FjCMXncDG%2FJA6HTe7taQ9dz93IQ%2BpP1yTcXkwzwPClp3gVE0JiMXoBqjUh9g%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240606T044027Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAXCQYYRKNP4ICX5WD%2F20240606%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Signature=718254d3655b22979763c052e7f1c43aefa31ad9d37a7051641d777b30c83431",
                "enabled": true,
                "images": [],
                "videos": [],
                "customFields": {
                    "46720fba2024-05-30 11:42:29.850638": "defaultValue"
                }
            }
        ],
        "customFields": {
            "46720fba2024-05-30 11:42:29.850638": "defaultValue"
        },
        "owners": null,
        "supplementaryCriteriaRO": [],
        "groupName": null,
        "groupRank": null,
        "rewardRank": null,
        "restrictions": null,
        "rewardRevenueMeta": [],
        "rewardRevenueDefaults": [],
        "paymentConfigs": null,
        "segment": [
            {
                "segmentId": "6136",
                "partitionId": [
                    "2675"
                ]
            }
        ]
    }
}

API-specific error codes

Error CodeDescription
6004Reward not found or disabled
Language
Authorization
Basic
base64
:
URL
Click Try It! to start a request and see the response here!