Documentação da API v1 · Conheça a Naut
v1

Consultar a receita de um período

Soma a receita da conta dentro de uma janela. O começo e o fim são obrigatórios: janela aberta devolveria número sem significado.

GEThttps://api.navenaut.com/seller/revenue

Autenticação

A sessão do painel autentica esta rota, e ela é lida de forma autoritativa: não há parâmetro em que o chamador aponte para outra conta.

Esta rota não exige escopo nomeado — o que não quer dizer que ela seja aberta: sem a credencial acima ela recusa.

Exige sessão de vendedor. Tudo aqui é escopado pela sessão: não há parâmetro em que o chamador aponte para outra conta.

Parâmetros

Consulta

NomeTipoDescrição
currencyum de: `BRL`, `USD`, `EUR`A moeda dos valores somados.
fromtexto (date-time)Começo da janela, inclusive.
totexto (date-time)Fim da janela, inclusive.

Respostas

200 · sucesso

{
  "currency": "BRL",
  "from": "2026-01-15T12:00:00.000Z",
  "received": {
    "amountCents": 129900,
    "currency": "BRL"
  },
  "salesCount": 0,
  "series": [
    {
      "day": "exemplo",
      "received": {
        "amountCents": 129900,
        "currency": "BRL"
      },
      "salesCount": 0
    }
  ],
  "timeZone": "exemplo",
  "to": "2026-01-15T12:00:00.000Z"
}

400 · requisição inválida

A janela pedida não é válida.

Erros desta rota

StatusCódigoQuandoO que fazer
400REVENUE_WINDOW_INVALIDA janela pedida não fecha: from está depois de to, uma das duas datas não é legível, ou faltou uma delas. Janela aberta é recusada de propósito, porque soma sem começo e sem fim devolve um número que não significa nada.Mande as duas datas, com from antes de to, e reenvie. Repetir a mesma janela devolve o mesmo 400.

Os códigos são estáveis e fazem parte do contrato. A lista completa, com todos os vocabulários, está na tabela de erros.