Referência da API

Clientes

Quem já abriu um carrinho na loja, com quanto gastou e quantos pedidos pagou.

Rotas deste grupo2

GET/customersListar clientescustomers:read
GET/customers/{id}Ver um clientecustomers:read

Listar clientes

GET/api/v1/customers

Ordenados pelo mais recente, pelo gasto ou pela quantidade de pedidos.

Permissão: customers:read

Parâmetros da URL

`discord_id`	texto	Um cliente pelo ID do Discord.
`q`	texto	Busca pelo nome.
`sort`	texto	recent (padrão), spent ou orders.
`page`	inteiro	Página, a partir de 1. Padrão 1.
`per_page`	inteiro	Itens por página, de 1 a 100. Padrão 20.

Exemplo

curl

curl https://zolvibot.app/api/v1/customers \
  -H "Authorization: Bearer zv_sk_SUA_CHAVE"

Resposta 200

{
  "data": [
    {
      "id": "cmvrlovla0001ssvcuio6xvf7",
      "discord_id": "1390611228354809977",
      "username": "cliente",
      "total_spent_cents": 8970,
      "orders_count": 3,
      "supporting": {
        "affiliate_id": "cmw9a1b2c0001ss11aaaa1111",
        "code": "DUSTY",
        "since": "2026-11-01T12:00:00.000Z"
      },
      "created_at": "2026-10-28T04:14:41.902Z"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 20,
    "total": 1,
    "last_page": 1
  }
}

Ver um cliente

GET/api/v1/customers/{id}

Pelo id da Zolvi ou pelo ID do Discord.

Permissão: customers:read

Exemplo

curl

curl https://zolvibot.app/api/v1/customers/ID \
  -H "Authorization: Bearer zv_sk_SUA_CHAVE"

Resposta 200

{
  "id": "cmvrlovla0001ssvcuio6xvf7",
  "discord_id": "1390611228354809977",
  "username": "cliente",
  "total_spent_cents": 8970,
  "orders_count": 3,
  "supporting": {
    "affiliate_id": "cmw9a1b2c0001ss11aaaa1111",
    "code": "DUSTY",
    "since": "2026-11-01T12:00:00.000Z"
  },
  "created_at": "2026-10-28T04:14:41.902Z"
}