API legada/Referência completa/Opções do produto

Detalhes da opção

A referência completa dos campos de uma opção de produto, com um objeto de exemplo.

As opções de produto permitem que os clientes personalizem os produtos antes de adicioná-los ao carrinho, por exemplo escolhendo um tamanho ou uma cor, ou acrescentando personalização. Esta página descreve os campos e as propriedades de uma opção de produto.

Referência dos campos da opção

As tabelas a seguir listam todos os campos disponíveis nas opções de produto.

Informações básicas

Campo	Valores	Descrição
`option_id`	integer	Um identificador único da opção.
`product_id`	integer	Um identificador único do produto ao qual a opção está associada.
`company_id`	integer	ID do vendedor associado.
`option_name`	string	O nome da opção como é exibido aos clientes (por exemplo, "Size", "Color").
`position`	integer	Define a posição da opção entre as demais. Quanto menor o número, mais acima a opção aparece na lista de opções do painel de administração.

Configuração da opção

Campo	Valores	Descrição
`option_type`	string	O tipo da opção: `S` caixa de seleção, `R` grupo de opções, `C` caixa de marcação, `I` texto (uma linha), `T` área de texto, `F` arquivo.
`required`	Y/N	Se a opção é obrigatória (`Y`), o cliente não consegue adicionar o produto ao carrinho sem informá-la. Por exemplo, se uma caixa de marcação tem `required=Y`, o cliente precisa marcá-la antes de adicionar o produto ao carrinho.
`inventory`	Y/N	Se ativada (`Y`), a opção é considerada na formação do estoque do produto.
`status`	string	O status da opção: `A` ativa, `D` desativada.
`value`	string	O número da variante da opção ou o texto que o cliente digitou em uma opção `Text` ou `Text area`.

Configurações de exibição

Campo	Valores	Descrição
`description`	string	Se você preencher este campo, um ícone `?` (dica) aparece ao lado do nome da opção na página do produto. Ao passar o mouse sobre o ícone, o cliente vê o texto da descrição.
`inner_hint`	string	Uma dica que aparece no campo de uma opção `Text` ou `Text area`. Ela diz ao cliente o que digitar no campo. A dica não é um valor padrão.
`comment`	string	O texto que aparece abaixo da opção na vitrine.
`missing_variants_handling`	string	Se o tipo da opção é `Select box` ou `Radiogroup`, você pode indicar as variantes entre as quais o cliente escolhe. Este campo define o que fazer quando o administrador não criou variantes para a opção. `M`: exibe uma mensagem ao lado do nome da opção (por padrão, a mensagem é "N/A"). `H`: oculta esta opção.

Configurações de validação

Campo	Valores	Descrição
`regexp`	string	Se o tipo da opção é `Text` ou `Text area`, você pode usar expressões regulares para limitar o que o usuário digita no campo.
`incorrect_message`	string	Se você usa `regexp` em opções `Text` ou `Text area`, esta mensagem aparece quando o texto digitado não atende à expressão regular.

Configurações de envio de arquivo

Campo	Valores	Descrição
`multiupload`	Y/N	Se o tipo da opção é `File`, você escolhe se o cliente pode enviar vários arquivos (`Y`) ou só um (`N`).
`allowed_extensions`	string	Se o tipo da opção é `File`, você pode indicar as extensões permitidas, separadas por vírgula (por exemplo, `jpg,bmp,gif,pdf`).
`max_file_size`	integer	O tamanho máximo dos arquivos enviados, em quilobytes.

Variantes da opção

Campo	Valores	Descrição
`variants`	object	As variantes da opção. As variantes existem nas opções do tipo `Select box` ou `Radiogroup`. Uma opção do tipo `Checkbox` tem 2 variantes por padrão.

Exemplo de objeto de opção

json

{
  "option_id": "42",
  "product_id": "101",
  "company_id": "1",
  "option_type": "S",
  "option_name": "Size",
  "description": "Please select your size based on our sizing chart",
  "required": "Y",
  "status": "A",
  "position": "10",
  "inventory": "Y",
  "missing_variants_handling": "H",
  "comment": "Sizes run slightly small, consider ordering one size up",
  "variants": {
    "16": {
      "variant_id": "16",
      "option_id": "42",
      "variant_name": "Small",
      "position": "10",
      "modifier": "0.00",
      "modifier_type": "A"
    },
    "17": {
      "variant_id": "17",
      "option_id": "42",
      "variant_name": "Medium",
      "position": "20",
      "modifier": "0.00",
      "modifier_type": "A"
    },
    "18": {
      "variant_id": "18",
      "option_id": "42",
      "variant_name": "Large",
      "position": "30",
      "modifier": "0.00",
      "modifier_type": "A"
    },
    "19": {
      "variant_id": "19",
      "option_id": "42",
      "variant_name": "X-Large",
      "position": "40",
      "modifier": "2.50",
      "modifier_type": "A"
    }
  }
}

Veja também