VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API legada/Referência completa/Opções do produto

POSTCriar uma opção

Cria uma nova opção, com suas variantes, para um produto.

As opções de produto permitem que os clientes personalizem os produtos antes de comprar. Este endpoint cria uma nova opção para um produto, como tamanho, cor ou outra característica configurável.

Visão geral do endpoint

POST/api/options/Admin

Criar uma opção

Cria uma nova opção para um produto específico. Envie os parâmetros no corpo da requisição HTTP, de acordo com o Content-Type que você usar.

Corpo da requisição

product_idintegerobrigatório
O identificador único do produto ao qual a opção está associada.
option_namestringobrigatório
O nome da opção como ela aparecerá aos clientes.
option_typestringpadrão: S
SRCITF
O tipo de interface da opção. Se não for informado, vale S (caixa de seleção).
requiredstring
YN
Define se o cliente precisa informar esta opção antes de adicionar o produto ao carrinho. Use Y para sim e N para não.
inventorystring
YN
Define se a opção é considerada na formação do estoque do produto. Use Y para sim e N para não.
main_pairobject
Um objeto com os ícones das variantes da opção.
variantsobject
Um objeto com as variantes da opção. Cada variante pode ter propriedades próprias, como nome e modificador de preço. Em caixas de seleção, grupos de opções e caixas de marcação, você pode definir as variantes na própria requisição.

Tipos de opção

CódigoTipoDescrição
SSelect boxUma lista suspensa de opções
RRadiogroupUm grupo de botões de opção (escolher um)
CCheckboxUma opção de caixa de marcação única
ITexto (uma linha)Um campo de entrada de texto
TText areaUma área de entrada de texto com várias linhas
FFileUma opção de envio de arquivo

Exemplo de requisição

bash
curl -X POST "$BASE_URL/api/options/" \
  -u "$EMAIL:$API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "product_id": "12",
  "option_name": "Packaging",
  "option_type": "R",
  "required": "Y",
  "inventory": "N",
  "main_pair": {
    "icon": {
      "image_path": {
        "1": "https://www.venddor.com.br/image1.jpg",
        "2": "https://www.venddor.com.br/image2.jpg"
      }
    }
  },
  "variants": {
    "1": {
      "variant_name": "None"
    },
    "2": {
      "variant_name": "Gift wrap",
      "modifier_type": "A",
      "modifier": "5"
    }
  }
}'

Esta requisição cria uma nova opção "Packaging" para o produto com product_id=12. A opção tem duas variantes:

  • None: embalagem padrão, sem alteração de preço.
  • Gift wrap: soma 5 ao preço do produto (modifier_type="A" para valor absoluto).
Observação

No campo modifier_type, use A para valor absoluto (como 5) e P para porcentagem (como 10%).

Formato da resposta

Resposta de sucesso (201 Created)

201Opção criada
json
{
  "option_id": 27
}

Resposta de erro (400 Bad Request)

Retornada quando não foi possível criar a opção por causa de parâmetros inválidos ou de outros problemas.

Erros

StatusQuando
201 CreatedA opção foi criada.
400 Bad RequestNão foi possível criar a opção por causa de parâmetros inválidos ou de outros problemas.

Notas de implementação

As opções de produto melhoram a sua loja ao permitir que os clientes personalizem os produtos. Ao criar opções, considere estas boas práticas:

  • Escolha o tipo de opção adequado:
    • Use caixa de seleção ou grupo de opções para opções com várias escolhas que se excluem (como tamanho ou cor).
    • Use caixa de marcação para opções simples de sim ou não (como "Adicionar embalagem de presente?").
    • Use campos de texto para personalização (como texto de gravação ou monogramas).
    • Use envio de arquivo para designs ou imagens fornecidos pelo cliente.
  • Defina o indicador required com critério: só torne uma opção obrigatória se o produto realmente não puder ser vendido sem a escolha.
  • Ao usar inventory=Y, crie também as combinações de opções adequadas para o controle de estoque.
  • Considere adicionar modificadores de preço às opções que alteram bastante o custo do produto.
  • Dê nomes claros e descritivos tanto às opções quanto às variantes.
Dica

Em opções visuais, como cores ou estampas, inclua imagens para cada variante e melhore a experiência de compra.

Veja também

  • Atualizar uma opção
  • Variantes da opção
Anterior
Variantes da opção
Próxima
Atualizar uma opção
Nesta página
  • Visão geral do endpoint
  • Tipos de opção
  • Exemplo de requisição
  • Formato da resposta
  • Erros
  • Notas de implementação
  • Veja também