Developer Documentation

Complete API reference, webhooks, React components, and integration guides for building with our e-commerce platform. Everything you need to create powerful customer experiences.

13+

API Endpoints

Webhook Events

12+

Components

24/7

Support

REST API

Complete reference for all API endpoints including products, orders, customers, and inventory management.

13+ Endpoints Available

Webhooks

Real-time event notifications for orders, payments, inventory changes, and customer interactions.

2 Event Types

UI Components

Pre-built React components for checkout flows, product displays, and customer interfaces.

12+ Components

Quick Start Guide

Authentication

Get your API key from the admin dashboard and include it in your request headers.

                  curl -H "Authorization: Bearer YOUR_API_KEY" \

                    https://api.shell-platform.com/products

Fetch Products

Retrieve your product catalog with filtering, pagination, and search capabilities.

                  GET /api/products

                  ?category=electronics

                  &limit=20&offset=0

Create Orders

Process orders and payments through our secure checkout API with full transaction support.

                  POST /api/orders

                  {

                    "items": [...],

                    "customer": {...}

                  }

Popular API Endpoints

POST /carts/{cartId}/items Add Cart Item

POST /carts Create Cart

POST /checkout-sessions Create Checkout Session

GET /carts/{cartId} Get Cart

DELETE /carts/{cartId}/items/{itemId} Remove Cart Item

PATCH /carts/{cartId}/billing Update Cart Billing

SDK Examples

JavaScript/React

                    import { ShellSDK } from '@shell/sdk';

                    const client = new ShellSDK(apiKey);

Python

                    from shell_sdk import ShellClient

                    client = ShellClient(api_key)

API Documentation

POST

Add Cart Item

/carts/{cartId}/items

Add an item to the cart Requires both Organization Key and Admin JWT Token for authentication.

POST

Create Cart

/carts

Create a new shopping cart session Requires both Organization Key and Admin JWT Token for authentication.

POST

Create Checkout Session

/checkout-sessions

Creates a new checkout session for a given cart. Supports two modes: cart ID reference (fetches from database) or direct cart payload (includes items inline). Returns a checkout URL with a short-lived session token valid for 5 minutes that redirects users to the shipping step.

GET

Get Cart

/carts/{cartId}

Retrieve cart details by cart ID Requires both Organization Key and Admin JWT Token for authentication.

Webhook Events

[WEBHOOK] Cart Abandonment

cart.abandoned

Webhook triggered when a cart is abandoned for 24+ hours without checkout. Useful for recovery campaigns and analytics.

[WEBHOOK] Order Completion

order.completed

Webhook triggered when an order is successfully completed and payment is confirmed. Handles final order processing and notifications.

Live Documentation Status

Documentation loaded with 13 API endpoints and 2 webhook events. For complete interactive documentation, please visit the full documentation portal.