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

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

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

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

ApiResponse_list_ProductSummaryData__ · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.

dataمصفوفة <ProductSummaryData > مطلوب: مثال على الاستجابة · ApiResponse_list_ProductSummaryData__.

مثال: [{"availability":{"available_from":null,"available_until":null,"is_available":true},"brand_id":null,"condition":"new","created_at":"2026-01-01T12:00:00Z","id":"example","name":"Example","number":"example","price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"price_version":1,"primary_category_id":"example","primary_media_id":"example","published":false,"sku":"example","slug":"example","tax_category_id":"example","updated_at":"2026-01-01T12:00:00Z","variants_enabled":false,"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"}

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

جلب — المنتجات — الاستجابة

ApiResponse_ProductDetailData_ · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.

dataProductDetailData مطلوب: مثال على الاستجابة · ProductDetailData.

مثال: {"availability":{"available_from":null,"available_until":null,"is_available":true},"brand_id":null,"condition":"new","created_at":"2026-01-01T12:00:00Z","description":"example","features":[{"feature_id":"example","feature_name":"example","value":"example","value_id":"example"}],"id":"example","identifiers":{},"media":[{"alt_text":"example","id":"example","is_primary":true,"kind":"image","mime_type":"image/jpeg","position":1,"url":"https://example.invalid/product.jpg"}],"meta_description":"example","meta_keywords":["example"],"meta_title":"example","name":"Example","number":"example","price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"price_version":1,"primary_category_id":"example","primary_media_id":"example","published":false,"sku":"example","slug":"example","tax_category_id":"example","updated_at":"2026-01-01T12:00:00Z","variants_enabled":false,"version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta مطلوب: البيانات الوصفية للاستجابة.

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

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

معلومات التوفر في السياق المحدد

AvailabilityData · المخطط · مخططات البيانات: المنتجات

available_fromسلسلة نصية nullمطلوب: بداية التوفر.

سلسلة نصية:format: "date-time"

مثال: null
available_untilسلسلة نصية nullمطلوب: نهاية التوفر.

سلسلة نصية:format: "date-time"

مثال: null
is_availableقيمة منطقيةمطلوب: ما إذا كان العنصر متاحًا في هذا السياق.

مثال: true

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

معلومات السعر في السياق المحدد

PriceData · المخطط · مخططات البيانات: المنتجات

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

مبلغ عشري ممثل كسلسلة JSON؛ يسمح بالقيمة null فقط حيث يكون ذلك مسموحًا.

مثال: "0.00"

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

رمز عملة المبلغ.

القيود

pattern: "^[A-Z]{3}$"

مثال: "PLN"

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

عدد المنازل العشرية التي تستخدمها العملة.

minimum: 0maximum: 4

مثال: 2

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

ما إذا كان السعر المرسل يشمل الضرائب.

مثال: true

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

معلومات قائمة الأسعار

PriceListData · المخطط · مخططات البيانات: المنتجات

currencyسلسلة نصيةمطلوب: رمز عملة المبلغ.
idسلسلة نصيةمطلوب: معرّف المورد؛ احتفظ به كما أعيد. (PriceListData).
tax_includedقيمة منطقيةمطلوب: ما إذا كان السعر المرسل يشمل الضرائب.
versionعدد صحيحمطلوب: إصدار المورد المستخدم للتحكم في التعديلات المتزامنة.

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

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

ProductCreate · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.

brand_idسلسلة نصية nullاختياري

معرّف العلامة التجارية.

سلسلة نصية:minLength: 1maxLength: 63

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

حالة المنتج.

القيود

enum: ["new", "refurbished", "used", "returned", "display", "damaged"]

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

descriptionسلسلة نصية nullاختياري

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

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

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

معرّفات قيم الخصائص المحددة.

maxItems: 1000

مصفوفة:minLength: 1maxLength: 63

identifiersProductIdentifiers nullاختياري

رموز تعريف المنتج.

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

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

maxItems: 1000

مصفوفة:minLength: 1maxLength: 63

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

معرّفات ملفات الوسائط الموجودة مسبقًا.

maxItems: 20

مصفوفة:minLength: 1maxLength: 63

meta_descriptionسلسلة نصية nullاختياري

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

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

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

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

مصفوفة:maxItems: 20

مصفوفة / مصفوفة:maxLength: 50

meta_titleسلسلة نصية nullاختياري

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

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

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

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

minLength: 1maxLength: 300

مثال: "Example"

pricingProductPrice اختياري

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

primary_category_idسلسلة نصية nullاختياري

معرّف الفئة الرئيسية.

سلسلة نصية:minLength: 1maxLength: 63

publishedقيمة منطقيةاختياري

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

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

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

رمز وحدة حفظ المخزون.

minLength: 1maxLength: 100

القيود

pattern: "^\\S+$"

مثال: "example"

slugسلسلة نصية nullاختياري

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

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

tax_category_idسلسلة نصية nullاختياري

معرّف الفئة الضريبية.

سلسلة نصية:minLength: 1maxLength: 63

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

معرّفات قيم المتغيرات المحددة.

maxItems: 250

مصفوفة:minLength: 1maxLength: 63

variants_enabledقيمة منطقيةاختياري

ما إذا كان المنتج يستخدم متغيرات.

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

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

جلب — المنتجات — الاستجابة

ProductDetailData · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.

availabilityAvailabilityData مطلوب

معلومات التوفر في السياق المحدد.

مثال: {"available_from":null,"available_until":null,"is_available":true}

brand_idسلسلة نصية nullمطلوب

معرّف العلامة التجارية.

مثال: null

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

حالة المنتج.

القيود

enum: ["new", "refurbished", "used", "returned", "display", "damaged"]

مثال: "new"

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

وقت الإنشاء.

format: "date-time"

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

descriptionسلسلة نصية nullمطلوب

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

مثال: "example"

featuresمصفوفة <FeatureSelectionData > مطلوب

خصائص المنتج.

مثال: [{"feature_id":"example","feature_name":"example","value":"example","value_id":"example"}]

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

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

مثال: "example"

identifiersكائنحقول إضافية: سلسلة نصيةمطلوب

رموز تعريف المنتج.

مثال: {}

mediaمصفوفة <ProductMediaData > مطلوب

معلومات ملفات الوسائط المرفقة.

مثال:

[{"alt_text":"example","id":"example","is_primary":true,"kind":"image","mime_type":"image/jpeg","position":1,"url":"https://example.invalid/product.jpg"}]

meta_descriptionسلسلة نصية nullمطلوب

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

مثال: "example"

meta_keywordsمصفوفة <سلسلة نصية> nullمطلوب

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

مثال: ["example"]

meta_titleسلسلة نصية nullمطلوب

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

مثال: "example"

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

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

مثال: "Example"

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

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

مثال: "example"

pricePriceData nullمطلوب

معلومات السعر في السياق المحدد.

مثال: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}

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

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

مثال: 1

primary_category_idسلسلة نصية nullمطلوب

معرّف الفئة الرئيسية.

مثال: "example"

primary_media_idسلسلة نصية nullمطلوب

معرّف ملف الوسائط الرئيسي.

مثال: "example"

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

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

مثال: false

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

رمز وحدة حفظ المخزون.

مثال: "example"

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

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

مثال: "example"

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

معرّف الفئة الضريبية.

مثال: "example"

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

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

format: "date-time"

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

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

ما إذا كان المنتج يستخدم متغيرات.

مثال: false

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

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

مثال: 1

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

رموز تعريف المنتج

ProductIdentifiers · المخطط · مخططات البيانات: المنتجات

eanسلسلة نصية nullاختياري: معرّف EAN للمنتج.

سلسلة نصية:minLength: 1maxLength: 100
isbnسلسلة نصية nullاختياري: معرّف ISBN.

سلسلة نصية:minLength: 1maxLength: 100
mpnسلسلة نصية nullاختياري: رقم القطعة لدى الشركة المصنعة.

سلسلة نصية:minLength: 1maxLength: 100
upcسلسلة نصية nullاختياري: معرّف UPC للمنتج.

سلسلة نصية:minLength: 1maxLength: 100

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

معلومات ملفات الوسائط المرفقة

ProductMediaData · المخطط · مخططات البيانات: المنتجات

alt_textسلسلة نصية nullمطلوب

النص البديل للصورة.

مثال: "example"

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

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

مثال: "example"

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

ما إذا كان هذا هو العنصر الرئيسي.

مثال: true

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

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

القيود

enum: ["image", "video", "model_3d"]

مثال: "image"

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

نوع محتوى الوسائط.

مثال: "image/jpeg"

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

الموضع في المجموعة المرتبة.

مثال: 1

urlسلسلة نصية nullمطلوب

عنوان URL للمورد.

مثال: "https://example.invalid/product.jpg"

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

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

ProductPrice · المخطط · مخططات البيانات: المنتجات

amountسلسلة نصية nullمطلوب

مبلغ عشري ممثل كسلسلة JSON؛ يسمح بالقيمة null فقط حيث يكون ذلك مسموحًا.

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

القيود · سلسلة نصية 1

pattern: "^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"

مثال: "0.00"

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

رمز عملة المبلغ.

القيود

pattern: "^[A-Z]{3}$"

مثال: "PLN"

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

إصدار قائمة الأسعار المقروء سابقًا والمطلوب لعملية الكتابة هذه.

minimum: 1maximum: 9223372036854775807

مثال: 1

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

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

minimum: 0maximum: 9223372036854775807

مثال: 0

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

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

القيود

enum: ["base", "market_fixed"]

مثال: "base"

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

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

minLength: 1maxLength: 63

مثال: "example"

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

ما إذا كان السعر المرسل يشمل الضرائب.

مثال: true

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

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

ProductSummaryData · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.

availabilityAvailabilityData مطلوب

معلومات التوفر في السياق المحدد.

مثال: {"available_from":null,"available_until":null,"is_available":true}

brand_idسلسلة نصية nullمطلوب

معرّف العلامة التجارية.

مثال: null

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

حالة المنتج.

القيود

enum: ["new", "refurbished", "used", "returned", "display", "damaged"]

مثال: "new"

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

وقت الإنشاء.

format: "date-time"

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

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

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

مثال: "example"

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

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

مثال: "Example"

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

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

مثال: "example"

pricePriceData nullمطلوب

معلومات السعر في السياق المحدد.

مثال: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}

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

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

مثال: 1

primary_category_idسلسلة نصية nullمطلوب

معرّف الفئة الرئيسية.

مثال: "example"

primary_media_idسلسلة نصية nullمطلوب

معرّف ملف الوسائط الرئيسي.

مثال: "example"

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

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

مثال: false

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

رمز وحدة حفظ المخزون.

مثال: "example"

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

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

مثال: "example"

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

معرّف الفئة الضريبية.

مثال: "example"

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

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

format: "date-time"

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

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

ما إذا كان المنتج يستخدم متغيرات.

مثال: false

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

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

مثال: 1

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

تحديث — المنتجات — محتوى الطلب

ProductUpdate · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.

brand_idسلسلة نصية nullاختياري

معرّف العلامة التجارية.

سلسلة نصية:minLength: 1maxLength: 63

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

حالة المنتج.

القيود

enum: ["new", "refurbished", "used", "returned", "display", "damaged"]

descriptionسلسلة نصية nullاختياري

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

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

مثال: null

expected_variant_price_versionsكائنحقول إضافية: عدد صحيح

minimum: 0maximum: 9223372036854775807

اختياري

إصدارات الأسعار المقروءة سابقًا، مفهرسة حسب معرّف متغير المنتج.

maxProperties: 250

القيود

propertyNames: {"maxLength": 63, "minLength": 1}

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

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

minimum: 1maximum: 9223372036854775807

مثال: 1

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

معرّفات قيم الخصائص المحددة.

maxItems: 1000

مصفوفة:minLength: 1maxLength: 63

identifiersProductIdentifiers nullاختياري

رموز تعريف المنتج.

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

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

maxItems: 1000

مصفوفة:minLength: 1maxLength: 63

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

معرّفات ملفات الوسائط الموجودة مسبقًا.

maxItems: 20

مصفوفة:minLength: 1maxLength: 63

meta_descriptionسلسلة نصية nullاختياري

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

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

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

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

مصفوفة:maxItems: 20

مصفوفة / مصفوفة:maxLength: 50

meta_titleسلسلة نصية nullاختياري

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

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

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

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

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

مثال: null

pricingProductPrice اختياري

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

مثال:

{"amount":"0.00","currency":"PLN","expected_price_list_version":1,"expected_version":0,"kind":"base","price_list_id":"example","tax_included":true}

primary_category_idسلسلة نصية nullاختياري

معرّف الفئة الرئيسية.

سلسلة نصية:minLength: 1maxLength: 63

publishedقيمة منطقيةاختياري

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

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

رمز وحدة حفظ المخزون.

minLength: 1maxLength: 100

القيود

pattern: "^\\S+$"

مثال: "example"

slugسلسلة نصية nullاختياري

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

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

tax_category_idسلسلة نصية nullاختياري

معرّف الفئة الضريبية.

سلسلة نصية:minLength: 1maxLength: 63

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

معرّفات قيم المتغيرات المحددة.

maxItems: 250

مصفوفة:minLength: 1maxLength: 63

variants_enabledقيمة منطقيةاختياري

ما إذا كان المنتج يستخدم متغيرات.

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