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

Consultar característica

Retorna uma característica pelo id, com a lista completa de opções.

Use esta operação quando já tem o id de uma característica (vindo de Listar características) e precisa do detalhe: as opções (variantes) que ela oferece, as cores das amostras, a que categorias e grupo ela pertence. É a única leitura que traz as opções junto da definição.

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

Consultar uma 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.
GET/api/features/{id}Admin

Consultar uma característica (forma sem versão)

Igual a /api/v1.0/features/{id}, mas o id do caminho pode ser o número decimal que a lista em /api/features devolve ("673694264"), e todos os ids da resposta saem em decimal, inclusive os de variant_id. O UUID também é aceito.

Parâmetros de caminho

idstringobrigatório
Id da característica, decimal em string ou UUID.

Exemplo de requisição

bash
curl -u "$EMAIL:$API_KEY" \
  "$BASE_URL/api/v1.0/features/a827c238-e0ce-4ff3-9655-478b5e3adf1b"

Resposta

200Característica retornada
json
{
  "feature_id": "a827c238-e0ce-4ff3-9655-478b5e3adf1b",
  "description": "Tamanho",
  "feature_type": "S",
  "company_id": "0",
  "position": 20,
  "status": "A",
  "categories_path": "",
  "purpose": "group_catalog_item",
  "filter_style": "",
  "variants": [
    { "variant_id": "1d13c44c-6575-403b-8ceb-e1cf37a5a862", "variant": "PP", "position": 1 },
    { "variant_id": "68399e61-4bf1-4762-b6d8-912c026a496a", "variant": "P", "position": 2 },
    { "variant_id": "177db45a-f708-4564-af8f-604b3053c5a1", "variant": "M", "position": 3 }
  ],
  "feature_style": "",
  "comparison": "Y",
  "display_on_catalog": "Y",
  "display_on_product": "Y",
  "display_on_header": "N",
  "full_description": "Tamanho de vestuário (letras)",
  "prefix": "",
  "sufix": "",
  "group_id": ""
}

Os campos são os mesmos de Listar características, com a diferença de que variants vem preenchido:

Campos da resposta

variantsarray
Opções da característica, na ordem de position. Vazio em característica sem lista (texto, número, data, caixa de marcação, grupo).
variants[].variant_idstring
Id da opção. UUID em /api/v1.0; decimal em string em /api/.
variants[].variantstring
Texto da opção (PP, Vermelho).
variants[].positioninteger
Posição de ordenação.
variants[].colorstring
Cor em hexadecimal (#FF0000). Só aparece nas opções que têm cor.

Erros

StatusQuandoCorpo
401Sem credenciais, chave inválida ou token expirado{"message":"Invalid credentials","status":401}
404Nenhuma característica com esse id{"message":"Feature not found","status":404}
500id que não é um UUID válido{"message":"query feature abc: pq: invalid input syntax for type uuid: \"abc\" (22P02)","status":500}
Id inválido volta 500, não 400

Um id mal formado deveria ser um erro de validação, mas hoje a plataforma responde 500. Valide que o id é um UUID antes de chamar. Em /api/features/{id} (sem versão), um decimal que não corresponde a nenhuma característica também volta 500.

Veja também

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