Skip to main content
POST
Adjust Points

Authorizations

Authorization
string
header
required

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

Body

application/json

Details needed to adjust points

points
number<integer>
required

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

Example:

100

profileId
string<uuid>

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

Example:

"f90a1da5-c072-48b7-a9ea-eb35c5dd506b"

pointType
string | null

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

Minimum string length: 1
Example:

"Base"

billingEntity
string | null

Billing entity for the adjustment transaction

Minimum string length: 1
Example:

"Company_Club"

reasonCode
string | null

Reason code for the point adjustment

Minimum string length: 1
Example:

"7502"

setToPending
boolean
default:false

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

Response

OK

Details of adjusted points

message
string

Message corresponding to the call

Example:

"Member points adjusted"

errors
Errors · object

Error details, if any.

data
object

Adjustment details.

status
integer<int32>

Status code of call

Example:

200