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

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

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

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

ApiResponse_ProductFileListData_

ApiResponse_ProductFileListData_ · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها. بعد إنشاء upload_id أرسل الملفات بصيغة multipart/form-data ثم اربطها بالمنتج. يتطلب التنزيل رمز Bearer وصلاحية category؛ يحتوي الرد على بايتات الملف دون عنوان عام أو كلمة مرور. عند mode=period اختر days ‏(1–3650) أو months السابق، ولا تستخدمهما معًا. تُحفظ الشروط عند الشراء؛ ويُلغي الاسترداد الوصول إلى بند الطلب المسترد فقط.
dataProductFileListData مطلوب

محتوى الاستجابة الناجحة.

مثال: {"files":[{"category":"digital","created_at":"2026-01-01T12:00:00Z","current_version_id":"00000000-0000-4000-8000-000000000001","file_id":"00000000-0000-4000-8000-000000000001","filename":"manual.pdf","id":"00000000-0000-4000-8000-000000000001","label":"Manual","mime_type":"application/pdf","sha256":"5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd","size_bytes":46,"state":"active","version_number":1}],"product_version":2}
metaContextPageMeta ContextMeta PageMeta RequestMeta مطلوب

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

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

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

ApiResponse_ReleaseListData_

ApiResponse_ReleaseListData_ · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها. بعد إنشاء upload_id أرسل الملفات بصيغة multipart/form-data ثم اربطها بالمنتج. يتطلب التنزيل رمز Bearer وصلاحية category؛ يحتوي الرد على بايتات الملف دون عنوان عام أو كلمة مرور. عند mode=period اختر days ‏(1–3650) أو months السابق، ولا تستخدمهما معًا. تُحفظ الشروط عند الشراء؛ ويُلغي الاسترداد الوصول إلى بند الطلب المسترد فقط.
dataReleaseListData مطلوب

محتوى الاستجابة الناجحة.

مثال: {"current_release_id":"00000000-0000-4000-8000-000000000001","product_version":2,"releases":[{"changelog":"Manual update","files":[{"file_id":"00000000-0000-4000-8000-000000000001","sort_order":0,"version_id":"00000000-0000-4000-8000-000000000001"}],"id":"00000000-0000-4000-8000-000000000001","manifest_sha256":"1111111111111111111111111111111111111111111111111111111111111111","published_at":null,"release_sequence":null,"state":"active","version_label":"1.0","withdrawn_at":null}],"update_days":365,"update_mode":"period","update_months":null}
metaContextPageMeta ContextMeta PageMeta RequestMeta مطلوب

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

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

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

ApiResponse_UploadData_

ApiResponse_UploadData_ · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها. بعد إنشاء upload_id أرسل الملفات بصيغة multipart/form-data ثم اربطها بالمنتج. يتطلب التنزيل رمز Bearer وصلاحية category؛ يحتوي الرد على بايتات الملف دون عنوان عام أو كلمة مرور. عند mode=period اختر days ‏(1–3650) أو months السابق، ولا تستخدمهما معًا. تُحفظ الشروط عند الشراء؛ ويُلغي الاسترداد الوصول إلى بند الطلب المسترد فقط.
dataUploadData مطلوب

محتوى الاستجابة الناجحة.

مثال: {"category":"digital","expires_at":"2026-01-01T12:00:00Z","filename":"manual.pdf","id":"00000000-0000-4000-8000-000000000001","product_id":"example","received_bytes":46,"sha256":"5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd","size_bytes":46,"status":"ready"}
metaContextPageMeta ContextMeta PageMeta RequestMeta مطلوب

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

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

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

ApiResponse[AudienceData]

ApiResponse_AudienceData_ · اقرأ قاعدة الوصول وإصدار المنتج. يظل وقت النشر الأول هو المرجع الزمني.
dataAudienceData مطلوب

محتوى الاستجابة الناجحة.

مثال: {"anchor_at":"2026-11-03T12:00:00Z","effective_at":"2026-11-03T12:00:00Z","file_id":"00000000-0000-4000-8000-000000000007","file_version_id":"00000000-0000-4000-8000-000000000010","historical_access_preserved":true,"id":"00000000-0000-4000-8000-000000000009","lookback_days":null,"mode":"all_purchasers","next_cursor":null,"order_ids":[],"product_version":3,"revision":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta مطلوب

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

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

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

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

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"}

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

AudienceChange

AudienceChange · اختر المشتريات المؤهلة. يجب أن تتضمن الطلبات المحددة هذا المنتج مدفوعًا ودون رد مبلغه.
audienceAudienceSelection مطلوب

قاعدة وصول صريحة إلى الملف المشترك.

مثال: {"mode":"all_purchasers"}
expected_versionعدد صحيحمطلوب

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

minimum: 1maximum: 9223372036854775807
مثال: 1

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

AudienceData

AudienceData · اقرأ قاعدة الوصول وإصدار المنتج. يظل وقت النشر الأول هو المرجع الزمني.
anchor_atسلسلة نصيةمطلوب

وقت النشر الأول؛ لا يتغير عند تعديل القاعدة.

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

وقت نشر قاعدة الوصول هذه.

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

معرّف المورد؛ احتفظ به كما أعيد. · file_id

مثال: "00000000-0000-4000-8000-000000000007"
file_version_idسلسلة نصيةمطلوب

معرّف إصدار ثابت لمحتوى الملف.

مثال: "00000000-0000-4000-8000-000000000010"
historical_access_preservedقيمة منطقيةاختياري

تبقى الحقوق الممنوحة سابقًا عند تضييق القاعدة.

القيمة الافتراضية: trueمثال: true
idسلسلة نصيةمطلوب

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

مثال: "00000000-0000-4000-8000-000000000009"
lookback_daysعدد صحيح nullمطلوب

1–3650 يومًا قبل النشر الأول؛ فقط مع recent_and_new.

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

قاعدة وصول صريحة إلى الملف المشترك. new_purchases / recent_and_new / selected / all_purchasers.

مثال: "all_purchasers"
next_cursorسلسلة نصية nullمطلوب

قيمة المتابعة للصفحة التالية، أو null.

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

طلبات تتضمن هذا المنتج مدفوعًا ودون رد مبلغه.

مثال: []
product_versionعدد صحيحمطلوب

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

مثال: 3
revisionعدد صحيحمطلوب

مراجعة متسلسلة لقاعدة الوصول.

مثال: 1

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

AudienceSelection

AudienceSelection · اختر المشتريات المؤهلة. يجب أن تتضمن الطلبات المحددة هذا المنتج مدفوعًا ودون رد مبلغه.
lookback_daysعدد صحيح nullاختياري

1–3650 يومًا قبل النشر الأول؛ فقط مع recent_and_new.

عدد صحيح:minimum: 1maximum: 3650
modeسلسلة نصيةمطلوب

قاعدة وصول صريحة إلى الملف المشترك. new_purchases / recent_and_new / selected / all_purchasers.

القيود
enum
["new_purchases", "recent_and_new", "selected", "all_purchasers"]
مثال: "new_purchases"
order_idsمصفوفة <سلسلة نصية> اختياري

طلبات تتضمن هذا المنتج مدفوعًا ودون رد مبلغه.

maxItems: 1000
القيود · مصفوفة 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
القيمة الافتراضية: []

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

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

AvailabilityData · المخطط · مخططات البيانات: المنتجات
available_fromسلسلة نصية nullمطلوب

بداية التوفر.

سلسلة نصية:format: "date-time"
مثال: null
available_untilسلسلة نصية nullمطلوب

نهاية التوفر.

سلسلة نصية:format: "date-time"
مثال: null
is_availableقيمة منطقيةمطلوب

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

مثال: true

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

FileAssign

FileAssign · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها. بعد إنشاء upload_id أرسل الملفات بصيغة multipart/form-data ثم اربطها بالمنتج. يتطلب التنزيل رمز Bearer وصلاحية category؛ يحتوي الرد على بايتات الملف دون عنوان عام أو كلمة مرور. عند mode=period اختر days ‏(1–3650) أو months السابق، ولا تستخدمهما معًا. تُحفظ الشروط عند الشراء؛ ويُلغي الاسترداد الوصول إلى بند الطلب المسترد فقط.
audienceAudienceSelection nullاختياري

قاعدة وصول صريحة إلى الملف المشترك.

مثال: {"mode":"new_purchases"}
expected_versionعدد صحيحمطلوب

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

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

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

maxLength: 300
القيمة الافتراضية: ""
upload_idسلسلة نصيةمطلوب

معرّف المورد؛ احتفظ به كما أعيد. · upload_id

format: "uuid"
مثال: "00000000-0000-4000-8000-000000000001"

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

FileCategory

FileCategory · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها. بعد إنشاء upload_id أرسل الملفات بصيغة multipart/form-data ثم اربطها بالمنتج. يتطلب التنزيل رمز Bearer وصلاحية category؛ يحتوي الرد على بايتات الملف دون عنوان عام أو كلمة مرور. عند mode=period اختر days ‏(1–3650) أو months السابق، ولا تستخدمهما معًا. تُحفظ الشروط عند الشراء؛ ويُلغي الاسترداد الوصول إلى بند الطلب المسترد فقط.
سلسلة نصية
القيود
enum
["internal", "customer_document", "digital"]

حقول إضافية: نعم

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

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: 30
مصفوفة: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

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

ProductFileData

ProductFileData · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها. بعد إنشاء upload_id أرسل الملفات بصيغة multipart/form-data ثم اربطها بالمنتج. يتطلب التنزيل رمز Bearer وصلاحية category؛ يحتوي الرد على بايتات الملف دون عنوان عام أو كلمة مرور. عند mode=period اختر days ‏(1–3650) أو months السابق، ولا تستخدمهما معًا. تُحفظ الشروط عند الشراء؛ ويُلغي الاسترداد الوصول إلى بند الطلب المسترد فقط.
categoryFileCategory مطلوب

فئة الملف: internal / customer_document / digital

مثال: "digital"
created_atسلسلة نصيةمطلوب

وقت الإنشاء.

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

معرّف المورد؛ احتفظ به كما أعيد. · current_version_id

format: "uuid"
مثال: "00000000-0000-4000-8000-000000000001"
file_idسلسلة نصيةمطلوب

معرّف المورد؛ احتفظ به كما أعيد. · file_id

format: "uuid"
مثال: "00000000-0000-4000-8000-000000000001"
filenameسلسلة نصيةمطلوب

الملف

مثال: "manual.pdf"
idسلسلة نصيةمطلوب

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

format: "uuid"
مثال: "00000000-0000-4000-8000-000000000001"
labelسلسلة نصيةمطلوب

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

مثال: "Manual"
mime_typeسلسلة نصيةمطلوب

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

مثال: "application/pdf"
sha256سلسلة نصيةمطلوب

SHA-256 (hex, 64)

مثال: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytesعدد صحيحمطلوب

الحجم بالبايت

مثال: 46
stateسلسلة نصيةمطلوب

الحالة

مثال: "active"
version_numberعدد صحيحمطلوب

النسخة

مثال: 1

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

ProductFileListData

ProductFileListData · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها. بعد إنشاء upload_id أرسل الملفات بصيغة multipart/form-data ثم اربطها بالمنتج. يتطلب التنزيل رمز Bearer وصلاحية category؛ يحتوي الرد على بايتات الملف دون عنوان عام أو كلمة مرور. عند mode=period اختر days ‏(1–3650) أو months السابق، ولا تستخدمهما معًا. تُحفظ الشروط عند الشراء؛ ويُلغي الاسترداد الوصول إلى بند الطلب المسترد فقط.
filesمصفوفة <ProductFileData > مطلوب

ملفات المنتج

مثال: [{"category":"digital","created_at":"2026-01-01T12:00:00Z","current_version_id":"00000000-0000-4000-8000-000000000001","file_id":"00000000-0000-4000-8000-000000000001","filename":"manual.pdf","id":"00000000-0000-4000-8000-000000000001","label":"Manual","mime_type":"application/pdf","sha256":"5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd","size_bytes":46,"state":"active","version_number":1}]
product_versionعدد صحيحمطلوب

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

مثال: 2

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

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

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: 30
مصفوفة:minLength: 1maxLength: 63
meta_descriptionسلسلة نصية nullاختياري

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

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

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

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

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

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

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

سلسلة نصية:maxLength: 300
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قيمة منطقيةاختياري

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

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

ProductVersion

ProductVersion · أُوقفت هذه العملية وتعيد 409 دون تغيير البيانات. اضبط الوصول لكل ملف رقمي على حدة من خلال اختيار المستلمين.
expected_versionعدد صحيحمطلوب

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

minimum: 1maximum: 9223372036854775807
مثال: 1

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

ReleaseData

ReleaseData · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها. بعد إنشاء upload_id أرسل الملفات بصيغة multipart/form-data ثم اربطها بالمنتج. يتطلب التنزيل رمز Bearer وصلاحية category؛ يحتوي الرد على بايتات الملف دون عنوان عام أو كلمة مرور. عند mode=period اختر days ‏(1–3650) أو months السابق، ولا تستخدمهما معًا. تُحفظ الشروط عند الشراء؛ ويُلغي الاسترداد الوصول إلى بند الطلب المسترد فقط.
changelogسلسلة نصيةمطلوب

وصف التغييرات

مثال: "Manual update"
filesمصفوفة <ReleaseFileData > مطلوب

ملفات المنتج

مثال: [{"file_id":"00000000-0000-4000-8000-000000000001","sort_order":0,"version_id":"00000000-0000-4000-8000-000000000001"}]
idسلسلة نصيةمطلوب

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

format: "uuid"
مثال: "00000000-0000-4000-8000-000000000001"
manifest_sha256سلسلة نصية nullمطلوب

الإصدارات الرقمية · SHA-256

مثال: "1111111111111111111111111111111111111111111111111111111111111111"
published_atسلسلة نصية nullمطلوب

نشر الإصدار · UTC

سلسلة نصية:format: "date-time"
مثال: null
release_sequenceعدد صحيح nullمطلوب

الإصدارات الرقمية · الموضع في المجموعة المرتبة.

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

الحالة

مثال: "active"
version_labelسلسلة نصيةمطلوب

النسخة

مثال: "1.0"
withdrawn_atسلسلة نصية nullمطلوب

سحب العرض · UTC

سلسلة نصية:format: "date-time"
مثال: null

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

ReleaseDraft

ReleaseDraft · أُوقفت هذه العملية وتعيد 409 دون تغيير البيانات. اضبط الوصول لكل ملف رقمي على حدة من خلال اختيار المستلمين.
changelogسلسلة نصيةاختياري

وصف التغييرات

maxLength: 20000
القيمة الافتراضية: ""
expected_versionعدد صحيحمطلوب

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

minimum: 1maximum: 9223372036854775807
مثال: 1
version_idsمصفوفة <سلسلة نصية> مطلوب

النسخة · UUID[]

minItems: 1maxItems: 20
مصفوفة:format: "uuid"
مثال: ["00000000-0000-4000-8000-000000000001"]
version_labelسلسلة نصيةمطلوب

النسخة

minLength: 1maxLength: 64
مثال: "1.0"

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

ReleaseFileData

ReleaseFileData · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها. بعد إنشاء upload_id أرسل الملفات بصيغة multipart/form-data ثم اربطها بالمنتج. يتطلب التنزيل رمز Bearer وصلاحية category؛ يحتوي الرد على بايتات الملف دون عنوان عام أو كلمة مرور. عند mode=period اختر days ‏(1–3650) أو months السابق، ولا تستخدمهما معًا. تُحفظ الشروط عند الشراء؛ ويُلغي الاسترداد الوصول إلى بند الطلب المسترد فقط.
file_idسلسلة نصيةمطلوب

معرّف المورد؛ احتفظ به كما أعيد. · file_id

format: "uuid"
مثال: "00000000-0000-4000-8000-000000000001"
sort_orderعدد صحيحمطلوب

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

مثال: 0
version_idسلسلة نصيةمطلوب

معرّف المورد؛ احتفظ به كما أعيد. · version_id

format: "uuid"
مثال: "00000000-0000-4000-8000-000000000001"

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

ReleaseListData

ReleaseListData · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها. بعد إنشاء upload_id أرسل الملفات بصيغة multipart/form-data ثم اربطها بالمنتج. يتطلب التنزيل رمز Bearer وصلاحية category؛ يحتوي الرد على بايتات الملف دون عنوان عام أو كلمة مرور. عند mode=period اختر days ‏(1–3650) أو months السابق، ولا تستخدمهما معًا. تُحفظ الشروط عند الشراء؛ ويُلغي الاسترداد الوصول إلى بند الطلب المسترد فقط.
current_release_idسلسلة نصية nullمطلوب

معرّف المورد؛ احتفظ به كما أعيد. · current_release_id

سلسلة نصية:format: "uuid"
مثال: "00000000-0000-4000-8000-000000000001"
product_versionعدد صحيحمطلوب

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

مثال: 2
releasesمصفوفة <ReleaseData > مطلوب

الإصدارات الرقمية

مثال: [{"changelog":"Manual update","files":[{"file_id":"00000000-0000-4000-8000-000000000001","sort_order":0,"version_id":"00000000-0000-4000-8000-000000000001"}],"id":"00000000-0000-4000-8000-000000000001","manifest_sha256":"1111111111111111111111111111111111111111111111111111111111111111","published_at":null,"release_sequence":null,"state":"active","version_label":"1.0","withdrawn_at":null}]
update_daysعدد صحيح nullمطلوب

عدد الأيام (days; null)

مثال: 365
update_modeسلسلة نصيةمطلوب

الوصول إلى الملفات المستقبلية بعد الشراء: none / period / unlimited

مثال: "period"
update_monthsعدد صحيح nullمطلوب

الأشهر (months; null)

مثال: null

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

UpdatePolicy

UpdatePolicy · أُوقفت هذه العملية وتعيد 409 دون تغيير البيانات. اضبط الوصول لكل ملف رقمي على حدة من خلال اختيار المستلمين.
daysعدد صحيح nullاختياري

عدد الأيام (1–3650; mode=period; months=null)

عدد صحيح:minimum: 1maximum: 3650
مثال: 365
expected_versionعدد صحيحمطلوب

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

minimum: 1maximum: 9223372036854775807
مثال: 1
modeسلسلة نصيةمطلوب

الوصول إلى الملفات المستقبلية بعد الشراء: none / period / unlimited

القيود
enum
["none", "period", "unlimited"]
مثال: "period"
monthsعدد صحيح nullاختياري

الأشهر (1–120; mode=period; days=null)

عدد صحيح:minimum: 1maximum: 120
مثال: null

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

UploadCreate

UploadCreate · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها. بعد إنشاء upload_id أرسل الملفات بصيغة multipart/form-data ثم اربطها بالمنتج. يتطلب التنزيل رمز Bearer وصلاحية category؛ يحتوي الرد على بايتات الملف دون عنوان عام أو كلمة مرور. عند mode=period اختر days ‏(1–3650) أو months السابق، ولا تستخدمهما معًا. تُحفظ الشروط عند الشراء؛ ويُلغي الاسترداد الوصول إلى بند الطلب المسترد فقط.
filenameسلسلة نصيةمطلوب

الملف

minLength: 1maxLength: 255
مثال: "manual.pdf"
product_idسلسلة نصية nullاختياري

معرّف المنتج.

القيود · سلسلة نصية 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
مثال: "example"
sha256سلسلة نصيةمطلوب

SHA-256 (hex, 64)

القيود
pattern
"^[0-9a-f]{64}$"
مثال: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytesعدد صحيحمطلوب

الحجم بالبايت

minimum: 1maximum: 262144000
مثال: 46

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

UploadData

UploadData · حقول البيانات وأنواعها وقيودها التي تقبلها واجهة API أو تعيدها. بعد إنشاء upload_id أرسل الملفات بصيغة multipart/form-data ثم اربطها بالمنتج. يتطلب التنزيل رمز Bearer وصلاحية category؛ يحتوي الرد على بايتات الملف دون عنوان عام أو كلمة مرور. عند mode=period اختر days ‏(1–3650) أو months السابق، ولا تستخدمهما معًا. تُحفظ الشروط عند الشراء؛ ويُلغي الاسترداد الوصول إلى بند الطلب المسترد فقط.
categoryFileCategory مطلوب

فئة الملف: internal / customer_document / digital

مثال: "digital"
expires_atسلسلة نصيةمطلوب

تاريخ انتهاء صلاحية بيانات الاعتماد ووقته.

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

الملف

مثال: "manual.pdf"
idسلسلة نصيةمطلوب

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

format: "uuid"
مثال: "00000000-0000-4000-8000-000000000001"
product_idسلسلة نصية nullمطلوب

معرّف المنتج.

مثال: "example"
received_bytesعدد صحيحمطلوب

جارٍ الرفع… · الحجم بالبايت

مثال: 46
sha256سلسلة نصيةمطلوب

SHA-256 (hex, 64)

مثال: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytesعدد صحيحمطلوب

الحجم بالبايت

مثال: 46
statusسلسلة نصيةمطلوب

الحالة التي تقبلها هذه العملية تحديدًا.

مثال: "ready"

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