GET /api/v1/sales/

Retorna uma lista paginada de vendas da organização, com suporte a filtros por cliente, produto, status e tipo de pagamento.

Retorna todas as vendas associadas à organização autenticada. É possível filtrar os resultados por cliente, produto, assinatura, checkout, status da venda e tipo de pagamento. O resultado é paginado.

​

Autenticação

Requer Organization Access Token via header Authorization: Bearer.

Escopos aceitos: web:read, web:write ou sales:read.

​

Parâmetros de Query

organization_id · string[]

Filtra vendas de uma ou mais organizações específicas.

customer_id · string[]

Filtra vendas de um ou mais clientes específicos.

subscription_id · string[]

Filtra vendas associadas a uma ou mais assinaturas.

checkout_id · string[]

Filtra vendas originadas de um ou mais checkouts.

status · string[]

Filtra pelo status da venda. Valores aceitos: new, pending, pre_authorized, succeeded, failed, canceled, refunded, partially_refunded, reversed, dispute, charged_back.

payment_type · string[]

Filtra pelo tipo de pagamento. Valores aceitos: credit, boleto, pix.

limit · integer

Quantidade de itens por página. Padrão: 10.

page · integer

Número da página a ser retornada. Padrão: 1.

sorting · string[]

Critério de ordenação dos resultados. Valores aceitos: created_at, -created_at, amount, -amount, status, -status, confirmed_at, -confirmed_at. O prefixo - indica ordem decrescente.

​

Resposta

items · array

Lista de objetos de venda.

pagination · object

Informações de paginação.

Show pagination

total_count · integer

Total de vendas que correspondem aos filtros aplicados.

max_page · integer

Número máximo de páginas disponíveis.

​

Exemplo

cURL

curl -X GET "https://api.chargefy.io/api/v1/sales/?limit=10&page=1&status=succeeded" \
  -H "Authorization: Bearer $CHARGEFY_ACCESS_TOKEN"

​

Resposta de Exemplo

{
  "items": [
    {
      "id": "sale_01j9abc123",
      "status": "succeeded",
      "amount": 9900,
      "payment_type": "credit",
      "installments": 1,
      "created_at": "2024-11-01T12:00:00Z",
      "customer": { "id": "cust_01j9xyz", "email": "[e-mail]" }
    }
  ],
  "pagination": {
    "total_count": 1,
    "max_page": 1
  }
}