Introduction
L’API EzyConnect est une interface REST qui permet d’intégrer votre système d’information (ERP, CMS, e-commerce) avec une plateforme logistique (WMS). Elle gère l’ensemble du cycle logistique : des référentiels produits jusqu’aux comptes-rendus d’expédition.
Concepts clés
Section intitulée « Concepts clés »Activité (activityCode)
Section intitulée « Activité (activityCode) »Chaque donnée dans EzyConnect est rattachée à une activité (code sur 3 caractères). Votre token d’authentification contient la liste des activités auxquelles vous avez accès (client_context). Vous ne pouvez lire ou écrire que les données de vos activités autorisées.
Référentiels (Master Data)
Section intitulée « Référentiels (Master Data) »Avant de pouvoir créer des commandes ou des approvisionnements, vous devez alimenter les référentiels :
| Référentiel | Endpoint | Description |
|---|---|---|
| Articles | POST /articles | Catalogue produit avec codes-barres, variantes logistiques, dimensions |
| Clients | POST /customers | Destinataires / clients finaux |
| Fournisseurs | POST /suppliers | Fournisseurs pour les approvisionnements |
Flux opérationnels
Section intitulée « Flux opérationnels »| Flux | Endpoint d’envoi | Endpoint de consultation |
|---|---|---|
| Commandes | POST /orders | GET /orders/reports |
| Approvisionnements | POST /procurements | GET /procurements/reports |
| Flux | Endpoint | Description |
|---|---|---|
| Snapshot stock | GET /articles/stock | Photo du stock à une date donnée |
| Mouvements | GET /articles/movements | Historique des entrées/sorties |
Flux de données typique
Section intitulée « Flux de données typique »-
Alimenter les référentiels : Poussez vos articles, clients et fournisseurs via
POST. -
Envoyer les commandes : Créez des commandes de préparation via
POST /orders. -
Récupérer les comptes-rendus : Pollez
GET /orders/reportsavecafterIdouafterDatepour obtenir les résultats de préparation (colis, tracking, quantités expédiées). -
Suivre le stock : Consultez
GET /articles/stockpour un snapshot etGET /articles/movementspour le détail des mouvements.
Format des échanges
Section intitulée « Format des échanges »- Content-Type :
application/json - Encodage : UTF-8
- Dates : Format ISO 8601 (
2024-01-15T10:30:00Z) - Nommage : camelCase pour tous les champs JSON
Réponses de l’API
Section intitulée « Réponses de l’API »Endpoints GET
Section intitulée « Endpoints GET »Retournent directement un tableau JSON d’objets.
Endpoints POST
Section intitulée « Endpoints POST »Retournent un objet OperationResult :
{ "status": 0, "operationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "errors": {}, "passed": ["ORDER_001", "ORDER_002"]}Les statuts possibles :
| Status | HTTP Code | Signification |
|---|---|---|
Ok | 200 | Toutes les ressources ont été traitées avec succès |
Mixed | 206 | Certaines ressources ont réussi, d’autres ont échoué |
Error | 400 | Toutes les ressources ont échoué la validation |
En cas d’erreur :
{ "status": "Error", "operationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "passed": [], "errors": { "ORDER_001": [ { "code": "211", "description": "Ressource rejetée car le code article [ART999] est inconnu dans nos systèmes" } ] }}