Este endpoint calcula cuántos puntos daría una compra, sin entregar ningún punto. Úsalo para mostrar mensajes como "Gana 120 puntos con este pedido" en la página de producto, en el carrito o en el pago.

El cálculo usa los ajustes de tu forma de obtener puntos por compras, las campañas de impulso activas y, si envías un cliente, su nivel VIP.

Endpoint 

GET https://api.jericommerce.com/v1/programs/{program_slug}/balance-preview?amount=4990&currency=EUR

Este endpoint es público, así que no necesita clave de API y puedes llamarlo desde tu tienda.

Parámetros de consulta

Parámetro Obligatorio Notas
amount Sí El importe del pedido en céntimos. Por ejemplo, 4990 para 49,90.
currency Sí La moneda de amount, como un código de tres letras, por ejemplo EUR o USD. Si no es la moneda de tu programa, el importe se convierte primero.
customerEmail No Inclúyelo para aplicar el factor de nivel del cliente. Si ningún cliente tiene este correo, la API responde 404.
sourceName No web (por defecto) o pos. Usa pos para las ventas en tienda, de modo que los impulsos limitados a un canal de venta se apliquen correctamente.
locationId No El ID de la ubicación de Shopify, que se usa con sourceName=pos para impulsos limitados a algunas tiendas.

Respuesta 

{
  "balance": 100,
  "tierBalance": 50
}
Campo Notas
balance Los puntos que obtendría el cliente.
tierBalance Los puntos de nivel que obtendría el cliente para su nivel VIP.
appliedBoost Solo aparece cuando una campaña de impulso se aplica a esta compra.

Cuando se aplica un impulso, appliedBoost explica la diferencia:

{
  "balance": 200,
  "tierBalance": 50,
  "appliedBoost": {
    "id": "3c2b1a0f-...",
    "name": "Double points weekend",
    "pointsMultiplier": 2,
    "tierMultiplier": 1,
    "unboostedBalance": 100,
    "boostedBalance": 200,
    "unboostedTierBalance": 50,
    "boostedTierBalance": 50
  }
}

El resultado es una estimación para el momento actual. Los puntos que el cliente recibe realmente se calculan cuando se hace el pedido, así que pueden variar si tus ajustes o tus impulsos cambian entretanto.

Errores

Código Estado Significado
PROGRAM_NOT_FOUND 404 El slug o el ID del programa de la URL no existe.
CUSTOMER_NOT_FOUND 404 Has enviado un customerEmail que no pertenece a ningún cliente.
Errores de validación 400 Falta amount o no es un número, o sourceName no es web ni pos.