Cashback redemptions report: which orders redeemed, per campaign, origin store vs redemption store (circulation)
Settled cashback redemptions — one row per (redemption, card) — with the
order that used the balance, the store that issued the card and the store
where it was redeemed. Paginated. Pass groupBy to get aggregates instead
(by day, month, campaign, origin store and/or redemption store).
Use it for the detail table of redemptions, to answer "which orders used the
cashback of campaign X", and for balance circulation between stores
(groupBy=originStore,redeemStore: where the balance was generated vs where it
was spent).
Grain: the card. An order that used three cards shows up three times, so
there is no order total here on purpose — summing a ticket over these rows
counts the same order several times. For revenue per order use
order.report.sales (with attribution) or order.campaign.report.
A redemption counts only once the sale is settled. Open checkout
reservations and canceled reservations are left out. redeemedValue is the
debit minus any partial reversal of that same redemption, on that card.
cohort=redemption (default): debits (checkout) dated in the period, from
cards of any date. cohort=issuance: cards issued in the period, redeemed at
any date. Values are in cents; dates are in the organization timezone.
Test cards (production=0) are excluded; rewardType defaults to monetary.
In aggregates, redemptions (distinct redemptions), cards (distinct cards)
and orders (distinct orders) are different counts — none of them is a
denominator for the others.
Try-it values populated from environment ACME (Demo)
Authentication
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.