Pular para o conteúdo
platform
PT EN

Referência da API · CashBack

Listar Saldo de Cashback Agregado por Cliente

Método
GET
Rota
/loyaltyProgram/listCustomersTotal
URL base
https://ws.autorei.net
Parâmetros de consulta do exemplo
limit=20 offset=0
Token
Exige token Bearer
Testar no Postman

Abre esta requisição na documentação pública da API, a fonte oficial da referência.

Descrição

Lista o saldo de cashback da sua loja cliente por cliente, com os totais por status de cada um. Use quando precisar do saldo individual; para o consolidado da loja, use GET /loyaltyProgram/total.

Parâmetros de Consulta

Parâmetro Tipo Obrigatório Descrição
limit integer Não Registros por página. Padrão 20, teto 50, valor acima disso é reduzido para 50, sem erro.
offset integer Não Registro inicial da página. Padrão 0.

Regras de negócio

A paginação conta lançamentos, não clientes

limit e offset são aplicados aos lançamentos de cashback, e a resposta agrupa esses lançamentos por cliente. Como um cliente costuma ter mais de um lançamento, a página devolve menos clientes do que o limit, limit=20 pode voltar 17 clientes. Não use a quantidade de itens da resposta para decidir se chegou ao fim. Não existe página vazia: quando o offset passa do último lançamento, a resposta é 400 com no record found, é esse 400 que encerra a paginação.

Resposta · 200

Array com um objeto por cliente.

Campo Tipo Descrição
customerId integer Id do cliente na CWS.
name string Nome ou razão social do cliente.
document string CPF ou CNPJ do cliente.
credit objeto Cashback que o cliente ganhou, por status. Chave = status, valor = total.
debit objeto Cashback que o cliente gastou, por status. Vem {} quando não há débito.

Os status possíveis nas chaves de credit e debit são os mesmos de GET /loyaltyProgram/total: TO_RELEASE, RELEASED, CANCELLED, INVALID_EXPIRED, IN_USE, USED, EXPIRED. Os valores são string com duas casas decimais e ponto como separador ("11.80").

Erros

Código Quando
400 {"status":"BAD_REQUEST","message":"no record found"}, a loja não tem nenhum registro de cashback, ou o offset passou do fim da lista. Não é um erro na sua requisição.
401 Token ausente, malformado ou expirado.

Exemplo de requisição

curl --request GET 'https://ws.autorei.net/loyaltyProgram/listCustomersTotal?limit=20&offset=0' \
  --header 'Authorization: Bearer {{access_token}}'

Respostas de exemplo

200Sucesso: dois clientes com saldo

[
  {
    "customerId": 700101,
    "name": "Ana Paula Ribeiro",
    "document": "700.413.648-56",
    "credit": {
      "TO_RELEASE": "11.80",
      "RELEASED": "42.35"
    },
    "debit": {
      "USED": "15.00"
    }
  },
  {
    "customerId": 700102,
    "name": "Comercial Aurora Ltda",
    "document": "29.893.264/0001-01",
    "credit": {
      "RELEASED": "318.90"
    },
    "debit": {}
  }
]

Usado em

Endpoints relacionados

← Ver o grupo: CashBack

Gerado a partir da coleção pública da API, publicada em 04/09/2026: api-docs.cws.digital.