Pular para o conteúdo
platform
PT EN

Referência da API · CashBack

Consultar Histórico de Cashback do Cliente

Método
GET
Rota
/loyaltyProgram/customerReport/:document
URL base
https://ws.autorei.net
Parâmetros de rota
:document
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 extrato de cashback de um cliente da sua loja: um item por lançamento, ganho ou gasto, do mais recente para o mais antigo.

Parâmetros de Rota

Parâmetro Tipo Obrigatório Descrição
document string Sim CPF ou CNPJ do cliente. O cliente precisa ser da loja autenticada.

Parâmetros de Consulta

Parâmetro Tipo Obrigatório Descrição
limit integer Não Lançamentos por página. Padrão 20, teto 50, valor acima disso é reduzido para 50, sem erro.
offset integer Não Lançamento inicial da página. Padrão 0.
status string Não Filtra os lançamentos por status. Aceita vários separados por vírgula, sem espaço: status=TO_RELEASE,RELEASED. Omitido, traz todos.

Valores aceitos em status: TO_RELEASE, RELEASED, CANCELLED, INVALID_EXPIRED (lançamentos de crédito) e IN_USE, USED, EXPIRED (lançamentos de débito).

Regras de negócio

Status desconhecido não é recusado

Um valor fora da lista não gera erro de validação: ele simplesmente não casa com nenhum lançamento. O resultado é a resposta de "sem registros" (400), igual a um filtro que não encontrou nada.

Filtro sem resultado e cliente sem cashback respondem igual

Não há como distinguir, pela resposta, "este cliente nunca teve cashback" de "este cliente não tem lançamento no status filtrado", as duas situações devolvem 400 com no record found.

Resposta · 200

Array com um objeto por lançamento.

Campo Tipo Descrição
partnerOrder integer Id do pedido CWS que gerou o lançamento. Vem 0 quando o lançamento não veio de um pedido da plataforma, é o caso do cashback concedido por pedido externo.
value string Valor do lançamento. String com duas casas decimais e ponto como separador ("10.41"), não número.
createDate string Data e hora do lançamento, em UTC (2024-03-13T21:26:57.161938Z).
status string Status do lançamento, entre os valores aceitos em status.
expirationDate string Data de expiração do saldo. Vem null quando o lançamento não tem expiração definida.
type string credit quando o cliente ganhou, debit quando gastou. Em minúsculas.

Erros

Código Quando
400 {"status":"BAD_REQUEST","message":"no customer found"}, o documento não corresponde a nenhum cliente da sua loja. É a mesma resposta para documento inexistente e para cliente de outra loja.
400 {"status":"BAD_REQUEST","message":"no record found"}, o cliente existe, mas não há lançamento no filtro pedido (ou o offset passou do fim). 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/customerReport/:document?limit=20&offset=0' \
  --header 'Authorization: Bearer {{access_token}}'

Respostas de exemplo

200Sucesso: extrato com ganho e uso

[
  {
    "partnerOrder": 0,
    "value": "11.80",
    "createDate": "2026-09-04T14:15:02.534996Z",
    "status": "TO_RELEASE",
    "expirationDate": null,
    "type": "credit"
  },
  {
    "partnerOrder": 900201,
    "value": "15.00",
    "createDate": "2026-08-22T18:03:41.229713Z",
    "status": "USED",
    "expirationDate": null,
    "type": "debit"
  },
  {
    "partnerOrder": 900201,
    "value": "42.35",
    "createDate": "2026-08-14T11:47:09.161938Z",
    "status": "RELEASED",
    "expirationDate": "2026-11-12T00:00:00-03:00",
    "type": "credit"
  }
]

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.