Joy dev docs
User guide
  • Joy Javascript API
    • Introduction to the Joy SDK
    • Public API get methods
    • Public API action methods
    • Widget methods
  • Joy REST API
    • Customers
    • Earning programs
    • Redeeming programs
    • Points history
    • Rewards
    • Point manupulation
    • VIP Tiers
    • Referral
  • JOY OPEN API V2
    • Customer
Powered by GitBook
On this page
  1. Joy REST API

VIP Tiers

PreviousPoint manupulationNextReferral

Last updated 7 months ago

List VIP programs

get
Header parameters
X-Joy-Loyalty-App-KeystringOptionalExample: {{appKey}}
X-Joy-Loyalty-Secret-KeystringOptionalExample: {{secretKey}}
Responses
200
OK
application/json
get
GET /rest_api/v1/tiers HTTP/1.1
Host: dev-api.joy.so
Accept: */*
200

OK

{
  "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
Path parameters
tierIdstringRequired
Header parameters
X-Joy-Loyalty-App-KeystringOptionalExample: {{appKey}}
X-Joy-Loyalty-Secret-KeystringOptionalExample: {{secretKey}}
Responses
200
OK
application/json
get
GET /rest_api/v1/tiers/{tierId} HTTP/1.1
Host: dev-api.joy.so
Accept: */*
200

OK

{
  "success": true,
  "tier": {
    "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": []
  }
}
  • GETList VIP programs
  • GETGet one VIP tier