Skip to main content

Customers

This guide explains how to interact with the admin manage the customers crud.

Get Customers​

Endpoint​

  • Method: GET
  • URL: /v1/admin/customers

Request Headers​

HeaderValueRequired
Content-Typeapplication/jsonYes
Acceptapplication/jsonYes
AuthorizationBearer tokenYes

Query Parameters​

ParameterTypeDescriptionRequiredDefault
search_textstringCustomer's nameNonull
filter[gender]stringCustomer's genderNonull
filter[national_id]stringCustomer's national idNonull
filter[active]stringCustomer's is activeNonull
filter[email_verified_at]stringCustomer's email verified atNonull
filter[rate]stringCustomer's rate avrageNonull
sortstringSort Customer's first nameNonull

Success Response​

{
    "success": true,
    "message": "تم جلب بيانات المدرب بنجاح",
    "data": {
        "customers": [
            {
                "id": "uuid",
                "firstName": "ماريا",
                "lastName": "المجالي",
                "fullName": "ماريا المجالي",
                "email": "customer@customer.com",
                "gender": "انثى",
                "avatar": "https://image.jpg",
                "phone": "966598774075",
                "country": {
                    "id": "uuid",
                    "name": "الكويت"
                },
                "emailVerifiedAt": true,
                "nationality": {
                    "id": "uuid",
                    "name": "سعودي"
                },
                "active": true,
                "rate": "1.9"
            }
        ]
    },
    "statusCode": 200
}

Error Response​

Unauthorized (401)​

{
    "success": false,
    "message": "يجب عليك تسجيل الدخول",
    "data": [],
    "statusCode": 401
}

Show Customer​

Endpoint​

  • Method: GET
  • URL: /v1/admin/customers/{id}

Request Headers​

HeaderValueRequired
Content-Typeapplication/jsonYes
Acceptapplication/jsonYes
AuthorizationBearer tokenYes

Success Response​

{
    "success": true,
    "message": "تم جلب البيانات بنجاح.",
    "data": {
        "id": "uuid",
        "firstName": "ماريا",
        "lastName": "المجالي",
        "fullName": "ماريا المجالي",
        "email": "customer@customer.com",
        "gender": "انثى",
        "birthDate": "1931/08/13",
        "phone": "966598774075",
        "activationUrl": null,
        "emailVerifiedAt": true,
        "country": {
            "id": "uuid",
            "name": "الكويت"
        },
        "phoneCode": "+965",
        "nationality": {
            "id": "uuid",
            "name": "سعودي"
        },
        "avatar": "https://image.jpg",
        "role": null,
        "active": true,
        "emailVerified": "2024-01-28T13:33:43.000000Z",
        "createdAt": "2023/12/14"
    },
    "statusCode": 200
}

Error Response​

Unauthorized (401)​

{
    "success": false,
    "message": "يجب عليك تسجيل الدخول",
    "data": [],
    "statusCode": 401
}

Create Customer​

Endpoint​

  • Method: POST
  • URL: /v1/admin/customers

Request Headers​

HeaderValueRequired
Content-Typeapplication/jsonYes
Acceptapplication/jsonYes
AuthorizationBearer tokenYes

Request Body​

ParameterTypeDescriptionRequired
first_namestringCustomer's first nameYes
last_namestringCustomer's last nameYes
emailstringCustomer's email addressYes
passwordstringCustomer's passwordYes
password_confirmationstringCustomer's password confirmationYes
phonestringCustomer's phoneYes
genderstringCustomer's genderYes
birth_datestringCustomer's birth dateYes
country_idstringCustomer's country idYes
national_idstringCustomer's national idYes
phonestringCustomer's phoneYes
avatarfileCustomer's avatarNo

Success Response​

{
    "success": true,
    "message": "تم جلب بيانات المدرب بنجاح",
    "data": {
        "id": 67,
        "name": "extera_role",
        "permissions": {
            "المستخدمين": [
                {
                    "id": 1,
                    "name": "coaches",
                    "nameAr": "المستشارين",
                    "children": [
                        {
                            "id": 25,
                            "name": "show_coaches",
                            "parentId": 1,
                            "nameAr": "عرض قائمة المستشارين",
                            "isActive": false,
                            "children": []
                        },
                        {
                            "id": 26,
                            "name": "modify_coach",
                            "parentId": 1,
                            "nameAr": "تعديل وحذف وتصدير  وتمييز مستشار",
                            "isActive": false,
                            "children": []
                        }
                    ]
                },
            ]
        }
    },
    "statusCode": 200
}

Error Response​

Unauthorized (401)​

{
    "success": false,
    "message": "يجب عليك تسجيل الدخول",
    "data": [],
    "statusCode": 401
}

Validation (422)​

{
    "success": false,
    "message": "حدث خطأ في البيانات المرسلة يرجى التحقق منها.",
    "errors": {
        "name": "يجب أن يحتوي الاسم على حروف انجليزية صغيرة أو رمز الشرطة السفلية فقط."
    },
    "data": [],
    "statusCode": 422
}

Update Customer​

Endpoint​

  • Method: PATCH
  • URL: /v1/admin/customers/{id}

Request Headers​

HeaderValueRequired
Content-Typeapplication/jsonYes
Acceptapplication/jsonYes
AuthorizationBearer tokenYes

Request Body​

ParameterTypeDescriptionRequired
first_namestringCustomer's first nameNo
last_namestringCustomer's last nameNo
emailstringCustomer's email addressNo
passwordstringCustomer's passwordNo
password_confirmationstringCustomer's password confirmationNo
phonestringCustomer's phoneNo
genderstringCustomer's genderNo
birth_datestringCustomer's birth dateNo
country_idstringCustomer's country idNo
national_idstringCustomer's national idNo
phonestringCustomer's phoneNo
avatarfileCustomer's avatarNo

Success Response​

{
    "success": true,
    "message": "تم جلب بيانات المدرب بنجاح",
    "data": {
        "id": 67,
        "name": "extera_role",
        "permissions": {
            "المستخدمين": [
                {
                    "id": 1,
                    "name": "coaches",
                    "nameAr": "المستشارين",
                    "children": [
                        {
                            "id": 25,
                            "name": "show_coaches",
                            "parentId": 1,
                            "nameAr": "عرض قائمة المستشارين",
                            "isActive": false,
                            "children": []
                        },
                        {
                            "id": 26,
                            "name": "modify_coach",
                            "parentId": 1,
                            "nameAr": "تعديل وحذف وتصدير  وتمييز مستشار",
                            "isActive": false,
                            "children": []
                        }
                    ]
                },
            ]
        }
    },
    "statusCode": 200
}

Error Response​

Unauthorized (401)​

{
    "success": false,
    "message": "يجب عليك تسجيل الدخول",
    "data": [],
    "statusCode": 401
}

Validation (422)​

{
    "success": false,
    "message": "حدث خطأ في البيانات المرسلة يرجى التحقق منها.",
    "errors": {
        "name": "يجب أن يحتوي الاسم على حروف انجليزية صغيرة أو رمز الشرطة السفلية فقط."
    },
    "data": [],
    "statusCode": 422
}

Delete Customer​

Endpoint​

  • Method: DELETE
  • URL: /v1/admin/customers

Request Headers​

HeaderValueRequired
Content-Typeapplication/jsonYes
Acceptapplication/jsonYes
AuthorizationBearer tokenYes

Request Body​

ParameterTypeDescriptionRequired
idsarrayCustomer's idNo

Success Response​

{
    "success": true,
    "message": "تم حذف البيانات بنجاح.",
    "data": [],
    "statusCode": 200
}

Error Response​

Unauthorized (401)​

{
    "success": false,
    "message": "يجب عليك تسجيل الدخول",
    "data": [],
    "statusCode": 401
}

Get Customer Activation Code​

Endpoint​

  • Method: GET
  • URL: /v1/admin/customers/{id}/get-customer-activation-code

Request Headers​

HeaderValueRequired
Content-Typeapplication/jsonYes
Acceptapplication/jsonYes
AuthorizationBearer tokenYes

Success Response​

{
    "success": true,
    "message": "تم جلب البيانات بنجاح.",
    "data": {
        "activationUrl": "https://testing-customer.calwe.com/auth/activate-account?token=aVkUr4tcAT6NTAr4gOGnQ9QMtMBG5SIzNheiQjVUnaXax6eB4kIYkCklVi3h&email=aalb6aiti36ss1@gmail.com"
    },
    "statusCode": 200
}

Error Response​

Unauthorized (401)​

{
    "success": false,
    "message": "يجب عليك تسجيل الدخول",
    "data": [],
    "statusCode": 401
}

Export Customers​

Endpoint​

  • Method: GET
  • URL: /v1/admin/customers-export

Request Headers​

HeaderValueRequired
Content-Typeapplication/jsonYes
Acceptapplication/jsonYes
AuthorizationBearer tokenYes

Success Response​

Excel File