Official SDKs

Integrate the ShopiMind API without rewriting the HTTP layer. The official SDKs handle authentication, automatic retries, large-batch chunking, pagination and a uniform response format for you — you write business logic, not network plumbing.

Building an integration?

If your goal is to connect a platform (CRM, ERP, POS, e-commerce…) to ShopiMind, don't use the SDK on its own: rely on the JavaScript integration kit@shopimind/integration-kit-js, which depends on and re-exports the SDK for you and handles the lifecycle, signed webhooks and data synchronization. → Integrations section

JavaScript / TypeScript SDK

Available — npm package @shopimind/sdk-js.

npm install @shopimind/sdk-js
# yarn add @shopimind/sdk-js
# pnpm add @shopimind/sdk-js

import { SpmClient, SpmCustomers } from '@shopimind/sdk-js';

// Client for the v1 API, authenticated with the shop API key (spm-api-key header)
const client = SpmClient.getClient('v1', process.env.SHOPIMIND_API_KEY!);

// Read — paginated list
const res = await SpmCustomers.list(client, { limit: 50 });
if (!res.ok) {
  throw new Error(res.error.message); // the SDK never throws: check res.ok instead
}
console.log(res.data.data); // ⚠️ business payload is double-nested: res.data.data

// Batch write with automatic chunking
const saved = await SpmCustomers.bulkSave(client, customers, { chunk: true });

• Node.js 18+ · ESM only (import) — no CommonJS build
• .d.ts types included · single runtime dependency: axios
• Authentication via the shop API key in the spm-api-key header
• Uniform return format { ok, statusCode, data, error } — the SDK never throws on an HTTP error; the business payload is at res.data.data

→ JavaScript SDK documentation

PHP SDK

Coming soon

The official PHP SDK is coming soon. In the meantime, call the API directly — every page of the API Reference provides a ready-to-use cURL and PHP example.

Go SDK

Coming soon

The official Go SDK is coming soon. In the meantime, call the API directly from the API Reference.

Which integration channel should you choose?

You are…	Recommendation
A Node.js / TypeScript app	JavaScript SDK @shopimind/sdk-js — the fastest and most robust
A platform to connect to ShopiMind (CRM, ERP, POS…)	The JavaScript integration kit @shopimind/integration-kit-js (it re-exports the SDK)
A standalone e-commerce platform (PrestaShop, WooCommerce, Odoo…)	An official or custom connector (built with the same kit)
Another language / low-level need	The REST API directly (cURL / PHP / HTTP), base https://core.shopimind.com/v1