Referência da API · CashBack

Consultar Saldo Total de Cashback do Marketplace

Método: GET
Rota: /loyaltyProgram/total
URL base: https://ws.autorei.net
Token: Exige token Bearer

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

Descrição

Retorna o saldo de cashback da sua loja, somado por tipo e por status. É a visão consolidada: um número por status, sem detalhe por cliente ou por pedido.

Resposta · 200

Dois objetos, credit e debit. Em cada um, a chave é o status e o valor é o total naquele status, não há campos fixos: só aparece o status que tem saldo. Uma loja sem nenhum débito devolve "debit": {}.

Campo	Tipo	Descrição
`credit`	objeto	Cashback que os clientes ganharam, por status.
`debit`	objeto	Cashback que os clientes gastaram, por status.

Status possíveis nas chaves:

Status	Onde aparece	Significado
`TO_RELEASE`	`credit`	Concedido, ainda em carência, o cliente não pode usar.
`RELEASED`	`credit`	Liberado para uso.
`CANCELLED`	`credit` · `debit`	Cancelado.
`INVALID_EXPIRED`	`credit`	Crédito que expirou sem ser usado.
`IN_USE`	`debit`	Reservado num carrinho em aberto.
`USED`	`debit`	Efetivamente consumido numa compra.
`EXPIRED`	`debit`	Débito de saldo que expirou.

Os valores são string, não número, duas casas decimais e ponto como separador ("220971.17"). Converta antes de somar.

Erros

Código	Quando
400	`{"status":"BAD_REQUEST","message":"no record found"}`, a loja não tem nenhum registro de cashback. É a resposta para loja sem programa de fidelidade ou sem movimento, 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/total' \
  --header 'Authorization: Bearer {{access_token}}'

Respostas de exemplo

200Sucesso: saldo consolidado da loja

{
  "credit": {
    "TO_RELEASE": "1284.36",
    "RELEASED": "7350.09",
    "CANCELLED": "118.24",
    "INVALID_EXPIRED": "942.71"
  },
  "debit": {
    "IN_USE": "260.50",
    "USED": "4810.62",
    "EXPIRED": "331.08"
  }
}

Usado em

Casos de usoMarketplace B2B: o caminho típico pela API

Endpoints relacionados

GET Listar Saldo de Cashback Agregado por Cliente /loyaltyProgram/listCustomersTotal
GET Consultar Histórico de Cashback do Cliente /loyaltyProgram/customerReport/:document
POST Conceder Cashback por Pedido Externo /loyaltyProgram/earnRewardExternal
PUT Atualizar Cashback de Pedido Externo /loyaltyProgram/earnRewardExternal

← Ver o grupo: CashBack

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