API legada/Guia rápido/Conteúdo e características do produto

Características do produto

Lê as definições das características que um produto usa, no formato da Venddor 1.0.

Use estas rotas para preencher a ficha técnica de um produto: material, peso, marca, voltagem e o que mais a loja tiver cadastrado como característica. Antes de ler esta página, passe pela home da seção: ela explica o que é uma característica, os tipos e como cada tipo recebe o valor.

Esta API só tem a leitura, e ela devolve as definições das características que o produto usa (nome, tipo e opções), no formato da Venddor 1.0.

GET/api/v1.0/products/{product_id}/featuresAdmin

Características usadas por um produto

Autenticação: HTTP Basic (e-mail:chave_de_api) de um administrador, ou Authorization: Bearer <JWT>. Também responde em /api/products/{product_id}/features; nessa forma feature_id e group_id saem como números decimais em string.

Devolve uma entrada por característica que o produto tem preenchida, na ordem em que os valores foram gravados. Produto sem valores, ou id que não existe, responde 200 com {"features":[]}.

Parâmetros de caminho

product_idstringobrigatório

Id do produto (UUID em /api/v1.0; decimal em string em /api).

Exemplo de requisição

bash

curl "$BASE_URL/api/v1.0/products/74dd8f08-8b06-43a8-9a8b-3ef5e7478d52/features" \
  -u "$EMAIL:$API_KEY"

Resposta

200Características do produto

json

{
  "features": [
    {
      "feature_id": "9f77bf2e-b4ad-487a-ae9c-9547ac40cbc4",
      "description": "Modelo",
      "full_description": "Modelo do produto",
      "feature_type": "T",
      "company_id": "0",
      "position": 70,
      "status": "A",
      "categories_path": "",
      "purpose": "",
      "filter_style": "",
      "feature_style": "",
      "comparison": "Y",
      "display_on_catalog": "N",
      "display_on_product": "Y",
      "display_on_header": "N",
      "prefix": "",
      "sufix": "",
      "group_id": "3737eedf-909a-4cf4-884b-68393ba5bb53",
      "variants": []
    },
    {
      "feature_id": "093075db-b1ce-4dbb-8d1c-60d1b253a072",
      "description": "Gênero",
      "feature_type": "S",
      "status": "A",
      "variants": [
        { "variant_id": "d82d6649-bee7-40c5-b14f-6cb593bec904", "variant": "Masculino", "position": 1 },
        { "variant_id": "feb9ea74-021f-4ae6-bb15-4226bbee941e", "variant": "Feminino", "position": 2 }
      ]
    }
  ]
}

(O exemplo omite campos repetidos da segunda característica.)

Campos da resposta

featuresarray

Uma entrada por característica preenchida no produto.

feature_idstring

Id da característica (UUID em /api/v1.0, decimal em string em /api).

descriptionstring

Nome da característica (este contrato chama o nome de "description").

full_descriptionstring

Texto explicativo da característica.

feature_typestring

CSMTNOGE

Tipo em letra: C bool, S select (e color, com filter_style igual a color), M multi_select, T text (e author), N number, O date, G group, E brand.

company_idstring

Sempre "0": característica da loja.

positioninteger

Ordem de exibição.

statusstring

Letra do status: A ativa, H oculta.

categories_pathstring

Ids de categorias onde vale, separados por vírgula. Vazio significa todas.

purposestring

Vazio, group_catalog_item ou group_variation_catalog_item (uso em variações).

filter_stylestring

Estilo do filtro: vazio (não filtra), checkbox, slider, date_range ou color.

feature_stylestring

Espelha filter_style.

comparisonstring

YN

Entra na comparação de produtos.

display_on_catalogstring

YN

Aparece como selo nas listagens.

display_on_productstring

YN

Aparece na ficha do produto.

display_on_headerstring

Sempre "N".

prefixstring

Prefixo exibido junto ao valor (ex.: R$).

sufixstring

Sufixo exibido junto ao valor (ex.: kg). O nome sem o segundo "f" é herdado da Venddor 1.0 e foi mantido.

group_idstring

Id do grupo ao qual pertence. Vazio quando não há grupo.

variantsarray

Todas as opções da característica de seleção (variant_id, variant, position e, em cor, color). Lista vazia nos demais tipos. Não indica qual opção o produto tem.

Erros

Status	Quando	Corpo
401	Sem credenciais ou token expirado	`{"message":"Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>.","status":401}`
500	id de produto fora do formato UUID	`{"message":"...","status":500}`

Veja também

Características do produto

Lê as definições das características que um produto usa, no formato da Venddor 1.0.

Esta API só tem a leitura, e ela devolve as definições das características que o produto usa (nome, tipo e opções), no formato da Venddor 1.0.

GET/api/v1.0/products/{product_id}/featuresAdmin

Características usadas por um produto

Devolve uma entrada por característica que o produto tem preenchida, na ordem em que os valores foram gravados. Produto sem valores, ou id que não existe, responde 200 com {"features":[]}.

Parâmetros de caminho

product_idstringobrigatório

Id do produto (UUID em /api/v1.0; decimal em string em /api).

Exemplo de requisição

bash

curl "$BASE_URL/api/v1.0/products/74dd8f08-8b06-43a8-9a8b-3ef5e7478d52/features" \
  -u "$EMAIL:$API_KEY"

Resposta

200Características do produto

json

{
  "features": [
    {
      "feature_id": "9f77bf2e-b4ad-487a-ae9c-9547ac40cbc4",
      "description": "Modelo",
      "full_description": "Modelo do produto",
      "feature_type": "T",
      "company_id": "0",
      "position": 70,
      "status": "A",
      "categories_path": "",
      "purpose": "",
      "filter_style": "",
      "feature_style": "",
      "comparison": "Y",
      "display_on_catalog": "N",
      "display_on_product": "Y",
      "display_on_header": "N",
      "prefix": "",
      "sufix": "",
      "group_id": "3737eedf-909a-4cf4-884b-68393ba5bb53",
      "variants": []
    },
    {
      "feature_id": "093075db-b1ce-4dbb-8d1c-60d1b253a072",
      "description": "Gênero",
      "feature_type": "S",
      "status": "A",
      "variants": [
        { "variant_id": "d82d6649-bee7-40c5-b14f-6cb593bec904", "variant": "Masculino", "position": 1 },
        { "variant_id": "feb9ea74-021f-4ae6-bb15-4226bbee941e", "variant": "Feminino", "position": 2 }
      ]
    }
  ]
}

(O exemplo omite campos repetidos da segunda característica.)

Campos da resposta

featuresarray

Uma entrada por característica preenchida no produto.

feature_idstring

Id da característica (UUID em /api/v1.0, decimal em string em /api).

descriptionstring

Nome da característica (este contrato chama o nome de "description").

full_descriptionstring

Texto explicativo da característica.

feature_typestring

CSMTNOGE

Tipo em letra: C bool, S select (e color, com filter_style igual a color), M multi_select, T text (e author), N number, O date, G group, E brand.

company_idstring

Sempre "0": característica da loja.

positioninteger

Ordem de exibição.

statusstring

Letra do status: A ativa, H oculta.

categories_pathstring

Ids de categorias onde vale, separados por vírgula. Vazio significa todas.

purposestring

Vazio, group_catalog_item ou group_variation_catalog_item (uso em variações).

filter_stylestring

Estilo do filtro: vazio (não filtra), checkbox, slider, date_range ou color.

feature_stylestring

Espelha filter_style.

comparisonstring

YN

Entra na comparação de produtos.

display_on_catalogstring

YN

Aparece como selo nas listagens.

display_on_productstring

YN

Aparece na ficha do produto.

display_on_headerstring

Sempre "N".

prefixstring

Prefixo exibido junto ao valor (ex.: R$).

sufixstring

Sufixo exibido junto ao valor (ex.: kg). O nome sem o segundo "f" é herdado da Venddor 1.0 e foi mantido.

group_idstring

Id do grupo ao qual pertence. Vazio quando não há grupo.

variantsarray

Todas as opções da característica de seleção (variant_id, variant, position e, em cor, color). Lista vazia nos demais tipos. Não indica qual opção o produto tem.

Erros

Status	Quando	Corpo
401	Sem credenciais ou token expirado	`{"message":"Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>.","status":401}`
500	id de produto fora do formato UUID	`{"message":"...","status":500}`