Relatório de resgates de cashback: quais pedidos resgataram, por campanha, loja de origem x loja do resgate (circulação de saldo)
Resgates de cashback liquidados — uma linha por (resgate, card) — com o
pedido que usou o saldo, a loja que emitiu o card e a loja onde ele foi
resgatado. Paginado. Passe groupBy para receber agregados (por dia, mês,
campanha, loja de origem e/ou loja de resgate).
Use para a tabela de detalhe dos resgates, para responder "quais pedidos usaram
o cashback da campanha X" e para a circulação de saldo entre lojas
(groupBy=originStore,redeemStore: onde o saldo foi gerado x onde foi gasto).
Granularidade: o card. Um pedido que usou três cards aparece três vezes, por
isso não há valor do pedido aqui, de propósito — somar ticket por estas
linhas conta o mesmo pedido várias vezes. Receita por pedido:
order.report.sales (com atribuição) ou order.campaign.report.
Resgate só conta quando a venda foi liquidada. Reserva aberta no checkout e
reserva cancelada ficam fora. redeemedValue é o débito menos o estorno parcial
daquele mesmo resgate, naquele card.
cohort=redemption (padrão): débitos (checkout) com data no período, de cards de
qualquer data. cohort=issuance: cards emitidos no período, resgatados em
qualquer data. Valores em centavos; datas no fuso da organização. Cards de
teste (production=0) ficam fora; rewardType padrão monetary.
Nos agregados, redemptions (resgates distintos), cards (cards distintos) e
orders (pedidos distintos) são contagens diferentes — nenhuma serve de
denominador para a outra.
Try-it values populated from environment ACME (Demo)
Autenticação
Token
Send your user token in the x-guper-authorization header. Endpoints that
support a Public mode (e.g. acúmulo and resgate previews) accept the same
request without the header — Private mode adds customer data and a
confirmation token to the response.