Points Record

This guide explains how to interact with the Points Record API in the Sumaya369 web application. The API provides endpoints for managing customer points records and retrieving points statistics.

List Points Records

Retrieve all points records for the authenticated customer.

Endpoint

• Method: GET
• URL: /v1/customer/points-record

Request Headers

Header	Value	Required
Content-Type	application/json	Yes
Accept	application/json	Yes
Authorization	Bearer token	Yes

Query Parameters

Parameter	Type	Description	Required
per_page	integer	Number of items per page	No

Success Response

{
    "success": true,
    "message": "تم جلب البيانات بنجاح.",
    "data": {
        "current_page": 1,
        "first_page_url": "http://testing-api.sumaya369.net/v1/customer/points-records?page=1",
        "from": 1,
        "last_page": 1,
        "last_page_url": "http://testing-api.sumaya369.net/v1/customer/points-records?page=1",
        "links": [
            {
                "url": null,
                "label": "« السابق",
                "active": false
            },
            {
                "url": "http://testing-api.sumaya369.net/v1/customer/points-records?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "التالي »",
                "active": false
            }
        ],
        "next_page_url": null,
        "path": "http://testing-api.sumaya369.net/v1/customer/points-records",
        "per_page": 10,
        "prev_page_url": null,
        "to": 3,
        "total": 3,
        "points": [
            {
                "icon": "white",
                "message": "اكتساب نقاط من الطلب: 2410156644",
                "points": "+57",
                "has_completed_profile": true,
                "customer_level": "نقاطي",
                "gar_status": "ضمان اجتماعي"
            },
            {
                "icon": "white",
                "message": "اكتساب نقاط من الطلب: 2405153974",
                "points": "+1",
                "has_completed_profile": true,
                "customer_level": "نقاطي",
                "gar_status": "ضمان اجتماعي"
            },
            {
                "icon": "white",
                "message": "تم منحك نقاط من الطلب: 2212045841 ",
                "points": "+1",
                "has_completed_profile": true,
                "customer_level": "نقاطي",
                "gar_status": "ضمان اجتماعي"
            }
        ]
    },
    "status_code": 200
}

Get Points Statistics

Retrieve points statistics and level information for the authenticated customer.

Endpoint

• Method: GET
• URL: /v1/customer/points-record/statistics

Request Headers

Header	Value	Required
Content-Type	application/json	Yes
Accept	application/json	Yes
Authorization	Bearer token	Yes

Success Response

{
    "success": true,
    "message": "تم جلب البيانات بنجاح.",
    "data": {
        "progress": {
            "current_level": "نقاطي",
            "current_level_icon": "https://sumaya369-testing-media.s3.us-east-2.amazonaws.com/4090/0--%D8%A7%D9%84%D9%86%D9%82%D8%A7%D8%B7---%D8%B9%D8%A7%D9%85-%D9%84%D9%84%D8%AC%D9%85%D9%8A%D8%B9-%D9%82%D8%A8%D9%84-%D8%A7%D9%84%D8%AF%D8%AE%D9%88%D9%84-%D9%84%D8%A3%D9%8A-%D9%85%D8%B3%D8%AA%D9%88%D9%89.png",
            "next_level": "فئة برونزية",
            "next_level_icon": "https://sumaya369-testing-media.s3.us-east-2.amazonaws.com/4086/1--%D8%A7%D9%84%D9%81%D8%A6%D8%A9-%D8%A7%D9%84%D8%A8%D8%B1%D9%88%D9%86%D8%B2%D9%8A%D8%A9.png",
            "progress": 15,
            "current_points": 59,
            "points_remaining": 331
        },
        "levels": [
            {
                "name": "فئة برونزية",
                "description": "<h5 class=\"ql-align-right\">-&nbsp;&nbsp;مواد متاحة أكثر من سنتين .</h5><h5 class=\"ql-align-right\">-&nbsp;&nbsp;أخبار و صور حصرية للدكتورة سمية .</h5><h5 class=\"ql-align-right\"><span style=\"background-color: rgb(246, 245, 247);\">-&nbsp; </span>شارة التوثيق على الموقع.</h5>",
                "points": 390,
                "is_active": false,
                "icon": "https://sumaya369-testing-media.s3.us-east-2.amazonaws.com/4086/1--%D8%A7%D9%84%D9%81%D8%A6%D8%A9-%D8%A7%D9%84%D8%A8%D8%B1%D9%88%D9%86%D8%B2%D9%8A%D8%A9.png"
            },
            {
                "name": "فئة فضية",
                "description": "<h5 class=\"ql-align-right\">-\tمواد متاحة أكثر من سنتين .</h5><h5 class=\"ql-align-right\">-\tخدمة عملاء خاصة .</h5><h5 class=\"ql-align-right\">-\tأخبار و صور حصرية للدكتورة سمية .</h5><h5 class=\"ql-align-right\">-\tشارة التوثيق على الموقع.</h5><p><br></p>",
                "points": 600,
                "is_active": false,
                "icon": "https://sumaya369-testing-media.s3.us-east-2.amazonaws.com/4087/2--%D8%A7%D9%84%D9%81%D8%A6%D8%A9-%D8%A7%D9%84%D9%81%D8%B6%D9%8A%D8%A9.png"
            },
            {
                "name": "فئة ذهبية",
                "description": "<h5 class=\"ql-align-right\">-&nbsp;&nbsp;مواد متاحة أكثر من سنتين .</h5><h5 class=\"ql-align-right\">-&nbsp;&nbsp;خدمة عملاء خاصة .</h5><h5 class=\"ql-align-right\">-&nbsp;&nbsp;أخبار و صور حصرية للدكتورة سمية .</h5><h5 class=\"ql-align-right\">-&nbsp;&nbsp;شارة التوثيق على الموقع .</h5><h5 class=\"ql-align-right\">-&nbsp;&nbsp;أولوية خاصة للظهور كضيف في البث .</h5><h5 class=\"ql-align-right\">-&nbsp;&nbsp;تهنئة بأعياد الميلاد.</h5><h5 class=\"ql-align-right\">-&nbsp;&nbsp;مسار خاص في حفلات توقيع الكتاب.</h5>",
                "points": 800,
                "is_active": false,
                "icon": "https://sumaya369-testing-media.s3.us-east-2.amazonaws.com/4088/3--%D8%A7%D9%84%D9%81%D8%A6%D8%A9-%D8%A7%D9%84%D8%B0%D9%87%D8%A8%D9%8A%D8%A9.png"
            },
            {
                "name": "فئة ماسية",
                "description": "<h5 class=\"ql-align-right\">-\tهدايا في الموسم .</h5><h5 class=\"ql-align-right\">-\tمواد متاحة أكثر من سنتين .</h5><h5 class=\"ql-align-right\">-\tخدمة عملاء خاصة .</h5><h5 class=\"ql-align-right\">-\tأخبار و صور حصرية للدكتورة سمية .</h5><h5 class=\"ql-align-right\">-\tشارة التوثيق على الموقع .</h5><h5 class=\"ql-align-right\">-\tأولوية خاصة للظهور كضيف في البث.</h5><h5 class=\"ql-align-right\">-\tتهنئة بأعياد الميلاد.</h5><h5 class=\"ql-align-right\">-\tمسار خاص في حفلات توقيع الكتاب.</h5><h5 class=\"ql-align-right\">-\tدعوات خاصة للحفلات و اللقاءات.</h5><h5 class=\"ql-align-right\">-\tخصم 10% على جميع المواد.</h5><h5 class=\"ql-align-right\">-\tالإجابة على 20 سؤال شهرياً من اختيار الدكتورة من مجموعة الأسئلة المطروحة من قبل عملاء الفئة الماسية.</h5>",
                "points": 1200,
                "is_active": false,
                "icon": "https://sumaya369-testing-media.s3.us-east-2.amazonaws.com/4089/4--%D8%A7%D9%84%D9%81%D8%A6%D8%A9-%D8%A7%D9%84%D9%85%D8%A7%D8%B3%D9%8A%D8%A9.png"
            }
        ]
    },
    "status_code": 200
}

Example Implementation Flow

1. Points Record Management

   • Application retrieves customer's points records using the list endpoint
   • Points records show history of points earned or deducted
   • Each record includes the icon type and message describing the points change

2. Customer Level Progress

   • Application fetches points statistics to show customer's current level
   • Progress information shows advancement towards next level
   • Displays all available levels with their requirements and current status

Key Considerations

• Authentication is required for all endpoints
• Points records are personal to each customer
• Points can be positive (earned) or negative (deducted)
• Customer levels are determined by total points accumulated
• Progress calculation shows percentage towards next level
• Level icons have both active and grayscale versions