Recompensas del programa

Las recompensas que el comercio entrega solas: bienvenida, cumpleaños y cliente del mes.

GET/v1/me/rewardsToken del usuario

Recompensas que el comercio entrega solas cuando pasa algo: la de bienvenida al adherirse, la de cumpleaños, la de cliente del mes.

Cada una indica si da un beneficio o puntos. Sirve para mostrarle al usuario qué gana además de canjear puntos.

Headers

X-Commerce-Idintegerheaderrequerido

Id del comercio que integra la API. Todas las respuestas quedan limitadas a este comercio.

Respuesta

Un array de Recompensa automática.

curl https://loybox-public-api-752998171300.southamerica-west1.run.app/v1/me/rewards \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "X-Commerce-Id: 87"
// 200 OK
[
  {
    "event": "welcome",
    "reward_type": "benefit",
    "benefit": {
      "id": "b_4c81",
      "type": "free_product",
      "description": "Café de regalo",
      "cost": 0,
      "expiration": null,
      "benefit_type": "welcome",
      "color": "#f1a10d",
      "buy_limit": 1,
      "prize": null,
      "tiendanube_coupon": null
    },
    "points": null
  },
  {
    "event": "birthday",
    "reward_type": "points",
    "benefit": null,
    "points": 200
  }
]

Los tres eventos

eventCuándo se entrega
welcomeAl adherirse al programa
birthdayEn el cumpleaños del cliente
monthly_topAl cliente que más compró en el mes

El reward_type dice dónde mirar: si es benefit, el premio está en benefit; si es points, está en points. El otro campo viene en null.

Es una lista de lo que el programa ofrece

Devuelve las recompensas configuradas por el comercio, no las que el usuario ya recibió. Para eso está mi historial, donde las recompensas de puntos aparecen como movimientos de tipo points_special_reward.

Errores

CódigoCuándo
401El token de acceso falta, venció o no corresponde a un usuario final.
404El comercio no existe.
422Falta el header X-Commerce-Id.