get
https://{host}/v1.1/customer/redemptions
This API allows you to retrieve points and coupons redemption history of a customer. You can filter the results by type, duration, coupon ids start with, and coupon ids end with. Besides filters you can also sort the results by ascending or descending order by redemption id/time and limit number of results to retrieve.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Example request
curl --location 'https://eu.api.capillarytech.com/v1.1/customer/redemptions?mobile=7744876415' \
--header 'Authorization: Basic =' \
--header 'Cookie: _cfuvid=a0NmZQvi.30LKK7NvCQJgMpK8Ig15sul9um2ZFRucDk-1757422794990-0.0.1.1-604800000'curl --location 'https://eu.api.capillarytech.com/v1.1/customer/redemptions?mobile=1234512345&points_limit=1' \
--header 'Authorization: Basic Z2VvcmdRlbW86NjVhMDgzYjk1MWY5MGY1NTY5NDk1YmNkNzUxYmJiY2U=' \
--header 'Cookie: _cfuvid=a0NmZQvi.30LCQJgMpK8Ig15sul9um2ZFRucDk-1757422794990-0.0.1.1-604800000; _cfuvid=G34mU5xo45KXhscLi1wLSxlx.ZVXnKiUNc_XzQMNPBg-1765781430679-0.0.1.1-604800000'curl --location 'https://eu.api.capillarytech.com/v1.1/customer/redemptions?mobile=1234512345&points_offset=10' \
--header 'Authorization: Basic Z2VvcmdlLmRvY2RlbW86NjVhMDgzYjk1MWYNTY5NDk1YmNkNzUxYmJiY2U=' \
--header 'Cookie: _cfuvid=a0NmZQvi.30LKK7NvCQJgMpK8m2ZFRucDk-1757422794990-0.0.1.1-604800000; _cfuvid=5yvhhI4kBWT.hvwsNG.I9UYaK_KkaA6C32ngT3G5Gvk-1765781837648-0.0.1.1-604800000'curl --location 'https://eu.api.capillarytech.com/v1.1/customer/redemptions?mobile=918442838241&includePointsSourceBreakdown=true&type=points&points_limit=10' \
--header 'Authorization: Basic Z2VvcmdlLmRvY2RlbW86NjVhMDgzYjk1MWY5MGY1NTY5NDk1YmNkNzUxYmJiY2U='Example response
{
"response": {
"status": {
"success":true,
"code":200,
"message":"Success"
},
"customer": {
"mobile": "917744876415",
"email": "[email protected]",
"external_id": null,
"firstname": "tester",
"lastname": "capillary",
"user_groups2":[
],
"rows": 4,
"coupons_count": "3",
"points_count": 1,
"coupons_start_id": "16793490",
"points_start_id": 1,
"redemptions": {
"coupons": {
"coupon": [
{
"id":"16793490",
"code": "RT2EJTAE",
"series_id":"689078",
"description":"LIKE1w2w2345678910",
"discount_code":"XYZ1w23",
"discount_type":"ABS",
"discount_value":"500",
"transaction_number":"bill-110",
"bill_id":"0",
"redeemed_time":"2025-02-24 13:01:40",
"redeemed_at":"satish.maharana",
"redeemed_store":
{
"name":"DocStore",
"code":"doc123"
},
"redeemed_till":{
"name":"satish.maharana",
"code":"satish.maharana"
},
"custom_fields": {
"field": [
]
}
},
{
"id":"16793484",
"code": "LU251JB2",
"series_id":"689078",
"description":"LIKE1w2w2345678910",
"discount_code":"XYZ1w23",
"discount_type":"ABS",
"discount_value":"500",
"transaction_number":"bill-110",
"bill_id":"0",
"redeemed_time":"2025-02-24 13:01:13",
"redeemed_at":"satish.maharana",
"redeemed_store":
{
"name":"DocStore",
"code":"doc123"
},
"redeemed_till":{
"name":"satish.maharana",
"code":"satish.maharana"
},
"custom_fields": {
"field": [
]
}
},
{
"id":"16787110",
"code": "K6OXLR0Q",
"series_id":"689078",
"description":"LIKE1w2w2345678910",
"discount_code":"XYZ1w23",
"discount_type":"ABS",
"discount_value":"500",
"transaction_number":"bill-110",
"bill_id":"0",
"redeemed_time":"2025-02-23 22:33:01",
"redeemed_at":"satish.maharana",
"redeemed_store":
{
"name":"DocStore",
"code":"doc123"
},
"redeemed_till":{
"name":"satish.maharana",
"code":"satish.maharana"
},
"custom_fields": {
"field": [
]
}
}
]
},
"points": {
"point": [
{
"id" :1,
"program_id":973,
"points_redeemed":100,
"transaction_number":"",
"bill_id":"-1",
"validation_code":"",
"redeemed_time":"2025-03-10 14:37:11",
"redeemed_at":"sant.p_123",
"redemption_purpose":"",
"notes":"Redeemed to transfer points to the friend",
"external_reference_number":"",
"redemption_id":"AfL1vt",
"redeemed_store":{
"code":"doc123",
"name":"DocStore"
},
"redeemed_till":{
"code":"sant.p_123",
"name":"sant.p_123"
},
"custom_fields": {
"field": [
]
},
"reversals":
[
],
"redemption_breakup_by_program":
[
]
}
]
}
}
}
}
}
{
"response": {
"status": {
"success": true,
"code": 200,
"message": "Success"
},
"customer": {
"mobile": "918442838241",
"email": "[email protected]",
"external_id": null,
"firstname": "John",
"lastname": "Doe",
"user_groups2": [],
"rows": 1,
"points_count": 1,
"points_start_id": 1,
"redemptions": {
"points": {
"point": [
{
"id": 1,
"program_id": 1886,
"points_redeemed": 8,
"transaction_number": "bill-123",
"bill_id": "-1",
"validation_code": "",
"redeemed_time": "2025-12-10 15:30:00",
"redeemed_at": "store_till",
"redemption_purpose": "Purchase discount",
"notes": "Redeemed at checkout",
"external_reference_number": "",
"redemption_id": "XyZ123",
"redeemed_store": {
"code": "store123",
"name": "Main Store"
},
"redeemed_till": {
"code": "till_01",
"name": "Till 01"
},
"custom_fields": {
"field": []
},
"reversals": [],
"redemption_breakup_by_program": [
{
"program_id": 1886,
"points_redeemed": 8,
"program_name": "DefaultProgram"
}
],
"redemption_breakup_by_source": [
{
"source_store": {
"code": "northstore",
"name": "NorthStore"
},
"points_consumed": 6,
"awarding_date": "2025-10-18 21:58:10"
},
{
"source_store": {
"code": "northstore",
"name": "NorthStore"
},
"points_consumed": 2,
"awarding_date": "2025-10-18 21:58:07"
}
]
}
]
}
}
}
}
}Request query parameters
| Parameter | Data Type | Required | Description |
|---|---|---|---|
| identifierName | string (enum) | Mandatory | Identifier of the customer to use. Allowed: mobile, email, external_id, id. |
| identifierValue | string | Mandatory | Value of the specified identifier type. To retrieve transactions of multiple customers, provide each identifier separated by commas.Example: mobile=44700900000,44700900999,4470090345 |
| type | string (enum) | Optional | Type of redemption. Allowed: POINTS, COUPONS, BOTH. |
| start_date | date | Optional | Retrieves redemptions made on or after a specific date (YYYY-MM-DD). Use with end_date for a date range. |
| end_date | date | Optional | Retrieves redemptions made on or before a specific date (YYYY-MM-DD). Use with start_date for a date range.Example: start_date=2013-12-21+23:45:45&end_date=2013-12-29+12:11:45 |
| entity_code | string | Optional | Code of the specified entity_type. Example: to get transactions of a zone with code zone01, pass entity_type=zone&entity_code=zone01. |
| coupons_limit | int32 | Optional | Limit the number of coupon redemptions displayed. Use only when type is not passed.Example: coupons_limit=10 |
| points_limit | int32 | Optional | Specifies the maximum number of point redemption records to return.
|
| limit | int32 | Optional | Limit the number of redemption details (points and/or coupons). Default is 10. Use only when type is not passed. |
| coupons_start_id | int64 | Optional | Filter results by coupon redemption ID starting with a specific number. Use only when type is not passed. |
| coupons_end_id | int64 | Optional | Filter results by coupon redemption ID ending with a specific number. Use only when type is not passed. |
| points_start_id | int64 | Optional | Filter results by points redemption ID starting with a specific number. Use only when type is not passed. |
| points_end_id | int64 | Optional | Filter results by points redemption ID ending with a specific number. Use only when type is not passed. |
| sort | string (enum) | Optional | Sort results by redemption ID or redeemed time. Defaults to descending order of redeemed time. Supported parameters: false, redemption_id, redeemed_time. |
| order | string (enum) | Optional | Defines sort order. Defaults to desc.Supported parameters: asc, desc. |
| mlp | boolean | Optional | Pass true to get redemptions from all programs of the org; false for only the default program. Defaults to false. |
| format | string (enum) | Optional | Format of the response. Allowed: xml, json. |
| user_id | boolean | Optional | Pass true to include customer ID in response. Defaults to not retrieved. |
| merchant_store_id | int64 | Optional | Merchant store ID to fetch redemptions from a specific store. |
| program_id | int32 | Optional | Program ID to filter redemptions of a particular program. |
| external_reference_number | string | Optional | Unique reference number provided when making the points redemption request. |
| points_offset | integer | Optional | Specifies the starting page for the records to be fetched. Default: 0 |
| includePointsEarnBreakdown | boolean | Optional | When set to Default: Note: This parameter only applies to points redemptions. It has no effect on coupon redemptions. |
Response Parameters
| Parameter | Datatype | Description |
|---|---|---|
| coupons_count | int | Number of coupon redemptions retrieved. |
| points_count | int | Number of points redemptions received. |
| coupons | obj | Details of coupon redemptions. |
| points | obj | Details of points redemption. |
| code | string | Unique code of the coupon. |
| series_id | long | Coupon series ID associated to the coupon. |
| description | string | Description of the coupon. |
| discount_code | string | Coupon code used to avail discount. |
| discount_type | enum | Type of discount. PERC for discount in percentage, FLAT for flat amount discount. |
| id | long | Redemption ID of that points or coupon. |
| transaction_number | string | Transaction number associated to the points or coupon redemption. |
| bill_id | long | A numerical identifier for the bill. |
| redeemed_time | date-time | Date and time of points or coupon redemption. |
| redeemed_at | string | Store or TILL code associated to points or coupon redemption. |
| program_id | long | Unique ID of the loyalty program in which points is redeemed. |
| points_redeemed | int | Number of points redeemed. |
| transaction_number | string | Transaction number associated to the points or coupon redemption. |
| redeemed_time | date-time | Date and time of points or coupon redemption. |
| redeemed_at | string | Store or TILL code associated to points or coupon redemption. |
| redemption_breakup_by_program | obj | Breakup of points redeemed with respect to the program. |
| reversals | obj | Details of points reversed if the transaction for which points are redeemed is returned. |
| reversal_id | long | Unique ID generated for the reversal of a specific set of redeemed points. |
| points_reversed | int | number of points reversed. |
| reversal_time | date-time | Date and time of points reversal in YYYY-MM-DD HH:MM:SS format. |
| reversed_on_till_id | long | Till ID associated to the points reversal. |
| reversal_breakup_by_program | obj | Breakup of points reversed and associated loyalty program. |
| redemption_breakup_by_source | array | Source-level breakdown of redeemed points (only included when includePointsSourceBreakdown=true). Shows which stores/tills originally awarded the points being redeemed. Each entry contains:- source_store: Object with code and name of the store where points were awarded- points_consumed: Number of points from that source used in this redemption- awarding_date: Date and time when the points were awarded at that source store (format: YYYY-MM-DD HH:MM:SS) |