# VIP Tiers

## GET /rest\_api/v1/tiers

> List VIP programs

```json
{"openapi":"3.0.0","info":{"title":"Joy Loyalty Program - API REST","version":"1.0.0"},"tags":[{"name":"VIPs"}],"servers":[{"url":"https://dev-api.joy.so"}],"paths":{"/rest_api/v1/tiers":{"get":{"tags":["VIPs"],"summary":"List VIP programs","parameters":[{"name":"X-Joy-Loyalty-App-Key","in":"header","schema":{"type":"string"}},{"name":"X-Joy-Loyalty-Secret-Key","in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"Connection":{"schema":{"type":"string"}},"Content-Length":{"schema":{"type":"integer"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}},"Cache-Control":{"schema":{"type":"string"}},"Content-Type":{"schema":{"type":"string"}},"Function-Execution-Id":{"schema":{"type":"string"}},"Server":{"schema":{"type":"string"}},"Strict-Transport-Security":{"schema":{"type":"string"}},"X-Cloud-Trace-Context":{"schema":{"type":"string"}},"X-Country-Code":{"schema":{"type":"string"}},"Accept-Ranges":{"schema":{"type":"string"}},"Date":{"schema":{"type":"string"}},"X-Served-By":{"schema":{"type":"string"}},"X-Cache":{"schema":{"type":"string"}},"X-Cache-Hits":{"schema":{"type":"integer"}},"X-Timer":{"schema":{"type":"string"}},"Vary":{"schema":{"type":"string"}},"alt-svc":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"tiers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"isSystemTier":{"type":"boolean"},"icon":{"type":"string"},"rateMoney":{"type":"string"},"iconCustom":{"type":"string"},"placedOrderReward":{"type":"boolean"},"earnPoint":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"targetPoint":{"type":"integer"},"members":{"type":"integer"},"name":{"type":"string"},"systemType":{"type":"string","enum":["bronze","silver","gold"]},"shopId":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"},"tierRewards":{"type":"array"}}}}}}}}}}}}}}
```

## GET /rest\_api/v1/tiers/{tierId}

> Get one VIP tier

```json
{"openapi":"3.0.0","info":{"title":"Joy Loyalty Program - API REST","version":"1.0.0"},"tags":[{"name":"VIPs"}],"servers":[{"url":"https://dev-api.joy.so"}],"paths":{"/rest_api/v1/tiers/{tierId}":{"get":{"tags":["VIPs"],"summary":"Get one VIP tier","parameters":[{"name":"X-Joy-Loyalty-App-Key","in":"header","schema":{"type":"string"}},{"name":"X-Joy-Loyalty-Secret-Key","in":"header","schema":{"type":"string"}},{"name":"tierId","in":"path","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"OK","headers":{"Connection":{"schema":{"type":"string"}},"Content-Length":{"schema":{"type":"integer"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}},"Cache-Control":{"schema":{"type":"string"}},"Content-Type":{"schema":{"type":"string"}},"Function-Execution-Id":{"schema":{"type":"string"}},"Server":{"schema":{"type":"string"}},"Strict-Transport-Security":{"schema":{"type":"string"}},"X-Cloud-Trace-Context":{"schema":{"type":"string"}},"X-Country-Code":{"schema":{"type":"string"}},"Accept-Ranges":{"schema":{"type":"string"}},"Date":{"schema":{"type":"string"}},"X-Served-By":{"schema":{"type":"string"}},"X-Cache":{"schema":{"type":"string"}},"X-Cache-Hits":{"schema":{"type":"integer"}},"X-Timer":{"schema":{"type":"string"}},"Vary":{"schema":{"type":"string"}},"alt-svc":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"tier":{"type":"object","properties":{"id":{"type":"string"},"isSystemTier":{"type":"boolean"},"icon":{"type":"string"},"rateMoney":{"type":"string"},"iconCustom":{"type":"string"},"placedOrderReward":{"type":"boolean"},"earnPoint":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"targetPoint":{"type":"integer"},"members":{"type":"integer"},"name":{"type":"string"},"systemType":{"type":"string"},"shopId":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"},"tierRewards":{"type":"array","items":{"type":"object"}}}}}}}}}}}}}}
```

## Get rewards for a specific tier

> Retrieve rewards based on tier type (tier\_spending or tier\_privileges) and a specific tier ID.

```json
{"openapi":"3.0.0","info":{"title":"Joy Loyalty Program - API REST","version":"1.0.0"},"tags":[{"name":"VIPs"}],"servers":[{"url":"https://dev-api.joy.so"}],"paths":{"/rest_api/v1/tiers/rewards/{type}":{"get":{"tags":["VIPs"],"summary":"Get rewards for a specific tier","description":"Retrieve rewards based on tier type (tier_spending or tier_privileges) and a specific tier ID.","parameters":[{"name":"X-Joy-Loyalty-App-Key","in":"header","schema":{"type":"string"}},{"name":"X-Joy-Loyalty-Secret-Key","in":"header","schema":{"type":"string"}},{"name":"type","in":"path","schema":{"type":"string","enum":["tier_spending","tier_privileges"]},"required":true},{"name":"tierIdFilter","in":"query","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"OK","headers":{"Connection":{"schema":{"type":"string"}},"Content-Length":{"schema":{"type":"integer"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}},"Cache-Control":{"schema":{"type":"string"}},"Content-Type":{"schema":{"type":"string"}},"Date":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"spendPoint":{"type":"integer"},"showLoyaltyPage":{"type":"boolean"},"isTierPrivileges":{"type":"boolean"},"redeemed":{"type":"integer"},"earnAmount":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"priority":{"type":"integer"},"createdAt":{"type":"string","format":"date-time"},"translateTitle":{"type":"object","additionalProperties":{"type":"string"}},"redeemType":{"type":"string"},"event":{"type":"string"},"status":{"type":"boolean"},"id":{"type":"string"},"expired":{"type":"boolean"}}}},"count":{"type":"integer"},"pageInfo":{"type":"object","properties":{"hasNext":{"type":"boolean"},"hasPre":{"type":"boolean"}}}}}}}}}}}}}}}
```