Sheme podataka · Popusti

Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.

Sheme podataka

ApiResponse[CampaignData]

ApiResponse_CampaignData_ · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.

dataCampaignData Obvezno: Podaci uspješnog odgovora.

Primjer: {"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 Obvezno: Metapodaci odgovora.

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

Dodatna polja: Ne

ApiResponse[list[CampaignData]]

ApiResponse_list_CampaignData__ · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.

dataPolje vrijednosti <CampaignData > Obvezno: Podaci uspješnog odgovora.

Primjer: []
metaContextPageMeta ContextMeta PageMeta RequestMeta Obvezno: Metapodaci odgovora.

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

Dodatna polja: Ne

CampaignCreate

CampaignCreate · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.

audienceNiz znakovaNeobavezno

Kupci

Ograničenja

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

Zadano: "all"

benefit_typeNiz znakovaNeobavezno

Varijanta strukture podataka opisana dopuštenim vrijednostima.

Ograničenja

enum: ["percentage", "fixed", "none"]

Zadano: "percentage"

category_idsPolje vrijednosti <Niz znakova> Neobavezno

Identifikatori povezanih kategorija.

maxItems: 1000

Ograničenja · Polje vrijednosti 1

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

codeNiz znakova nullNeobavezno

Stabilan strojno čitljiv kod.

Ograničenja · Niz znakova 1

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

Primjer: "LEARN10"

combine_couponsLogička vrijednostNeobavezno

Kombiniraj s drugim kodovima

Zadano: false

combine_promotionsLogička vrijednostNeobavezno

Dopusti ovaj kod za proizvode s automatskim promocijama

Zadano: false

customer_idsPolje vrijednosti <Niz znakova> Neobavezno

Podaci kupca zabilježeni za ovaj resurs.

maxItems: 1000

Ograničenja · Polje vrijednosti 1

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

ends_atNiz znakova nullNeobavezno

Aktivno do

Niz znakova:format: "date-time"

free_shippingLogička vrijednostNeobavezno

Besplatna dostava

Zadano: false

marketsPolje vrijednosti <MarketData-Input > Obvezno

Tržišta dostupna u kontekstu trgovine.

minItems: 1maxItems: 1000

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

minimum_quantityCijeli brojNeobavezno

Minimalni broj artikala u košarici

minimum: 1maximum: 2147483647

Zadano: 1

nameNiz znakovaObvezno

Naziv resursa u odgovarajućem kontekstu.

minLength: 1maxLength: 160

Primjer: "Autumn guide offer"

per_customer_limitCijeli brojNeobavezno

Ograničenje upotreba po kupcu

minimum: -1maximum: 2147483647

Zadano: -1

percentageNiz znakovaNeobavezno

Postotak

maxLength: 19

Ograničenja

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

Zadano: "10"

product_idsPolje vrijednosti <Niz znakova> Neobavezno

Identifikatori povezanih proizvoda.

maxItems: 1000

Ograničenja · Polje vrijednosti 1

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

product_scopeNiz znakovaNeobavezno

Proizvodi

Ograničenja

enum: ["all", "selected"]

Zadano: "all"

show_accountLogička vrijednostNeobavezno

Na računu kupca

Zadano: false

show_cartLogička vrijednostNeobavezno

U košarici

Zadano: false

show_productLogička vrijednostNeobavezno

Na stranicama proizvoda

Zadano: false

starts_atNiz znakova nullNeobavezno

Aktivno od

Niz znakova:format: "date-time"

usage_limitCijeli brojNeobavezno

Ograničenje upotreba

minimum: -1maximum: 2147483647

Zadano: -1

Dodatna polja: Ne

CampaignData

CampaignData · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.

audienceNiz znakovaNeobavezno

Kupci

Ograničenja

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

Zadano: "all"

benefit_typeNiz znakovaNeobavezno

Varijanta strukture podataka opisana dopuštenim vrijednostima.

Ograničenja

enum: ["percentage", "fixed", "none"]

Zadano: "percentage"

category_idsPolje vrijednosti <Niz znakova> Neobavezno

Identifikatori povezanih kategorija.

maxItems: 1000

Ograničenja · Polje vrijednosti 1

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

codeNiz znakova nullNeobavezno

Stabilan strojno čitljiv kod.

Ograničenja · Niz znakova 1

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

combine_couponsLogička vrijednostNeobavezno

Kombiniraj s drugim kodovima

Zadano: false

combine_promotionsLogička vrijednostNeobavezno

Dopusti ovaj kod za proizvode s automatskim promocijama

Zadano: false

created_atNiz znakovaObvezno

Vrijeme izrade.

format: "date-time"

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

created_byCreatorData Obvezno

Izradio

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

customer_idsPolje vrijednosti <Niz znakova> Neobavezno

Podaci kupca zabilježeni za ovaj resurs.

maxItems: 1000

Ograničenja · Polje vrijednosti 1

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

enabledLogička vrijednostObvezno

Je li ova postavka uključena.

Primjer: false

ends_atNiz znakova nullNeobavezno

Aktivno do

Niz znakova:format: "date-time"

free_shippingLogička vrijednostNeobavezno

Besplatna dostava

Zadano: false

idNiz znakovaObvezno

Identifikator resursa; sačuvajte ga u vraćenom obliku.

Primjer: "example-campaign"

kindNiz znakovaObvezno

Varijanta strukture podataka opisana dopuštenim vrijednostima.

Ograničenja

enum: ["coupon", "promotion"]

Primjer: "coupon"

marketsPolje vrijednosti <shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData > Obvezno

Tržišta dostupna u kontekstu trgovine.

minItems: 1maxItems: 1000

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

minimum_quantityCijeli brojNeobavezno

Minimalni broj artikala u košarici

minimum: 1maximum: 2147483647

Zadano: 1

nameNiz znakovaObvezno

Naziv resursa u odgovarajućem kontekstu.

minLength: 1maxLength: 160

Primjer: "Autumn guide offer"

per_customer_limitCijeli brojNeobavezno

Ograničenje upotreba po kupcu

minimum: -1maximum: 2147483647

Zadano: -1

percentageNiz znakovaNeobavezno

Postotak

maxLength: 19

Ograničenja

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

Zadano: "10"

product_idsPolje vrijednosti <Niz znakova> Neobavezno

Identifikatori povezanih proizvoda.

maxItems: 1000

Ograničenja · Polje vrijednosti 1

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

product_scopeNiz znakovaNeobavezno

Proizvodi

Ograničenja

enum: ["all", "selected"]

Zadano: "all"

show_accountLogička vrijednostNeobavezno

Na računu kupca

Zadano: false

show_cartLogička vrijednostNeobavezno

U košarici

Zadano: false

show_productLogička vrijednostNeobavezno

Na stranicama proizvoda

Zadano: false

starts_atNiz znakova nullNeobavezno

Aktivno od

Niz znakova:format: "date-time"

updated_atNiz znakovaObvezno

Vrijeme posljednjeg ažuriranja.

format: "date-time"

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

usage_limitCijeli brojNeobavezno

Ograničenje upotreba

minimum: -1maximum: 2147483647

Zadano: -1

used_countCijeli brojObvezno

Broj upotreba

Primjer: 0

versionCijeli brojObvezno

Verzija resursa za kontrolu istodobnih upisa.

Primjer: 1

Dodatna polja: Ne

CampaignStatus

CampaignStatus · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.

enabledLogička vrijednostObvezno: Je li ova postavka uključena.

Primjer: false
expected_versionCijeli brojObvezno: Verzija pročitana prije upisa; nepodudaranje odbija ažuriranje.

minimum: 1maximum: 9223372036854775807

Primjer: 1

Dodatna polja: Ne

CampaignUpdate

CampaignUpdate · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.

audienceNiz znakovaNeobavezno

Kupci

Ograničenja

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

Zadano: "all"

benefit_typeNiz znakovaNeobavezno

Varijanta strukture podataka opisana dopuštenim vrijednostima.

Ograničenja

enum: ["percentage", "fixed", "none"]

Zadano: "percentage"

category_idsPolje vrijednosti <Niz znakova> Neobavezno

Identifikatori povezanih kategorija.

maxItems: 1000

Ograničenja · Polje vrijednosti 1

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

codeNiz znakova nullNeobavezno

Stabilan strojno čitljiv kod.

Ograničenja · Niz znakova 1

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

Primjer: "LEARN10"

combine_couponsLogička vrijednostNeobavezno

Kombiniraj s drugim kodovima

Zadano: false

combine_promotionsLogička vrijednostNeobavezno

Dopusti ovaj kod za proizvode s automatskim promocijama

Zadano: false

customer_idsPolje vrijednosti <Niz znakova> Neobavezno

Podaci kupca zabilježeni za ovaj resurs.

maxItems: 1000

Ograničenja · Polje vrijednosti 1

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

ends_atNiz znakova nullNeobavezno

Aktivno do

Niz znakova:format: "date-time"

expected_versionCijeli brojObvezno

Verzija pročitana prije upisa; nepodudaranje odbija ažuriranje.

minimum: 1maximum: 9223372036854775807

Primjer: 1

free_shippingLogička vrijednostNeobavezno

Besplatna dostava

Zadano: false

marketsPolje vrijednosti <MarketData-Input > Obvezno

Tržišta dostupna u kontekstu trgovine.

minItems: 1maxItems: 1000

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

minimum_quantityCijeli brojNeobavezno

Minimalni broj artikala u košarici

minimum: 1maximum: 2147483647

Zadano: 1

nameNiz znakovaObvezno

Naziv resursa u odgovarajućem kontekstu.

minLength: 1maxLength: 160

Primjer: "Autumn guide offer"

per_customer_limitCijeli brojNeobavezno

Ograničenje upotreba po kupcu

minimum: -1maximum: 2147483647

Zadano: -1

percentageNiz znakovaNeobavezno

Postotak

maxLength: 19

Ograničenja

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

Zadano: "10"

product_idsPolje vrijednosti <Niz znakova> Neobavezno

Identifikatori povezanih proizvoda.

maxItems: 1000

Ograničenja · Polje vrijednosti 1

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

product_scopeNiz znakovaNeobavezno

Proizvodi

Ograničenja

enum: ["all", "selected"]

Zadano: "all"

show_accountLogička vrijednostNeobavezno

Na računu kupca

Zadano: false

show_cartLogička vrijednostNeobavezno

U košarici

Zadano: false

show_productLogička vrijednostNeobavezno

Na stranicama proizvoda

Zadano: false

starts_atNiz znakova nullNeobavezno

Aktivno od

Niz znakova:format: "date-time"

usage_limitCijeli brojNeobavezno

Ograničenje upotreba

minimum: -1maximum: 2147483647

Zadano: -1

Dodatna polja: Ne

CreatorData

CreatorData · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.

kindNiz znakovaObvezno

Varijanta strukture podataka opisana dopuštenim vrijednostima.

Ograničenja

enum: ["admin", "api"]

Primjer: "admin"

labelNiz znakovaObvezno

Naziv resursa u odgovarajućem kontekstu.

Primjer: "Editorial integration"

referenceNiz znakovaObvezno

Identifikator entiteta na koji se upućuje.

Primjer: "learn-api-key"

Dodatna polja: Ne

MarketData

MarketData-Input · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.

currencyNiz znakovaObvezno

Kod valute iznosa.

Ograničenja

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

Primjer: "PLN"

fixed_amountNiz znakovaNeobavezno

Iznos popusta

maxLength: 19

Ograničenja

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

Zadano: "0"

market_idNiz znakovaObvezno

Identifikator tržišta vraćen s krajnje točke konteksta.

Ograničenja

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

Primjer: "poland"

maximum_priceNiz znakova nullNeobavezno

Maksimalna cijena proizvoda

Niz znakova:maxLength: 19

Ograničenja · Niz znakova 1

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

minimum_priceNiz znakova nullNeobavezno

Minimalna cijena proizvoda

Niz znakova:maxLength: 19

Ograničenja · Niz znakova 1

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

minimum_subtotalNiz znakovaNeobavezno

Minimalna vrijednost košarice

maxLength: 19

Ograničenja

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

Zadano: "0"

minor_unitsCijeli brojObvezno

Broj decimalnih znamenki valute.

minimum: 0maximum: 4

Primjer: 2

Dodatna polja: Ne

MarketData

shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.

currencyNiz znakovaObvezno

Kod valute iznosa.

Ograničenja

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

Primjer: "PLN"

fixed_amountNiz znakovaNeobavezno

Iznos popusta

maxLength: 19

Ograničenja

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

Zadano: "0"

market_idNiz znakovaObvezno

Identifikator tržišta vraćen s krajnje točke konteksta.

Ograničenja

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

Primjer: "poland"

maximum_priceNiz znakova nullNeobavezno

Maksimalna cijena proizvoda

Niz znakova:maxLength: 19

Ograničenja · Niz znakova 1

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

minimum_priceNiz znakova nullNeobavezno

Minimalna cijena proizvoda

Niz znakova:maxLength: 19

Ograničenja · Niz znakova 1

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

minimum_subtotalNiz znakovaNeobavezno

Minimalna vrijednost košarice

maxLength: 19

Ograničenja

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

Zadano: "0"

minor_unitsCijeli brojObvezno

Broj decimalnih znamenki valute.

minimum: 0maximum: 4

Primjer: 0

Dodatna polja: Ne