مخططات البيانات: المخزون

location_codeسلسلة نصيةمطلوب

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

مثال: "example"

location_idسلسلة نصيةمطلوب

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

مثال: "example"

location_nameسلسلة نصيةمطلوب

اسم الموقع داخل المستودع.

مثال: "example"

on_handعدد صحيحمطلوب

الكمية الفعلية في المخزون.

مثال: 10

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

dataمصفوفة <StockData > مطلوب

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

مثال: [{"active":true,"available":5,"id":"stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ","manual_reserved":2,"on_hand":10,"reserved":3,"sellable_limit":10,"target_id":"example","target_type":"product","total_reserved":5,"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"}

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

dataStockDetailData مطلوب

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

مثال: {"active":true,"allocations":[{"location_code":"example","location_id":"example","location_name":"example","on_hand":10}],"available":5,"id":"stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ","manual_reserved":2,"on_hand":10,"reserved":3,"sellable_limit":10,"target_id":"example","target_type":"product","total_reserved":5,"updated_at":"2026-01-01T12:00:00Z","version":1,"warehouse_id":"example"}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta مطلوب

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

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

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

expected_versionعدد صحيحمطلوب

الإصدار المقروء قبل الكتابة؛ يؤدي عدم التطابق إلى رفض التحديث.

minimum: 1maximum: 9223372036854775807

مثال: 1

manual_reservedعدد صحيحمطلوب

الكمية المحجوزة يدويًا.

minimum: 0maximum: 2147483647

مثال: 1

reasonسلسلة نصيةاختياري

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

maxLength: 500

القيمة الافتراضية: ""

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

expected_versionعدد صحيحمطلوب

الإصدار المقروء قبل الكتابة؛ يؤدي عدم التطابق إلى رفض التحديث.

minimum: 1maximum: 9223372036854775807

مثال: 1

reasonسلسلة نصيةاختياري

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

maxLength: 500

القيمة الافتراضية: ""

sellable_limitعدد صحيحمطلوب

حد البيع: تعني -1 أنه غير محدود، بينما تعطل 0 التوفر للبيع.

minimum: -1maximum: 2147483647

مثال: 1

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

expected_versionعدد صحيحمطلوب

الإصدار المقروء قبل الكتابة؛ يؤدي عدم التطابق إلى رفض التحديث.

minimum: 0maximum: 9223372036854775807

مثال: 0

locationsمصفوفة <LocationQuantity > مطلوب

مواقع المستودع.

minItems: 1maxItems: 100

مثال: [{"location_id":"example","on_hand":1}]

reasonسلسلة نصيةمطلوب

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

minLength: 1maxLength: 500

مثال: "Example"

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"

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

expected_versionعدد صحيحمطلوب

الإصدار المقروء قبل الكتابة؛ يؤدي عدم التطابق إلى رفض التحديث.

minimum: 1maximum: 9223372036854775807

مثال: 1

locationsمصفوفة <LocationQuantity > مطلوب

مواقع المستودع.

minItems: 1maxItems: 100

مثال: [{"location_id":"example","on_hand":1}]

reasonسلسلة نصيةمطلوب

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

minLength: 1maxLength: 500

مثال: "Example"

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

activeقيمة منطقيةمطلوب

ما إذا كان المورد نشطًا.

مثال: true

availableعدد صحيح | nullمطلوب

الكمية المتاحة للبيع؛ تمثل null كمية غير محدودة.

مثال: 5

idسلسلة نصيةمطلوب

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

مثال: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reservedعدد صحيحمطلوب

الكمية المحجوزة يدويًا.

مثال: 2

on_handعدد صحيحمطلوب

الكمية الفعلية في المخزون.

مثال: 10

reservedعدد صحيحمطلوب

الكمية المحجوزة لطلبات الشراء.

مثال: 3

sellable_limitعدد صحيحمطلوب

حد البيع: تعني -1 أنه غير محدود، بينما تعطل 0 التوفر للبيع.

مثال: 10

target_idسلسلة نصيةمطلوب

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

مثال: "example"

target_typeسلسلة نصيةمطلوب

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

القيود

enum

["product", "variant"]

مثال: "product"

total_reservedعدد صحيحمطلوب

إجمالي الكمية المحجوزة.

مثال: 5

updated_atسلسلة نصيةمطلوب

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

format: "date-time"

مثال: "2026-01-01T12:00:00Z"

versionعدد صحيحمطلوب

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

مثال: 1

warehouse_idسلسلة نصيةمطلوب

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

مثال: "example"

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

activeقيمة منطقيةمطلوب

ما إذا كان المورد نشطًا.

مثال: true

allocationsمصفوفة <AllocationData > مطلوب

الكميات المخصصة لمواقع المستودع.

مثال: [{"location_code":"example","location_id":"example","location_name":"example","on_hand":10}]

availableعدد صحيح | nullمطلوب

الكمية المتاحة للبيع؛ تمثل null كمية غير محدودة.

مثال: 5

idسلسلة نصيةمطلوب

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

مثال: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reservedعدد صحيحمطلوب

الكمية المحجوزة يدويًا.

مثال: 2

on_handعدد صحيحمطلوب

الكمية الفعلية في المخزون.

مثال: 10

reservedعدد صحيحمطلوب

الكمية المحجوزة لطلبات الشراء.

مثال: 3

sellable_limitعدد صحيحمطلوب

حد البيع: تعني -1 أنه غير محدود، بينما تعطل 0 التوفر للبيع.

مثال: 10

target_idسلسلة نصيةمطلوب

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

مثال: "example"

target_typeسلسلة نصيةمطلوب

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

القيود

enum

["product", "variant"]

مثال: "product"

total_reservedعدد صحيحمطلوب

إجمالي الكمية المحجوزة.

مثال: 5

updated_atسلسلة نصيةمطلوب

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

format: "date-time"

مثال: "2026-01-01T12:00:00Z"

versionعدد صحيحمطلوب

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

مثال: 1

warehouse_idسلسلة نصيةمطلوب

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

مثال: "example"

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