كل رسالة طلب POST بمحتوى JSON: اسم الحدث وبياناته.
{
"event": "order.placed",
"data": { "id": 5123, "unique_order_id": "OD-…", "total": 163 }
}
الطلبات
| الحدث | يُرسل عندما |
|---|
order.placed | ينشئ عميل طلبًا جديدًا. البيع المكتمل في نقطة البيع يرسله أيضًا |
order.accepted | تقبل طلبًا |
order.modified | تتغير منتجات الطلب أو مبالغه |
order.shipped | تحصل أول شحنة للطلب عبر شركة الشحن على رقم التتبع (AWB) |
order.delivered | يُحدَّد الطلب كمُسلَّم |
order.cancelled | يُلغى الطلب |
order.reassigned | يُنقل الطلب إلى موقع آخر من مواقعك |
data هي الطلب كاملًا: المنتجات والمبالغ وبيانات العميل والتوصيل.
- إذا كان الطلب مرتبطًا بموقع، تحتوي
data أيضًا على fulfilment_location وفيه id وcode وname وexternal_ref وerpnext_branch.
order.reassigned يضيف reassignment وفيه from وto وby (id، name) وat.
المرتجعات
| الحدث | يُرسل عندما |
|---|
return.requested | يطلب العميل، أو تطلب أنت، إرجاع منتجات أو استبدالها |
return.approved | توافق على مرتجع، أو يُوافَق عليه تلقائيًا |
return.rejected | ترفض طلب إرجاع |
return.pickup_cancelled | تلغي أنت أو شركة الشحن استلام المرتجع. يعود المرتجع إلى حالة الموافقة، دون حدث return.approved ثانٍ |
return.pickup_rescheduled | يُحجز استلام المرتجع مجددًا بعد استلام ملغى |
return.received | تصلك المنتجات المرتجعة |
return.refunded | يُستردّ مبلغ المرتجع |
return.exchanged | يكتمل الاستبدال |
return.cancelled | يلغي العميل المرتجع أو تلغيه أنت |
المفاتيح الرئيسية في data:
| المجموعة | المفاتيح |
|---|
| الهوية | id, number, type, shop_id, customer_id, order_id, exchange_order_id, url |
| الحالة | status, status_label, reason_code, reason, note, shop_note, return_method |
| المبالغ | refund_method, refund_status, refund_amount, refunded_amount, refund_estimate, delivery_refund, shipping_fee, exchange_difference, refund_reference |
| شحنة الاستلام | shipment وفيه courier, awb, status, status_label, tracking_url |
أول حجز للاستلام لا يرسل حدثًا. روابط الصور في البيانات موقّعة وتبقى صالحة 7 أيام.
الشحن
| الحدث | يُرسل عندما |
|---|
shipment.status_changed | تتغير حالة شحنة مرسلة إلى العميل عبر شركة الشحن |
| المفتاح | ما يحمله |
|---|
order_id, shop_id | رقم الطلب ومتجرك |
shipment | id, courier, driver, awb, reference, status, status_label, previous_status, previous_status_label, courier_status, tracking_url, eta, cod_amount |
event | occurred_at، location، description لعملية المسح |
عمليات استلام المرتجعات لا ترسل هذا الحدث.
العملاء
| الحدث | يُرسل عندما |
|---|
customer.registered | يحصل عميل في متجرك على رقم شريك لأول مرة، عند التسجيل أو تسجيل الدخول به |
customer.updated | تحفظ عميلًا في اللوحة وحقل رقم الشريك معبّأ |
data تحمل user_id وpartner_id وname وemail وphone وcreated_at.
يصف النموذج هذين الحدثين بأنهما تسجيل جديد وتغيير في البيانات. في الكود يحتاج كلاهما إلى رقم شريك: عمليات التسجيل الأخرى وتغييرات الملف الشخصي لا ترسل شيئًا. يظهر حقل رقم الشريك فقط إذا فعّل الدعم عمولة الشريك لمتجرك.
غير متاح
لا توجد أحداث للمنتجات أو المخزون أو الأسعار. طلبات المتجر التجريبي ومرتجعاتها لا ترسل شيئًا.