Skip to main content
Retorna os pedidos da sua loja, do mais recente para o mais antigo. Método: GET /api/v1/orders Autenticação: Obrigatória — inclua o header Authorization: Bearer sk_live_sua_api_key.

Parâmetros de query

number
default:"50"
Pedidos por página. Máximo: 100.
number
default:"0"
Pedidos a pular, para paginação.
string
pending, paid, shipped, cancelled ou refunded.
Busca por nome do cliente, e-mail ou código do pedido.
string
Data ISO inicial, inclusiva.
string
Data ISO final, exclusiva.
string
UUIDs de produtos separados por vírgula. Retorna só pedidos que contenham ao menos um deles.

Exemplo de requisição

Resposta

total e price são em reais, com decimais. 149.9 = R$149,90.

Cliente e pagador

string
Quem comprou, informado no checkout. Use este campo para identificar o comprador.
string
Titular da conta que pagou o Pix, informado pelo banco. Difere de customerName quando outra pessoa paga.