Getting started with Ruby


Install the Ruby Gem

Add Moltin to your application’s Gemfile and then execute bundle install.

gem 'moltin'



We will automatically detect ENV['MOLTIN_CLIENT_ID'] and ENV['MOLTIN_CLIENT_SECRET'] variables, or you can pass them through manually. There is no need to call the authenticate method if ENV variables are set. You can find your store keys in your store dashboard.

moltin ={
        client_id: 'YOUR_CLIENT_ID',
        client_secret: 'YOUR_CLIENT_SECRET'

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.

products = moltin.products.all


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.

product = products.first
      cart = moltin.carts.get('unique_reference')
      cart.add({ id:, quantity: 3 })


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.

cart = 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.

customer = {
         "name": "Jon Doe",
         "email": ""
       billing = {
         "first_name": "Jon",
         "last_name": "Doe",
         "company_name": "Moltin",
         "line_1": "123 Sunny Street",
         "line_2": "Sunnycreek",
         "postcode": "CA94040",
         "county": "California",
         "country": "US"
       shipping = {
         "first_name": "Jon",
         "last_name": "Doe",
         "company_name": "Moltin",
         "line_1": "123 Sunny Street",
         "line_2": "Sunnycreek",
         "postcode": "CA94040",
         "county": "California",
         "country": "US",
         "instructions": "Leave in porch"
       order = cart.checkout(customer: customer,
         billing: billing,
         shipping: shipping)


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!

payment ={
        gateway: 'stripe',
        method: 'purchase',
        first_name: 'John',
        last_name: 'Doe',
        number: '4242424242424242',
        month: '08',
        year: '2020',
        verification_value: '123'

Ready to get started?

It always starts with a conversation.