Order Notes

This section covers the API endpoints for managing order notes in the admin panel.

Create Note

POST /v1/admin/order-notes

Create a new note for an order or groups application request.

Request Body

Parameter	Type	Description
note	string	Required. Note content (3-4000 characters)
orderable_id	string	Required. UUID of the order or groups application request
orderable_type	string	Required. Type of the orderable (orders, groups_application_requests)
sent_to_customer_email	boolean	Optional. Send note to customer email

Response

{
    "success": true,
    "message": "تم حفظ البيانات بنجاح.",
    "data": {
        "id": "44ae3610-1354-11f0-a755-6fdcacb61695",
        "note": "الطلب يتطلبُ طلبًا",
        "can_modify": true,
        "sent_to_customer_email_at": null,
        "user_avatar": "https://i.ibb.co/g4BR50S/avatar.png",
        "user_full_name": "mazen ahmed",
        "user_role": "super_admin",
        "created_at": "2025-04-07 05:01:49",
        "updated_at": null
    },
    "status_code": 200
}

Update Note

PATCH /v1/admin/order-notes/{id}

Update an existing note.

Request Body

Parameter	Type	Description
note	string	Required. Updated note content (3-4000 characters)

Response

{
    "success": true,
    "message": "تم تحديث البيانات بنجاح.",
    "data": {
        "id": "44ae3610-1354-11f0-a755-6fdcacb61695",
        "note": "هذا النص هو مثال لنص يمكن أن يستبدل في نفس المساحة، لقد تم توليد هذا النص من مولد النص العربى، حيث يمكنك أن تولد مثل هذا النص أو العديد من النصوص الأخرى إضافة إلى زيادة عدد الحروف التى يولدها التطبيق.\nإذا كنت تحتاج إلى عدد أكبر من الفقرات يتيح لك مولد النص العربى زيادة عدد الفقرات كما تريد، النص لن يبدو مقسما ولا يحوي أخطاء لغوية، مولد النص العربى مفيد لمصممي المواقع على وجه الخصوص، حيث يحتاج العميل فى كثير من الأحيان أن يطلع على صورة حقيقية لتصميم الموقع.\nومن هنا وجب على المصمم أن يضع نصوصا مؤقتة على التصميم ليظهر للعميل الشكل كاملاً،دور مولد النص العربى أن يوفر على المصمم عناء البحث عن نص بديل لا علاقة له بالموضوع الذى يتحدث عنه التصميم فيظهر بشكل لا يليق.",
        "can_modify": true,
        "sent_to_customer_email_at": "2025-04-07 05:01:49",
        "user_avatar": "https://i.ibb.co/g4BR50S/avatar.png",
        "user_full_name": "mazen ahmed",
        "user_role": "super_admin",
        "created_at": "2025-04-07 05:01:49",
        "updated_at": "2025-04-07 05:02:50"
    },
    "status_code": 200
}

Delete Notes

DELETE /v1/admin/order-notes

Delete multiple notes.

Request Body

Parameter	Type	Description
ids	array	Required. Array of note UUIDs to delete
ids.*	string	Required. Note UUID

Response

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

Send Note to Customer

POST /v1/admin/notes-customer

Send a note to the customer via email.

Request Body

Parameter	Type	Description
note_id	string	Required. UUID of the note to send

Response

{
    "success": true,
    "message": "تم ارسال الإيميل بنجاح.",
    "data": null,
    "status_code": 200
}

Authorization

All order note management endpoints require admin authorization. The user must have the appropriate permissions to perform these operations.

Notes

• Notes can only be updated by their original creator
• Notes can be attached to both orders and group application requests
• When a note is sent to a customer, it will be sent via email and the sending timestamp will be recorded in the note's meta data
• The note content must be between 3 and 4000 characters in length