Shopify API Connection - Custom Apps

Avatar
Matt Sullivan
Created / Updated
Follow

Getting Started

See more...

Guiding you how to create a custom app to connect IR to your Shopify store

Using the Shopify API avoids issues that can come from scraping, helps to maintain (in some cases increase) the high quality of your data, and helps with efficiency. Therefore, Shopify API integration should always be the goal when dealing with Shopify sites.
 
The Shopify client/site owner/admin needs to do one thing, create a ‘Custom App’. This is how we gain access to the data.

Please note that as of January 2022, Private Apps have been deprecated within Shopify and Custom Apps should be used in their place. 

Create the app

  1. From your Shopify admin, go to Apps. Or alternatively go to Settings in the bottom left

  2. Click Apps and sales Channels

  3. Click Develop apps.

  4. Click Create an app.

  5. In the modal window, enter the App name and select an App developer. The app developer can be the store owner, or any staff or collaborator account with the Develop apps permission.

  6. Click Create app.

Select API scopes

After you create a custom app, you can assign API scopes to it. A custom app can have Admin API scopes, Storefront API scopes, or both, depending on the requirements of the app.

  1. Click Configure Admin API scopes.

  2. In the Admin API access scopes section, select the API scopes that you to assign to the app.

    1. This should include all 'Product' scopes but at minimum Product, Product Variants, Collections and Inventory
    2. We would also require Locations scope
    3. If Order Management is required, please also add scopes for Orders, Transactions, Fulfilments and Customer Details.

  3. Click Save.

Install the app and get the API access tokens

After you've set API scopes for your app, you can install the app. You'll get your API access tokens after you install. 

  1. Navigate to API Credentials and click Install App

  2. In the modal window, click Install app.

  3. This will then give you the access token for the Admin API

You can see the Admin API access token on this page only one time, because the token provides API access to sensitive store data. After revealing the access token, write down or record the token somewhere secure so that you can refer to it again, as you will not be able to view this token again, if you lose or forget your token before you have shared this with us then you will need to set up the custom app again and delete the old one. Treat the token like a password. Share the access token only with developers that you trust.

Get the API credentials for a custom app

You can check the Storefront access token, the API key, and the API secret for a custom app from the app's API credentials page. You can also check the Admin API access token, but after revealing it once, you can only check the last four digits of the token.

  1. From your Shopify admin, go to Apps.

  2. Click Develop apps.

  3. Click the name of the app that you want the credentials for.

  4. Click API credentials.

  5. Send the below information back to your CSM or Enablement Manager.

Access token: 

Api Key : 

Api secret :

Admin URL (will look like this https://STORE-NAME.myshopify.com/) : 



If you are using the Metafields within Shopify for some of your product details then please let us know, we will ask you to set up a second set of credentials in the same way that you created them above. 

 

If you are using Shopify Markets to separate out your regions then we will ask for another set of credentials, again set up in the same way as above but with the addition of the Translations scope so that we can pull through any translated product data.

Related articles

Comments

0 comments

Article is closed for comments.