API المخزون

مراقبة مستويات المخزون عبر مستودعاتك في الوقت الفعلي.

نقاط النهاية

GET

/inventory

inventory:read

استرجاع مستويات المخزون لجميع المنتجات. يدعم التصفية حسب المستودع وحالة انخفاض المخزون.

GET

/inventory/:productId

inventory:read

استرجاع معلومات مخزون منتج محدد عبر جميع المستودعات.

مرجع الحقول

الحقل	النوع	مطلوب	الوصف
id	string	لا	معرف سجل المخزون الفريد (للقراءة فقط)
productId	string	لا	معرف المنتج
productSku	string	لا	رمز SKU للمنتج
productName	string	لا	اسم المنتج (للقراءة فقط)
warehouseId	string	لا	معرف المستودع
warehouseName	string	لا	اسم المستودع (للقراءة فقط)
quantity	integer	لا	كمية المخزون الحالية
reservedQuantity	integer	لا	الكمية المحجوزة للطلبات المعلقة
availableQuantity	integer	لا	الكمية المتاحة (الكمية ناقص المحجوز)
minThreshold	integer	لا	عتبة تنبيه انخفاض المخزون
updatedAt	datetime	لا	طابع زمني لآخر تحديث للمخزون

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

الحقل	النوع	مطلوب	الوصف
page	integer	لا	رقم الصفحة (افتراضي: 1)
limit	integer	لا	عناصر لكل صفحة (افتراضي: 20، حد أقصى: 100)
warehouseId	string	لا	التصفية حسب معرف المستودع
lowStock	boolean	لا	إظهار المنتجات تحت عتبة انخفاض المخزون فقط

مثال

عرض مستويات المخزون

bash

curl "https://api.mercozy.com/api/v1/external/inventory?lowStock=true" \
  -H "X-API-Key: mk_live_your_key_here"

الحصول على مخزون منتج محدد

bash

curl "https://api.mercozy.com/api/v1/external/inventory/prod_abc123" \
  -H "X-API-Key: mk_live_your_key_here"

مثال على الاستجابة

json

{
  "data": {
    "productId": "prod_abc123",
    "productName": "Premium Widget",
    "sku": "WDG-001",
    "quantity": 42,
    "lowStockThreshold": 10,
    "warehouseId": "wh_main",
    "warehouseName": "Main Warehouse",
    "updatedAt": "2025-12-15T10:30:00Z"
  }
}