انتقل إلى المحتوى
ShopentlyLearn

مخططات البيانات: التوريدات

مخططات البيانات: التوريدات. حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.

مخططات البيانات

جلب — التوريدات — الاستجابة

ApiResponse_DeliveryDetailData_ · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.
dataDeliveryDetailData مطلوب

مثال على الاستجابة · DeliveryDetailData.

مثال: {"created_at":"2026-01-01T12:00:00Z","deleted_at":null,"delivered_at":"2026-01-01T12:00:00Z","id":"example","increases_stock":true,"location_id":"example","notes":"example","quantity":1,"received_at":null,"record_status":"active","status":"planned","stock_applied_at":null,"target_id":"example","target_type":"product","updated_at":"2026-01-01T12:00:00Z","version":1,"warehouse_id":"example"}
metaContextPageMeta ContextMeta PageMeta RequestMeta مطلوب

البيانات الوصفية للاستجابة.

مثال: {"request_id":"example"}

حقول إضافية: لا

عرض القائمة — التوريدات — الاستجابة

ApiResponse_list_DeliveryData__ · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.
dataمصفوفة <DeliveryData > مطلوب

مثال على الاستجابة · ApiResponse_list_DeliveryData__.

مثال: [{"created_at":"2026-01-01T12:00:00Z","deleted_at":null,"delivered_at":"2026-01-01T12:00:00Z","id":"example","increases_stock":true,"location_id":"example","quantity":1,"received_at":null,"record_status":"active","status":"planned","stock_applied_at":null,"target_id":"example","target_type":"product","updated_at":"2026-01-01T12:00:00Z","version":1,"warehouse_id":"example"}]
metaContextPageMeta ContextMeta PageMeta RequestMeta مطلوب

البيانات الوصفية للاستجابة.

مثال: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

حقول إضافية: لا

إنشاء — التوريدات — محتوى الطلب

DeliveryCreate · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.
delivered_atسلسلة نصيةمطلوب

تاريخ التسليم ووقته.

format: "date-time"
مثال: "2026-01-01T00:00:00Z"
increases_stockقيمة منطقيةاختياري

ما إذا كان استلام التوريد يزيد المخزون.

القيمة الافتراضية: true
location_idسلسلة نصيةمطلوب

معرّف الموقع داخل المستودع.

القيود
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
مثال: "example"
notesسلسلة نصيةاختياري

ملاحظات إضافية.

maxLength: 2000
القيمة الافتراضية: ""
quantityعدد صحيحمطلوب

عدد الوحدات.

minimum: 1maximum: 2147483647
مثال: 1
reasonسلسلة نصيةاختياري

السبب المسجل للتغيير.

maxLength: 500
القيمة الافتراضية: ""
statusسلسلة نصيةمطلوب

الحالة التي تقبلها هذه العملية تحديدًا.

القيود
enum
["planned", "received"]
مثال: "planned"
target_idسلسلة نصيةمطلوب

معرّف المنتج أو المتغير المتأثر بالعملية.

القيود
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
مثال: "example"
target_typeسلسلة نصيةمطلوب

ما إذا كانت العملية تتعلق بمنتج أو بمتغير منتج.

القيود
enum
["product", "variant"]
مثال: "product"
warehouse_idسلسلة نصيةمطلوب

معرّف المستودع.

القيود
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
مثال: "example"

حقول إضافية: لا

عرض القائمة — التوريدات — الاستجابة

DeliveryData · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.
created_atسلسلة نصيةمطلوب

وقت الإنشاء.

format: "date-time"
مثال: "2026-01-01T12:00:00Z"
deleted_atسلسلة نصية nullمطلوب

وقت الحذف، إن وجد.

سلسلة نصية:format: "date-time"
مثال: null
delivered_atسلسلة نصيةمطلوب

تاريخ التسليم ووقته.

format: "date-time"
مثال: "2026-01-01T12:00:00Z"
idسلسلة نصيةمطلوب

معرّف المورد؛ احتفظ به كما أعيد. (DeliveryData).

مثال: "example"
increases_stockقيمة منطقيةمطلوب

ما إذا كان استلام التوريد يزيد المخزون.

مثال: true
location_idسلسلة نصيةمطلوب

معرّف الموقع داخل المستودع.

مثال: "example"
quantityعدد صحيحمطلوب

عدد الوحدات.

مثال: 1
received_atسلسلة نصية nullمطلوب

تاريخ استلام التوريد ووقته.

سلسلة نصية:format: "date-time"
مثال: null
record_statusسلسلة نصيةمطلوب

حالة السجل المخزنة.

القيود
enum
["active", "deleted"]
مثال: "active"
statusسلسلة نصيةمطلوب

الحالة التي تقبلها هذه العملية تحديدًا.

القيود
enum
["planned", "received"]
مثال: "planned"
stock_applied_atسلسلة نصية nullمطلوب

تاريخ ووقت تطبيق تغيير المخزون الناتج عن التوريد.

سلسلة نصية:format: "date-time"
مثال: null
target_idسلسلة نصيةمطلوب

معرّف المنتج أو المتغير المتأثر بالعملية.

مثال: "example"
target_typeسلسلة نصيةمطلوب

ما إذا كانت العملية تتعلق بمنتج أو بمتغير منتج.

القيود
enum
["product", "variant"]
مثال: "product"
updated_atسلسلة نصية nullمطلوب

وقت آخر تحديث.

سلسلة نصية:format: "date-time"
مثال: "2026-01-01T12:00:00Z"
versionعدد صحيحمطلوب

إصدار المورد المستخدم للتحكم في التعديلات المتزامنة.

مثال: 1
warehouse_idسلسلة نصيةمطلوب

معرّف المستودع.

مثال: "example"

حقول إضافية: لا

جلب — التوريدات — الاستجابة

DeliveryDetailData · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.
created_atسلسلة نصيةمطلوب

وقت الإنشاء.

format: "date-time"
مثال: "2026-01-01T12:00:00Z"
deleted_atسلسلة نصية nullمطلوب

وقت الحذف، إن وجد.

سلسلة نصية:format: "date-time"
مثال: null
delivered_atسلسلة نصيةمطلوب

تاريخ التسليم ووقته.

format: "date-time"
مثال: "2026-01-01T12:00:00Z"
idسلسلة نصيةمطلوب

معرّف المورد؛ احتفظ به كما أعيد. (DeliveryDetailData).

مثال: "example"
increases_stockقيمة منطقيةمطلوب

ما إذا كان استلام التوريد يزيد المخزون.

مثال: true
location_idسلسلة نصيةمطلوب

معرّف الموقع داخل المستودع.

مثال: "example"
notesسلسلة نصية nullمطلوب

ملاحظات إضافية.

مثال: "example"
quantityعدد صحيحمطلوب

عدد الوحدات.

مثال: 1
received_atسلسلة نصية nullمطلوب

تاريخ استلام التوريد ووقته.

سلسلة نصية:format: "date-time"
مثال: null
record_statusسلسلة نصيةمطلوب

حالة السجل المخزنة.

القيود
enum
["active", "deleted"]
مثال: "active"
statusسلسلة نصيةمطلوب

الحالة التي تقبلها هذه العملية تحديدًا.

القيود
enum
["planned", "received"]
مثال: "planned"
stock_applied_atسلسلة نصية nullمطلوب

تاريخ ووقت تطبيق تغيير المخزون الناتج عن التوريد.

سلسلة نصية:format: "date-time"
مثال: null
target_idسلسلة نصيةمطلوب

معرّف المنتج أو المتغير المتأثر بالعملية.

مثال: "example"
target_typeسلسلة نصيةمطلوب

ما إذا كانت العملية تتعلق بمنتج أو بمتغير منتج.

القيود
enum
["product", "variant"]
مثال: "product"
updated_atسلسلة نصية nullمطلوب

وقت آخر تحديث.

سلسلة نصية:format: "date-time"
مثال: "2026-01-01T12:00:00Z"
versionعدد صحيحمطلوب

إصدار المورد المستخدم للتحكم في التعديلات المتزامنة.

مثال: 1
warehouse_idسلسلة نصيةمطلوب

معرّف المستودع.

مثال: "example"

حقول إضافية: لا