Duomenų schemos · Nuolaidos

API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

Duomenų schemos

ApiResponse[CampaignData]

ApiResponse_CampaignData_ · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

dataCampaignData Privalomas: Sėkmingo atsakymo duomenys.

Pavyzdys: {"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 Privalomas: Atsakymo metaduomenys.

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

Papildomi laukai: Ne

ApiResponse[list[CampaignData]]

ApiResponse_list_CampaignData__ · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

dataMasyvas <CampaignData > Privalomas: Sėkmingo atsakymo duomenys.

Pavyzdys: []
metaContextPageMeta ContextMeta PageMeta RequestMeta Privalomas: Atsakymo metaduomenys.

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

Papildomi laukai: Ne

CampaignCreate

CampaignCreate · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

audienceEilutėNeprivalomas

Klientai

Apribojimai

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

Numatytoji reikšmė: "all"

benefit_typeEilutėNeprivalomas

Duomenų struktūros atmaina, apibrėžta leidžiamomis reikšmėmis.

Apribojimai

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

Numatytoji reikšmė: "percentage"

category_idsMasyvas <Eilutė> Neprivalomas

Susijusių kategorijų identifikatoriai.

maxItems: 1000

Apribojimai · Masyvas 1

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

codeEilutė nullNeprivalomas

Stabilus kompiuterio skaitomas kodas.

Apribojimai · Eilutė 1

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

Pavyzdys: "LEARN10"

combine_couponsLoginė reikšmėNeprivalomas

Derinti su kitais kodais

Numatytoji reikšmė: false

combine_promotionsLoginė reikšmėNeprivalomas

Leisti šį kodą produktams su automatinėmis akcijomis

Numatytoji reikšmė: false

customer_idsMasyvas <Eilutė> Neprivalomas

Šiam ištekliui užregistruota kliento informacija.

maxItems: 1000

Apribojimai · Masyvas 1

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

ends_atEilutė nullNeprivalomas

Galioja iki

Eilutė:format: "date-time"

free_shippingLoginė reikšmėNeprivalomas

Nemokamas pristatymas

Numatytoji reikšmė: false

marketsMasyvas <MarketData-Input > Privalomas

Parduotuvės kontekste prieinamos rinkos.

minItems: 1maxItems: 1000

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

minimum_quantitySveikasis skaičiusNeprivalomas

Mažiausias prekių skaičius krepšelyje

minimum: 1maximum: 2147483647

Numatytoji reikšmė: 1

nameEilutėPrivalomas

Ištekliaus pavadinimas atitinkamame kontekste.

minLength: 1maxLength: 160

Pavyzdys: "Autumn guide offer"

per_customer_limitSveikasis skaičiusNeprivalomas

Naudojimų limitas vienam klientui

minimum: -1maximum: 2147483647

Numatytoji reikšmė: -1

percentageEilutėNeprivalomas

Procentinė

maxLength: 19

Apribojimai

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

Numatytoji reikšmė: "10"

product_idsMasyvas <Eilutė> Neprivalomas

Susijusių produktų identifikatoriai.

maxItems: 1000

Apribojimai · Masyvas 1

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

product_scopeEilutėNeprivalomas

Produktai

Apribojimai

enum: ["all", "selected"]

Numatytoji reikšmė: "all"

show_accountLoginė reikšmėNeprivalomas

Kliento paskyroje

Numatytoji reikšmė: false

show_cartLoginė reikšmėNeprivalomas

Krepšelyje

Numatytoji reikšmė: false

show_productLoginė reikšmėNeprivalomas

Produktų puslapiuose

Numatytoji reikšmė: false

starts_atEilutė nullNeprivalomas

Galioja nuo

Eilutė:format: "date-time"

usage_limitSveikasis skaičiusNeprivalomas

Naudojimų limitas

minimum: -1maximum: 2147483647

Numatytoji reikšmė: -1

Papildomi laukai: Ne

CampaignData

CampaignData · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

audienceEilutėNeprivalomas

Klientai

Apribojimai

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

Numatytoji reikšmė: "all"

benefit_typeEilutėNeprivalomas

Duomenų struktūros atmaina, apibrėžta leidžiamomis reikšmėmis.

Apribojimai

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

Numatytoji reikšmė: "percentage"

category_idsMasyvas <Eilutė> Neprivalomas

Susijusių kategorijų identifikatoriai.

maxItems: 1000

Apribojimai · Masyvas 1

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

codeEilutė nullNeprivalomas

Stabilus kompiuterio skaitomas kodas.

Apribojimai · Eilutė 1

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

combine_couponsLoginė reikšmėNeprivalomas

Derinti su kitais kodais

Numatytoji reikšmė: false

combine_promotionsLoginė reikšmėNeprivalomas

Leisti šį kodą produktams su automatinėmis akcijomis

Numatytoji reikšmė: false

created_atEilutėPrivalomas

Sukūrimo laikas.

format: "date-time"

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

created_byCreatorData Privalomas

Sukūrė

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

customer_idsMasyvas <Eilutė> Neprivalomas

Šiam ištekliui užregistruota kliento informacija.

maxItems: 1000

Apribojimai · Masyvas 1

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

enabledLoginė reikšmėPrivalomas

Ar šis nustatymas įjungtas.

Pavyzdys: false

ends_atEilutė nullNeprivalomas

Galioja iki

Eilutė:format: "date-time"

free_shippingLoginė reikšmėNeprivalomas

Nemokamas pristatymas

Numatytoji reikšmė: false

idEilutėPrivalomas

Ištekliaus identifikatorius; išsaugokite grąžintą išraišką.

Pavyzdys: "example-campaign"

kindEilutėPrivalomas

Duomenų struktūros atmaina, apibrėžta leidžiamomis reikšmėmis.

Apribojimai

enum: ["coupon", "promotion"]

Pavyzdys: "coupon"

marketsMasyvas <shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData > Privalomas

Parduotuvės kontekste prieinamos rinkos.

minItems: 1maxItems: 1000

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

minimum_quantitySveikasis skaičiusNeprivalomas

Mažiausias prekių skaičius krepšelyje

minimum: 1maximum: 2147483647

Numatytoji reikšmė: 1

nameEilutėPrivalomas

Ištekliaus pavadinimas atitinkamame kontekste.

minLength: 1maxLength: 160

Pavyzdys: "Autumn guide offer"

per_customer_limitSveikasis skaičiusNeprivalomas

Naudojimų limitas vienam klientui

minimum: -1maximum: 2147483647

Numatytoji reikšmė: -1

percentageEilutėNeprivalomas

Procentinė

maxLength: 19

Apribojimai

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

Numatytoji reikšmė: "10"

product_idsMasyvas <Eilutė> Neprivalomas

Susijusių produktų identifikatoriai.

maxItems: 1000

Apribojimai · Masyvas 1

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

product_scopeEilutėNeprivalomas

Produktai

Apribojimai

enum: ["all", "selected"]

Numatytoji reikšmė: "all"

show_accountLoginė reikšmėNeprivalomas

Kliento paskyroje

Numatytoji reikšmė: false

show_cartLoginė reikšmėNeprivalomas

Krepšelyje

Numatytoji reikšmė: false

show_productLoginė reikšmėNeprivalomas

Produktų puslapiuose

Numatytoji reikšmė: false

starts_atEilutė nullNeprivalomas

Galioja nuo

Eilutė:format: "date-time"

updated_atEilutėPrivalomas

Paskutinio atnaujinimo laikas.

format: "date-time"

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

usage_limitSveikasis skaičiusNeprivalomas

Naudojimų limitas

minimum: -1maximum: 2147483647

Numatytoji reikšmė: -1

used_countSveikasis skaičiusPrivalomas

Panaudota kartų

Pavyzdys: 0

versionSveikasis skaičiusPrivalomas

Ištekliaus versija lygiagrečių pakeitimų kontrolei.

Pavyzdys: 1

Papildomi laukai: Ne

CampaignStatus

CampaignStatus · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

enabledLoginė reikšmėPrivalomas: Ar šis nustatymas įjungtas.

Pavyzdys: false
expected_versionSveikasis skaičiusPrivalomas: Prieš įrašant perskaityta versija; neatitikimas atmeta pakeitimą.

minimum: 1maximum: 9223372036854775807

Pavyzdys: 1

Papildomi laukai: Ne

CampaignUpdate

CampaignUpdate · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

audienceEilutėNeprivalomas

Klientai

Apribojimai

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

Numatytoji reikšmė: "all"

benefit_typeEilutėNeprivalomas

Duomenų struktūros atmaina, apibrėžta leidžiamomis reikšmėmis.

Apribojimai

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

Numatytoji reikšmė: "percentage"

category_idsMasyvas <Eilutė> Neprivalomas

Susijusių kategorijų identifikatoriai.

maxItems: 1000

Apribojimai · Masyvas 1

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

codeEilutė nullNeprivalomas

Stabilus kompiuterio skaitomas kodas.

Apribojimai · Eilutė 1

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

Pavyzdys: "LEARN10"

combine_couponsLoginė reikšmėNeprivalomas

Derinti su kitais kodais

Numatytoji reikšmė: false

combine_promotionsLoginė reikšmėNeprivalomas

Leisti šį kodą produktams su automatinėmis akcijomis

Numatytoji reikšmė: false

customer_idsMasyvas <Eilutė> Neprivalomas

Šiam ištekliui užregistruota kliento informacija.

maxItems: 1000

Apribojimai · Masyvas 1

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

ends_atEilutė nullNeprivalomas

Galioja iki

Eilutė:format: "date-time"

expected_versionSveikasis skaičiusPrivalomas

Prieš įrašant perskaityta versija; neatitikimas atmeta pakeitimą.

minimum: 1maximum: 9223372036854775807

Pavyzdys: 1

free_shippingLoginė reikšmėNeprivalomas

Nemokamas pristatymas

Numatytoji reikšmė: false

marketsMasyvas <MarketData-Input > Privalomas

Parduotuvės kontekste prieinamos rinkos.

minItems: 1maxItems: 1000

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

minimum_quantitySveikasis skaičiusNeprivalomas

Mažiausias prekių skaičius krepšelyje

minimum: 1maximum: 2147483647

Numatytoji reikšmė: 1

nameEilutėPrivalomas

Ištekliaus pavadinimas atitinkamame kontekste.

minLength: 1maxLength: 160

Pavyzdys: "Autumn guide offer"

per_customer_limitSveikasis skaičiusNeprivalomas

Naudojimų limitas vienam klientui

minimum: -1maximum: 2147483647

Numatytoji reikšmė: -1

percentageEilutėNeprivalomas

Procentinė

maxLength: 19

Apribojimai

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

Numatytoji reikšmė: "10"

product_idsMasyvas <Eilutė> Neprivalomas

Susijusių produktų identifikatoriai.

maxItems: 1000

Apribojimai · Masyvas 1

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

product_scopeEilutėNeprivalomas

Produktai

Apribojimai

enum: ["all", "selected"]

Numatytoji reikšmė: "all"

show_accountLoginė reikšmėNeprivalomas

Kliento paskyroje

Numatytoji reikšmė: false

show_cartLoginė reikšmėNeprivalomas

Krepšelyje

Numatytoji reikšmė: false

show_productLoginė reikšmėNeprivalomas

Produktų puslapiuose

Numatytoji reikšmė: false

starts_atEilutė nullNeprivalomas

Galioja nuo

Eilutė:format: "date-time"

usage_limitSveikasis skaičiusNeprivalomas

Naudojimų limitas

minimum: -1maximum: 2147483647

Numatytoji reikšmė: -1

Papildomi laukai: Ne

CreatorData

CreatorData · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

kindEilutėPrivalomas

Duomenų struktūros atmaina, apibrėžta leidžiamomis reikšmėmis.

Apribojimai

enum: ["admin", "api"]

Pavyzdys: "admin"

labelEilutėPrivalomas

Ištekliaus pavadinimas atitinkamame kontekste.

Pavyzdys: "Editorial integration"

referenceEilutėPrivalomas

Nurodyto objekto identifikatorius.

Pavyzdys: "learn-api-key"

Papildomi laukai: Ne

MarketData

MarketData-Input · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

currencyEilutėPrivalomas

Sumos valiutos kodas.

Apribojimai

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

Pavyzdys: "PLN"

fixed_amountEilutėNeprivalomas

Nuolaidos suma

maxLength: 19

Apribojimai

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

Numatytoji reikšmė: "0"

market_idEilutėPrivalomas

Konteksto prieigos taško grąžintas rinkos identifikatorius.

Apribojimai

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

Pavyzdys: "poland"

maximum_priceEilutė nullNeprivalomas

Didžiausia produkto kaina

Eilutė:maxLength: 19

Apribojimai · Eilutė 1

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

minimum_priceEilutė nullNeprivalomas

Mažiausia produkto kaina

Eilutė:maxLength: 19

Apribojimai · Eilutė 1

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

minimum_subtotalEilutėNeprivalomas

Mažiausia krepšelio vertė

maxLength: 19

Apribojimai

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

Numatytoji reikšmė: "0"

minor_unitsSveikasis skaičiusPrivalomas

Valiutos naudojamų skaitmenų po kablelio skaičius.

minimum: 0maximum: 4

Pavyzdys: 2

Papildomi laukai: Ne

MarketData

shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

currencyEilutėPrivalomas

Sumos valiutos kodas.

Apribojimai

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

Pavyzdys: "PLN"

fixed_amountEilutėNeprivalomas

Nuolaidos suma

maxLength: 19

Apribojimai

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

Numatytoji reikšmė: "0"

market_idEilutėPrivalomas

Konteksto prieigos taško grąžintas rinkos identifikatorius.

Apribojimai

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

Pavyzdys: "poland"

maximum_priceEilutė nullNeprivalomas

Didžiausia produkto kaina

Eilutė:maxLength: 19

Apribojimai · Eilutė 1

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

minimum_priceEilutė nullNeprivalomas

Mažiausia produkto kaina

Eilutė:maxLength: 19

Apribojimai · Eilutė 1

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

minimum_subtotalEilutėNeprivalomas

Mažiausia krepšelio vertė

maxLength: 19

Apribojimai

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

Numatytoji reikšmė: "0"

minor_unitsSveikasis skaičiusPrivalomas

Valiutos naudojamų skaitmenų po kablelio skaičius.

minimum: 0maximum: 4

Pavyzdys: 0

Papildomi laukai: Ne