SV
Sua Venda
API REST · Sanctum

Documentacao da API Sua Venda

Referencia da API REST usada pelo app mobile e por integracoes externas.

Voltar para a landing Entrar no sistema

Autenticacao

7 endpoints
POST
/auth/login
Autentica o usuario e devolve o par de tokens.
POST
/auth/refresh
Renova o access token usando o refresh token atual.
POST
/auth/logout
Revoga a sessao atual do dispositivo autenticado.
GET
/me
Consulta o perfil autenticado.
PUT
/me
Atualiza os dados basicos do perfil autenticado.
GET
/health
Verifica a disponibilidade basica da API para monitoramento.
GET
/meta
Retorna metadados publicos da API, versao e capacidades disponiveis.

Cadastros

11 endpoints
GET
/clients
Lista clientes do tenant.
POST
/clients
Cria um novo cliente.
GET
/clients/{id}/sales
Lista o historico de vendas de um cliente.
GET
/products
Lista produtos do tenant com filtros de sincronizacao.
POST
/products/{id}/photo
Envia a foto do produto.
GET
/routes
Lista rotas comerciais.
GET
/routes/active
Recupera a rota ativa para vendas.
POST
/products/{id}/photo
Envia a foto do produto em multipart/form-data.
GET
/routes
Lista rotas comerciais com filtros por atividade e disponibilidade.
POST
/routes
Cria rota comercial com descricao, datas e regra de permanencia ativa.
GET
/routes/active
Recupera rotas ativas para vincular em novas vendas.

Vendas e cobrancas

7 endpoints
GET
/sales
Lista vendas com filtros por status, cliente, rota e periodo.
POST
/sales
Cria uma venda com seus itens.
PUT
/sales/{id}/items
Substitui a composicao de itens da venda.
GET
/sales/{id}/payments
Lista pagamentos de uma venda.
POST
/sales/{id}/payments
Registra um novo pagamento para a venda.
GET
/reports/summary
Entrega indicadores agregados do tenant ou do usuario.
POST
/sales/{id}/payments
Registra pagamento e atualiza paid_amount, pending_amount e status da venda.

Operacao mobile

5 endpoints
POST
/navigation/road-route
Gera uma rota viaria com OSRM e fallback em linha reta.
GET
/sync/bootstrap
Carga inicial para o app mobile.
POST
/sync/push
Envia mudancas locais do dispositivo para o servidor.
GET
/sync/pull
Baixa mudancas desde um cursor anterior.
POST
/sync/ack
Confirma o processamento de um lote sincronizado.

Operacao mobile e sync

4 endpoints
GET
/sync/bootstrap
Carga inicial para o app mobile.
GET
/sync/pull
Baixa alteracoes desde um cursor anterior, incluindo soft deletes.
POST
/sync/push
Envia mudancas locais do dispositivo para o servidor.
POST
/sync/ack
Confirma o processamento do lote sincronizado e atualiza o ultimo cursor do device.