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

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

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

عرض القائمة · متغيرات المنتج — المتغيرات والخيارات — الاستجابة

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

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

مثال: [{"active":true,"created_at":"2026-01-01T12:00:00Z","id":"example","is_default":true,"media_ids":["example"],"position":1,"pricing":{"base_adjustment":{"amount":"0.00","currency":"PLN","minor_units":2},"market_price":null,"price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"product_version":1,"version":1},"primary_media_id":"example","product_id":"example","sku":"example","updated_at":"2026-01-01T12:00:00Z","values":[{"option_id":"example","option_name":"example","value":"example","value_id":"example"}],"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_list_VariantOptionData__ · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.

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

مثال: [{"created_at":"2026-01-01T12:00:00Z","id":"example","name":"Example","number":"example","position":1,"selection_type":"button","updated_at":"2026-01-01T12:00:00Z","value_presentation_type":"text","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_list_VariantValueData__ · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.

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

مثال: [{"color_hex":"#008855","created_at":"2026-01-01T12:00:00Z","id":"example","image_media_id":null,"number":"example","option_id":"example","position":1,"sku_code":"example","updated_at":"2026-01-01T12:00:00Z","value":"example","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_ProductVariantData_ · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها.

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

مثال: {"active":true,"created_at":"2026-01-01T12:00:00Z","id":"example","is_default":true,"media_ids":["example"],"position":1,"pricing":{"base_adjustment":{"amount":"0.00","currency":"PLN","minor_units":2},"market_price":null,"price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"product_version":1,"version":1},"primary_media_id":"example","product_id":"example","sku":"example","updated_at":"2026-01-01T12:00:00Z","values":[{"option_id":"example","option_name":"example","value":"example","value_id":"example"}],"version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta مطلوب: البيانات الوصفية للاستجابة.

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

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

جلب · الخيارات — المتغيرات والخيارات — الاستجابة

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

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

مثال: {"created_at":"2026-01-01T12:00:00Z","id":"example","name":"Example","number":"example","position":1,"selection_type":"button","updated_at":"2026-01-01T12:00:00Z","value_presentation_type":"text","version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta مطلوب: البيانات الوصفية للاستجابة.

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

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

جلب · قيم الخيارات — المتغيرات والخيارات — الاستجابة

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

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

مثال: {"color_hex":"#008855","created_at":"2026-01-01T12:00:00Z","id":"example","image_media_id":null,"number":"example","option_id":"example","position":1,"sku_code":"example","updated_at":"2026-01-01T12:00:00Z","value":"example","version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta مطلوب: البيانات الوصفية للاستجابة.

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

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

جلب · الخيارات — المتغيرات والخيارات — الاستجابة

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

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

وقت الإنشاء.

format: "date-time"

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

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

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

مثال: "example"

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

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

مثال: "Example"

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

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

مثال: "example"

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

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

مثال: 1

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

الوضع المسموح لاختيار قيم الخصائص.

القيود

enum: ["button", "dropdown"]

مثال: "button"

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

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

format: "date-time"

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

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

كيفية عرض قيم الدليل.

القيود

enum: ["text", "color", "image"]

مثال: "text"

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

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

مثال: 1

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

جلب · متغيرات المنتج — المتغيرات والخيارات — الاستجابة

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

activeقيمة منطقيةمطلوب: ما إذا كان المورد نشطًا.

مثال: true
created_atسلسلة نصيةمطلوب: وقت الإنشاء.

format: "date-time"

مثال: "2026-01-01T12:00:00Z"
idسلسلة نصيةمطلوب: معرّف المورد؛ احتفظ به كما أعيد. (ProductVariantData).

مثال: "example"
is_defaultقيمة منطقيةمطلوب: ما إذا كان هذا هو الخيار الافتراضي.

مثال: true
media_idsمصفوفة <سلسلة نصية> مطلوب: معرّفات ملفات الوسائط الموجودة مسبقًا.

مثال: ["example"]
positionعدد صحيحمطلوب: الموضع في المجموعة المرتبة.

مثال: 1
pricingVariantPricingData مطلوب: إعدادات الأسعار وإصدارات التحكم في التعديلات المتزامنة.

مثال: {"base_adjustment":{"amount":"0.00","currency":"PLN","minor_units":2},"market_price":null,"price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"product_version":1,"version":1}
primary_media_idسلسلة نصية nullمطلوب: معرّف ملف الوسائط الرئيسي.

مثال: "example"
product_idسلسلة نصيةمطلوب: معرّف المنتج.

مثال: "example"
skuسلسلة نصيةمطلوب: رمز وحدة حفظ المخزون.

مثال: "example"
updated_atسلسلة نصيةمطلوب: وقت آخر تحديث.

format: "date-time"

مثال: "2026-01-01T12:00:00Z"
valuesمصفوفة <VariantChoiceData > مطلوب: قيم الدليل.

مثال: [{"option_id":"example","option_name":"example","value":"example","value_id":"example"}]
versionعدد صحيحمطلوب: إصدار المورد المستخدم للتحكم في التعديلات المتزامنة.

مثال: 1

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

قيم الدليل

VariantChoiceData · المخطط · مخططات البيانات: المتغيرات والخيارات

option_idسلسلة نصيةمطلوب: معرّف خيار متغير المنتج.

مثال: "example"
option_nameسلسلة نصية nullمطلوب: اسم خيار متغير المنتج.

مثال: "example"
valueسلسلة نصية nullمطلوب: القيمة التي يحددها المخطط المحيط بها.

مثال: "example"
value_idسلسلة نصيةمطلوب: معرّف قيمة الدليل.

مثال: "example"

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

إنشاء · متغيرات المنتج — المتغيرات والخيارات — محتوى الطلب

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

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

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

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

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

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

minimum: 1maximum: 9223372036854775807

مثال: 1

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

ما إذا كان هذا هو الخيار الافتراضي.

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

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

maxItems: 20

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

pricingVariantPrice اختياري

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

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

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

minLength: 1maxLength: 100

القيود

pattern: "^\\S+$"

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

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

minItems: 1maxItems: 250

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

مثال: ["example"]

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

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

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

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

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

minLength: 1maxLength: 120

القيود

pattern: "^[^\\x00]*$"

مثال: "Example"

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

الوضع المسموح لاختيار قيم الخصائص.

القيود

enum: ["button", "dropdown"]

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

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

كيفية عرض قيم الدليل.

القيود

enum: ["text", "color", "image"]

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

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

تحديث · الخيارات — المتغيرات والخيارات — محتوى الطلب

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

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

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

minimum: 1maximum: 9223372036854775807

مثال: 1

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

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

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

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

pattern: "^[^\\x00]*$"

مثال: "Example"

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

الوضع المسموح لاختيار قيم الخصائص.

القيود

enum: ["button", "dropdown"]

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

كيفية عرض قيم الدليل.

القيود

enum: ["text", "color", "image"]

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

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

VariantPrice · المخطط · مخططات البيانات: المتغيرات والخيارات

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

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

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

القيود · سلسلة نصية 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_product_versionعدد صحيحمطلوب

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

minimum: 0maximum: 9223372036854775807

مثال: 1

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

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

minimum: 0maximum: 9223372036854775807

مثال: 0

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

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

القيود

enum: ["base_adjustment", "market_fixed"]

مثال: "base_adjustment"

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

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

minLength: 1maxLength: 63

مثال: "example"

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

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

VariantPricingData · المخطط · مخططات البيانات: المتغيرات والخيارات

base_adjustmentMoneyData مطلوب: تعديل السعر بالنسبة إلى السعر الأساسي.

مثال: {"amount":"0.00","currency":"PLN","minor_units":2}
market_priceMoneyData nullمطلوب: السعر في السوق المحددة.

مثال: null
pricePriceData nullمطلوب: معلومات السعر في السياق المحدد.

مثال: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
product_versionعدد صحيحمطلوب: الإصدار الحالي للمنتج المستخدم للتحكم في التعديلات المتزامنة.

مثال: 1
versionعدد صحيحمطلوب: إصدار المورد المستخدم للتحكم في التعديلات المتزامنة.

مثال: 1

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

تحديث · متغيرات المنتج — المتغيرات والخيارات — محتوى الطلب

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

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

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

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

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

minimum: 1maximum: 9223372036854775807

مثال: 1

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

ما إذا كان هذا هو الخيار الافتراضي.

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

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

maxItems: 20

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

pricingVariantPrice اختياري

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

مثال:

{"amount":"0.00","currency":"PLN","expected_price_list_version":1,"expected_product_version":1,"expected_version":0,"kind":"base_adjustment","price_list_id":"example"}

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

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

minLength: 1maxLength: 100

القيود

pattern: "^\\S+$"

مثال: "example"

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

إنشاء · قيم الخيارات — المتغيرات والخيارات — محتوى الطلب

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

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

لون ممثل برمز سداسي عشري.

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

pattern: "^#[0-9A-Fa-f]{6}$"

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

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

minimum: 1maximum: 9223372036854775807

مثال: 1

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

القيمة التي يحددها المخطط المحيط بها.

minLength: 1maxLength: 180

القيود

pattern: "^[^\\x00]*$"

مثال: "Example"

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

جلب · قيم الخيارات — المتغيرات والخيارات — الاستجابة

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

color_hexسلسلة نصية nullمطلوب: لون ممثل برمز سداسي عشري.

مثال: "#008855"
created_atسلسلة نصيةمطلوب: وقت الإنشاء.

format: "date-time"

مثال: "2026-01-01T12:00:00Z"
idسلسلة نصيةمطلوب: معرّف المورد؛ احتفظ به كما أعيد. (VariantValueData).

مثال: "example"
image_media_idسلسلة نصية nullمطلوب: معرّف ملف الصورة المحدد.

مثال: null
numberسلسلة نصيةمطلوب: رقم طلب الشراء أو طلب الخدمة المعروض للمستخدم.

مثال: "example"
option_idسلسلة نصيةمطلوب: معرّف خيار متغير المنتج.

مثال: "example"
positionعدد صحيحمطلوب: الموضع في المجموعة المرتبة.

مثال: 1
sku_codeسلسلة نصيةمطلوب: رمز وحدة حفظ المخزون.

مثال: "example"
updated_atسلسلة نصيةمطلوب: وقت آخر تحديث.

format: "date-time"

مثال: "2026-01-01T12:00:00Z"
valueسلسلة نصية nullمطلوب: القيمة التي يحددها المخطط المحيط بها.

مثال: "example"
versionعدد صحيحمطلوب: إصدار المورد المستخدم للتحكم في التعديلات المتزامنة.

مثال: 1

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

تحديث · قيم الخيارات — المتغيرات والخيارات — محتوى الطلب

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

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

لون ممثل برمز سداسي عشري.

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

pattern: "^#[0-9A-Fa-f]{6}$"

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

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

minimum: 1maximum: 9223372036854775807

مثال: 1

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

القيمة التي يحددها المخطط المحيط بها.

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

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

pattern: "^[^\\x00]*$"

مثال: "Example"

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