Schemi dei dati · Sconti

Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

Schemi dei dati

ApiResponse[CampaignData]

ApiResponse_CampaignData_ · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

dataCampaignData Obbligatorio: Contenuto di una risposta riuscita.

Esempio: {"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 Obbligatorio: Metadati della risposta.

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

Campi aggiuntivi: No

ApiResponse[list[CampaignData]]

ApiResponse_list_CampaignData__ · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

dataArray <CampaignData > Obbligatorio: Contenuto di una risposta riuscita.

Esempio: []
metaContextPageMeta ContextMeta PageMeta RequestMeta Obbligatorio: Metadati della risposta.

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

Campi aggiuntivi: No

CampaignCreate

CampaignCreate · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

audienceStringaFacoltativo

Clienti

Vincoli

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

Valore predefinito: "all"

benefit_typeStringaFacoltativo

Forma della struttura dati, definita dai valori consentiti.

Vincoli

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

Valore predefinito: "percentage"

category_idsArray <Stringa> Facoltativo

Identificativi delle categorie collegate.

maxItems: 1000

Vincoli · Array 1

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

codeStringa nullFacoltativo

Codice stabile interpretabile dal software.

Vincoli · Stringa 1

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

Esempio: "LEARN10"

combine_couponsBooleanoFacoltativo

Combina con altri codici

Valore predefinito: false

combine_promotionsBooleanoFacoltativo

Consenti questo codice sui prodotti con promozioni automatiche

Valore predefinito: false

customer_idsArray <Stringa> Facoltativo

Dati del cliente registrati per questa risorsa.

maxItems: 1000

Vincoli · Array 1

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

ends_atStringa nullFacoltativo

Attivo fino al

Stringa:format: "date-time"

free_shippingBooleanoFacoltativo

Spedizione gratuita

Valore predefinito: false

marketsArray <MarketData-Input > Obbligatorio

Mercati disponibili nel contesto del negozio.

minItems: 1maxItems: 1000

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

minimum_quantityInteroFacoltativo

Numero minimo di articoli nel carrello

minimum: 1maximum: 2147483647

Valore predefinito: 1

nameStringaObbligatorio

Nome della risorsa nel contesto pertinente.

minLength: 1maxLength: 160

Esempio: "Autumn guide offer"

per_customer_limitInteroFacoltativo

Limite di utilizzi per cliente

minimum: -1maximum: 2147483647

Valore predefinito: -1

percentageStringaFacoltativo

Percentuale

maxLength: 19

Vincoli

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

Valore predefinito: "10"

product_idsArray <Stringa> Facoltativo

Identificativi dei prodotti collegati.

maxItems: 1000

Vincoli · Array 1

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

product_scopeStringaFacoltativo

Prodotti

Vincoli

enum: ["all", "selected"]

Valore predefinito: "all"

show_accountBooleanoFacoltativo

Nell'account cliente

Valore predefinito: false

show_cartBooleanoFacoltativo

Nel carrello

Valore predefinito: false

show_productBooleanoFacoltativo

Nelle pagine prodotto

Valore predefinito: false

starts_atStringa nullFacoltativo

Attivo dal

Stringa:format: "date-time"

usage_limitInteroFacoltativo

Limite di utilizzi

minimum: -1maximum: 2147483647

Valore predefinito: -1

Campi aggiuntivi: No

CampaignData

CampaignData · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

audienceStringaFacoltativo

Clienti

Vincoli

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

Valore predefinito: "all"

benefit_typeStringaFacoltativo

Forma della struttura dati, definita dai valori consentiti.

Vincoli

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

Valore predefinito: "percentage"

category_idsArray <Stringa> Facoltativo

Identificativi delle categorie collegate.

maxItems: 1000

Vincoli · Array 1

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

codeStringa nullFacoltativo

Codice stabile interpretabile dal software.

Vincoli · Stringa 1

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

combine_couponsBooleanoFacoltativo

Combina con altri codici

Valore predefinito: false

combine_promotionsBooleanoFacoltativo

Consenti questo codice sui prodotti con promozioni automatiche

Valore predefinito: false

created_atStringaObbligatorio

Data e ora di creazione.

format: "date-time"

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

created_byCreatorData Obbligatorio

Creato da

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

customer_idsArray <Stringa> Facoltativo

Dati del cliente registrati per questa risorsa.

maxItems: 1000

Vincoli · Array 1

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

enabledBooleanoObbligatorio

Indica se questa impostazione è abilitata.

Esempio: false

ends_atStringa nullFacoltativo

Attivo fino al

Stringa:format: "date-time"

free_shippingBooleanoFacoltativo

Spedizione gratuita

Valore predefinito: false

idStringaObbligatorio

Identificativo della risorsa; conservalo come restituito.

Esempio: "example-campaign"

kindStringaObbligatorio

Forma della struttura dati, definita dai valori consentiti.

Vincoli

enum: ["coupon", "promotion"]

Esempio: "coupon"

marketsArray <shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData > Obbligatorio

Mercati disponibili nel contesto del negozio.

minItems: 1maxItems: 1000

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

minimum_quantityInteroFacoltativo

Numero minimo di articoli nel carrello

minimum: 1maximum: 2147483647

Valore predefinito: 1

nameStringaObbligatorio

Nome della risorsa nel contesto pertinente.

minLength: 1maxLength: 160

Esempio: "Autumn guide offer"

per_customer_limitInteroFacoltativo

Limite di utilizzi per cliente

minimum: -1maximum: 2147483647

Valore predefinito: -1

percentageStringaFacoltativo

Percentuale

maxLength: 19

Vincoli

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

Valore predefinito: "10"

product_idsArray <Stringa> Facoltativo

Identificativi dei prodotti collegati.

maxItems: 1000

Vincoli · Array 1

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

product_scopeStringaFacoltativo

Prodotti

Vincoli

enum: ["all", "selected"]

Valore predefinito: "all"

show_accountBooleanoFacoltativo

Nell'account cliente

Valore predefinito: false

show_cartBooleanoFacoltativo

Nel carrello

Valore predefinito: false

show_productBooleanoFacoltativo

Nelle pagine prodotto

Valore predefinito: false

starts_atStringa nullFacoltativo

Attivo dal

Stringa:format: "date-time"

updated_atStringaObbligatorio

Data e ora dell’aggiornamento più recente.

format: "date-time"

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

usage_limitInteroFacoltativo

Limite di utilizzi

minimum: -1maximum: 2147483647

Valore predefinito: -1

used_countInteroObbligatorio

Utilizzi effettuati

Esempio: 0

versionInteroObbligatorio

Versione della risorsa per il controllo della concorrenza.

Esempio: 1

Campi aggiuntivi: No

CampaignStatus

CampaignStatus · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

enabledBooleanoObbligatorio: Indica se questa impostazione è abilitata.

Esempio: false
expected_versionInteroObbligatorio: Versione letta prima della scrittura; una differenza impedisce l’aggiornamento.

minimum: 1maximum: 9223372036854775807

Esempio: 1

Campi aggiuntivi: No

CampaignUpdate

CampaignUpdate · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

audienceStringaFacoltativo

Clienti

Vincoli

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

Valore predefinito: "all"

benefit_typeStringaFacoltativo

Forma della struttura dati, definita dai valori consentiti.

Vincoli

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

Valore predefinito: "percentage"

category_idsArray <Stringa> Facoltativo

Identificativi delle categorie collegate.

maxItems: 1000

Vincoli · Array 1

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

codeStringa nullFacoltativo

Codice stabile interpretabile dal software.

Vincoli · Stringa 1

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

Esempio: "LEARN10"

combine_couponsBooleanoFacoltativo

Combina con altri codici

Valore predefinito: false

combine_promotionsBooleanoFacoltativo

Consenti questo codice sui prodotti con promozioni automatiche

Valore predefinito: false

customer_idsArray <Stringa> Facoltativo

Dati del cliente registrati per questa risorsa.

maxItems: 1000

Vincoli · Array 1

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

ends_atStringa nullFacoltativo

Attivo fino al

Stringa:format: "date-time"

expected_versionInteroObbligatorio

Versione letta prima della scrittura; una differenza impedisce l’aggiornamento.

minimum: 1maximum: 9223372036854775807

Esempio: 1

free_shippingBooleanoFacoltativo

Spedizione gratuita

Valore predefinito: false

marketsArray <MarketData-Input > Obbligatorio

Mercati disponibili nel contesto del negozio.

minItems: 1maxItems: 1000

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

minimum_quantityInteroFacoltativo

Numero minimo di articoli nel carrello

minimum: 1maximum: 2147483647

Valore predefinito: 1

nameStringaObbligatorio

Nome della risorsa nel contesto pertinente.

minLength: 1maxLength: 160

Esempio: "Autumn guide offer"

per_customer_limitInteroFacoltativo

Limite di utilizzi per cliente

minimum: -1maximum: 2147483647

Valore predefinito: -1

percentageStringaFacoltativo

Percentuale

maxLength: 19

Vincoli

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

Valore predefinito: "10"

product_idsArray <Stringa> Facoltativo

Identificativi dei prodotti collegati.

maxItems: 1000

Vincoli · Array 1

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

product_scopeStringaFacoltativo

Prodotti

Vincoli

enum: ["all", "selected"]

Valore predefinito: "all"

show_accountBooleanoFacoltativo

Nell'account cliente

Valore predefinito: false

show_cartBooleanoFacoltativo

Nel carrello

Valore predefinito: false

show_productBooleanoFacoltativo

Nelle pagine prodotto

Valore predefinito: false

starts_atStringa nullFacoltativo

Attivo dal

Stringa:format: "date-time"

usage_limitInteroFacoltativo

Limite di utilizzi

minimum: -1maximum: 2147483647

Valore predefinito: -1

Campi aggiuntivi: No

CreatorData

CreatorData · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

kindStringaObbligatorio

Forma della struttura dati, definita dai valori consentiti.

Vincoli

enum: ["admin", "api"]

Esempio: "admin"

labelStringaObbligatorio

Nome della risorsa nel contesto pertinente.

Esempio: "Editorial integration"

referenceStringaObbligatorio

Identificativo dell’entità referenziata.

Esempio: "learn-api-key"

Campi aggiuntivi: No

MarketData

MarketData-Input · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

currencyStringaObbligatorio

Codice della valuta dell’importo.

Vincoli

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

Esempio: "PLN"

fixed_amountStringaFacoltativo

Importo dello sconto

maxLength: 19

Vincoli

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

Valore predefinito: "0"

market_idStringaObbligatorio

Identificativo del mercato restituito dall’endpoint del contesto.

Vincoli

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

Esempio: "poland"

maximum_priceStringa nullFacoltativo

Prezzo massimo del prodotto

Stringa:maxLength: 19

Vincoli · Stringa 1

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

minimum_priceStringa nullFacoltativo

Prezzo minimo del prodotto

Stringa:maxLength: 19

Vincoli · Stringa 1

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

minimum_subtotalStringaFacoltativo

Valore minimo del carrello

maxLength: 19

Vincoli

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

Valore predefinito: "0"

minor_unitsInteroObbligatorio

Numero di cifre decimali usate dalla valuta.

minimum: 0maximum: 4

Esempio: 2

Campi aggiuntivi: No

MarketData

shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

currencyStringaObbligatorio

Codice della valuta dell’importo.

Vincoli

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

Esempio: "PLN"

fixed_amountStringaFacoltativo

Importo dello sconto

maxLength: 19

Vincoli

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

Valore predefinito: "0"

market_idStringaObbligatorio

Identificativo del mercato restituito dall’endpoint del contesto.

Vincoli

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

Esempio: "poland"

maximum_priceStringa nullFacoltativo

Prezzo massimo del prodotto

Stringa:maxLength: 19

Vincoli · Stringa 1

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

minimum_priceStringa nullFacoltativo

Prezzo minimo del prodotto

Stringa:maxLength: 19

Vincoli · Stringa 1

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

minimum_subtotalStringaFacoltativo

Valore minimo del carrello

maxLength: 19

Vincoli

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

Valore predefinito: "0"

minor_unitsInteroObbligatorio

Numero di cifre decimali usate dalla valuta.

minimum: 0maximum: 4

Esempio: 0

Campi aggiuntivi: No