Skip to main content
GET
Listar Vendas

Authorizations

X-Client-Id
string
header
required
X-Api-Key
string
header
required

Query Parameters

page
integer
default:1

Número da página a ser listada (mínimo 1)

Required range: x >= 1
limit
integer
default:10

Quantidade de registros por página (padrão 10). Acima de 100, a API devolve 400 com invalid_request

Required range: 1 <= x <= 100
order
enum<string>
default:desc

Ordenação por createdAt. Valores fora de asc e desc caem para desc

Available options:
asc,
desc
status
enum<string>

Filtra pelo status da Venda. Valor fora do enum devolve 400 Status da Venda

Available options:
pending,
paid,
failed,
cancelled
merchantId
string<uuid>

Filtra pelo identificador do merchant. UUID inválido devolve 400

orderId
string

Filtra pelo identificador do pedido

id
string<uuid>

Filtra pelo identificador da Venda. UUID inválido devolve 400

sessionId
string<uuid>

Filtra pelo sessionId informado na criação da Venda. UUID inválido devolve 400

createdAtGte
string<date-time>

Vendas criadas a partir do instante informado (inclusive, RFC 3339). Formato inválido devolve 422

createdAtLte
string<date-time>

Vendas criadas até o instante informado (inclusive, RFC 3339). Formato inválido devolve 422

Response

Página de Vendas

Página de Vendas

items
object[]
required
meta
object
required

Metadados de paginação