v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get 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.

get/customer/redemptions

Query parameters

identifierName'mobile' | 'email' | 'external_id id' required

Identifier of the customer to use.

identifierValuestring required

Value of the specified identifier type. o retrieve transactions of multiple customers at a time, provide each identifier separating by a comma. <br>Example: mobile=44700900000,44700900999,4470090345

type'POINTS' | 'COUPONS' | 'BOTH'

Type of redemption.

start_datestring date

Retrieves redemptions made on or after a specific date (YYYY-MM-DD). To get transactions of a particular duration, use both start_date and end_date.

end_datestring date

Retrieves redemptions made on or before a specific date (YYYY-MM-DD). To get transactions of a particular duration, use both start_date and end_date. Example: start_date=2013-12-21+23:45:45&end_date=2013-12-29+12:11:45

entity_codestring

Code of the specified entity_type. For example, to get transactions of a specific zone (with zone code zone01), pass entity_type=zone&entity_code=zone01.

coupons_limitinteger

Limit the number of coupon redemptions to be displayed. Example:coupons_limit=10 to show only 10 coupon redemption details. Use only when the type parameter is not passed.

points_limitinteger

Limit the number of points redemption results to be displayed. Example:points_limit=10 to show only 10 points redemption details. Use only when the type parameter is not passed.

limitinteger

Limit the number of redemption details (points and/or coupons). Use only when the type parameter is not passed. Default value is 10.

coupons_start_idinteger

Filter the results by coupon redemption id starting with a specific number. Use only when the type parameter is not passed.

coupons_end_idinteger

Filter the results by coupon redemption id ending with a specific number. Use only when the type parameter is not passed.

points_start_idinteger

Filter the results by points redemption id ending with a specific number. Use only when the type parameter is not passed.

points_end_idinteger

Retrieves the credit notes of the transactions. Credit Notes is a receipt given by a cashier to a customer for returned goods which can be used for future purchases.

sort'redemption_id' | 'redeemed_time'

Sort the results either by redemption id or redeemed time. By default, the results are sorted in the descending order of redeemed time.

order'asc' | 'desc'

Order the results in ascending (asc) or descending order (desc). By default, the results are shown in the descending order of redeemed time.

mlpboolean

Pass true to get redemptions of the customer from all programs of the org, false to fetch from the default program associated with the till.

format'xml' | 'json'

Representation of response content.

user_idboolean

Pass true to return the customer ID in response. By default, customer id is not retrieved.

merchant_store_idinteger

Pass the merchant store ID of to fetch redemptions made in that particular merchant store.

order'asc' | 'desc'

Arranges the transactions based on the value set in sort. By default, results are shown in the descending order of transaction date/id.

program_idinteger

Pass program ID to filter redemptions of a particular program.

Response

200

Example response

{
  "response": {
    "status": {
      "success": true,
      "code": 200,
      "message": "Success"
    },
    "customer": {
      "mobile": "917939623972",
      "email": "auto_917939623972@capautomation.com",
      "external_id": "ext_id7939623972",
      "firstname": "Tom",
      "lastname": "Sawyer",
      "rows": 2,
      "points_count": 2,
      "points_start_id": 1,
      "redemptions": {
        "points": {
          "point": [
            {
              "id": 1,
              "program_id": 1098,
              "points_redeemed": 100,
              "transaction_number": "number7939623972",
              "bill_id": "12345",
              "redeemed_time": "2024-07-26 10:52:24",
              "redeemed_at": "autostore1.till2",
              "redemption_purpose": "Testing",
              "notes": "Redemption by SMS",
              "external_reference_number": "ACR-5801353177",
              "redemption_id": "8878ru",
              "redeemed_store": {
                "code": "autostore1",
                "name": "autostore1"
              },
              "redeemed_till": {
                "code": "autostore1.till2",
                "name": "autostore1.till2"
              }
            }
          ]
        }
      }
    }
  }
}