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

Trabalhando com características

Consulte as características de um produto, crie um produto com uma característica e atualize a característica de um produto.

Este guia mostra como trabalhar com as características de um produto pela API. As características permitem definir atributos específicos dos produtos e são uma forma de dar aos clientes especificações detalhadas, que eles podem usar para filtrar e comparar produtos.

API de características do produto

Consultar as características de um produto

GET/api/products/{id}/featuresAdmin

Listar as características de um produto

Retorna todas as características associadas ao produto indicado.

Parâmetros de caminho

idintegerobrigatório
O id do produto.

Exemplo de requisição

bash
curl "$BASE_URL/api/products/14/features" \
  -u "$EMAIL:$API_KEY"

Esta requisição retorna todas as características do produto com product_id=14.

Criar um produto com uma característica

Ao criar um produto, você pode definir as características dele na mesma requisição. Este exemplo adiciona ao novo produto uma característica de texto (tipo T) com feature_id=23.

POST/api/productsAdmin

Criar um produto com características

Cria um novo produto com as características indicadas. Envie o cabeçalho Content-type: application/json.

Corpo da requisição

product_featuresobject
As características do produto. A chave de cada item é o id da característica e o valor é um objeto com feature_type e value.

Exemplo de requisição

bash
curl -X POST "$BASE_URL/api/products" \
  -u "$EMAIL:$API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "product": "New Product",
  "category_ids": "223",
  "main_category": "223",
  "price": "10",
  "status": "A",
  "product_features": {
    "23": {
      "feature_type": "T",
      "value": "Test"
    }
  }
}'

Esta requisição cria um novo produto com o valor "Test" na característica de texto.

Resposta de sucesso

200Produto criado
json
{
  "product_id": 250
}

Atualizar uma característica de um produto

PUT/api/products/{id}Admin

Atualizar as características de um produto

Atualiza as características de um produto existente. Envie o cabeçalho Content-type: application/json.

Parâmetros de caminho

idintegerobrigatório
O id do produto.

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": {
    "23": {
      "feature_type": "T",
      "value": "Feature updated"
    }
  }
}'

Esta requisição atualiza o produto com product_id=250 e altera para "Feature updated" o valor da característica de texto com feature_id=23.

Resposta de sucesso

200Produto atualizado
json
{
  "product_id": 250
}
Dica

Ao atualizar as características de um produto, você só precisa incluir as que quer alterar. Os demais dados e características do produto permanecem como estão.

Veja também

  • Campos
  • Endpoints de produtos
Anterior
Campos das características
Próxima
Combinações de opções
Nesta página
  • API de características do produto
  • Consultar as características de um produto
  • Criar um produto com uma característica
  • Atualizar uma característica de um produto
  • Veja também