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

Endpoints de produtos

Todas as URLs da API 1.0 para produtos: listar, criar, consultar, atualizar, excluir e os produtos de uma categoria.

Os endpoints de Produtos permitem gerenciar as listagens de produtos da plataforma. A referência escreve as URLs relativas ao endereço da API; por extenso, toda URL começa com $BASE_URL/api. Todas as requisições usam HTTP Basic com -u "$EMAIL:$API_KEY".

Duas URLs trabalham com a lista inteira (/api/products), uma trabalha com um produto (/api/products/{id}) e duas retornam os produtos de uma categoria.

Todos os produtos

Use /api/products para consultar todos os produtos (GET) ou para criar um novo (POST).

Método	Descrição	Uso
GET	Consulta todos os produtos	Use os parâmetros de paginação para limitar o resultado. Veja os detalhes em Filtros.
POST	Cria um novo produto	Exige um corpo JSON com os dados do produto.

Listar produtos

GET/api/productsAdmin

Listar produtos

Retorna os produtos da loja, uma página por vez.

Parâmetros de consulta

pageinteger

Número da página a exibir.

items_per_pageintegerpadrão: 10

Quantos produtos são exibidos por página.

Exemplo de requisição

bash

curl "$BASE_URL/api/products?page=1&items_per_page=10" \
  -u "$EMAIL:$API_KEY"

Resposta

200Produtos retornados

json

{
  "products": [
    {
      "product_id": 143,
      "product": "Premium Wireless Headphones",
      "price": 199.99,
      "list_price": 249.99,
      "status": "A",
      "category_ids": [16, 42],
      "quantity": 98,
      "average_rating": 4.7
    },
    {
      "product_id": 144,
      "product": "Ultra HD Smart TV",
      "price": 899.99,
      "list_price": 1099.99,
      "status": "A",
      "category_ids": [16],
      "quantity": 25,
      "average_rating": 4.5
    }
  ],
  "params": {
    "page": 1,
    "items_per_page": 10,
    "total_items": 248
  }
}

Criar um produto

POST/api/productsAdmin

Criar um produto

Cria um novo produto. Envie um corpo JSON com os dados do produto; os campos estão descritos em Campos do produto.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/products" \
  -u "$EMAIL:$API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "product": "Premium Wireless Headphones",
  "category_ids": [16, 42],
  "price": 199.99,
  "list_price": 249.99,
  "status": "A",
  "description": "High-quality wireless headphones with noise cancellation and premium sound",
  "short_description": "Premium Bluetooth headphones",
  "meta_keywords": "headphones, wireless, bluetooth, premium, audio",
  "meta_description": "Experience crystal-clear sound with our premium wireless headphones",
  "quantity": 100,
  "weight": 0.35,
  "dimensions": {
    "length": 8.5,
    "width": 7.2,
    "height": 3.8
  },
  "tax_ids": [1],
  "shipping_freight": 0,
  "low_stock_alert": 10
}'

Um produto específico

Use /api/products/{id} para trabalhar com um produto identificado pelo seu id.

Método	Descrição	Uso
GET	Consulta um produto específico	Retorna as informações detalhadas do produto indicado.
PUT	Atualiza um produto	Exige um corpo JSON com os campos a atualizar.
DELETE	Exclui um produto	Remove o produto do sistema de forma definitiva.

Consultar um produto

GET/api/products/{id}Admin

Consultar um produto

Retorna as informações detalhadas do produto indicado.

Parâmetros de caminho

idintegerobrigatório

O identificador único do produto.

Exemplo de requisição

bash

curl "$BASE_URL/api/products/1" \
  -u "$EMAIL:$API_KEY"

Atualizar um produto

PUT/api/products/{id}Admin

Atualizar um produto

Atualiza um produto. Envie um corpo JSON apenas com os campos que você quer alterar.

Parâmetros de caminho

idintegerobrigatório

O identificador único do produto.

Corpo da requisição

productstring

Qualquer campo do produto, por exemplo o nome.

pricefloat

Qualquer campo do produto, por exemplo o preço.

Exemplo de requisição

bash

curl -X PUT "$BASE_URL/api/products/1" \
  -u "$EMAIL:$API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"product": "New Product Name"}'

Excluir um produto

DELETE/api/products/{id}Admin

Excluir um produto

Remove o produto do sistema de forma definitiva.

Parâmetros de caminho

idintegerobrigatório

O identificador único do produto.

Exemplo de requisição

bash

curl -X DELETE "$BASE_URL/api/products/1" \
  -u "$EMAIL:$API_KEY"

Produtos de uma categoria

Listar os produtos de uma categoria

GET/api/categories/{id}/productsAdmin

Listar os produtos de uma categoria

Retorna todos os produtos atribuídos a uma categoria específica.

Parâmetros de caminho

idintegerobrigatório

O identificador único da categoria.

Exemplo de requisição

bash

curl "$BASE_URL/api/categories/16/products?status=A" \
  -u "$EMAIL:$API_KEY"

Consultar um produto de uma categoria

GET/api/categories/{category_id}/products/{product_id}Admin

Consultar um produto de uma categoria

Retorna os detalhes de um produto específico dentro de uma categoria específica.

Parâmetros de caminho

category_idintegerobrigatório

O identificador único da categoria.

product_idintegerobrigatório

O identificador único do produto.

Exemplo de requisição

bash

curl "$BASE_URL/api/categories/16/products/143" \
  -u "$EMAIL:$API_KEY"

Códigos de status do produto

Código de status	Descrição
`A`	Ativo: o produto está visível e disponível para compra.
`H`	Oculto: o produto existe, mas não fica visível para os clientes.
`D`	Desativado: o produto está temporariamente desativado.
`O`	Sem estoque: o produto está visível, mas não pode ser comprado.

Veja também

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

Endpoints de produtos

Todas as URLs da API 1.0 para produtos: listar, criar, consultar, atualizar, excluir e os produtos de uma categoria.

Duas URLs trabalham com a lista inteira (/api/products), uma trabalha com um produto (/api/products/{id}) e duas retornam os produtos de uma categoria.

Todos os produtos

Use /api/products para consultar todos os produtos (GET) ou para criar um novo (POST).

Método	Descrição	Uso
GET	Consulta todos os produtos	Use os parâmetros de paginação para limitar o resultado. Veja os detalhes em Filtros.
POST	Cria um novo produto	Exige um corpo JSON com os dados do produto.

Listar produtos

GET/api/productsAdmin

Listar produtos

Retorna os produtos da loja, uma página por vez.

Parâmetros de consulta

pageinteger

Número da página a exibir.

items_per_pageintegerpadrão: 10

Quantos produtos são exibidos por página.

Exemplo de requisição

bash

curl "$BASE_URL/api/products?page=1&items_per_page=10" \
  -u "$EMAIL:$API_KEY"

Resposta

200Produtos retornados

json

{
  "products": [
    {
      "product_id": 143,
      "product": "Premium Wireless Headphones",
      "price": 199.99,
      "list_price": 249.99,
      "status": "A",
      "category_ids": [16, 42],
      "quantity": 98,
      "average_rating": 4.7
    },
    {
      "product_id": 144,
      "product": "Ultra HD Smart TV",
      "price": 899.99,
      "list_price": 1099.99,
      "status": "A",
      "category_ids": [16],
      "quantity": 25,
      "average_rating": 4.5
    }
  ],
  "params": {
    "page": 1,
    "items_per_page": 10,
    "total_items": 248
  }
}

Criar um produto

POST/api/productsAdmin

Criar um produto

Cria um novo produto. Envie um corpo JSON com os dados do produto; os campos estão descritos em Campos do produto.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/products" \
  -u "$EMAIL:$API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "product": "Premium Wireless Headphones",
  "category_ids": [16, 42],
  "price": 199.99,
  "list_price": 249.99,
  "status": "A",
  "description": "High-quality wireless headphones with noise cancellation and premium sound",
  "short_description": "Premium Bluetooth headphones",
  "meta_keywords": "headphones, wireless, bluetooth, premium, audio",
  "meta_description": "Experience crystal-clear sound with our premium wireless headphones",
  "quantity": 100,
  "weight": 0.35,
  "dimensions": {
    "length": 8.5,
    "width": 7.2,
    "height": 3.8
  },
  "tax_ids": [1],
  "shipping_freight": 0,
  "low_stock_alert": 10
}'

Um produto específico

Use /api/products/{id} para trabalhar com um produto identificado pelo seu id.

Método	Descrição	Uso
GET	Consulta um produto específico	Retorna as informações detalhadas do produto indicado.
PUT	Atualiza um produto	Exige um corpo JSON com os campos a atualizar.
DELETE	Exclui um produto	Remove o produto do sistema de forma definitiva.

Consultar um produto

GET/api/products/{id}Admin

Consultar um produto

Retorna as informações detalhadas do produto indicado.

Parâmetros de caminho

idintegerobrigatório

O identificador único do produto.

Exemplo de requisição

bash

curl "$BASE_URL/api/products/1" \
  -u "$EMAIL:$API_KEY"

Atualizar um produto

PUT/api/products/{id}Admin

Atualizar um produto

Atualiza um produto. Envie um corpo JSON apenas com os campos que você quer alterar.

Parâmetros de caminho

idintegerobrigatório

O identificador único do produto.

Corpo da requisição

productstring

Qualquer campo do produto, por exemplo o nome.

pricefloat

Qualquer campo do produto, por exemplo o preço.

Exemplo de requisição

bash

curl -X PUT "$BASE_URL/api/products/1" \
  -u "$EMAIL:$API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"product": "New Product Name"}'

Excluir um produto

DELETE/api/products/{id}Admin

Excluir um produto

Remove o produto do sistema de forma definitiva.

Parâmetros de caminho

idintegerobrigatório

O identificador único do produto.

Exemplo de requisição

bash

curl -X DELETE "$BASE_URL/api/products/1" \
  -u "$EMAIL:$API_KEY"

Produtos de uma categoria

Listar os produtos de uma categoria

GET/api/categories/{id}/productsAdmin

Listar os produtos de uma categoria

Retorna todos os produtos atribuídos a uma categoria específica.

Parâmetros de caminho

idintegerobrigatório

O identificador único da categoria.

Exemplo de requisição

bash

curl "$BASE_URL/api/categories/16/products?status=A" \
  -u "$EMAIL:$API_KEY"

Consultar um produto de uma categoria

GET/api/categories/{category_id}/products/{product_id}Admin

Consultar um produto de uma categoria

Retorna os detalhes de um produto específico dentro de uma categoria específica.

Parâmetros de caminho

category_idintegerobrigatório

O identificador único da categoria.

product_idintegerobrigatório

O identificador único do produto.

Exemplo de requisição

bash

curl "$BASE_URL/api/categories/16/products/143" \
  -u "$EMAIL:$API_KEY"

Códigos de status do produto

Código de status	Descrição
`A`	Ativo: o produto está visível e disponível para compra.
`H`	Oculto: o produto existe, mas não fica visível para os clientes.
`D`	Desativado: o produto está temporariamente desativado.
`O`	Sem estoque: o produto está visível, mas não pode ser comprado.