Skip to main content

Official SDKs

Developer API SDK (JS/TS)

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

Storefront SDK

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

Python + PHP

Matching Developer API packages for backend integrations.

Choosing an SDK

@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

Public repositories

These repositories are read-only mirrors of the published packages, synced on each release. Install from npm, PyPI or Packagist, and report bugs in the repository’s issues.

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:
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