• Log in
  • Contact Us

Get in touch  

Getting started with JavaScript


Install the SDK

Install the SDK from npm

npm install --save @moltin/sdk



Import the library and instantiate a new Moltin client.

You will need a client ID to authenticate with our API. You can find your store keys in your store dashboard.

import { gateway as MoltinGateway } from '@moltin/sdk';

const Moltin = MoltinGateway({
    client_id: 'XXXX'

A simple checkout flow


Get products

Now that we’ve authenticated with the Moltin API lets get one of our sample products. Please note you will need to create a product first via the API or store management dashboard.

This API call should contain an array of products. A good place to display this data is on a product or listing page.

const products = Moltin.Products.All().then((products) => {


Add to cart

Using a product ID we can insert a quantity of this product into the cart with one simple request. The first parameter passed is the product ID, the second the quantity to be added to the cart. A third parameter can be added for modifiers and variations (e.g. size and color) if these are set up.

This response should contain an array of the individual cart item data e.g. title, quantity, price. A good example of integrating this would be to add a simple button or form to the product page that posts the product ID and quantity to this endpoint.

Moltin.Cart().AddProduct(product.id, 1).then((item) => {
	alert(`Added ${item.name} to your cart`);


Get cart contents

Now that there is at least one product in the cart let’s get the full cart contents.

This response should contain an array of all cart items and cart totals. A good place to show this data would be on the cart or orders page, or even a widget in the header of your website.

const cart = Moltin.Cart().Items();


Convert to order

When the customer is ready to checkout we need to convert the cart to an order. This call lets you define the payment gateway and conditional order parameters such as customer, billing and shipping addresses.

This call will return an object containing data for the newly created order.

const address = {
	first_name: 'John'
	last_name: 'Doe',
	line_1: '123 Sunny Street',
	line_2: 'Sunnycreek',
	county: 'California',
	postcode: 'CA94040',
	country: 'US'
const customer = {
	email: 'john@doe.co',
	name: 'John Doe'

Moltin.Cart().Checkout(customer, address);


Process payment

Once we’ve converted a cart into an order we’re now ready to process a payment. In this example, we’ve used the dummy gateway so we just need to provide some card details. The data you need to provide in this step depends on your chosen gateway.

Congratulations, if you made it this far you’ve implemented a simple step by step checkout!

Moltin.Orders.Payment(order.id, {
	gateway: 'stripe',
	method: 'purchase',
	first_name: 'John',
	last_name: 'Doe',
	number: '4242424242424242',
	month: '02',
	year: '2020',
	verification_value: '123'

Ready to get started?

It always starts with a conversation.

Get in touch