Show Member Rewards Program Status
Pending
GET
https://api.mpc.dev.placewise.com/v3/{loyalty_club_slug}/members/me/rewards-program/status
API Permit:Rewards:Api:OAuth:Memberships:CheckStatus
API Context:Loyalty Club
Authorizations:TokenMember
Query Parameters
| Parameter | Type | Required? | Default | Description |
|---|---|---|---|---|
| per_page | integer | no | 1000 | Number of transactions to be returned per request (1000 is the maximum) |
| page | integer | no | 1 | Number of transactions page |
Response Body
| Key | Type | Description |
|---|---|---|
| membership | boolean | Does member participate the Rewards Program? |
| membership_started_at | Date | When the member joined the Rewards Program |
| balance | integer | Member's current points number |
| transactions | Array | List of Transactions objects, ordered by date descending. See below |
| pagination_info | Object | Pagination object describing transactions list |
Transaction object
| Key | Type | Description |
|---|---|---|
| id | integer | |
| type | One of: 'achievement', 'reward_purchase', 'expiration' and 'correction' | see 'Transaction types' below |
| date | Date | When the transaction has been made |
| amount | integer | How many points the transaction added or subtracted |
| expired_at | Date | (optional) When the points granted by the transaction expired. When null, they're not expired |
| details | Object | Transaction-specific details - see 'Transaction details' below |
Transaction types
| Type | Description |
|---|---|
| achievement | Addition of points triggered by fulfilling an achievement goal |
| reward_purchase | Reduction of points caused by purchasing a reward by member |
| expiration | Reduction of points caused by automatic expiration of old transactions |
| correction | Change of points caused by admin's manual correction |
| grant | Arbitrary addition of points |
| cancellation | Cancellation of another transaction |
Transaction details
| Transaction type | Key | Description |
|---|---|---|
| achievement | achievement_type | Type of achievement that granted the points - see Achievement types |
| achievement | rule_id | ID of achievement/rule |
| reward_purchase | reward_name | Name of reward that the points have been spent on |
| correction | comment | (optional) Admin's notes |
| grant | grant_type | (optional) See Grant points |
| grant | grant_properties | (optional) See Grant points |
| cancellation | cancelled_transaction_id | (optional) ID of cancelled transaction - see Cancel transaction |
Example
{
"membership": true,
"membership_started_at": "2019-05-15T12:43:22:41063Z",
"balance": 180,
"transactions": [
{
"id": 7,
"type": "reward_purchase",
"date": "2019-12-15T08:00:15063Z",
"amount": -20,
"expired_at": null,
"cancelled_at": null,
"details": {
"reward_name": "Awesome Toaster"
}
},
{
"id": 6,
"type": "expiration",
"date": "2019-12-14T08:00:15063Z",
"amount": -110,
"expired_at": null,
"cancelled_at": null,
"details": {}
},
{
"id": 5,
"type": "achievement",
"date": "2019-12-10T08:00:15063Z",
"amount": 150,
"expired_at": null,
"cancelled_at": null,
"details": {
"achievement_type": "app_opened",
"rule_id": 1
}
},
{
"id": 4,
"type": "correction",
"date": "2019-12-05T08:00:15063Z",
"amount": 50,
"expired_at": null,
"cancelled_at": null,
"details": {
"comment": "Just for you"
}
},
{
"id": 3,
"type": "achievement",
"date": "2019-06-14T08:00:15063Z",
"amount": 110,
"expired_at": "2019-12-15T08:00:15063Z",
"cancelled_at": null,
"details": {
"achievement_type": "coupon_used",
"rule_id": 2
}
},
{
"id": 2,
"type": "cancellation",
"date": "2019-06-12T058:00:13263Z",
"amount": -42,
"expired_at": null,
"cancelled_at": "2019-06-12T058:00:13263Z",
"details": {
"cancelled_transaction_id": 1
}
},
{
"id": 1,
"type": "grant",
"date": "2019-06-12T058:00:13263Z",
"amount": 42,
"expired_at": null,
"cancelled_at": "2019-06-12T058:00:13263Z",
"details": {
"grant_type": "receipt",
"grant_properties": { "store_id": 142 }
}
}
],
"pagination_info": {
"total_count": 2050,
"per_page": 1000,
"total_pages": 3,
"current_page": 1,
"next_page": 2,
"prev_page": null,
"is_first_page": true,
"is_last_page": false,
"is_out_of_range": false
}
}{
"membership": false
}Request
Path Params
loyalty_club_slug
stringÂ
required
Example:
infinity-mall
Header Params
X-Loyalty-Club-Slug
stringÂ
required
Default:
{{LOYALTY_CLUB_SLUG}}
X-Client-Authorization
stringÂ
optional
Default:
{{API_TOKEN}}
Request samples
Responses
Modified at 2024-05-07 15:47:57