v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get Goodwill Requests

Retrieves the history of goodwill points of a customer.

get/customers/{customerId}/goodwillRequest

Path parameters

customerIdinteger required

Pass the unique ID of the customer whose goodwill request details you want to fetch.

Query parameters

requestIdinteger

Unique id of the goodwill request that you want to fetch.

is_one_step_changeboolean

Pass true to fetch goodwill points or coupon requests that are issued instantly (one step issual).

programIdstring

Get requests of a specific loyalty program. Pass the unique loyalty program ID.

autoApproveboolean

Pass true to fetch requests that are auto-approved - without the involvement of the back-end team.

Response

200

Example response

{
  "pagination": {
    "limit": 10,
    "total": 2
  },
  "data": [
    {
      "id": 43114,
      "addedBy": {
        "id": 15000449,
        "code": "1371622280_919866643044",
        "name": "1371622280_Ashish",
        "type": "ADMIN_USER",
        "adminType": "GENERAL",
        "isActive": true
      },
      "updatedBy": {
        "id": 15000449,
        "code": "1371622280_919866643044",
        "name": "1371622280_Ashish",
        "type": "ADMIN_USER",
        "adminType": "GENERAL",
        "isActive": true
      },
      "addedOn": "2019-11-04T15:18:23+05:30",
      "updatedOn": "2019-11-04T15:18:23+05:30",
      "userId": 343040815,
      "requestId": 770197,
      "goodwillType": "POINTS",
      "goodwillStatus": "APPROVED",
      "comments": "sample",
      "reason": " ",
      "approvedValue": "450",
      "updatedComments": "sample; AUTO_APPROVED"
    }
  ]
}