Esquemas de dados: Variantes e opções

Esquemas de dados: Variantes e opções. Campos, tipos e restrições dos dados aceitos ou retornados pela API.

Esquemas de dados

Listar · Variantes do produto — Variantes e opções — Resposta

ApiResponse_list_ProductVariantData__ · Campos, tipos e restrições dos dados aceitos ou retornados pela API.

dataLista <ProductVariantData > Obrigatório: Exemplo de resposta · ApiResponse_list_ProductVariantData__.

Exemplo: [{"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 Obrigatório: Metadados da resposta.

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

Campos adicionais: Não

Listar · Opções — Variantes e opções — Resposta

ApiResponse_list_VariantOptionData__ · Campos, tipos e restrições dos dados aceitos ou retornados pela API.

dataLista <shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData > Obrigatório: Exemplo de resposta · ApiResponse_list_VariantOptionData__.

Exemplo: [{"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 Obrigatório: Metadados da resposta.

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

Campos adicionais: Não

Listar · Valores das opções — Variantes e opções — Resposta

ApiResponse_list_VariantValueData__ · Campos, tipos e restrições dos dados aceitos ou retornados pela API.

dataLista <VariantValueData > Obrigatório: Exemplo de resposta · ApiResponse_list_VariantValueData__.

Exemplo: [{"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 Obrigatório: Metadados da resposta.

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

Campos adicionais: Não

Obter · Variantes do produto — Variantes e opções — Resposta

ApiResponse_ProductVariantData_ · Campos, tipos e restrições dos dados aceitos ou retornados pela API.

dataProductVariantData Obrigatório: Exemplo de resposta · ProductVariantData.

Exemplo: {"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 Obrigatório: Metadados da resposta.

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

Campos adicionais: Não

Obter · Opções — Variantes e opções — Resposta

ApiResponse_VariantOptionData_ · Campos, tipos e restrições dos dados aceitos ou retornados pela API.

datashopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData Obrigatório: Exemplo de resposta · shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData.

Exemplo: {"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 Obrigatório: Metadados da resposta.

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

Campos adicionais: Não

Obter · Valores das opções — Variantes e opções — Resposta

ApiResponse_VariantValueData_ · Campos, tipos e restrições dos dados aceitos ou retornados pela API.

dataVariantValueData Obrigatório: Exemplo de resposta · VariantValueData.

Exemplo: {"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 Obrigatório: Metadados da resposta.

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

Campos adicionais: Não

Obter · Opções — Variantes e opções — Resposta

shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData · Campos, tipos e restrições dos dados aceitos ou retornados pela API.

created_atTextoObrigatório

Momento da criação.

format: "date-time"

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

idTextoObrigatório

Identificador do recurso; preserve-o conforme retornado. (shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData).

Exemplo: "example"

nameTexto nullObrigatório

Nome do recurso no contexto correspondente.

Exemplo: "Example"

numberTextoObrigatório

Número do pedido ou da solicitação exibido ao usuário.

Exemplo: "example"

positionNúmero inteiroObrigatório

Posição na coleção ordenada.

Exemplo: 1

selection_typeTextoObrigatório

Modo permitido de seleção de valores de características.

Restrições

enum: ["button", "dropdown"]

Exemplo: "button"

updated_atTextoObrigatório

Momento da atualização mais recente.

format: "date-time"

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

value_presentation_typeTextoObrigatório

Forma de apresentação dos valores do catálogo.

Restrições

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

Exemplo: "text"

versionNúmero inteiroObrigatório

Versão do recurso utilizada para controle de concorrência.

Exemplo: 1

Campos adicionais: Não

Obter · Variantes do produto — Variantes e opções — Resposta

ProductVariantData · Campos, tipos e restrições dos dados aceitos ou retornados pela API.

activeBooleanoObrigatório: Indica se o recurso está ativo.

Exemplo: true
created_atTextoObrigatório: Momento da criação.

format: "date-time"

Exemplo: "2026-01-01T12:00:00Z"
idTextoObrigatório: Identificador do recurso; preserve-o conforme retornado. (ProductVariantData).

Exemplo: "example"
is_defaultBooleanoObrigatório: Indica se esta é a opção padrão.

Exemplo: true
media_idsLista <Texto> Obrigatório: Identificadores de arquivos de mídia já existentes.

Exemplo: ["example"]
positionNúmero inteiroObrigatório: Posição na coleção ordenada.

Exemplo: 1
pricingVariantPricingData Obrigatório: Configuração de preços e versões para controle de concorrência.

Exemplo: {"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_idTexto nullObrigatório: Identificador do arquivo de mídia principal.

Exemplo: "example"
product_idTextoObrigatório: Identificador do produto.

Exemplo: "example"
skuTextoObrigatório: Código da unidade de manutenção de estoque.

Exemplo: "example"
updated_atTextoObrigatório: Momento da atualização mais recente.

format: "date-time"

Exemplo: "2026-01-01T12:00:00Z"
valuesLista <VariantChoiceData > Obrigatório: Valores do catálogo.

Exemplo: [{"option_id":"example","option_name":"example","value":"example","value_id":"example"}]
versionNúmero inteiroObrigatório: Versão do recurso utilizada para controle de concorrência.

Exemplo: 1

Campos adicionais: Não

Valores do catálogo

VariantChoiceData · Esquema · Esquemas de dados: Variantes e opções

option_idTextoObrigatório: Identificador da opção de variante.

Exemplo: "example"
option_nameTexto nullObrigatório: Nome da opção de variante.

Exemplo: "example"
valueTexto nullObrigatório: Valor definido pelo esquema que o contém.

Exemplo: "example"
value_idTextoObrigatório: Identificador do valor do catálogo.

Exemplo: "example"

Campos adicionais: Não

Criar · Variantes do produto — Variantes e opções — Corpo da requisição

VariantCreate · Campos, tipos e restrições dos dados aceitos ou retornados pela API.

activeBooleanoOpcional

Indica se o recurso está ativo.

Padrão: true

expected_versionNúmero inteiroObrigatório

Versão lida antes da escrita; uma divergência rejeita a atualização.

minimum: 1maximum: 9223372036854775807

Exemplo: 1

is_defaultBooleanoOpcional

Indica se esta é a opção padrão.

media_idsLista <Texto> Opcional

Identificadores de arquivos de mídia já existentes.

maxItems: 20

Lista:minLength: 1maxLength: 63

pricingVariantPrice Opcional

Configuração de preços e versões para controle de concorrência.

skuTextoOpcional

Código da unidade de manutenção de estoque.

minLength: 1maxLength: 100

Restrições

pattern: "^\\S+$"

value_idsLista <Texto> Obrigatório

Identificadores dos valores do catálogo.

minItems: 1maxItems: 250

Lista:minLength: 1maxLength: 63

Exemplo: ["example"]

Campos adicionais: Não

Criar · Opções — Variantes e opções — Corpo da requisição

VariantOptionCreate · Campos, tipos e restrições dos dados aceitos ou retornados pela API.

nameTextoObrigatório

Nome do recurso no contexto correspondente.

minLength: 1maxLength: 120

Restrições

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

Exemplo: "Example"

selection_typeTextoOpcional

Modo permitido de seleção de valores de características.

Restrições

enum: ["button", "dropdown"]

Padrão: "button"

value_presentation_typeTextoOpcional

Forma de apresentação dos valores do catálogo.

Restrições

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

Padrão: "text"

Campos adicionais: Não

Atualizar · Opções — Variantes e opções — Corpo da requisição

VariantOptionUpdate · Campos, tipos e restrições dos dados aceitos ou retornados pela API.

expected_versionNúmero inteiroObrigatório

Versão lida antes da escrita; uma divergência rejeita a atualização.

minimum: 1maximum: 9223372036854775807

Exemplo: 1

nameTexto nullOpcional

Nome do recurso no contexto correspondente.

Texto:minLength: 1maxLength: 120

Restrições · Texto 1

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

Exemplo: "Example"

selection_typeTextoOpcional

Modo permitido de seleção de valores de características.

Restrições

enum: ["button", "dropdown"]

value_presentation_typeTextoOpcional

Forma de apresentação dos valores do catálogo.

Restrições

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

Campos adicionais: Não

Configuração de preços e versões para controle de concorrência

VariantPrice · Esquema · Esquemas de dados: Variantes e opções

amountTexto nullObrigatório

Valor decimal codificado como texto JSON; null apenas quando permitido.

Texto:maxLength: 20

Restrições · Texto 1

pattern: "^-?(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"

Exemplo: "0.00"

currencyTextoObrigatório

Código da moeda do valor.

Restrições

pattern: "^[A-Z]{3}$"

Exemplo: "PLN"

expected_price_list_versionNúmero inteiroObrigatório

Versão da lista de preços lida anteriormente e exigida nesta escrita.

minimum: 1maximum: 9223372036854775807

Exemplo: 1

expected_product_versionNúmero inteiroObrigatório

Versão do produto lida anteriormente e exigida nesta escrita.

minimum: 0maximum: 9223372036854775807

Exemplo: 1

expected_versionNúmero inteiroObrigatório

Versão lida antes da escrita; uma divergência rejeita a atualização.

minimum: 0maximum: 9223372036854775807

Exemplo: 0

kindTextoObrigatório

Variante da estrutura de dados definida pelos valores permitidos.

Restrições

enum: ["base_adjustment", "market_fixed"]

Exemplo: "base_adjustment"

price_list_idTextoObrigatório

Identificador da lista de preços.

minLength: 1maxLength: 63

Exemplo: "example"

Campos adicionais: Não

Configuração de preços e versões para controle de concorrência

VariantPricingData · Esquema · Esquemas de dados: Variantes e opções

base_adjustmentMoneyData Obrigatório: Ajuste de preço em relação ao preço base.

Exemplo: {"amount":"0.00","currency":"PLN","minor_units":2}
market_priceMoneyData nullObrigatório: Preço do mercado selecionado.

Exemplo: null
pricePriceData nullObrigatório: Informações do preço no contexto selecionado.

Exemplo: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
product_versionNúmero inteiroObrigatório: Versão atual do produto para controle de concorrência.

Exemplo: 1
versionNúmero inteiroObrigatório: Versão do recurso utilizada para controle de concorrência.

Exemplo: 1

Campos adicionais: Não

Atualizar · Variantes do produto — Variantes e opções — Corpo da requisição

VariantUpdate · Campos, tipos e restrições dos dados aceitos ou retornados pela API.

activeBooleanoOpcional

Indica se o recurso está ativo.

expected_versionNúmero inteiroObrigatório

Versão lida antes da escrita; uma divergência rejeita a atualização.

minimum: 1maximum: 9223372036854775807

Exemplo: 1

is_defaultBooleanoOpcional

Indica se esta é a opção padrão.

media_idsLista <Texto> Opcional

Identificadores de arquivos de mídia já existentes.

maxItems: 20

Lista:minLength: 1maxLength: 63

pricingVariantPrice Opcional

Configuração de preços e versões para controle de concorrência.

Exemplo:

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

skuTextoOpcional

Código da unidade de manutenção de estoque.

minLength: 1maxLength: 100

Restrições

pattern: "^\\S+$"

Exemplo: "example"

Campos adicionais: Não

Criar · Valores das opções — Variantes e opções — Corpo da requisição

VariantValueCreate · Campos, tipos e restrições dos dados aceitos ou retornados pela API.

color_hexTexto nullOpcional

Cor representada por um código hexadecimal.

Restrições · Texto 1

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

expected_versionNúmero inteiroObrigatório

Versão lida antes da escrita; uma divergência rejeita a atualização.

minimum: 1maximum: 9223372036854775807

Exemplo: 1

valueTextoObrigatório

Valor definido pelo esquema que o contém.

minLength: 1maxLength: 180

Restrições

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

Exemplo: "Example"

Campos adicionais: Não

Obter · Valores das opções — Variantes e opções — Resposta

VariantValueData · Campos, tipos e restrições dos dados aceitos ou retornados pela API.

color_hexTexto nullObrigatório: Cor representada por um código hexadecimal.

Exemplo: "#008855"
created_atTextoObrigatório: Momento da criação.

format: "date-time"

Exemplo: "2026-01-01T12:00:00Z"
idTextoObrigatório: Identificador do recurso; preserve-o conforme retornado. (VariantValueData).

Exemplo: "example"
image_media_idTexto nullObrigatório: Identificador do arquivo de imagem selecionado.

Exemplo: null
numberTextoObrigatório: Número do pedido ou da solicitação exibido ao usuário.

Exemplo: "example"
option_idTextoObrigatório: Identificador da opção de variante.

Exemplo: "example"
positionNúmero inteiroObrigatório: Posição na coleção ordenada.

Exemplo: 1
sku_codeTextoObrigatório: Código da unidade de manutenção de estoque.

Exemplo: "example"
updated_atTextoObrigatório: Momento da atualização mais recente.

format: "date-time"

Exemplo: "2026-01-01T12:00:00Z"
valueTexto nullObrigatório: Valor definido pelo esquema que o contém.

Exemplo: "example"
versionNúmero inteiroObrigatório: Versão do recurso utilizada para controle de concorrência.

Exemplo: 1

Campos adicionais: Não

Atualizar · Valores das opções — Variantes e opções — Corpo da requisição

VariantValueUpdate · Campos, tipos e restrições dos dados aceitos ou retornados pela API.

color_hexTexto nullOpcional

Cor representada por um código hexadecimal.

Restrições · Texto 1

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

expected_versionNúmero inteiroObrigatório

Versão lida antes da escrita; uma divergência rejeita a atualização.

minimum: 1maximum: 9223372036854775807

Exemplo: 1

valueTexto nullOpcional

Valor definido pelo esquema que o contém.

Texto:minLength: 1maxLength: 180

Restrições · Texto 1

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

Exemplo: "Example"

Campos adicionais: Não