put https://{host}/v2/points/updateRedemption
This API allows you to update points redemption. The fields that can be updated are:
- bill_id
- bill_number
- purpose
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 .
API specifications
| Feature | Availability |
|---|---|
| Authentication supported | Basic |
| Pagination | Not supported |
| Batch support | Not supported |
| Access Group | Yes |
API endpoint example
https://eucrm.cc.capillarytech.com/v2/points/updateRedemption
Request body parameters
| Parameter | Description | Data Type |
|---|---|---|
| redemptionId* | A unique identifier for the redemption process. | String |
| externalReferenceNumber* | Unique reference number associated with the bill. | String |
| billId | A numerical identifier for the bill. | Integer |
| billNumber | A string identifier for the bill. | String |
| purpose | The purpose or reason for the transaction. | String |
| entity | An object containing details about the entity. | Object |
| entity.type | The type of entity involved in the transaction. | Enum |
| entity.identifierType | The type of identifier used for the entity. | Enum |
| entity.identifierValue | The value of the identifier for the entity. | String |
Note: It is mandatory to pass either redemptionId or externalReferenceNumber.
{
"redemptionId": "sTDVyi",
"billId":235,
"billNumber":"idk",
"purpose":"why",
"entity":{
"type":"CUSTOMER",
"identifierType":"mobile",
"identifierValue":"9353995259"
}
}
Response parameters
| Parameter | Description | Data Type |
|---|---|---|
| id | A unique identifier for the transaction. | Integer |
| programId | Identifier for the associated program. | Integer |
| pointsRedeemed | The number of points redeemed in the transaction. | Float |
| billId | A numerical identifier for the bill. | Integer |
| billNumber | A string identifier for the bill. | String |
| validationCode | A code used for validating the transaction. | String |
| notes | Additional notes or comments about the transaction. | String |
| redemptionTime | Timestamp of when the redemption occurred. | Long (Epoch time) |
| pointsRedemptionTime | Timestamp of when the points were redeemed. | Long (Epoch time) |
| tillId | Identifier for the till where the transaction occurred. | Integer |
| tillName | Name of the till where the transaction occurred. | String |
| pointDeductionList | List of point deductions involved in the transaction. | Array |
| redemptionId | A unique identifier for the redemption process. | String |
| customerId | Identifier for the customer involved in the transaction. | Integer |
| redemptionPurpose | The purpose or reason for the redemption. | String |
| redemptionDate | The date and time of redemption in ISO 8601 format. | String (Date-Time) |
| warnings | List of any warnings related to the transaction. | Array |
{
"id": 24135289,
"programId": 772,
"pointsRedeemed": 10.0,
"billId": 235,
"billNumber": "idk",
"validationCode": "",
"notes": "Sample notes",
"redemptionTime": 1694608810000,
"pointsRedemptionTime": 1694594410000,
"tillId": 75086856,
"tillName": "",
"pointDeductionList": [],
"redemptionId": "sTDVyi",
"customerId": 109943742,
"redemptionPurpose": "why",
"redemptionDate": "2023-09-13T12:40:10Z",
"warnings": []
}
API-specific error codes
| Error code | Description |
|---|---|
| 748 | No metadata update requested. |
| 749 | Exactly one redemption identifier needed to identify redemption. |
| 750 | Redemption update failed : {0}. |
| 1219 | Entity details not set/invalid. |
| 1212 | Entity type passed is not valid. |