Skip to main content
GET
/
api
/
v1
/
public
/
products
Listar produtos
curl --request GET \
  --url https://api.indiqai.com/api/v1/public/products \
  --header 'X-API-Key: <x-api-key>'
{
  "products": [
    {
      "uid": "prd_001",
      "name": "Pizza Margherita",
      "description": "Molho de tomate, mussarela e manjericão",
      "price": 45.90,
      "quantity": 50,
      "points_cost": 200,
      "image_url": "https://storage.indiqai.com/products/pizza.jpg",
      "available": true,
      "created_at": "2025-09-01T12:00:00Z"
    },
    {
      "uid": "prd_002",
      "name": "Refrigerante 600ml",
      "description": "Refrigerante gelado",
      "price": 8.50,
      "quantity": 100,
      "points_cost": 50,
      "image_url": null,
      "available": true,
      "created_at": "2025-09-01T12:05:00Z"
    }
  ],
  "total": 2
}

Listar Produtos

Retorna todos os produtos cadastrados pela empresa, incluindo seus preços, estoque e custo em pontos.

Request

curl -X GET "https://api.indiqai.com/api/v1/public/products" \
  -H "X-API-Key: indiqai_sua_chave_aqui"

Response

{
  "products": [
    {
      "uid": "prd_001",
      "name": "Pizza Margherita",
      "description": "Molho de tomate, mussarela e manjericão",
      "price": 45.90,
      "quantity": 50,
      "points_cost": 200,
      "image_url": "https://storage.indiqai.com/products/pizza.jpg",
      "available": true,
      "created_at": "2025-09-01T12:00:00Z"
    },
    {
      "uid": "prd_002",
      "name": "Refrigerante 600ml",
      "description": "Refrigerante gelado",
      "price": 8.50,
      "quantity": 100,
      "points_cost": 50,
      "image_url": null,
      "available": true,
      "created_at": "2025-09-01T12:05:00Z"
    }
  ],
  "total": 2
}

Campos da Resposta

products
array
Lista de produtos
products[].uid
string
ID único do produto
products[].name
string
Nome do produto
products[].description
string
Descrição do produto (pode ser null)
products[].price
number
Preço em reais (BRL)
products[].quantity
integer
Quantidade em estoque
products[].points_cost
integer
Custo em pontos para resgate
products[].image_url
string
URL da imagem do produto (pode ser null)
products[].available
boolean
Se o produto está disponível
products[].created_at
string
Data de criação (ISO 8601)
total
integer
Total de produtos

Headers

X-API-Key
string
required

Chave de API da empresa

Response

Successful Response

id
string
required
name
string
required
price
number
required
quantity
integer
required
created_at
string<date-time> | null
description
string | null
image_url
string | null