Produtos

Catálogo de produtos e serviços com preços e categorias.

GET /api/products Auth

Listar Produtos

Retorna a lista paginada de produtos do catálogo.

Query Parameters

page integer

Número da página (padrão: 1)

limit integer

Itens por página (padrão: 20, máx: 100)

search string

Busca por nome ou email

Status Codes

200 Lista retornada com sucesso
401 Não autenticado
Response
{
  "data": [
    {
      "id": "507f1f77bcf86cd799439055",
      "name": "Consultoria Mensal",
      "description": "40h de consultoria comercial",
      "price": 3500.00,
      "sku": "CONS-001",
      "category": "Serviços",
      "active": true,
      "createdAt": "2026-03-01T10:00:00Z"
    }
  ],
  "total": 15,
  "page": 1,
  "limit": 20
}
POST /api/products Auth

Criar Produto

Adiciona um novo produto ao catálogo. Integrado com cotações e faturas.

Request Body

name string obrigatório

Nome do produto

description string opcional

Descrição

price number obrigatório

Preço unitário em BRL

sku string opcional

Código SKU

category string opcional

Categoria

Status Codes

201 Criado com sucesso
400 Dados inválidos
401 Não autenticado
Request
{
  "name": "Consultoria Mensal",
  "description": "40h de consultoria comercial",
  "price": 3500.00,
  "sku": "CONS-001",
  "category": "Serviços"
}
Response
{
  "id": "507f1f77bcf86cd799439055",
  "name": "Consultoria Mensal",
  "description": "40h de consultoria comercial",
  "price": 3500.00,
  "sku": "CONS-001",
  "category": "Serviços",
  "active": true,
  "createdAt": "2026-05-07T10:00:00Z"
}
GET /api/products/:id Auth

Buscar Produto por ID

Retorna os dados completos de um produto específico.

Status Codes

200 Registro encontrado
401 Não autenticado
403 Sem permissão (não é o proprietário)
404 Não encontrado
Response
{
  "id": "507f1f77bcf86cd799439055",
  "name": "Consultoria Mensal",
  "description": "40h de consultoria comercial",
  "price": 3500.00,
  "sku": "CONS-001",
  "category": "Serviços",
  "active": true,
  "createdAt": "2026-03-01T10:00:00Z",
  "updatedAt": "2026-04-15T11:00:00Z"
}
PUT /api/products/:id Auth

Atualizar Produto

Atualiza os dados de um produto existente.

Request Body

name string opcional

Nome

description string opcional

Descrição

price number opcional

Preço unitário em BRL

sku string opcional

Código SKU

category string opcional

Categoria

active boolean opcional

Se o produto está ativo

Status Codes

200 Atualizado com sucesso
400 Dados inválidos
401 Não autenticado
403 Sem permissão (não é o proprietário)
404 Não encontrado
Request
{
  "price": 4000.00,
  "description": "50h de consultoria comercial"
}
Response
{
  "id": "507f1f77bcf86cd799439055",
  "name": "Consultoria Mensal",
  "price": 4000.00,
  "description": "50h de consultoria comercial",
  "updatedAt": "2026-05-07T15:30:00Z"
}
DELETE /api/products/:id Auth

Remover Produto

Remove permanentemente um produto do catálogo. Faturas e cotações existentes não são afetadas.

Status Codes

200 Removido com sucesso
401 Não autenticado
403 Sem permissão (não é o proprietário)
404 Não encontrado
Response
{
  "message": "Produto excluído com sucesso"
}

Este site utiliza cookies

Utilizamos cookies essenciais para o funcionamento da plataforma e cookies de análise para melhorar sua experiência. Ao continuar navegando, você concorda com nossa Política de Privacidade e Termos de Uso.