GET/api/v1/orders

Listar Pedidos

Retorna a lista paginada de pedidos (sales) da sua conta, ordenados do mais recente.

Escoporead + orders

Parâmetros de query

Parâmetro	Tipo	Descrição
page	integer	Página da listagem (padrão 1).
limit	integer	Itens por página (1–100, padrão 20).
status	string	Filtra por payment_status: paid, pending, refused, refunded, chargeback.
method	string	Filtra por método: pix, credit_card, boleto.

Exemplo de requisição

bash

curl https://devexpay-v3.vercel.app/api/v1/orders?status=paid&limit=10 \
  -H "Authorization: Bearer $TOKEN"

Resposta

json

{
  "count": 42,
  "next": "https://devexpay-v3.vercel.app/api/v1/orders?page=2&limit=10",
  "previous": null,
  "results": [
    {
      "id": "9f1c0e8c-...",
      "amount": 297.00,
      "payment_status": "paid",
      "payment_method": "pix",
      "pagarme_transaction_id": "tr_xxxxxx",
      "offer_id": "cdc93c57-...",
      "product_id": "252735b3-...",
      "created_at": "2026-06-08T10:00:00Z"
    }
  ]
}

Estrutura da resposta

Parâmetro	Tipo	Descrição
count	integer	Total de pedidos que satisfazem o filtro.
next	string\|null	URL da próxima página.
previous	string\|null	URL da página anterior.
results[]	Order[]	Lista de pedidos.

Erros possíveis

Status	Descrição
401	Token inválido ou ausente.
403	Chave sem escopo read + orders.