Making your first request

You can use Shopify's APIs to create powerful solutions for a variety of purposes, including integrating your service with Shopify, adding new capabilities to the Shopify admin, and embedding Shopify-powered features in any website.

This guide describes the basic steps for getting started with Shopify's API

Create a Shopify Partner account

The Shopify Partner program includes developers, designers, and experts who build on the Shopify platform. You can sign up for a free Shopify Partner account by registering here.

As a Shopify Partner, you have access to the Partner Dashboard. From your Partner Dashboard, you can create development stores, manage the apps that you build, submit themes that you've developed, and track revenue that you've earned from Shopify.

To learn more about the Partner Dashboard, see Using the Partner Dashboard.

Create a development store

After creating a Shopify Partner account, you can create a development store. You can use development stores to test your apps, themes, and other integrations that you build. You can also use them to build Shopify stores for clients.

Unlike merchant stores that begin with a 14-day free trial, development stores are free until you transfer them to a client. To learn more about development stores, their features, and their limitations, see Creating development stores.

Steps:

  1. Log in to your Partner Dashboard.

  2. Click Development stores.

  3. Enter a store name and create a password.

  4. Click Save.

Generate API credentials from the Shopify admin

When you make an API call, you need to include API credentials to authenticate it. You can quickly generate API credentials by creating a private app from your development store's Shopify admin. When you create the private app, Shopify creates an API key and password, which you can include in API calls to the development store.

Steps:

  1. From your Shopify admin, go to Apps.

  2. Click Manage private apps.

  3. Click Create a new private app.

  4. In the App details section, enter a name for your app, and an emergency developer email.

  5. In the Admin API section, select the areas of your store that you want the app to access.

  6. Click Save.

After you save the app's details, the Admin API section shows the app's API key and password.

Making your first request

You can use the API key and password that you generated for basic HTTP authorization of your first request. The URL format for basic authorization is as follows:

https://{username}:{password}@{shop}.myshopify.com/admin/api/{api-version}/{resource}.json
  • {username} — The API key that you generated
  • {password} — The API password
  • {shop} - The name that you entered for your development store
  • {api-version} — The supported API version you want to use
  • {resource} — A resource endpoint from the REST admin API

A URL with real values looks like this:

https://38b3692b6b48a9712b8d909c46e6208d:c2dc0abbdef5825da69ee1647962ce2d@example.myshopify.com/admin/api/2019-04/products.json

The following curl request retrieves information by using the Shop resource and the /admin/api/2019-04/shop.json endpoint:

curl -X GET https://{username}:{password}@{shop}.myshopify.com/admin/api/2019-04/shop.json -H 'Content-Type: application/json'

Substitute your own values, and then run the curl command from the command line to retrieve information from your development store.

Next steps

  • Using Postman - Learn how to use basic authorization with Postman to make API calls, including PUT and POST requests.
  • REST Admin API - Explore the REST Admin API reference and try the example requests.
  • Public apps — Learn how to install an app on multiple shops.

Sign up for a Partner account to get started.

Sign up