Get Custom Fields Associated with Coupon Redemption

The API retrieves the custom fields and their associated values for 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 methodGET
Pagination supported?Yes
Rate limitBased on Neo
Batch supportNA

Request query parameters

Parameter (Parameters marked with * are mandatory)Data TypeDescription
redemption_ids*LongA 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.
pageIntegerRetrieve details of a specific page. Page count starts from 1. Example: page=2 retrieves data on page 2.
countIntegerNumber of results to display per page. The default value is 10. The maximum supported value is 100.

Response parameters

ParameterData TypeDescription
redemptionIdLongUnique identifier for the redemption instance.
nameStringName of the custom field.
valueStringValue associated with the custom field.

Sample response

[
  {
    "redemptionId": 1046094,
    "name": "age",
    "value": "12"
  },
  {
    "redemptionId": 1046094,
    "name": "redem_gender",
    "value": "Female1"
  },
  {
    "redemptionId": 1046095,
    "name": "age",
    "value": "10"
  },
  {
    "redemptionId": 1046096,
    "name": "age",
    "value": "12"
  },
  {
    "redemptionId": 1046096,
    "name": "redem_gender",
    "value": "Female2"
  }
]

Error codes

Error CodeDescription
400Bad Request
404Not Found
500Internal Server Error