Skip to main content

​
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

​
Which SDK should you use?

What you’re buildingSDK
Node/Bun backend calling /dev/v1/*@shoppexio/sdk
Python worker syncing customersshoppexio
Laravel/PHP backend integrationshoppexio/shoppex-php
Frontend with products, cart, checkout@shoppexio/storefront
Language without an official SDKRaw HTTP with the OpenAPI spec

​
Quick Examples

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);

​
Public Repositories

​
REST API

No SDK required - use the REST API directly with any HTTP client. Every endpoint in the API Reference 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:

​
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