API et webhooks / Référence / Lire le commerce
Lire le commerce
GET /v1/commerce rend la fiche du commerce lié à la clé et les règles de sa carte de fidélité.
GET
/v1/commerceRend le commerce auquel appartient la clé : son nom, sa devise, son fuseau et les règles de sa carte (mode, objectif, récompenses, règle au montant). Pratique pour vérifier une clé, ou pour afficher la règle de la carte dans votre caisse.
Exemple
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();Réponse
{
"id": "5f0c8e2a-3b1d-4c9e-9a51-2d7f3e8b6a10",
"nom": "Boulangerie Lemaire",
"mode": "tampons",
"tampons_requis": 10,
"recompense": "Une baguette tradition offerte",
"recompenses": [ { "seuil": 10, "libelle": "Une baguette tradition offerte" } ],
"devise": "EUR",
"montant_par_tampon": 10,
"points_par_unite": null,
"tampons_bienvenue": 1,
"conditions_exigees": false,
"premium": null,
"fuseau": "Europe/Paris",
"langue": "fr"
}| Champ | Sens |
|---|---|
mode | tampons, paliers ou points (les types de carte) |
recompenses | Chaque récompense avec son seuil |
montant_par_tampon | La règle « 10 € = 1 tampon », ou null |
points_par_unite | En mode points : combien de points pour 1 unité de monnaie |
conditions_exigees | true si le commerce exige l'acceptation de ses conditions : passez alors conditions_acceptees: true en créant un client |
premium | Le second compteur, quand le commerce l'a ouvert, sinon null |
Mis à jour le
Cette page vous a aidé ?Merci pour votre retour.