Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get Points Balance

Retrieves points balance of a customer from a single program or all programs of the org. Points are aggregated for each Point Category - Main, delayed accrual, and external trigger based.

This is a light API.

get/customers/lookup/points/balance

Query parameters

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

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

Unique ID of the loyalty program from which points balance needs to retrieve. If not passed, it shows the points balance in the default program.

entityType'CUSTOMER' | 'FLEET'

Pass CUSTOMER to fetch the individual customer’s points balance, FLEET to see group-level details. Default value is CUSTOMER.

fetchDataForAllProgramsboolean

Pass true to fetch the sum of points balance from all the available programs of the org. Default value is false.

Headers

X-CAP-API-OAUTH-TOKENstring

Response

200