Schemi dei dati: Varianti e opzioni

Schemi dei dati: Varianti e opzioni. Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

Schemi dei dati

Elenca · Varianti del prodotto — Varianti e opzioni — Risposta

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

dataArray <ProductVariantData > Obbligatorio: Esempio di risposta · ApiResponse_list_ProductVariantData__.

Esempio: [{"active":true,"created_at":"2026-01-01T12:00:00Z","id":"example","is_default":true,"media_ids":["example"],"position":1,"pricing":{"base_adjustment":{"amount":"0.00","currency":"PLN","minor_units":2},"market_price":null,"price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"product_version":1,"version":1},"primary_media_id":"example","product_id":"example","sku":"example","updated_at":"2026-01-01T12:00:00Z","values":[{"option_id":"example","option_name":"example","value":"example","value_id":"example"}],"version":1}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Obbligatorio: Metadati della risposta.

Esempio: {"locale":"en","market_code":"PL","market_id":"example","pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Campi aggiuntivi: No

Elenca · Opzioni — Varianti e opzioni — Risposta

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

dataArray <shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData > Obbligatorio: Esempio di risposta · ApiResponse_list_VariantOptionData__.

Esempio: [{"created_at":"2026-01-01T12:00:00Z","id":"example","name":"Example","number":"example","position":1,"selection_type":"button","updated_at":"2026-01-01T12:00:00Z","value_presentation_type":"text","version":1}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Obbligatorio: Metadati della risposta.

Esempio: {"locale":"en","market_code":"PL","market_id":"example","pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Campi aggiuntivi: No

Elenca · Valori delle opzioni — Varianti e opzioni — Risposta

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

dataArray <VariantValueData > Obbligatorio: Esempio di risposta · ApiResponse_list_VariantValueData__.

Esempio: [{"color_hex":"#008855","created_at":"2026-01-01T12:00:00Z","id":"example","image_media_id":null,"number":"example","option_id":"example","position":1,"sku_code":"example","updated_at":"2026-01-01T12:00:00Z","value":"example","version":1}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Obbligatorio: Metadati della risposta.

Esempio: {"locale":"en","market_code":"PL","market_id":"example","pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Campi aggiuntivi: No

Recupera · Varianti del prodotto — Varianti e opzioni — Risposta

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

dataProductVariantData Obbligatorio: Esempio di risposta · ProductVariantData.

Esempio: {"active":true,"created_at":"2026-01-01T12:00:00Z","id":"example","is_default":true,"media_ids":["example"],"position":1,"pricing":{"base_adjustment":{"amount":"0.00","currency":"PLN","minor_units":2},"market_price":null,"price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"product_version":1,"version":1},"primary_media_id":"example","product_id":"example","sku":"example","updated_at":"2026-01-01T12:00:00Z","values":[{"option_id":"example","option_name":"example","value":"example","value_id":"example"}],"version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obbligatorio: Metadati della risposta.

Esempio: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Campi aggiuntivi: No

Recupera · Opzioni — Varianti e opzioni — Risposta

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

datashopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData Obbligatorio: Esempio di risposta · shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData.

Esempio: {"created_at":"2026-01-01T12:00:00Z","id":"example","name":"Example","number":"example","position":1,"selection_type":"button","updated_at":"2026-01-01T12:00:00Z","value_presentation_type":"text","version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obbligatorio: Metadati della risposta.

Esempio: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Campi aggiuntivi: No

Recupera · Valori delle opzioni — Varianti e opzioni — Risposta

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

dataVariantValueData Obbligatorio: Esempio di risposta · VariantValueData.

Esempio: {"color_hex":"#008855","created_at":"2026-01-01T12:00:00Z","id":"example","image_media_id":null,"number":"example","option_id":"example","position":1,"sku_code":"example","updated_at":"2026-01-01T12:00:00Z","value":"example","version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obbligatorio: Metadati della risposta.

Esempio: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Campi aggiuntivi: No

Recupera · Opzioni — Varianti e opzioni — Risposta

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

created_atStringaObbligatorio

Data e ora di creazione.

format: "date-time"

Esempio: "2026-01-01T12:00:00Z"

idStringaObbligatorio

Identificativo della risorsa; conservalo come restituito. (shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData).

Esempio: "example"

nameStringa nullObbligatorio

Nome della risorsa nel contesto pertinente.

Esempio: "Example"

numberStringaObbligatorio

Numero dell’ordine o della richiesta destinato alle persone.

Esempio: "example"

positionInteroObbligatorio

Posizione nella collezione ordinata.

Esempio: 1

selection_typeStringaObbligatorio

Modalità consentita di selezione dei valori delle caratteristiche.

Vincoli

enum: ["button", "dropdown"]

Esempio: "button"

updated_atStringaObbligatorio

Data e ora dell’aggiornamento più recente.

format: "date-time"

Esempio: "2026-01-01T12:00:00Z"

value_presentation_typeStringaObbligatorio

Modalità di presentazione dei valori del dizionario.

Vincoli

enum: ["text", "color", "image"]

Esempio: "text"

versionInteroObbligatorio

Versione della risorsa per il controllo della concorrenza.

Esempio: 1

Campi aggiuntivi: No

Recupera · Varianti del prodotto — Varianti e opzioni — Risposta

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

activeBooleanoObbligatorio: Indica se la risorsa è attiva.

Esempio: true
created_atStringaObbligatorio: Data e ora di creazione.

format: "date-time"

Esempio: "2026-01-01T12:00:00Z"
idStringaObbligatorio: Identificativo della risorsa; conservalo come restituito. (ProductVariantData).

Esempio: "example"
is_defaultBooleanoObbligatorio: Indica se è la scelta predefinita.

Esempio: true
media_idsArray <Stringa> Obbligatorio: Identificativi di media già esistenti.

Esempio: ["example"]
positionInteroObbligatorio: Posizione nella collezione ordinata.

Esempio: 1
pricingVariantPricingData Obbligatorio: Configurazione dei prezzi e relative versioni di concorrenza.

Esempio: {"base_adjustment":{"amount":"0.00","currency":"PLN","minor_units":2},"market_price":null,"price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"product_version":1,"version":1}
primary_media_idStringa nullObbligatorio: Identificativo del media principale.

Esempio: "example"
product_idStringaObbligatorio: Identificativo del prodotto.

Esempio: "example"
skuStringaObbligatorio: Codice di identificazione dell’articolo a magazzino.

Esempio: "example"
updated_atStringaObbligatorio: Data e ora dell’aggiornamento più recente.

format: "date-time"

Esempio: "2026-01-01T12:00:00Z"
valuesArray <VariantChoiceData > Obbligatorio: Valori del dizionario.

Esempio: [{"option_id":"example","option_name":"example","value":"example","value_id":"example"}]
versionInteroObbligatorio: Versione della risorsa per il controllo della concorrenza.

Esempio: 1

Campi aggiuntivi: No

Valori del dizionario

VariantChoiceData · Schema · Schemi dei dati: Varianti e opzioni

option_idStringaObbligatorio: Identificativo dell’opzione della variante.

Esempio: "example"
option_nameStringa nullObbligatorio: Nome dell’opzione della variante.

Esempio: "example"
valueStringa nullObbligatorio: Valore descritto dallo schema circostante.

Esempio: "example"
value_idStringaObbligatorio: Identificativo del valore del dizionario.

Esempio: "example"

Campi aggiuntivi: No

Crea · Varianti del prodotto — Varianti e opzioni — Corpo della richiesta

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

activeBooleanoFacoltativo

Indica se la risorsa è attiva.

Valore predefinito: true

expected_versionInteroObbligatorio

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

minimum: 1maximum: 9223372036854775807

Esempio: 1

is_defaultBooleanoFacoltativo

Indica se è la scelta predefinita.

media_idsArray <Stringa> Facoltativo

Identificativi di media già esistenti.

maxItems: 20

Array:minLength: 1maxLength: 63

pricingVariantPrice Facoltativo

Configurazione dei prezzi e relative versioni di concorrenza.

skuStringaFacoltativo

Codice di identificazione dell’articolo a magazzino.

minLength: 1maxLength: 100

Vincoli

pattern: "^\\S+$"

value_idsArray <Stringa> Obbligatorio

Identificativi dei valori del dizionario.

minItems: 1maxItems: 250

Array:minLength: 1maxLength: 63

Esempio: ["example"]

Campi aggiuntivi: No

Crea · Opzioni — Varianti e opzioni — Corpo della richiesta

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

nameStringaObbligatorio

Nome della risorsa nel contesto pertinente.

minLength: 1maxLength: 120

Vincoli

pattern: "^[^\\x00]*$"

Esempio: "Example"

selection_typeStringaFacoltativo

Modalità consentita di selezione dei valori delle caratteristiche.

Vincoli

enum: ["button", "dropdown"]

Valore predefinito: "button"

value_presentation_typeStringaFacoltativo

Modalità di presentazione dei valori del dizionario.

Vincoli

enum: ["text", "color", "image"]

Valore predefinito: "text"

Campi aggiuntivi: No

Aggiorna · Opzioni — Varianti e opzioni — Corpo della richiesta

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

expected_versionInteroObbligatorio

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

minimum: 1maximum: 9223372036854775807

Esempio: 1

nameStringa nullFacoltativo

Nome della risorsa nel contesto pertinente.

Stringa:minLength: 1maxLength: 120

Vincoli · Stringa 1

pattern: "^[^\\x00]*$"

Esempio: "Example"

selection_typeStringaFacoltativo

Modalità consentita di selezione dei valori delle caratteristiche.

Vincoli

enum: ["button", "dropdown"]

value_presentation_typeStringaFacoltativo

Modalità di presentazione dei valori del dizionario.

Vincoli

enum: ["text", "color", "image"]

Campi aggiuntivi: No

Configurazione dei prezzi e relative versioni di concorrenza

VariantPrice · Schema · Schemi dei dati: Varianti e opzioni

amountStringa nullObbligatorio

Importo decimale codificato come stringa JSON; null solo dove consentito.

Stringa:maxLength: 20

Vincoli · Stringa 1

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

Esempio: "0.00"

currencyStringaObbligatorio

Codice della valuta dell’importo.

Vincoli

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

Esempio: "PLN"

expected_price_list_versionInteroObbligatorio

Versione del listino letta in precedenza e richiesta per questa scrittura.

minimum: 1maximum: 9223372036854775807

Esempio: 1

expected_product_versionInteroObbligatorio

Versione del prodotto letta in precedenza e richiesta per questa scrittura.

minimum: 0maximum: 9223372036854775807

Esempio: 1

expected_versionInteroObbligatorio

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

minimum: 0maximum: 9223372036854775807

Esempio: 0

kindStringaObbligatorio

Forma della struttura dati, definita dai valori consentiti.

Vincoli

enum: ["base_adjustment", "market_fixed"]

Esempio: "base_adjustment"

price_list_idStringaObbligatorio

Identificativo del listino.

minLength: 1maxLength: 63

Esempio: "example"

Campi aggiuntivi: No

Configurazione dei prezzi e relative versioni di concorrenza

VariantPricingData · Schema · Schemi dei dati: Varianti e opzioni

base_adjustmentMoneyData Obbligatorio: Variazione del prezzo rispetto al prezzo base.

Esempio: {"amount":"0.00","currency":"PLN","minor_units":2}
market_priceMoneyData nullObbligatorio: Prezzo per il mercato selezionato.

Esempio: null
pricePriceData nullObbligatorio: Informazioni sul prezzo nel contesto selezionato.

Esempio: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
product_versionInteroObbligatorio: Versione corrente del prodotto per il controllo della concorrenza.

Esempio: 1
versionInteroObbligatorio: Versione della risorsa per il controllo della concorrenza.

Esempio: 1

Campi aggiuntivi: No

Aggiorna · Varianti del prodotto — Varianti e opzioni — Corpo della richiesta

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

activeBooleanoFacoltativo

Indica se la risorsa è attiva.

expected_versionInteroObbligatorio

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

minimum: 1maximum: 9223372036854775807

Esempio: 1

is_defaultBooleanoFacoltativo

Indica se è la scelta predefinita.

media_idsArray <Stringa> Facoltativo

Identificativi di media già esistenti.

maxItems: 20

Array:minLength: 1maxLength: 63

pricingVariantPrice Facoltativo

Configurazione dei prezzi e relative versioni di concorrenza.

Esempio:

{"amount":"0.00","currency":"PLN","expected_price_list_version":1,"expected_product_version":1,"expected_version":0,"kind":"base_adjustment","price_list_id":"example"}

skuStringaFacoltativo

Codice di identificazione dell’articolo a magazzino.

minLength: 1maxLength: 100

Vincoli

pattern: "^\\S+$"

Esempio: "example"

Campi aggiuntivi: No

Crea · Valori delle opzioni — Varianti e opzioni — Corpo della richiesta

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

color_hexStringa nullFacoltativo

Colore rappresentato da un codice esadecimale.

Vincoli · Stringa 1

pattern: "^#[0-9A-Fa-f]{6}$"

expected_versionInteroObbligatorio

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

minimum: 1maximum: 9223372036854775807

Esempio: 1

valueStringaObbligatorio

Valore descritto dallo schema circostante.

minLength: 1maxLength: 180

Vincoli

pattern: "^[^\\x00]*$"

Esempio: "Example"

Campi aggiuntivi: No

Recupera · Valori delle opzioni — Varianti e opzioni — Risposta

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

color_hexStringa nullObbligatorio: Colore rappresentato da un codice esadecimale.

Esempio: "#008855"
created_atStringaObbligatorio: Data e ora di creazione.

format: "date-time"

Esempio: "2026-01-01T12:00:00Z"
idStringaObbligatorio: Identificativo della risorsa; conservalo come restituito. (VariantValueData).

Esempio: "example"
image_media_idStringa nullObbligatorio: Identificativo del media immagine selezionato.

Esempio: null
numberStringaObbligatorio: Numero dell’ordine o della richiesta destinato alle persone.

Esempio: "example"
option_idStringaObbligatorio: Identificativo dell’opzione della variante.

Esempio: "example"
positionInteroObbligatorio: Posizione nella collezione ordinata.

Esempio: 1
sku_codeStringaObbligatorio: Codice di identificazione dell’articolo a magazzino.

Esempio: "example"
updated_atStringaObbligatorio: Data e ora dell’aggiornamento più recente.

format: "date-time"

Esempio: "2026-01-01T12:00:00Z"
valueStringa nullObbligatorio: Valore descritto dallo schema circostante.

Esempio: "example"
versionInteroObbligatorio: Versione della risorsa per il controllo della concorrenza.

Esempio: 1

Campi aggiuntivi: No

Aggiorna · Valori delle opzioni — Varianti e opzioni — Corpo della richiesta

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

color_hexStringa nullFacoltativo

Colore rappresentato da un codice esadecimale.

Vincoli · Stringa 1

pattern: "^#[0-9A-Fa-f]{6}$"

expected_versionInteroObbligatorio

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

minimum: 1maximum: 9223372036854775807

Esempio: 1

valueStringa nullFacoltativo

Valore descritto dallo schema circostante.

Stringa:minLength: 1maxLength: 180

Vincoli · Stringa 1

pattern: "^[^\\x00]*$"

Esempio: "Example"

Campi aggiuntivi: No