المخطط يعرض أكثر بكثير من هذه القائمة. أي شيء غير مذكور هنا يُعدّ داخلياً: قد يتغيّر أو يختفي في أي إصدار دون إشعار. ابنِ على العمليات المذكورة ولن يكسرك أي تحديث.
نقطة النهاية
نقطة نهاية واحدة من نوع POST على /admin-api. الاستكشاف (Introspection) متاح بمفتاح صالح، لذا يستطيع أي عميل GraphQL توليد الأنواع من المخطط الحي.
الطلبات
| العملية | وظيفتها |
|---|---|
| orders(options) | قائمة الطلبات مع التصفية والتقسيم إلى صفحات. |
| order(id) | طلب واحد مع بنوده ومجاميعه وعناوينه وحالته. |
| transitionOrderToState(id, state) | نقل الطلب إلى حالة تالية (مثل الشحن). |
| addFulfillmentToOrder(input) | تسجيل عملية تجهيز مقابل بنود الطلب. |
المنتجات والمخزون
| العملية | وظيفتها |
|---|---|
| products(options) | قائمة المنتجات. |
| product(id | slug) | منتج واحد مع خياراته. |
| createProduct / updateProduct | إنشاء منتج أو تعديله. |
| createProductVariants / updateProductVariants | إدارة الخيارات والأسعار وأرقام SKU. |
| updateProductVariants(stockOnHand) | مسار كتابة المخزون — هكذا تعمل مزامنة المخزون. |
| collections / collection(id | slug) | قراءة أقسام المتجر. |
الزبائن
| العملية | وظيفتها |
|---|---|
| customers(options) | قائمة زبائن هذا المتجر. |
| customer(id) | زبون واحد مع عناوينه وسجل طلباته. |
هوية الزبون محصورة بكل متجر على حدة: الشخص نفسه إذا تسوّق من متجرين على المنصة يكون سجلين مستقلين. لا تفترض أن البريد الإلكتروني يعرّف شخصاً على مستوى المنصة.
إعدادات المتجر
| العملية | وظيفتها |
|---|---|
| activeStoreSettings | إعدادات المتجر: المعرّف، الهوية البصرية، القالب، النطاق المخصص، الخطة. |
| myPlan | خطة المتجر وحدودها والاستخدام الحالي. |
| myWebhooks | روابط الويب هوك وقائمة الأحداث المدعومة. |
المبالغ والتواريخ
- كل المبالغ أعداد صحيحة بالوحدة الصغرى للعملة. 185000 ل.س تُكتب 185000 لا 1850.00.
- كل مبلغ مرفق برمز عملته. قد يبيع المتجر بأكثر من عملة.
- التواريخ نصوص بصيغة ISO 8601 بتوقيت UTC.