Swell offers both client-side and server-side APIs. This documentation covers topics related to the server-side Backend API. 

Setup

Introduction

Authentication

Swell-node

Swell-php

Swell-py

Backend libraries

Validation errors

Handling errors

Errors

Query parameters

Filtering

Sorting

Limiting

Pagination

Searching

Expanding

Including

Querying

Updating fields

Aggregation

Set locale values

Retrieve localized content

Retrieve locale values

Localization

Formula

Pages

The product model

Create a product

Retrieve a product

Update a product

List all products

Delete a product

Products

The variant model

Create a variant

Retrieve a variant

Update a variant

List all variants

Delete a variant

Variants

The stock model

Create stock adjustments

Retrieve stock adjustment

List all stock adjustments

Stock

The category model

Create a category

Retrieve a category

Update a category

List all categories

Delete a category

The attribute model

Create an attribute

Retrieve an attribute

Update an attribute

List all attributes

Delete an attribute

Attributes

The purchase links model

Create a purchase link

Retrieve a purchase link

Update a purchase link

List all purchase links

Delete a purchase link

Purchase links

The cart model

Create a cart

Retrieve a cart

Update a cart

Convert carts to orders

List all carts

Delete a cart

Carts

The order model

Create an order

Retrieve an order

Update an order

List all orders

Delete an order

Orders

The payment model

Create a payment

Retrieve a payment

Refund a payment

List all payments

Payments

The refund model

Issue a refund

Retrieve a refund

List all refunds

Refunds

The shipment model

Create a shipment

Update a shipment

Retrieve a shipment

List all shipments

Shipments

The return model

Create a return

Retrieve a return

Update a return

List all returns

Returns

The subscription product model

Create a subscription product

Retrieve a subscription product

Update a subscription product

List all subscription products

Delete a subscription productf

Subscriptions

Subscription model

Create a subscription plan

Retrieve a subscription plan

Update a subscription

List all subscriptions

Delete a subscription

Subscription plans

The account model

Create an account

Retrieve an account

Update an account

List all accounts

Delete an account

Accounts

The account address model

Create an account address

Retrieve an account address

Update an account address

List all account addresses

Delete an account address

Account addresses

The account cards model

Create an account card

Retrieve an account card

Update an account card

List all account cards

Delete an account card

Account cards

The account credit model

Create an account credit

Retrieve an account credit

Update an account credit

List all account credits

Delete an account credit

Account credits

The invoice model

Retrieve an invoice

List all invoices

Invoices

The coupon model

Create a coupon

Retrieve a coupon

Update a coupon

List all coupons

Delete a coupon

Coupons

The coupon code model

Create a coupon code

Retrieve a coupon code

Update a coupon code

List all coupon codes

Delete a coupon code

Coupon codes

The coupon generation model

Create a coupon generation

Retrieve a coupon generation

Update a coupon generation

List all coupon generations

Delete a coupon generation

Coupon generations

The coupon use model

Create a coupon use

Retrieve a coupon use

List all coupon uses

Delete a coupon use

Coupon uses

The promotion model

Create a promotion

Retrieve a promotion

Update a promotion

List all promotions

Delete a promotion

Promotions

The promotion use model

Create a promotion use

Retrieve a promotion use

List all promotion uses

Delete a promotion use

Promotion uses

The gift card model

Create a gift card

Retrieve a gift card

Update a gift card

List all gift cards

Delete a gift card

Gift cards

The gift card debit model

Create a gift card debit

Gift card debits

Backend API

Filter

Results

Setup