Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Convert Promised Points

Convert promised points and alternate currencies to redeemable points.

post/points/unlockPromisedPoints

Query parameters

identifierNamestring required

Identifier type to identify the customer. Supported values: mobile, id, externalId, cuid, primaryUserId

identifierValuestring required

Value corresponding to the identifierName provided.

sourcestring required

Source of customer information. Supported values: INSTORE,FACEBOOK,WEB_ENGAGE,WECHAT,MARTJACK,TMALL,TAOBAO,JD,ECOMMERCE,WEBSITE,LINE,MOBILE_APP

type'USERGROUP2' | 'CUSTOMER'

Type of entity.

Request body

eventName'GenericEvent' | 'CustomerPromotionImport' | 'TargetCompleted' | 'LineitemsPointsPromotionImport' | 'BillPointsPromotionImport' | 'TransactionAdd' | 'GroupTransactionAdd' required

Name of the event to associate with unlock of promise points

billNumberstring required

Unique bill number of the transaction

eventLogIdinteger

Unique log ID of the current event.

lineItemIdsinteger[]

Array of the lineitems

itemCodesstring[]

Array of the item code

billDatestring date

Date and time of the transaction in the ISO 8601 format - YYYY-MM-DDTHH:MM:SSZ

sourceStoreIdinteger

Store id

sourceTilIdinteger

Till id

sourceProgramIdinteger

Program Id

Response

200

Example response

{
  "pointsUnlocked": [
    {
      "billNumber": "txn-67",
      "pointsUnlocked": "100.000",
      "programId": 973
    }
  ]
}