Skip to content
API/
Vendas
/
/
Retornar as vendas por fi...

Retornar as vendas por filtro

Request

Retorna as vendas filtradas, podendo fazer uso de parâmetros de consulta como data inicial/final, cliente, situação, tipos de venda, IDs de produtos, IDs de categorias, paginação, entre outros. Use esse endpoint para construir telas de listagem, dashboards ou relatórios de vendas.

Security
BearerAuth
Query
paginainteger

Página

Default:1
Example:pagina=1
tamanho_paginainteger

Tamanho da página. O parâmetro tamanho_pagina aceita somente os valores definidos no enum. Se um valor fora dessa lista for informado, a requisição não é processada e a API retorna 400 Bad Request, com a mensagem indicando quais valores são válidos.

Enum:1020501002005001000
Example:tamanho_pagina=10
campo_ordenado_ascendentestring

Campo para ordenação ascendente. Se informado ele desconsidera o valor do campo_ordenado_descendente. É possível ordenar por numero da venda (NUMERO), pelo nome do cliente (CLIENTE) ou pela data da venda (DATA)

Enum:"NUMERO""CLIENTE""DATA"
Example:campo_ordenado_ascendente=numero
campo_ordenado_descendentestring

Campo para ordenação descendente. Se este campo for utilizado, o campo campo_ordenado_ascendente não deverá ser informado. É possível ordenar por numero da venda (NUMERO), pelo nome do cliente (CLIENTE) ou pela data da venda (DATA)

Enum:"NUMERO""CLIENTE""DATA"
Example:campo_ordenado_descendente=numero
termo_buscastring

Termo para busca das vendas por nome, email do cliente ou número da venda

data_iniciostring, (date)

Data de início da emissão da venda

Example:data_inicio=2023-12-30
data_fimstring, (date)

Data final da emissão da venda

Example:data_fim=2023-12-30
data_criacao_destring, (date)

Data de início da criação da venda

Example:data_criacao_de=2023-12-30
data_criacao_atestring, (date)

Data final da criação da venda

Example:data_criacao_ate=2023-12-31
data_alteracao_destring, (date-time)

Data de alteração de (ISO 8601, São Paulo/GMT-3)

Example:data_alteracao_de=2025-10-20T07:59:59
data_alteracao_atestring, (date-time)

Data de alteração até (ISO 8601, São Paulo/GMT-3)

Example:data_alteracao_ate=2025-10-29T07:59:59
ids_vendedoresArray of strings, (uuid)

ids dos vendedores

ids_clientesArray of strings, (uuid)

ids dos clientes

ids_natureza_operacaoArray of strings, (uuid)

ids da natureza da operação

situacoesArray of strings

Situações das vendas

tiposArray of strings

Tipos de vendas

origensArray of strings

Origens das vendas

numerosArray of integers

Números das vendas

ids_categoriasArray of strings, (uuid)

ids das categorias

ids_produtosArray of strings, (uuid)

ids dos produtos

pendenteboolean

Indica se a venda está pendente

totaisstring

Tipo de total de venda. Possiveis valores WAITING_APPROVED, APPROVED, CANCELED, ALL

ids_legado_donosArray of integers

ids legados dos donos

ids_legado_clientesArray of integers

ids legados dos clientes

ids_legado_produtosArray of integers

ids legados dos produtos

ids_legado_categoriasArray of integers

ids legados das categorias

curl -i -X GET \
  'https://api-v2.contaazul.com/v1/venda/busca?pagina=1&tamanho_pagina=10&campo_ordenado_ascendente=numero&campo_ordenado_descendente=numero&termo_busca=string&data_inicio=2023-12-30&data_fim=2023-12-30&data_criacao_de=2023-12-30&data_criacao_ate=2023-12-31&data_alteracao_de=2025-10-20T07%3A59%3A59&data_alteracao_ate=2025-10-29T07%3A59%3A59&ids_vendedores=497f6eca-6276-4993-bfeb-53cbbbba6f08&ids_clientes=497f6eca-6276-4993-bfeb-53cbbbba6f08&ids_natureza_operacao=497f6eca-6276-4993-bfeb-53cbbbba6f08&situacoes=string&tipos=string&origens=string&numeros=0&ids_categorias=497f6eca-6276-4993-bfeb-53cbbbba6f08&ids_produtos=497f6eca-6276-4993-bfeb-53cbbbba6f08&pendente=true&totais=string&ids_legado_donos=0&ids_legado_clientes=0&ids_legado_produtos=0&ids_legado_categorias=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
totaisobject(TotaisVenda)

Valores das de vendas com status Aprovado, Cancelado, Esperando aprovação e Total

quantidadesobject(QuantidadesVenda)

Quantidades de vendas com status Aprovado, Cancelado, Esperando aprovação e Total

total_itensinteger

Total de itens

Example:10
itensArray of objects(Venda)
Response
{
  "totais": {
    "total": 1000,
    "aprovado": 500,
    "cancelado": 200,
    "esperando_aprovacao": 300
  },
  "quantidades": {
    "total": 10,
    "aprovado": 5,
    "cancelado": 3,
    "esperando_aprovacao": 2
  },
  "total_itens": 10,
  "itens": [
    { … }
  ]
}