API legada/Referência completa/Produtos (REST)

Características como objetos aninhados

Os tipos de característica, os endpoints para gerenciá-las e como atribuí-las a um produto.

As características do produto descrevem os atributos de um produto da sua loja, como material, cor ou número do modelo. Elas ajudam os clientes a comparar produtos e a decidir a compra com informação.

Esta página mostra como as características aparecem dentro de um produto e as URLs para gerenciá-las.

Visão geral das características

As características do produto são qualidades ou atributos que definem os produtos da sua loja. Você pode usá-las para:

criar especificações detalhadas do produto;
habilitar filtros avançados de produtos;
organizar os produtos a partir dos seus atributos;
permitir que os clientes comparem produtos semelhantes.

Tipos de característica

Código do tipo	Nome do tipo	Descrição
`C`	Checkbox	Uma característica simples de sim ou não (por exemplo, "À prova d'água").
`S`	Select Box	Uma lista suspensa com variantes predefinidas (por exemplo, "Material" com as opções "Algodão", "Poliéster").
`M`	Multiple Checkbox	Várias opções podem ser marcadas (por exemplo, "Conectores" com as opções "HDMI", "USB", "DisplayPort").
`N`	Number	Valores numéricos (por exemplo, "Peso em kg").
`T`	Text	Texto livre (por exemplo, "Número do modelo").
`D`	Date	Seleção de data (por exemplo, "Data de fabricação").
`E`	Extended	Seleção de marca ou fabricante (um tipo de característica especializado).

Endpoints das características do produto

Listar características

GET/api/product_featuresAdmin

Listar características do produto

Retorna a lista de todas as características do produto com seus detalhes.

Parâmetros de consulta

feature_typesstring

Filtra as características por tipo, por exemplo "C,S,M" para Checkbox, Select Box e Multiple Checkbox.

get_variantsstring

Y

Use "Y" para incluir as variantes da característica na resposta.

Exemplo de requisição

bash

curl "$BASE_URL/api/product_features?feature_types=C,S,M&get_variants=Y" \
  -u "$EMAIL:$API_KEY"

Consultar uma característica

GET/api/product_features/{feature_id}Admin

Consultar uma característica do produto

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

Parâmetros de caminho

feature_idintegerobrigatório

O identificador único da característica a consultar.

Exemplo de requisição

bash

curl "$BASE_URL/api/product_features/16" \
  -u "$EMAIL:$API_KEY"

Criar uma característica

POST/api/product_featuresAdmin

Criar uma característica do produto

Cria uma nova característica do produto.

Corpo da requisição

feature_typestringobrigatório

O tipo da característica (por exemplo "C", "S", "M").

descriptionstringobrigatório

O nome ou a descrição da característica.

categories_pathstring

Ids das categorias em que a característica deve estar disponível (separados por vírgula).

variantsarray

Variantes da característica. Obrigatório para os tipos Select Box e Multiple Checkbox.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/product_features" \
  -u "$EMAIL:$API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "feature_type": "S",
  "description": "Material",
  "categories_path": "12,15,18",
  "variants": [
    {
      "variant": "Cotton"
    },
    {
      "variant": "Polyester"
    },
    {
      "variant": "Wool"
    }
  ]
}'

Atribuir características a produtos

Depois de criar as características, atribua-as a produtos específicos atualizando o produto.

PUT/api/products/{product_id}Admin

Atribuir características a um produto

Atualiza um produto para atribuir características. A chave de cada item é o id da característica.

Parâmetros de caminho

product_idintegerobrigatório

O identificador único do produto.

A referência mostra o corpo com explicações depois de //:

json

{
  "product_features": {
    "16": "42",    // Feature ID 16 = Variant ID 42
    "18": "Y",     // Checkbox feature ID 18 = Yes
    "23": "500",   // Number feature ID 23 = 500
    "25": "Model X15" // Text feature ID 25 = "Model X15"
  }
}

Exemplo de requisição

bash

curl -X PUT "$BASE_URL/api/products/250" \
  -u "$EMAIL:$API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "product_features": {
    "16": "42",
    "18": "Y",
    "23": "500",
    "25": "Model X15"
  }
}'

Filtros por característica

As características do produto podem ser usadas para montar filtros na sua loja. A API pode retornar os produtos filtrados por valores específicos de características.

GET/api/productsAdmin

Filtrar produtos por características

Retorna os produtos filtrados por valores específicos de características: GET /products?features_hash={features_hash}.

Parâmetros de consulta

features_hashstring

Critérios de filtro codificados a partir dos valores das características.

Veja também

API legada/Referência completa/Produtos (REST)

Características como objetos aninhados

Os tipos de característica, os endpoints para gerenciá-las e como atribuí-las a um produto.

Esta página mostra como as características aparecem dentro de um produto e as URLs para gerenciá-las.

Visão geral das características

As características do produto são qualidades ou atributos que definem os produtos da sua loja. Você pode usá-las para:

criar especificações detalhadas do produto;
habilitar filtros avançados de produtos;
organizar os produtos a partir dos seus atributos;
permitir que os clientes comparem produtos semelhantes.

Tipos de característica

Código do tipo	Nome do tipo	Descrição
`C`	Checkbox	Uma característica simples de sim ou não (por exemplo, "À prova d'água").
`S`	Select Box	Uma lista suspensa com variantes predefinidas (por exemplo, "Material" com as opções "Algodão", "Poliéster").
`M`	Multiple Checkbox	Várias opções podem ser marcadas (por exemplo, "Conectores" com as opções "HDMI", "USB", "DisplayPort").
`N`	Number	Valores numéricos (por exemplo, "Peso em kg").
`T`	Text	Texto livre (por exemplo, "Número do modelo").
`D`	Date	Seleção de data (por exemplo, "Data de fabricação").
`E`	Extended	Seleção de marca ou fabricante (um tipo de característica especializado).

Endpoints das características do produto

Listar características

GET/api/product_featuresAdmin

Listar características do produto

Retorna a lista de todas as características do produto com seus detalhes.

Parâmetros de consulta

feature_typesstring

Filtra as características por tipo, por exemplo "C,S,M" para Checkbox, Select Box e Multiple Checkbox.

get_variantsstring

Y

Use "Y" para incluir as variantes da característica na resposta.

Exemplo de requisição

bash

curl "$BASE_URL/api/product_features?feature_types=C,S,M&get_variants=Y" \
  -u "$EMAIL:$API_KEY"

Consultar uma característica

GET/api/product_features/{feature_id}Admin

Consultar uma característica do produto

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

Parâmetros de caminho

feature_idintegerobrigatório

O identificador único da característica a consultar.

Exemplo de requisição

bash

curl "$BASE_URL/api/product_features/16" \
  -u "$EMAIL:$API_KEY"

Criar uma característica

POST/api/product_featuresAdmin

Criar uma característica do produto

Cria uma nova característica do produto.

Corpo da requisição

feature_typestringobrigatório

O tipo da característica (por exemplo "C", "S", "M").

descriptionstringobrigatório

O nome ou a descrição da característica.

categories_pathstring

Ids das categorias em que a característica deve estar disponível (separados por vírgula).

variantsarray

Variantes da característica. Obrigatório para os tipos Select Box e Multiple Checkbox.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/product_features" \
  -u "$EMAIL:$API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "feature_type": "S",
  "description": "Material",
  "categories_path": "12,15,18",
  "variants": [
    {
      "variant": "Cotton"
    },
    {
      "variant": "Polyester"
    },
    {
      "variant": "Wool"
    }
  ]
}'

Atribuir características a produtos

Depois de criar as características, atribua-as a produtos específicos atualizando o produto.

PUT/api/products/{product_id}Admin

Atribuir características a um produto

Atualiza um produto para atribuir características. A chave de cada item é o id da característica.

Parâmetros de caminho

product_idintegerobrigatório

O identificador único do produto.

A referência mostra o corpo com explicações depois de //:

json

{
  "product_features": {
    "16": "42",    // Feature ID 16 = Variant ID 42
    "18": "Y",     // Checkbox feature ID 18 = Yes
    "23": "500",   // Number feature ID 23 = 500
    "25": "Model X15" // Text feature ID 25 = "Model X15"
  }
}

Exemplo de requisição

bash

curl -X PUT "$BASE_URL/api/products/250" \
  -u "$EMAIL:$API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "product_features": {
    "16": "42",
    "18": "Y",
    "23": "500",
    "25": "Model X15"
  }
}'

Filtros por característica

As características do produto podem ser usadas para montar filtros na sua loja. A API pode retornar os produtos filtrados por valores específicos de características.

GET/api/productsAdmin

Filtrar produtos por características

Retorna os produtos filtrados por valores específicos de características: GET /products?features_hash={features_hash}.

Parâmetros de consulta

features_hashstring

Critérios de filtro codificados a partir dos valores das características.