get https://{host}/api_gateway/rewards/core/v1/promotion//brand/
This API is used to get the details of a particular catalog promotion for a particular brand.
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/promotion/{promotion Id}/brand/{brand Id} |
| 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/promotion/2/brand/1
Request path parameters
| Parameter | Data Type | Description |
|---|---|---|
| promotionId* | String | Unique ID of promotion. Ex: 2 |
| brandId* | String | You can use the API and retrieve the brand ID of your brand. |
https://eucrm.cc.capillarytech.com/api_gateway/rewards/core/v1/promotion/2/brand/1
Response parameters
| Parameter | Data Type | Description |
|---|---|---|
| success | Boolean | Indicates if the request was successful |
| code | Integer | Status code |
| message | String | Status message |
| id | Integer | Unique identifier of the promotion |
| name | String | Name of the promotion |
| orgId | Integer | Organization ID associated with the promotion |
| isEnabled | Boolean | Indicates if the promotion is enabled |
| startTime | String | Start time of the promotion |
| endTime | String | End time of the promotion |
| discountType | String | Type of discount |
| discountValue | Float | Value of the discount |
| lastUpdatedOn | String | Last update time of the promotion |
| createdOn | String | Creation time of the promotion |
| lastUpdatedBy | Integer | ID of the user who last updated the promotion |
| createdBy | Integer | ID of the user who created the promotion |
| languageCode | String | Language code |
| name | String | Name of the promotion in specific language |
| description | String | Description in specific language |
| enabled | Boolean | Indicates if the promotion is enabled in this language |
| createdBy | Integer | ID of the user who created the language-specific info |
| createdOn | String (DateTime) | Creation time of the language-specific info |
| lastUpdatedBy | Integer | ID of the user who last updated the language-specific info |
| lastUpdateOn | String (DateTime) | Last update time of the language-specific info |
| customFields | Object | Custom fields associated with the promotion |
| id | Integer | Unique identifier of the reward |
| rewardId | Integer | Specific reward ID |
| promotionId | Integer | Links the reward to the promotion |
| startTime | String (DateTime) | Start time of the reward |
| endTime | String (DateTime) | End time of the reward |
| expired | Boolean | Indicates if the reward has expired |
| started | Boolean | Indicates if the reward has started |
| intouchPointsPostDiscount | Integer | Points post discount |
{
"status": {
"success": true,
"code": 11008,
"message": "Catalog promotion fetched successfully."
},
"catalogPromotion": {
"id": 2,
"name": "P1- R-5165 P1- R-5165 upadted 2",
"orgId": 100458,
"isEnabled": false,
"startTime": "2023-05-04 20:58:49",
"endTime": "2025-10-25 11:16:00",
"discountType": "ABSOLUTE",
"discountValue": 0.80,
"lastUpdatedOn": "2023-05-04 17:37:23",
"createdOn": "2023-05-04 11:16:42",
"lastUpdatedBy": 75078478,
"createdBy": 75078478,
"languageSpecificInfo": [
{
"languageCode": "en",
"name": "P1- R-5165 P1- R-5165 upadted 2",
"description": "description",
"enabled": true,
"createdBy": 75078478,
"createdOn": "2023-05-04 11:16:42",
"lastUpdatedBy": 75078478,
"lastUpdateOn": "2023-05-04 11:17:41"
}
],
"customFields": {},
"rewards": [
{
"id": 2,
"rewardId": 53908,
"promotionId": 2,
"startTime": "2023-05-04 20:58:49",
"endTime": "2023-10-31 11:59:30",
"expired": true,
"started": true,
"intouchPointsPostDiscount": 100
}
]
}
}
API-specific error codes
| Error code | Description |
|---|---|
| 11007 | Catalog promotion not found. |