Beneficios
El catálogo de premios del comercio, la consulta de un código de canje y el canje en sí.
Esta sección tiene las dos mitades de la vida de un premio: el catálogo que armó el comercio, y el canje de un código que un cliente trae para usar.
Beneficio y beneficio canjeable no son lo mismo
El comercio crea beneficios, y cada uno tiene un benefit_id. Cuando un
cliente compra uno con sus puntos recibe un beneficio canjeable con su propio
client_benefit_code.
El benefit_id sirve sólo para consultar información. El
client_benefit_code sirve para consultar y para canjear.
El flujo del canje
Así se ve del lado de tu sistema cuando un cliente llega con un código:
El cliente da su código
Lo tiene en su app de Loybox. Es el client_benefit_code.
Consultás qué es
GET /v1/benefits/preview/{client_benefit_code}
te dice qué premio es y, si corresponde, qué descuento aplicar. Todavía no
canjea nada.
Aplicás el descuento
En tu caja, tu e-commerce o donde corra la venta, con los datos del paso anterior.
Lo marcás como usado
POST /v1/benefits/redeem. A partir de acá
el código queda quemado y no se puede volver a usar.
Canjeá recién cuando la venta se concretó
Consultar es inofensivo y se puede repetir; canjear es definitivo. Si canjeás antes de cerrar la venta y la venta se cae, el cliente perdió el premio.
Los endpoints
Listar beneficios
Todo el catálogo que creó el comercio.
Obtener un beneficio
Un beneficio del catálogo por su benefit_id.
Consultar un código
Qué premio es un client_benefit_code, antes de canjearlo.
Consultar un código (v2)
Lo mismo, con el título y el valor del descuento al nivel de arriba.
Canjear un beneficio
Marca el código como usado. Es definitivo.
Credencial
Toda la sección va desde tu servidor, con la API key del comercio:
Authorization: Bearer {api-key}