VIP Tiers

PreviousPoint manupulation NextReferral

Last updated 4 months ago

List VIP programs

get

/rest_api/v1/tiers

Header parameters

X-Joy-Loyalty-App-Keystring

Example: {{appKey}}

X-Joy-Loyalty-Secret-Keystring

Example: {{secretKey}}

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://dev-api.joy.so/rest_api/v1/tiers'

200

{
  "success": true,
  "tiers": [
    {
      "id": "3V2MEbloIVUmVhBbEzO1",
      "isSystemTier": true,
      "icon": "https://cdnapps.avada.io/joy/vip-tiers/icons/bronze.png",
      "rateMoney": "",
      "iconCustom": "",
      "placedOrderReward": false,
      "earnPoint": "",
      "createdAt": "2023-07-14T04:08:05.498Z",
      "targetPoint": 0,
      "members": 0,
      "name": "Bronze",
      "systemType": "bronze",
      "shopId": "nDaevBKY0zGCzmJz8mCv",
      "updatedAt": "2023-07-14T04:08:05.498Z",
      "tierRewards": []
    },
    {
      "id": "15VYE9Go7vje7UVtfz3T",
      "isSystemTier": true,
      "icon": "https://cdnapps.avada.io/joy/vip-tiers/icons/silver.png",
      "rateMoney": "",
      "iconCustom": "",
      "placedOrderReward": false,
      "earnPoint": "",
      "createdAt": "2023-07-14T04:08:05.499Z",
      "targetPoint": 200,
      "members": 0,
      "name": "Silver",
      "systemType": "silver",
      "shopId": "nDaevBKY0zGCzmJz8mCv",
      "updatedAt": "2023-07-14T04:08:05.499Z",
      "tierRewards": []
    },
    {
      "id": "YYDfREeDKmTmQTnkJTdE",
      "isSystemTier": true,
      "icon": "https://cdnapps.avada.io/joy/vip-tiers/icons/gold.png",
      "rateMoney": "",
      "iconCustom": "",
      "placedOrderReward": false,
      "earnPoint": "",
      "createdAt": "2023-07-14T04:08:05.499Z",
      "targetPoint": 500,
      "members": 0,
      "name": "Gold",
      "systemType": "gold",
      "shopId": "nDaevBKY0zGCzmJz8mCv",
      "updatedAt": "2023-07-14T04:08:05.499Z",
      "tierRewards": []
    }
  ]
}

Get one VIP tier

get

/rest_api/v1/tiers/{tierId}

Path parameters

tierIdstringrequired