Vai al contenuto
ShopentlyLearn

Schemi dei dati: Prodotti

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

Schemi dei dati

Elenca — Prodotti — Risposta

ApiResponse_list_ProductSummaryData__ · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.
dataArray <ProductSummaryData > Obbligatorio

Esempio di risposta · ApiResponse_list_ProductSummaryData__.

Esempio: [{"availability":{"available_from":null,"available_until":null,"is_available":true},"brand_id":null,"condition":"new","created_at":"2026-01-01T12:00:00Z","id":"example","name":"Example","number":"example","price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"price_version":1,"primary_category_id":"example","primary_media_id":"example","published":false,"sku":"example","slug":"example","tax_category_id":"example","updated_at":"2026-01-01T12:00:00Z","variants_enabled":false,"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 — Prodotti — Risposta

ApiResponse_ProductDetailData_ · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.
dataProductDetailData Obbligatorio

Esempio di risposta · ProductDetailData.

Esempio: {"availability":{"available_from":null,"available_until":null,"is_available":true},"brand_id":null,"condition":"new","created_at":"2026-01-01T12:00:00Z","description":"example","features":[{"feature_id":"example","feature_name":"example","value":"example","value_id":"example"}],"id":"example","identifiers":{},"media":[{"alt_text":"example","id":"example","is_primary":true,"kind":"image","mime_type":"image/jpeg","position":1,"url":"https://example.invalid/product.jpg"}],"meta_description":"example","meta_keywords":["example"],"meta_title":"example","name":"Example","number":"example","price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"price_version":1,"primary_category_id":"example","primary_media_id":"example","published":false,"sku":"example","slug":"example","tax_category_id":"example","updated_at":"2026-01-01T12:00:00Z","variants_enabled":false,"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

Informazioni sulla disponibilità nel contesto selezionato

AvailabilityData · Schema · Schemi dei dati: Prodotti
available_fromStringa nullObbligatorio

Inizio della disponibilità.

Stringa:format: "date-time"
Esempio: null
available_untilStringa nullObbligatorio

Fine della disponibilità.

Stringa:format: "date-time"
Esempio: null
is_availableBooleanoObbligatorio

Indica se l’elemento è disponibile in questo contesto.

Esempio: true

Campi aggiuntivi: No

Informazioni sul prezzo nel contesto selezionato

PriceData · Schema · Schemi dei dati: Prodotti
amountStringaObbligatorio

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

Esempio: "0.00"
currencyStringaObbligatorio

Codice della valuta dell’importo.

Vincoli
pattern
"^[A-Z]{3}$"
Esempio: "PLN"
minor_unitsInteroObbligatorio

Numero di cifre decimali usate dalla valuta.

minimum: 0maximum: 4
Esempio: 2
tax_includedBooleanoObbligatorio

Indica se il prezzo inviato include le imposte.

Esempio: true

Campi aggiuntivi: No

Informazioni sul listino

PriceListData · Schema · Schemi dei dati: Prodotti
currencyStringaObbligatorio

Codice della valuta dell’importo.

idStringaObbligatorio

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

tax_includedBooleanoObbligatorio

Indica se il prezzo inviato include le imposte.

versionInteroObbligatorio

Versione della risorsa per il controllo della concorrenza.

Campi aggiuntivi: No

Crea — Prodotti — Corpo della richiesta

ProductCreate · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.
brand_idStringa nullFacoltativo

Identificativo del marchio.

Stringa:minLength: 1maxLength: 63
conditionStringaFacoltativo

Condizione del prodotto.

Vincoli
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Valore predefinito: "new"
descriptionStringa nullFacoltativo

Descrizione nella lingua selezionata.

Stringa:maxLength: 100000
feature_value_idsArray <Stringa> Facoltativo

Identificativi dei valori selezionati per le caratteristiche.

maxItems: 1000
Array:minLength: 1maxLength: 63
identifiersProductIdentifiers nullFacoltativo

Codici identificativi del prodotto.

market_idsArray <Stringa> Facoltativo

Identificativi dei mercati selezionati.

maxItems: 1000
Array:minLength: 1maxLength: 63
media_idsArray <Stringa> Facoltativo

Identificativi di media già esistenti.

maxItems: 20
Array:minLength: 1maxLength: 63
meta_descriptionStringa nullFacoltativo

Descrizione per i motori di ricerca nella lingua selezionata.

Stringa:maxLength: 160
meta_keywordsArray <Stringa> nullFacoltativo

Parole chiave per i motori di ricerca nella lingua selezionata.

Array:maxItems: 20
Array / Array:maxLength: 50
meta_titleStringa nullFacoltativo

Titolo per i motori di ricerca nella lingua selezionata.

Stringa:maxLength: 70
nameStringaObbligatorio

Nome della risorsa nel contesto pertinente.

minLength: 1maxLength: 300
Esempio: "Example"
pricingProductPrice Facoltativo

Configurazione dei prezzi e relative versioni di concorrenza.

primary_category_idStringa nullFacoltativo

Identificativo della categoria principale.

Stringa:minLength: 1maxLength: 63
publishedBooleanoFacoltativo

Indica se la risorsa è pubblicata.

Valore predefinito: false
skuStringaObbligatorio

Codice di identificazione dell’articolo a magazzino.

minLength: 1maxLength: 100
Vincoli
pattern
"^\\S+$"
Esempio: "example"
slugStringa nullFacoltativo

Segmento del percorso URL nella lingua selezionata.

Stringa:maxLength: 160
tax_category_idStringa nullFacoltativo

Identificativo della categoria fiscale.

Stringa:minLength: 1maxLength: 63
variant_value_idsArray <Stringa> Facoltativo

Identificativi dei valori selezionati per la variante.

maxItems: 250
Array:minLength: 1maxLength: 63
variants_enabledBooleanoFacoltativo

Indica se il prodotto utilizza varianti.

Valore predefinito: false

Campi aggiuntivi: No

Recupera — Prodotti — Risposta

ProductDetailData · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.
availabilityAvailabilityData Obbligatorio

Informazioni sulla disponibilità nel contesto selezionato.

Esempio: {"available_from":null,"available_until":null,"is_available":true}
brand_idStringa nullObbligatorio

Identificativo del marchio.

Esempio: null
conditionStringaObbligatorio

Condizione del prodotto.

Vincoli
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Esempio: "new"
created_atStringaObbligatorio

Data e ora di creazione.

format: "date-time"
Esempio: "2026-01-01T12:00:00Z"
descriptionStringa nullObbligatorio

Descrizione nella lingua selezionata.

Esempio: "example"
featuresArray <FeatureSelectionData > Obbligatorio

Caratteristiche del prodotto.

Esempio: [{"feature_id":"example","feature_name":"example","value":"example","value_id":"example"}]
idStringaObbligatorio

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

Esempio: "example"
identifiersOggettoCampi aggiuntivi: StringaObbligatorio

Codici identificativi del prodotto.

Esempio: {}
mediaArray <ProductMediaData > Obbligatorio

Informazioni sui media allegati.

Esempio: [{"alt_text":"example","id":"example","is_primary":true,"kind":"image","mime_type":"image/jpeg","position":1,"url":"https://example.invalid/product.jpg"}]
meta_descriptionStringa nullObbligatorio

Descrizione per i motori di ricerca nella lingua selezionata.

Esempio: "example"
meta_keywordsArray <Stringa> nullObbligatorio

Parole chiave per i motori di ricerca nella lingua selezionata.

Esempio: ["example"]
meta_titleStringa nullObbligatorio

Titolo per i motori di ricerca nella lingua selezionata.

Esempio: "example"
nameStringa nullObbligatorio

Nome della risorsa nel contesto pertinente.

Esempio: "Example"
numberStringaObbligatorio

Numero dell’ordine o della richiesta destinato alle persone.

Esempio: "example"
pricePriceData nullObbligatorio

Informazioni sul prezzo nel contesto selezionato.

Esempio: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
price_versionInteroObbligatorio

Versione corrente del prezzo per il controllo della concorrenza.

Esempio: 1
primary_category_idStringa nullObbligatorio

Identificativo della categoria principale.

Esempio: "example"
primary_media_idStringa nullObbligatorio

Identificativo del media principale.

Esempio: "example"
publishedBooleanoObbligatorio

Indica se la risorsa è pubblicata.

Esempio: false
skuStringaObbligatorio

Codice di identificazione dell’articolo a magazzino.

Esempio: "example"
slugStringa nullObbligatorio

Segmento del percorso URL nella lingua selezionata.

Esempio: "example"
tax_category_idStringaObbligatorio

Identificativo della categoria fiscale.

Esempio: "example"
updated_atStringaObbligatorio

Data e ora dell’aggiornamento più recente.

format: "date-time"
Esempio: "2026-01-01T12:00:00Z"
variants_enabledBooleanoObbligatorio

Indica se il prodotto utilizza varianti.

Esempio: false
versionInteroObbligatorio

Versione della risorsa per il controllo della concorrenza.

Esempio: 1

Campi aggiuntivi: No

Codici identificativi del prodotto

ProductIdentifiers · Schema · Schemi dei dati: Prodotti
eanStringa nullFacoltativo

Identificativo EAN del prodotto.

Stringa:minLength: 1maxLength: 100
isbnStringa nullFacoltativo

Identificativo ISBN.

Stringa:minLength: 1maxLength: 100
mpnStringa nullFacoltativo

Codice articolo del produttore.

Stringa:minLength: 1maxLength: 100
upcStringa nullFacoltativo

Identificativo UPC del prodotto.

Stringa:minLength: 1maxLength: 100

Campi aggiuntivi: No

Informazioni sui media allegati

ProductMediaData · Schema · Schemi dei dati: Prodotti
alt_textStringa nullObbligatorio

Testo alternativo dell’immagine.

Esempio: "example"
idStringaObbligatorio

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

Esempio: "example"
is_primaryBooleanoObbligatorio

Indica se è l’elemento principale.

Esempio: true
kindStringaObbligatorio

Forma della struttura dati, definita dai valori consentiti.

Vincoli
enum
["image", "video", "model_3d"]
Esempio: "image"
mime_typeStringaObbligatorio

Tipo di contenuto del media.

Esempio: "image/jpeg"
positionInteroObbligatorio

Posizione nella collezione ordinata.

Esempio: 1
urlStringa nullObbligatorio

URL della risorsa.

Esempio: "https://example.invalid/product.jpg"

Campi aggiuntivi: No

Configurazione dei prezzi e relative versioni di concorrenza

ProductPrice · Schema · Schemi dei dati: Prodotti
amountStringa nullObbligatorio

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

Stringa:maxLength: 19
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_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", "market_fixed"]
Esempio: "base"
price_list_idStringaObbligatorio

Identificativo del listino.

minLength: 1maxLength: 63
Esempio: "example"
tax_includedBooleanoObbligatorio

Indica se il prezzo inviato include le imposte.

Esempio: true

Campi aggiuntivi: No

Elenca — Prodotti — Risposta

ProductSummaryData · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.
availabilityAvailabilityData Obbligatorio

Informazioni sulla disponibilità nel contesto selezionato.

Esempio: {"available_from":null,"available_until":null,"is_available":true}
brand_idStringa nullObbligatorio

Identificativo del marchio.

Esempio: null
conditionStringaObbligatorio

Condizione del prodotto.

Vincoli
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Esempio: "new"
created_atStringaObbligatorio

Data e ora di creazione.

format: "date-time"
Esempio: "2026-01-01T12:00:00Z"
idStringaObbligatorio

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

Esempio: "example"
nameStringa nullObbligatorio

Nome della risorsa nel contesto pertinente.

Esempio: "Example"
numberStringaObbligatorio

Numero dell’ordine o della richiesta destinato alle persone.

Esempio: "example"
pricePriceData nullObbligatorio

Informazioni sul prezzo nel contesto selezionato.

Esempio: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
price_versionInteroObbligatorio

Versione corrente del prezzo per il controllo della concorrenza.

Esempio: 1
primary_category_idStringa nullObbligatorio

Identificativo della categoria principale.

Esempio: "example"
primary_media_idStringa nullObbligatorio

Identificativo del media principale.

Esempio: "example"
publishedBooleanoObbligatorio

Indica se la risorsa è pubblicata.

Esempio: false
skuStringaObbligatorio

Codice di identificazione dell’articolo a magazzino.

Esempio: "example"
slugStringa nullObbligatorio

Segmento del percorso URL nella lingua selezionata.

Esempio: "example"
tax_category_idStringaObbligatorio

Identificativo della categoria fiscale.

Esempio: "example"
updated_atStringaObbligatorio

Data e ora dell’aggiornamento più recente.

format: "date-time"
Esempio: "2026-01-01T12:00:00Z"
variants_enabledBooleanoObbligatorio

Indica se il prodotto utilizza varianti.

Esempio: false
versionInteroObbligatorio

Versione della risorsa per il controllo della concorrenza.

Esempio: 1

Campi aggiuntivi: No

Aggiorna — Prodotti — Corpo della richiesta

ProductUpdate · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.
brand_idStringa nullFacoltativo

Identificativo del marchio.

Stringa:minLength: 1maxLength: 63
conditionStringaFacoltativo

Condizione del prodotto.

Vincoli
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
descriptionStringa nullFacoltativo

Descrizione nella lingua selezionata.

Stringa:maxLength: 100000
Esempio: null
expected_variant_price_versionsOggettoCampi aggiuntivi: Intero
minimum: 0maximum: 9223372036854775807
Facoltativo

Versioni dei prezzi lette in precedenza, indicizzate per identificativo della variante.

maxProperties: 250
Vincoli
propertyNames
{"maxLength": 63, "minLength": 1}
expected_versionInteroObbligatorio

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

minimum: 1maximum: 9223372036854775807
Esempio: 1
feature_value_idsArray <Stringa> Facoltativo

Identificativi dei valori selezionati per le caratteristiche.

maxItems: 1000
Array:minLength: 1maxLength: 63
identifiersProductIdentifiers nullFacoltativo

Codici identificativi del prodotto.

market_idsArray <Stringa> Facoltativo

Identificativi dei mercati selezionati.

maxItems: 1000
Array:minLength: 1maxLength: 63
media_idsArray <Stringa> Facoltativo

Identificativi di media già esistenti.

maxItems: 20
Array:minLength: 1maxLength: 63
meta_descriptionStringa nullFacoltativo

Descrizione per i motori di ricerca nella lingua selezionata.

Stringa:maxLength: 160
meta_keywordsArray <Stringa> nullFacoltativo

Parole chiave per i motori di ricerca nella lingua selezionata.

Array:maxItems: 20
Array / Array:maxLength: 50
meta_titleStringa nullFacoltativo

Titolo per i motori di ricerca nella lingua selezionata.

Stringa:maxLength: 70
nameStringa nullFacoltativo

Nome della risorsa nel contesto pertinente.

Stringa:maxLength: 300
Esempio: null
pricingProductPrice Facoltativo

Configurazione dei prezzi e relative versioni di concorrenza.

Esempio: {"amount":"0.00","currency":"PLN","expected_price_list_version":1,"expected_version":0,"kind":"base","price_list_id":"example","tax_included":true}
primary_category_idStringa nullFacoltativo

Identificativo della categoria principale.

Stringa:minLength: 1maxLength: 63
publishedBooleanoFacoltativo

Indica se la risorsa è pubblicata.

skuStringaFacoltativo

Codice di identificazione dell’articolo a magazzino.

minLength: 1maxLength: 100
Vincoli
pattern
"^\\S+$"
Esempio: "example"
slugStringa nullFacoltativo

Segmento del percorso URL nella lingua selezionata.

Stringa:maxLength: 160
tax_category_idStringa nullFacoltativo

Identificativo della categoria fiscale.

Stringa:minLength: 1maxLength: 63
variant_value_idsArray <Stringa> Facoltativo

Identificativi dei valori selezionati per la variante.

maxItems: 250
Array:minLength: 1maxLength: 63
variants_enabledBooleanoFacoltativo

Indica se il prodotto utilizza varianti.

Campi aggiuntivi: No