Lister les magasins et leurs points de caisse
/v1/shops
Renvoie tous les magasins du compte avec leur adresse, leur téléphone, leur taux de TVA par défaut et leurs points de caisse. Toute clé valide peut l'appeler.
C'est ici que se traduisent les identifiants id_shop et id_point_caisse rencontrés ailleurs (lignes de vente, prix d'un produit par magasin, magasin d'origine d'un client). Les magasins archivés sont listés aussi, en fin de liste, pour que d'anciennes ventes restent lisibles : testez archived et actif avant de considérer qu'un magasin est en service.
La liste est courte et renvoyée en une seule fois, sans paramètre. GET /v1/me donne une version réduite de cette liste, limitée aux magasins non archivés.
Exemple d'appel
curl "https://api.wanapos.com/v1/shops" \ -H "Authorization: Bearer VOTRE_CLE"
Réponse en cas de succès (statut 200)
Les magasins du compte.
| Champ | Type | Description |
|---|---|---|
data |
liste | Magasins du compte : d'abord ceux en service, puis les magasins archivés. |
data[].id |
entier |
Identifiant du magasin. C'est la valeur des champs id_shop rencontrés ailleurs dans l'API. |
data[].name |
texte | Nom du magasin. |
data[].tel |
texte | Téléphone du magasin. Chaîne vide si non renseigné. |
data[].tva_taux |
nombre | Taux de TVA par défaut du magasin, en pourcentage (exemple : 20). Un produit sans taux propre prend celui-ci. |
data[].actif |
booléen |
true si le magasin est en service. |
data[].archived |
booléen |
true si le magasin a été archivé par le commerçant. Il reste listé pour que ses anciennes ventes restent lisibles. |
data[].date_creation |
texte | Date de création du magasin. |
data[].adresse |
objet | Adresse du magasin. |
data[].adresse.ligne1 |
texte | Adresse, première ligne. |
data[].adresse.ligne2 |
texte | Complément d'adresse. |
data[].adresse.cp |
texte | Code postal. |
data[].adresse.ville |
texte | Ville. |
data[].adresse.id_pays |
entier |
Identifiant du pays (voir GET /v1/countries). 0 si non renseigné. |
data[].adresse.pays_code |
texte |
Code du pays à deux lettres (exemple : FR). Chaîne vide si non renseigné. |
data[].adresse.pays |
texte | Nom du pays en français. |
data[].points_caisse |
liste | Points de caisse du magasin. Liste vide s'il n'en a aucun. |
data[].points_caisse[].id |
entier |
Identifiant du point de caisse. C'est la valeur des champs id_point_caisse rencontrés ailleurs dans l'API. |
data[].points_caisse[].name |
texte | Nom du point de caisse. |
data[].points_caisse[].actif |
booléen |
true si le point de caisse est en service. |
data[].points_caisse[].date_creation |
texte | Date de création du point de caisse. |
meta |
objet | |
meta.request_id |
texte | Identifiant de l'appel. |
meta.count |
entier | Nombre d'éléments renvoyés. |
{
"data": [
{
"id": 1,
"name": "Magasin principal",
"tel": "0102030405",
"tva_taux": 20,
"actif": true,
"archived": false,
"date_creation": "2025-03-12T10:04:11+01:00",
"adresse": {
"ligne1": "12 rue des Lilas",
"ligne2": "",
"cp": "69002",
"ville": "Lyon",
"id_pays": 63,
"pays_code": "FR",
"pays": "France"
},
"points_caisse": [
{
"id": 1,
"name": "Point de caisse 1",
"actif": true,
"date_creation": "2025-03-12T10:04:11+01:00"
}
]
}
],
"meta": {
"request_id": "3f9a1c0b7d2e4a61",
"count": 1
}
}
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
