Listar vendas

Lista as vendas de produto do estabelecimento no período informado, pela data da venda.

Período: quando dataInicio e dataFim são omitidos, a listagem devolve os últimos 90 dias.
Quando só dataInicio é informada, o período vai até hoje. Quando só dataFim é informada, o período
começa 90 dias antes dela. O intervalo entre as duas datas não pode passar de 366 dias; acima disso a
resposta é 400.

Paginação: pageSize acima de 50 é limitado a 50.

Cliente: cliente é o cadastro, neste estabelecimento, de quem pagou a transação. É null quando a
transação não tem pagador ou quando o pagador não é cliente do estabelecimento. A venda aparece na lista
nos dois casos. Se a pessoa tiver dois cadastros, vale o cadastro de menor Id.

Transação: os campos de transacao são da transação inteira, não só dos produtos desta venda. A
transação pode incluir serviços e pacotes, então totalPagar, troco e formasPagamentos podem ser
maiores que o valorLiquido da venda. formasPagamentos tem as mesmas chaves de GET /v1/transacoes.

Estornos: transacao.tipoId vale 1 (Pagamento) ou 2 (Estorno), e transacao.tipoNome traz o nome. Em
uma venda estornada, transacao.idTransacaoQueEstornou é o id do estorno. Os estornos de produto não
aparecem na lista, nem com incluirEstornos=true: eles são gravados com valores negativos, e a lista só
traz vendas com total de produtos positivo.

Concorrência: no máximo 2 chamadas simultâneas por conta neste endpoint. A partir da terceira, a
resposta é 429 com o cabeçalho Retry-After.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int32

Numeração da página (padrão 1)

int32

Quantidade de registros por página (máximo 50)

date-time

(Opcional) Início do período, pela data da venda

date-time

(Opcional) Fim do período, pela data da venda. Sem hora, inclui o dia inteiro

boolean
Defaults to false

(Opcional) Quando true, inclui as vendas estornadas. Os estornos de produto não entram (ver Estornos)

Headers
string
required
Responses

Errors

Retry-After

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json