get https://{host}/api_gateway/rewards/core/v1/management/customer//issuals/
This API allows you to retrieve reward transaction of a customer using customer ID and reward transaction ID.
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 authentication
- Default access group
Resource information
| URI | api_gateway/rewards/core/v1/management/customer/{customerId}/issuals/{rewardTransaction} |
| HTTP Method | GET |
| Pagination | Yes |
| Batch support | No |
| Rate limit information | None |
API endpoint example
https://crm-nightly-new.cc.capillarytech.com/api_gateway/rewards/core/v1/management/customer/383428154/issuals/84563
Request path parameters
| Parameter | Data type | Description |
|---|---|---|
| customerId* | Integer | Unique ID of the customer. |
| rewardTransactionId* | Integer | Unique ID of the reward transaction. |
Response parameters
| Parameter | Description |
|---|---|
| success | Indicates whether the specific API call was successful. |
| code | The status code related to the specific part of the transaction. |
| message | A descriptive message regarding the status of the transaction. |
| rewardTransactionId | Unique identifier for the reward transaction. |
| rewardIssueRefId | Reference identifier for the reward issue transaction. |
| rewardTransactionDate | Timestamp indicating when the transaction took place. |
| success | Indicates the success of the reward transaction specifically. |
| code | Status code associated with the reward transaction. |
| message | Description of the reward transaction status. |
| rewardId | Unique identifier of the reward. |
| languageCode | Language code for the reward details. |
| name | The name of the reward. |
| description | Description of the reward. |
| termNConditionsId | ID for the terms and conditions associated with the reward |
| termNConditionsUrl | URL to the terms and conditions document |
| imageId | Identifier for the reward's image. |
| imageUrl | URL of the reward's image. |
| enabled | Boolean flag to indicate if the reward is enabled or not. |
| success | Indicates if the points redemption was successful. |
| code | Status code related to the points redemption. |
| message | Description of the points redemption status. |
| ownerType | The module claimed by the badge. Supported values: Loyalty program, Milestones, Campaigns, Journeys, Goodwill. |
| ownerId | Identifier of the owner of the transaction, here shown as an empty string. |
| intouchPoints | Number of InTouch points associated with the reward. |
| intouchSeriesId | InTouch series ID |
| redemptionType | Type of redemption for the reward. |
| vendorName | Name of the vendor |
| vendorId | Unique identifier for the vendor |
| vendorRedemptionId | Vendor redemption ID |
| vendorRedemptionName | Name of the vendor redemption. |
| images | Array of images associated with the reward. |
| pointsRedemption | Object containing details of the points redemption. |
| issueReward | Issue reward details |
| revokeReward | Revoke reward details |
| vouchers | Array of vouchers associated with the reward. |
| ownerType | Type of the owner |
| ownerId | Tender details |
{
"status": [
{
"success": true,
"code": 200,
"message": "Reward issue transactions details fetched successfully"
}
],
"data": {
"rewardTransactionId": "84563",
"rewardIssueRefId": "2344s4",
"rewardTransactionDate": 1712738457000,
"status": {
"success": true,
"code": 200,
"message": "Reward issued successfully"
},
"quantity": 1,
"groupRedemption": false,
"rewardDetails": {
"rewardId": 55771,
"languageCode": "en",
"name": " INTOUCH Enabled",
"description": "Description",
"rewardRank": null,
"groups": [],
"imageId": "EXDR12987U",
"imageUrl": "https://s3.amazonaws.com/crm-nightly-new-solutions/testOrg_marvel_20230822_147/EXDR12987U?X-Amz-Security-Token=FwoGZXIvYXdzEC8aDCg9KLUOd03NMWLgHSLWAW0IoNU8BYSfxFtPc6L1EYIrF4CaxQIK0Qq9pK7zWcl4i57jC0FxSfy67Gt4faeUKnBxNSVNs%2FehpLQqJP8Gqf8IF6ckAAV7VehXTSmHCF460iaAqw8i8KNDCMzp1w%2BiQzrgq2P3Qee%2B%2FxrseSjpcRYGlwglBQbow7ik5JD6vFlzhsVlu4AGbzJUKu5MDNQyIXQHVD65UkvdpDYQfx6x0sGcS%2BZJ%2BFv6bCoSSUTGD4ivBp75sxi6wn%2FwVAs%2BMtYZPOJkCgbVWXMnPb%2FcXZ2pbDsSj81rTX0o9fLNtQYyLXqYZJRKcsHhgQeSJ4Wi2sWtSjwatOql4A4DdgEGbjlD9u1Q6QIRGUYHBAoXag%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240807T134109Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3599&X-Amz-Credential=ASIAXCQYYRKNAT4P2VUO%2F20240807%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=9fbb97d9c394eed9e6ce56377ba1b09a50dea0ad74cddd293a75bd281a79d6c5",
"intouchPoints": 0,
"intouchSeriesId": null,
"redemptionType": "MILES",
"vendorName": null,
"vendorId": null,
"vendorRedemptionId": null,
"vendorRedemptionName": null,
"images": [],
"videos": []
},
"pointsRedemption": {
"redeemedPoints": 200,
"vendorName": null,
"referenceId": null,
"pointsRedemptionRefId": "aJm5To",
"status": {
"success": true,
"code": 200,
"message": "Points redeemed successfully."
},
"stageReferenceId": null,
"vendorId": null,
"requestBody": null,
"responseBody": null,
"headers": null
},
"pointsRedemptionCheck": null,
"issueReward": null,
"revokeReward": null,
"constraintsCheck": null,
"catalogPromotions": null,
"appliedPromotions": null,
"vouchers": [],
"promotions": null,
"customFields": {
"fa7603c72024-07-03 20:32:53.025692": "defaultValue",
"a03eb05b2024-07-26 17:32:54.734564": "defaultValue",
"321e71d02024-07-18 15:10:20.124947": "defaultValue",
"7437f9c52024-07-16 15:14:36.051644": "defaultValue",
"ec0812382024-07-26 15:02:33.424849": "defaultValue",
"a32270ef2024-07-01 15:02:28.801104": "defaultValue",
"5a86116a2024-06-24 13:30:26.942411": "defaultValue",
"1181241b2024-07-17 18:33:55.509164": "defaultValue",
"d4dc6ac02024-07-26 18:40:38.154924": "defaultValue",
"6c02d1e12024-07-10 15:02:17.630926": "defaultValue",
"9d67fb542024-07-08 15:19:55.330240": "defaultValue",
"2370604f2024-07-08 11:36:30.658952": "defaultValue",
"dd600b022024-07-05 11:34:31.698678": "defaultValue",
"6ea3800a2024-07-18 15:02:22.622157": "defaultValue",
"f019dc732024-07-15 11:33:08.721332": "defaultValue",
"7b9c7be62024-07-15 15:01:56.322874": "defaultValue",
"32316e6a2024-07-04 15:11:02.116268": "defaultValue",
"b949bf182024-07-18 15:15:50.380455": "defaultValue",
"08b3ff522024-07-11 11:33:40.986002": "defaultValue",
"662a19112024-07-11 15:15:50.124809": "defaultValue",
"52a3ef062024-07-01 15:17:44.149115": "defaultValue",
"bff8ca1e2024-07-04 15:17:12.612749": "defaultValue",
"b1f055ec2024-07-23 11:33:12.383854": "defaultValue",
"eecac1002024-07-25 15:03:16.619110": "defaultValue",
"75b2f9dd2024-07-08 20:34:51.295851": "defaultValue",
"fae348522024-07-10 15:18:51.156489": "defaultValue",
"caeb7eba2024-07-09 20:34:48.912544": "defaultValue",
"9996c6632024-07-02 15:18:37.655810": "defaultValue",
"10ecf43c2024-07-12 15:10:18.406125": "defaultValue",
"d4c334ac2024-07-08 15:13:40.919734": "defaultValue",
"0604b79f2024-07-10 15:12:29.601413": "defaultValue",
"82721b872024-07-24 19:04:29.862429": "defaultValue",
"19a88edd2024-07-26 17:35:52.048546": "defaultValue",
"d9af2cfa2024-07-12 15:02:26.239276": "defaultValue",
"16947a222024-07-22 15:09:54.842054": "defaultValue",
"cac339552024-07-26 18:33:41.999245": "defaultValue",
"8a18b3652024-07-02 11:34:48.711383": "defaultValue",
"e5ec43222024-07-25 15:11:23.911606": "defaultValue",
"75f5446e2024-07-26 15:15:48.208713": "defaultValue",
"486109f02024-07-24 15:17:39.995958": "defaultValue",
"995f15712024-06-24 13:30:16.002511": "defaultValue",
"808593232024-07-12 15:15:40.103678": "defaultValue",
"21756ab12024-07-26 18:36:36.431809": "defaultValue",
"b13586572024-07-16 15:02:01.699268": "defaultValue",
"568df12b2024-07-17 15:02:14.963652": "defaultValue",
"f291524d2024-07-17 15:15:19.570347": "defaultValue",
"6bcea6a22024-07-11 15:10:16.024957": "defaultValue",
"0a1f63072024-07-17 15:09:54.571179": "defaultValue",
"55af36b12024-07-16 11:33:07.601787": "defaultValue",
"36ccf97b2024-07-23 15:09:23.793201": "defaultValue",
"26e4a4fb2024-07-19 11:32:50.697830": "defaultValue",
"b88bda902024-07-18 11:33:47.413091": "defaultValue",
"6f356b752024-07-03 20:20:07.780486": "defaultValue",
"44eeca822024-07-26 17:44:57.271850": "defaultValue",
"a8b449f62024-07-12 22:43:06.778784": "defaultValue",
"e473a4d52024-06-25 14:32:57.381643": "defaultValue",
"e45efa612024-07-15 15:09:09.191288": "defaultValue",
"4e68fb572024-06-27 12:02:26.623275": "defaultValue",
"47120a252024-07-02 15:12:27.189999": "defaultValue",
"df7093e12024-07-05 15:02:58.567820": "defaultValue",
"f198246e2024-07-22 15:15:09.827592": "defaultValue",
"d5f400752024-07-26 15:10:22.455797": "defaultValue",
"4f3a44362024-07-24 15:03:07.145276": "defaultValue",
"b3f2fb5f2024-07-26 17:41:02.917912": "defaultValue",
"8d2d03232024-07-16 15:09:18.300002": "defaultValue",
"0b3ca5f52024-07-26 17:50:15.516558": "defaultValue",
"1aa2ebb52024-06-26 22:34:50.918024": "defaultValue",
"6130cc9b2084-06-21 18:16:16.975209": "defaultValue",
"ca92b5d92024-07-04 17:33:50.970391": "defaultValue",
"53303aec2024-06-25 11:32:48.610544": "defaultValue",
"336f56e12024-07-05 15:13:15.695713": "defaultValue",
"4f4540f92024-07-08 12:34:49.085607": "defaultValue",
"fb6ce58a2024-07-03 15:13:06.800047": "defaultValue",
"81907b162024-07-03 15:19:33.197073": "defaultValue",
"26bca1222024-07-05 10:34:49.170015": "defaultValue",
"7a9bbcd72024-07-24 15:12:06.245858": "defaultValue",
"009820fd2024-07-02 15:03:09.527884": "defaultValue",
"f73a63172024-07-23 15:02:01.034509": "defaultValue",
"e028516a2024-07-01 15:34:49.018445": "defaultValue",
"60e66f592024-06-24 13:30:00.931957": "defaultValue",
"9922cd512024-07-08 15:03:18.440220": "defaultValue",
"c7247a252024-07-19 15:02:12.592068": "defaultValue",
"8e4f88822024-07-15 21:24:48.885705": "defaultValue",
"791236862024-07-23 15:14:41.260293": "defaultValue",
"27c723992024-07-01 15:11:29.095037": "defaultValue",
"80a6ff992024-07-03 15:03:00.751306": "defaultValue",
"ddd73cba2024-07-19 15:09:35.789703": "defaultValue",
"be6c336a2024-07-17 11:33:30.527784": "defaultValue",
"0dc3b0f42024-07-22 15:02:29.837992": "defaultValue",
"91c88a952024-07-06 15:09:31.518042": "defaultValue",
"e85019972024-07-15 15:14:43.045468": "defaultValue",
"7be7bd592024-07-19 15:14:51.718796": "defaultValue",
"2a4191a72024-07-08 13:35:49.535712": "defaultValue",
"6ae68db42024-07-05 15:19:44.929683": "defaultValue",
"1a9419fa2024-06-25 11:42:03.472770": "defaultValue",
"dce011ee2024-07-11 15:02:28.533428": "defaultValue",
"4ceefe8b2024-07-04 15:02:24.941601": "defaultValue"
},
"transactionCustomFields": null,
"fulfillmentDetails": null,
"ownerType": null,
"ownerId": "",
"tender": null
}
}