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

ApiResponse_ProductFileListData_

ApiResponse_ProductFileListData_ · Campos, tipos y restricciones de los datos aceptados o devueltos por la API. Envía los archivos como multipart/form-data después de crear upload_id y asígnalos a un producto. La descarga requiere un token Bearer y permiso para category; la respuesta contiene los bytes, sin dirección pública ni contraseña. Para mode=period elige days (1–3650) o el valor anterior months, nunca ambos. Las condiciones se guardan al comprar; el reembolso revoca el acceso solo a la línea reembolsada.
dataProductFileListData Obligatorio

Contenido de una respuesta correcta.

Ejemplo: {"files":[{"category":"digital","created_at":"2026-01-01T12:00:00Z","current_version_id":"00000000-0000-4000-8000-000000000001","file_id":"00000000-0000-4000-8000-000000000001","filename":"manual.pdf","id":"00000000-0000-4000-8000-000000000001","label":"Manual","mime_type":"application/pdf","sha256":"5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd","size_bytes":46,"state":"active","version_number":1}],"product_version":2}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatorio

Metadatos de la respuesta.

Ejemplo: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example"}

Campos adicionales: No

ApiResponse_ReleaseListData_

ApiResponse_ReleaseListData_ · Campos, tipos y restricciones de los datos aceptados o devueltos por la API. Envía los archivos como multipart/form-data después de crear upload_id y asígnalos a un producto. La descarga requiere un token Bearer y permiso para category; la respuesta contiene los bytes, sin dirección pública ni contraseña. Para mode=period elige days (1–3650) o el valor anterior months, nunca ambos. Las condiciones se guardan al comprar; el reembolso revoca el acceso solo a la línea reembolsada.
dataReleaseListData Obligatorio

Contenido de una respuesta correcta.

Ejemplo: {"current_release_id":"00000000-0000-4000-8000-000000000001","product_version":2,"releases":[{"changelog":"Manual update","files":[{"file_id":"00000000-0000-4000-8000-000000000001","sort_order":0,"version_id":"00000000-0000-4000-8000-000000000001"}],"id":"00000000-0000-4000-8000-000000000001","manifest_sha256":"1111111111111111111111111111111111111111111111111111111111111111","published_at":null,"release_sequence":null,"state":"active","version_label":"1.0","withdrawn_at":null}],"update_days":365,"update_mode":"period","update_months":null}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatorio

Metadatos de la respuesta.

Ejemplo: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example"}

Campos adicionales: No

ApiResponse_UploadData_

ApiResponse_UploadData_ · Campos, tipos y restricciones de los datos aceptados o devueltos por la API. Envía los archivos como multipart/form-data después de crear upload_id y asígnalos a un producto. La descarga requiere un token Bearer y permiso para category; la respuesta contiene los bytes, sin dirección pública ni contraseña. Para mode=period elige days (1–3650) o el valor anterior months, nunca ambos. Las condiciones se guardan al comprar; el reembolso revoca el acceso solo a la línea reembolsada.
dataUploadData Obligatorio

Contenido de una respuesta correcta.

Ejemplo: {"category":"digital","expires_at":"2026-01-01T12:00:00Z","filename":"manual.pdf","id":"00000000-0000-4000-8000-000000000001","product_id":"example","received_bytes":46,"sha256":"5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd","size_bytes":46,"status":"ready"}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatorio

Metadatos de la respuesta.

Ejemplo: {"request_id":"example"}

Campos adicionales: No

ApiResponse[AudienceData]

ApiResponse_AudienceData_ · Lee la regla de acceso y la versión del producto. La primera publicación sigue siendo la fecha de referencia.
dataAudienceData Obligatorio

Contenido de una respuesta correcta.

Ejemplo: {"anchor_at":"2026-11-03T12:00:00Z","effective_at":"2026-11-03T12:00:00Z","file_id":"00000000-0000-4000-8000-000000000007","file_version_id":"00000000-0000-4000-8000-000000000010","historical_access_preserved":true,"id":"00000000-0000-4000-8000-000000000009","lookback_days":null,"mode":"all_purchasers","next_cursor":null,"order_ids":[],"product_version":3,"revision":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatorio

Metadatos de la respuesta.

Ejemplo: {"request_id":"example-request"}

Campos adicionales: No

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

AudienceChange

AudienceChange · Elige las compras autorizadas. Los pedidos seleccionados deben contener este producto pagado y no reembolsado.
audienceAudienceSelection Obligatorio

Regla explícita de acceso al archivo compartido.

Ejemplo: {"mode":"all_purchasers"}
expected_versionNúmero enteroObligatorio

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

minimum: 1maximum: 9223372036854775807
Ejemplo: 1

Campos adicionales: No

AudienceData

AudienceData · Lee la regla de acceso y la versión del producto. La primera publicación sigue siendo la fecha de referencia.
anchor_atCadena de textoObligatorio

Primera publicación; no cambia al editar la regla.

format: "date-time"
Ejemplo: "2026-11-03T12:00:00Z"
effective_atCadena de textoObligatorio

Fecha de publicación de esta regla de acceso.

format: "date-time"
Ejemplo: "2026-11-03T12:00:00Z"
file_idCadena de textoObligatorio

Identificador del recurso; consérvalo tal como se devuelve. · file_id

Ejemplo: "00000000-0000-4000-8000-000000000007"
file_version_idCadena de textoObligatorio

ID de una versión inmutable del archivo.

Ejemplo: "00000000-0000-4000-8000-000000000010"
historical_access_preservedBooleanoOpcional

Los derechos ya concedidos se conservan al restringir la regla.

Valor predeterminado: trueEjemplo: true
idCadena de textoObligatorio

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

Ejemplo: "00000000-0000-4000-8000-000000000009"
lookback_daysNúmero entero nullObligatorio

1–3650 días antes de la primera publicación; solo recent_and_new.

Ejemplo: null
modeCadena de textoObligatorio

Regla explícita de acceso al archivo compartido. new_purchases / recent_and_new / selected / all_purchasers.

Ejemplo: "all_purchasers"
next_cursorCadena de texto nullObligatorio

Valor de continuación para la página siguiente, o null.

Ejemplo: null
order_idsLista <Cadena de texto> Obligatorio

Pedidos pagados y no reembolsados que contienen este producto.

Ejemplo: []
product_versionNúmero enteroObligatorio

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

Ejemplo: 3
revisionNúmero enteroObligatorio

Revisión sucesiva de la regla de acceso.

Ejemplo: 1

Campos adicionales: No

AudienceSelection

AudienceSelection · Elige las compras autorizadas. Los pedidos seleccionados deben contener este producto pagado y no reembolsado.
lookback_daysNúmero entero nullOpcional

1–3650 días antes de la primera publicación; solo recent_and_new.

Número entero:minimum: 1maximum: 3650
modeCadena de textoObligatorio

Regla explícita de acceso al archivo compartido. new_purchases / recent_and_new / selected / all_purchasers.

Restricciones
enum
["new_purchases", "recent_and_new", "selected", "all_purchasers"]
Ejemplo: "new_purchases"
order_idsLista <Cadena de texto> Opcional

Pedidos pagados y no reembolsados que contienen este producto.

maxItems: 1000
Restricciones · Lista 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Valor predeterminado: []

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

FileAssign

FileAssign · Campos, tipos y restricciones de los datos aceptados o devueltos por la API. Envía los archivos como multipart/form-data después de crear upload_id y asígnalos a un producto. La descarga requiere un token Bearer y permiso para category; la respuesta contiene los bytes, sin dirección pública ni contraseña. Para mode=period elige days (1–3650) o el valor anterior months, nunca ambos. Las condiciones se guardan al comprar; el reembolso revoca el acceso solo a la línea reembolsada.
audienceAudienceSelection nullOpcional

Regla explícita de acceso al archivo compartido.

Ejemplo: {"mode":"new_purchases"}
expected_versionNúmero enteroObligatorio

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

minimum: 1maximum: 9223372036854775807
Ejemplo: 1
labelCadena de textoOpcional

Nombre del recurso en el contexto correspondiente.

maxLength: 300
Valor predeterminado: ""
upload_idCadena de textoObligatorio

Identificador del recurso; consérvalo tal como se devuelve. · upload_id

format: "uuid"
Ejemplo: "00000000-0000-4000-8000-000000000001"

Campos adicionales: No

FileCategory

FileCategory · Campos, tipos y restricciones de los datos aceptados o devueltos por la API. Envía los archivos como multipart/form-data después de crear upload_id y asígnalos a un producto. La descarga requiere un token Bearer y permiso para category; la respuesta contiene los bytes, sin dirección pública ni contraseña. Para mode=period elige days (1–3650) o el valor anterior months, nunca ambos. Las condiciones se guardan al comprar; el reembolso revoca el acceso solo a la línea reembolsada.
Cadena de texto
Restricciones
enum
["internal", "customer_document", "digital"]

Campos adicionales: Sí

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: 30
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

ProductFileData

ProductFileData · Campos, tipos y restricciones de los datos aceptados o devueltos por la API. Envía los archivos como multipart/form-data después de crear upload_id y asígnalos a un producto. La descarga requiere un token Bearer y permiso para category; la respuesta contiene los bytes, sin dirección pública ni contraseña. Para mode=period elige days (1–3650) o el valor anterior months, nunca ambos. Las condiciones se guardan al comprar; el reembolso revoca el acceso solo a la línea reembolsada.
categoryFileCategory Obligatorio

Categoría del archivo: internal / customer_document / digital

Ejemplo: "digital"
created_atCadena de textoObligatorio

Momento de creación.

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

Identificador del recurso; consérvalo tal como se devuelve. · current_version_id

format: "uuid"
Ejemplo: "00000000-0000-4000-8000-000000000001"
file_idCadena de textoObligatorio

Identificador del recurso; consérvalo tal como se devuelve. · file_id

format: "uuid"
Ejemplo: "00000000-0000-4000-8000-000000000001"
filenameCadena de textoObligatorio

Archivo

Ejemplo: "manual.pdf"
idCadena de textoObligatorio

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

format: "uuid"
Ejemplo: "00000000-0000-4000-8000-000000000001"
labelCadena de textoObligatorio

Nombre del recurso en el contexto correspondiente.

Ejemplo: "Manual"
mime_typeCadena de textoObligatorio

Tipo de contenido multimedia.

Ejemplo: "application/pdf"
sha256Cadena de textoObligatorio

SHA-256 (hex, 64)

Ejemplo: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytesNúmero enteroObligatorio

Tamaño en bytes

Ejemplo: 46
stateCadena de textoObligatorio

Estado

Ejemplo: "active"
version_numberNúmero enteroObligatorio

Versión

Ejemplo: 1

Campos adicionales: No

ProductFileListData

ProductFileListData · Campos, tipos y restricciones de los datos aceptados o devueltos por la API. Envía los archivos como multipart/form-data después de crear upload_id y asígnalos a un producto. La descarga requiere un token Bearer y permiso para category; la respuesta contiene los bytes, sin dirección pública ni contraseña. Para mode=period elige days (1–3650) o el valor anterior months, nunca ambos. Las condiciones se guardan al comprar; el reembolso revoca el acceso solo a la línea reembolsada.
filesLista <ProductFileData > Obligatorio

Archivos del producto

Ejemplo: [{"category":"digital","created_at":"2026-01-01T12:00:00Z","current_version_id":"00000000-0000-4000-8000-000000000001","file_id":"00000000-0000-4000-8000-000000000001","filename":"manual.pdf","id":"00000000-0000-4000-8000-000000000001","label":"Manual","mime_type":"application/pdf","sha256":"5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd","size_bytes":46,"state":"active","version_number":1}]
product_versionNúmero enteroObligatorio

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

Ejemplo: 2

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: 30
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
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

ProductVersion

ProductVersion · Esta operación se retiró y devuelve 409 sin modificar datos. Configura el acceso de cada archivo digital mediante la selección de destinatarios.
expected_versionNúmero enteroObligatorio

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

minimum: 1maximum: 9223372036854775807
Ejemplo: 1

Campos adicionales: No

ReleaseData

ReleaseData · Campos, tipos y restricciones de los datos aceptados o devueltos por la API. Envía los archivos como multipart/form-data después de crear upload_id y asígnalos a un producto. La descarga requiere un token Bearer y permiso para category; la respuesta contiene los bytes, sin dirección pública ni contraseña. Para mode=period elige days (1–3650) o el valor anterior months, nunca ambos. Las condiciones se guardan al comprar; el reembolso revoca el acceso solo a la línea reembolsada.
changelogCadena de textoObligatorio

Descripción de los cambios

Ejemplo: "Manual update"
filesLista <ReleaseFileData > Obligatorio

Archivos del producto

Ejemplo: [{"file_id":"00000000-0000-4000-8000-000000000001","sort_order":0,"version_id":"00000000-0000-4000-8000-000000000001"}]
idCadena de textoObligatorio

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

format: "uuid"
Ejemplo: "00000000-0000-4000-8000-000000000001"
manifest_sha256Cadena de texto nullObligatorio

Versiones digitales · SHA-256

Ejemplo: "1111111111111111111111111111111111111111111111111111111111111111"
published_atCadena de texto nullObligatorio

Publicar versión · UTC

Cadena de texto:format: "date-time"
Ejemplo: null
release_sequenceNúmero entero nullObligatorio

Versiones digitales · Posición en la colección ordenada.

Ejemplo: null
stateCadena de textoObligatorio

Estado

Ejemplo: "active"
version_labelCadena de textoObligatorio

Versión

Ejemplo: "1.0"
withdrawn_atCadena de texto nullObligatorio

Retirar oferta · UTC

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

Campos adicionales: No

ReleaseDraft

ReleaseDraft · Esta operación se retiró y devuelve 409 sin modificar datos. Configura el acceso de cada archivo digital mediante la selección de destinatarios.
changelogCadena de textoOpcional

Descripción de los cambios

maxLength: 20000
Valor predeterminado: ""
expected_versionNúmero enteroObligatorio

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

minimum: 1maximum: 9223372036854775807
Ejemplo: 1
version_idsLista <Cadena de texto> Obligatorio

Versión · UUID[]

minItems: 1maxItems: 20
Lista:format: "uuid"
Ejemplo: ["00000000-0000-4000-8000-000000000001"]
version_labelCadena de textoObligatorio

Versión

minLength: 1maxLength: 64
Ejemplo: "1.0"

Campos adicionales: No

ReleaseFileData

ReleaseFileData · Campos, tipos y restricciones de los datos aceptados o devueltos por la API. Envía los archivos como multipart/form-data después de crear upload_id y asígnalos a un producto. La descarga requiere un token Bearer y permiso para category; la respuesta contiene los bytes, sin dirección pública ni contraseña. Para mode=period elige days (1–3650) o el valor anterior months, nunca ambos. Las condiciones se guardan al comprar; el reembolso revoca el acceso solo a la línea reembolsada.
file_idCadena de textoObligatorio

Identificador del recurso; consérvalo tal como se devuelve. · file_id

format: "uuid"
Ejemplo: "00000000-0000-4000-8000-000000000001"
sort_orderNúmero enteroObligatorio

Posición en la colección ordenada.

Ejemplo: 0
version_idCadena de textoObligatorio

Identificador del recurso; consérvalo tal como se devuelve. · version_id

format: "uuid"
Ejemplo: "00000000-0000-4000-8000-000000000001"

Campos adicionales: No

ReleaseListData

ReleaseListData · Campos, tipos y restricciones de los datos aceptados o devueltos por la API. Envía los archivos como multipart/form-data después de crear upload_id y asígnalos a un producto. La descarga requiere un token Bearer y permiso para category; la respuesta contiene los bytes, sin dirección pública ni contraseña. Para mode=period elige days (1–3650) o el valor anterior months, nunca ambos. Las condiciones se guardan al comprar; el reembolso revoca el acceso solo a la línea reembolsada.
current_release_idCadena de texto nullObligatorio

Identificador del recurso; consérvalo tal como se devuelve. · current_release_id

Cadena de texto:format: "uuid"
Ejemplo: "00000000-0000-4000-8000-000000000001"
product_versionNúmero enteroObligatorio

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

Ejemplo: 2
releasesLista <ReleaseData > Obligatorio

Versiones digitales

Ejemplo: [{"changelog":"Manual update","files":[{"file_id":"00000000-0000-4000-8000-000000000001","sort_order":0,"version_id":"00000000-0000-4000-8000-000000000001"}],"id":"00000000-0000-4000-8000-000000000001","manifest_sha256":"1111111111111111111111111111111111111111111111111111111111111111","published_at":null,"release_sequence":null,"state":"active","version_label":"1.0","withdrawn_at":null}]
update_daysNúmero entero nullObligatorio

Cantidad de días (days; null)

Ejemplo: 365
update_modeCadena de textoObligatorio

Acceso a futuros archivos después de la compra: none / period / unlimited

Ejemplo: "period"
update_monthsNúmero entero nullObligatorio

Meses (months; null)

Ejemplo: null

Campos adicionales: No

UpdatePolicy

UpdatePolicy · Esta operación se retiró y devuelve 409 sin modificar datos. Configura el acceso de cada archivo digital mediante la selección de destinatarios.
daysNúmero entero nullOpcional

Cantidad de días (1–3650; mode=period; months=null)

Número entero:minimum: 1maximum: 3650
Ejemplo: 365
expected_versionNúmero enteroObligatorio

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

minimum: 1maximum: 9223372036854775807
Ejemplo: 1
modeCadena de textoObligatorio

Acceso a futuros archivos después de la compra: none / period / unlimited

Restricciones
enum
["none", "period", "unlimited"]
Ejemplo: "period"
monthsNúmero entero nullOpcional

Meses (1–120; mode=period; days=null)

Número entero:minimum: 1maximum: 120
Ejemplo: null

Campos adicionales: No

UploadCreate

UploadCreate · Campos, tipos y restricciones de los datos aceptados o devueltos por la API. Envía los archivos como multipart/form-data después de crear upload_id y asígnalos a un producto. La descarga requiere un token Bearer y permiso para category; la respuesta contiene los bytes, sin dirección pública ni contraseña. Para mode=period elige days (1–3650) o el valor anterior months, nunca ambos. Las condiciones se guardan al comprar; el reembolso revoca el acceso solo a la línea reembolsada.
filenameCadena de textoObligatorio

Archivo

minLength: 1maxLength: 255
Ejemplo: "manual.pdf"
product_idCadena de texto nullOpcional

Identificador del producto.

Restricciones · Cadena de texto 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Ejemplo: "example"
sha256Cadena de textoObligatorio

SHA-256 (hex, 64)

Restricciones
pattern
"^[0-9a-f]{64}$"
Ejemplo: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytesNúmero enteroObligatorio

Tamaño en bytes

minimum: 1maximum: 262144000
Ejemplo: 46

Campos adicionales: No

UploadData

UploadData · Campos, tipos y restricciones de los datos aceptados o devueltos por la API. Envía los archivos como multipart/form-data después de crear upload_id y asígnalos a un producto. La descarga requiere un token Bearer y permiso para category; la respuesta contiene los bytes, sin dirección pública ni contraseña. Para mode=period elige days (1–3650) o el valor anterior months, nunca ambos. Las condiciones se guardan al comprar; el reembolso revoca el acceso solo a la línea reembolsada.
categoryFileCategory Obligatorio

Categoría del archivo: internal / customer_document / digital

Ejemplo: "digital"
expires_atCadena de textoObligatorio

Fecha y hora de caducidad de la credencial.

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

Archivo

Ejemplo: "manual.pdf"
idCadena de textoObligatorio

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

format: "uuid"
Ejemplo: "00000000-0000-4000-8000-000000000001"
product_idCadena de texto nullObligatorio

Identificador del producto.

Ejemplo: "example"
received_bytesNúmero enteroObligatorio

Subiendo… · Tamaño en bytes

Ejemplo: 46
sha256Cadena de textoObligatorio

SHA-256 (hex, 64)

Ejemplo: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytesNúmero enteroObligatorio

Tamaño en bytes

Ejemplo: 46
statusCadena de textoObligatorio

Estado admitido por esta operación concreta.

Ejemplo: "ready"

Campos adicionales: No