Skip to content

Feeds

This guide explains how to integrate with Shopify by creating an app through the Shopify Dev Dashboard. You’ll configure the necessary permissions for read-only access to products, orders, and returns, then install the app on your store.

When creating the application, you will specify the permissions it will have. Specifically, we will enable read-only access to products, orders, and returns. After the application is set up in your store, you will need to share the API credentials with us, which will allow us to access the necessary data.

Creating the Application

To start, go to the Dev Dashboard page at https://dev.shopify.com/dashboard

From the Dev Dashboard, navigate to Apps in the left-panel navigation and select Create app in the top right corner.

Select Start from Dev Dashboard, name your app, then select Create.

Create a new app

Configuring Permissions and Creating a Version

Scroll down to the Access section and configure the following scopes:

  • read_order_edits
  • read_orders
  • read_products
  • read_returns

Configure app scopes

Once configured, select Release to create a version. A version is a snapshot of your app’s current configuration, URLs, and settings. Your app must have at least one version before it can be installed on a store.

Installing Your App

Once your version is released, you can install the app on your store.

  1. Return to the Home section of your app.

  2. In the Distribution section, click Select distribution method.

Distribution section

  1. Select Custom distribution, then click Select. Confirm your selection by clicking Select distribution method.

Select custom distribution

  1. Enter your store domain (e.g., your-store.myshopify.com) if prompted, and Click Generate link to create an installation link for your app.

Confirm custom distribution

  1. Click the generated link or Install app to begin the installation process.

Generate installation link

  1. Review the app settings and permissions, then confirm the installation.

Install app button

Retrieving and Sharing API Credentials

Review app settings

After installing the app, return to Dev Dashboard and navigate to the Settings section to find:

  • Client ID
  • API secret key

Please share these two credentials with us to complete the integration.