Entrar

Relatório de resgates de cashback: quais pedidos resgataram, por campanha, loja de origem x loja do resgate (circulação de saldo)

GET https://{organization}.myguper.com/api/loyalty/report/redemptions/{dateStart}/{dateEnd}

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.

Cabeçalhos

Name Type Description
x-guper-authorization * string User token issued by Guper. Omit only on endpoints that explicitly support a Public mode.
Content-Type * string Always `application/json` for endpoints that accept a JSON body.

Parâmetros do caminho

Name Type Description
dateStart * string Start of the period (YYYY-MM-DD), inclusive.
dateEnd * string End of the period (YYYY-MM-DD), inclusive.

Parâmetros de query

Name Type Description
groupBy string Omit for the paginated list. Otherwise one of `day`, `month`, `campaign`, `originStore`, `redeemStore`, or a comma list. `day` and `month` cannot be combined; they follow the cohort (redemption date or card issuance date).
cohort string Which date the period applies to. `redemption` (default) or `issuance`.
campaign string Only cards of these campaigns. Pass an array (`campaign[]=191&campaign[]=171`) or a comma list; a single id still works. Up to 200 ids.
originStore integer Only cards issued by this store.
redeemStore integer Only redemptions made in this store.
client integer Only cards of this client (person id).
rewardType string Which wallet. Default `monetary`.
page integer List page (default 1). Ignored with `groupBy`.
entries integer Rows per page (default 50, max 500). Ignored with `groupBy`.

Respostas

{
  "meta": { "unit": "cents", "timezone": "Etc/GMT+6", "cohort": "issuance", "groupBy": null },
  "total": { "rows": 757, "redemptions": 694, "orders": 694, "redeemedValue": 34095898 },
  "page": 1, "entries": 1, "pages": 757,
  "list": [
    { "tid": "f19f97178e926abacd584819d8e83e954b5254c4c6b12aea23c02670d21eb9e3",
      "cardId": 334708, "campaign": 191, "clientId": 2461453,
      "originStore": 1629, "redeemStore": 1629, "orderId": 3940209,
      "redeemedValue": 147400, "redeemedAt": "2025-10-04 15:26:23",
      "settledAt": "2026-08-27 16:42:03", "cardCreatedAt": "2025-08-17 16:48:09" }
  ]
}

Relacionados

Copied to clipboard