Referência da API
CashBack
Endpoints para consulta de saldos e gerenciamento de cashback de clientes.
Endpoints deste grupo
-
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.
-
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.
-
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.
-
Concede cashback a um cliente a partir de um pedido que aconteceu fora da plataforma CWS, uma venda no seu balcão, no seu e-commerce próprio ou em outro canal. Você informa quem comprou, o número do pedido no seu sistema e os itens; o programa de fidelidade calcula quanto cada item rende e registra o crédito.
-
Altera um cashback já concedido por pedido externo: libera o crédito que estava em carência, cancela a concessão, corrige o valor ou a data de entrega. O pedido é identificado pelo mesmo externalOrderId usado na concessão.
Gerado a partir da coleção pública da API, publicada em 04/09/2026: api-docs.cws.digital.