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

مخططات البيانات: الفئات

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

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

جلب — الفئات — الاستجابة

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

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

مثال: {"created_at":"2026-01-01T12:00:00Z","description":"example","id":"example","introduction":"example","is_available":true,"is_visible":false,"meta_description":"example","meta_keywords":["example"],"meta_title":"example","name":"Example","number":"example","parent_id":null,"slug":"example","updated_at":"2026-01-01T12:00:00Z","version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta مطلوب

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

مثال: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

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

عرض القائمة — الفئات — الاستجابة

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

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

مثال: [{"created_at":"2026-01-01T12:00:00Z","id":"example","is_available":true,"is_visible":false,"name":"Example","number":"example","parent_id":null,"slug":"example","updated_at":"2026-01-01T12:00:00Z","version":1}]
metaContextPageMeta ContextMeta PageMeta RequestMeta مطلوب

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

مثال: {"locale":"en","market_code":"PL","market_id":"example","pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

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

إنشاء — الفئات — محتوى الطلب

CategoryCreate · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.
descriptionسلسلة نصية nullاختياري

الوصف باللغة المحددة.

سلسلة نصية:maxLength: 50000
introductionسلسلة نصية nullاختياري

النص التمهيدي باللغة المحددة.

سلسلة نصية:maxLength: 5000
is_visibleقيمة منطقيةاختياري

ما إذا كان المورد ظاهرًا.

القيمة الافتراضية: false
market_idsمصفوفة <سلسلة نصية> اختياري

معرّفات الأسواق المحددة.

maxItems: 1000
مصفوفة:minLength: 1maxLength: 63
meta_descriptionسلسلة نصية nullاختياري

وصف محركات البحث باللغة المحددة.

سلسلة نصية:maxLength: 160
meta_keywordsمصفوفة <سلسلة نصية> nullاختياري

الكلمات المفتاحية لمحركات البحث باللغة المحددة.

مصفوفة:maxItems: 20
مصفوفة / مصفوفة:maxLength: 50
meta_titleسلسلة نصية nullاختياري

عنوان محركات البحث باللغة المحددة.

سلسلة نصية:maxLength: 70
nameسلسلة نصيةمطلوب

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

minLength: 1maxLength: 200
مثال: "Example"
parent_idسلسلة نصية nullاختياري

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

سلسلة نصية:minLength: 1maxLength: 63
slugسلسلة نصية nullاختياري

جزء مسار URL باللغة المحددة.

سلسلة نصية:maxLength: 160

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

جلب — الفئات — الاستجابة

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

وقت الإنشاء.

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

الوصف باللغة المحددة.

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

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

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

النص التمهيدي باللغة المحددة.

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

ما إذا كان العنصر متاحًا في هذا السياق.

مثال: true
is_visibleقيمة منطقيةمطلوب

ما إذا كان المورد ظاهرًا.

مثال: false
meta_descriptionسلسلة نصية nullمطلوب

وصف محركات البحث باللغة المحددة.

مثال: "example"
meta_keywordsمصفوفة <سلسلة نصية> nullمطلوب

الكلمات المفتاحية لمحركات البحث باللغة المحددة.

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

عنوان محركات البحث باللغة المحددة.

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

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

مثال: "Example"
numberسلسلة نصيةمطلوب

رقم طلب الشراء أو طلب الخدمة المعروض للمستخدم.

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

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

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

جزء مسار URL باللغة المحددة.

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

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

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

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

مثال: 1

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

عرض القائمة — الفئات — الاستجابة

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

وقت الإنشاء.

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

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

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

ما إذا كان العنصر متاحًا في هذا السياق.

مثال: true
is_visibleقيمة منطقيةمطلوب

ما إذا كان المورد ظاهرًا.

مثال: false
nameسلسلة نصية nullمطلوب

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

مثال: "Example"
numberسلسلة نصيةمطلوب

رقم طلب الشراء أو طلب الخدمة المعروض للمستخدم.

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

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

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

جزء مسار URL باللغة المحددة.

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

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

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

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

مثال: 1

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

تحديث — الفئات — محتوى الطلب

CategoryUpdate · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.
descriptionسلسلة نصية nullاختياري

الوصف باللغة المحددة.

سلسلة نصية:maxLength: 50000
expected_versionعدد صحيحمطلوب

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

minimum: 1maximum: 9223372036854775807
مثال: 1
introductionسلسلة نصية nullاختياري

النص التمهيدي باللغة المحددة.

سلسلة نصية:maxLength: 5000
is_visibleقيمة منطقيةاختياري

ما إذا كان المورد ظاهرًا.

market_idsمصفوفة <سلسلة نصية> اختياري

معرّفات الأسواق المحددة.

maxItems: 1000
مصفوفة:minLength: 1maxLength: 63
meta_descriptionسلسلة نصية nullاختياري

وصف محركات البحث باللغة المحددة.

سلسلة نصية:maxLength: 160
meta_keywordsمصفوفة <سلسلة نصية> nullاختياري

الكلمات المفتاحية لمحركات البحث باللغة المحددة.

مصفوفة:maxItems: 20
مصفوفة / مصفوفة:maxLength: 50
meta_titleسلسلة نصية nullاختياري

عنوان محركات البحث باللغة المحددة.

سلسلة نصية:maxLength: 70
nameسلسلة نصية nullاختياري

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

سلسلة نصية:maxLength: 200
مثال: "Example"
parent_idسلسلة نصية nullاختياري

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

سلسلة نصية:minLength: 1maxLength: 63
slugسلسلة نصية nullاختياري

جزء مسار URL باللغة المحددة.

سلسلة نصية:maxLength: 160

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