Tiers

Tier management

Get tier by ID

get

Path parameters

tierIdstringRequired

Tier ID

Header parameters

X-Joy-Loyalty-App-KeystringRequired

App ID of your shop which retrieved from the Settings page

Example: {{appKey}}

X-Joy-Loyalty-Secret-KeystringRequired

Secret Key of your shop which retrieved from the Settings page

Example: {{secretKey}}

Responses

200

Tier details

application/json

Responseall of

404

Tier not found

application/json

get

HTTPcURLJavaScriptPython

GET /rest_api/v2/tiers/{tierId} HTTP/1.1
Host: dev-api.joy.so
X-Joy-Loyalty-App-Key: text
X-Joy-Loyalty-Secret-Key: text
Accept: */*

{
  "success": true,
  "data": {
    "id": "0cd20cc6-1cac-40fe-b350-49deca03470d",
    "name": "VIP - PRO",
    "icon": "https://cdnapps.avada.io/joy/vip-tiers/icons/bronze.png",
    "iconCustom": "text",
    "targetPoint": 5000,
    "targetPointUpdate": 5000,
    "members": 42,
    "placedOrderReward": false,
    "rateMoney": "text",
    "earnPoint": "text",
    "shopId": "umN0f3GKyQC3XS1AwVWg",
    "imageBlock": "https://cdnapps.avada.io/joy/vip-tiers/icons/bronze.png",
    "tierRewards": [],
    "inactive": false,
    "isExclusiveTier": false,
    "prevNames": [],
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-20T14:45:30.000Z"
  },
  "meta": {},
  "message": "Operation completed successfully",
  "timestamp": "2023-07-28T07:27:54.123Z"
}

Get all tiers

get

Retrieve all customer tiers for the authenticated shop

Header parameters

X-Joy-Loyalty-App-KeystringRequired

App ID of your shop which retrieved from the Settings page

Example: {{appKey}}

X-Joy-Loyalty-Secret-KeystringRequired

Secret Key of your shop which retrieved from the Settings page

Example: {{secretKey}}

Responses

200

List of tiers

application/json

Responseall of

401

Authentication required

application/json

403

Plan upgrade required

application/json

500

Internal server error

application/json

get

HTTPcURLJavaScriptPython

GET /rest_api/v2/tiers HTTP/1.1
Host: dev-api.joy.so
X-Joy-Loyalty-App-Key: text
X-Joy-Loyalty-Secret-Key: text
Accept: */*

{
  "success": true,
  "data": [
    {
      "id": "0cd20cc6-1cac-40fe-b350-49deca03470d",
      "name": "VIP - PRO",
      "icon": "https://cdnapps.avada.io/joy/vip-tiers/icons/bronze.png",
      "iconCustom": "text",
      "targetPoint": 5000,
      "targetPointUpdate": 5000,
      "members": 42,
      "placedOrderReward": false,
      "rateMoney": "text",
      "earnPoint": "text",
      "shopId": "umN0f3GKyQC3XS1AwVWg",
      "imageBlock": "https://cdnapps.avada.io/joy/vip-tiers/icons/bronze.png",
      "tierRewards": [],
      "inactive": false,
      "isExclusiveTier": false,
      "prevNames": [],
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-20T14:45:30.000Z"
    }
  ],
  "meta": {
    "count": 1
  },
  "message": "Operation completed successfully",
  "timestamp": "2023-07-28T07:27:54.123Z"
}