POST
/
v1
/
members
/
points-adjustment

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Details needed to adjust points

profileId
string

Profile ID of the member. In an ecosystem, it acts as a primary ID to keep the various systems (apps, websites, etc.) in sync.

pointType
string | null

Points type. <br /> They are categorized as: <br /> 1) Base points: Earned in any purchase transaction, based on the core rule. <br /> 2) Bonus points: Earned as a bonus for example on a large purchase. <br /> 3) Promotional Points: Earned as part of promotional events. <br /> 4) Restricted Points: Points to be used only on specified stores.

billingEntity
string | null

Billing entity for the adjustment transaction

points
number
required

Number of points to adjust. Can be positive or negative.

reasonCode
string | null

Reason code for the point adjustment

setToPending
boolean
default: false

true: Points in Pending status. <br /> false: Points in Active status. <br />Note:The time period for Pending state is configurable.

Response

200 - application/json

Details of adjusted points

message
string

Message corresponding to the call

errors
object

Error details, if any.

data
object

Adjustment details.

status
integer

Status code of call

Was this page helpful?

Activate PointsDropship API