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

Características do produto

Visão geral da API de Características do Produto: a estrutura da característica, as operações da API 2.0 nas características de um produto e todos os endpoints da seção.

A API de Características do Produto gerencia as características e especificações adicionais dos produtos da sua loja. As características ajudam a categorizar e diferenciar os produtos, o que facilita a busca e a comparação pelos clientes.

Esta seção tem dois grupos de URLs. As URLs da API 2.0 trabalham nas características de um produto (/api/2.0/products/{product_id}/features) e são descritas nesta página. As URLs da API 1.0 trabalham nas próprias características (/api/features) e estão em Endpoints. As credenciais são as do HTTP Basic do administrador ($EMAIL e $API_KEY).

Pontos principais
  • A URL base da API 2.0 para as características de um produto é $BASE_URL/api/2.0/products/{product_id}/features.
  • As características são importantes para que os produtos sejam encontrados por filtros e pela busca.
  • Todos os campos de uma característica estão em Campos.
  • A lista de características pode ser paginada: veja Paginação.
  • Você pode criar um produto com características e atualizar as características de um produto na mesma chamada: veja Trabalhando com características.

Como funciona

Tipos de característica

As características podem ser usadas de várias formas para descrever produtos:

  • Especificações técnicas: como dimensões, peso, material etc.
  • Propriedades funcionais: o que o produto faz ou é capaz de fazer.
  • Informações de compatibilidade: com quais dispositivos ou sistemas o produto funciona.
  • Certificações: padrões do setor que o produto atende.

Estrutura de uma característica

A estrutura de uma característica, como a referência a mostra. O texto depois de // é a explicação da referência para o código.

json
{
  "feature_id": "12345",
  "product_id": "678",
  "feature_code": "PROCESSOR",
  "feature_name": "Processor",
  "feature_type": "T",     // T - text, C - checkbox, N - number, etc.
  "feature_value": "Intel Core i7-10700K",
  "feature_group": "Technical Specifications",
  "feature_position": 10,
  "display_on_product": true,
  "display_on_catalog": false,
  "feature_comparison": true
}

Conceitos principais

Grupos de características

Agrupe as características relacionadas com a propriedade feature_group.

Onde uma característica é exibida

Avalie quais características devem aparecer nas páginas de produto (display_on_product) e no catálogo (display_on_catalog) e quais são úteis apenas para filtrar.

Operações comuns da API

GET/api/2.0/products/{product_id}/featuresAdmin

Listar as características de um produto

Retorna todas as características associadas ao produto indicado.

Parâmetros de caminho

product_idstringobrigatório
Identificador do produto.
GET/api/2.0/products/{product_id}/features/{feature_id}Admin

Consultar uma característica de um produto

Retorna os detalhes de uma característica específica do produto indicado.

Parâmetros de caminho

product_idstringobrigatório
Identificador do produto.
feature_idstringobrigatório
Identificador da característica.
POST/api/2.0/products/{product_id}/featuresAdmin

Adicionar uma característica a um produto

Cria uma nova característica para o produto indicado.

Parâmetros de caminho

product_idstringobrigatório
Identificador do produto.
PUT/api/2.0/products/{product_id}/features/{feature_id}Admin

Atualizar uma característica de um produto

Atualiza uma característica existente do produto indicado.

Parâmetros de caminho

product_idstringobrigatório
Identificador do produto.
feature_idstringobrigatório
Identificador da característica.
DELETE/api/2.0/products/{product_id}/features/{feature_id}Admin

Remover uma característica de um produto

Remove uma característica do produto indicado.

Parâmetros de caminho

product_idstringobrigatório
Identificador do produto.
feature_idstringobrigatório
Identificador da característica.
Observação

As características são importantes para que os produtos sejam encontrados por filtros e pela busca. Garanta que seus produtos tenham conjuntos completos de características, com terminologia padronizada.

Modelos de característica de uma categoria

GET/api/2.0/categories/{category_id}/feature_templatesAdmin

Modelos de característica de uma categoria

Para características específicas de uma categoria, retorna os modelos de característica recomendados.

Parâmetros de caminho

category_idstringobrigatório
Identificador da categoria.

Endpoints

MétodoPathFinalidadeAutenticaçãoPágina
GET/api/2.0/products/{product_id}/featuresListar as características de um produtoHTTP BasicEsta página
GET/api/2.0/products/{product_id}/features/{feature_id}Consultar uma característica de um produtoHTTP BasicEsta página
POST/api/2.0/products/{product_id}/featuresAdicionar uma característica a um produtoHTTP BasicEsta página
PUT/api/2.0/products/{product_id}/features/{feature_id}Atualizar uma característica de um produtoHTTP BasicEsta página
DELETE/api/2.0/products/{product_id}/features/{feature_id}Remover uma característica de um produtoHTTP BasicEsta página
GET/api/2.0/categories/{category_id}/feature_templatesModelos de característica de uma categoriaHTTP BasicEsta página
GET/api/featuresListar todas as característicasHTTP BasicEndpoints
POST/api/featuresCriar uma característicaHTTP BasicEndpoints
GET/api/features/{id}Consultar uma característicaHTTP BasicEndpoints
PUT/api/features/{id}Atualizar uma característicaHTTP BasicEndpoints
DELETE/api/features/{id}Excluir uma característicaHTTP BasicEndpoints
GET/api/products/{id}/featuresListar as características de um produtoHTTP BasicEndpoints

Erros comuns e boas práticas

  • Use códigos e nomes de característica consistentes entre produtos semelhantes.
  • Agrupe as características relacionadas com a propriedade feature_group.
  • Decida quais características vão na página do produto e quais servem apenas para filtrar.
  • Ao atualizar características em lote, considere operações em lote para ter melhor desempenho.
  • Não envie campos que não estão na referência: eles são ignorados (veja Campos).

Próximos passos

Endpoints
Todas as URLs da API 1.0 para características.
Campos
A lista completa de campos de uma característica.
Trabalhando com características
Características dentro de um produto.
Anterior
Enviar produtos com preço único
Próxima
Endpoints de características
Nesta página
  • Como funciona
  • Tipos de característica
  • Estrutura de uma característica
  • Conceitos principais
  • Grupos de características
  • Onde uma característica é exibida
  • Operações comuns da API
  • Modelos de característica de uma categoria
  • Endpoints
  • Erros comuns e boas práticas
  • Próximos passos