Placewise API

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

Key	Type	Description
achievements	Achievement[]	List of Achievement objects - see Achievements
reward_activation_time	integer	Time in seconds describing how long the reward is active after use
levels_program	object	Definition 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

loyalty_club_slug

string

required

Example:

infinity-mall

Header Params

Content-Type

enum<string>

required

Details

Allowed value:

application/json

Default:

application/json

X-User-Agent

string

required

Arbitrary identifier of your client. Details

Default:

X-Product-Name

string

required

API Product for API context. Details

Default:

X-Loyalty-Club-Slug

string

required

LoyaltyClub for API context. Details

Default:

X-Customer

string

required

Customer for API context. Details

Default:

Authorization

string

required

Member or User Authorization.

Default:

Bearer {{_OAUTH_TOKEN}}

X-Client-Authorization

string

optional

Default:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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;' \
--header 'X-Client-Authorization: '

Responses

🟢200Success

application/json

Body

object {0}

Example

{}

Modified at 2024-05-07 15:47:57

Introduction

Join To Rewards Program

Show Rewards Program

Response Body#

Example#

Request

Request samples

Responses

Response Body

Example