v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get Points Conversion Schedule

Retrieves the history of promised points conversion schedules of a customer for a single program or across all programs of the org.

This is a light API.

get/customers/lookup/promisedPointsSchedule

Query parameters

Source in which the customer identifier is available.

accountIdstring

Account in which the customer details are available (Required only for sources with multiple accounts).

identifierName'mobile' | 'email' | 'externalId' | 'cardExternalId' | 'cardNumber' required

Identifier type used for the customer.

identifierValuestring required

Value of the respective identifier. For example if identifierName is email, then the identifierValue needs to be the email ID of the customer.

programIdinteger

Fetch points conversion schedules of the customer from a specific program. Pass the programId. If not passed, it shows the points balance in the default program.

entityType'CUSTOMER' | 'FLEET'

Pass CUSTOMER to fetch the points conversion schedules of an individual (customer), FLEET to fetch details at the group level. Default value is CUSTOMER.

fetchDataForAllProgramsboolean

Pass true to fetch points conversion schedules from all the available programs of the org.

startDatestring date

Date (YYYY-MM-DD) from which points conversion schedule details need to be fetched. Minimum supported date - current time + 1 day. Default value - current time.

endDatestring date

End date (YYYY-MM-DD) for the points conversion schedule details need to be fetched. Maximum supported date - current time + 100 years (this is the default value).

Headers

X-CAP-API-OAUTH-TOKENstring

Response

200

entityIdinteger

entityTypestring

Example response

{
  "entityId": 374844123,
  "entityType": "CUSTOMER",
  "promisedPointsScheduleList": [
    {
      "points": 390,
      "redeemableFrom": "2022-04-10",
      "programId": 2199,
      "pointsType": "line_item_promotions"
    }
  ],
  "triggerBasedPointsList": [
    {
      "points": 300,
      "programId": 890,
      "pointsType": "line_item_promotions"
    }
  ]
}