get https://{host}/x/neo/couponRedemption/customFields
The API retrieves the custom fields and their associated values for coupon redemption.
Note
This API is a private API that has been exposed through Neo and made public.
Prerequisites
- Access to Neo
- Authentication - Basic or OAuth authentication details
- Access group resource - NA
- Header
x-cap-neo-dag-scopeset to a valid scope value (e.g. global)
Resource information
| URI | x/neo/couponRedemption/customFields |
| HTTP method | GET |
| Pagination supported? | Yes |
| Rate limit | Based on Neo |
| Batch support | NA |
API endpoint example
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. |
Sample request
curl --location 'https://nightly.api.capillarytech.com/x/neo/couponRedemption/customFields?redemption_ids=1046094%2C1046095%2C1046096&page=1&count=15' \
--header 'Content-Type: application/json' \
--header 'x-cap-neo-dag-scope: global' \
--header 'Authorization: Basic bMDcxNTJkMjM0Yjcw' \
--header 'Cookie: _cfuvid=bDzuqORMDePiD7OSqoaM5Wf.LRjcYN1SoBJGzi0aLo4-1749727061901-0.0.1.1-604800000'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. |
Sample response
[
{
"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 |