Scope & versions

What the SDK covers

The SDK gives you access to the ShopiMind API resources:

• E-commerce synchronization — customers, products, orders, vouchers, and their sub-resources (addresses, images, variations, carriers, statuses, categories, manufacturers).
• Reads — get / list / getByReference / listGroups depending on the resource.
• Custom data — definitions and records.
• Contacts — profiles, lists, tags, consent history, rejected messages.
• Events, lists, custom KPIs and carts (read-only).
• Shop connection and data sources.

The full list of methods: Resources & methods.

Consent

The consent history (EMAIL / SMS / WHATSAPP / PUSH) can be read via SpmContacts.listConsentHistory.

Versions (SemVer)

The SDK follows semantic versioning MAJOR.MINOR.PATCH:

Bump	When	Example
PATCH	Fix without API change	retry fix, typo
MINOR	Backward-compatible addition	new method, new option
MAJOR	Breaking change (signature, removal)	field rename, method removal

Pin

For a reproducible installation, pin the version: yarn add @shopimind/sdk-shopimind@1.0.2. The REST API itself is versioned by URL prefix (/v1) — independently of the SDK version.

Compatibility

Item	Support
Node.js	≥ 14
Modules	CommonJS + ESM / TypeScript
Targeted API version	v1 (via SpmClient.getClient('v1', …))