Guía: Lectura desde GET · Condiciones →

Respuesta de GET /points

Referencia OpenAPI: GetAListOfScoreCampaigns — GET https://streaming.loyal.guru/points.

Casos de uso habituales para integraciones:

• Listar campañas de puntos/wallet activas (GET /points).
• Filtrar por tipo de evento: ?when=manual devuelve solo campañas de asignación directa (ver API de campañas).
• Catálogo por customer, país o tier según parámetros de query (cuando la API los expone en el listado).

Comportamiento del listado (habitual):

• Solo campañas activas (active: true) y vigentes según available_from / available_to.
• Paginación con starting_after / next_token_starts_after si la respuesta lo incluye.

Índice

• Query parameters
• Envoltura de la respuesta
• Campos de reglas en la respuesta
• Metadatos por ítem en data[]
• Activación y caducidad (ciclo de vida del saldo)
• Integración API en ticket

---

Query parameters

Parámetro	Uso
when	Filtra por evento de la campaña (p. ej. manual para asignación directa).
customer_id / customer_code	Catálogo o elegibilidad del customer cuando el endpoint lo soporta.
countries	Filtro por país de registro o alcance.
tier_id	Campañas asociadas a un tier.
starting_after	Paginación: token de la página anterior.

Consulta la documentación OpenAPI actualizada para la lista completa de filtros en GET /points.

Envoltura de la respuesta

Campo	Descripción
data	Array de objetos campaña.
next_token_starts_after	Token para la siguiente página (starting_after). Ausente en la última página.

Campos de reglas en la respuesta

GET /points (listado) y GET /points/{id} (detalle) usan los mismos nombres en el objeto campaña:

Campo en la respuesta	Tipo habitual	Contenido tras parsear
rule_conditions	string JSON	conditions.and[] / conditions.or[] (o formato plano en POST)
rule_application	string JSON	application.and[] (clave interna application)
rule_effects	string JSON	type, value, distribution, limits, rule_group, …

Frecuencia de victoria y presupuesto: once, once_limit, budget_value, budget_period — ver Límites.

Estructura interna vs nombre de campo: el campo de la API se llama rule_application, pero dentro del JSON parseado la raíz suele ser application.and[].

Metadatos por ítem en data[]

Bloque	Campos	Para qué sirve en integración
Identidad	id, name, description	ID y textos de la campaña.
Evento	when	after_create_activity (carrito), after_create_custom_entity (evento personalizado), slug de trigger configurado, o manual (asignación directa)
Moneda / modo	currency, accrual_mode (si viene)	Divisa del value monetario en rule_effects; points vs money para presentación. Requiere score_exchange de esa moneda para convertir a puntos — ver Efectos.
Vigencia	active, available_from, available_to, recurrence_type, recurrence_days	Si la campaña aplica hoy.
Audiencia	select_customers	Solo loyalty o targeted — no all_customers (en puntos hace falta customer identificado para acreditar saldo).
Activación	activation_period_type, activation_delay	Cuándo el saldo otorgado pasa a estar disponible.
Caducidad	expiration_period_type, availability_duration	Cuándo expira el saldo otorgado.
Límites victoria	once, once_limit, budget_value, budget_period	Ver Límites.
Categoría	category (si viene)	Clasificación de la regla en Owner App.

Activación y caducidad (ciclo de vida del saldo)

Tras un otorgamiento, el customer puede ver saldo en estados distintos:

Concepto	Campos en GET (habitual)	Integración
Activación	activation_period_type, activation_delay	Retraso hasta que el saldo es usable (p. ej. N días después del ticket).
Caducidad	expiration_period_type, availability_duration	Ventana o periodo fijo de expiración del saldo.

Detalle de producto: Reglas de acumulación y documentación de expiración si está publicada en tu versión de la KB.

Integración API en ticket

Al crear o simular un ticket (POST /activities o POST /activities/simulate), el flag apply_points del payload controla si esa transacción evalúa campañas de puntos (por defecto suele ser true). Ver Integración API en la página de Puntos y Wallet.

Parseo: rule_conditions, rule_application y rule_effects suelen venir como string JSON. Deserializa antes de leer cláusulas.

---

Siguiente: Condiciones (rule_conditions)