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

PUTAtualizar uma opção

Atualiza o tipo, as imagens e as variantes de uma opção de produto existente.

Para atualizar uma opção de produto existente, envie uma requisição PUT com o id da opção na URL e os dados da opção no corpo da requisição HTTP, de acordo com o Content-Type que você usar. Nenhum dos campos é obrigatório.

Atualizando opções de produto

PUT/api/options/{option_id}/Admin

Atualizar uma opção

Atualiza uma opção de produto existente. O exemplo de requisição da referência é PUT /api/options/27.

Parâmetros de caminho

option_idintegerobrigatório
O identificador único da opção.

Corpo da requisição

option_typestring
Tipo da opção (por exemplo, S para caixa de seleção, R para grupo de opções, C para caixa de marcação).
main_pairobject
Pares de imagens da opção.
variantsobject
Variantes (escolhas) disponíveis para esta opção.

Exemplo de corpo JSON

bash
curl -X PUT "$BASE_URL/api/options/27" \
  -u "$EMAIL:$API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "option_type": "S",
  "main_pair": {
    "icon": {
      "image_path": {
        "2": "https://www.venddor.com.br/image3.jpg",
        "3": "https://www.venddor.com.br/image4.jpg"
      }
    }
  },
  "variants": {
    "2": {
      "variant_name": "Gift wrap"
    },
    "3": {
      "variant_name": "Present box",
      "modifier_type": "P",
      "modifier": "20"
    }
  }
}'

Esta requisição altera vários aspectos da opção:

  • Muda o tipo da opção de grupo de opções para caixa de seleção.
  • Atualiza os ícones das variantes.
  • Remove a variante "None" (por não incluí-la).
  • Mantém a variante "Gift wrap" sem alteração.
  • Adiciona uma nova variante "Present box", que aumenta em 20% o preço do produto.
Importante

Ao atualizar o objeto variants, é preciso informar todas as variantes que devem permanecer na opção. Qualquer variante que não esteja na requisição é excluída.

Tipos de modificador

TipoDescrição
AValor absoluto (quantia fixa)
PPercentual (% do preço do produto)

Resposta

200Opção atualizada
json
{
  "option_id": "27"
}

Códigos de status da resposta

Código de statusDescrição
200 OKA opção foi atualizada com sucesso.
400 Bad RequestParâmetros da requisição inválidos.
404 Not FoundA opção com o ID informado não existe.

Veja também

  • Criar uma opção
  • Variantes da opção
Anterior
Criar uma opção
Próxima
Excluir uma opção
Nesta página
  • Atualizando opções de produto
  • Exemplo de corpo JSON
  • Tipos de modificador
  • Resposta
  • Códigos de status da resposta
  • Veja também