Skip to content

الكتالوج

كل المسارات أدناه عامة على http://localhost:5000. تتبع السلاسل المترجمة Accept-Language (ar / ar-* → العربية، وإلا الإنجليزية).

الإقلاع

الطريقةالمسارالغرض
GET/v1/initلقطة الإطلاق
GET/v1/homeأقسام الرئيسية (شرائح، أرفف، عروض)

استدعِ GET /v1/init عند إطلاق التطبيق. المصادقة اختيارية: أرسل Bearer عند التسجيل.

results في init

الحقلالمعنى
store.name، store.taglineمحلّيان مسبقاً
store.maintenanceMode، store.maintenanceMessageعند التفعيل امنع كتابات السلة/الطلب/المفضلة
store.paymentمفاتيح الطرق (الإتمام ما يزال cod / wallet فقط)
store.loyalty، store.proأعلام البرنامج والمزايا
store.assistant.enabled، store.assistant.allowGuestsإظهار الدردشة / السماح للضيوف
store.supportContact، store.socialMediaالتذييل / التواصل
userالعميل العام، أو null
wishlistProductIdsلحالة القلب؛ فارغ للضيف
cart.offersالعروض المنطبقة على السلة حالياً
deliveryالنمط الحالي (delivery | pickupbranch، zone (الرسوم بالفلس)، اختياري addressId
content.popupsنوافذ تسويقية محلّاة

الأقسام والعلامات والمجموعات

الطريقةالمسارالغرض
GET/v1/categoriesشجرة / قائمة الأقسام
GET/v1/categories/:slugتفاصيل القسم
GET/v1/brandsقائمة العلامات
GET/v1/brands/:slugتفاصيل العلامة
GET/v1/collectionsقائمة المجموعات
GET/v1/collections/:slugتفاصيل المجموعة

قراءات الكتالوج تستخدم slug وليس المعرّف.

المنتجات

الطريقةالمسارالمصادقةالغرض
GET/v1/productsعامةبحث / تصفية
GET/v1/products/:slugعامةتفاصيل المنتج
GET/v1/products/:slug/reviewsعامةالتقييمات ومتوسط التقييم

استعلام القائمة

الاستعلامملاحظات
page، limitالصفحات (limit حد أقصى 100)
categorySlug، brandSlug، collectionSlugالنطاق
searchنص حر
tagاختصار الوسم
inStock، onSaleمنطقي
minPrice، maxPriceفلس
sortnewest | price_asc | price_desc | name | discount_desc

results هو { data, pagination }. الأسعار على البطاقات بالفلس. قد يتغيّر التوفر بعد اختيار التوصيل / الاستلام.

الوصفات والعروض والصفحات والخطط

الطريقةالمسارالغرض
GET/v1/recipesقائمة الوصفات
GET/v1/recipes/:slugتفاصيل الوصفة
GET/v1/offersالعروض النشطة (حسب الفرع عند اختيار التوصيل)
GET/v1/pages/:slugصفحة محتوى / قانونية (about، faq، privacy، …)
GET/v1/subscription-plansخطط برو العامة + enabled + المزايا

التقييمات (كتابة)

الطريقةالمسارالمصادقةالجسم
POST/v1/reviewsعميلproductId، orderId، rating، اختياري title، body
PATCH/v1/reviews/:reviewIdعميلجزئي rating، title، body

يمكن للعملاء تقييم منتجات من طلباتهم فقط. rating من 1 إلى 5.