Saltar al contenido
ShopentlyLearn

Esquemas de datos: Productos

Esquemas de datos: Productos. Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

Esquemas de datos

Listar — Productos — Respuesta

ApiResponse_list_ProductSummaryData__ · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.
dataLista <ProductSummaryData > Obligatorio

Ejemplo de respuesta · ApiResponse_list_ProductSummaryData__.

Ejemplo: [{"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 Obligatorio

Metadatos de la respuesta.

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

Campos adicionales: No

Obtener — Productos — Respuesta

ApiResponse_ProductDetailData_ · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.
dataProductDetailData Obligatorio

Ejemplo de respuesta · ProductDetailData.

Ejemplo: {"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 Obligatorio

Metadatos de la respuesta.

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

Campos adicionales: No

Información de disponibilidad en el contexto seleccionado

AvailabilityData · Esquema · Esquemas de datos: Productos
available_fromCadena de texto nullObligatorio

Inicio de la disponibilidad.

Cadena de texto:format: "date-time"
Ejemplo: null
available_untilCadena de texto nullObligatorio

Fin de la disponibilidad.

Cadena de texto:format: "date-time"
Ejemplo: null
is_availableBooleanoObligatorio

Indica si el elemento está disponible en este contexto.

Ejemplo: true

Campos adicionales: No

Información del precio en el contexto seleccionado

PriceData · Esquema · Esquemas de datos: Productos
amountCadena de textoObligatorio

Importe decimal codificado como cadena JSON; null solo cuando se permite.

Ejemplo: "0.00"
currencyCadena de textoObligatorio

Código de la moneda del importe.

Restricciones
pattern
"^[A-Z]{3}$"
Ejemplo: "PLN"
minor_unitsNúmero enteroObligatorio

Número de decimales utilizados por la moneda.

minimum: 0maximum: 4
Ejemplo: 2
tax_includedBooleanoObligatorio

Indica si el precio enviado incluye impuestos.

Ejemplo: true

Campos adicionales: No

Información de la lista de precios

PriceListData · Esquema · Esquemas de datos: Productos
currencyCadena de textoObligatorio

Código de la moneda del importe.

idCadena de textoObligatorio

Identificador del recurso; consérvalo tal como se devuelve. (PriceListData).

tax_includedBooleanoObligatorio

Indica si el precio enviado incluye impuestos.

versionNúmero enteroObligatorio

Versió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 nullOpcional

Identificador de la marca.

Cadena de texto:minLength: 1maxLength: 63
conditionCadena de textoOpcional

Estado del producto.

Restricciones
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Valor predeterminado: "new"
descriptionCadena de texto nullOpcional

Descripción en el idioma seleccionado.

Cadena de texto:maxLength: 100000
feature_value_idsLista <Cadena de texto> Opcional

Identificadores de los valores de características seleccionados.

maxItems: 1000
Lista:minLength: 1maxLength: 63
identifiersProductIdentifiers nullOpcional

Códigos de identificación del producto.

market_idsLista <Cadena de texto> Opcional

Identificadores de los mercados seleccionados.

maxItems: 1000
Lista:minLength: 1maxLength: 63
media_idsLista <Cadena de texto> Opcional

Identificadores de archivos multimedia ya existentes.

maxItems: 20
Lista:minLength: 1maxLength: 63
meta_descriptionCadena de texto nullOpcional

Descripción para buscadores en el idioma seleccionado.

Cadena de texto:maxLength: 160
meta_keywordsLista <Cadena de texto> nullOpcional

Palabras clave para buscadores en el idioma seleccionado.

Lista:maxItems: 20
Lista / Lista:maxLength: 50
meta_titleCadena de texto nullOpcional

Título para buscadores en el idioma seleccionado.

Cadena de texto:maxLength: 70
nameCadena de textoObligatorio

Nombre del recurso en el contexto correspondiente.

minLength: 1maxLength: 300
Ejemplo: "Example"
pricingProductPrice Opcional

Configuración de precios y versiones para controlar cambios simultáneos.

primary_category_idCadena de texto nullOpcional

Identificador de la categoría principal.

Cadena de texto:minLength: 1maxLength: 63
publishedBooleanoOpcional

Indica si el recurso está publicado.

Valor predeterminado: false
skuCadena de textoObligatorio

Código de referencia de inventario.

minLength: 1maxLength: 100
Restricciones
pattern
"^\\S+$"
Ejemplo: "example"
slugCadena de texto nullOpcional

Segmento de la ruta URL en el idioma seleccionado.

Cadena de texto:maxLength: 160
tax_category_idCadena de texto nullOpcional

Identificador de la categoría fiscal.

Cadena de texto:minLength: 1maxLength: 63
variant_value_idsLista <Cadena de texto> Opcional

Identificadores de los valores de variantes seleccionados.

maxItems: 250
Lista:minLength: 1maxLength: 63
variants_enabledBooleanoOpcional

Indica si el producto utiliza variantes.

Valor predeterminado: false

Campos adicionales: No

Obtener — Productos — Respuesta

ProductDetailData · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.
availabilityAvailabilityData Obligatorio

Información de disponibilidad en el contexto seleccionado.

Ejemplo: {"available_from":null,"available_until":null,"is_available":true}
brand_idCadena de texto nullObligatorio

Identificador de la marca.

Ejemplo: null
conditionCadena de textoObligatorio

Estado del producto.

Restricciones
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Ejemplo: "new"
created_atCadena de textoObligatorio

Momento de creación.

format: "date-time"
Ejemplo: "2026-01-01T12:00:00Z"
descriptionCadena de texto nullObligatorio

Descripción en el idioma seleccionado.

Ejemplo: "example"
featuresLista <FeatureSelectionData > Obligatorio

Características del producto.

Ejemplo: [{"feature_id":"example","feature_name":"example","value":"example","value_id":"example"}]
idCadena de textoObligatorio

Identificador del recurso; consérvalo tal como se devuelve. (ProductDetailData).

Ejemplo: "example"
identifiersObjetoCampos adicionales: Cadena de textoObligatorio

Códigos de identificación del producto.

Ejemplo: {}
mediaLista <ProductMediaData > Obligatorio

Información de los archivos multimedia adjuntos.

Ejemplo: [{"alt_text":"example","id":"example","is_primary":true,"kind":"image","mime_type":"image/jpeg","position":1,"url":"https://example.invalid/product.jpg"}]
meta_descriptionCadena de texto nullObligatorio

Descripción para buscadores en el idioma seleccionado.

Ejemplo: "example"
meta_keywordsLista <Cadena de texto> nullObligatorio

Palabras clave para buscadores en el idioma seleccionado.

Ejemplo: ["example"]
meta_titleCadena de texto nullObligatorio

Título para buscadores en el idioma seleccionado.

Ejemplo: "example"
nameCadena de texto nullObligatorio

Nombre del recurso en el contexto correspondiente.

Ejemplo: "Example"
numberCadena de textoObligatorio

Número de pedido o solicitud mostrado al usuario.

Ejemplo: "example"
pricePriceData nullObligatorio

Información del precio en el contexto seleccionado.

Ejemplo: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
price_versionNúmero enteroObligatorio

Versión actual del precio para controlar cambios simultáneos.

Ejemplo: 1
primary_category_idCadena de texto nullObligatorio

Identificador de la categoría principal.

Ejemplo: "example"
primary_media_idCadena de texto nullObligatorio

Identificador del archivo multimedia principal.

Ejemplo: "example"
publishedBooleanoObligatorio

Indica si el recurso está publicado.

Ejemplo: false
skuCadena de textoObligatorio

Código de referencia de inventario.

Ejemplo: "example"
slugCadena de texto nullObligatorio

Segmento de la ruta URL en el idioma seleccionado.

Ejemplo: "example"
tax_category_idCadena de textoObligatorio

Identificador de la categoría fiscal.

Ejemplo: "example"
updated_atCadena de textoObligatorio

Momento de la última actualización.

format: "date-time"
Ejemplo: "2026-01-01T12:00:00Z"
variants_enabledBooleanoObligatorio

Indica si el producto utiliza variantes.

Ejemplo: false
versionNúmero enteroObligatorio

Versión del recurso utilizada para controlar cambios simultáneos.

Ejemplo: 1

Campos adicionales: No

Códigos de identificación del producto

ProductIdentifiers · Esquema · Esquemas de datos: Productos
eanCadena de texto nullOpcional

Identificador EAN del producto.

Cadena de texto:minLength: 1maxLength: 100
isbnCadena de texto nullOpcional

Identificador ISBN.

Cadena de texto:minLength: 1maxLength: 100
mpnCadena de texto nullOpcional

Número de pieza del fabricante.

Cadena de texto:minLength: 1maxLength: 100
upcCadena de texto nullOpcional

Identificador 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 nullObligatorio

Texto alternativo de una imagen.

Ejemplo: "example"
idCadena de textoObligatorio

Identificador del recurso; consérvalo tal como se devuelve. (ProductMediaData).

Ejemplo: "example"
is_primaryBooleanoObligatorio

Indica si este es el elemento principal.

Ejemplo: true
kindCadena de textoObligatorio

Variante de la estructura de datos definida por los valores admitidos.

Restricciones
enum
["image", "video", "model_3d"]
Ejemplo: "image"
mime_typeCadena de textoObligatorio

Tipo de contenido multimedia.

Ejemplo: "image/jpeg"
positionNúmero enteroObligatorio

Posición en la colección ordenada.

Ejemplo: 1
urlCadena de texto nullObligatorio

URL del recurso.

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

Campos adicionales: No

Configuración de precios y versiones para controlar cambios simultáneos

ProductPrice · Esquema · Esquemas de datos: Productos
amountCadena de texto nullObligatorio

Importe decimal codificado como cadena JSON; null solo cuando se permite.

Cadena de texto:maxLength: 19
Restricciones · Cadena de texto 1
pattern
"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"
Ejemplo: "0.00"
currencyCadena de textoObligatorio

Código de la moneda del importe.

Restricciones
pattern
"^[A-Z]{3}$"
Ejemplo: "PLN"
expected_price_list_versionNúmero enteroObligatorio

Versión de la lista de precios leída previamente y requerida para esta escritura.

minimum: 1maximum: 9223372036854775807
Ejemplo: 1
expected_versionNúmero enteroObligatorio

Versión leída antes de escribir; si no coincide, se rechaza la actualización.

minimum: 0maximum: 9223372036854775807
Ejemplo: 0
kindCadena de textoObligatorio

Variante de la estructura de datos definida por los valores admitidos.

Restricciones
enum
["base", "market_fixed"]
Ejemplo: "base"
price_list_idCadena de textoObligatorio

Identificador de la lista de precios.

minLength: 1maxLength: 63
Ejemplo: "example"
tax_includedBooleanoObligatorio

Indica si el precio enviado incluye impuestos.

Ejemplo: true

Campos adicionales: No

Listar — Productos — Respuesta

ProductSummaryData · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.
availabilityAvailabilityData Obligatorio

Información de disponibilidad en el contexto seleccionado.

Ejemplo: {"available_from":null,"available_until":null,"is_available":true}
brand_idCadena de texto nullObligatorio

Identificador de la marca.

Ejemplo: null
conditionCadena de textoObligatorio

Estado del producto.

Restricciones
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
Ejemplo: "new"
created_atCadena de textoObligatorio

Momento de creación.

format: "date-time"
Ejemplo: "2026-01-01T12:00:00Z"
idCadena de textoObligatorio

Identificador del recurso; consérvalo tal como se devuelve. (ProductSummaryData).

Ejemplo: "example"
nameCadena de texto nullObligatorio

Nombre del recurso en el contexto correspondiente.

Ejemplo: "Example"
numberCadena de textoObligatorio

Número de pedido o solicitud mostrado al usuario.

Ejemplo: "example"
pricePriceData nullObligatorio

Información del precio en el contexto seleccionado.

Ejemplo: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
price_versionNúmero enteroObligatorio

Versión actual del precio para controlar cambios simultáneos.

Ejemplo: 1
primary_category_idCadena de texto nullObligatorio

Identificador de la categoría principal.

Ejemplo: "example"
primary_media_idCadena de texto nullObligatorio

Identificador del archivo multimedia principal.

Ejemplo: "example"
publishedBooleanoObligatorio

Indica si el recurso está publicado.

Ejemplo: false
skuCadena de textoObligatorio

Código de referencia de inventario.

Ejemplo: "example"
slugCadena de texto nullObligatorio

Segmento de la ruta URL en el idioma seleccionado.

Ejemplo: "example"
tax_category_idCadena de textoObligatorio

Identificador de la categoría fiscal.

Ejemplo: "example"
updated_atCadena de textoObligatorio

Momento de la última actualización.

format: "date-time"
Ejemplo: "2026-01-01T12:00:00Z"
variants_enabledBooleanoObligatorio

Indica si el producto utiliza variantes.

Ejemplo: false
versionNúmero enteroObligatorio

Versión del recurso utilizada para controlar cambios simultáneos.

Ejemplo: 1

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 nullOpcional

Identificador de la marca.

Cadena de texto:minLength: 1maxLength: 63
conditionCadena de textoOpcional

Estado del producto.

Restricciones
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
descriptionCadena de texto nullOpcional

Descripción en el idioma seleccionado.

Cadena de texto:maxLength: 100000
Ejemplo: null
expected_variant_price_versionsObjetoCampos adicionales: Número entero
minimum: 0maximum: 9223372036854775807
Opcional

Versiones de precios leídas previamente, indexadas por identificador de variante.

maxProperties: 250
Restricciones
propertyNames
{"maxLength": 63, "minLength": 1}
expected_versionNúmero enteroObligatorio

Versión leída antes de escribir; si no coincide, se rechaza la actualización.

minimum: 1maximum: 9223372036854775807
Ejemplo: 1
feature_value_idsLista <Cadena de texto> Opcional

Identificadores de los valores de características seleccionados.

maxItems: 1000
Lista:minLength: 1maxLength: 63
identifiersProductIdentifiers nullOpcional

Códigos de identificación del producto.

market_idsLista <Cadena de texto> Opcional

Identificadores de los mercados seleccionados.

maxItems: 1000
Lista:minLength: 1maxLength: 63
media_idsLista <Cadena de texto> Opcional

Identificadores de archivos multimedia ya existentes.

maxItems: 20
Lista:minLength: 1maxLength: 63
meta_descriptionCadena de texto nullOpcional

Descripción para buscadores en el idioma seleccionado.

Cadena de texto:maxLength: 160
meta_keywordsLista <Cadena de texto> nullOpcional

Palabras clave para buscadores en el idioma seleccionado.

Lista:maxItems: 20
Lista / Lista:maxLength: 50
meta_titleCadena de texto nullOpcional

Título para buscadores en el idioma seleccionado.

Cadena de texto:maxLength: 70
nameCadena de texto nullOpcional

Nombre del recurso en el contexto correspondiente.

Cadena de texto:maxLength: 300
Ejemplo: null
pricingProductPrice Opcional

Configuración de precios y versiones para controlar cambios simultáneos.

Ejemplo: {"amount":"0.00","currency":"PLN","expected_price_list_version":1,"expected_version":0,"kind":"base","price_list_id":"example","tax_included":true}
primary_category_idCadena de texto nullOpcional

Identificador de la categoría principal.

Cadena de texto:minLength: 1maxLength: 63
publishedBooleanoOpcional

Indica si el recurso está publicado.

skuCadena de textoOpcional

Código de referencia de inventario.

minLength: 1maxLength: 100
Restricciones
pattern
"^\\S+$"
Ejemplo: "example"
slugCadena de texto nullOpcional

Segmento de la ruta URL en el idioma seleccionado.

Cadena de texto:maxLength: 160
tax_category_idCadena de texto nullOpcional

Identificador de la categoría fiscal.

Cadena de texto:minLength: 1maxLength: 63
variant_value_idsLista <Cadena de texto> Opcional

Identificadores de los valores de variantes seleccionados.

maxItems: 250
Lista:minLength: 1maxLength: 63
variants_enabledBooleanoOpcional

Indica si el producto utiliza variantes.

Campos adicionales: No