Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Deduct points and alternate currencies from user using userId

post/customers/{userid}/negativePointsAdjustment

Path parameters

userIdstring required

Unique ID of the customer (customerId).

Query parameters

source'INSTORE' | 'WEB_ENGAGE' | 'WECHAT'

Source in which the identifier is available.

Request body

pointsToBeAdjustedinteger required

Points to be deducted for the user. Provide a value greater than 0. This is applicable for points.

programIdinteger

Unique ID of the loyalty program to associate with the promotion.

reasonOfReturnstring required

Enter the reason for the return of the points.

pointsAwardedIdinteger

Unique ID of the awarded points.

promotionIdinteger

Unique identifier for the promotion

promotionIdentifierstring

Identifier for the promotion.

pointsAwardedRefType'bill_regular' | 'bill_promotions' | 'line_item_regular' | 'line_item_promotions' | 'customer_promotions'

Reference type for points awarded.

alternateCurrencyNamestring

Unique name of the alternate currency.

pointCategoryTypes'REGULAR' | 'PROMISED' | 'EXTERNAL_TRIGGER_BASED'

Points category to deduct for the user.

valueToBeAdjustedinteger

Alternate currencies to be deducted for the user. Provide a value greater than 0. This is applicable for alternate currencies. Provide the alternateCurrencyName when using this parameter.

Response

200

OR

Example response

{
  "status": "success",
  "pointsAvailable": "670.000",
  "message": "points deducted successfully for the user "
}