Datu shēmas · Atlaides

dataCampaignData Obligāts

Veiksmīgas atbildes dati.

Piemērs: {"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 Obligāts

Atbildes metadati.

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

Papildu lauki: Nē

dataMasīvs <CampaignData > Obligāts

Veiksmīgas atbildes dati.

Piemērs: []

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Obligāts

Atbildes metadati.

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

Papildu lauki: Nē

audienceVirkneNeobligāts

Klienti

Ierobežojumi

enum

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

Noklusējums: "all"

benefit_typeVirkneNeobligāts

Datu struktūras variants, kuru apraksta atļautās vērtības.

Ierobežojumi

enum

["percentage", "fixed", "none"]

Noklusējums: "percentage"

category_idsMasīvs <Virkne> Neobligāts

Saistīto kategoriju identifikatori.

maxItems: 1000

Ierobežojumi · Masīvs 1

pattern

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

codeVirkne | nullNeobligāts

Stabils mašīnlasāms kods.

Ierobežojumi · Virkne 1

pattern

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

Piemērs: "LEARN10"

combine_couponsLoģiska vērtībaNeobligāts

Apvienot ar citiem kodiem

Noklusējums: false

combine_promotionsLoģiska vērtībaNeobligāts

Atļaut šo kodu produktiem ar automātiskām akcijām

Noklusējums: false

customer_idsMasīvs <Virkne> Neobligāts

Šim resursam saglabātā klienta informācija.

maxItems: 1000

Ierobežojumi · Masīvs 1

pattern

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

ends_atVirkne | nullNeobligāts

Aktīvs līdz

Virkne:format: "date-time"

free_shippingLoģiska vērtībaNeobligāts

Bezmaksas piegāde

Noklusējums: false

marketsMasīvs <MarketData-Input > Obligāts

Veikala kontekstā pieejamie tirgi.

minItems: 1maxItems: 1000

Piemērs: [{"currency":"PLN","market_id":"poland","minor_units":2}]

minimum_quantityVesels skaitlisNeobligāts

Minimālais preču skaits grozā

minimum: 1maximum: 2147483647

Noklusējums: 1

nameVirkneObligāts

Resursa nosaukums attiecīgajā kontekstā.

minLength: 1maxLength: 160

Piemērs: "Autumn guide offer"

per_customer_limitVesels skaitlisNeobligāts

Izmantošanas reižu limits vienam klientam

minimum: -1maximum: 2147483647

Noklusējums: -1

percentageVirkneNeobligāts

Procentuāla

maxLength: 19

Ierobežojumi

pattern

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

Noklusējums: "10"

product_idsMasīvs <Virkne> Neobligāts

Saistīto produktu identifikatori.

maxItems: 1000

Ierobežojumi · Masīvs 1

pattern

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

product_scopeVirkneNeobligāts

Produkti

Ierobežojumi

enum

["all", "selected"]

Noklusējums: "all"

show_accountLoģiska vērtībaNeobligāts

Klienta kontā

Noklusējums: false

show_cartLoģiska vērtībaNeobligāts

Grozā

Noklusējums: false

show_productLoģiska vērtībaNeobligāts

Produktu lapās

Noklusējums: false

starts_atVirkne | nullNeobligāts

Aktīvs no

Virkne:format: "date-time"

usage_limitVesels skaitlisNeobligāts

Izmantošanas reižu limits

minimum: -1maximum: 2147483647

Noklusējums: -1

Papildu lauki: Nē

audienceVirkneNeobligāts

Klienti

Ierobežojumi

enum

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

Noklusējums: "all"

benefit_typeVirkneNeobligāts

Datu struktūras variants, kuru apraksta atļautās vērtības.

Ierobežojumi

enum

["percentage", "fixed", "none"]

Noklusējums: "percentage"

category_idsMasīvs <Virkne> Neobligāts

Saistīto kategoriju identifikatori.

maxItems: 1000

Ierobežojumi · Masīvs 1

pattern

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

codeVirkne | nullNeobligāts

Stabils mašīnlasāms kods.

Ierobežojumi · Virkne 1

pattern

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

combine_couponsLoģiska vērtībaNeobligāts

Apvienot ar citiem kodiem

Noklusējums: false

combine_promotionsLoģiska vērtībaNeobligāts

Atļaut šo kodu produktiem ar automātiskām akcijām

Noklusējums: false

created_atVirkneObligāts

Izveides laiks.

format: "date-time"

Piemērs: "2026-10-07T10:00:00Z"

created_byCreatorData Obligāts

Izveidoja

Piemērs: {"kind":"admin","label":"Editorial integration","reference":"learn-api-key"}

customer_idsMasīvs <Virkne> Neobligāts

Šim resursam saglabātā klienta informācija.

maxItems: 1000

Ierobežojumi · Masīvs 1

pattern

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

enabledLoģiska vērtībaObligāts

Vai šis iestatījums ir ieslēgts.

Piemērs: false

ends_atVirkne | nullNeobligāts

Aktīvs līdz

Virkne:format: "date-time"

free_shippingLoģiska vērtībaNeobligāts

Bezmaksas piegāde

Noklusējums: false

idVirkneObligāts

Resursa identifikators; saglabājiet to atgrieztajā formā.

Piemērs: "example-campaign"

kindVirkneObligāts

Datu struktūras variants, kuru apraksta atļautās vērtības.

Ierobežojumi

enum

["coupon", "promotion"]

Piemērs: "coupon"

marketsMasīvs <shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData > Obligāts

Veikala kontekstā pieejamie tirgi.

minItems: 1maxItems: 1000

Piemērs: [{"currency":"PLN","market_id":"poland","minor_units":0}]

minimum_quantityVesels skaitlisNeobligāts

Minimālais preču skaits grozā

minimum: 1maximum: 2147483647

Noklusējums: 1

nameVirkneObligāts

Resursa nosaukums attiecīgajā kontekstā.

minLength: 1maxLength: 160

Piemērs: "Autumn guide offer"

per_customer_limitVesels skaitlisNeobligāts

Izmantošanas reižu limits vienam klientam

minimum: -1maximum: 2147483647

Noklusējums: -1

percentageVirkneNeobligāts

Procentuāla

maxLength: 19

Ierobežojumi

pattern

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

Noklusējums: "10"

product_idsMasīvs <Virkne> Neobligāts

Saistīto produktu identifikatori.

maxItems: 1000

Ierobežojumi · Masīvs 1

pattern

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

product_scopeVirkneNeobligāts

Produkti

Ierobežojumi

enum

["all", "selected"]

Noklusējums: "all"

show_accountLoģiska vērtībaNeobligāts

Klienta kontā

Noklusējums: false

show_cartLoģiska vērtībaNeobligāts

Grozā

Noklusējums: false

show_productLoģiska vērtībaNeobligāts

Produktu lapās

Noklusējums: false

starts_atVirkne | nullNeobligāts

Aktīvs no

Virkne:format: "date-time"

updated_atVirkneObligāts

Pēdējās atjaunināšanas laiks.

format: "date-time"

Piemērs: "2026-10-07T10:00:00Z"

usage_limitVesels skaitlisNeobligāts

Izmantošanas reižu limits

minimum: -1maximum: 2147483647

Noklusējums: -1

used_countVesels skaitlisObligāts

Izmantošanas reižu skaits

Piemērs: 0

versionVesels skaitlisObligāts

Resursa versija vienlaicīgu izmaiņu kontrolei.

Piemērs: 1

Papildu lauki: Nē

enabledLoģiska vērtībaObligāts

Vai šis iestatījums ir ieslēgts.

Piemērs: false

expected_versionVesels skaitlisObligāts

Pirms rakstīšanas nolasītā versija; neatbilstības gadījumā izmaiņa tiek noraidīta.

minimum: 1maximum: 9223372036854775807

Piemērs: 1

Papildu lauki: Nē

audienceVirkneNeobligāts

Klienti

Ierobežojumi

enum

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

Noklusējums: "all"

benefit_typeVirkneNeobligāts

Datu struktūras variants, kuru apraksta atļautās vērtības.

Ierobežojumi

enum

["percentage", "fixed", "none"]

Noklusējums: "percentage"

category_idsMasīvs <Virkne> Neobligāts

Saistīto kategoriju identifikatori.

maxItems: 1000

Ierobežojumi · Masīvs 1

pattern

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

codeVirkne | nullNeobligāts

Stabils mašīnlasāms kods.

Ierobežojumi · Virkne 1

pattern

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

Piemērs: "LEARN10"

combine_couponsLoģiska vērtībaNeobligāts

Apvienot ar citiem kodiem

Noklusējums: false

combine_promotionsLoģiska vērtībaNeobligāts

Atļaut šo kodu produktiem ar automātiskām akcijām

Noklusējums: false

customer_idsMasīvs <Virkne> Neobligāts

Šim resursam saglabātā klienta informācija.

maxItems: 1000

Ierobežojumi · Masīvs 1

pattern

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

ends_atVirkne | nullNeobligāts

Aktīvs līdz

Virkne:format: "date-time"

expected_versionVesels skaitlisObligāts

Pirms rakstīšanas nolasītā versija; neatbilstības gadījumā izmaiņa tiek noraidīta.

minimum: 1maximum: 9223372036854775807

Piemērs: 1

free_shippingLoģiska vērtībaNeobligāts

Bezmaksas piegāde

Noklusējums: false

marketsMasīvs <MarketData-Input > Obligāts

Veikala kontekstā pieejamie tirgi.

minItems: 1maxItems: 1000

Piemērs: [{"currency":"PLN","market_id":"poland","minor_units":2}]

minimum_quantityVesels skaitlisNeobligāts

Minimālais preču skaits grozā

minimum: 1maximum: 2147483647

Noklusējums: 1

nameVirkneObligāts

Resursa nosaukums attiecīgajā kontekstā.

minLength: 1maxLength: 160

Piemērs: "Autumn guide offer"

per_customer_limitVesels skaitlisNeobligāts

Izmantošanas reižu limits vienam klientam

minimum: -1maximum: 2147483647

Noklusējums: -1

percentageVirkneNeobligāts

Procentuāla

maxLength: 19

Ierobežojumi

pattern

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

Noklusējums: "10"

product_idsMasīvs <Virkne> Neobligāts

Saistīto produktu identifikatori.

maxItems: 1000

Ierobežojumi · Masīvs 1

pattern

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

product_scopeVirkneNeobligāts

Produkti

Ierobežojumi

enum

["all", "selected"]

Noklusējums: "all"

show_accountLoģiska vērtībaNeobligāts

Klienta kontā

Noklusējums: false

show_cartLoģiska vērtībaNeobligāts

Grozā

Noklusējums: false

show_productLoģiska vērtībaNeobligāts

Produktu lapās

Noklusējums: false

starts_atVirkne | nullNeobligāts

Aktīvs no

Virkne:format: "date-time"

usage_limitVesels skaitlisNeobligāts

Izmantošanas reižu limits

minimum: -1maximum: 2147483647

Noklusējums: -1

Papildu lauki: Nē

kindVirkneObligāts

Datu struktūras variants, kuru apraksta atļautās vērtības.

Ierobežojumi

enum

["admin", "api"]

Piemērs: "admin"

labelVirkneObligāts

Resursa nosaukums attiecīgajā kontekstā.

Piemērs: "Editorial integration"

referenceVirkneObligāts

Norādītās entītijas identifikators.

Piemērs: "learn-api-key"

Papildu lauki: Nē

currencyVirkneObligāts

Summas valūtas kods.

Ierobežojumi

pattern

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

Piemērs: "PLN"

fixed_amountVirkneNeobligāts

Atlaides summa

maxLength: 19

Ierobežojumi

pattern

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

Noklusējums: "0"

market_idVirkneObligāts

Konteksta galapunkta atgrieztais tirgus identifikators.

Ierobežojumi

pattern

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

Piemērs: "poland"

maximum_priceVirkne | nullNeobligāts

Maksimālā produkta cena

Virkne:maxLength: 19

Ierobežojumi · Virkne 1

pattern

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

minimum_priceVirkne | nullNeobligāts

Minimālā produkta cena

Virkne:maxLength: 19

Ierobežojumi · Virkne 1

pattern

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

minimum_subtotalVirkneNeobligāts

Minimālā groza vērtība

maxLength: 19

Ierobežojumi

pattern

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

Noklusējums: "0"

minor_unitsVesels skaitlisObligāts

Valūtas izmantoto ciparu skaits aiz komata.

minimum: 0maximum: 4

Piemērs: 2

Papildu lauki: Nē

currencyVirkneObligāts

Summas valūtas kods.

Ierobežojumi

pattern

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

Piemērs: "PLN"

fixed_amountVirkneNeobligāts

Atlaides summa

maxLength: 19

Ierobežojumi

pattern

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

Noklusējums: "0"

market_idVirkneObligāts

Konteksta galapunkta atgrieztais tirgus identifikators.

Ierobežojumi

pattern

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

Piemērs: "poland"

maximum_priceVirkne | nullNeobligāts

Maksimālā produkta cena

Virkne:maxLength: 19

Ierobežojumi · Virkne 1

pattern

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

minimum_priceVirkne | nullNeobligāts

Minimālā produkta cena

Virkne:maxLength: 19

Ierobežojumi · Virkne 1

pattern

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

minimum_subtotalVirkneNeobligāts

Minimālā groza vērtība

maxLength: 19

Ierobežojumi

pattern

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

Noklusējums: "0"

minor_unitsVesels skaitlisObligāts

Valūtas izmantoto ciparu skaits aiz komata.

minimum: 0maximum: 4

Piemērs: 0

Papildu lauki: Nē