Šeme podataka · Popusti

Polja, tipovi i ograničenja podataka koje API prihvata ili vraća.

Šeme podataka

ApiResponse[CampaignData]

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

dataCampaignData Obavezno: Podaci uspešnog odgovora.

Primer: {"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 Obavezno: Metapodaci odgovora.

Primer: {"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, tipovi i ograničenja podataka koje API prihvata ili vraća.

dataNiz vrednosti <CampaignData > Obavezno: Podaci uspešnog odgovora.

Primer: []
metaContextPageMeta ContextMeta PageMeta RequestMeta Obavezno: Metapodaci odgovora.

Primer: {"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, tipovi i ograničenja podataka koje API prihvata ili vraća.

audienceNiz znakovaOpciono

Kupci

Ograničenja

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

Podrazumevano: "all"

benefit_typeNiz znakovaOpciono

Varijanta strukture podataka opisana dozvoljenim vrednostima.

Ograničenja

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

Podrazumevano: "percentage"

category_idsNiz vrednosti <Niz znakova> Opciono

Identifikatori povezanih kategorija.

maxItems: 1000

Ograničenja · Niz vrednosti 1

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

codeNiz znakova nullOpciono

Stabilan mašinski čitljiv kod.

Ograničenja · Niz znakova 1

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

Primer: "LEARN10"

combine_couponsLogička vrednostOpciono

Kombinuj sa drugim kodovima

Podrazumevano: false

combine_promotionsLogička vrednostOpciono

Dozvoli ovaj kod za proizvode sa automatskim promocijama

Podrazumevano: false

customer_idsNiz vrednosti <Niz znakova> Opciono

Podaci kupca zabeleženi za ovaj resurs.

maxItems: 1000

Ograničenja · Niz vrednosti 1

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

ends_atNiz znakova nullOpciono

Aktivno do

Niz znakova:format: "date-time"

free_shippingLogička vrednostOpciono

Besplatna dostava

Podrazumevano: false

marketsNiz vrednosti <MarketData-Input > Obavezno

Tržišta dostupna u kontekstu prodavnice.

minItems: 1maxItems: 1000

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

minimum_quantityCeli brojOpciono

Minimalni broj artikala u korpi

minimum: 1maximum: 2147483647

Podrazumevano: 1

nameNiz znakovaObavezno

Naziv resursa u odgovarajućem kontekstu.

minLength: 1maxLength: 160

Primer: "Autumn guide offer"

per_customer_limitCeli brojOpciono

Ograničenje korišćenja po kupcu

minimum: -1maximum: 2147483647

Podrazumevano: -1

percentageNiz znakovaOpciono

Procenat

maxLength: 19

Ograničenja

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

Podrazumevano: "10"

product_idsNiz vrednosti <Niz znakova> Opciono

Identifikatori povezanih proizvoda.

maxItems: 1000

Ograničenja · Niz vrednosti 1

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

product_scopeNiz znakovaOpciono

Proizvodi

Ograničenja

enum: ["all", "selected"]

Podrazumevano: "all"

show_accountLogička vrednostOpciono

Na nalogu kupca

Podrazumevano: false

show_cartLogička vrednostOpciono

U korpi

Podrazumevano: false

show_productLogička vrednostOpciono

Na stranicama proizvoda

Podrazumevano: false

starts_atNiz znakova nullOpciono

Aktivno od

Niz znakova:format: "date-time"

usage_limitCeli brojOpciono

Ograničenje korišćenja

minimum: -1maximum: 2147483647

Podrazumevano: -1

Dodatna polja: Ne

CampaignData

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

audienceNiz znakovaOpciono

Kupci

Ograničenja

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

Podrazumevano: "all"

benefit_typeNiz znakovaOpciono

Varijanta strukture podataka opisana dozvoljenim vrednostima.

Ograničenja

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

Podrazumevano: "percentage"

category_idsNiz vrednosti <Niz znakova> Opciono

Identifikatori povezanih kategorija.

maxItems: 1000

Ograničenja · Niz vrednosti 1

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

codeNiz znakova nullOpciono

Stabilan mašinski čitljiv kod.

Ograničenja · Niz znakova 1

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

combine_couponsLogička vrednostOpciono

Kombinuj sa drugim kodovima

Podrazumevano: false

combine_promotionsLogička vrednostOpciono

Dozvoli ovaj kod za proizvode sa automatskim promocijama

Podrazumevano: false

created_atNiz znakovaObavezno

Vreme kreiranja.

format: "date-time"

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

created_byCreatorData Obavezno

Kreirao

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

customer_idsNiz vrednosti <Niz znakova> Opciono

Podaci kupca zabeleženi za ovaj resurs.

maxItems: 1000

Ograničenja · Niz vrednosti 1

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

enabledLogička vrednostObavezno

Da li je ova postavka uključena.

Primer: false

ends_atNiz znakova nullOpciono

Aktivno do

Niz znakova:format: "date-time"

free_shippingLogička vrednostOpciono

Besplatna dostava

Podrazumevano: false

idNiz znakovaObavezno

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

Primer: "example-campaign"

kindNiz znakovaObavezno

Varijanta strukture podataka opisana dozvoljenim vrednostima.

Ograničenja

enum: ["coupon", "promotion"]

Primer: "coupon"

marketsNiz vrednosti <shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData > Obavezno

Tržišta dostupna u kontekstu prodavnice.

minItems: 1maxItems: 1000

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

minimum_quantityCeli brojOpciono

Minimalni broj artikala u korpi

minimum: 1maximum: 2147483647

Podrazumevano: 1

nameNiz znakovaObavezno

Naziv resursa u odgovarajućem kontekstu.

minLength: 1maxLength: 160

Primer: "Autumn guide offer"

per_customer_limitCeli brojOpciono

Ograničenje korišćenja po kupcu

minimum: -1maximum: 2147483647

Podrazumevano: -1

percentageNiz znakovaOpciono

Procenat

maxLength: 19

Ograničenja

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

Podrazumevano: "10"

product_idsNiz vrednosti <Niz znakova> Opciono

Identifikatori povezanih proizvoda.

maxItems: 1000

Ograničenja · Niz vrednosti 1

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

product_scopeNiz znakovaOpciono

Proizvodi

Ograničenja

enum: ["all", "selected"]

Podrazumevano: "all"

show_accountLogička vrednostOpciono

Na nalogu kupca

Podrazumevano: false

show_cartLogička vrednostOpciono

U korpi

Podrazumevano: false

show_productLogička vrednostOpciono

Na stranicama proizvoda

Podrazumevano: false

starts_atNiz znakova nullOpciono

Aktivno od

Niz znakova:format: "date-time"

updated_atNiz znakovaObavezno

Vreme poslednjeg ažuriranja.

format: "date-time"

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

usage_limitCeli brojOpciono

Ograničenje korišćenja

minimum: -1maximum: 2147483647

Podrazumevano: -1

used_countCeli brojObavezno

Broj korišćenja

Primer: 0

versionCeli brojObavezno

Verzija resursa za kontrolu istovremenih upisa.

Primer: 1

Dodatna polja: Ne

CampaignStatus

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

enabledLogička vrednostObavezno: Da li je ova postavka uključena.

Primer: false
expected_versionCeli brojObavezno: Verzija pročitana pre upisa; nepodudaranje odbija ažuriranje.

minimum: 1maximum: 9223372036854775807

Primer: 1

Dodatna polja: Ne

CampaignUpdate

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

audienceNiz znakovaOpciono

Kupci

Ograničenja

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

Podrazumevano: "all"

benefit_typeNiz znakovaOpciono

Varijanta strukture podataka opisana dozvoljenim vrednostima.

Ograničenja

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

Podrazumevano: "percentage"

category_idsNiz vrednosti <Niz znakova> Opciono

Identifikatori povezanih kategorija.

maxItems: 1000

Ograničenja · Niz vrednosti 1

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

codeNiz znakova nullOpciono

Stabilan mašinski čitljiv kod.

Ograničenja · Niz znakova 1

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

Primer: "LEARN10"

combine_couponsLogička vrednostOpciono

Kombinuj sa drugim kodovima

Podrazumevano: false

combine_promotionsLogička vrednostOpciono

Dozvoli ovaj kod za proizvode sa automatskim promocijama

Podrazumevano: false

customer_idsNiz vrednosti <Niz znakova> Opciono

Podaci kupca zabeleženi za ovaj resurs.

maxItems: 1000

Ograničenja · Niz vrednosti 1

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

ends_atNiz znakova nullOpciono

Aktivno do

Niz znakova:format: "date-time"

expected_versionCeli brojObavezno

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

minimum: 1maximum: 9223372036854775807

Primer: 1

free_shippingLogička vrednostOpciono

Besplatna dostava

Podrazumevano: false

marketsNiz vrednosti <MarketData-Input > Obavezno

Tržišta dostupna u kontekstu prodavnice.

minItems: 1maxItems: 1000

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

minimum_quantityCeli brojOpciono

Minimalni broj artikala u korpi

minimum: 1maximum: 2147483647

Podrazumevano: 1

nameNiz znakovaObavezno

Naziv resursa u odgovarajućem kontekstu.

minLength: 1maxLength: 160

Primer: "Autumn guide offer"

per_customer_limitCeli brojOpciono

Ograničenje korišćenja po kupcu

minimum: -1maximum: 2147483647

Podrazumevano: -1

percentageNiz znakovaOpciono

Procenat

maxLength: 19

Ograničenja

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

Podrazumevano: "10"

product_idsNiz vrednosti <Niz znakova> Opciono

Identifikatori povezanih proizvoda.

maxItems: 1000

Ograničenja · Niz vrednosti 1

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

product_scopeNiz znakovaOpciono

Proizvodi

Ograničenja

enum: ["all", "selected"]

Podrazumevano: "all"

show_accountLogička vrednostOpciono

Na nalogu kupca

Podrazumevano: false

show_cartLogička vrednostOpciono

U korpi

Podrazumevano: false

show_productLogička vrednostOpciono

Na stranicama proizvoda

Podrazumevano: false

starts_atNiz znakova nullOpciono

Aktivno od

Niz znakova:format: "date-time"

usage_limitCeli brojOpciono

Ograničenje korišćenja

minimum: -1maximum: 2147483647

Podrazumevano: -1

Dodatna polja: Ne

CreatorData

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

kindNiz znakovaObavezno

Varijanta strukture podataka opisana dozvoljenim vrednostima.

Ograničenja

enum: ["admin", "api"]

Primer: "admin"

labelNiz znakovaObavezno

Naziv resursa u odgovarajućem kontekstu.

Primer: "Editorial integration"

referenceNiz znakovaObavezno

Identifikator entiteta na koji se upućuje.

Primer: "learn-api-key"

Dodatna polja: Ne

MarketData

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

currencyNiz znakovaObavezno

Kod valute iznosa.

Ograničenja

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

Primer: "PLN"

fixed_amountNiz znakovaOpciono

Iznos popusta

maxLength: 19

Ograničenja

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

Podrazumevano: "0"

market_idNiz znakovaObavezno

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

Ograničenja

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

Primer: "poland"

maximum_priceNiz znakova nullOpciono

Maksimalna cena 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 nullOpciono

Minimalna cena proizvoda

Niz znakova:maxLength: 19

Ograničenja · Niz znakova 1

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

minimum_subtotalNiz znakovaOpciono

Minimalna vrednost korpe

maxLength: 19

Ograničenja

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

Podrazumevano: "0"

minor_unitsCeli brojObavezno

Broj decimalnih cifara valute.

minimum: 0maximum: 4

Primer: 2

Dodatna polja: Ne

MarketData

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

currencyNiz znakovaObavezno

Kod valute iznosa.

Ograničenja

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

Primer: "PLN"

fixed_amountNiz znakovaOpciono

Iznos popusta

maxLength: 19

Ograničenja

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

Podrazumevano: "0"

market_idNiz znakovaObavezno

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

Ograničenja

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

Primer: "poland"

maximum_priceNiz znakova nullOpciono

Maksimalna cena 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 nullOpciono

Minimalna cena proizvoda

Niz znakova:maxLength: 19

Ograničenja · Niz znakova 1

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

minimum_subtotalNiz znakovaOpciono

Minimalna vrednost korpe

maxLength: 19

Ograničenja

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

Podrazumevano: "0"

minor_unitsCeli brojObavezno

Broj decimalnih cifara valute.

minimum: 0maximum: 4

Primer: 0

Dodatna polja: Ne