curl -X GET "https://api.sistema-representantes.com.br/api/v1/sales?page=1&limit=20" \
-H "x-api-key: sua-api-key-aqui"
curl -X GET "https://api.sistema-representantes.com.br/api/v1/sales?page=2&limit=50" \
-H "x-api-key: sua-api-key-aqui"
const response = await fetch('https://api.sistema-representantes.com.br/api/v1/sales?page=1&limit=20', {
method: 'GET',
headers: {
'x-api-key': 'sua-api-key-aqui'
}
});
const result = await response.json();
console.log(`Total de vendas: ${result.total}`);
console.log(`Vendas nesta página: ${result.data.length}`);
// Calcular valor total das vendas
const totalValue = result.data.reduce((sum, sale) => sum + sale.valor_total, 0);
console.log(`Valor total desta página: R$ ${totalValue.toFixed(2)}`);
import requests
url = "https://api.sistema-representantes.com.br/api/v1/sales"
headers = {
'x-api-key': 'sua-api-key-aqui'
}
params = {
'page': 1,
'limit': 20
}
response = requests.get(url, headers=headers, params=params)
result = response.json()
if response.status_code == 200:
print(f"Total de vendas: {result['total']}")
print(f"Página {result['page']} de {(result['total'] + result['limit'] - 1) // result['limit']}")
for sale in result['data']:
print(f"\nPedido: {sale['pedido']}")
print(f"Cliente: {sale['cliente_nome']}")
print(f"Valor: R$ {sale['valor_total']:.2f}")
print(f"Status: {sale['status']}")
else:
print(f"Erro: {result.get('error', 'Erro desconhecido')}")
<?php
$url = 'https://api.sistema-representantes.com.br/api/v1/sales';
$headers = [
'x-api-key: sua-api-key-aqui'
];
$params = http_build_query([
'page' => 1,
'limit' => 20
]);
$options = [
'http' => [
'header' => implode("\r\n", $headers),
'method' => 'GET'
]
];
$context = stream_context_create($options);
$result = file_get_contents($url . '?' . $params, false, $context);
$response = json_decode($result, true);
if ($response) {
echo "Total de vendas: " . $response['total'] . "\n";
echo "Mostrando página " . $response['page'] . "\n\n";
foreach ($response['data'] as $sale) {
echo "Pedido: " . $sale['pedido'] . "\n";
echo "Cliente: " . $sale['cliente_nome'] . "\n";
echo "Valor: R$ " . number_format($sale['valor_total'], 2, ',', '.') . "\n";
echo "Status: " . $sale['status'] . "\n";
echo "---\n";
}
}
?>
{
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"pedido": "PED-2024-001",
"data": "2024-01-20",
"cliente_id": "550e8400-e29b-41d4-a716-446655440000",
"cliente_nome": "Supermercado Central",
"representada_id": "987e6543-e89b-12d3-a456-426614174999",
"representada_nome": "Laticínios do Vale",
"status": "Faturado",
"valor_total": 5500.00,
"created_at": "2024-01-20T10:30:00Z",
"updated_at": "2024-01-21T08:15:00Z"
},
{
"id": "456e7890-e89b-12d3-a456-426614174111",
"pedido": "PED-2024-002",
"data": "2024-01-21",
"cliente_id": "660e8400-e29b-41d4-a716-446655440111",
"cliente_nome": "Distribuidora ABC",
"representada_id": "987e6543-e89b-12d3-a456-426614174999",
"representada_nome": "Laticínios do Vale",
"status": "Pedido",
"valor_total": 3250.50,
"created_at": "2024-01-21T14:20:00Z",
"updated_at": "2024-01-21T14:20:00Z"
}
],
"page": 1,
"limit": 20,
"total": 85
}
{
"data": [],
"page": 1,
"limit": 20,
"total": 0
}
{
"error": "API key ausente"
}
{
"error": "API key inválida"
}
{
"error": "Empresa inativa"
}
Vendas
Listar Vendas
Lista todas as vendas cadastradas com paginação
GET
/
api
/
v1
/
sales
curl -X GET "https://api.sistema-representantes.com.br/api/v1/sales?page=1&limit=20" \
-H "x-api-key: sua-api-key-aqui"
curl -X GET "https://api.sistema-representantes.com.br/api/v1/sales?page=2&limit=50" \
-H "x-api-key: sua-api-key-aqui"
const response = await fetch('https://api.sistema-representantes.com.br/api/v1/sales?page=1&limit=20', {
method: 'GET',
headers: {
'x-api-key': 'sua-api-key-aqui'
}
});
const result = await response.json();
console.log(`Total de vendas: ${result.total}`);
console.log(`Vendas nesta página: ${result.data.length}`);
// Calcular valor total das vendas
const totalValue = result.data.reduce((sum, sale) => sum + sale.valor_total, 0);
console.log(`Valor total desta página: R$ ${totalValue.toFixed(2)}`);
import requests
url = "https://api.sistema-representantes.com.br/api/v1/sales"
headers = {
'x-api-key': 'sua-api-key-aqui'
}
params = {
'page': 1,
'limit': 20
}
response = requests.get(url, headers=headers, params=params)
result = response.json()
if response.status_code == 200:
print(f"Total de vendas: {result['total']}")
print(f"Página {result['page']} de {(result['total'] + result['limit'] - 1) // result['limit']}")
for sale in result['data']:
print(f"\nPedido: {sale['pedido']}")
print(f"Cliente: {sale['cliente_nome']}")
print(f"Valor: R$ {sale['valor_total']:.2f}")
print(f"Status: {sale['status']}")
else:
print(f"Erro: {result.get('error', 'Erro desconhecido')}")
<?php
$url = 'https://api.sistema-representantes.com.br/api/v1/sales';
$headers = [
'x-api-key: sua-api-key-aqui'
];
$params = http_build_query([
'page' => 1,
'limit' => 20
]);
$options = [
'http' => [
'header' => implode("\r\n", $headers),
'method' => 'GET'
]
];
$context = stream_context_create($options);
$result = file_get_contents($url . '?' . $params, false, $context);
$response = json_decode($result, true);
if ($response) {
echo "Total de vendas: " . $response['total'] . "\n";
echo "Mostrando página " . $response['page'] . "\n\n";
foreach ($response['data'] as $sale) {
echo "Pedido: " . $sale['pedido'] . "\n";
echo "Cliente: " . $sale['cliente_nome'] . "\n";
echo "Valor: R$ " . number_format($sale['valor_total'], 2, ',', '.') . "\n";
echo "Status: " . $sale['status'] . "\n";
echo "---\n";
}
}
?>
{
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"pedido": "PED-2024-001",
"data": "2024-01-20",
"cliente_id": "550e8400-e29b-41d4-a716-446655440000",
"cliente_nome": "Supermercado Central",
"representada_id": "987e6543-e89b-12d3-a456-426614174999",
"representada_nome": "Laticínios do Vale",
"status": "Faturado",
"valor_total": 5500.00,
"created_at": "2024-01-20T10:30:00Z",
"updated_at": "2024-01-21T08:15:00Z"
},
{
"id": "456e7890-e89b-12d3-a456-426614174111",
"pedido": "PED-2024-002",
"data": "2024-01-21",
"cliente_id": "660e8400-e29b-41d4-a716-446655440111",
"cliente_nome": "Distribuidora ABC",
"representada_id": "987e6543-e89b-12d3-a456-426614174999",
"representada_nome": "Laticínios do Vale",
"status": "Pedido",
"valor_total": 3250.50,
"created_at": "2024-01-21T14:20:00Z",
"updated_at": "2024-01-21T14:20:00Z"
}
],
"page": 1,
"limit": 20,
"total": 85
}
{
"data": [],
"page": 1,
"limit": 20,
"total": 0
}
{
"error": "API key ausente"
}
{
"error": "API key inválida"
}
{
"error": "Empresa inativa"
}
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)
curl -X GET "https://api.sistema-representantes.com.br/api/v1/sales?page=1&limit=20" \
-H "x-api-key: sua-api-key-aqui"
curl -X GET "https://api.sistema-representantes.com.br/api/v1/sales?page=2&limit=50" \
-H "x-api-key: sua-api-key-aqui"
const response = await fetch('https://api.sistema-representantes.com.br/api/v1/sales?page=1&limit=20', {
method: 'GET',
headers: {
'x-api-key': 'sua-api-key-aqui'
}
});
const result = await response.json();
console.log(`Total de vendas: ${result.total}`);
console.log(`Vendas nesta página: ${result.data.length}`);
// Calcular valor total das vendas
const totalValue = result.data.reduce((sum, sale) => sum + sale.valor_total, 0);
console.log(`Valor total desta página: R$ ${totalValue.toFixed(2)}`);
import requests
url = "https://api.sistema-representantes.com.br/api/v1/sales"
headers = {
'x-api-key': 'sua-api-key-aqui'
}
params = {
'page': 1,
'limit': 20
}
response = requests.get(url, headers=headers, params=params)
result = response.json()
if response.status_code == 200:
print(f"Total de vendas: {result['total']}")
print(f"Página {result['page']} de {(result['total'] + result['limit'] - 1) // result['limit']}")
for sale in result['data']:
print(f"\nPedido: {sale['pedido']}")
print(f"Cliente: {sale['cliente_nome']}")
print(f"Valor: R$ {sale['valor_total']:.2f}")
print(f"Status: {sale['status']}")
else:
print(f"Erro: {result.get('error', 'Erro desconhecido')}")
<?php
$url = 'https://api.sistema-representantes.com.br/api/v1/sales';
$headers = [
'x-api-key: sua-api-key-aqui'
];
$params = http_build_query([
'page' => 1,
'limit' => 20
]);
$options = [
'http' => [
'header' => implode("\r\n", $headers),
'method' => 'GET'
]
];
$context = stream_context_create($options);
$result = file_get_contents($url . '?' . $params, false, $context);
$response = json_decode($result, true);
if ($response) {
echo "Total de vendas: " . $response['total'] . "\n";
echo "Mostrando página " . $response['page'] . "\n\n";
foreach ($response['data'] as $sale) {
echo "Pedido: " . $sale['pedido'] . "\n";
echo "Cliente: " . $sale['cliente_nome'] . "\n";
echo "Valor: R$ " . number_format($sale['valor_total'], 2, ',', '.') . "\n";
echo "Status: " . $sale['status'] . "\n";
echo "---\n";
}
}
?>
Response
array
Array contendo as vendas encontradas
Show Estrutura da venda
Show Estrutura da venda
string
ID único da venda (UUID)
string
Código do pedido
string
Data da venda (formato: YYYY-MM-DD)
string
ID do cliente
string
Nome do cliente (join automático)
string
ID da representada
string
Nome da representada (join automático)
string
Status da venda:
Pedido- Venda registradaFaturado- Nota fiscal emitidaEnviado- Mercadoria despachadaEntregue- Mercadoria recebidaCancelado- Venda cancelada
number
Valor total da venda em reais
string
Data de criação (ISO 8601)
string
Data da última atualização
number
Página atual
number
Limite de registros por página
number
Total de vendas no banco de dados
{
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"pedido": "PED-2024-001",
"data": "2024-01-20",
"cliente_id": "550e8400-e29b-41d4-a716-446655440000",
"cliente_nome": "Supermercado Central",
"representada_id": "987e6543-e89b-12d3-a456-426614174999",
"representada_nome": "Laticínios do Vale",
"status": "Faturado",
"valor_total": 5500.00,
"created_at": "2024-01-20T10:30:00Z",
"updated_at": "2024-01-21T08:15:00Z"
},
{
"id": "456e7890-e89b-12d3-a456-426614174111",
"pedido": "PED-2024-002",
"data": "2024-01-21",
"cliente_id": "660e8400-e29b-41d4-a716-446655440111",
"cliente_nome": "Distribuidora ABC",
"representada_id": "987e6543-e89b-12d3-a456-426614174999",
"representada_nome": "Laticínios do Vale",
"status": "Pedido",
"valor_total": 3250.50,
"created_at": "2024-01-21T14:20:00Z",
"updated_at": "2024-01-21T14:20:00Z"
}
],
"page": 1,
"limit": 20,
"total": 85
}
{
"data": [],
"page": 1,
"limit": 20,
"total": 0
}
{
"error": "API key ausente"
}
{
"error": "API key inválida"
}
{
"error": "Empresa inativa"
}
Paginação
Para navegar pelos resultados:
- Use
pagepara especificar a página desejada - O
limitcontrola quantos registros por página (máximo 100) - O campo
totalindica quantos registros existem no total
const totalPages = Math.ceil(total / limit);
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
- 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:
| Status | Descrição |
|---|---|
Pedido | Venda registrada, aguardando processamento |
Faturado | Nota fiscal foi emitida |
Enviado | Mercadoria foi despachada |
Entregue | Cliente recebeu a mercadoria |
Cancelado | Venda foi cancelada |