VIP Tiers

List VIP programs

GEThttps://dev-api.joy.so/rest_api/v1/tiers

Header parameters

Response

200

OK

Headers

Body

application/json

successboolean

tiersarray of object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://dev-api.joy.so/rest_api/v1/tiers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "success": false,
  "tiers": [
    {
      "id": "text",
      "isSystemTier": false,
      "icon": "text",
      "rateMoney": "text",
      "iconCustom": "text",
      "placedOrderReward": false,
      "earnPoint": "text",
      "createdAt": "2025-01-22T08:02:57.815Z",
      "targetPoint": 0,
      "members": 0,
      "name": "text",
      "systemType": "bronze",
      "shopId": "text",
      "updatedAt": "2025-01-22T08:02:57.815Z",
      "tierRewards": []
    }
  ]
}

Get one VIP tier

GEThttps://dev-api.joy.so/rest_api/v1/tiers/{tierId}

Path parameters

tierId*string

Header parameters

Response

200

OK

Headers

Body

application/json

successboolean

tierobject

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://dev-api.joy.so/rest_api/v1/tiers/{tierId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "success": false,
  "tier": {
    "id": "text",
    "isSystemTier": false,
    "icon": "text",
    "rateMoney": "text",
    "iconCustom": "text",
    "placedOrderReward": false,
    "earnPoint": "text",
    "createdAt": "2025-01-22T08:02:57.815Z",
    "targetPoint": 0,
    "members": 0,
    "name": "text",
    "systemType": "text",
    "shopId": "text",
    "updatedAt": "2025-01-22T08:02:57.815Z",
    "tierRewards": []
  }
}

List VIP programs

GEThttps://dev-api.joy.so/rest_api/v1/tiers

Header parameters

Response

200

OK

Headers

Body

application/json

successboolean

tiersarray of object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://dev-api.joy.so/rest_api/v1/tiers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "success": false,
  "tiers": [
    {
      "id": "text",
      "isSystemTier": false,
      "icon": "text",
      "rateMoney": "text",
      "iconCustom": "text",
      "placedOrderReward": false,
      "earnPoint": "text",
      "createdAt": "2025-01-22T08:02:57.815Z",
      "targetPoint": 0,
      "members": 0,
      "name": "text",
      "systemType": "bronze",
      "shopId": "text",
      "updatedAt": "2025-01-22T08:02:57.815Z",
      "tierRewards": []
    }
  ]
}

Get rewards for a specific tier

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

GEThttps://dev-api.joy.so/rest_api/v1/tiers/rewards/{type}

Path parameters

type*enum

tier_spendingtier_privileges

Query parameters

Header parameters

Response

200

OK

Headers

Body

application/json

dataobject

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://dev-api.joy.so/rest_api/v1/tiers/rewards/{type}?tierIdFilter=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "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
  }
}