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
/api/options/AdminCriar 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óriooption_namestringobrigatóriooption_typestringpadrão: SSRCITFS (caixa de seleção).requiredstringYNY para sim e N para não.inventorystringYNY para sim e N para não.main_pairobjectvariantsobjectTipos de opção
| Código | Tipo | Descrição |
|---|---|---|
S | Select box | Uma lista suspensa de opções |
R | Radiogroup | Um grupo de botões de opção (escolher um) |
C | Checkbox | Uma opção de caixa de marcação única |
I | Texto (uma linha) | Um campo de entrada de texto |
T | Text area | Uma área de entrada de texto com várias linhas |
F | File | Uma opção de envio de arquivo |
Exemplo de requisição
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).
Formato da resposta
Resposta de sucesso (201 Created)
{
"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
| Status | Quando |
|---|---|
201 Created | A opção foi criada. |
400 Bad Request | Nã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
requiredcom 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.