Referral

Use Rest API to retrieve the shortened link for refferal

Get referral link

POSThttps://dev-api.joy.so/rest_api/v1/referral/getLink

Header parameters

Body

application/json

object

Response

200

OK

Headers

Body

application/json

object

Request

JavaScriptCurlPython

const response = await fetch('https://dev-api.joy.so/rest_api/v1/referral/getLink', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "email": "[e-mail]"
    }),
});
const data = await response.json();

Get list refer by shopify customer id

GEThttps://dev-api.joy.so/rest_api/v1/referral/{shopifyCustomerId}

Path parameters

shopifyCustomerId*string

Header parameters

Response

200

OK

Headers

Body

application/json

dataarray of object

countinteger

pageInfoobject

Request

JavaScriptCurlPython

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

Response

200

{
  "data": [
    {
      "id": "text",
      "referralCustomerEmail": "text",
      "statusReferral": "pending_referral",
      "customerId": "text",
      "couponCode": "text",
      "email": "text",
      "updatedAt": "2024-10-03T13:29:49.483Z",
      "createdAt": "2024-10-03T13:29:49.483Z"
    }
  ],
  "pageInfo": {
    "hasPre": false,
    "hasNext": false
  }
}

Get total redeemed coupons and points earned from referrals

GEThttps://dev-api.joy.so/rest_api/v1/referral/summary/{shopifyCustomerId}

Path parameters

shopifyCustomerId*string

Header parameters

Response

200

OK

Headers

Body

application/json

dataobject

Request

JavaScriptCurlPython

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

Response

200

{
  "data": {}
}