Skemi tad-data · Skontijiet

L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

Skemi tad-data

ApiResponse[CampaignData]

ApiResponse_CampaignData_ · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

dataCampaignData Obbligatorju: Data ta’ tweġiba ta’ suċċess.

Eżempju: {"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 Obbligatorju: Metadata tat-tweġiba.

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

Oqsma addizzjonali: Le

ApiResponse[list[CampaignData]]

ApiResponse_list_CampaignData__ · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

dataArray <CampaignData > Obbligatorju: Data ta’ tweġiba ta’ suċċess.

Eżempju: []
metaContextPageMeta ContextMeta PageMeta RequestMeta Obbligatorju: Metadata tat-tweġiba.

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

Oqsma addizzjonali: Le

CampaignCreate

CampaignCreate · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

audienceStringMhux obbligatorju

Klijenti

Restrizzjonijiet

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

Valur predefinit: "all"

benefit_typeStringMhux obbligatorju

Varjant tal-istruttura tad-data deskritt mill-valuri permessi tiegħu.

Restrizzjonijiet

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

Valur predefinit: "percentage"

category_idsArray <String> Mhux obbligatorju

Identifikaturi tal-kategoriji relatati.

maxItems: 1000

Restrizzjonijiet · Array 1

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

codeString nullMhux obbligatorju

Kodiċi stabbli li jista’ jinqara minn magna.

Restrizzjonijiet · String 1

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

Eżempju: "LEARN10"

combine_couponsBooleanMhux obbligatorju

Għaqqad ma’ kodiċijiet oħra

Valur predefinit: false

combine_promotionsBooleanMhux obbligatorju

Ħalli dan il-kodiċi jintuża fuq prodotti bi promozzjonijiet awtomatiċi

Valur predefinit: false

customer_idsArray <String> Mhux obbligatorju

Informazzjoni tal-klijent irreġistrata għal din ir-riżorsa.

maxItems: 1000

Restrizzjonijiet · Array 1

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

ends_atString nullMhux obbligatorju

Attiv sa

String:format: "date-time"

free_shippingBooleanMhux obbligatorju

Kunsinna b'xejn

Valur predefinit: false

marketsArray <MarketData-Input > Obbligatorju

Swieq disponibbli fil-kuntest tal-ħanut.

minItems: 1maxItems: 1000

Eżempju: [{"currency":"PLN","market_id":"poland","minor_units":2}]

minimum_quantityNumru sħiħMhux obbligatorju

Numru minimu ta' oġġetti fil-basket

minimum: 1maximum: 2147483647

Valur predefinit: 1

nameStringObbligatorju

Isem tar-riżorsa fil-kuntest rilevanti.

minLength: 1maxLength: 160

Eżempju: "Autumn guide offer"

per_customer_limitNumru sħiħMhux obbligatorju

Limitu ta' użi għal kull klijent

minimum: -1maximum: 2147483647

Valur predefinit: -1

percentageStringMhux obbligatorju

Perċentwal

maxLength: 19

Restrizzjonijiet

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

Valur predefinit: "10"

product_idsArray <String> Mhux obbligatorju

Identifikaturi tal-prodotti relatati.

maxItems: 1000

Restrizzjonijiet · Array 1

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

product_scopeStringMhux obbligatorju

Prodotti

Restrizzjonijiet

enum: ["all", "selected"]

Valur predefinit: "all"

show_accountBooleanMhux obbligatorju

Fil-kont tal-klijent

Valur predefinit: false

show_cartBooleanMhux obbligatorju

Fil-basket

Valur predefinit: false

show_productBooleanMhux obbligatorju

Fil-paġni tal-prodotti

Valur predefinit: false

starts_atString nullMhux obbligatorju

Attiv minn

String:format: "date-time"

usage_limitNumru sħiħMhux obbligatorju

Limitu ta' użi

minimum: -1maximum: 2147483647

Valur predefinit: -1

Oqsma addizzjonali: Le

CampaignData

CampaignData · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

audienceStringMhux obbligatorju

Klijenti

Restrizzjonijiet

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

Valur predefinit: "all"

benefit_typeStringMhux obbligatorju

Varjant tal-istruttura tad-data deskritt mill-valuri permessi tiegħu.

Restrizzjonijiet

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

Valur predefinit: "percentage"

category_idsArray <String> Mhux obbligatorju

Identifikaturi tal-kategoriji relatati.

maxItems: 1000

Restrizzjonijiet · Array 1

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

codeString nullMhux obbligatorju

Kodiċi stabbli li jista’ jinqara minn magna.

Restrizzjonijiet · String 1

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

combine_couponsBooleanMhux obbligatorju

Għaqqad ma’ kodiċijiet oħra

Valur predefinit: false

combine_promotionsBooleanMhux obbligatorju

Ħalli dan il-kodiċi jintuża fuq prodotti bi promozzjonijiet awtomatiċi

Valur predefinit: false

created_atStringObbligatorju

Ħin tal-ħolqien.

format: "date-time"

Eżempju: "2026-10-07T10:00:00Z"

created_byCreatorData Obbligatorju

Maħluq minn

Eżempju: {"kind":"admin","label":"Editorial integration","reference":"learn-api-key"}

customer_idsArray <String> Mhux obbligatorju

Informazzjoni tal-klijent irreġistrata għal din ir-riżorsa.

maxItems: 1000

Restrizzjonijiet · Array 1

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

enabledBooleanObbligatorju

Jekk dan l-issettjar huwiex attivat.

Eżempju: false

ends_atString nullMhux obbligatorju

Attiv sa

String:format: "date-time"

free_shippingBooleanMhux obbligatorju

Kunsinna b'xejn

Valur predefinit: false

idStringObbligatorju

Identifikatur tar-riżorsa; żommu kif mogħti.

Eżempju: "example-campaign"

kindStringObbligatorju

Varjant tal-istruttura tad-data deskritt mill-valuri permessi tiegħu.

Restrizzjonijiet

enum: ["coupon", "promotion"]

Eżempju: "coupon"

marketsArray <shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData > Obbligatorju

Swieq disponibbli fil-kuntest tal-ħanut.

minItems: 1maxItems: 1000

Eżempju: [{"currency":"PLN","market_id":"poland","minor_units":0}]

minimum_quantityNumru sħiħMhux obbligatorju

Numru minimu ta' oġġetti fil-basket

minimum: 1maximum: 2147483647

Valur predefinit: 1

nameStringObbligatorju

Isem tar-riżorsa fil-kuntest rilevanti.

minLength: 1maxLength: 160

Eżempju: "Autumn guide offer"

per_customer_limitNumru sħiħMhux obbligatorju

Limitu ta' użi għal kull klijent

minimum: -1maximum: 2147483647

Valur predefinit: -1

percentageStringMhux obbligatorju

Perċentwal

maxLength: 19

Restrizzjonijiet

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

Valur predefinit: "10"

product_idsArray <String> Mhux obbligatorju

Identifikaturi tal-prodotti relatati.

maxItems: 1000

Restrizzjonijiet · Array 1

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

product_scopeStringMhux obbligatorju

Prodotti

Restrizzjonijiet

enum: ["all", "selected"]

Valur predefinit: "all"

show_accountBooleanMhux obbligatorju

Fil-kont tal-klijent

Valur predefinit: false

show_cartBooleanMhux obbligatorju

Fil-basket

Valur predefinit: false

show_productBooleanMhux obbligatorju

Fil-paġni tal-prodotti

Valur predefinit: false

starts_atString nullMhux obbligatorju

Attiv minn

String:format: "date-time"

updated_atStringObbligatorju

Ħin tal-aktar aġġornament reċenti.

format: "date-time"

Eżempju: "2026-10-07T10:00:00Z"

usage_limitNumru sħiħMhux obbligatorju

Limitu ta' użi

minimum: -1maximum: 2147483647

Valur predefinit: -1

used_countNumru sħiħObbligatorju

Użi mwettqa

Eżempju: 0

versionNumru sħiħObbligatorju

Verżjoni tar-riżorsa għall-kontroll tal-konkorrenza.

Eżempju: 1

Oqsma addizzjonali: Le

CampaignStatus

CampaignStatus · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

enabledBooleanObbligatorju: Jekk dan l-issettjar huwiex attivat.

Eżempju: false
expected_versionNumru sħiħObbligatorju: Verżjoni li nqrat qabel il-kitba; nuqqas ta’ qbil jirrifjuta l-aġġornament.

minimum: 1maximum: 9223372036854775807

Eżempju: 1

Oqsma addizzjonali: Le

CampaignUpdate

CampaignUpdate · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

audienceStringMhux obbligatorju

Klijenti

Restrizzjonijiet

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

Valur predefinit: "all"

benefit_typeStringMhux obbligatorju

Varjant tal-istruttura tad-data deskritt mill-valuri permessi tiegħu.

Restrizzjonijiet

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

Valur predefinit: "percentage"

category_idsArray <String> Mhux obbligatorju

Identifikaturi tal-kategoriji relatati.

maxItems: 1000

Restrizzjonijiet · Array 1

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

codeString nullMhux obbligatorju

Kodiċi stabbli li jista’ jinqara minn magna.

Restrizzjonijiet · String 1

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

Eżempju: "LEARN10"

combine_couponsBooleanMhux obbligatorju

Għaqqad ma’ kodiċijiet oħra

Valur predefinit: false

combine_promotionsBooleanMhux obbligatorju

Ħalli dan il-kodiċi jintuża fuq prodotti bi promozzjonijiet awtomatiċi

Valur predefinit: false

customer_idsArray <String> Mhux obbligatorju

Informazzjoni tal-klijent irreġistrata għal din ir-riżorsa.

maxItems: 1000

Restrizzjonijiet · Array 1

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

ends_atString nullMhux obbligatorju

Attiv sa

String:format: "date-time"

expected_versionNumru sħiħObbligatorju

Verżjoni li nqrat qabel il-kitba; nuqqas ta’ qbil jirrifjuta l-aġġornament.

minimum: 1maximum: 9223372036854775807

Eżempju: 1

free_shippingBooleanMhux obbligatorju

Kunsinna b'xejn

Valur predefinit: false

marketsArray <MarketData-Input > Obbligatorju

Swieq disponibbli fil-kuntest tal-ħanut.

minItems: 1maxItems: 1000

Eżempju: [{"currency":"PLN","market_id":"poland","minor_units":2}]

minimum_quantityNumru sħiħMhux obbligatorju

Numru minimu ta' oġġetti fil-basket

minimum: 1maximum: 2147483647

Valur predefinit: 1

nameStringObbligatorju

Isem tar-riżorsa fil-kuntest rilevanti.

minLength: 1maxLength: 160

Eżempju: "Autumn guide offer"

per_customer_limitNumru sħiħMhux obbligatorju

Limitu ta' użi għal kull klijent

minimum: -1maximum: 2147483647

Valur predefinit: -1

percentageStringMhux obbligatorju

Perċentwal

maxLength: 19

Restrizzjonijiet

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

Valur predefinit: "10"

product_idsArray <String> Mhux obbligatorju

Identifikaturi tal-prodotti relatati.

maxItems: 1000

Restrizzjonijiet · Array 1

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

product_scopeStringMhux obbligatorju

Prodotti

Restrizzjonijiet

enum: ["all", "selected"]

Valur predefinit: "all"

show_accountBooleanMhux obbligatorju

Fil-kont tal-klijent

Valur predefinit: false

show_cartBooleanMhux obbligatorju

Fil-basket

Valur predefinit: false

show_productBooleanMhux obbligatorju

Fil-paġni tal-prodotti

Valur predefinit: false

starts_atString nullMhux obbligatorju

Attiv minn

String:format: "date-time"

usage_limitNumru sħiħMhux obbligatorju

Limitu ta' użi

minimum: -1maximum: 2147483647

Valur predefinit: -1

Oqsma addizzjonali: Le

CreatorData

CreatorData · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

kindStringObbligatorju

Varjant tal-istruttura tad-data deskritt mill-valuri permessi tiegħu.

Restrizzjonijiet

enum: ["admin", "api"]

Eżempju: "admin"

labelStringObbligatorju

Isem tar-riżorsa fil-kuntest rilevanti.

Eżempju: "Editorial integration"

referenceStringObbligatorju

Identifikatur tal-entità referenzjata.

Eżempju: "learn-api-key"

Oqsma addizzjonali: Le

MarketData

MarketData-Input · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

currencyStringObbligatorju

Kodiċi tal-munita tal-ammont.

Restrizzjonijiet

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

Eżempju: "PLN"

fixed_amountStringMhux obbligatorju

Ammont tal-iskont

maxLength: 19

Restrizzjonijiet

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

Valur predefinit: "0"

market_idStringObbligatorju

Identifikatur tas-suq mogħti mill-endpoint tal-kuntest.

Restrizzjonijiet

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

Eżempju: "poland"

maximum_priceString nullMhux obbligatorju

Prezz massimu tal-prodott

String:maxLength: 19

Restrizzjonijiet · String 1

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

minimum_priceString nullMhux obbligatorju

Prezz minimu tal-prodott

String:maxLength: 19

Restrizzjonijiet · String 1

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

minimum_subtotalStringMhux obbligatorju

Valur minimu tal-basket

maxLength: 19

Restrizzjonijiet

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

Valur predefinit: "0"

minor_unitsNumru sħiħObbligatorju

Numru ta’ ċifri deċimali użati mill-munita.

minimum: 0maximum: 4

Eżempju: 2

Oqsma addizzjonali: Le

MarketData

shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

currencyStringObbligatorju

Kodiċi tal-munita tal-ammont.

Restrizzjonijiet

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

Eżempju: "PLN"

fixed_amountStringMhux obbligatorju

Ammont tal-iskont

maxLength: 19

Restrizzjonijiet

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

Valur predefinit: "0"

market_idStringObbligatorju

Identifikatur tas-suq mogħti mill-endpoint tal-kuntest.

Restrizzjonijiet

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

Eżempju: "poland"

maximum_priceString nullMhux obbligatorju

Prezz massimu tal-prodott

String:maxLength: 19

Restrizzjonijiet · String 1

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

minimum_priceString nullMhux obbligatorju

Prezz minimu tal-prodott

String:maxLength: 19

Restrizzjonijiet · String 1

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

minimum_subtotalStringMhux obbligatorju

Valur minimu tal-basket

maxLength: 19

Restrizzjonijiet

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

Valur predefinit: "0"

minor_unitsNumru sħiħObbligatorju

Numru ta’ ċifri deċimali użati mill-munita.

minimum: 0maximum: 4

Eżempju: 0

Oqsma addizzjonali: Le