Esquemas de datos
Listar — Productos — Respuesta
ApiResponse_list_ProductSummaryData__ · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.
dataLista <ProductSummaryData> ObligatorioEjemplo de respuesta · ApiResponse_list_ProductSummaryData__.
metaContextPageMetaContextMetaPageMetaRequestMetaObligatorioMetadatos de la respuesta.
Campos adicionales: No
Obtener — Productos — Respuesta
ApiResponse_ProductDetailData_ · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.
dataProductDetailDataObligatorioEjemplo de respuesta · ProductDetailData.
metaContextPageMetaContextMetaPageMetaRequestMetaObligatorioMetadatos de la respuesta.
Campos adicionales: No
Información de disponibilidad en el contexto seleccionado
AvailabilityData · Esquema · Esquemas de datos: Productos
available_fromCadena de texto nullObligatorioInicio de la disponibilidad.
Cadena de texto:format:"date-time"available_untilCadena de texto nullObligatorioFin de la disponibilidad.
Cadena de texto:format:"date-time"is_availableBooleanoObligatorioIndica si el elemento está disponible en este contexto.
Campos adicionales: No
Información del precio en el contexto seleccionado
PriceData · Esquema · Esquemas de datos: Productos
amountCadena de textoObligatorioImporte decimal codificado como cadena JSON; null solo cuando se permite.
currencyCadena de textoObligatorioCódigo de la moneda del importe.
Restricciones
pattern"^[A-Z]{3}$"
minor_unitsNúmero enteroObligatorioNúmero de decimales utilizados por la moneda.
minimum:0maximum:4tax_includedBooleanoObligatorioIndica si el precio enviado incluye impuestos.
Campos adicionales: No
Información de la lista de precios
PriceListData · Esquema · Esquemas de datos: Productos
currencyCadena de textoObligatorioCódigo de la moneda del importe.
idCadena de textoObligatorioIdentificador del recurso; consérvalo tal como se devuelve. (PriceListData).
tax_includedBooleanoObligatorioIndica si el precio enviado incluye impuestos.
versionNúmero enteroObligatorioVersión del recurso utilizada para controlar cambios simultáneos.
Campos adicionales: No
Crear — Productos — Cuerpo de la solicitud
ProductCreate · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.
brand_idCadena de texto nullOpcionalIdentificador de la marca.
Cadena de texto:minLength:1maxLength:63conditionCadena de textoOpcionalEstado del producto.
Restricciones
enum["new", "refurbished", "used", "returned", "display", "damaged"]
descriptionCadena de texto nullOpcionalDescripción en el idioma seleccionado.
Cadena de texto:maxLength:100000feature_value_idsLista <Cadena de texto> OpcionalIdentificadores de los valores de características seleccionados.
maxItems:1000Lista:minLength:1maxLength:63identifiersProductIdentifiersnullOpcionalCódigos de identificación del producto.
market_idsLista <Cadena de texto> OpcionalIdentificadores de los mercados seleccionados.
maxItems:1000Lista:minLength:1maxLength:63media_idsLista <Cadena de texto> OpcionalIdentificadores de archivos multimedia ya existentes.
maxItems:20Lista:minLength:1maxLength:63meta_descriptionCadena de texto nullOpcionalDescripción para buscadores en el idioma seleccionado.
Cadena de texto:maxLength:160meta_keywordsLista <Cadena de texto> nullOpcionalPalabras clave para buscadores en el idioma seleccionado.
Lista:maxItems:20Lista / Lista:maxLength:50meta_titleCadena de texto nullOpcionalTítulo para buscadores en el idioma seleccionado.
Cadena de texto:maxLength:70nameCadena de textoObligatorioNombre del recurso en el contexto correspondiente.
minLength:1maxLength:300pricingProductPriceOpcionalConfiguración de precios y versiones para controlar cambios simultáneos.
primary_category_idCadena de texto nullOpcionalIdentificador de la categoría principal.
Cadena de texto:minLength:1maxLength:63publishedBooleanoOpcionalIndica si el recurso está publicado.
skuCadena de textoObligatorioCódigo de referencia de inventario.
minLength:1maxLength:100Restricciones
pattern"^\\S+$"
slugCadena de texto nullOpcionalSegmento de la ruta URL en el idioma seleccionado.
Cadena de texto:maxLength:160tax_category_idCadena de texto nullOpcionalIdentificador de la categoría fiscal.
Cadena de texto:minLength:1maxLength:63variant_value_idsLista <Cadena de texto> OpcionalIdentificadores de los valores de variantes seleccionados.
maxItems:250Lista:minLength:1maxLength:63variants_enabledBooleanoOpcionalIndica si el producto utiliza variantes.
Campos adicionales: No
Obtener — Productos — Respuesta
ProductDetailData · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.
availabilityAvailabilityDataObligatorioInformación de disponibilidad en el contexto seleccionado.
brand_idCadena de texto nullObligatorioIdentificador de la marca.
conditionCadena de textoObligatorioEstado del producto.
Restricciones
enum["new", "refurbished", "used", "returned", "display", "damaged"]
created_atCadena de textoObligatorioMomento de creación.
format:"date-time"descriptionCadena de texto nullObligatorioDescripción en el idioma seleccionado.
featuresLista <FeatureSelectionData> ObligatorioCaracterísticas del producto.
idCadena de textoObligatorioIdentificador del recurso; consérvalo tal como se devuelve. (ProductDetailData).
identifiersObjetoCampos adicionales: Cadena de textoObligatorioCódigos de identificación del producto.
mediaLista <ProductMediaData> ObligatorioInformación de los archivos multimedia adjuntos.
meta_descriptionCadena de texto nullObligatorioDescripción para buscadores en el idioma seleccionado.
meta_keywordsLista <Cadena de texto> nullObligatorioPalabras clave para buscadores en el idioma seleccionado.
meta_titleCadena de texto nullObligatorioTítulo para buscadores en el idioma seleccionado.
nameCadena de texto nullObligatorioNombre del recurso en el contexto correspondiente.
numberCadena de textoObligatorioNúmero de pedido o solicitud mostrado al usuario.
pricePriceDatanullObligatorioInformación del precio en el contexto seleccionado.
price_versionNúmero enteroObligatorioVersión actual del precio para controlar cambios simultáneos.
primary_category_idCadena de texto nullObligatorioIdentificador de la categoría principal.
primary_media_idCadena de texto nullObligatorioIdentificador del archivo multimedia principal.
publishedBooleanoObligatorioIndica si el recurso está publicado.
skuCadena de textoObligatorioCódigo de referencia de inventario.
slugCadena de texto nullObligatorioSegmento de la ruta URL en el idioma seleccionado.
tax_category_idCadena de textoObligatorioIdentificador de la categoría fiscal.
updated_atCadena de textoObligatorioMomento de la última actualización.
format:"date-time"variants_enabledBooleanoObligatorioIndica si el producto utiliza variantes.
versionNúmero enteroObligatorioVersión del recurso utilizada para controlar cambios simultáneos.
Campos adicionales: No
Códigos de identificación del producto
ProductIdentifiers · Esquema · Esquemas de datos: Productos
eanCadena de texto nullOpcionalIdentificador EAN del producto.
Cadena de texto:minLength:1maxLength:100isbnCadena de texto nullOpcionalIdentificador ISBN.
Cadena de texto:minLength:1maxLength:100mpnCadena de texto nullOpcionalNúmero de pieza del fabricante.
Cadena de texto:minLength:1maxLength:100upcCadena de texto nullOpcionalIdentificador UPC del producto.
Cadena de texto:minLength:1maxLength:100
Campos adicionales: No
Información de los archivos multimedia adjuntos
ProductMediaData · Esquema · Esquemas de datos: Productos
alt_textCadena de texto nullObligatorioTexto alternativo de una imagen.
idCadena de textoObligatorioIdentificador del recurso; consérvalo tal como se devuelve. (ProductMediaData).
is_primaryBooleanoObligatorioIndica si este es el elemento principal.
kindCadena de textoObligatorioVariante de la estructura de datos definida por los valores admitidos.
Restricciones
enum["image", "video", "model_3d"]
mime_typeCadena de textoObligatorioTipo de contenido multimedia.
positionNúmero enteroObligatorioPosición en la colección ordenada.
urlCadena de texto nullObligatorioURL del recurso.
Campos adicionales: No
Configuración de precios y versiones para controlar cambios simultáneos
ProductPrice · Esquema · Esquemas de datos: Productos
amountCadena de texto nullObligatorioImporte decimal codificado como cadena JSON; null solo cuando se permite.
Cadena de texto:maxLength:19Restricciones · Cadena de texto 1
pattern"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"
currencyCadena de textoObligatorioCódigo de la moneda del importe.
Restricciones
pattern"^[A-Z]{3}$"
expected_price_list_versionNúmero enteroObligatorioVersión de la lista de precios leída previamente y requerida para esta escritura.
minimum:1maximum:9223372036854775807expected_versionNúmero enteroObligatorioVersión leída antes de escribir; si no coincide, se rechaza la actualización.
minimum:0maximum:9223372036854775807kindCadena de textoObligatorioVariante de la estructura de datos definida por los valores admitidos.
Restricciones
enum["base", "market_fixed"]
price_list_idCadena de textoObligatorioIdentificador de la lista de precios.
minLength:1maxLength:63tax_includedBooleanoObligatorioIndica si el precio enviado incluye impuestos.
Campos adicionales: No
Listar — Productos — Respuesta
ProductSummaryData · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.
availabilityAvailabilityDataObligatorioInformación de disponibilidad en el contexto seleccionado.
brand_idCadena de texto nullObligatorioIdentificador de la marca.
conditionCadena de textoObligatorioEstado del producto.
Restricciones
enum["new", "refurbished", "used", "returned", "display", "damaged"]
created_atCadena de textoObligatorioMomento de creación.
format:"date-time"idCadena de textoObligatorioIdentificador del recurso; consérvalo tal como se devuelve. (ProductSummaryData).
nameCadena de texto nullObligatorioNombre del recurso en el contexto correspondiente.
numberCadena de textoObligatorioNúmero de pedido o solicitud mostrado al usuario.
pricePriceDatanullObligatorioInformación del precio en el contexto seleccionado.
price_versionNúmero enteroObligatorioVersión actual del precio para controlar cambios simultáneos.
primary_category_idCadena de texto nullObligatorioIdentificador de la categoría principal.
primary_media_idCadena de texto nullObligatorioIdentificador del archivo multimedia principal.
publishedBooleanoObligatorioIndica si el recurso está publicado.
skuCadena de textoObligatorioCódigo de referencia de inventario.
slugCadena de texto nullObligatorioSegmento de la ruta URL en el idioma seleccionado.
tax_category_idCadena de textoObligatorioIdentificador de la categoría fiscal.
updated_atCadena de textoObligatorioMomento de la última actualización.
format:"date-time"variants_enabledBooleanoObligatorioIndica si el producto utiliza variantes.
versionNúmero enteroObligatorioVersión del recurso utilizada para controlar cambios simultáneos.
Campos adicionales: No
Actualizar — Productos — Cuerpo de la solicitud
ProductUpdate · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.
brand_idCadena de texto nullOpcionalIdentificador de la marca.
Cadena de texto:minLength:1maxLength:63conditionCadena de textoOpcionalEstado del producto.
Restricciones
enum["new", "refurbished", "used", "returned", "display", "damaged"]
descriptionCadena de texto nullOpcionalDescripción en el idioma seleccionado.
Cadena de texto:maxLength:100000expected_variant_price_versionsObjetoCampos adicionales: Número enteroOpcionalminimum:0maximum:9223372036854775807Versiones de precios leídas previamente, indexadas por identificador de variante.
maxProperties:250Restricciones
propertyNames{"maxLength": 63, "minLength": 1}
expected_versionNúmero enteroObligatorioVersión leída antes de escribir; si no coincide, se rechaza la actualización.
minimum:1maximum:9223372036854775807feature_value_idsLista <Cadena de texto> OpcionalIdentificadores de los valores de características seleccionados.
maxItems:1000Lista:minLength:1maxLength:63identifiersProductIdentifiersnullOpcionalCódigos de identificación del producto.
market_idsLista <Cadena de texto> OpcionalIdentificadores de los mercados seleccionados.
maxItems:1000Lista:minLength:1maxLength:63media_idsLista <Cadena de texto> OpcionalIdentificadores de archivos multimedia ya existentes.
maxItems:20Lista:minLength:1maxLength:63meta_descriptionCadena de texto nullOpcionalDescripción para buscadores en el idioma seleccionado.
Cadena de texto:maxLength:160meta_keywordsLista <Cadena de texto> nullOpcionalPalabras clave para buscadores en el idioma seleccionado.
Lista:maxItems:20Lista / Lista:maxLength:50meta_titleCadena de texto nullOpcionalTítulo para buscadores en el idioma seleccionado.
Cadena de texto:maxLength:70nameCadena de texto nullOpcionalNombre del recurso en el contexto correspondiente.
Cadena de texto:maxLength:300pricingProductPriceOpcionalConfiguración de precios y versiones para controlar cambios simultáneos.
primary_category_idCadena de texto nullOpcionalIdentificador de la categoría principal.
Cadena de texto:minLength:1maxLength:63publishedBooleanoOpcionalIndica si el recurso está publicado.
skuCadena de textoOpcionalCódigo de referencia de inventario.
minLength:1maxLength:100Restricciones
pattern"^\\S+$"
slugCadena de texto nullOpcionalSegmento de la ruta URL en el idioma seleccionado.
Cadena de texto:maxLength:160tax_category_idCadena de texto nullOpcionalIdentificador de la categoría fiscal.
Cadena de texto:minLength:1maxLength:63variant_value_idsLista <Cadena de texto> OpcionalIdentificadores de los valores de variantes seleccionados.
maxItems:250Lista:minLength:1maxLength:63variants_enabledBooleanoOpcionalIndica si el producto utiliza variantes.
Campos adicionales: No