Point manupulation

Manually manupulate customer points balance via API

Earn point via Rest API

Earn point via Rest API

This api allows you to increase point for a specific shopify customer via Rest API

post

/rest_api/v1/shopify/earn-point

Header parameters

X-Joy-Loyalty-App-Keystring

Example: {{appKey}}

X-Joy-Loyalty-Secret-Keystring

Example: {{secretKey}}

Body

object

Example: {"shopifyCustomerId":7278822981918,"point":10000,"adminNote":"Note that is only visible in admin side","userNote":"Note that is visible in both admin and customer side"}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://dev-api.joy.so/rest_api/v1/shopify/earn-point' \
  --header 'Content-Type: application/json' \
  --data '{"shopifyCustomerId":7278822981918,"point":10000,"adminNote":"Note that is only visible in admin side","userNote":"Note that is visible in both admin and customer side"}'

200

200

Fail example

Success example

Fail example

{
  "success": false,
  "error": "Customer not found"
}

OK

Spend point via Rest API

Spend point via Rest API

This api allows you to decrease point for a specific shopify customer via Rest API

post

/rest_api/v1/shopify/spend-point

Header parameters

X-Joy-Loyalty-App-Keystring

Example: {{appKey}}

X-Joy-Loyalty-Secret-Keystring

Example: {{secretKey}}

Body

object

Example: {"shopifyCustomerId":7278822981918,"point":10000,"adminNote":"Note that is only visible in admin side","userNote":"Note that is visible in both admin and customer side"}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://dev-api.joy.so/rest_api/v1/shopify/spend-point' \
  --header 'Content-Type: application/json' \
  --data '{"shopifyCustomerId":7278822981918,"point":10000,"adminNote":"Note that is only visible in admin side","userNote":"Note that is visible in both admin and customer side"}'

200

200

Fail example

Success example

Fail example

{
  "success": false,
  "error": "Customer not found"
}

OK

Reset point via Rest API

Adjust point via Rest API

This api allows you to reset point for a specific shopify customer via Rest API

post

/rest_api/v1/shopify/reset-point

Header parameters

X-Joy-Loyalty-App-Keystring

Example: {{appKey}}

X-Joy-Loyalty-Secret-Keystring

Example: {{secretKey}}

Body

object

Example: {"shopifyCustomerId":7278822981918,"point":10000,"adminNote":"Note that is only visible in admin side","userNote":"Note that is visible in both admin and customer side"}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://dev-api.joy.so/rest_api/v1/shopify/reset-point' \
  --header 'Content-Type: application/json' \
  --data '{"shopifyCustomerId":7278822981918,"point":10000,"adminNote":"Note that is only visible in admin side","userNote":"Note that is visible in both admin and customer side"}'

200

200

Fail example

Success example

Fail example

{
  "success": false,
  "error": "Customer not found"
}

OK

Adjust point via Rest API

Adjust point via Rest API

This api allows you to adjust (increase or decrease) point for a specific shopify customer via Rest API

post

/rest_api/v1/shopify/adjust-point

Header parameters

X-Joy-Loyalty-App-Keystring

Example: {{appKey}}

X-Joy-Loyalty-Secret-Keystring

Example: {{secretKey}}

Body

object

Example: {"shopifyCustomerId":7278822981918,"point":10000,"adminNote":"Note that is only visible in admin side","userNote":"Note that is visible in both admin and customer side"}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://dev-api.joy.so/rest_api/v1/shopify/adjust-point' \
  --header 'Content-Type: application/json' \
  --data '{"shopifyCustomerId":7278822981918,"point":10000,"adminNote":"Note that is only visible in admin side","userNote":"Note that is visible in both admin and customer side"}'

200

200

Fail example

Success example

Fail example

{
  "success": false,
  "error": "Customer not found"
}

OK