Home

Guides

Apps

Storefronts

Backend API

Frontend API

Introduction to Swell Apps: Learn how to get started building the future of commerce with Swell.

Overview

Learn how to get started building the future of commerce with Swell.

Getting started

Learn about how to build apps with Swell.

App development

Learn about how to distribute apps with Swell.

App distribution

Learn best practices for building Swell Apps.

Best practices

Learn how to build an admin workflow app using the Swell Apps platform.

Build an admin app

Learn how to build a payment gateway app using a Swell payment extension.

Build a payment gateway

Learn how to build a shipping service app using a Swell shipping extension.

Build a shipping service

Learn how to build a tax calculation app using a Swell tax extension.

Build a tax integration

Learn how to embed your own frontend interfaces to build storefronts and admin workflows with Swell Apps.

Frontend

Learn how to create unique themes for Proxima and other storefront apps on the Swell platform.

Themes

Learn how to customize models and configure your own data schema with Swell Apps.

Models

Learn how to enhance the Swell dashboard using powerful content management capabilities with Swell Apps.

Content

Learn how to define custom logic using app functions with Swell Apps.

Functions

Learn how to define custom events to trigger app functions and webhooks with Swell Apps.

Events

Learn how to create automated email notifications based on model events with Swell Apps.

Notifications

Learn how to configure webhooks to send events to external applications with Swell Apps.

Webhooks

Learn how to define settings for merchants to configure your app on the Swell platform.

Settings

Learn how to use static assets for App Store listings and app notifications.

Assets

Learn how extensions are used to integrate more deeply with Swell platform, including payment, shipping, and tax applications.

Extensions

Learn all the options available to configure swell.json in your Swell Apps.

swell.json

Learn how to use the Swell CLI to build apps and more in this complete reference.

Swell CLI

Learn how to use the Apps SDK to simplify building frontend interfaces for Swell Apps.

Apps SDK

Basics

Tutorials

Build, test, and distribute apps for your clients or share them with the community.

Introduction

Authentication information for Swell's Backend API.

Authentication

Backend libraries

Information regarding errors in Swell's Backend API.

Errors

Overview of querying on the Swell Backend API.

Querying records

Updating records

Aggregating within queries on the Swell Backend API.

Aggregation

Localizing content in the Swell Backend API.

Localization

Formula

Information on handling products within the Swell Backend API. 

Products

Information on handling variants within the Swell Backend API. 

Variants

Information on handling product stock within the Swell Backend API. 

Stock

Information on handling categories within the Swell Backend API. 

Attributes

Purchase links

Information on handling carts within the Swell Backend API.

Carts

Information on handling orders within the Swell Backend API.

Orders

Information on handling payments within the Swell Backend API.

Payments

Information on handling refunds within the Swell Backend API.

Refunds

Information on handling shipments within the Swell Backend API.

Shipments

Information on handling returns within the Swell Backend API.

Returns

Information on handling subscriptions within the Swell Backend API.

Subscriptions

Information on handling subscription plans within the Swell Backend API.

Subscription plans

Information on handling accounts within the Swell Backend API.

Accounts

Information on handling account addresses within the Swell Backend API.

Account addresses

Information on handling account cards within the Swell Backend API.

Account cards

Account credits

Information on handling invoices within the Swell Backend API.

Invoices

Information on handling coupons within the Swell Backend API. 

Coupons

Information on handling coupon codes within the Swell Backend API. 

Coupon codes

Information on handling coupon generations within the Swell Backend API. 

Coupon generations

Information on handling coupon uses within the Swell Backend API. 

Coupon uses

Information on handling promotions within the Swell Backend API. 

Promotions

Information on handling promotion uses within the Swell Backend API. 

Promotion uses

Gift cards

Information on handling gift card debits within the Swell Backend API. 

Gift card debits

Managing gift card products with the Swell Backend API.

Gift card products

Information on handling content pages within the Swell Backend API. 

Pages

Using webhooks within the Swell Backend API. 

Files

Swell offers both client-side and server-side APIs. This documentation covers topics related to the client-side Frontend API. Use Swell.js and GraphQL for client-side and headless ecommerce.

Frontend libraries

Setup reference for the Swell Frontend API.

Setup

Basic usage

Storefront theme

Session management

Account recovery

Address management

Credit card management

Account orders

Method reference for managing your store's payments with Swell.js.

Currencies

Navigation menus

Payment settings

Create a store, get your API keys, and make your first Swell API calls.

Quickstart guide

Move your store from the test environment to accepting real orders.

Going live

Dive into key aspects of Swell for a deeper understanding of the platform's structure and base models. 

Core concepts

Dive into one of Swell's most powerful features—its flexible backend models. Each model can be fully customized and you can also create your own models depending on the logic you wish to implement within your store.

Model customization

Learn how to create and update custom fields within Swell models, including how to update permissions for those fields to be editable through the Frontend API—as well as how to fetch and create records for these custom models using the Backend API. Overall, there are endless customization possibilities with Swell's content fields feature.

Custom fields and models

Learn how to open content models and content field permissions for use within the frontend.

Opening content permissions

Learn how to configure custom email notifications in Swell.

Email notifications

Use Test environments to separate development data from your live Swell store.

Test environments

Filter, expand, include, aggregate, and search records with the Swell Backend API.

Advanced queries

Swell's file CDN supports basic size transformations for image files by appending query parameters to the file URL. To request a specific sized image from the CDN, take the url field from the file object and add parameters for width, height, or both with the size in pixels as the value. See the reference and examples below for more details on how each parameter works.

Image transformation

In this guide, we’ll use Swell-js to render Stripe Elements with React. Our objective is to lay the groundwork for a checkout that you can build upon to include additional custom logic you may wish to implement within your checkout flow.

Render Stripe elements

Learn how to integrate custom payment gateways and methods on Swell.

Integrate custom payment gateways and methods

Migrating ecommerce platforms is a big decision. Thanks to Swell's full-access Backend API, this can be done incrementally and at your own pace. 

Migrate to Swell

Dive into a code-based approach to migrating your Shopify store to Swell, and learn about considerations for your particular migration needs.

Migrate from Shopify

A code-based approach for migrating your WooCommerce store data to Swell.

Migrate from WooCommerce

A code-based approach for migrating your BigCommerce store data to Swell.

Migrate from BigCommerce

Origin is a full-fledged and functional ecommerce web app for Swell that utilizes modern JavaScript and front-end tooling. It's intended as a reference example and starter project for building custom storefronts powered by Swell. Take what you need and make it your own—without having to start from scratch.

Origin

Horizon is a Swell storefront theme designed entirely around subscription-based commerce using React and Next.js. 

Horizon

A quick glimpse of supported frameworks that can be used for building a Swell storefront.

Frameworks

Explore this collection of third-party apps that can be implemented within Swell as a storefront solution. 

Storefront apps

Explore your hosting options for Swell storefront themes. Even with built-in hosting for Swell themes, we provide the ability to utilize the themes with a variety of top-tier hosting platforms such as Netlify and Vercel.

Storefront hosting

Swell supports the use of custom domains for your storefront—with the ability to auto-generate SSL certificates for your custom domains.

Custom domains and SSL

Use Cloudflare as a third-party alternative to Swell's built-in custom domain and SSL support.

Custom domains and SSL with Cloudflare

Take a glance at token login, a custom feature that bypasses the standard Swell user login.

Token login

Storefronts V1

Introduction to Swell Storefronts: Learn how to get started building the future of commerce with Swell.

Learn about how to build Storefront apps on Swell.

Learn how to build Headless storefronts with Swell.

Headless storefronts

Learn how to set up custom domains for your storefront on Swell.

Custom domains

V1 hosting migration

Learn about Proxima – Swell's official Storefront App with Shopify theme compatibility.

Proxima

Learn about Sunrise – Swell's first official theme for Proxima Storefront.

Sorry, there was an error rendering this page.