Scheme de date · Reduceri

dataCampaignData Obligatoriu

Datele unui răspuns reușit.

Exemplu: {"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 Obligatoriu

Metadatele răspunsului.

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

Câmpuri suplimentare: Nu

dataTablou <CampaignData > Obligatoriu

Datele unui răspuns reușit.

Exemplu: []

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Obligatoriu

Metadatele răspunsului.

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

Câmpuri suplimentare: Nu

audienceȘir de caractereOpțional

Clienți

Restricții

enum

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

Valoare implicită: "all"

benefit_typeȘir de caractereOpțional

Varianta structurii de date, descrisă prin valorile permise.

Restricții

enum

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

Valoare implicită: "percentage"

category_idsTablou <Șir de caractere> Opțional

Identificatorii categoriilor asociate.

maxItems: 1000

Restricții · Tablou 1

pattern

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

codeȘir de caractere | nullOpțional

Cod stabil, destinat prelucrării automate.

Restricții · Șir de caractere 1

pattern

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

Exemplu: "LEARN10"

combine_couponsValoare booleanăOpțional

Combină cu alte coduri

Valoare implicită: false

combine_promotionsValoare booleanăOpțional

Permite acest cod pentru produsele cu promoții automate

Valoare implicită: false

customer_idsTablou <Șir de caractere> Opțional

Datele clientului înregistrate pentru această resursă.

maxItems: 1000

Restricții · Tablou 1

pattern

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

ends_atȘir de caractere | nullOpțional

Activ până la

Șir de caractere:format: "date-time"

free_shippingValoare booleanăOpțional

Livrare gratuită

Valoare implicită: false

marketsTablou <MarketData-Input > Obligatoriu

Piețele disponibile în contextul magazinului.

minItems: 1maxItems: 1000

Exemplu: [{"currency":"PLN","market_id":"poland","minor_units":2}]

minimum_quantityNumăr întregOpțional

Numărul minim de articole din coș

minimum: 1maximum: 2147483647

Valoare implicită: 1

nameȘir de caractereObligatoriu

Numele resursei în contextul relevant.

minLength: 1maxLength: 160

Exemplu: "Autumn guide offer"

per_customer_limitNumăr întregOpțional

Limită de utilizări per client

minimum: -1maximum: 2147483647

Valoare implicită: -1

percentageȘir de caractereOpțional

Procent

maxLength: 19

Restricții

pattern

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

Valoare implicită: "10"

product_idsTablou <Șir de caractere> Opțional

Identificatorii produselor asociate.

maxItems: 1000

Restricții · Tablou 1

pattern

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

product_scopeȘir de caractereOpțional

Produse

Restricții

enum

["all", "selected"]

Valoare implicită: "all"

show_accountValoare booleanăOpțional

În contul clientului

Valoare implicită: false

show_cartValoare booleanăOpțional

În coș

Valoare implicită: false

show_productValoare booleanăOpțional

Pe paginile produselor

Valoare implicită: false

starts_atȘir de caractere | nullOpțional

Activ de la

Șir de caractere:format: "date-time"

usage_limitNumăr întregOpțional

Limită de utilizări

minimum: -1maximum: 2147483647

Valoare implicită: -1

Câmpuri suplimentare: Nu

audienceȘir de caractereOpțional

Clienți

Restricții

enum

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

Valoare implicită: "all"

benefit_typeȘir de caractereOpțional

Varianta structurii de date, descrisă prin valorile permise.

Restricții

enum

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

Valoare implicită: "percentage"

category_idsTablou <Șir de caractere> Opțional

Identificatorii categoriilor asociate.

maxItems: 1000

Restricții · Tablou 1

pattern

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

codeȘir de caractere | nullOpțional

Cod stabil, destinat prelucrării automate.

Restricții · Șir de caractere 1

pattern

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

combine_couponsValoare booleanăOpțional

Combină cu alte coduri

Valoare implicită: false

combine_promotionsValoare booleanăOpțional

Permite acest cod pentru produsele cu promoții automate

Valoare implicită: false

created_atȘir de caractereObligatoriu

Momentul creării.

format: "date-time"

Exemplu: "2026-10-07T10:00:00Z"

created_byCreatorData Obligatoriu

Creat de

Exemplu: {"kind":"admin","label":"Editorial integration","reference":"learn-api-key"}

customer_idsTablou <Șir de caractere> Opțional

Datele clientului înregistrate pentru această resursă.

maxItems: 1000

Restricții · Tablou 1

pattern

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

enabledValoare booleanăObligatoriu

Indică dacă această setare este activată.

Exemplu: false

ends_atȘir de caractere | nullOpțional

Activ până la

Șir de caractere:format: "date-time"

free_shippingValoare booleanăOpțional

Livrare gratuită

Valoare implicită: false

idȘir de caractereObligatoriu

Identificatorul resursei; păstrați-l în forma returnată.

Exemplu: "example-campaign"

kindȘir de caractereObligatoriu

Varianta structurii de date, descrisă prin valorile permise.

Restricții

enum

["coupon", "promotion"]

Exemplu: "coupon"

marketsTablou <shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData > Obligatoriu

Piețele disponibile în contextul magazinului.

minItems: 1maxItems: 1000

Exemplu: [{"currency":"PLN","market_id":"poland","minor_units":0}]

minimum_quantityNumăr întregOpțional

Numărul minim de articole din coș

minimum: 1maximum: 2147483647

Valoare implicită: 1

nameȘir de caractereObligatoriu

Numele resursei în contextul relevant.

minLength: 1maxLength: 160

Exemplu: "Autumn guide offer"

per_customer_limitNumăr întregOpțional

Limită de utilizări per client

minimum: -1maximum: 2147483647

Valoare implicită: -1

percentageȘir de caractereOpțional

Procent

maxLength: 19

Restricții

pattern

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

Valoare implicită: "10"

product_idsTablou <Șir de caractere> Opțional

Identificatorii produselor asociate.

maxItems: 1000

Restricții · Tablou 1

pattern

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

product_scopeȘir de caractereOpțional

Produse

Restricții

enum

["all", "selected"]

Valoare implicită: "all"

show_accountValoare booleanăOpțional

În contul clientului

Valoare implicită: false

show_cartValoare booleanăOpțional

În coș

Valoare implicită: false

show_productValoare booleanăOpțional

Pe paginile produselor

Valoare implicită: false

starts_atȘir de caractere | nullOpțional

Activ de la

Șir de caractere:format: "date-time"

updated_atȘir de caractereObligatoriu

Momentul celei mai recente actualizări.

format: "date-time"

Exemplu: "2026-10-07T10:00:00Z"

usage_limitNumăr întregOpțional

Limită de utilizări

minimum: -1maximum: 2147483647

Valoare implicită: -1

used_countNumăr întregObligatoriu

Utilizări efectuate

Exemplu: 0

versionNumăr întregObligatoriu

Versiunea resursei folosită pentru controlul concurenței.

Exemplu: 1

Câmpuri suplimentare: Nu

enabledValoare booleanăObligatoriu

Indică dacă această setare este activată.

Exemplu: false

expected_versionNumăr întregObligatoriu

Versiunea citită înainte de scriere; o neconcordanță respinge actualizarea.

minimum: 1maximum: 9223372036854775807

Exemplu: 1

Câmpuri suplimentare: Nu

audienceȘir de caractereOpțional

Clienți

Restricții

enum

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

Valoare implicită: "all"

benefit_typeȘir de caractereOpțional

Varianta structurii de date, descrisă prin valorile permise.

Restricții

enum

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

Valoare implicită: "percentage"

category_idsTablou <Șir de caractere> Opțional

Identificatorii categoriilor asociate.

maxItems: 1000

Restricții · Tablou 1

pattern

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

codeȘir de caractere | nullOpțional

Cod stabil, destinat prelucrării automate.

Restricții · Șir de caractere 1

pattern

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

Exemplu: "LEARN10"

combine_couponsValoare booleanăOpțional

Combină cu alte coduri

Valoare implicită: false

combine_promotionsValoare booleanăOpțional

Permite acest cod pentru produsele cu promoții automate

Valoare implicită: false

customer_idsTablou <Șir de caractere> Opțional

Datele clientului înregistrate pentru această resursă.

maxItems: 1000

Restricții · Tablou 1

pattern

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

ends_atȘir de caractere | nullOpțional

Activ până la

Șir de caractere:format: "date-time"

expected_versionNumăr întregObligatoriu

Versiunea citită înainte de scriere; o neconcordanță respinge actualizarea.

minimum: 1maximum: 9223372036854775807

Exemplu: 1

free_shippingValoare booleanăOpțional

Livrare gratuită

Valoare implicită: false

marketsTablou <MarketData-Input > Obligatoriu

Piețele disponibile în contextul magazinului.

minItems: 1maxItems: 1000

Exemplu: [{"currency":"PLN","market_id":"poland","minor_units":2}]

minimum_quantityNumăr întregOpțional

Numărul minim de articole din coș

minimum: 1maximum: 2147483647

Valoare implicită: 1

nameȘir de caractereObligatoriu

Numele resursei în contextul relevant.

minLength: 1maxLength: 160

Exemplu: "Autumn guide offer"

per_customer_limitNumăr întregOpțional

Limită de utilizări per client

minimum: -1maximum: 2147483647

Valoare implicită: -1

percentageȘir de caractereOpțional

Procent

maxLength: 19

Restricții

pattern

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

Valoare implicită: "10"

product_idsTablou <Șir de caractere> Opțional

Identificatorii produselor asociate.

maxItems: 1000

Restricții · Tablou 1

pattern

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

product_scopeȘir de caractereOpțional

Produse

Restricții

enum

["all", "selected"]

Valoare implicită: "all"

show_accountValoare booleanăOpțional

În contul clientului

Valoare implicită: false

show_cartValoare booleanăOpțional

În coș

Valoare implicită: false

show_productValoare booleanăOpțional

Pe paginile produselor

Valoare implicită: false

starts_atȘir de caractere | nullOpțional

Activ de la

Șir de caractere:format: "date-time"

usage_limitNumăr întregOpțional

Limită de utilizări

minimum: -1maximum: 2147483647

Valoare implicită: -1

Câmpuri suplimentare: Nu

kindȘir de caractereObligatoriu

Varianta structurii de date, descrisă prin valorile permise.

Restricții

enum

["admin", "api"]

Exemplu: "admin"

labelȘir de caractereObligatoriu

Numele resursei în contextul relevant.

Exemplu: "Editorial integration"

referenceȘir de caractereObligatoriu

Identificatorul entității referite.

Exemplu: "learn-api-key"

Câmpuri suplimentare: Nu

currencyȘir de caractereObligatoriu

Codul monedei în care este exprimată suma.

Restricții

pattern

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

Exemplu: "PLN"

fixed_amountȘir de caractereOpțional

Valoarea reducerii

maxLength: 19

Restricții

pattern

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

Valoare implicită: "0"

market_idȘir de caractereObligatoriu

Identificatorul pieței returnat de endpointul de context.

Restricții

pattern

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

Exemplu: "poland"

maximum_priceȘir de caractere | nullOpțional

Prețul maxim al produsului

Șir de caractere:maxLength: 19

Restricții · Șir de caractere 1

pattern

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

minimum_priceȘir de caractere | nullOpțional

Prețul minim al produsului

Șir de caractere:maxLength: 19

Restricții · Șir de caractere 1

pattern

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

minimum_subtotalȘir de caractereOpțional

Valoarea minimă a coșului

maxLength: 19

Restricții

pattern

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

Valoare implicită: "0"

minor_unitsNumăr întregObligatoriu

Numărul de zecimale folosite de monedă.

minimum: 0maximum: 4

Exemplu: 2

Câmpuri suplimentare: Nu

currencyȘir de caractereObligatoriu

Codul monedei în care este exprimată suma.

Restricții

pattern

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

Exemplu: "PLN"

fixed_amountȘir de caractereOpțional

Valoarea reducerii

maxLength: 19

Restricții

pattern

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

Valoare implicită: "0"

market_idȘir de caractereObligatoriu

Identificatorul pieței returnat de endpointul de context.

Restricții

pattern

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

Exemplu: "poland"

maximum_priceȘir de caractere | nullOpțional

Prețul maxim al produsului

Șir de caractere:maxLength: 19

Restricții · Șir de caractere 1

pattern

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

minimum_priceȘir de caractere | nullOpțional

Prețul minim al produsului

Șir de caractere:maxLength: 19

Restricții · Șir de caractere 1

pattern

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

minimum_subtotalȘir de caractereOpțional

Valoarea minimă a coșului

maxLength: 19

Restricții

pattern

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

Valoare implicită: "0"

minor_unitsNumăr întregObligatoriu

Numărul de zecimale folosite de monedă.

minimum: 0maximum: 4

Exemplu: 0

Câmpuri suplimentare: Nu