Andmeskeemid · Allahindlused

API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

Andmeskeemid

ApiResponse[CampaignData]

ApiResponse_CampaignData_ · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

dataCampaignData Kohustuslik: Eduka vastuse andmed.

Näide: {"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 Kohustuslik: Vastuse metaandmed.

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

Lisaväljad: Ei

ApiResponse[list[CampaignData]]

ApiResponse_list_CampaignData__ · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

dataMassiiv <CampaignData > Kohustuslik: Eduka vastuse andmed.

Näide: []
metaContextPageMeta ContextMeta PageMeta RequestMeta Kohustuslik: Vastuse metaandmed.

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

Lisaväljad: Ei

CampaignCreate

CampaignCreate · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

audienceStringValikuline

Kliendid

Piirangud

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

Vaikeväärtus: "all"

benefit_typeStringValikuline

Andmestruktuuri variant, mida kirjeldavad lubatud väärtused.

Piirangud

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

Vaikeväärtus: "percentage"

category_idsMassiiv <String> Valikuline

Seotud kategooriate identifikaatorid.

maxItems: 1000

Piirangud · Massiiv 1

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

codeString nullValikuline

Püsiv masinloetav kood.

Piirangud · String 1

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

Näide: "LEARN10"

combine_couponsTõeväärtusValikuline

Kombineeri teiste koodidega

Vaikeväärtus: false

combine_promotionsTõeväärtusValikuline

Luba seda koodi automaatsete kampaaniatega toodetele

Vaikeväärtus: false

customer_idsMassiiv <String> Valikuline

Selle ressursi juurde salvestatud klienditeave.

maxItems: 1000

Piirangud · Massiiv 1

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

ends_atString nullValikuline

Aktiivne kuni

String:format: "date-time"

free_shippingTõeväärtusValikuline

Tasuta tarne

Vaikeväärtus: false

marketsMassiiv <MarketData-Input > Kohustuslik

Poe kontekstis saadaolevad turud.

minItems: 1maxItems: 1000

Näide: [{"currency":"PLN","market_id":"poland","minor_units":2}]

minimum_quantityTäisarvValikuline

Minimaalne toodete arv ostukorvis

minimum: 1maximum: 2147483647

Vaikeväärtus: 1

nameStringKohustuslik

Ressursi nimi vastavas kontekstis.

minLength: 1maxLength: 160

Näide: "Autumn guide offer"

per_customer_limitTäisarvValikuline

Kasutuskordade piirang kliendi kohta

minimum: -1maximum: 2147483647

Vaikeväärtus: -1

percentageStringValikuline

Protsent

maxLength: 19

Piirangud

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

Vaikeväärtus: "10"

product_idsMassiiv <String> Valikuline

Seotud toodete identifikaatorid.

maxItems: 1000

Piirangud · Massiiv 1

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

product_scopeStringValikuline

Tooted

Piirangud

enum: ["all", "selected"]

Vaikeväärtus: "all"

show_accountTõeväärtusValikuline

Kliendikontol

Vaikeväärtus: false

show_cartTõeväärtusValikuline

Ostukorvis

Vaikeväärtus: false

show_productTõeväärtusValikuline

Tootelehtedel

Vaikeväärtus: false

starts_atString nullValikuline

Aktiivne alates

String:format: "date-time"

usage_limitTäisarvValikuline

Kasutuskordade piirang

minimum: -1maximum: 2147483647

Vaikeväärtus: -1

Lisaväljad: Ei

CampaignData

CampaignData · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

audienceStringValikuline

Kliendid

Piirangud

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

Vaikeväärtus: "all"

benefit_typeStringValikuline

Andmestruktuuri variant, mida kirjeldavad lubatud väärtused.

Piirangud

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

Vaikeväärtus: "percentage"

category_idsMassiiv <String> Valikuline

Seotud kategooriate identifikaatorid.

maxItems: 1000

Piirangud · Massiiv 1

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

codeString nullValikuline

Püsiv masinloetav kood.

Piirangud · String 1

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

combine_couponsTõeväärtusValikuline

Kombineeri teiste koodidega

Vaikeväärtus: false

combine_promotionsTõeväärtusValikuline

Luba seda koodi automaatsete kampaaniatega toodetele

Vaikeväärtus: false

created_atStringKohustuslik

Loomise aeg.

format: "date-time"

Näide: "2026-10-07T10:00:00Z"

created_byCreatorData Kohustuslik

Looja

Näide: {"kind":"admin","label":"Editorial integration","reference":"learn-api-key"}

customer_idsMassiiv <String> Valikuline

Selle ressursi juurde salvestatud klienditeave.

maxItems: 1000

Piirangud · Massiiv 1

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

enabledTõeväärtusKohustuslik

Kas see säte on lubatud.

Näide: false

ends_atString nullValikuline

Aktiivne kuni

String:format: "date-time"

free_shippingTõeväärtusValikuline

Tasuta tarne

Vaikeväärtus: false

idStringKohustuslik

Ressursi identifikaator; säilita see tagastatud kujul.

Näide: "example-campaign"

kindStringKohustuslik

Andmestruktuuri variant, mida kirjeldavad lubatud väärtused.

Piirangud

enum: ["coupon", "promotion"]

Näide: "coupon"

marketsMassiiv <shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData > Kohustuslik

Poe kontekstis saadaolevad turud.

minItems: 1maxItems: 1000

Näide: [{"currency":"PLN","market_id":"poland","minor_units":0}]

minimum_quantityTäisarvValikuline

Minimaalne toodete arv ostukorvis

minimum: 1maximum: 2147483647

Vaikeväärtus: 1

nameStringKohustuslik

Ressursi nimi vastavas kontekstis.

minLength: 1maxLength: 160

Näide: "Autumn guide offer"

per_customer_limitTäisarvValikuline

Kasutuskordade piirang kliendi kohta

minimum: -1maximum: 2147483647

Vaikeväärtus: -1

percentageStringValikuline

Protsent

maxLength: 19

Piirangud

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

Vaikeväärtus: "10"

product_idsMassiiv <String> Valikuline

Seotud toodete identifikaatorid.

maxItems: 1000

Piirangud · Massiiv 1

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

product_scopeStringValikuline

Tooted

Piirangud

enum: ["all", "selected"]

Vaikeväärtus: "all"

show_accountTõeväärtusValikuline

Kliendikontol

Vaikeväärtus: false

show_cartTõeväärtusValikuline

Ostukorvis

Vaikeväärtus: false

show_productTõeväärtusValikuline

Tootelehtedel

Vaikeväärtus: false

starts_atString nullValikuline

Aktiivne alates

String:format: "date-time"

updated_atStringKohustuslik

Viimase uuendamise aeg.

format: "date-time"

Näide: "2026-10-07T10:00:00Z"

usage_limitTäisarvValikuline

Kasutuskordade piirang

minimum: -1maximum: 2147483647

Vaikeväärtus: -1

used_countTäisarvKohustuslik

Kasutatud kordade arv

Näide: 0

versionTäisarvKohustuslik

Ressursi versioon samaaegsuse kontrolliks.

Näide: 1

Lisaväljad: Ei

CampaignStatus

CampaignStatus · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

enabledTõeväärtusKohustuslik: Kas see säte on lubatud.

Näide: false
expected_versionTäisarvKohustuslik: Enne muutmist loetud versioon; erinevuse korral lükatakse muudatus tagasi.

minimum: 1maximum: 9223372036854775807

Näide: 1

Lisaväljad: Ei

CampaignUpdate

CampaignUpdate · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

audienceStringValikuline

Kliendid

Piirangud

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

Vaikeväärtus: "all"

benefit_typeStringValikuline

Andmestruktuuri variant, mida kirjeldavad lubatud väärtused.

Piirangud

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

Vaikeväärtus: "percentage"

category_idsMassiiv <String> Valikuline

Seotud kategooriate identifikaatorid.

maxItems: 1000

Piirangud · Massiiv 1

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

codeString nullValikuline

Püsiv masinloetav kood.

Piirangud · String 1

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

Näide: "LEARN10"

combine_couponsTõeväärtusValikuline

Kombineeri teiste koodidega

Vaikeväärtus: false

combine_promotionsTõeväärtusValikuline

Luba seda koodi automaatsete kampaaniatega toodetele

Vaikeväärtus: false

customer_idsMassiiv <String> Valikuline

Selle ressursi juurde salvestatud klienditeave.

maxItems: 1000

Piirangud · Massiiv 1

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

ends_atString nullValikuline

Aktiivne kuni

String:format: "date-time"

expected_versionTäisarvKohustuslik

Enne muutmist loetud versioon; erinevuse korral lükatakse muudatus tagasi.

minimum: 1maximum: 9223372036854775807

Näide: 1

free_shippingTõeväärtusValikuline

Tasuta tarne

Vaikeväärtus: false

marketsMassiiv <MarketData-Input > Kohustuslik

Poe kontekstis saadaolevad turud.

minItems: 1maxItems: 1000

Näide: [{"currency":"PLN","market_id":"poland","minor_units":2}]

minimum_quantityTäisarvValikuline

Minimaalne toodete arv ostukorvis

minimum: 1maximum: 2147483647

Vaikeväärtus: 1

nameStringKohustuslik

Ressursi nimi vastavas kontekstis.

minLength: 1maxLength: 160

Näide: "Autumn guide offer"

per_customer_limitTäisarvValikuline

Kasutuskordade piirang kliendi kohta

minimum: -1maximum: 2147483647

Vaikeväärtus: -1

percentageStringValikuline

Protsent

maxLength: 19

Piirangud

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

Vaikeväärtus: "10"

product_idsMassiiv <String> Valikuline

Seotud toodete identifikaatorid.

maxItems: 1000

Piirangud · Massiiv 1

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

product_scopeStringValikuline

Tooted

Piirangud

enum: ["all", "selected"]

Vaikeväärtus: "all"

show_accountTõeväärtusValikuline

Kliendikontol

Vaikeväärtus: false

show_cartTõeväärtusValikuline

Ostukorvis

Vaikeväärtus: false

show_productTõeväärtusValikuline

Tootelehtedel

Vaikeväärtus: false

starts_atString nullValikuline

Aktiivne alates

String:format: "date-time"

usage_limitTäisarvValikuline

Kasutuskordade piirang

minimum: -1maximum: 2147483647

Vaikeväärtus: -1

Lisaväljad: Ei

CreatorData

CreatorData · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

kindStringKohustuslik

Andmestruktuuri variant, mida kirjeldavad lubatud väärtused.

Piirangud

enum: ["admin", "api"]

Näide: "admin"

labelStringKohustuslik

Ressursi nimi vastavas kontekstis.

Näide: "Editorial integration"

referenceStringKohustuslik

Viidatud üksuse identifikaator.

Näide: "learn-api-key"

Lisaväljad: Ei

MarketData

MarketData-Input · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

currencyStringKohustuslik

Summa valuutakood.

Piirangud

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

Näide: "PLN"

fixed_amountStringValikuline

Allahindluse summa

maxLength: 19

Piirangud

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

Vaikeväärtus: "0"

market_idStringKohustuslik

Konteksti lõpp-punkti tagastatud turuidentifikaator.

Piirangud

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

Näide: "poland"

maximum_priceString nullValikuline

Toote maksimaalne hind

String:maxLength: 19

Piirangud · String 1

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

minimum_priceString nullValikuline

Toote minimaalne hind

String:maxLength: 19

Piirangud · String 1

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

minimum_subtotalStringValikuline

Ostukorvi minimaalne väärtus

maxLength: 19

Piirangud

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

Vaikeväärtus: "0"

minor_unitsTäisarvKohustuslik

Valuuta kasutatavate kümnendkohtade arv.

minimum: 0maximum: 4

Näide: 2

Lisaväljad: Ei

MarketData

shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

currencyStringKohustuslik

Summa valuutakood.

Piirangud

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

Näide: "PLN"

fixed_amountStringValikuline

Allahindluse summa

maxLength: 19

Piirangud

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

Vaikeväärtus: "0"

market_idStringKohustuslik

Konteksti lõpp-punkti tagastatud turuidentifikaator.

Piirangud

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

Näide: "poland"

maximum_priceString nullValikuline

Toote maksimaalne hind

String:maxLength: 19

Piirangud · String 1

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

minimum_priceString nullValikuline

Toote minimaalne hind

String:maxLength: 19

Piirangud · String 1

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

minimum_subtotalStringValikuline

Ostukorvi minimaalne väärtus

maxLength: 19

Piirangud

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

Vaikeväärtus: "0"

minor_unitsTäisarvKohustuslik

Valuuta kasutatavate kümnendkohtade arv.

minimum: 0maximum: 4

Näide: 0

Lisaväljad: Ei