Schemi dei dati
Elenca — Prodotti — Risposta
ApiResponse_list_ProductSummaryData__ · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.
dataArray <ProductSummaryData> ObbligatorioEsempio di risposta · ApiResponse_list_ProductSummaryData__.
metaContextPageMetaContextMetaPageMetaRequestMetaObbligatorioMetadati della risposta.
Campi aggiuntivi: No
Recupera — Prodotti — Risposta
ApiResponse_ProductDetailData_ · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.
dataProductDetailDataObbligatorioEsempio di risposta · ProductDetailData.
metaContextPageMetaContextMetaPageMetaRequestMetaObbligatorioMetadati della risposta.
Campi aggiuntivi: No
Informazioni sulla disponibilità nel contesto selezionato
AvailabilityData · Schema · Schemi dei dati: Prodotti
available_fromStringa nullObbligatorioInizio della disponibilità.
Stringa:format:"date-time"available_untilStringa nullObbligatorioFine della disponibilità.
Stringa:format:"date-time"is_availableBooleanoObbligatorioIndica se l’elemento è disponibile in questo contesto.
Campi aggiuntivi: No
Informazioni sul prezzo nel contesto selezionato
PriceData · Schema · Schemi dei dati: Prodotti
amountStringaObbligatorioImporto decimale codificato come stringa JSON; null solo dove consentito.
currencyStringaObbligatorioCodice della valuta dell’importo.
Vincoli
pattern"^[A-Z]{3}$"
minor_unitsInteroObbligatorioNumero di cifre decimali usate dalla valuta.
minimum:0maximum:4tax_includedBooleanoObbligatorioIndica se il prezzo inviato include le imposte.
Campi aggiuntivi: No
Informazioni sul listino
PriceListData · Schema · Schemi dei dati: Prodotti
currencyStringaObbligatorioCodice della valuta dell’importo.
idStringaObbligatorioIdentificativo della risorsa; conservalo come restituito. (PriceListData).
tax_includedBooleanoObbligatorioIndica se il prezzo inviato include le imposte.
versionInteroObbligatorioVersione 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 nullFacoltativoIdentificativo del marchio.
Stringa:minLength:1maxLength:63conditionStringaFacoltativoCondizione del prodotto.
Vincoli
enum["new", "refurbished", "used", "returned", "display", "damaged"]
descriptionStringa nullFacoltativoDescrizione nella lingua selezionata.
Stringa:maxLength:100000feature_value_idsArray <Stringa> FacoltativoIdentificativi dei valori selezionati per le caratteristiche.
maxItems:1000Array:minLength:1maxLength:63identifiersProductIdentifiersnullFacoltativoCodici identificativi del prodotto.
market_idsArray <Stringa> FacoltativoIdentificativi dei mercati selezionati.
maxItems:1000Array:minLength:1maxLength:63media_idsArray <Stringa> FacoltativoIdentificativi di media già esistenti.
maxItems:20Array:minLength:1maxLength:63meta_descriptionStringa nullFacoltativoDescrizione per i motori di ricerca nella lingua selezionata.
Stringa:maxLength:160meta_keywordsArray <Stringa> nullFacoltativoParole chiave per i motori di ricerca nella lingua selezionata.
Array:maxItems:20Array / Array:maxLength:50meta_titleStringa nullFacoltativoTitolo per i motori di ricerca nella lingua selezionata.
Stringa:maxLength:70nameStringaObbligatorioNome della risorsa nel contesto pertinente.
minLength:1maxLength:300pricingProductPriceFacoltativoConfigurazione dei prezzi e relative versioni di concorrenza.
primary_category_idStringa nullFacoltativoIdentificativo della categoria principale.
Stringa:minLength:1maxLength:63publishedBooleanoFacoltativoIndica se la risorsa è pubblicata.
skuStringaObbligatorioCodice di identificazione dell’articolo a magazzino.
minLength:1maxLength:100Vincoli
pattern"^\\S+$"
slugStringa nullFacoltativoSegmento del percorso URL nella lingua selezionata.
Stringa:maxLength:160tax_category_idStringa nullFacoltativoIdentificativo della categoria fiscale.
Stringa:minLength:1maxLength:63variant_value_idsArray <Stringa> FacoltativoIdentificativi dei valori selezionati per la variante.
maxItems:250Array:minLength:1maxLength:63variants_enabledBooleanoFacoltativoIndica se il prodotto utilizza varianti.
Campi aggiuntivi: No
Recupera — Prodotti — Risposta
ProductDetailData · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.
availabilityAvailabilityDataObbligatorioInformazioni sulla disponibilità nel contesto selezionato.
brand_idStringa nullObbligatorioIdentificativo del marchio.
conditionStringaObbligatorioCondizione del prodotto.
Vincoli
enum["new", "refurbished", "used", "returned", "display", "damaged"]
created_atStringaObbligatorioData e ora di creazione.
format:"date-time"descriptionStringa nullObbligatorioDescrizione nella lingua selezionata.
featuresArray <FeatureSelectionData> ObbligatorioCaratteristiche del prodotto.
idStringaObbligatorioIdentificativo della risorsa; conservalo come restituito. (ProductDetailData).
identifiersOggettoCampi aggiuntivi: StringaObbligatorioCodici identificativi del prodotto.
mediaArray <ProductMediaData> ObbligatorioInformazioni sui media allegati.
meta_descriptionStringa nullObbligatorioDescrizione per i motori di ricerca nella lingua selezionata.
meta_keywordsArray <Stringa> nullObbligatorioParole chiave per i motori di ricerca nella lingua selezionata.
meta_titleStringa nullObbligatorioTitolo per i motori di ricerca nella lingua selezionata.
nameStringa nullObbligatorioNome della risorsa nel contesto pertinente.
numberStringaObbligatorioNumero dell’ordine o della richiesta destinato alle persone.
pricePriceDatanullObbligatorioInformazioni sul prezzo nel contesto selezionato.
price_versionInteroObbligatorioVersione corrente del prezzo per il controllo della concorrenza.
primary_category_idStringa nullObbligatorioIdentificativo della categoria principale.
primary_media_idStringa nullObbligatorioIdentificativo del media principale.
publishedBooleanoObbligatorioIndica se la risorsa è pubblicata.
skuStringaObbligatorioCodice di identificazione dell’articolo a magazzino.
slugStringa nullObbligatorioSegmento del percorso URL nella lingua selezionata.
tax_category_idStringaObbligatorioIdentificativo della categoria fiscale.
updated_atStringaObbligatorioData e ora dell’aggiornamento più recente.
format:"date-time"variants_enabledBooleanoObbligatorioIndica se il prodotto utilizza varianti.
versionInteroObbligatorioVersione della risorsa per il controllo della concorrenza.
Campi aggiuntivi: No
Codici identificativi del prodotto
ProductIdentifiers · Schema · Schemi dei dati: Prodotti
eanStringa nullFacoltativoIdentificativo EAN del prodotto.
Stringa:minLength:1maxLength:100isbnStringa nullFacoltativoIdentificativo ISBN.
Stringa:minLength:1maxLength:100mpnStringa nullFacoltativoCodice articolo del produttore.
Stringa:minLength:1maxLength:100upcStringa nullFacoltativoIdentificativo UPC del prodotto.
Stringa:minLength:1maxLength:100
Campi aggiuntivi: No
Informazioni sui media allegati
ProductMediaData · Schema · Schemi dei dati: Prodotti
alt_textStringa nullObbligatorioTesto alternativo dell’immagine.
idStringaObbligatorioIdentificativo della risorsa; conservalo come restituito. (ProductMediaData).
is_primaryBooleanoObbligatorioIndica se è l’elemento principale.
kindStringaObbligatorioForma della struttura dati, definita dai valori consentiti.
Vincoli
enum["image", "video", "model_3d"]
mime_typeStringaObbligatorioTipo di contenuto del media.
positionInteroObbligatorioPosizione nella collezione ordinata.
urlStringa nullObbligatorioURL della risorsa.
Campi aggiuntivi: No
Configurazione dei prezzi e relative versioni di concorrenza
ProductPrice · Schema · Schemi dei dati: Prodotti
amountStringa nullObbligatorioImporto decimale codificato come stringa JSON; null solo dove consentito.
Stringa:maxLength:19Vincoli · Stringa 1
pattern"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"
currencyStringaObbligatorioCodice della valuta dell’importo.
Vincoli
pattern"^[A-Z]{3}$"
expected_price_list_versionInteroObbligatorioVersione del listino letta in precedenza e richiesta per questa scrittura.
minimum:1maximum:9223372036854775807expected_versionInteroObbligatorioVersione letta prima della scrittura; una differenza impedisce l’aggiornamento.
minimum:0maximum:9223372036854775807kindStringaObbligatorioForma della struttura dati, definita dai valori consentiti.
Vincoli
enum["base", "market_fixed"]
price_list_idStringaObbligatorioIdentificativo del listino.
minLength:1maxLength:63tax_includedBooleanoObbligatorioIndica se il prezzo inviato include le imposte.
Campi aggiuntivi: No
Elenca — Prodotti — Risposta
ProductSummaryData · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.
availabilityAvailabilityDataObbligatorioInformazioni sulla disponibilità nel contesto selezionato.
brand_idStringa nullObbligatorioIdentificativo del marchio.
conditionStringaObbligatorioCondizione del prodotto.
Vincoli
enum["new", "refurbished", "used", "returned", "display", "damaged"]
created_atStringaObbligatorioData e ora di creazione.
format:"date-time"idStringaObbligatorioIdentificativo della risorsa; conservalo come restituito. (ProductSummaryData).
nameStringa nullObbligatorioNome della risorsa nel contesto pertinente.
numberStringaObbligatorioNumero dell’ordine o della richiesta destinato alle persone.
pricePriceDatanullObbligatorioInformazioni sul prezzo nel contesto selezionato.
price_versionInteroObbligatorioVersione corrente del prezzo per il controllo della concorrenza.
primary_category_idStringa nullObbligatorioIdentificativo della categoria principale.
primary_media_idStringa nullObbligatorioIdentificativo del media principale.
publishedBooleanoObbligatorioIndica se la risorsa è pubblicata.
skuStringaObbligatorioCodice di identificazione dell’articolo a magazzino.
slugStringa nullObbligatorioSegmento del percorso URL nella lingua selezionata.
tax_category_idStringaObbligatorioIdentificativo della categoria fiscale.
updated_atStringaObbligatorioData e ora dell’aggiornamento più recente.
format:"date-time"variants_enabledBooleanoObbligatorioIndica se il prodotto utilizza varianti.
versionInteroObbligatorioVersione della risorsa per il controllo della concorrenza.
Campi aggiuntivi: No
Aggiorna — Prodotti — Corpo della richiesta
ProductUpdate · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.
brand_idStringa nullFacoltativoIdentificativo del marchio.
Stringa:minLength:1maxLength:63conditionStringaFacoltativoCondizione del prodotto.
Vincoli
enum["new", "refurbished", "used", "returned", "display", "damaged"]
descriptionStringa nullFacoltativoDescrizione nella lingua selezionata.
Stringa:maxLength:100000expected_variant_price_versionsOggettoCampi aggiuntivi: InteroFacoltativominimum:0maximum:9223372036854775807Versioni dei prezzi lette in precedenza, indicizzate per identificativo della variante.
maxProperties:250Vincoli
propertyNames{"maxLength": 63, "minLength": 1}
expected_versionInteroObbligatorioVersione letta prima della scrittura; una differenza impedisce l’aggiornamento.
minimum:1maximum:9223372036854775807feature_value_idsArray <Stringa> FacoltativoIdentificativi dei valori selezionati per le caratteristiche.
maxItems:1000Array:minLength:1maxLength:63identifiersProductIdentifiersnullFacoltativoCodici identificativi del prodotto.
market_idsArray <Stringa> FacoltativoIdentificativi dei mercati selezionati.
maxItems:1000Array:minLength:1maxLength:63media_idsArray <Stringa> FacoltativoIdentificativi di media già esistenti.
maxItems:20Array:minLength:1maxLength:63meta_descriptionStringa nullFacoltativoDescrizione per i motori di ricerca nella lingua selezionata.
Stringa:maxLength:160meta_keywordsArray <Stringa> nullFacoltativoParole chiave per i motori di ricerca nella lingua selezionata.
Array:maxItems:20Array / Array:maxLength:50meta_titleStringa nullFacoltativoTitolo per i motori di ricerca nella lingua selezionata.
Stringa:maxLength:70nameStringa nullFacoltativoNome della risorsa nel contesto pertinente.
Stringa:maxLength:300pricingProductPriceFacoltativoConfigurazione dei prezzi e relative versioni di concorrenza.
primary_category_idStringa nullFacoltativoIdentificativo della categoria principale.
Stringa:minLength:1maxLength:63publishedBooleanoFacoltativoIndica se la risorsa è pubblicata.
skuStringaFacoltativoCodice di identificazione dell’articolo a magazzino.
minLength:1maxLength:100Vincoli
pattern"^\\S+$"
slugStringa nullFacoltativoSegmento del percorso URL nella lingua selezionata.
Stringa:maxLength:160tax_category_idStringa nullFacoltativoIdentificativo della categoria fiscale.
Stringa:minLength:1maxLength:63variant_value_idsArray <Stringa> FacoltativoIdentificativi dei valori selezionati per la variante.
maxItems:250Array:minLength:1maxLength:63variants_enabledBooleanoFacoltativoIndica se il prodotto utilizza varianti.
Campi aggiuntivi: No