API y webhooks / Referencia / Leer el comercio
Leer el comercio
GET /v1/commerce devuelve la ficha del comercio vinculado a la clave y las reglas de su tarjeta de fidelidad.
GET
/v1/commerceDevuelve el comercio al que pertenece la clave: su nombre, su moneda, su zona horaria y las reglas de su tarjeta (modo, objetivo, recompensas, regla por importe). Útil para comprobar una clave o para mostrar la regla de la tarjeta en tu TPV.
Ejemplo
curl https://app.stampywallet.com/v1/commerce \
-H "Authorization: Bearer sw_live_votre_cle"const r = await fetch('https://app.stampywallet.com/v1/commerce', {
headers: { Authorization: `Bearer ${process.env.STAMPY_CLE}` },
});
const commerce = await r.json();Respuesta
{
"id": "5f0c8e2a-3b1d-4c9e-9a51-2d7f3e8b6a10",
"nom": "Boulangerie Lemaire",
"mode": "tampons",
"tampons_requis": 10,
"recompense": "Una baguette tradicional gratis",
"recompenses": [ { "seuil": 10, "libelle": "Una baguette tradicional gratis" } ],
"devise": "EUR",
"montant_par_tampon": 10,
"points_par_unite": null,
"tampons_bienvenue": 1,
"conditions_exigees": false,
"premium": null,
"fuseau": "Europe/Paris",
"langue": "fr"
}| Campo | Significado |
|---|---|
mode | tampons, paliers o points (los tipos de tarjeta) |
recompenses | Cada recompensa con su seuil |
montant_par_tampon | La regla «10 € = 1 sello», o null |
points_par_unite | En modo puntos: cuántos puntos por 1 unidad de moneda |
conditions_exigees | true si el comercio exige aceptar sus condiciones: en ese caso, pasa conditions_acceptees: true al crear un cliente |
premium | El segundo contador, cuando el comercio lo ha abierto; si no, null |
Actualizado el
¿Te ha sido útil esta página?Gracias por tu opinión.