Adherirme al programa

Adhiere al usuario al programa de fidelidad del comercio y devuelve la recompensa de bienvenida.

POST/v1/me/subscriptionToken del usuario

Adhiere al usuario al programa de fidelidad del comercio. Si el comercio configuró una recompensa de bienvenida, se devuelve en welcome_benefit o welcome_points.

Verificar el código ya adhiere al usuario

Verificar un código ya deja al usuario adherido, así que este endpoint sirve sobre todo para volver a adherirse después de una baja.

Headers

X-Commerce-Idintegerheaderrequerido

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

No lleva cuerpo.

Respuesta

messagestringrequerido

Resultado de la operación.

welcome_benefitBeneficio | null

Beneficio de bienvenida, si el comercio configuró uno y el usuario recién se adhirió. Ver Beneficio.

welcome_pointsinteger | null

Puntos de bienvenida, si el comercio configuró puntos en vez de un beneficio.

curl -X POST https://loybox-public-api-752998171300.southamerica-west1.run.app/v1/me/subscription \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "X-Commerce-Id: 87"

// 200 OK
{
  "message": "Subscribed successfully",
  "welcome_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
  },
  "welcome_points": null
}

Los dos campos de bienvenida son excluyentes: viene uno o el otro, según lo que el comercio haya configurado. Si no configuró nada, vienen los dos en null.

Es un buen momento para mostrar una pantalla de bienvenida: si vino welcome_benefit, el premio; si vino welcome_points, los puntos que acaba de ganar.

Errores

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

Adherirme al programa

Headers

Respuesta

Errores

En esta página