Consultar vendas

Consultar todas as vendas

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

Paginação e filtros

Todos os query params são opcionais. A consulta retorna as Vendas da empresa autenticada. order_id usa busca parcial; uuid, type, status, customer_email e customer_document_number usam correspondência exata.

Os padrões são page=1, size=10, sort=created_at e dir=desc. dir depende do envio de sort. Os enums listam valores conhecidos; valores desconhecidos em type e status não têm rejeição por enum garantida.

status refere-se à Venda. OVERPAID está declarado no código, mas suas condições de atribuição à Venda estão a confirmar.

Valores

Valores monetários são inteiros em centavos (1000 = R$ 10,00). Valores iguais ao mínimo ou ao máximo informado também entram no resultado. amount_end < amount_start retorna HTTP 400 quando ambos são enviados.

Datas

  • Formatos aceitos: YYYY-MM-DD, YYYY-MM-DDTHH:mm:ss, YYYY-MM-DD HH:mm:ss e RFC 3339 com Z ou offset.
  • Sem offset, a interpretação inicial é UTC. Datas sem horário representam meia-noite; _end não se estende ao fim do dia. Registros exatamente nos limites considerados pelo filtro também entram no resultado.
  • created_at_* e updated_at_* somam três horas ao valor interpretado, mesmo com offset. due_date_* e expiry_date_* não recebem esse acréscimo.
  • Datas inválidas podem ser ignoradas, sem erro de validação garantido.
Query Params
string

Filtrar por UUID da Venda.

string
enum

Filtrar pelo tipo da Venda.

Allowed:
string
enum

Filtrar pelo status da Venda, distinto do status da Transação.

string

Buscar Vendas cujo order_id contenha o texto informado.

string

Filtrar pelo e-mail do comprador.

string

Filtrar pelo número do documento do comprador.

integer

Valor original mínimo da Venda, em centavos. Inclui o valor informado.

integer

Valor original máximo da Venda, em centavos. Inclui o valor informado.

integer

Valor mínimo da Venda, em centavos. Inclui o valor informado.

integer

Valor máximo da Venda, em centavos, incluindo o valor informado. Deve ser maior ou igual a amount_start, quando informado.

integer

Valor pago mínimo, em centavos. Inclui o valor informado.

integer

Valor pago máximo, em centavos. Inclui o valor informado.

integer

Valor reembolsado mínimo, em centavos. Inclui o valor informado.

integer

Valor reembolsado máximo, em centavos. Inclui o valor informado.

string

Filtrar vencimentos a partir da data informada, incluindo o limite.

string

Filtrar vencimentos até a data informada, incluindo o limite.

string

Filtrar expirações a partir da data informada, incluindo o limite.

string

Filtrar expirações até a data informada, incluindo o limite.

string

Filtrar registros criados a partir da data informada, incluindo o limite. O filtro soma 3 horas à data recebida.

string

Filtrar registros criados até a data informada, incluindo o limite. O filtro soma 3 horas à data recebida.

string

Filtrar atualizações a partir da data informada, incluindo o limite. O filtro soma 3 horas à data recebida.

string

Filtrar atualizações até a data informada, incluindo o limite. O filtro soma 3 horas à data recebida.

integer
Defaults to 10

Registros por página: de 10 a 200. Valores fora dessa faixa utilizam 10.

integer
Defaults to 1

Número da página. Valores menores que 1 utilizam a página 1.

string
enum
Defaults to created_at

Campo de ordenação. Valores desconhecidos utilizam created_at.

string
enum
Defaults to desc

Direção da ordenação. Só é considerada quando sort é enviado; apenas asc altera o padrão desc.

Allowed:
Headers
string
required
Responses

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