Gérer les marchands
Créer des marchands, configurer leur profil, leur logo et leurs options.
Gérer les marchands
Cette page décrit la création et la configuration des marchands dans Swaloo. La gestion des marchands suppose que le module Marchand soit actif sur votre forfait (FEATURE_MERCHANT).
Créer un marchand
La création d'un marchand est réservée aux administrateurs d'organisation (ROLE_ORG_ADMIN). Créer un marchand crée à la fois son profil de boutique et le compte utilisateur associé qui lui servira à se connecter.
Le profil d'un marchand
Un marchand expose les champs suivants :
| Champ | Code | Détail |
|---|---|---|
| Compte utilisateur | user | Le compte de connexion du marchand |
| Organisation | organization | L'organisation à laquelle le marchand est rattaché |
| Nom de la boutique | storeName | Obligatoire (255 caractères max) |
| Téléphone de la boutique | storePhone | Optionnel |
| URL de webhook | webhookUrl | Optionnel — endpoint de notification du marchand |
| Webhook activé | isWebhookEnabled | Défaut : false |
| Point de collecte par défaut | defaultPickupPoint | Optionnel — point de collecte utilisé par défaut |
| Actif | isActive | Défaut : true |
| Approbation requise | requiresApproval | Défaut : false |
| Logo | logoFilename | Image téléversée (voir ci-dessous) |
Le nom de la boutique est le seul champ obligatoire. Il apparaît notamment sur les expéditions et les tâches associées au marchand.
Modifier un marchand
La modification d'un marchand est possible :
- pour un administrateur d'organisation (
ROLE_ORG_ADMIN), sur n'importe quel marchand de son organisation ; - pour un marchand (
ROLE_MERCHANT), uniquement sur son propre profil.
Dans tous les cas, la permission FEATURE_MERCHANT est requise.
Le logo
Chaque marchand peut téléverser un logo de boutique. Une fois enregistré, le logo est exposé via une URL publique dédiée, calculée à partir de l'identifiant du marchand.
Le profil et les statistiques du marchand connecté
Un marchand connecté accède à deux ressources le concernant :
| Ressource | Endpoint | Contenu |
|---|---|---|
| Son profil | /me/merchant | Le profil de boutique du marchand connecté |
| Ses statistiques | /me/merchant/stats | Compteurs de ses expéditions et de ses montants |
Le tableau de bord de statistiques du marchand agrège, pour ses propres expéditions uniquement :
| Statistique | Champ |
|---|---|
| Total d'expéditions | totalShipments |
| En attente | pendingShipments |
| En transit | inTransitShipments |
| Livrées | deliveredShipments |
| Retournées | returnedShipments |
| Montant encaissé (COD) | totalCodCollected |
| Montant en attente (COD) | pendingCodAmount |
Ces deux ressources ne renvoient que les données du marchand connecté ; un marchand ne peut pas consulter le profil ou les statistiques d'un autre marchand. Voir Isolation multi-tenant.
Voir aussi : Vue d'ensemble du module Marchand | Isolation multi-tenant