Tiers

Tier management

Get all tiers

get
/rest_api/v2/tiers

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
get
/rest_api/v2/tiers

Get tier by ID

get
/rest_api/v2/tiers/{tierId}
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
get
/rest_api/v2/tiers/{tierId}

Get tier benefits by type

get
/rest_api/v2/tiers/benefits/{benefitType}

Retrieve tier benefits filtered by benefit type

Path parameters
benefitTypestringRequired

Type of benefit to retrieve

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
get
/rest_api/v2/tiers/benefits/{benefitType}