مخططات البيانات · الخصومات

dataCampaignData مطلوب

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

مثال: {"created_at":"2026-10-07T10:00:00Z","created_by":{"kind":"admin","label":"Editorial integration","reference":"learn-api-key"},"enabled":false,"id":"example-campaign","kind":"coupon","markets":[{"currency":"PLN","market_id":"poland","minor_units":0}],"name":"Autumn guide offer","updated_at":"2026-10-07T10:00:00Z","used_count":0,"version":1}

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

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

مثال: {"locale":"example","market_code":"example","market_id":"poland","pagination":{"has_more":false,"limit":1,"next_cursor":null},"request_id":"learn-example-request"}

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

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

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

مثال: []

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

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

مثال: {"locale":"example","market_code":"example","market_id":"poland","pagination":{"has_more":false,"limit":1,"next_cursor":null},"request_id":"learn-example-request"}

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

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

العملاء

القيود

enum

["all", "guest", "customer", "selected"]

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

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

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

القيود

enum

["percentage", "fixed", "none"]

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

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

معرّفات الفئات المرتبطة.

maxItems: 1000

القيود · مصفوفة 1

pattern

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

codeسلسلة نصية | nullاختياري

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

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

pattern

"^[A-Za-z0-9]{6,16}$"

مثال: "LEARN10"

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

الدمج مع رموز أخرى

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

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

السماح بهذا الرمز للمنتجات المشمولة بعروض تلقائية

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

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

معلومات العميل المسجلة لهذا المورد.

maxItems: 1000

القيود · مصفوفة 1

pattern

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

ends_atسلسلة نصية | nullاختياري

نشط حتى

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

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

شحن مجاني

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

marketsمصفوفة <MarketData-Input > مطلوب

الأسواق المتاحة في سياق المتجر.

minItems: 1maxItems: 1000

مثال: [{"currency":"PLN","market_id":"poland","minor_units":2}]

minimum_quantityعدد صحيحاختياري

الحد الأدنى لعدد القطع في السلة

minimum: 1maximum: 2147483647

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

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

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

minLength: 1maxLength: 160

مثال: "Autumn guide offer"

per_customer_limitعدد صحيحاختياري

الحد الأقصى للاستخدامات لكل عميل

minimum: -1maximum: 2147483647

القيمة الافتراضية: -1

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

نسبة مئوية

maxLength: 19

القيود

pattern

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

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

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

معرّفات المنتجات المرتبطة.

maxItems: 1000

القيود · مصفوفة 1

pattern

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

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

المنتجات

القيود

enum

["all", "selected"]

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

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

في حساب العميل

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

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

في السلة

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

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

على صفحات المنتجات

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

starts_atسلسلة نصية | nullاختياري

نشط من

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

usage_limitعدد صحيحاختياري

الحد الأقصى للاستخدامات

minimum: -1maximum: 2147483647

القيمة الافتراضية: -1

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

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

العملاء

القيود

enum

["all", "guest", "customer", "selected"]

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

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

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

القيود

enum

["percentage", "fixed", "none"]

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

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

معرّفات الفئات المرتبطة.

maxItems: 1000

القيود · مصفوفة 1

pattern

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

codeسلسلة نصية | nullاختياري

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

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

pattern

"^[A-Za-z0-9]{6,16}$"

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

الدمج مع رموز أخرى

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

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

السماح بهذا الرمز للمنتجات المشمولة بعروض تلقائية

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

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

وقت الإنشاء.

format: "date-time"

مثال: "2026-10-07T10:00:00Z"

created_byCreatorData مطلوب

أنشأه

مثال: {"kind":"admin","label":"Editorial integration","reference":"learn-api-key"}

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

معلومات العميل المسجلة لهذا المورد.

maxItems: 1000

القيود · مصفوفة 1

pattern

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

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

ما إذا كان هذا الإعداد مفعّلًا.

مثال: false

ends_atسلسلة نصية | nullاختياري

نشط حتى

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

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

شحن مجاني

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

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

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

مثال: "example-campaign"

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

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

القيود

enum

["coupon", "promotion"]

مثال: "coupon"

marketsمصفوفة <shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData > مطلوب

الأسواق المتاحة في سياق المتجر.

minItems: 1maxItems: 1000

مثال: [{"currency":"PLN","market_id":"poland","minor_units":0}]

minimum_quantityعدد صحيحاختياري

الحد الأدنى لعدد القطع في السلة

minimum: 1maximum: 2147483647

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

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

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

minLength: 1maxLength: 160

مثال: "Autumn guide offer"

per_customer_limitعدد صحيحاختياري

الحد الأقصى للاستخدامات لكل عميل

minimum: -1maximum: 2147483647

القيمة الافتراضية: -1

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

نسبة مئوية

maxLength: 19

القيود

pattern

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

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

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

معرّفات المنتجات المرتبطة.

maxItems: 1000

القيود · مصفوفة 1

pattern

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

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

المنتجات

القيود

enum

["all", "selected"]

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

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

في حساب العميل

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

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

في السلة

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

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

على صفحات المنتجات

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

starts_atسلسلة نصية | nullاختياري

نشط من

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

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

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

format: "date-time"

مثال: "2026-10-07T10:00:00Z"

usage_limitعدد صحيحاختياري

الحد الأقصى للاستخدامات

minimum: -1maximum: 2147483647

القيمة الافتراضية: -1

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

عدد مرات الاستخدام

مثال: 0

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

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

مثال: 1

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

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

ما إذا كان هذا الإعداد مفعّلًا.

مثال: false

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

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

minimum: 1maximum: 9223372036854775807

مثال: 1

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

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

العملاء

القيود

enum

["all", "guest", "customer", "selected"]

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

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

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

القيود

enum

["percentage", "fixed", "none"]

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

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

معرّفات الفئات المرتبطة.

maxItems: 1000

القيود · مصفوفة 1

pattern

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

codeسلسلة نصية | nullاختياري

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

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

pattern

"^[A-Za-z0-9]{6,16}$"

مثال: "LEARN10"

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

الدمج مع رموز أخرى

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

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

السماح بهذا الرمز للمنتجات المشمولة بعروض تلقائية

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

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

معلومات العميل المسجلة لهذا المورد.

maxItems: 1000

القيود · مصفوفة 1

pattern

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

ends_atسلسلة نصية | nullاختياري

نشط حتى

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

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

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

minimum: 1maximum: 9223372036854775807

مثال: 1

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

شحن مجاني

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

marketsمصفوفة <MarketData-Input > مطلوب

الأسواق المتاحة في سياق المتجر.

minItems: 1maxItems: 1000

مثال: [{"currency":"PLN","market_id":"poland","minor_units":2}]

minimum_quantityعدد صحيحاختياري

الحد الأدنى لعدد القطع في السلة

minimum: 1maximum: 2147483647

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

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

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

minLength: 1maxLength: 160

مثال: "Autumn guide offer"

per_customer_limitعدد صحيحاختياري

الحد الأقصى للاستخدامات لكل عميل

minimum: -1maximum: 2147483647

القيمة الافتراضية: -1

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

نسبة مئوية

maxLength: 19

القيود

pattern

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

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

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

معرّفات المنتجات المرتبطة.

maxItems: 1000

القيود · مصفوفة 1

pattern

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

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

المنتجات

القيود

enum

["all", "selected"]

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

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

في حساب العميل

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

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

في السلة

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

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

على صفحات المنتجات

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

starts_atسلسلة نصية | nullاختياري

نشط من

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

usage_limitعدد صحيحاختياري

الحد الأقصى للاستخدامات

minimum: -1maximum: 2147483647

القيمة الافتراضية: -1

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

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

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

القيود

enum

["admin", "api"]

مثال: "admin"

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

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

مثال: "Editorial integration"

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

معرّف الكيان المشار إليه.

مثال: "learn-api-key"

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

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

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

القيود

pattern

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

مثال: "PLN"

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

مبلغ الخصم

maxLength: 19

القيود

pattern

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

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

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

معرّف السوق الذي تعيده نقطة نهاية السياق.

القيود

pattern

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

مثال: "poland"

maximum_priceسلسلة نصية | nullاختياري

الحد الأقصى لسعر المنتج

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

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

pattern

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

minimum_priceسلسلة نصية | nullاختياري

الحد الأدنى لسعر المنتج

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

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

pattern

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

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

الحد الأدنى لقيمة السلة

maxLength: 19

القيود

pattern

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

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

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

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

minimum: 0maximum: 4

مثال: 2

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

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

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

القيود

pattern

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

مثال: "PLN"

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

مبلغ الخصم

maxLength: 19

القيود

pattern

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

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

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

معرّف السوق الذي تعيده نقطة نهاية السياق.

القيود

pattern

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

مثال: "poland"

maximum_priceسلسلة نصية | nullاختياري

الحد الأقصى لسعر المنتج

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

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

pattern

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

minimum_priceسلسلة نصية | nullاختياري

الحد الأدنى لسعر المنتج

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

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

pattern

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

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

الحد الأدنى لقيمة السلة

maxLength: 19

القيود

pattern

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

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

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

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

minimum: 0maximum: 4

مثال: 0

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