Need private packages and team management tools?Check out npm Teams »


3.23.0 • Public • Published

Moltin JavaScript SDK

npm version

A simple to use API interface to help get you off the ground quickly and efficiently with your Moltin JavaScript apps.

📚 API reference — 📚

🛠 Installation

Install the package from npm and import in your project.

npm install --save @moltin/sdk

⛽️ Usage

To get started, instantiate a new Moltin client with your store credentials.

Note: This requires a Moltin account.

// JavaScript
import { gateway as MoltinGateway } from '@moltin/sdk'
const Moltin = MoltinGateway({
  client_id: 'XXX'
// Node.js
const MoltinGateway = require('@moltin/sdk').gateway
const Moltin = MoltinGateway({
  client_id: 'XXX',
  client_secret: 'XXX'

Alternatively you can include the UMD bundle via UNPKG like so:

<script src=""></script>
  const Moltin = moltin.gateway({
    client_id: 'XXX'

Note: If you're using webpack, you'll need to add the following to your projects configuration file.

node: {
  fs: 'empty'

You can now authenticate with the Moltin service 🎉

Moltin.Authenticate().then(response => {
  console.log('authenticated', response)

Check out the API reference to learn more about authenticating and the available endpoints.

Custom Host

If you're an enterprise customer with your own infrastructure, you'll need to specify your API URL when instantiating:

const Moltin = MoltinGateway({
  client_id: 'XXX',
  host: ''

Custom Storage

By default the Moltin SDK persists data to window.localStorage in the browser and node-localstorage in Node. If this doesn't suit your needs you can override the default storage with a MemoryStorageFactory which will persist data for the life cycle of the JavaScript VM:

import { gateway as MoltinGateway, MemoryStorageFactory } from '@moltin/sdk'
const Moltin = MoltinGateway({
  client_id: 'XXX',
  storage: new MemoryStorageFactory()

Or alternatively, create your own storage factory by passing in an object which implements the following interface:

interface StorageFactory {
  set(key: string, value: string): void;
  get(key: string): string | null;
  delete(key: string): void;

❤️ Contributing

We love community contributions. Here's a quick guide if you want to submit a pull request:

  1. Fork the repository
  2. Add a test for your change (it should fail)
  3. Make the tests pass
  4. Commit your changes (see note below)
  5. Submit your PR with a brief description explaining your changes

Note: Commits should adhere to the Angular commit conventions.

Make sure you have Prettier installed for your editor with ESLint integration enabled.

⚡️ Development

The SDK is built with ES6 modules that are bundled using Rollup.

If you want to roll your own bundle, or make changes to any of the modules in src, then you'll need to install the package dependencies and run rollup while watching for changes.

npm install
npm start

You can learn more about the Rollup API and configuration here.




npm i @moltin/sdk

DownloadsWeekly Downloads






Unpacked Size

303 kB

Total Files


Last publish


  • avatar