Gegevensschema’s · Kortingen

Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

Gegevensschema’s

ApiResponse[CampaignData]

ApiResponse_CampaignData_ · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

dataCampaignData Verplicht: Gegevens van een geslaagd antwoord.

Voorbeeld: {"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 Verplicht: Metadata van het antwoord.

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

Aanvullende velden: Nee

ApiResponse[list[CampaignData]]

ApiResponse_list_CampaignData__ · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

dataArray <CampaignData > Verplicht: Gegevens van een geslaagd antwoord.

Voorbeeld: []
metaContextPageMeta ContextMeta PageMeta RequestMeta Verplicht: Metadata van het antwoord.

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

Aanvullende velden: Nee

CampaignCreate

CampaignCreate · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

audienceTekenreeksOptioneel

Klanten

Beperkingen

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

Standaard: "all"

benefit_typeTekenreeksOptioneel

Variant van de gegevensstructuur, zoals beschreven door de toegestane waarden.

Beperkingen

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

Standaard: "percentage"

category_idsArray <Tekenreeks> Optioneel

Identificaties van gerelateerde categorieën.

maxItems: 1000

Beperkingen · Array 1

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

codeTekenreeks nullOptioneel

Stabiele, machineleesbare code.

Beperkingen · Tekenreeks 1

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

Voorbeeld: "LEARN10"

combine_couponsBooleaanse waardeOptioneel

Combineren met andere codes

Standaard: false

combine_promotionsBooleaanse waardeOptioneel

Deze code toestaan voor producten met automatische promoties

Standaard: false

customer_idsArray <Tekenreeks> Optioneel

Klantgegevens die voor deze resource zijn vastgelegd.

maxItems: 1000

Beperkingen · Array 1

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

ends_atTekenreeks nullOptioneel

Actief tot

Tekenreeks:format: "date-time"

free_shippingBooleaanse waardeOptioneel

Gratis verzending

Standaard: false

marketsArray <MarketData-Input > Verplicht

Beschikbare markten binnen de winkelcontext.

minItems: 1maxItems: 1000

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

minimum_quantityGeheel getalOptioneel

Minimumaantal artikelen in de winkelwagen

minimum: 1maximum: 2147483647

Standaard: 1

nameTekenreeksVerplicht

Resourcenaam in de betreffende context.

minLength: 1maxLength: 160

Voorbeeld: "Autumn guide offer"

per_customer_limitGeheel getalOptioneel

Gebruikslimiet per klant

minimum: -1maximum: 2147483647

Standaard: -1

percentageTekenreeksOptioneel

Percentage

maxLength: 19

Beperkingen

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

Standaard: "10"

product_idsArray <Tekenreeks> Optioneel

Identificaties van gerelateerde producten.

maxItems: 1000

Beperkingen · Array 1

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

product_scopeTekenreeksOptioneel

Producten

Beperkingen

enum: ["all", "selected"]

Standaard: "all"

show_accountBooleaanse waardeOptioneel

In het klantaccount

Standaard: false

show_cartBooleaanse waardeOptioneel

In de winkelwagen

Standaard: false

show_productBooleaanse waardeOptioneel

Op productpagina's

Standaard: false

starts_atTekenreeks nullOptioneel

Actief vanaf

Tekenreeks:format: "date-time"

usage_limitGeheel getalOptioneel

Gebruikslimiet

minimum: -1maximum: 2147483647

Standaard: -1

Aanvullende velden: Nee

CampaignData

CampaignData · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

audienceTekenreeksOptioneel

Klanten

Beperkingen

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

Standaard: "all"

benefit_typeTekenreeksOptioneel

Variant van de gegevensstructuur, zoals beschreven door de toegestane waarden.

Beperkingen

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

Standaard: "percentage"

category_idsArray <Tekenreeks> Optioneel

Identificaties van gerelateerde categorieën.

maxItems: 1000

Beperkingen · Array 1

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

codeTekenreeks nullOptioneel

Stabiele, machineleesbare code.

Beperkingen · Tekenreeks 1

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

combine_couponsBooleaanse waardeOptioneel

Combineren met andere codes

Standaard: false

combine_promotionsBooleaanse waardeOptioneel

Deze code toestaan voor producten met automatische promoties

Standaard: false

created_atTekenreeksVerplicht

Tijdstip van aanmaak.

format: "date-time"

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

created_byCreatorData Verplicht

Aangemaakt door

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

customer_idsArray <Tekenreeks> Optioneel

Klantgegevens die voor deze resource zijn vastgelegd.

maxItems: 1000

Beperkingen · Array 1

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

enabledBooleaanse waardeVerplicht

Of deze instelling is ingeschakeld.

Voorbeeld: false

ends_atTekenreeks nullOptioneel

Actief tot

Tekenreeks:format: "date-time"

free_shippingBooleaanse waardeOptioneel

Gratis verzending

Standaard: false

idTekenreeksVerplicht

Resource-identificatie; bewaar deze zoals teruggegeven.

Voorbeeld: "example-campaign"

kindTekenreeksVerplicht

Variant van de gegevensstructuur, zoals beschreven door de toegestane waarden.

Beperkingen

enum: ["coupon", "promotion"]

Voorbeeld: "coupon"

marketsArray <shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData > Verplicht

Beschikbare markten binnen de winkelcontext.

minItems: 1maxItems: 1000

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

minimum_quantityGeheel getalOptioneel

Minimumaantal artikelen in de winkelwagen

minimum: 1maximum: 2147483647

Standaard: 1

nameTekenreeksVerplicht

Resourcenaam in de betreffende context.

minLength: 1maxLength: 160

Voorbeeld: "Autumn guide offer"

per_customer_limitGeheel getalOptioneel

Gebruikslimiet per klant

minimum: -1maximum: 2147483647

Standaard: -1

percentageTekenreeksOptioneel

Percentage

maxLength: 19

Beperkingen

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

Standaard: "10"

product_idsArray <Tekenreeks> Optioneel

Identificaties van gerelateerde producten.

maxItems: 1000

Beperkingen · Array 1

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

product_scopeTekenreeksOptioneel

Producten

Beperkingen

enum: ["all", "selected"]

Standaard: "all"

show_accountBooleaanse waardeOptioneel

In het klantaccount

Standaard: false

show_cartBooleaanse waardeOptioneel

In de winkelwagen

Standaard: false

show_productBooleaanse waardeOptioneel

Op productpagina's

Standaard: false

starts_atTekenreeks nullOptioneel

Actief vanaf

Tekenreeks:format: "date-time"

updated_atTekenreeksVerplicht

Tijdstip van de meest recente wijziging.

format: "date-time"

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

usage_limitGeheel getalOptioneel

Gebruikslimiet

minimum: -1maximum: 2147483647

Standaard: -1

used_countGeheel getalVerplicht

Aantal keer gebruikt

Voorbeeld: 0

versionGeheel getalVerplicht

Resourceversie voor controle op gelijktijdige wijzigingen.

Voorbeeld: 1

Aanvullende velden: Nee

CampaignStatus

CampaignStatus · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

enabledBooleaanse waardeVerplicht: Of deze instelling is ingeschakeld.

Voorbeeld: false
expected_versionGeheel getalVerplicht: Versie die vóór de schrijfbewerking is gelezen; bij afwijking wordt de wijziging geweigerd.

minimum: 1maximum: 9223372036854775807

Voorbeeld: 1

Aanvullende velden: Nee

CampaignUpdate

CampaignUpdate · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

audienceTekenreeksOptioneel

Klanten

Beperkingen

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

Standaard: "all"

benefit_typeTekenreeksOptioneel

Variant van de gegevensstructuur, zoals beschreven door de toegestane waarden.

Beperkingen

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

Standaard: "percentage"

category_idsArray <Tekenreeks> Optioneel

Identificaties van gerelateerde categorieën.

maxItems: 1000

Beperkingen · Array 1

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

codeTekenreeks nullOptioneel

Stabiele, machineleesbare code.

Beperkingen · Tekenreeks 1

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

Voorbeeld: "LEARN10"

combine_couponsBooleaanse waardeOptioneel

Combineren met andere codes

Standaard: false

combine_promotionsBooleaanse waardeOptioneel

Deze code toestaan voor producten met automatische promoties

Standaard: false

customer_idsArray <Tekenreeks> Optioneel

Klantgegevens die voor deze resource zijn vastgelegd.

maxItems: 1000

Beperkingen · Array 1

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

ends_atTekenreeks nullOptioneel

Actief tot

Tekenreeks:format: "date-time"

expected_versionGeheel getalVerplicht

Versie die vóór de schrijfbewerking is gelezen; bij afwijking wordt de wijziging geweigerd.

minimum: 1maximum: 9223372036854775807

Voorbeeld: 1

free_shippingBooleaanse waardeOptioneel

Gratis verzending

Standaard: false

marketsArray <MarketData-Input > Verplicht

Beschikbare markten binnen de winkelcontext.

minItems: 1maxItems: 1000

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

minimum_quantityGeheel getalOptioneel

Minimumaantal artikelen in de winkelwagen

minimum: 1maximum: 2147483647

Standaard: 1

nameTekenreeksVerplicht

Resourcenaam in de betreffende context.

minLength: 1maxLength: 160

Voorbeeld: "Autumn guide offer"

per_customer_limitGeheel getalOptioneel

Gebruikslimiet per klant

minimum: -1maximum: 2147483647

Standaard: -1

percentageTekenreeksOptioneel

Percentage

maxLength: 19

Beperkingen

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

Standaard: "10"

product_idsArray <Tekenreeks> Optioneel

Identificaties van gerelateerde producten.

maxItems: 1000

Beperkingen · Array 1

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

product_scopeTekenreeksOptioneel

Producten

Beperkingen

enum: ["all", "selected"]

Standaard: "all"

show_accountBooleaanse waardeOptioneel

In het klantaccount

Standaard: false

show_cartBooleaanse waardeOptioneel

In de winkelwagen

Standaard: false

show_productBooleaanse waardeOptioneel

Op productpagina's

Standaard: false

starts_atTekenreeks nullOptioneel

Actief vanaf

Tekenreeks:format: "date-time"

usage_limitGeheel getalOptioneel

Gebruikslimiet

minimum: -1maximum: 2147483647

Standaard: -1

Aanvullende velden: Nee

CreatorData

CreatorData · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

kindTekenreeksVerplicht

Variant van de gegevensstructuur, zoals beschreven door de toegestane waarden.

Beperkingen

enum: ["admin", "api"]

Voorbeeld: "admin"

labelTekenreeksVerplicht

Resourcenaam in de betreffende context.

Voorbeeld: "Editorial integration"

referenceTekenreeksVerplicht

Identificatie van de entiteit waarnaar wordt verwezen.

Voorbeeld: "learn-api-key"

Aanvullende velden: Nee

MarketData

MarketData-Input · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

currencyTekenreeksVerplicht

Valutacode voor het bedrag.

Beperkingen

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

Voorbeeld: "PLN"

fixed_amountTekenreeksOptioneel

Kortingsbedrag

maxLength: 19

Beperkingen

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

Standaard: "0"

market_idTekenreeksVerplicht

Marktidentificatie die het contextendpoint teruggeeft.

Beperkingen

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

Voorbeeld: "poland"

maximum_priceTekenreeks nullOptioneel

Maximale productprijs

Tekenreeks:maxLength: 19

Beperkingen · Tekenreeks 1

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

minimum_priceTekenreeks nullOptioneel

Minimale productprijs

Tekenreeks:maxLength: 19

Beperkingen · Tekenreeks 1

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

minimum_subtotalTekenreeksOptioneel

Minimale winkelwagenwaarde

maxLength: 19

Beperkingen

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

Standaard: "0"

minor_unitsGeheel getalVerplicht

Aantal decimalen van de valuta.

minimum: 0maximum: 4

Voorbeeld: 2

Aanvullende velden: Nee

MarketData

shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

currencyTekenreeksVerplicht

Valutacode voor het bedrag.

Beperkingen

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

Voorbeeld: "PLN"

fixed_amountTekenreeksOptioneel

Kortingsbedrag

maxLength: 19

Beperkingen

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

Standaard: "0"

market_idTekenreeksVerplicht

Marktidentificatie die het contextendpoint teruggeeft.

Beperkingen

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

Voorbeeld: "poland"

maximum_priceTekenreeks nullOptioneel

Maximale productprijs

Tekenreeks:maxLength: 19

Beperkingen · Tekenreeks 1

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

minimum_priceTekenreeks nullOptioneel

Minimale productprijs

Tekenreeks:maxLength: 19

Beperkingen · Tekenreeks 1

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

minimum_subtotalTekenreeksOptioneel

Minimale winkelwagenwaarde

maxLength: 19

Beperkingen

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

Standaard: "0"

minor_unitsGeheel getalVerplicht

Aantal decimalen van de valuta.

minimum: 0maximum: 4

Voorbeeld: 0

Aanvullende velden: Nee