VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API legada/Guia rápido/Características

Alterar característica

Altera os dados de uma característica existente: nome, posição e status.

Use esta operação para renomear uma característica, mudar a posição dela ou ocultá-la. As alterações valem para todos os produtos que já têm valor nela. Esta rota não altera as opções (Vermelho, P, M).

Só os campos enviados mudam; os demais ficam como estão. Isso vale também para PUT: ele não substitui a característica inteira, é uma alteração parcial igual ao PATCH. O tipo (feature_type) não pode ser alterado depois de criado: para mudar o tipo, crie uma nova característica.

PUT/api/v1.0/features/{id}Admin

Alterar característica

Autenticação: HTTP Basic com e-mail:chave_de_api de um administrador, ou Authorization: Bearer <JWT>.

Parâmetros de caminho

iduuidobrigatório
Id da característica.

Corpo da requisição

descriptionstring
Novo nome da característica.
positioninteger
Nova posição de ordenação.
statusstring
AHD
Letra de status: A ativa, H oculta, D desativada.
variantsarray
Não altera as opções. Se o campo vier no corpo (mesmo vazio), a resposta devolve a lista de opções atual.
feature_typestring
Aceito mas ignorado: o tipo não muda.

Precisa vir pelo menos um dos campos description, position ou status. Um corpo sem nenhum deles volta 400.

PUT/api/features/{id}Admin

Alterar característica (forma sem versão)

Igual a /api/v1.0/features/{id}, com o mesmo corpo. Aqui o id do caminho precisa ser o UUID. Hoje o id decimal que a lista dessa forma devolve ("673694264") é recusado com 400 em alterações; use o UUID, que a rota aceita.

Exemplo de requisição

bash
curl -u "$EMAIL:$API_KEY" -X PUT \
  "$BASE_URL/api/v1.0/features/6d750dc5-6207-4809-9342-f9834c93a877" \
  -H "Content-Type: application/json" \
  -d '{ "description": "Cor do produto", "position": 7, "status": "H" }'

Resposta

200Característica alterada
json
{ "feature_id": "6d750dc5-6207-4809-9342-f9834c93a877" }

Campos da resposta

feature_idstring
Id da característica alterada.
variantsarray
Só aparece quando o corpo trouxe variants: as opções atuais, cada uma com variant_id, variant, position e, se houver, color.

A resposta não devolve a característica inteira. Para conferir o resultado, consulte-a com Consultar característica.

Erros

StatusQuandoCorpo
400Corpo que não é JSON{"message":"Invalid JSON","status":400}
400Nenhum campo para alterar, nome repetido{"message":"no fields to update","status":400}, {"message":"duplicate_feature_name: a feature named \"Cor\" already exists","status":400}
401Sem credenciais ou token expirado{"message":"Invalid credentials","status":401}
403Não é administrador{"message":"Forbidden: admin scope required","status":403}
404Característica inexistente{"message":"Feature not found","status":404}
Ocultar sem apagar

Para tirar uma característica da vitrine sem perder os valores já gravados nos produtos, mude o status para H (oculta) em vez de excluir. A exclusão é recusada enquanto algum produto tem valor nela (Excluir característica). Uma característica que não está ativa (A) também deixa de aparecer nos filtros da vitrine.

Veja também

  • Consultar característica
  • Excluir característica
  • Criar característica
Anterior
Criar característica
Próxima
Excluir característica
Nesta página
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também