SDKs & libraries

Official and community SDKs for the Shoppex API

Official SDKs

Developer API SDK (JS/TS)

Official JavaScript/TypeScript SDK for /dev/v1/*.

npm install @shoppexio/sdk

Storefront SDK

JavaScript storefront SDK for products, carts, and hosted checkout.

npm install @shoppexio/storefront

Python + PHP

Matching Developer API packages for backend integrations.

pip install shoppexio
composer require shoppexio/shoppex-php

---

Choosing an SDK

What you are building	SDK
Node/Bun backend calling /dev/v1/*	@shoppexio/sdk
Python worker syncing customers	shoppexio
Laravel/PHP backend integration	shoppexio/shoppex-php
Frontend with products, cart, checkout	@shoppexio/storefront
Language without an official SDK	Raw HTTP with the OpenAPI spec

@shoppexio/sdk is the server-side Developer API SDK. It has no CDN or browser global build and must not be bundled into customer-facing frontend code because it uses API keys. Browser storefronts use @shoppexio/storefront or the Storefront SDK CDN instead.

For example, a Node backend creating orders uses @shoppexio/sdk, a Python cron job reading customers uses shoppexio, and a Laravel admin tool rotating webhooks uses shoppexio/shoppex-php.

Quick examples

JavaScript / TypeScript

import { ShoppexClient } from '@shoppexio/sdk';

const client = new ShoppexClient({
  apiKey: process.env.SHOPPEX_API_KEY!,
});

const products = await client.products.list();
console.log(products.data[0]?.title);

await client.invoices.issueReplacement('019c525f-3333-7333-8333-333333333333', {
  quantity: 1,
  product_id: 'prod_1',
  reason: 'previous replacement failed',
  override_remaining_quantity: true,
}, {
  idempotencyKey: 'replacement-019c525f-3333-7333-8333-333333333333-1',
});

Public repositories

• JavaScript Developer API SDK: ShoppexIO/sdk-js
• JavaScript Storefront SDK: ShoppexIO/storefront-js
• Python SDK: ShoppexIO/sdk-python
• PHP SDK: ShoppexIO/sdk-php

---

REST API

The REST API works directly with any HTTP client, no SDK required. Every endpoint in the API introduction includes auto-generated code examples for cURL, Python, JavaScript, PHP, Go, Java, and Ruby.

---

OpenAPI specification

Generate your own client using our OpenAPI spec:

https://docs.shoppex.io/openapi.json

Use tools like:

• openapi-generator — generate clients for 50+ languages
• Postman — import for API testing and exploration

---

Webhooks

For webhook integration, see our Webhooks Guide which covers:

• Setting up webhook endpoints
• Verifying signatures
• Handling events
• Retry logic

Webhook Events Reference

Complete list of webhook events and payloads