get https://{host}/das/getCouponRedemptionCustomFieldsData
The API retrieves the custom fields and their values associated with coupon redemption.
Note
This private API is accessible only through Neo dataflows.
Prerequisites
- Access to Neo
- Authentication - Basic or OAuth authentication details
- Access group resource - NA
Resource Information
| URI to be used in Neo dataflow | /das/getCouponRedemptionCustomFieldsData |
| HTTP method | GET |
| Pagination supported? | Yes |
| Rate limit | Based on Neo |
| Batch support | NA |
Request Query Parameters
| Parameter(Parameters marked with * are mandatory) | Data Type | Description |
|---|---|---|
redemption_ids* |
Long |
A unique identifier for the redemption instance. It is the ID generated when a coupon is redeemed. You can provide multiple redemption IDs, separated by commas. |
page |
Integer |
Retrieve details of a specific page. Page count starts from 1. |
count |
Integer |
Number of results to display per page. The default value is 10. The maximum supported value is 100. |
Response Parameters
| Parameter | Data Type | Description |
|---|---|---|
| redemptionId | Long | Unique identifier for the redemption instance. |
| redemptionCustomFields | Array | Array containing the custom fields and their associated values. |
| name | String | Name of the custom field. |
| value | String | Value associated with the custom field. |
[
{
"redemptionId": 1046094,
"redemptionCustomFields": [
{
"name": "age",
"value": "12"
},
{
"name": "redem_gender",
"value": "Female1"
}
]
},
{
"redemptionId": 1046095,
"redemptionCustomFields": [
{
"name": "age",
"value": "10"
}
]
},
{
"redemptionId": 1046096,
"redemptionCustomFields": [
{
"name": "age",
"value": "12"
},
{
"name": "redem_gender",
"value": "Female2"
}
]
}
]Error Codes
| Error Code | Description |
|---|---|
| 400 | Bad Request |
| 404 | Not Found |
| 500 | Internal Server Error |