Skip to main content
GET
Retorna uma lista paginada de vendas com informações dos clientes e representadas associadas.
Você precisa de uma API key válida no header x-api-key para usar este endpoint.

Headers

string
required
API key de autenticação

Query Parameters

number
default:"1"
Número da página para paginação
number
default:"20"
Quantidade de registros por página (máximo: 100)

Response

array
Array contendo as vendas encontradas
number
Página atual
number
Limite de registros por página
number
Total de vendas no banco de dados

Paginação

Para navegar pelos resultados:
  • Use page para especificar a página desejada
  • O limit controla quantos registros por página (máximo 100)
  • O campo total indica quantos registros existem no total
Exemplo para calcular total de páginas:

Informações Adicionais

Joins Automáticos:
  • O endpoint já retorna o nome do cliente (cliente_nome)
  • O endpoint já retorna o nome da representada (representada_nome)
  • Não é necessário fazer requisições adicionais para obter esses dados
Ordenação:
  • As vendas são retornadas ordenadas por data de criação (mais recentes primeiro)

Status das Vendas

Os possíveis status de uma venda são: