Ir para o conteúdo

Referência da API · v1 em prévia

Consulte vendas.

Lista vendas reais do produtor. Valores em reais são representados em centavos. O recurso não retorna nome, e-mail, documento, telefone ou identificador do perfil do comprador.

GET/api/v1/sales

Requer plano Scale efetivo. Escopo necessário: sales:read. O produtor é definido pela credencial, enviada em Authorization: Bearer <sua-credencial>. Ordem decrescente por created_at, com desempate por id. A resposta abaixo usa dados sintéticos e ilustra o formato, sem representar uma operação real; a coleção também pode estar vazia.

Escopo
  • sales:read

Parâmetros

NomeDescrição
limitDe 1 a 100; padrão 50.
cursorCursor opaco da página anterior. Omita na primeira consulta.

Exemplo de resposta

JSON
{
  "data": [
    {
      "id": "00000000-0000-4000-8000-000000000201",
      "product_id": "00000000-0000-4000-8000-000000000101",
      "offer_id": null,
      "product_slug": "curso-exemplo",
      "status": "paid",
      "amount_brl_cents": 10000,
      "net_brl_cents": 9500,
      "created_at": "2026-09-03T12:00:00.000001Z",
      "paid_at": "2026-09-03T12:01:00.000001Z",
      "refunded_at": null
    }
  ],
  "next_cursor": null,
  "version": "v1"
}

Campos retornados

Campos sem valor são retornados como null. Campos adicionais devem ser tolerados pelo consumidor.

CampoSignificado e tratamento
idIdentificador da venda.
product_idReferência ao produto; pode ser null.
offer_idReferência à oferta; pode ser null.
product_slugIdentificador legível do produto associado à venda.
statusEstado da venda. Exemplos: pending, paid, refunded. Uma linha não representa necessariamente receita confirmada.
amount_brl_centsValor bruto da venda em centavos de real: 10000 representa R$ 100,00.
net_brl_centsValor líquido registrado em centavos de real. Não é uma cotação de saque ou o saldo total da conta.
created_atData e hora de criação; usada na ordenação.
paid_atData e hora de pagamento, quando registrada; pode ser null.
refunded_atData e hora de reembolso, quando registrada; pode ser null.

Conferência de valores e estados

A coleção contém vendas reais e pode incluir diferentes estados. Para um relatório de pagamentos confirmados, interprete o estado e as datas; somar todas as linhas como receita produz um resultado incorreto.

Mantenha valores em centavos durante os cálculos. O exemplo apresenta um líquido ilustrativo e não define uma regra de cálculo de taxas. Use o valor registrado e reconcilie alterações como reembolso.

Dúvidas frequentes

Percorra a coleção completa

Use o cursor retornado para continuar e mantenha a conferência do estado atual dos registros.

Referência conferida em 8 de outubro de 2026. Relatar uma dúvida na documentação.