Skip to content

Swell NodeJS library for building storefronts and checkouts with Swell ecommerce.

License

Notifications You must be signed in to change notification settings

swellstores/swell-node

Repository files navigation

Swell API library for NodeJS

Swell is a customizable, API-first platform for powering modern B2C/B2B shopping experiences and marketplaces. Build and connect anything using your favorite technologies, and provide admins with an easy to use dashboard.

Install

npm install swell-node --save

Connect

const { swell } = require('swell-node');

swell.init('my-store', 'secret-key');

To connect to multiple stores in the same process, use swell.createClient():

const { swell } = require('swell-node');

const client1 = swell.createClient('my-store-1', 'secret-key-1');
const client2 = swell.createClient('my-store-2', 'secret-key-2');

Usage

try {
  const { data } = await swell.get('/products', {
    active: true
  });
  console.log(data);
} catch (err) {
  console.error(err.message);
}

Documentation

This library is intended for use with the Swell Backend API: https://developers.swell.is/backend-api

Contributing

Pull requests are welcome

License

MIT