Entrar

Reporte de canjes de cashback: qué pedidos canjearon, por campaña, tienda de origen vs tienda del canje (circulación de saldo)

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

Canjes de cashback liquidados — una fila por (canje, tarjeta) — con el pedido que usó el saldo, la tienda que emitió la tarjeta y la tienda donde se canjeó. Paginado. Pase groupBy para recibir agregados (por día, mes, campaña, tienda de origen y/o tienda de canje).

Úselo para la tabla de detalle de los canjes, para responder "qué pedidos usaron el cashback de la campaña X" y para la circulación de saldo entre tiendas (groupBy=originStore,redeemStore: dónde se generó el saldo vs dónde se gastó).

Granularidad: la tarjeta. Un pedido que usó tres tarjetas aparece tres veces, por eso no hay valor del pedido aquí, a propósito — sumar el ticket por estas filas cuenta el mismo pedido varias veces. Ingreso por pedido: order.report.sales (con atribución) u order.campaign.report.

Un canje solo cuenta cuando la venta fue liquidada. Las reservas abiertas en el checkout y las reservas canceladas quedan fuera. redeemedValue es el débito menos la reversión parcial de ese mismo canje, en esa tarjeta.

cohort=redemption (por defecto): débitos (checkout) con fecha en el período, de tarjetas de cualquier fecha. cohort=issuance: tarjetas emitidas en el período, canjeadas en cualquier fecha. Valores en centavos; fechas en la zona horaria de la organización. Las tarjetas de prueba (production=0) quedan fuera; rewardType por defecto monetary.

En los agregados, redemptions (canjes distintos), cards (tarjetas distintas) y orders (pedidos distintos) son conteos diferentes — ninguno sirve de denominador para el otro.

Try-it values populated from environment ACME (Demo)


Autenticación

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.

Encabezados

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 de ruta

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`.

Respuestas

{
  "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