JS Buy SDK

Deprecated

The JS Buy SDK is deprecated as of January, 2025. For existing users of JS Buy SDK, we will be releasing a last and final major version 3.0 to remove the SDK’s dependency on the deprecated Checkout APIs and replace them with Cart APIs. Updating to v3.0 will allow merchants to maintain their current setup for most use cases but we will not be maintaining this library after v3.0. We recommend exploring one of our other solutions or consider if one of our themes for an Online Store is a better fit for your long-term needs.

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.

Anchor to RequirementsRequirements

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.

Anchor to Step 1: Generate an access tokenStep 1: Generate an access token

To generate an access token, you can generate one in the Shopify admin. Alternatively, you can create a custom app and use authorization code grant.

Anchor to Step 2: Make your products and collections availableStep 2: Make your products and collections available

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

Tip

If you have many products or collections, then you can use bulk actions to make them available in one step.

Anchor to Make a product availableMake a product available

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

Anchor to Make a collection availableMake a collection available

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

Anchor to Step 3: Access the JS Buy SDKStep 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

Anchor to Where to get helpWhere to get help

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