Схеми на данните · Отстъпки

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НизЗадължително

Идентификатор на пазара, върнат от endpoint за контекст.

Ограничения

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НизЗадължително

Идентификатор на пазара, върнат от endpoint за контекст.

Ограничения

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

Допълнителни полета: Не