Preskoči na vsebino
ShopentlyLearn
Slovenščina

Podatkovne sheme · Popusti

Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.

Podatkovne sheme

ApiResponse[CampaignData]

ApiResponse_CampaignData_ · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
dataCampaignData Obvezno

Vsebina uspešnega 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 Obvezno

Metapodatki 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, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
dataPolje elementov <CampaignData > Obvezno

Vsebina uspešnega odgovora.

Primer: []
metaContextPageMeta ContextMeta PageMeta RequestMeta Obvezno

Metapodatki 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, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
audienceNizIzbirno

Kupci

Omejitve
enum
["all", "guest", "customer", "selected"]
Privzeto: "all"
benefit_typeNizIzbirno

Vrsta podatkovne strukture, opisana z dovoljenimi vrednostmi.

Omejitve
enum
["percentage", "fixed", "none"]
Privzeto: "percentage"
category_idsPolje elementov <Niz> Izbirno

Identifikatorji povezanih kategorij.

maxItems: 1000
Omejitve · Polje elementov 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
codeNiz nullIzbirno

Stabilna strojno berljiva koda.

Omejitve · Niz 1
pattern
"^[A-Za-z0-9]{6,16}$"
Primer: "LEARN10"
combine_couponsLogična vrednostIzbirno

Združi z drugimi kodami

Privzeto: false
combine_promotionsLogična vrednostIzbirno

Dovoli to kodo za izdelke s samodejnimi akcijami

Privzeto: false
customer_idsPolje elementov <Niz> Izbirno

Podatki stranke, zabeleženi za ta vir.

maxItems: 1000
Omejitve · Polje elementov 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
ends_atNiz nullIzbirno

Aktivno do

Niz:format: "date-time"
free_shippingLogična vrednostIzbirno

Brezplačna dostava

Privzeto: false
marketsPolje elementov <MarketData-Input > Obvezno

Trgi, razpoložljivi v kontekstu trgovine.

minItems: 1maxItems: 1000
Primer: [{"currency":"PLN","market_id":"poland","minor_units":2}]
minimum_quantityCelo številoIzbirno

Najmanjše število kosov v košarici

minimum: 1maximum: 2147483647
Privzeto: 1
nameNizObvezno

Ime vira v ustreznem kontekstu.

minLength: 1maxLength: 160
Primer: "Autumn guide offer"
per_customer_limitCelo številoIzbirno

Omejitev uporab na kupca

minimum: -1maximum: 2147483647
Privzeto: -1
percentageNizIzbirno

Odstotek

maxLength: 19
Omejitve
pattern
"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"
Privzeto: "10"
product_idsPolje elementov <Niz> Izbirno

Identifikatorji povezanih izdelkov.

maxItems: 1000
Omejitve · Polje elementov 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
product_scopeNizIzbirno

Izdelki

Omejitve
enum
["all", "selected"]
Privzeto: "all"
show_accountLogična vrednostIzbirno

V računu kupca

Privzeto: false
show_cartLogična vrednostIzbirno

V košarici

Privzeto: false
show_productLogična vrednostIzbirno

Na straneh izdelkov

Privzeto: false
starts_atNiz nullIzbirno

Aktivno od

Niz:format: "date-time"
usage_limitCelo številoIzbirno

Omejitev uporab

minimum: -1maximum: 2147483647
Privzeto: -1

Dodatna polja: Ne

CampaignData

CampaignData · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
audienceNizIzbirno

Kupci

Omejitve
enum
["all", "guest", "customer", "selected"]
Privzeto: "all"
benefit_typeNizIzbirno

Vrsta podatkovne strukture, opisana z dovoljenimi vrednostmi.

Omejitve
enum
["percentage", "fixed", "none"]
Privzeto: "percentage"
category_idsPolje elementov <Niz> Izbirno

Identifikatorji povezanih kategorij.

maxItems: 1000
Omejitve · Polje elementov 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
codeNiz nullIzbirno

Stabilna strojno berljiva koda.

Omejitve · Niz 1
pattern
"^[A-Za-z0-9]{6,16}$"
combine_couponsLogična vrednostIzbirno

Združi z drugimi kodami

Privzeto: false
combine_promotionsLogična vrednostIzbirno

Dovoli to kodo za izdelke s samodejnimi akcijami

Privzeto: false
created_atNizObvezno

Čas nastanka.

format: "date-time"
Primer: "2026-10-07T10:00:00Z"
created_byCreatorData Obvezno

Ustvaril

Primer: {"kind":"admin","label":"Editorial integration","reference":"learn-api-key"}
customer_idsPolje elementov <Niz> Izbirno

Podatki stranke, zabeleženi za ta vir.

maxItems: 1000
Omejitve · Polje elementov 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
enabledLogična vrednostObvezno

Ali je nastavitev omogočena.

Primer: false
ends_atNiz nullIzbirno

Aktivno do

Niz:format: "date-time"
free_shippingLogična vrednostIzbirno

Brezplačna dostava

Privzeto: false
idNizObvezno

Identifikator vira; ohranite ga v vrnjeni obliki.

Primer: "example-campaign"
kindNizObvezno

Vrsta podatkovne strukture, opisana z dovoljenimi vrednostmi.

Omejitve
enum
["coupon", "promotion"]
Primer: "coupon"
marketsPolje elementov <shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData > Obvezno

Trgi, razpoložljivi v kontekstu trgovine.

minItems: 1maxItems: 1000
Primer: [{"currency":"PLN","market_id":"poland","minor_units":0}]
minimum_quantityCelo številoIzbirno

Najmanjše število kosov v košarici

minimum: 1maximum: 2147483647
Privzeto: 1
nameNizObvezno

Ime vira v ustreznem kontekstu.

minLength: 1maxLength: 160
Primer: "Autumn guide offer"
per_customer_limitCelo številoIzbirno

Omejitev uporab na kupca

minimum: -1maximum: 2147483647
Privzeto: -1
percentageNizIzbirno

Odstotek

maxLength: 19
Omejitve
pattern
"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"
Privzeto: "10"
product_idsPolje elementov <Niz> Izbirno

Identifikatorji povezanih izdelkov.

maxItems: 1000
Omejitve · Polje elementov 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
product_scopeNizIzbirno

Izdelki

Omejitve
enum
["all", "selected"]
Privzeto: "all"
show_accountLogična vrednostIzbirno

V računu kupca

Privzeto: false
show_cartLogična vrednostIzbirno

V košarici

Privzeto: false
show_productLogična vrednostIzbirno

Na straneh izdelkov

Privzeto: false
starts_atNiz nullIzbirno

Aktivno od

Niz:format: "date-time"
updated_atNizObvezno

Čas zadnje posodobitve.

format: "date-time"
Primer: "2026-10-07T10:00:00Z"
usage_limitCelo številoIzbirno

Omejitev uporab

minimum: -1maximum: 2147483647
Privzeto: -1
used_countCelo številoObvezno

Število uporab

Primer: 0
versionCelo številoObvezno

Različica vira za nadzor sočasnosti.

Primer: 1

Dodatna polja: Ne

CampaignStatus

CampaignStatus · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
enabledLogična vrednostObvezno

Ali je nastavitev omogočena.

Primer: false
expected_versionCelo številoObvezno

Različica, prebrana pred zapisom; neujemanje zavrne posodobitev.

minimum: 1maximum: 9223372036854775807
Primer: 1

Dodatna polja: Ne

CampaignUpdate

CampaignUpdate · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
audienceNizIzbirno

Kupci

Omejitve
enum
["all", "guest", "customer", "selected"]
Privzeto: "all"
benefit_typeNizIzbirno

Vrsta podatkovne strukture, opisana z dovoljenimi vrednostmi.

Omejitve
enum
["percentage", "fixed", "none"]
Privzeto: "percentage"
category_idsPolje elementov <Niz> Izbirno

Identifikatorji povezanih kategorij.

maxItems: 1000
Omejitve · Polje elementov 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
codeNiz nullIzbirno

Stabilna strojno berljiva koda.

Omejitve · Niz 1
pattern
"^[A-Za-z0-9]{6,16}$"
Primer: "LEARN10"
combine_couponsLogična vrednostIzbirno

Združi z drugimi kodami

Privzeto: false
combine_promotionsLogična vrednostIzbirno

Dovoli to kodo za izdelke s samodejnimi akcijami

Privzeto: false
customer_idsPolje elementov <Niz> Izbirno

Podatki stranke, zabeleženi za ta vir.

maxItems: 1000
Omejitve · Polje elementov 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
ends_atNiz nullIzbirno

Aktivno do

Niz:format: "date-time"
expected_versionCelo številoObvezno

Različica, prebrana pred zapisom; neujemanje zavrne posodobitev.

minimum: 1maximum: 9223372036854775807
Primer: 1
free_shippingLogična vrednostIzbirno

Brezplačna dostava

Privzeto: false
marketsPolje elementov <MarketData-Input > Obvezno

Trgi, razpoložljivi v kontekstu trgovine.

minItems: 1maxItems: 1000
Primer: [{"currency":"PLN","market_id":"poland","minor_units":2}]
minimum_quantityCelo številoIzbirno

Najmanjše število kosov v košarici

minimum: 1maximum: 2147483647
Privzeto: 1
nameNizObvezno

Ime vira v ustreznem kontekstu.

minLength: 1maxLength: 160
Primer: "Autumn guide offer"
per_customer_limitCelo številoIzbirno

Omejitev uporab na kupca

minimum: -1maximum: 2147483647
Privzeto: -1
percentageNizIzbirno

Odstotek

maxLength: 19
Omejitve
pattern
"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"
Privzeto: "10"
product_idsPolje elementov <Niz> Izbirno

Identifikatorji povezanih izdelkov.

maxItems: 1000
Omejitve · Polje elementov 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
product_scopeNizIzbirno

Izdelki

Omejitve
enum
["all", "selected"]
Privzeto: "all"
show_accountLogična vrednostIzbirno

V računu kupca

Privzeto: false
show_cartLogična vrednostIzbirno

V košarici

Privzeto: false
show_productLogična vrednostIzbirno

Na straneh izdelkov

Privzeto: false
starts_atNiz nullIzbirno

Aktivno od

Niz:format: "date-time"
usage_limitCelo številoIzbirno

Omejitev uporab

minimum: -1maximum: 2147483647
Privzeto: -1

Dodatna polja: Ne

CreatorData

CreatorData · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
kindNizObvezno

Vrsta podatkovne strukture, opisana z dovoljenimi vrednostmi.

Omejitve
enum
["admin", "api"]
Primer: "admin"
labelNizObvezno

Ime vira v ustreznem kontekstu.

Primer: "Editorial integration"
referenceNizObvezno

Identifikator navedenega objekta.

Primer: "learn-api-key"

Dodatna polja: Ne

MarketData

MarketData-Input · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
currencyNizObvezno

Koda valute zneska.

Omejitve
pattern
"^[A-Z]{3}$"
Primer: "PLN"
fixed_amountNizIzbirno

Znesek popusta

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

Identifikator trga, vrnjen s končno točko konteksta.

Omejitve
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Primer: "poland"
maximum_priceNiz nullIzbirno

Najvišja cena izdelka

Niz:maxLength: 19
Omejitve · Niz 1
pattern
"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"
minimum_priceNiz nullIzbirno

Najnižja cena izdelka

Niz:maxLength: 19
Omejitve · Niz 1
pattern
"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"
minimum_subtotalNizIzbirno

Najmanjša vrednost košarice

maxLength: 19
Omejitve
pattern
"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"
Privzeto: "0"
minor_unitsCelo številoObvezno

Število decimalnih mest valute.

minimum: 0maximum: 4
Primer: 2

Dodatna polja: Ne

MarketData

shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData · Polja, vrste in omejitve podatkov, ki jih API sprejema ali vrača.
currencyNizObvezno

Koda valute zneska.

Omejitve
pattern
"^[A-Z]{3}$"
Primer: "PLN"
fixed_amountNizIzbirno

Znesek popusta

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

Identifikator trga, vrnjen s končno točko konteksta.

Omejitve
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Primer: "poland"
maximum_priceNiz nullIzbirno

Najvišja cena izdelka

Niz:maxLength: 19
Omejitve · Niz 1
pattern
"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"
minimum_priceNiz nullIzbirno

Najnižja cena izdelka

Niz:maxLength: 19
Omejitve · Niz 1
pattern
"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"
minimum_subtotalNizIzbirno

Najmanjša vrednost košarice

maxLength: 19
Omejitve
pattern
"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"
Privzeto: "0"
minor_unitsCelo številoObvezno

Število decimalnih mest valute.

minimum: 0maximum: 4
Primer: 0

Dodatna polja: Ne