Rewards

Getting customer rewards redeemed using points or reaching VIP tiers

List customer rewards

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

Query parameters

Header parameters

Response

200

OK

Headers

Body

application/json

object

Request

JavaScriptCurlPython

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

Get a reward details

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

Path parameters

customerRewardId*string

Header parameters

Response

200

OK

Headers

Body

application/json

object

Request

JavaScriptCurlPython

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

Refund coupon via Rest API

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

POSThttps://dev-api.joy.so/coupons/refund

Header parameters

Body

application/json

couponCodestring

Example: "ABC123"

shopifyCustomerIdinteger

Example: 7278822981918

Response

200

OK

Headers

Body

application/json

successboolean

Request

JavaScriptCurlPython

const response = await fetch('https://dev-api.joy.so/coupons/refund', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "success": true
}