API Website World

Member Points

Points are earned and redeemed based on the loyalty points program setup in your eCommerce area. Using the memberpoints endpoint you can view the history of member points for your site and create new entries.

Endpoint URL

https://api.cms-tool.net/api/memberpoints

`/api/memberpoints`

Read and record member points adjustments.

GET

List records, or retrieve one by appending its ID to the path.

Query parameters

Name	Type	Example	Notes
`mbr_id`	int	`123`	Filter results by mbr id.
`after`	date	`2026-09-24`	Filter results by after.
`before`	date	`2026-09-24`	Filter results by before.
`includeOrders`	boolean	`true`	Include orders in the response. Accepts true or 1.
`offset`	int	`123`	Skip this many matching records before returning results.
`pageSize`	int	`123`	Limit the number of records returned; accepted values are 1 through 999, with 200 used otherwise.

POST

Create or update a record from a JSON object.

Request content type: application/json

Request body fields

Name	Type	Example	Notes
`mbr_id`	int	`123`	Set the mbr id value.
`adjustpoints`	number	`19.95`	Set the adjustpoints value.
`adjustmentnote`	text	`example`	Set the adjustmentnote value.
`adjustdate`	date	`2026-09-24`	Set the adjustdate value.

`/api/memberpointsbalances`

Read member points balances.

GET

Read member points balances.

Query parameters

Name	Type	Example	Notes
`mbr_id`	int	`123`	Filter results by mbr id.

Data definitions

Field	Type	Description
`adjustmentnote`	text	Comment about why the points were given
`point_rule`	text	The sourceof the points, eg {Review,RegoLogin}
`pointsadjustid`	serial	Unique ID for the point activity record transaction
`mbr_id`	int	The user ID to which benefits from this points adjustment
`adjustpoints`	decimal	Number of points to add or deduct. Negative points reduce the balance. Positive points increase the balance.
`object_id`	int	If the points related to a product review, then this would be the product ID
`adjustdate`	timestamp	Adjustment Timestamp

Usage instructions and examples

List your member points balances

Use the member points balances endpoint with GET method to get the points balances of all members or a query a single mbr_id.

Example url:

https://api.cms-tool.net/webapps/api/memberpointsbalances

Sample data returned:

{
    "endPoint": "memberpointsbalances",
    "resultCount": 2,
    "offset": 0,
    "data": [
        {
            "mbr_email": "test@example.com",
            "mbr_name": "Johnson",
            "mbr_id": 442531,
            "mbr_points_balance": "120.00"
        },
        {
            "mbr_email": "Jason@exmapleemail.com",
            "mbr_name": "Jason",
            "mbr_id": 445123,
            "mbr_points_balance": "50.00"
        }
    ],
    "success": true,
    "pageSize": 200
}

List your member points adjustment history

Use the member points endpoint with GET method to get the history of member points adjustments.

Example url:

https://api.cms-tool.net/webapps/api/memberpoints

Sample data returned:

{
    "endPoint": "memberpoints",
    "resultCount": 2,
    "data": [
        {
            "adjustmentnote": "test note",
            "pointsadjustid": 222,
            "mbr_id": 123123,
            "adjustpoints": "50.00",
            "id": 22232,
            "adjustdate": "2021-12-20 16:00:30.834896",
            "cid": 1111112
        },
        {
            "adjustmentnote": "example note",
            "pointsadjustid": 221,
            "mbr_id": 123,
            "adjustpoints": "120.00",
            "id": 22231,
            "adjustdate": "2021-12-20 16:27:24.343733",
            "cid": 11111112
        }
    ],
    "success": true
}

List your member points adjustment history including redemptions (for a specific member only)

View point adjustments due to orders i.e. redeemed or earned points.

This is a read only.

You must include both a mbr_id and set includeOrders to 1

Example get request url:

https://api.cms-tool.net/webapps/api/memberpoints?includeOrders=1&mbr_id=123123

Sample return data:

{
   "endPoint": "memberpoints",
   "resultCount": 1,
   "data": [
       {
           "adjustvalue": "9.00",
           "adjusttype": "earned",
           "adjustmentnote": "test custom note",
           "adjustpoints": "0.90",
           "id": 123123,
           "adjustdate": "2021-12-23 07:08:34.512266"
       }
   ],
   "success": true
}

Create new member points adjustment entry

To create a new entry use POST method and you must include the mbr_id for whom the entry is to be made. You can get all your members with ids using GET member endpoint. Below example will add 10 loyalty points for member if 1234. You can also provide negative values to update the loyalty points for a member.

You must provide a mbr_id or a mbr_email

Example:

{
   "mbr_id": 1234,
   "adjustpoints": 10,
   "adjustmentnote": "Product refund through points"
}

Sample object

       {
           "adjustvalue": "9.00",
           "adjusttype": "earned",
           "adjustmentnote": "test custom note",
           "adjustpoints": "0.90",
           "id": 123123,
           "adjustdate": "2021-12-23 07:08:34.512266"
       }

Member Points - API Reference