Схеми даних · Знижки

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

Додаткові поля: Ні