Listar características

Retorna as características cadastradas na loja, com filtro por tipo e paginação.

Use esta operação para ler o cadastro de características da loja: montar uma tela de administração, sincronizar o catálogo com um ERP ou descobrir o id de uma característica antes de gravar valores em produtos. A lista traz a definição de cada característica (nome, tipo, onde aparece, a que grupo pertence). Ela não traz as opções (as variantes) nem os valores dos produtos. Para as opções, use Consultar característica.

A lista mistura características comuns e grupos (feature_type igual a G). Para ver só os grupos, filtre por feature_type=G.

GET/api/v1.0/featuresAdmin

A lista é ordenada por position e depois por nome. Autenticação: HTTP Basic com e-mail:chave_de_api de um administrador, ou Authorization: Bearer <JWT>.

Parâmetros de consulta

pageintegerpadrão: 1

Página, a partir de 1. Valor inválido ou menor que 1 é ignorado.

items_per_pageintegerpadrão: 10

Itens por página, de 1 a 250. Texto, 0 ou valor acima de 250 são ignorados e valem 10.

feature_typestring

CSMTNOGE

Filtra pelo tipo, em letra. S devolve só as de lista simples e não inclui as de cor. Uma letra desconhecida não dá erro, apenas devolve lista vazia.

GET/api/featuresAdmin

Listar características (forma sem versão)

Igual a /api/v1.0/features, com os mesmos parâmetros e o mesmo corpo, exceto pelos ids: feature_id e group_id saem como números decimais dentro de uma string ("673694264"), no estilo da Venddor 1.0. Use esta forma só se o seu cliente espera ids inteiros.

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" \
  "$BASE_URL/api/v1.0/features?items_per_page=50&feature_type=S"

Resposta

200Características retornadas

json

{
  "features": [
    {
      "feature_id": "ab4e8643-fed7-4b87-8fbe-0ffb4fad088f",
      "description": "Geradas por IA (revisar)",
      "feature_type": "G",
      "company_id": "0",
      "position": 0,
      "status": "A",
      "categories_path": "",
      "purpose": "",
      "filter_style": "",
      "variants": [],
      "feature_style": "",
      "comparison": "Y",
      "display_on_catalog": "N",
      "display_on_product": "Y",
      "display_on_header": "N",
      "full_description": "Características propostas pela IA, aguardando revisão humana.",
      "prefix": "",
      "sufix": "",
      "group_id": ""
    }
  ],
  "params": { "page": 1, "items_per_page": 10, "total_items": 32 }
}

Campos da resposta

featuresarray

Características da página.

features[].feature_idstring

Id da característica. UUID em /api/v1.0; decimal em string em /api/.

features[].descriptionstring

Nome da característica (neste contrato o campo se chama description). O texto longo está em full_description.

features[].feature_typestring

CSMTNOGE

Tipo em letra: C caixa de marcação, S lista, M lista múltipla, T texto, N número, O data, G grupo, E marca. Cor sai como S com filter_style igual a color; autor sai como T.

features[].company_idstring

Sempre "0": características pertencem à loja, não a um seller.

features[].positioninteger

Posição de ordenação, do menor para o maior.

features[].statusstring

AHD

Letra de status. Veja a observação abaixo sobre H e D.

features[].categories_pathstring

Ids das categorias onde a característica vale, separados por vírgula. Vazio significa todas as categorias.

features[].purposestring

group_catalog_itemgroup_variation_catalog_item

Ligação com variações de produto. Vazio em característica comum.

features[].filter_stylestring

colorcheckboxsliderdate_range

Estilo do filtro. color em característica de cor. Nos demais tipos, vazio quando a característica não é filtrável e checkbox, slider (número) ou date_range (data) quando é.

features[].feature_stylestring

Espelha filter_style.

features[].variantsarray

Na lista, sempre []. As opções só vêm na consulta por id.

features[].comparisonstring

YN

Y quando a característica entra na tabela de comparação (comparable).

features[].display_on_catalogstring

YN

Y quando aparece como selo nos cartões de produto.

features[].display_on_productstring

YN

Y quando aparece na página do produto.

features[].display_on_headerstring

Sempre "N" (campo mantido por compatibilidade).

features[].full_descriptionstring

Descrição longa da característica.

features[].prefixstring

Prefixo exibido junto ao valor (por exemplo R$).

features[].sufixstring

Sufixo exibido junto ao valor (por exemplo kg). O nome do campo é sufix, com um f, como na Venddor 1.0.

features[].group_idstring

Id do grupo ao qual a característica pertence. Vazio quando não pertence a nenhum.

params.pageinteger

Página retornada.

params.items_per_pageinteger

Itens por página aplicados.

params.total_itemsinteger

Total de características que atendem ao filtro, em todas as páginas.

Erros

Status	Quando	Corpo
401	Sem credenciais, chave de API inválida ou token expirado	`{"message":"Invalid credentials","status":401}`
429	Limite de requisições (por exemplo, login repetido)	`{"error":"rate limit exceeded","detail":"too many requests, please try again later"}`

Veja também

Listar características

Retorna as características cadastradas na loja, com filtro por tipo e paginação.

A lista mistura características comuns e grupos (feature_type igual a G). Para ver só os grupos, filtre por feature_type=G.

GET/api/v1.0/featuresAdmin

Listar características

A lista é ordenada por position e depois por nome. Autenticação: HTTP Basic com e-mail:chave_de_api de um administrador, ou Authorization: Bearer <JWT>.

Parâmetros de consulta

pageintegerpadrão: 1

Página, a partir de 1. Valor inválido ou menor que 1 é ignorado.

items_per_pageintegerpadrão: 10

Itens por página, de 1 a 250. Texto, 0 ou valor acima de 250 são ignorados e valem 10.

feature_typestring

CSMTNOGE

Filtra pelo tipo, em letra. S devolve só as de lista simples e não inclui as de cor. Uma letra desconhecida não dá erro, apenas devolve lista vazia.

GET/api/featuresAdmin

Listar características (forma sem versão)

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" \
  "$BASE_URL/api/v1.0/features?items_per_page=50&feature_type=S"

Resposta

200Características retornadas

json

{
  "features": [
    {
      "feature_id": "ab4e8643-fed7-4b87-8fbe-0ffb4fad088f",
      "description": "Geradas por IA (revisar)",
      "feature_type": "G",
      "company_id": "0",
      "position": 0,
      "status": "A",
      "categories_path": "",
      "purpose": "",
      "filter_style": "",
      "variants": [],
      "feature_style": "",
      "comparison": "Y",
      "display_on_catalog": "N",
      "display_on_product": "Y",
      "display_on_header": "N",
      "full_description": "Características propostas pela IA, aguardando revisão humana.",
      "prefix": "",
      "sufix": "",
      "group_id": ""
    }
  ],
  "params": { "page": 1, "items_per_page": 10, "total_items": 32 }
}

Campos da resposta

featuresarray

Características da página.

features[].feature_idstring

Id da característica. UUID em /api/v1.0; decimal em string em /api/.

features[].descriptionstring

Nome da característica (neste contrato o campo se chama description). O texto longo está em full_description.

features[].feature_typestring

CSMTNOGE

features[].company_idstring

Sempre "0": características pertencem à loja, não a um seller.

features[].positioninteger

Posição de ordenação, do menor para o maior.

features[].statusstring

AHD

Letra de status. Veja a observação abaixo sobre H e D.

features[].categories_pathstring

Ids das categorias onde a característica vale, separados por vírgula. Vazio significa todas as categorias.

features[].purposestring

group_catalog_itemgroup_variation_catalog_item

Ligação com variações de produto. Vazio em característica comum.

features[].filter_stylestring

colorcheckboxsliderdate_range

Estilo do filtro. color em característica de cor. Nos demais tipos, vazio quando a característica não é filtrável e checkbox, slider (número) ou date_range (data) quando é.

features[].feature_stylestring

Espelha filter_style.

features[].variantsarray

Na lista, sempre []. As opções só vêm na consulta por id.

features[].comparisonstring

YN

Y quando a característica entra na tabela de comparação (comparable).

features[].display_on_catalogstring

YN

Y quando aparece como selo nos cartões de produto.

features[].display_on_productstring

YN

Y quando aparece na página do produto.

features[].display_on_headerstring

Sempre "N" (campo mantido por compatibilidade).

features[].full_descriptionstring

Descrição longa da característica.

features[].prefixstring

Prefixo exibido junto ao valor (por exemplo R$).

features[].sufixstring

Sufixo exibido junto ao valor (por exemplo kg). O nome do campo é sufix, com um f, como na Venddor 1.0.

features[].group_idstring

Id do grupo ao qual a característica pertence. Vazio quando não pertence a nenhum.

params.pageinteger

Página retornada.

params.items_per_pageinteger

Itens por página aplicados.

params.total_itemsinteger

Total de características que atendem ao filtro, em todas as páginas.

Erros

Status	Quando	Corpo
401	Sem credenciais, chave de API inválida ou token expirado	`{"message":"Invalid credentials","status":401}`
429	Limite de requisições (por exemplo, login repetido)	`{"error":"rate limit exceeded","detail":"too many requests, please try again later"}`