Referral

Get referral link

POST/rest_api/v1/referral/getLink

Parameters

X-Joy-Loyalty-App-Keyheader · stringOptional

X-Joy-Loyalty-Secret-Keyheader · stringOptional

Request body

emailstringRequired

Responses

200OK

dataobjectOptional

Show properties

urlReferralstringOptional

Link referral of customer

POST/rest_api/v1/referral/getLink

POST /rest_api/v1/referral/getLink HTTP/1.1
Host: dev-api.joy.so
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "email": "[email protected]"
}

200OK

{
  "data": {
    "urlReferral": "https://joy-dev.com/i/Ln2M"
  }
}

Get list refer by shopify customer id

GET/rest_api/v1/referral/{shopifyCustomerId}

Parameters

X-Joy-Loyalty-App-Keyheader · stringOptional

X-Joy-Loyalty-Secret-Keyheader · stringOptional

shopifyCustomerIdpath · stringRequired

Responses

200OK

dataobject[]Optional

Show properties

idstringOptional

referralCustomerEmailstringOptional

Email of the inviting customer

statusReferralstringOptional

Status of referral

customerIdstringOptional

The customer id is identified by joy

couponCodestringOptional

The coupon code is generated by Joy

emailstringOptional

The email of invited customer

updatedAtstring · date-timeOptional

The date and time when the record was updated

createdAtstring · date-timeOptional

The date and time when the record was created

countintegerOptional

pageInfoobjectOptional

Show properties

hasPrebooleanOptional

hasNextbooleanOptional

GET/rest_api/v1/referral/{shopifyCustomerId}

GET /rest_api/v1/referral/{shopifyCustomerId} HTTP/1.1
Host: dev-api.joy.so
Accept: */*

200OK

{
  "data": [
    {
      "id": "J9JT65z3Ne8vHUo1lItr",
      "referralCustomerEmail": "[email protected]",
      "email": "h*****[email protected],",
      "couponCode": "JOY-02Q47LXBY1OJ",
      "customerId": "EFqXuCw5jszwXCJ5N6b2",
      "statusReferral": "pending_referral",
      "createdAt": "2024-09-22T17:02:26.394Z",
      "updatedAt": "2024-09-22T17:02:26.394Z"
    },
    {
      "id": "A8JT65z3Ne8cHUo1lItr",
      "referralCustomerEmail": "[email protected]",
      "email": "a*****[email protected],",
      "couponCode": "JOY-02Q47LXBY1OJ",
      "customerId": "EFqXuCw5jszwXCJ5N6b2",
      "statusReferral": "complete_referral",
      "createdAt": "2024-08-22T17:02:26.394Z",
      "updatedAt": "2024-08-22T17:02:26.394Z"
    },
    {
      "id": "9OJT65z3Ne8cHUo1lItr",
      "referralCustomerEmail": "[email protected]",
      "email": "b*****[email protected],",
      "couponCode": "JOY-02Q47LXBY1OJ",
      "customerId": "EFqXuCw5jszwXCJ5N6b2",
      "statusReferral": "cancel_referral",
      "createdAt": "2024-07-22T17:02:26.394Z",
      "updatedAt": "2024-07-22T17:02:26.394Z"
    }
  ],
  "count": 3,
  "pageInfo": {
    "hasPre": false,
    "hasNext": false
  }
}

Get total redeemed coupons and points earned from referrals

GET/rest_api/v1/referral/summary/{shopifyCustomerId}

Parameters

X-Joy-Loyalty-App-Keyheader · stringOptional

X-Joy-Loyalty-Secret-Keyheader · stringOptional

shopifyCustomerIdpath · stringRequired

Responses

200OK

dataobjectOptional

Show properties

totalRedeemCouponintegerOptional

Total redeemed coupons by referral

totalPointEarnReferintegerOptional

Total points earned from referrals

GET/rest_api/v1/referral/summary/{shopifyCustomerId}

GET /rest_api/v1/referral/summary/{shopifyCustomerId} HTTP/1.1
Host: dev-api.joy.so
Accept: */*

200OK

{
  "data": {
    "totalRedeemCoupon": 1,
    "totalPointEarnRefer": 2720
  }
}

Get analytics on referral link clicks and coupon code usage

GET/rest_api/v1/referral/analytics/clicks-usage

Parameters

X-Joy-Loyalty-App-Keyheader · stringOptional

X-Joy-Loyalty-Secret-Keyheader · stringOptional

shopifyCustomerIdquery · stringOptional

Shopify customer ID to get specific customer analytics

Responses

200OK

dataobjectOptional

Show properties

countReferralLinkClicksintegerOptional

Total number of clicks on referral links

countCouponCodeUsageintegerOptional

Total number of times coupon codes have been used

totalLinkClickersintegerOptional

Total number of link clickers for the specific Shopify customer

GET/rest_api/v1/referral/analytics/clicks-usage

GET /rest_api/v1/referral/analytics/clicks-usage HTTP/1.1
Host: dev-api.joy.so
Accept: */*

200OK

{
  "data": {
    "countReferralLinkClicks": 14,
    "countCouponCodeUsage": 4,
    "totalLinkClickers": 2
  }
}

VIP Tiers