Rewards

Getting customer rewards redeemed using points or reaching VIP tiers

List customer rewards

get
Query parameters
customerIdstringOptionalExample: {{customerId}}
beforestringOptional
afterstringOptional
shopifyCustomerIdnumberOptionalExample: 7114710712597
Header parameters
X-Joy-Loyalty-App-KeystringOptional

App ID of your shop which retrieved from the Settings page

Example: {{appKey}}
X-Joy-Loyalty-Secret-KeystringOptional

Secret Key of your shop which retrieved from the Settings page

Example: {{secretKey}}
Responses
200

OK

application/json
Responseobject
get
/rest_api/v1/rewards
200

OK

Get a reward details

get
Path parameters
customerRewardIdstringRequired
Header parameters
X-Joy-Loyalty-Secret-KeystringOptional

App ID of your shop which retrieved from the Settings page

Example: {{secretKey}}
X-Joy-Loyalty-App-KeystringOptional

Secret Key of your shop which retrieved from the Settings page

Example: {{appKey}}
Responses
200

OK

application/json
Responseobject
get
/rest_api/v1/rewards/{customerRewardId}
200

OK

Refund coupon via Rest API

post

Allows you to refund a coupon for a specific Shopify customer via Rest API.

Header parameters
X-Joy-Loyalty-App-KeystringOptional

App ID of your shop which retrieved from the Settings page

Example: {{appKey}}
X-Joy-Loyalty-Secret-KeystringOptional

Secret Key of your shop which retrieved from the Settings page

Example: {{secretKey}}
Body
couponCodestringOptionalExample: ABC123
shopifyCustomerIdintegerOptionalExample: 7278822981918
Responses
200

OK

application/json
post
/coupons/refund
200

OK

Last updated