Périmètre & versions

Ce que couvre le SDK

Le SDK donne accès aux ressources de l'API ShopiMind :

• Synchronisation e-commerce — clients, produits, commandes, bons de réduction, et leurs sous-ressources (adresses, images, déclinaisons, transporteurs, statuts, catégories, fabricants).
• Lecture — get / list / getByReference / listGroups selon la ressource.
• Données personnalisées — définitions et enregistrements (custom data).
• Contacts — fiches, listes, tags, historique de consentement, messages rejetés.
• Événements, listes, KPIs personnalisés et paniers (lecture seule).
• Connexion de boutique et sources de données.

La liste exhaustive des méthodes : Ressources & méthodes.

Consentement

L'historique de consentement (EMAIL / SMS / WHATSAPP / PUSH) est lisible via SpmContacts.listConsentHistory.

Versions (SemVer)

Le SDK suit le versionnage sémantique MAJOR.MINOR.PATCH :

Bump	Quand	Exemple
PATCH	Correctif sans changement d'API	fix retry, typo
MINOR	Ajout rétro-compatible	nouvelle méthode, nouvelle option
MAJOR	Rupture (signature, retrait)	renommage de champ, retrait de méthode

Épingler

Pour une installation reproductible, épinglez la version : yarn add @shopimind/sdk-shopimind@1.0.2. L'API REST, elle, est versionnée par préfixe d'URL (/v1) — indépendamment de la version du SDK.

Compatibilité

Élément	Support
Node.js	≥ 14
Modules	CommonJS + ESM / TypeScript
Version d'API ciblée	v1 (via SpmClient.getClient('v1', …))