# Listar vendas

URL: https://staging.pagpolar.com/docs/referencia/vendas/list-sales

`GET /sales`

## Autenticação

- Token Bearer no header `Authorization` (esquema `BearerAuth`). Token de acesso devolvido por POST /auth/token. Envie como "Authorization: Bearer <token>". Vale 24 horas.

## Parâmetros de consulta

| Parâmetro | Tipo | Obrigatório | Descrição |
| --- | --- | --- | --- |
| `page` | inteiro | não | Número da página, começando em 1. |
| `per_page` | inteiro | não | Itens por página, de 1 a 100. |
| `status` | enum | não | Situação da venda. Valores: `DRAFT`, `OPEN`, `PROCESSING`, `PAID`, `CANCELED`, `ASK_REFUND`, `ASK_PARTIAL_REFUND`, `REFUNDED`, `PARTIALLY_REFUNDED`, `REFUNDING`, `ABANDONED`, `EXPIRED`, `FAILED`, `CHARGEBACK_REQUESTED`, `CHARGEBACK_APPROVED`. |
| `payment_method` | enum | não | Meio de pagamento da venda. Valores: `CREDIT_CARD`, `PIX`, `BOLETO`, `APPLE_PAY`, `GOOGLE_PAY`. |
| `created_from` | texto (date-time) | não | Vendas criadas a partir desta data e hora, incluindo ela. ISO 8601 com fuso. |
| `created_to` | texto (date-time) | não | Vendas criadas até esta data e hora, incluindo ela. ISO 8601 com fuso. |
| `external_reference` | texto | não | Lista só as vendas com esta referência do pedido (a mesma enviada na criação do pagamento ou da assinatura). |
| `product_id` | texto (uuid) | não | Vendas que têm este produto em algum item. A venda volta com todos os itens. |
| `customer_email` | texto (email) | não | E-mail do cliente da venda. E-mail completo, sem diferenciar maiúsculas de minúsculas. |
| `customer_document` | texto | não | Documento do cliente da venda. CPF com 11 dígitos ou CNPJ com 14, com ou sem pontuação. Exemplo: `123.456.789-09`. |

## Respostas

### 200 — Lista de vendas

| Campo | Tipo | Obrigatório | Descrição |
| --- | --- | --- | --- |
| `data` | [lista de Venda](/docs/referencia/entidades/venda) | não | — |
| `meta` | objeto | não | — |
| `meta.page` | inteiro | não | Exemplo: `1`. |
| `meta.per_page` | inteiro | não | Exemplo: `25`. |
| `meta.total` | inteiro | não | Exemplo: `143`. |
| `meta.total_pages` | inteiro | não | Exemplo: `6`. |

## Erros

| Status | Descrição |
| --- | --- |
| `401` | Token ausente, inválido ou expirado, ou credencial revogada ou expirada. Chame POST /auth/token para obter um token novo. |
| `403` | IP não autorizado |
| `429` | Limite de requisições excedido |

Lista completa de códigos e como tratá-los: [Erros](/docs/guias/fundamentos/erros).