مخططات البيانات: المستودعات والمواقع

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

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

مثال: [{"code":"example","created_at":"2026-01-01T12:00:00Z","id":"example","is_leaf":true,"location_type":"zone","name":"Example","parent_id":null,"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"}

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

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

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

مثال: [{"active":true,"address_line":"example","city":"example","code":"example","country_code":"PL","created_at":"2026-01-01T12:00:00Z","customer_visible":false,"id":"example","name":"Example","postal_code":"example","updated_at":"2026-01-01T12:00:00Z","version":1}]

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

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

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

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

dataWarehouseData مطلوب

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

مثال: {"active":true,"address_line":"example","city":"example","code":"example","country_code":"PL","created_at":"2026-01-01T12:00:00Z","customer_visible":false,"id":"example","name":"Example","postal_code":"example","updated_at":"2026-01-01T12:00:00Z","version":1}

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

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

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

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

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

رمز ثابت قابل للقراءة آليًا.

مثال: "example"

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

وقت الإنشاء.

format: "date-time"

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

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

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

مثال: "example"

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

ما إذا كانت الفئة لا تحتوي على فئات فرعية.

مثال: true

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

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

القيود

enum

["zone", "rack", "shelf", "bin"]

مثال: "zone"

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

اسم المورد في السياق المناسب.

مثال: "Example"

parent_idسلسلة نصية | nullمطلوب

معرّف الفئة الأم.

مثال: null

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

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

format: "date-time"

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

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

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

مثال: 1

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

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

مثال: "example"

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

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

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

القيود

pattern

"^[a-z0-9][a-z0-9_-]{0,62}$"

مثال: "example"

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

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

minimum: 0maximum: 2147483647

مثال: 1

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

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

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

مثال: true

address_lineسلسلة نصية | nullمطلوب

سطر العنوان.

مثال: "example"

cityسلسلة نصية | nullمطلوب

المدينة أو المنطقة المحلية.

مثال: "example"

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

رمز ثابت قابل للقراءة آليًا.

مثال: "example"

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

رمز البلد.

مثال: "PL"

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

وقت الإنشاء.

format: "date-time"

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

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

ما إذا كانت الحالة ظاهرة للعميل.

مثال: false

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

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

مثال: "example"

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

اسم المورد في السياق المناسب.

مثال: "Example"

postal_codeسلسلة نصية | nullمطلوب

الرمز البريدي.

مثال: "example"

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

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

format: "date-time"

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

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

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

مثال: 1

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