VIP Tiers

List VIP programs

get

Header parameters

X-Joy-Loyalty-App-KeystringOptionalExample: {{appKey}}

X-Joy-Loyalty-Secret-KeystringOptionalExample: {{secretKey}}

Responses

200

OK

application/json

get

/rest_api/v1/tiers

HTTPcURLJavaScriptPython

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

/rest_api/v1/tiers/{tierId}

HTTPcURLJavaScriptPython

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": []
  }
}

Get rewards for a specific tier

get

Retrieve rewards based on tier type (tier_spending or tier_privileges) and a specific tier ID.

Path parameters

typestring · enumRequiredPossible values:

Query parameters

tierIdFilterstringRequired

Header parameters

X-Joy-Loyalty-App-KeystringOptionalExample: {{appKey}}

X-Joy-Loyalty-Secret-KeystringOptionalExample: {{secretKey}}

Responses

200

OK

application/json

get

/rest_api/v1/tiers/rewards/{type}

HTTPcURLJavaScriptPython

GET /rest_api/v1/tiers/rewards/{type}?tierIdFilter=text HTTP/1.1
Host: dev-api.joy.so
Accept: */*

200

OK

{
  "data": {
    "spendPoint": 100,
    "showLoyaltyPage": true,
    "isTierPrivileges": false,
    "redeemed": 23,
    "earnAmount": "1",
    "title": "Entry Reward Program",
    "type": "tier_spending",
    "priority": 0,
    "createdAt": "2024-08-05T09:11:26.728Z",
    "translateTitle": {
      "it": ""
    },
    "redeemType": "fixed",
    "event": "percentage_discount",
    "status": true,
    "id": "s7pBj30zXHhUMb6iWQHC",
    "expired": false
  },
  "count": 1,
  "pageInfo": {
    "hasNext": false,
    "hasPre": false
  }
}