Esquemas de datos: Variantes y opciones

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

Esquemas de datos

Listar · Variantes del producto — Variantes y opciones — Respuesta

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

dataLista <ProductVariantData > Obligatorio: Ejemplo de respuesta · ApiResponse_list_ProductVariantData__.

Ejemplo: [{"active":true,"created_at":"2026-01-01T12:00:00Z","id":"example","is_default":true,"media_ids":["example"],"position":1,"pricing":{"base_adjustment":{"amount":"0.00","currency":"PLN","minor_units":2},"market_price":null,"price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"product_version":1,"version":1},"primary_media_id":"example","product_id":"example","sku":"example","updated_at":"2026-01-01T12:00:00Z","values":[{"option_id":"example","option_name":"example","value":"example","value_id":"example"}],"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

Listar · Opciones — Variantes y opciones — Respuesta

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

dataLista <shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData > Obligatorio: Ejemplo de respuesta · ApiResponse_list_VariantOptionData__.

Ejemplo: [{"created_at":"2026-01-01T12:00:00Z","id":"example","name":"Example","number":"example","position":1,"selection_type":"button","updated_at":"2026-01-01T12:00:00Z","value_presentation_type":"text","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

Listar · Valores de opciones — Variantes y opciones — Respuesta

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

dataLista <VariantValueData > Obligatorio: Ejemplo de respuesta · ApiResponse_list_VariantValueData__.

Ejemplo: [{"color_hex":"#008855","created_at":"2026-01-01T12:00:00Z","id":"example","image_media_id":null,"number":"example","option_id":"example","position":1,"sku_code":"example","updated_at":"2026-01-01T12:00:00Z","value":"example","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 · Variantes del producto — Variantes y opciones — Respuesta

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

dataProductVariantData Obligatorio: Ejemplo de respuesta · ProductVariantData.

Ejemplo: {"active":true,"created_at":"2026-01-01T12:00:00Z","id":"example","is_default":true,"media_ids":["example"],"position":1,"pricing":{"base_adjustment":{"amount":"0.00","currency":"PLN","minor_units":2},"market_price":null,"price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"product_version":1,"version":1},"primary_media_id":"example","product_id":"example","sku":"example","updated_at":"2026-01-01T12:00:00Z","values":[{"option_id":"example","option_name":"example","value":"example","value_id":"example"}],"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

Obtener · Opciones — Variantes y opciones — Respuesta

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

datashopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData Obligatorio: Ejemplo de respuesta · shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData.

Ejemplo: {"created_at":"2026-01-01T12:00:00Z","id":"example","name":"Example","number":"example","position":1,"selection_type":"button","updated_at":"2026-01-01T12:00:00Z","value_presentation_type":"text","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

Obtener · Valores de opciones — Variantes y opciones — Respuesta

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

dataVariantValueData Obligatorio: Ejemplo de respuesta · VariantValueData.

Ejemplo: {"color_hex":"#008855","created_at":"2026-01-01T12:00:00Z","id":"example","image_media_id":null,"number":"example","option_id":"example","position":1,"sku_code":"example","updated_at":"2026-01-01T12:00:00Z","value":"example","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

Obtener · Opciones — Variantes y opciones — Respuesta

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

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. (shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData).

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"

positionNúmero enteroObligatorio

Posición en la colección ordenada.

Ejemplo: 1

selection_typeCadena de textoObligatorio

Modo permitido de selección de valores de características.

Restricciones

enum: ["button", "dropdown"]

Ejemplo: "button"

updated_atCadena de textoObligatorio

Momento de la última actualización.

format: "date-time"

Ejemplo: "2026-01-01T12:00:00Z"

value_presentation_typeCadena de textoObligatorio

Forma de presentar los valores del catálogo.

Restricciones

enum: ["text", "color", "image"]

Ejemplo: "text"

versionNúmero enteroObligatorio

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

Ejemplo: 1

Campos adicionales: No

Obtener · Variantes del producto — Variantes y opciones — Respuesta

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

activeBooleanoObligatorio: Indica si el recurso está activo.

Ejemplo: true
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. (ProductVariantData).

Ejemplo: "example"
is_defaultBooleanoObligatorio: Indica si esta es la opción predeterminada.

Ejemplo: true
media_idsLista <Cadena de texto> Obligatorio: Identificadores de archivos multimedia ya existentes.

Ejemplo: ["example"]
positionNúmero enteroObligatorio: Posición en la colección ordenada.

Ejemplo: 1
pricingVariantPricingData Obligatorio: Configuración de precios y versiones para controlar cambios simultáneos.

Ejemplo: {"base_adjustment":{"amount":"0.00","currency":"PLN","minor_units":2},"market_price":null,"price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"product_version":1,"version":1}
primary_media_idCadena de texto nullObligatorio: Identificador del archivo multimedia principal.

Ejemplo: "example"
product_idCadena de textoObligatorio: Identificador del producto.

Ejemplo: "example"
skuCadena de textoObligatorio: Código de referencia de inventario.

Ejemplo: "example"
updated_atCadena de textoObligatorio: Momento de la última actualización.

format: "date-time"

Ejemplo: "2026-01-01T12:00:00Z"
valuesLista <VariantChoiceData > Obligatorio: Valores del catálogo.

Ejemplo: [{"option_id":"example","option_name":"example","value":"example","value_id":"example"}]
versionNúmero enteroObligatorio: Versión del recurso utilizada para controlar cambios simultáneos.

Ejemplo: 1

Campos adicionales: No

Valores del catálogo

VariantChoiceData · Esquema · Esquemas de datos: Variantes y opciones

option_idCadena de textoObligatorio: Identificador de la opción de variante.

Ejemplo: "example"
option_nameCadena de texto nullObligatorio: Nombre de la opción de variante.

Ejemplo: "example"
valueCadena de texto nullObligatorio: Valor definido por el esquema que lo contiene.

Ejemplo: "example"
value_idCadena de textoObligatorio: Identificador del valor del catálogo.

Ejemplo: "example"

Campos adicionales: No

Crear · Variantes del producto — Variantes y opciones — Cuerpo de la solicitud

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

activeBooleanoOpcional

Indica si el recurso está activo.

Valor predeterminado: true

expected_versionNúmero enteroObligatorio

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

minimum: 1maximum: 9223372036854775807

Ejemplo: 1

is_defaultBooleanoOpcional

Indica si esta es la opción predeterminada.

media_idsLista <Cadena de texto> Opcional

Identificadores de archivos multimedia ya existentes.

maxItems: 20

Lista:minLength: 1maxLength: 63

pricingVariantPrice Opcional

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

skuCadena de textoOpcional

Código de referencia de inventario.

minLength: 1maxLength: 100

Restricciones

pattern: "^\\S+$"

value_idsLista <Cadena de texto> Obligatorio

Identificadores de los valores del catálogo.

minItems: 1maxItems: 250

Lista:minLength: 1maxLength: 63

Ejemplo: ["example"]

Campos adicionales: No

Crear · Opciones — Variantes y opciones — Cuerpo de la solicitud

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

nameCadena de textoObligatorio

Nombre del recurso en el contexto correspondiente.

minLength: 1maxLength: 120

Restricciones

pattern: "^[^\\x00]*$"

Ejemplo: "Example"

selection_typeCadena de textoOpcional

Modo permitido de selección de valores de características.

Restricciones

enum: ["button", "dropdown"]

Valor predeterminado: "button"

value_presentation_typeCadena de textoOpcional

Forma de presentar los valores del catálogo.

Restricciones

enum: ["text", "color", "image"]

Valor predeterminado: "text"

Campos adicionales: No

Actualizar · Opciones — Variantes y opciones — Cuerpo de la solicitud

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

expected_versionNúmero enteroObligatorio

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

minimum: 1maximum: 9223372036854775807

Ejemplo: 1

nameCadena de texto nullOpcional

Nombre del recurso en el contexto correspondiente.

Cadena de texto:minLength: 1maxLength: 120

Restricciones · Cadena de texto 1

pattern: "^[^\\x00]*$"

Ejemplo: "Example"

selection_typeCadena de textoOpcional

Modo permitido de selección de valores de características.

Restricciones

enum: ["button", "dropdown"]

value_presentation_typeCadena de textoOpcional

Forma de presentar los valores del catálogo.

Restricciones

enum: ["text", "color", "image"]

Campos adicionales: No

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

VariantPrice · Esquema · Esquemas de datos: Variantes y opciones

amountCadena de texto nullObligatorio

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

Cadena de texto:maxLength: 20

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_product_versionNúmero enteroObligatorio

Versión del producto leída previamente y requerida para esta escritura.

minimum: 0maximum: 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_adjustment", "market_fixed"]

Ejemplo: "base_adjustment"

price_list_idCadena de textoObligatorio

Identificador de la lista de precios.

minLength: 1maxLength: 63

Ejemplo: "example"

Campos adicionales: No

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

VariantPricingData · Esquema · Esquemas de datos: Variantes y opciones

base_adjustmentMoneyData Obligatorio: Ajuste respecto al precio base.

Ejemplo: {"amount":"0.00","currency":"PLN","minor_units":2}
market_priceMoneyData nullObligatorio: Precio del mercado seleccionado.

Ejemplo: null
pricePriceData nullObligatorio: Información del precio en el contexto seleccionado.

Ejemplo: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
product_versionNúmero enteroObligatorio: Versión actual del producto para controlar cambios simultáneos.

Ejemplo: 1
versionNúmero enteroObligatorio: Versión del recurso utilizada para controlar cambios simultáneos.

Ejemplo: 1

Campos adicionales: No

Actualizar · Variantes del producto — Variantes y opciones — Cuerpo de la solicitud

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

activeBooleanoOpcional

Indica si el recurso está activo.

expected_versionNúmero enteroObligatorio

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

minimum: 1maximum: 9223372036854775807

Ejemplo: 1

is_defaultBooleanoOpcional

Indica si esta es la opción predeterminada.

media_idsLista <Cadena de texto> Opcional

Identificadores de archivos multimedia ya existentes.

maxItems: 20

Lista:minLength: 1maxLength: 63

pricingVariantPrice Opcional

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

Ejemplo:

{"amount":"0.00","currency":"PLN","expected_price_list_version":1,"expected_product_version":1,"expected_version":0,"kind":"base_adjustment","price_list_id":"example"}

skuCadena de textoOpcional

Código de referencia de inventario.

minLength: 1maxLength: 100

Restricciones

pattern: "^\\S+$"

Ejemplo: "example"

Campos adicionales: No

Crear · Valores de opciones — Variantes y opciones — Cuerpo de la solicitud

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

color_hexCadena de texto nullOpcional

Color representado mediante un código hexadecimal.

Restricciones · Cadena de texto 1

pattern: "^#[0-9A-Fa-f]{6}$"

expected_versionNúmero enteroObligatorio

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

minimum: 1maximum: 9223372036854775807

Ejemplo: 1

valueCadena de textoObligatorio

Valor definido por el esquema que lo contiene.

minLength: 1maxLength: 180

Restricciones

pattern: "^[^\\x00]*$"

Ejemplo: "Example"

Campos adicionales: No

Obtener · Valores de opciones — Variantes y opciones — Respuesta

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

color_hexCadena de texto nullObligatorio: Color representado mediante un código hexadecimal.

Ejemplo: "#008855"
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. (VariantValueData).

Ejemplo: "example"
image_media_idCadena de texto nullObligatorio: Identificador del archivo de imagen seleccionado.

Ejemplo: null
numberCadena de textoObligatorio: Número de pedido o solicitud mostrado al usuario.

Ejemplo: "example"
option_idCadena de textoObligatorio: Identificador de la opción de variante.

Ejemplo: "example"
positionNúmero enteroObligatorio: Posición en la colección ordenada.

Ejemplo: 1
sku_codeCadena de textoObligatorio: Código de referencia de inventario.

Ejemplo: "example"
updated_atCadena de textoObligatorio: Momento de la última actualización.

format: "date-time"

Ejemplo: "2026-01-01T12:00:00Z"
valueCadena de texto nullObligatorio: Valor definido por el esquema que lo contiene.

Ejemplo: "example"
versionNúmero enteroObligatorio: Versión del recurso utilizada para controlar cambios simultáneos.

Ejemplo: 1

Campos adicionales: No

Actualizar · Valores de opciones — Variantes y opciones — Cuerpo de la solicitud

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

color_hexCadena de texto nullOpcional

Color representado mediante un código hexadecimal.

Restricciones · Cadena de texto 1

pattern: "^#[0-9A-Fa-f]{6}$"

expected_versionNúmero enteroObligatorio

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

minimum: 1maximum: 9223372036854775807

Ejemplo: 1

valueCadena de texto nullOpcional

Valor definido por el esquema que lo contiene.

Cadena de texto:minLength: 1maxLength: 180

Restricciones · Cadena de texto 1

pattern: "^[^\\x00]*$"

Ejemplo: "Example"

Campos adicionales: No