HomeDocumentationAPI Reference
Documentation

Step 1. Configure your Reach API keys

Configure your Reach API key to include settlement data for your Shopify account to ensure smooth reporting and settlement on Reach’s end. Follow these easy steps to complete the process:

  1. Sign in to Shopify.
  2. Click Settings and then click Apps and sales channels.
ℹ️

Note

If your store doesn’t have developer apps, click Allow custom app development to continue. You will see the following screen.

Click **Allow custom app development**

Click Allow custom app development

Click Allow custom app development again.

  1. Click Develop Apps in the top-right corner of the App and sales channels page.
Click **Develop Apps**

Click Develop Apps

  1. From the App development screen, click Create an app.
Click **Create an app**

Click Create an app

  1. From the Create an app modal, type the app’s name for the settlement in the App name field. We recommend using “Reach Data” as the app name.
Enter the app's name in the **App name** field

Enter the app's name in the App name field

  1. Click Create app.
  2. Click Reach Data on the App development page.
Click **Reach Data**

Click Reach Data

  1. From the Overview tab on the Reach Data page, click the Configuration tab.
  2. Click Configure in the Admin API integration section. If you have already configured this integration, you can skip this step.
  3. Under Admin API access scopes, use the Filter access scopes field to locate and select the following checkboxes.
    • read_orders
    • read_products
    • read_shopify_payments_payouts
    • read_shopify_payments_disputes
    • read_shopify_payments_accounts
    • read_shopify_payments_bank_accounts
Use the **Filter access scopes** field to locate checkboxes

Use the Filter access scopes field to locate checkboxes

  1. Click Save. Your Admin API access scopes will appear under the Admin API integration section in the Configuration tab.
 API access scopes will appear under the **Admin API integration**

API access scopes will appear under the Admin API integration

  1. Click API credentials.
  2. Click Install app under Access tokens to install the application and generate your access tokens.
Click **Install app**

Click Install app

  1. On the Install Reach Data modal, click Install to add it to your store. Your API access token and API keys are now available on the API credentials tab.
Click **Install**

Click Install

  1. Reveal, copy, and save the following keys to a safe place:

    • Admin API access token: To protect your data, you can only reveal and copy your Admin API token once.

    • API key

    • API secret key

    ❗️

    Important

    When saving API keys and tokens, you must store them securely. For example, keep confidential (secret) keys on your servers only and do not store them in version control systems. It helps protect your API keys from unauthorized access.

Reveal and copy your keys to a safe place

Reveal and copy your keys to a safe place

  1. Reach will ask you to upload these keys to a secure location. Reach uses these keys to pull the orders and add them to their database.

Configure your Reach API key to include settlement data for your Shopify account to ensure smooth reporting and settlement on Reach’s end. Follow these easy steps to complete the process:

  1. Sign in to Shopify.
  2. Click Settings in the lower left corner and then click Apps and sales channels.
ℹ️

Note

If your store doesn’t have developer apps, click Allow custom app development to continue. You will see the following screen.

Click **Allow custom app development**

Click Allow custom app development

Click Allow custom app development again.

  1. Click Develop apps in the top-right corner of the App and sales channels page.
Click **Develop apps**

Click Develop apps

  1. From the App development screen, click Create an app.
Click **Create an app**

Click Create an app

  1. From the Create an app modal, type the app’s name for the settlement in the App name field. We recommend using “Reach Data” as the app name.
Click **Create app**

Click Create app

  1. Click Create app.
  2. Click Reach Data on the App development page.
Click **Reach Data**

Click Reach Data

  1. From the Overview tab on the Reach Data page, click the Configuration tab.
  2. Click Configure in the Admin API integration section. If you have already configured this integration, you can skip this step.
  3. Under Admin API access scopes, use the Filter access scopes field to locate and select the following checkboxes.
    • read_orders
    • read_products
    • read_shopify_payments_payouts
    • read_shopify_payments_disputes
    • read_shopify_payments_accounts
    • read_shopify_payments_bank_accounts
Use the **Filter access scopes** field to locate checkboxes

Use the Filter access scopes field to locate checkboxes

  1. Click Save. Your Admin API access scopes will appear under the Admin API itegration section in the Configuration tab.
Admin API access scopes will appear under the **Admin API itegration**

Admin API access scopes will appear under the Admin API itegration

  1. Click API credentials.
  2. Click Install app under Access tokens to install the application and generate your access tokens.
Click **Install app**

Click Install app

  1. On the Install Reach Data modal, click Install to add it to your store. Your API access token and API keys are now available on the API credentials tab.
Click **Install**

Click Install

  1. Reveal, copy, and save the following keys to a safe place:

    • Admin API access token: To protect your data, you can only reveal and copy your Admin API token once.

    • API key

    • API secret key

    ❗️

    Important

    When saving API keys and tokens, you must store them securely. For example, keep confidential (secret) keys on your servers only and do not store them in version control systems. It helps protect your API keys from unauthorized access.

Reveal, copy, and save the following keys to a safe place

Reveal, copy, and save the following keys to a safe place

  1. Reach will ask you to upload these keys to a secure location. Reach uses these keys to pull the orders and add them to their database.