JS Buy SDK

The JavaScript (JS) Buy SDK is a lightweight library that lets you add commerce to any website. It's based on Shopify's Storefront API and provides the ability to retrieve products and collections from your store, add products to a cart, and check out.

Requirements

  • You've created a development store or have a production store.
  • You've created products or collections in your store.
  • You have experience writing JavaScript. The JS Buy SDK tool is intended for use by developers who are experienced with JavaScript.
  • You have a website and want to add commerce functionality to it.

1. Generate an access token

To generate an access token, you create a private app.

When you create the private app, make sure to enable Allow this app to access your storefront data using the Storefront API, and select which types of data you want to expose to the app.

The access token is generated when you save the private app. You include the access token with any requests made from your app to Shopify.

2. Make your products and collections available

After you've generated an access token, you need to make products and collections available to your private app to access them from your app. After the products and collections are available, you can retrieve them using their respective IDs.

Make a product available

  1. From your Shopify admin, go to Products.
  2. From the Products page, click the product you want to make available.
  3. Next to SALES CHANNELS AND APPS click Manage.
  4. In the Sales channels and apps dialog box, select the box next to the name of your private app.

Make a collection available

  1. From your Shopify admin, go to Products and click Collections.
  2. From the Collections page, click the collection you want to make available.
  3. Next to SALES CHANNELS AND APPS click Manage.
  4. In the Sales channels and apps dialog box, select the box next to the name of your private app.

3. Access the JS Buy SDK

The JS Buy SDK can render data on the client side or server. Using the JS Buy SDK, you can do the following:

  • Fetch information about a single product or a collection of products
  • Create a shopping cart
  • Allow customers to select options and quantities
  • Generate a checkout URL for a single product or an entire cart

View the JS Buy SDK on GitHub.

Where to get help

This SDK isn't supported by Shopify support, but there are other places where you can get help.

Open a GitHub issue

You can open an issue in the GitHub repository.

Shopify Community forums

Visit our forums to connect with the community and learn more about the Shopify API and app development.

Shopify Experts

Find a Shopify Expert for hire in our ecosystem of talented development agencies.