Placewise API
Get startedExplore
Get startedExplore
Performance Cloud 🗗
Placewise 🗗
ExplorePublic API
Management APIUsers APIOperations APIMessaging APIReporting APIML APIData API
ExplorePublic API
Management APIUsers APIOperations APIMessaging APIReporting APIML APIData API
  1. Rewards Program
  • Introduction
  • Loyalty Club
    • Loyalty Clubs
      • Introduction
      • Show Loyalty Club
      • List Loyalty Clubs
    • Schema
      • Show Schema
    • Legal Information
      • Show Legal Information
    • Translations
      • List Translations (v4)
      • List Translations (v3)
    • Carbon Offset Program
      • Show Carbon Offset Program Info
    • Cars
      • Show Cars Configuration
      • Show Available Cars Colors
    • Programs
      • Introduction
      • List Programs
      • Show Program
    • Receipts
      • Introduction
      • Show Receipts Configuration
  • Member
    • Authentication
      • OAuth Flow
      • One Time Password
        • Send OTP via SMS
        • Send OTP via SMS by Email
        • Send OTP via Email
        • Send OTP via Email by MSISDN
      • Registration Password
        • Send Registration Password SMS
        • Send Registration Password Email
      • Create Token
      • Revoke Token
      • Show Token Info
    • Profile
      • Public Info
        • Show Member Public Info
        • Show Member Public Info by MSISDN
        • Show Member Public Info by Email
      • Person ID
        • Show Member Person ID
        • Show Member Person ID by MSISDN
        • Show Member Person ID by Email
      • Create Member
      • Update Member
      • Validate Member
      • Register Member App Token
      • Show Member
      • Destroy Member
    • Programs
      • Registration
        • Start
        • Confirm
      • Update Member Programs
      • Add Member to Program
      • List Member Programs
      • Remove Member from Program
    • Cars
      • Introduction
      • List Member Cars
      • Create Member Car
      • Show Member Car
      • Update Member Car
      • Renew Member Car
      • Destroy Member Car
      • Lookup a Car
    • Benefits
      • Introduction
      • List Member Benefits
      • Show Member Benefit
    • Verification
      • Send Verification Email
      • Send Verification SMS
      • Verify Email
      • Verify MSISDN
    • Password
      • Update Password
      • Reset Password
      • Send Password Reset Token
    • Integrations
      • Amano Parking Integration
        • Create Card
        • Delete Card
      • Spaycial Integrations
        • Generate Connections URL
        • Generate Connect URL
        • Show Spaycial Connections Status
        • Show Spaycial Feature Settings
        • Update Spaycial Feature Settings
    • Receipts
      • Introduction
      • List Submissions
      • Show Submission
      • Create Submission
      • Update Submission
      • Delete Submission
      • Check Limits Exceeded
    • Misc
      • Checkin to Store
      • Show Member Messages History v2
    • Files
      • Uploads
        • Upload status
        • Start Upload
        • Upload Part
        • Finish Upload
        • Activate Uploaded File
    • Messages
      • Send "delivered" event for push message
      • Send "open" event for push message
  • Offers
    • Introduction
    • Offers
      • Show Offers Meta
      • Show Offer
      • Encode Offer
      • List Offers
      • Use Offer
      • Like Offer
      • Unlike Offer
    • Offers Preview
      • Preview Offers Meta
      • Preview Offer
      • Preview Offers List
    • Events
      • Introduction
      • Register "clicked" Event
      • Register "seen" Event
  • Rewards
    • Introduction
    • Rewards Program
      • Show Rewards Program
        GET
      • Join To Rewards Program
        POST
      • Leave Rewards Program
        DELETE
      • Show Member Rewards Program Status
        GET
      • Show Achievements Summary
        GET
    • Rewards
      • List Rewards
      • List Purchased Rewards
      • Purchase Reward
      • Use Reward
  • Games
    • Introduction
    • Games
      • List Games
      • Show Game Details
      • Show Game Ticket
      • Play Game
      • Issue Game Prize
  • CMS Content
    • Introduction
    • Website
      • Introduction
      • Show Website
    • Venue Info
      • Introduction
      • Show Venue Info
    • Components
      • Component Schema Model
      • Show Components Schema
    • Pages
      • Page Model
      • List Pages
      • Show Page
      • Route Page
    • Articles
      • Article Model
      • Articles Categories
        • List Articles Categories
        • Show Articles Categories
      • List Articles
      • Show Article
    • Events
      • Event Model
      • Events Groups
        • Introduction
        • List Events Groups
        • Show Events Group
      • Events Categories
        • List Events Categories
        • Show Events Categories
      • List Events
      • Show Event
    • Job Postings
      • Introduction
      • List Job Postings
      • Show Job Posting
    • Service Messages
      • Introduction
      • List Service Messages
      • Show Service Message
    • Stores
      • Introduction
      • List
      • Show
    • Stores Categories
      • Introduction
      • List Stores Categories
      • Show Stores Category
    • Promotions
      • Introduction
      • List Promotions Collections
      • List Promotions
      • Show Promotion
    • Press Releases
      • Press Release Model
      • List Press Releases
      • Show Press Release
    • Attachments
      • Attachment Model
      • List Attachments
  1. Rewards Program

Show Rewards Program

Pending
GET
https://api.mpc.dev.placewise.com/v3/{loyalty_club_slug}/rewards-program/info
API Permit:Rewards:Api:Program:GetInfo
API Context:Loyalty Club
Authorizations:UserToken
Returns information about Rewards Program in Loyalty Club.

Response Body#

KeyTypeDescription
achievementsAchievement[]List of Achievement objects - see Achievements
reward_activation_timeintegerTime in seconds describing how long the reward is active after use
levels_programobjectDefinition of member levels - see Levels. When null, there are no levels.

Example#

When successful, returns JSON structured like this:
{
  "achievements": [
    {
      "id": 1,    
      "type": "app_opened",
      "name": "App opened",
      "points": 50,
      "limit": 20,
      "frequency": {
        "limit": 10,
        "timespan": "day"
      }
    },
    {
      "id": 2,   
      "type": "consent_granted",
      "name": "Consents granted",
      "points": 1000,
      "limit": null,
      "frequency": null
    }
  ],
  "levels_program": {
    "type": "regular",
    "levels": [
        {
          "name": "1",
          "points_threshold": 100
        },
        {
          "name": "2",
          "points_threshold": 300
        },
        {
          "name": "3",
          "points_threshold": 500
        }
    ]
  },
  "reward_activation_time": 35
}

Request

Path Params

Header Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C#
Ruby
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.mpc.dev.placewise.com/v3/infinity-mall/rewards-program/info' \
--header 'X-User-Agent;' \
--header 'X-Product-Name;' \
--header 'X-Loyalty-Club-Slug;' \
--header 'X-Customer;' \
--header 'Authorization: Bearer ' \
--header 'X-Client-Authorization: '

Responses

🟢200Success
application/json
Body

Example
{}
Previous
Introduction
Next
Join To Rewards Program
Built with