Saltearse al contenido

Recompensas

Listar recompensas

GET /api/v1/rewards

Parámetros de query

ParámetroTipoDescripción
pagenúmeroPágina.
limitnúmeroPor página, máximo 100.
statustextoActive o Inactive.
searchtextoBusca por nombre.

Ejemplo

Ventana de terminal
curl "https://api.novity.com.ar/api/v1/rewards?status=Active" \
-H "Authorization: Bearer nv_tu_api_key"

Obtener una recompensa

GET /api/v1/rewards/:rewardId

Ejemplo

Ventana de terminal
curl https://api.novity.com.ar/api/v1/rewards/rew_abc123 \
-H "Authorization: Bearer nv_tu_api_key"

Canjear una recompensa

Canjea una recompensa para un cliente. La API verifica que el cliente tenga puntos suficientes, los descuenta y registra el canje.

POST /api/v1/rewards/redeem

Cuerpo

CampoTipoDescripción
customerIdtextoObligatorio. ID del cliente.
productIdtextoObligatorio. ID de la recompensa.
deliverNowbooleanoSi es true, entrega la recompensa de inmediato (método Manual).

Ejemplo

Ventana de terminal
curl -X POST https://api.novity.com.ar/api/v1/rewards/redeem \
-H "Authorization: Bearer nv_tu_api_key" \
-H "Content-Type: application/json" \
-d '{
"customerId": "cus_abc123",
"productId": "rew_abc123",
"deliverNow": true
}'

Errores

CódigoMensaje
400customerId y productId son requeridos
400Puntos insuficientes. Disponible: X, requerido: Y