Customer

PreviousReferral

Last updated 1 month ago

List earning programs

get

Get a list of all earning programs with count

Authorizations

Header parameters

X-Joy-Loyalty-App-Keystringrequired

App ID of your shop

X-Joy-Loyalty-Secret-Keystringrequired

Secret Key of your shop

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://dev-api.joy.so/open/v2/programs/earning' \
  --header 'X-Joy-Loyalty-App-Key: text' \
  --header 'X-Joy-Loyalty-Secret-Key: text'

200

{
  "success": true,
  "data": {
    "count": 2,
    "programs": [
      {
        "id": "earning_program_001",
        "type": "earning",
        "title": "Place Order",
        "event": "place_order",
        "earnPoint": 12,
        "status": true,
        "priority": 0,
        "hasLimit": false,
        "limitUnit": "minute",
        "limitInterval": 1,
        "createdAt": "2023-12-20T04:16:40.318Z",
        "updatedAt": "2024-08-30T09:50:37.994Z",
        "translateTitle": {
          "ar": "وضع الطلب",
          "vi": "Đặt hàng"
        }
      },
      {
        "id": "earning_program_002",
        "type": "earning",
        "title": "Sign Up Bonus",
        "event": "sign_up",
        "earnPoint": 50,
        "status": true,
        "priority": 1,
        "hasLimit": false,
        "limitUnit": "lifetime",
        "limitInterval": 0,
        "createdAt": "2023-12-20T04:16:40.318Z",
        "updatedAt": "2024-08-30T09:50:37.994Z",
        "translateTitle": {
          "ar": "مكافأة التسجيل",
          "vi": "Thưởng đăng ký"
        }
      }
    ]
  }
}

Get earning program by ID

get

Authorizations

Path parameters

programIdstringrequired

Header parameters

X-Joy-Loyalty-App-Keystringrequired

X-Joy-Loyalty-Secret-Keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://dev-api.joy.so/open/v2/programs/earning/{programId}' \
  --header 'X-Joy-Loyalty-App-Key: text' \
  --header 'X-Joy-Loyalty-Secret-Key: text'

200

{
  "success": true,
  "data": {
    "id": "text",
    "type": "earning",
    "title": "text",
    "event": "place_order",
    "earnPoint": 1,
    "status": true,
    "priority": 1,
    "hasLimit": true,
    "limitUnit": "minute",
    "limitInterval": 1,
    "createdAt": "2025-04-02T11:39:05.378Z",
    "updatedAt": "2025-04-02T11:39:05.378Z",
    "translateTitle": {
      "ar": "text",
      "vi": "text"
    }
  }
}

List spending programs

get

Authorizations

Header parameters

X-Joy-Loyalty-App-Keystringrequired

X-Joy-Loyalty-Secret-Keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://dev-api.joy.so/open/v2/programs/spending' \
  --header 'X-Joy-Loyalty-App-Key: text' \
  --header 'X-Joy-Loyalty-Secret-Key: text'

200

{
  "success": true,
  "data": {
    "count": 1,
    "programs": [
      {
        "id": "spending_program_001",
        "type": "spending",
        "title": "Free Product Test",
        "event": "free_gift",
        "spendPoint": 200,
        "status": true,
        "redeemType": "fixed",
        "earnAmount": 700,
        "redeemed": 0,
        "createdAt": "2024-08-27T08:09:46.757Z",
        "updatedAt": "2025-02-04T03:43:29.666Z",
        "translateTitle": {
          "ar": "اختبار المنتج مجانا",
          "vi": "Kiểm tra sản phẩm miễn phí"
        }
      }
    ]
  }
}

Get spending program by ID

get

Authorizations

Path parameters

programIdstringrequired

Header parameters

X-Joy-Loyalty-App-Keystringrequired

X-Joy-Loyalty-Secret-Keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://dev-api.joy.so/open/v2/programs/spending/{programId}' \
  --header 'X-Joy-Loyalty-App-Key: text' \
  --header 'X-Joy-Loyalty-Secret-Key: text'

200

{
  "success": true,
  "data": {
    "id": "text",
    "type": "spending",
    "title": "text",
    "event": "free_gift",
    "spendPoint": 1,
    "status": true,
    "redeemType": "fixed",
    "earnAmount": 1,
    "redeemed": 1,
    "createdAt": "2025-04-02T11:39:05.378Z",
    "updatedAt": "2025-04-02T11:39:05.378Z",
    "translateTitle": {
      "ar": "text",
      "vi": "text"
    }
  }
}