Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get Points Expiry Schedule (Light API)

get/customers/lookup/pointsExpirySchedule

Query parameters

source'FACEBOOK' | 'WEB_ENGAGE' | 'WECHAT' | 'INSTORE' | 'MARTJACK' | 'TMALL' | 'TAOBAO' | 'JD' | 'ECOMMERCE' | 'WEBSITE' | 'LINE' | 'ALL' required

Source on which the identifier is available.

accountIdstring

Account ID of a specific source if the source has multiple accounts.

identifierName'mobile' | 'email' | 'externalId' | 'cardnumber' | 'cardExternalId' | 'wechat' | 'martjackId' | 'fbId' required

Identifier type used to fetch the customer's expiry schedule details.

identifierValuestring required

Identifier of the customer specific to the identifierName.

fetchDataForAllProgramsboolean

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

fetchEarliestExpiryOnlyboolean

Pass true to fetche earliest points expiry records of default program or passed programId

startDatestring

Date (YYYY-MM-DD) from which points conversion schedule details need to be fetched. Default value - current time.

endDatestring

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

programIdstring

Unique ID of the program.

Response

200

OR
OR
OR
OR
OR

Example response

{
  "id": 421098436,
  "loyaltyInfo": {
    "loyaltyType": "loyalty"
  },
  "expirySchedules": [
    {
      "points": 100,
      "expiryDate": "2122-03-20",
      "programId": 1356,
      "pointsType": "line_item_regular",
      "expiryType": "fixed"
    }
  ]
}