Lister les promotions
GET
/v1/promotions
Toute clé valide
Compte comme une lecture
Renvoie les promotions du compte, archivées comprises, par identifiant croissant. Toute clé valide peut l'appeler.
C'est ici que se traduit l'id_promotion d'une ligne de vente. Une promotion est soit une remise en pourcentage (mode = pc), soit un prix fixe (mode = pf). Elle s'applique entre start et end, dans les magasins de id_shops. La liste des produits rattachés à une promotion n'est pas renvoyée.
Le parcours se fait par curseur : tant que meta.has_more vaut true, rappelez l'adresse avec after égal à meta.next_after.
Paramètres
limit |
Facultatif | Nombre d'éléments par page, de 1 à 100. 50 par défaut. |
after |
Facultatif | Curseur de parcours : ne renvoie que les éléments dont l'identifiant est supérieur. Absent ou 0 pour la première page, puis la valeur next_after de la réponse précédente. |
Exemple d'appel
curl "https://api.wanapos.com/v1/promotions" \ -H "Authorization: Bearer VOTRE_CLE"
Réponse en cas de succès (statut 200)
Une page de promotions.
| Champ | Type | Description |
|---|---|---|
data |
liste | Promotions, par identifiant croissant. Liste vide si le compte n'en a aucune. |
data[].id |
entier |
Identifiant de la promotion. C'est la valeur du champ id_promotion d'une ligne de vente. |
data[].name |
texte | Nom de la promotion. |
data[].mode |
texte |
pc : remise en pourcentage (voir remise_pc et arrondi). pf : prix fixe (voir prix). |
data[].start |
texte |
Premier jour de la promotion, au format 2026-11-01. Chaîne vide si non renseigné. |
data[].end |
texte | Dernier jour de la promotion. Chaîne vide si non renseigné. |
data[].remise_pc |
nombre |
Pourcentage de remise, en mode pc. 0 en mode pf. |
data[].arrondi |
texte |
Arrondi appliqué au prix remisé, en mode pc : sans, entier_sup (à l'entier supérieur) ou entier_inf (à l'entier inférieur). sans en mode pf. |
data[].prix |
nombre |
Prix de vente pendant la promotion, en mode pf. 0 en mode pc. |
data[].apply_impact_pv |
booléen |
En mode pf : true si l'écart de prix propre à une variante s'ajoute au prix fixe. |
data[].apply_impact_shop |
booléen |
En mode pf : true si l'écart de prix propre à un magasin s'ajoute au prix fixe. |
data[].id_shops |
liste de entier | Identifiants des magasins rattachés à la promotion. |
data[].archived |
booléen |
true si la promotion a été archivée par le commerçant. |
data[].date_creation |
texte | Date de création de la promotion. |
data[].date_update |
texte | Date de la dernière modification. Chaîne vide si inconnue. |
meta |
objet | |
meta.request_id |
texte | Identifiant de l'appel. |
meta.count |
entier | Nombre d'éléments dans cette page. |
meta.has_more |
booléen |
true s'il reste une page à lire. |
meta.next_after |
entier |
Valeur à passer dans after pour la page suivante. 0 quand le parcours est terminé. |
{
"data": [
{
"id": 14,
"name": "Soldes d'hiver",
"mode": "pc",
"start": "2027-01-06",
"end": "2027-02-02",
"remise_pc": 30,
"arrondi": "entier_inf",
"prix": 0,
"apply_impact_pv": false,
"apply_impact_shop": false,
"id_shops": [
1,
2
],
"archived": false,
"date_creation": "2026-12-18T16:20:05+01:00",
"date_update": "2026-12-19T09:02:40+01:00"
}
],
"meta": {
"request_id": "3f9a1c0b7d2e4a61",
"count": 1,
"has_more": false,
"next_after": 0
}
}
Erreurs possibles
-
401
Clé absente, inconnue ou révoquée. Codes :
missing_key,invalid_key. -
403
Appel refusé pour ce compte ou cette clé. Codes :
api_not_activated,account_not_eligible,access_blocked,missing_scope. -
422
Un paramètre est absent, inconnu ou invalide. Code :
invalid_parameter. Le champfieldnomme le paramètre. -
429
Quota dépassé. Codes :
rate_limited,daily_quota_exceeded,too_many_failed_attempts. L'en-têteRetry-Afterindique combien de secondes attendre.
Une question ? contact@wanapos.com
