Skip to main content

Getting started with the Storefront API

Note

If you're building with Hydrogen, then refer to the Hydrogen documentation for getting started.

The Storefront API is a GraphQL API that requires an access token associated with a specific Shopify store. You can call the API from any HTTP client.

You can have a maximum of 100 active storefronts and access tokens per shop.

The Shopify API is framework agnostic. You can build using your framework of choice, such as Hydrogen, Next.js, Vue, and more. This guide teaches you how to get started building a storefront.

Anchor to What you'll learnWhat you'll learn

In this tutorial, you'll learn how to do the following tasks:

  • Install the Headless channel to your Shopify admin
  • Generate Storefront API access tokens
  • Manage storefront permissions

Anchor to RequirementsRequirements

  • You have the staff role on the Shopify store that you're working with.
  • You have Apps and channels permissions on the Shopify store that you're working with.

Anchor to Step 1: Enable Storefront API accessStep 1: Enable Storefront API access

Install the Headless channel from the Shopify App Store. On installation, click Create storefront to generate public and private access tokens that enable public and private, authenticated access to the Storefront API.

Make note of the private access token, as you'll use this token to authenticate requests to the Storefront API.

Anchor to (Optional) Create another storefront(Optional) Create another storefront

Note

The following instructions assume that you've pinned the Headless channel in your Shopify admin. If you haven't, then you can access the channel using the Search field.

  1. From your Shopify admin, under Sales channels, click Headless.

  2. Click Add storefront.

Anchor to Step 2: Manage permissionsStep 2: Manage permissions

Managing permissions controls what your custom storefront can display from your Shopify store.

  1. From your Shopify admin, select the Headless sales channel.

  2. From the list, select the storefront.

  3. Beside Storefront API permissions, click Edit.

  4. Select the permissions for the storefront.

  5. Click Save.

Anchor to Step 3: Set up request headersStep 3: Set up request headers

Before you make requests to the Storefront API, you need to set up your request headers with the private access token that you received when creating your storefront. To learn more about how to set up request headers for your development framework, refer to the Storefront API reference.

Anchor to Step 4: Make queriesStep 4: Make queries

After you've selected the Storefront API permissions for your custom storefront and have Storefront API access tokens, you can make queries using the Storefront API.

Shopify provides the following resources for learning how to make GraphQL queries to Shopify's Storefront API:

Anchor to Next stepsNext steps

Was this page helpful?