Get brand-specific rewards

This API is used to retrieve details of an active reward for a particular brand.

For example: A brand configures a reward for their customer to earn. Through this API, the brands can check the active rewards configured for their customers.

๐Ÿ‘

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/user/reward/{reward Id}/brand/{brand name}
HTTP MethodGET
PaginationNo
Batch supportNo
Rate limit informationNone

API endpoint example

https://eucrm.cc.capillarytech.com/api_gateway/core/v1/user/reward/112295/brand/1

Request path parameters

Parameter NameData TypeDescription
rewardId*StringUnique identifier of the reward. Ex: 112295
brandName*StringName of the brand the reward is associated with. Ex: 1

Request query parameters

Parameter NameData TypeDescription
userIdStringUnique identifier of the user.
languageStringEnter the language code. Ex: en,ja,fr
https://eucrm.cc.capillarytech.com/api_gateway/rewards/core/v1/reward/112295/brand/1

Response parameters

Parameter NameData TypeDescription
successBooleanIndicates the success of the operation
codeIntegerResponse code indicating the status
messageStringDescription of the status
idIntegerUnique identifier for the reward
nameStringName of the reward
descriptionStringDescription of the reward
imageIdStringIdentifier for the reward image
imageUrlStringURL for the reward image
thumbnailIdStringIdentifier for the reward thumbnail image
thumbnailUrlStringURL for the reward thumbnail image
termAndConditionsIdStringIdentifier for the terms and conditions document
termAndConditionsUrlStringURL for the terms and conditions document
customFieldsObjectList of custom fields.
customFieldNameStringName of the custom field.
customFieldValueStringValue of the custom field.
tierStringTier of the reward
labelStringLabel of the reward
priorityIntegerPriority level of the reward
intouchPointsIntegerPoints associated with the reward
groupIntegerGroup associated with the reward
startTimeStringStart time of the reward availability
endTimeStringEnd time of the reward availability
expiredBooleanIndicates if the reward is expired
startedBooleanIndicates if the reward has started
programIdStringProgram ID associated with the reward
categoryListArrayList of categories associated with the reward
customFieldsObjectCustom fields associated with the reward
loyaltyProgramCriteriaArrayCriteria for loyalty programs related to the reward
restrictionsObjectRestrictions associated with the reward
appliedPromotionsArrayList of promotions applied to the reward
groupNameStringName of the group
groupRankIntegerRank of the group
rewardRankIntegerRank of the reward.
rewardRevenueMetaObjectAn object with commission details for different participants over specific periods.
commissionParticipantEnumThe entity receiving the commission. Supported values: BRAND, CAPILLARY, AFFILIATE, END_CUSTOMER
commissionRateFloatThe amount of commission to be received.
cycleStartDateDateStart date of the commission cycle.
Note: cycleStartDate should be greater than rewardStartDate. cycleStartDate must be in the future.
cycleEndDateDateEnd date of the commission cycle.
Note: cycleEndDate should smaller than rewardEndDate.
cycleEndDate must be in the future
rewardRevenueDefaultsObjectAn object with the default commission.
commissionParticipantEnumThe entity receiving the commission.
For example: BRAND, CAPILLARY, AFFILIATE, END_CUSTOMER
defaultValueFloatDefault commission rate associated with the participant.
Note: If no defaultValue is passed, then 0 is considered as the defaultValue.
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
{
    "status": {
        "success": true,
        "code": 200,
        "message": "User Reward fetched successfully"
    },
    "reward": {
        "id": 55569,
        "name": " INTOUCH Enabled",
        "description": "Description",
        "imageId": "EXDR12987U",
        "imageUrl": "https://s3.amazonaws.com/crm-nightly-new-solutions/SAHANA_TEST/EXDR12987U?X-Amz-Security-Token=FwoGZXIvYXdzEJb%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDEu2rutCUosWODgElCLWAROqCDmZoUYA%2F%2Bakh15X42%2F2Xh9GI9b6mOtS6lLWDrr7S%2FAtN8nn609PikuPK3rMRxvzTHIycuGmi4juQxbTczqVZ0SNOKqqVNn39zeVPRvHSgcPAA7diMAfMGw%2FIXs16U0StXdrv1C3e66Owy2eFIKp7h4arAU2%2FD7OM%2BeiPdVUgUKzJXfO0d%2B0n6mmaMJQpu8G5NTFgI141VHBTkw9Lp8T8yfWM1GZBak6Nsu4s8%2B4itIYC8MWmAYDzzKv1rR41zHeUdAnYo%2F%2BhbZ48fGzMkp9JSpjsrMogtj5sAYyLQ6kov4CAMbYPGmLE%2FzXmMAlfLw54EB8VthljGWuy4IU%2BmNkV02QcsETNnRz1A%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240416T122507Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAXCQYYRKNDLJXJIOJ%2F20240416%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=64c4b5034f4921e47913b1cee564b6f0be26d6c58e62b313ff3336a027b29d83",
        "thumbnailId": "EXDR12987T",
        "thumbnailUrl": "https://s3.amazonaws.com/crm-nightly-new-solutions/SAHANA_TEST/EXDR12987T?X-Amz-Security-Token=FwoGZXIvYXdzEJb%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDEu2rutCUosWODgElCLWAROqCDmZoUYA%2F%2Bakh15X42%2F2Xh9GI9b6mOtS6lLWDrr7S%2FAtN8nn609PikuPK3rMRxvzTHIycuGmi4juQxbTczqVZ0SNOKqqVNn39zeVPRvHSgcPAA7diMAfMGw%2FIXs16U0StXdrv1C3e66Owy2eFIKp7h4arAU2%2FD7OM%2BeiPdVUgUKzJXfO0d%2B0n6mmaMJQpu8G5NTFgI141VHBTkw9Lp8T8yfWM1GZBak6Nsu4s8%2B4itIYC8MWmAYDzzKv1rR41zHeUdAnYo%2F%2BhbZ48fGzMkp9JSpjsrMogtj5sAYyLQ6kov4CAMbYPGmLE%2FzXmMAlfLw54EB8VthljGWuy4IU%2BmNkV02QcsETNnRz1A%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240416T122507Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAXCQYYRKNDLJXJIOJ%2F20240416%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=59ae499e5e14e605770ec83e94ef447eddddded6f6aaf2689397e34376105048",
        "termAndConditionsId": "EXDR12987R",
        "termAndConditionsUrl": "https://s3.amazonaws.com/crm-nightly-new-solutions/SAHANA_TEST/EXDR12987R?X-Amz-Security-Token=FwoGZXIvYXdzEJb%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDEu2rutCUosWODgElCLWAROqCDmZoUYA%2F%2Bakh15X42%2F2Xh9GI9b6mOtS6lLWDrr7S%2FAtN8nn609PikuPK3rMRxvzTHIycuGmi4juQxbTczqVZ0SNOKqqVNn39zeVPRvHSgcPAA7diMAfMGw%2FIXs16U0StXdrv1C3e66Owy2eFIKp7h4arAU2%2FD7OM%2BeiPdVUgUKzJXfO0d%2B0n6mmaMJQpu8G5NTFgI141VHBTkw9Lp8T8yfWM1GZBak6Nsu4s8%2B4itIYC8MWmAYDzzKv1rR41zHeUdAnYo%2F%2BhbZ48fGzMkp9JSpjsrMogtj5sAYyLQ6kov4CAMbYPGmLE%2FzXmMAlfLw54EB8VthljGWuy4IU%2BmNkV02QcsETNnRz1A%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240416T122507Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAXCQYYRKNDLJXJIOJ%2F20240416%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=5578821948fc0405ee2d9761515ecb2b78f28c2bb0cc60ffe2a0b77c92910a16",
        "tier": "SILVER",
        "label": null,
        "priority": 1,
        "intouchPoints": 0,
        "group": null,
        "startTime": "2024-04-09 21:05:30",
        "endTime": "2024-11-29 11:09:49",
        "expired": false,
        "started": true,
        "programId": null,
        "categoryList": [],
        "customFields": {},
        "loyaltyProgramCriteria": [],
        "rewardRestrictions": {
            "isValid": true
        },
        "appliedPromotions": [],
        "groupName": null,
        "groupRank": null,
        "rewardRank": null,
        "images": [],
        "videos": [],
        "rewardRevenueDetails": {
            "brandCommission": 0,
            "endCustomerCommission": 0
        },
        "paymentConfigs": [
            {
                "paymentMode": "CASH",
                "id": 8,
                "cash": 500.0000
            }
        ]
    }
}

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!