Get list of promotions

This API is used to get the list of catalog promotions for a 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/brand/{brand Id}
HTTP MethodGET
PaginationNo
Batch supportNo
Rate limit informationNone

API endpoint example

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

Request path parameters

ParametersData TypeDescription
Brand ID*StringUnique identifier for the brand. Ex: 1
https://eucrm.cc.capillarytech.com/api_gateway/rewards/core/v1/promotion/brand/1 

Response parameters

Parameter NameData TypeDescription
statusObjectContains the status information of the request.
successBooleanIndicates the success status of the request.
codeIntegerThe status code of the response.
messageStringThe message describing the status.
idIntegerThe unique identifier of the catalog promotion.
nameStringThe name of the catalog promotion.
orgIdIntegerThe organization ID associated with the promotion.
isEnabledBooleanIndicates whether the promotion is enabled.
startTimeStringThe start time of the promotion.
endTimeStringThe end time of the promotion.
discountTypeStringThe type of discount applied in the promotion.
discountValueNumberThe value of the discount.
lastUpdatedOnStringThe timestamp of the last update.
createdOnStringThe timestamp of when the promotion was created.
lastUpdatedByIntegerThe ID of the user who last updated the promotion.
createdByIntegerThe ID of the user who created the promotion.
languageSpecificInfoNull/ObjectLanguage-specific information, if available.
{
    "status": {
        "success": true,
        "code": 11008,
        "message": "Catalog promotion fetched successfully."
    },
    "catalogPromotions": [
        {
            "id": 1,
            "name": "P1- R-5165 P1- R-5165 upadted 2",
            "orgId": 100458,
            "isEnabled": false,
            "startTime": "2023-04-26 06:58:49",
            "endTime": "2024-10-25 11:16:00",
            "discountType": "ABSOLUTE",
            "discountValue": 1.00,
            "lastUpdatedOn": "2023-11-16 10:10:03",
            "createdOn": "2023-04-25 13:59:28",
            "lastUpdatedBy": 75078478,
            "createdBy": 75078478,
            "languageSpecificInfo": null
        },
        {
            "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": null
        },
        {
            "id": 3,
            "name": "test1",
            "orgId": 100458,
            "isEnabled": true,
            "startTime": "2023-06-07 01:50:49",
            "endTime": "2025-10-25 05:46:00",
            "discountType": "ABSOLUTE",
            "discountValue": 1.00,
            "lastUpdatedOn": "2023-06-05 13:48:10",
            "createdOn": "2023-06-05 13:48:10",
            "lastUpdatedBy": 75078478,
            "createdBy": 75078478,
            "languageSpecificInfo": null
        },
        {
            "id": 4,
            "name": "test1",
            "orgId": 100458,
            "isEnabled": true,
            "startTime": "2023-06-07 01:50:49",
            "endTime": "2025-10-25 05:46:00",
            "discountType": "ABSOLUTE",
            "discountValue": 1.00,
            "lastUpdatedOn": "2023-06-05 13:48:44",
            "createdOn": "2023-06-05 13:48:44",
            "lastUpdatedBy": 75078478,
            "createdBy": 75078478,
            "languageSpecificInfo": null
        },
        {
            "id": 5,
            "name": "P1- R-5165 P1- R-5165 upadted 2",
            "orgId": 100458,
            "isEnabled": true,
            "startTime": "2023-06-07 01:50:49",
            "endTime": "2025-10-25 11:16:00",
            "discountType": "ABSOLUTE",
            "discountValue": 0.80,
            "lastUpdatedOn": "2023-06-05 13:49:40",
            "createdOn": "2023-06-05 13:48:58",
            "lastUpdatedBy": 75078478,
            "createdBy": 75078478,
            "languageSpecificInfo": null
        },
        {
            "id": 6,
            "name": "test",
            "orgId": 100458,
            "isEnabled": true,
            "startTime": "2023-12-26 06:58:49",
            "endTime": "2025-10-25 05:46:00",
            "discountType": "ABSOLUTE",
            "discountValue": 1.00,
            "lastUpdatedOn": "2023-11-27 16:38:41",
            "createdOn": "2023-11-27 16:38:41",
            "lastUpdatedBy": 75078478,
            "createdBy": 75078478,
            "languageSpecificInfo": null
        },
        {
            "id": 7,
            "name": "P1- R-5165 P1- R-5165 upadted 2",
            "orgId": 100458,
            "isEnabled": true,
            "startTime": "2024-05-04 20:58:49",
            "endTime": "2025-10-25 11:16:00",
            "discountType": "ABSOLUTE",
            "discountValue": 0.80,
            "lastUpdatedOn": "2024-01-10 09:56:27",
            "createdOn": "2024-01-10 09:51:50",
            "lastUpdatedBy": 75078478,
            "createdBy": 75078478,
            "languageSpecificInfo": null
        }
    ]
}
Language
Authorization
Basic
base64
:
URL
Click Try It! to start a request and see the response here!