get https://{host}/api_gateway/rewards/core/v1/brand/constraints
This API allows the brand to retrieve the details of the points restrictions set for the customer.
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
- Basic or OAuth Authentication
- Default access group
Resource information
| URI | api_gateway/rewards/core/v1/brand/constraints |
| 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/brand/constraints
Response parameters
| Parameter | Data Type | Description |
|---|---|---|
| rewardConstraintId | Integer | Unique identifier for the reward constraint |
| orgId | Integer | Identifier for the organization |
| kpi | String | The KPI on which the restriction is applied. Supported value: POINTS |
| constraintLevel | String | The level at which restrictions would be defined by org and applied on. Supported values: CUSTOMER_REDEMPTION_TYPE, CUSTOMER. Only one combination of Constraint_Level & KPI is allowed with the DAILY, WEEKLY, or MONTHLY frequency type. |
| frequencyType | String | The frequency at which the constraint is applied. Supported values: DAILY, WEEKLY, MONTHLY. |
| constraintLimitValue | Integer | The limit value for the constraint |
| isActive | Boolean | Status indicating whether the constraint is active |
| intervalValue | Integer | The interval at which the frequency is applied (daily) |
| status.success | Boolean | Indicates if the status check was successful |
| status.code | Integer | Status code associated with the constraint check |
| redemptionType | String | Type of redemption managed by this constraint |