العملاء
يتطلب مفتاح API — انظر المصادقة. للقراءة فقط (GET).
قائمة العملاء
Section titled “قائمة العملاء”GET /v1/customersمعاملات الاستعلام
Section titled “معاملات الاستعلام”| المعامل | النوع | الافتراضي | ملاحظات |
|---|---|---|---|
limit |
integer | 50 |
الحد الأقصى 200. |
offset |
integer | 0 |
لا يوجد عامل تصفية status أو غيره لنقطة النهاية هذه. النتائج مرتّبة تصاعديًا (أبجديًا) حسب companyName، خلافًا للشحنات والفواتير المرتّبة من الأحدث إلى الأقدم.
مثال طلب
Section titled “مثال طلب”curl -H "Authorization: Bearer lk_YOUR_KEY" \ "https://tenant.logistall.cloud/api/v1/customers?limit=2"مثال استجابة
Section titled “مثال استجابة”[ { "id": "1b2c3d4e-5f6a-7b8c-9d0e-1f2a3b4c5d6e", "customerCode": "CUS-00031", "companyName": "Atlas Textiles SARL", "contactEmail": "logistics@atlastextiles.ma" }, { "id": "2c3d4e5f-6a7b-8c9d-0e1f-2a3b4c5d6e7f", "customerCode": "CUS-00019", "companyName": "Maghreb Foods Distribution", "contactEmail": "supply@maghrebfoods.ma" }]قد تكون contactEmail بقيمة null إذا لم يكن هناك بريد إلكتروني للتواصل مسجَّل.
الأخطاء
Section titled “الأخطاء”| الحالة | المتن | متى |
|---|---|---|
401 |
انظر المصادقة | مفتاح مفقود/غير صالح. |
500 |
{ "error": "Database error" } |
خطأ غير متوقع في الخادم. |
لا توجد حاليًا نقطة نهاية لعميل واحد (GET /v1/customers/:id) — القائمة فقط. انظر صفحة العملاء والعقود في دليل المستخدم للاطلاع على سجل العميل الكامل كما يظهر في التطبيق (العناوين وجهات الاتصال والعقود)، وهو غير مكشوف عبر هذه الواجهة.