This API is used to retrieve list of rewards owned by them based on filters.

👍
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 Authentication
Default access group

Resource information


URI	/api_gateway/rewards/core/v1/management/customer/{customerId}/issuals
HTTP Method	GET
Pagination	Yes
Batch support	No
Rate limit information	None

API endpoint example

https://eucrm.cc.capillarytech.com/api_gateway/rewards/core/v1/management/customer/109943742/issuals?status=false

Request path parameters

Parameter Name	Data Type	Description
customerId*	String	Unique identifier of the customer.

Request query parameters

Parameter Name	Data Type	Description
Page	Integer	Allows to retrieve details of a specific page.
Size	Long	Results to show per page. Default - 100
status	Boolean	Status of the issued reward transaction.

https://eucrm.cc.capillarytech.com/api_gateway/rewards/core/v1/management/customer/109943742/issuals?status=false

Response parameters

Parameter Name	Data Type	Description
success	Boolean	Indicates if the operation was successful.
code	Integer	The HTTP status code of the operation.
message	String	Descriptive message about the operation's outcome.
rewardTransactionId	String	Unique identifier for the reward transaction.
rewardIssueRefId	String	Reference ID associated with the reward issue.
rewardTransactionDate	Long	Date and time of the reward transaction in milliseconds since epoch.
status	Object	Nested object containing the status of the reward issue.
success	Boolean	Indicates if the reward was issued successfully.
code	Integer	Status code for the reward issue transaction.
message	String	Status message for the reward issue transaction.
rewardDetails	Object	Nested object containing details of the issued reward.
rewardId	Integer	Unique identifier of the reward.
languageCode	String	Language code of the reward details (e.g., "en" for English).
name	String	Name of the reward.
description	String	Description of the reward.
termNConditionsId	String	Unique identifier for the terms and conditions of the reward.
termNConditionsUrl	String	URL to the terms and conditions of the reward.
imageId	String	Unique identifier for the image associated with the reward.
imageUrl	String	URL to the image associated with the reward.
thumbnailId	String	Unique identifier for the thumbnail image associated with the reward.
thumbnailUrl	String	URL to the thumbnail image associated with the reward.
enabled	Boolean	Indicates whether the reward is enabled.
ownerType	String	Type of the owner associated with the reward transaction, if applicable.
ownerId	String	Identifier of the owner associated with the reward transaction, if applicable.
last	Boolean	Indicates if the current page is the last.
totalElements	Integer	Total number of elements across all pages.
totalPages	Integer	Total number of pages.
numberOfElements	Integer	Number of elements in the current page.
first	Boolean	Indicates if the current page is the first.
size	Integer	Number of elements per page.
number	Integer	The current page number.

{
    "status": {
        "success": true,
        "code": 200,
        "message": "Reward issue transactions fetched successfully"
    },
    "rewardIssueTransactions": [
        {
            "rewardTransactionId": "91957",
            "rewardIssueRefId": "TX3914402",
            "rewardTransactionDate": 1695212136000,
            "status": {
                "success": true,
                "code": 200,
                "message": "Reward issued successfully"
            },
            "rewardDetails": {
                "rewardId": 13,
                "languageCode": "en",
                "name": "150 off on handbags and wallets",
                "description": "150 off on handbags and wallets",
                "termNConditionsId": "36797a3b-7726-4d75-ad8b-aa1dc0bd7874",
                "termNConditionsUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/5f259983-5671-453e-af25-c9d1293.html",
                "imageId": "04bbabf2-ce9d-48b3-9a58-347479b8ea88",
                "imageUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/969c2707-e082-4cc5-bbad-48f6ae1.jpeg",
                "thumbnailId": "d287af72-80bd-40c8-98c3-68a28eb3cf66",
                "thumbnailUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/3a8f00ea-bb30-4eeb-9175-663afbb.jpeg",
                "enabled": true
            },
            "ownerType": null,
            "ownerId": ""
        },
        {
            "rewardTransactionId": "77106",
            "rewardIssueRefId": "TX2140060",
            "rewardTransactionDate": 1690451892000,
            "status": {
                "success": true,
                "code": 200,
                "message": "Reward issued successfully"
            },
            "rewardDetails": {
                "rewardId": 53386,
                "languageCode": "en",
                "name": "Lotte Hotels & Resorts ",
                "description": "Lotte Hotels & Resorts Points may be used for rooms, food and beverages at LOTTE HOTELS & RESORTS and Evian SPA in SIGNIEL SEOUL from at least 1,000 points (USD 10).",
                "termNConditionsId": "81a702b8-107f-4e53-bec2-223c456c15cb",
                "termNConditionsUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/bce566f7-54c1-4c15-bef0-d7e292e.html",
                "imageId": "d7ecad3e-4360-401d-a51b-20938eb3e8dd",
                "imageUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/8d4079fd-271d-4bab-9652-bac13ca8.png",
                "thumbnailId": "4895fa62-6cd6-4b17-970a-f1fbe126392c",
                "thumbnailUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/228535ab-6ad2-44e7-b9ed-5f73406d.png",
                "enabled": true
            },
            "ownerType": null,
            "ownerId": ""
        },
        {
            "rewardTransactionId": "75131",
            "rewardIssueRefId": "TX8662702",
            "rewardTransactionDate": 1689774990000,
            "status": {
                "success": false,
                "code": 8004,
                "message": "fail to issue reward as  points are not redeemable"
            },
            "rewardDetails": {
                "rewardId": 13,
                "languageCode": "en",
                "name": "150 off on handbags and wallets",
                "description": "150 off on handbags and wallets",
                "termNConditionsId": "36797a3b-7726-4d75-ad8b-aa1dc0bd7874",
                "termNConditionsUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/5f259983-5671-453e-af25-c9d1293.html",
                "imageId": "04bbabf2-ce9d-48b3-9a58-347479b8ea88",
                "imageUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/969c2707-e082-4cc5-bbad-48f6ae1.jpeg",
                "thumbnailId": "d287af72-80bd-40c8-98c3-68a28eb3cf66",
                "thumbnailUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/3a8f00ea-bb30-4eeb-9175-663afbb.jpeg",
                "enabled": true
            },
            "ownerType": null,
            "ownerId": ""
        },
        {
            "rewardTransactionId": "75089",
            "rewardIssueRefId": "TX9837981",
            "rewardTransactionDate": 1689762352000,
            "status": {
                "success": false,
                "code": 8004,
                "message": "fail to issue reward as  points are not redeemable"
            },
            "rewardDetails": {
                "rewardId": 13,
                "languageCode": "en",
                "name": "150 off on handbags and wallets",
                "description": "150 off on handbags and wallets",
                "termNConditionsId": "36797a3b-7726-4d75-ad8b-aa1dc0bd7874",
                "termNConditionsUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/5f259983-5671-453e-af25-c9d1293.html",
                "imageId": "04bbabf2-ce9d-48b3-9a58-347479b8ea88",
                "imageUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/969c2707-e082-4cc5-bbad-48f6ae1.jpeg",
                "thumbnailId": "d287af72-80bd-40c8-98c3-68a28eb3cf66",
                "thumbnailUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/3a8f00ea-bb30-4eeb-9175-663afbb.jpeg",
                "enabled": true
            },
            "ownerType": null,
            "ownerId": ""
        },
        {
            "rewardTransactionId": "75061",
            "rewardIssueRefId": "TX3433466",
            "rewardTransactionDate": 1689755442000,
            "status": {
                "success": true,
                "code": 200,
                "message": "Reward issued successfully"
            },
            "rewardDetails": {
                "rewardId": 73060,
                "languageCode": "en",
                "name": "Exclusive Access to Fashion Week",
                "description": "Immerse yourself in the glamorous world of fashion with exclusive access to prestigious fashion week events. ",
                "termNConditionsId": "dd669236-e8d9-4812-9ab5-ac6b6bffcfbf",
                "termNConditionsUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/c26befab-b29a-4776-b254-9b8099a.html",
                "imageId": "03e18a94-87aa-4fad-a1b5-6a88be174df9",
                "imageUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/fd1be9be-a588-453a-a60d-9d596158.jpg",
                "thumbnailId": "4f961d16-c992-4ab8-9334-409cbf765383",
                "thumbnailUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/703e55a0-d057-4cf7-9040-a4182cb1.jpg",
                "enabled": true
            },
            "ownerType": null,
            "ownerId": ""
        }
    ],
    "pagingDto": {
        "last": false,
        "totalElements": 256,
        "totalPages": 52,
        "numberOfElements": 5,
        "first": true,
        "size": 5,
        "number": 0
    }
}

Get list of issued reward transactions

👍
Note

Prerequisites

Resource information

API endpoint example

Request path parameters

Request query parameters

Response parameters

👍Note

Prerequisites

Resource information

API endpoint example

Request path parameters

Request query parameters

Response parameters

👍
Note