> ## Documentation Index
> Fetch the complete documentation index at: https://developers.perform.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Shopify integration setup

> Connect your Shopify store to Perform.AI — shipments import automatically, tracked end to end.

The Shopify integration imports orders and shipments from your Shopify store into Perform.AI automatically — no API coding required. Setup has three steps: create the integration in Perform.AI, create a Shopify app to obtain credentials, then save and activate.

<Info>
  Perform.AI only **reads** the relevant Shopify data (orders, fulfillments, product images); it never writes back to your store.
</Info>

## Step 1 — Create the integration in Perform.AI

In your account, open the **Integrations** page and select **Add Store**. The configuration panel asks for:

<img src="https://mintcdn.com/perform-ai/h_wboKDQm_MSwzQD/images/shopify/shopify_step1_image1.png?fit=max&auto=format&n=h_wboKDQm_MSwzQD&q=85&s=9f26dc236ccc39a259f4bcf149820721" alt="Shopify integration configuration panel" width="1600" height="786" data-path="images/shopify/shopify_step1_image1.png" />

**Store credentials**

| Field              | Needed for            | Notes                                                                              |
| ------------------ | --------------------- | ---------------------------------------------------------------------------------- |
| **Store URL**      | Saving and activating | Only the subdomain part: for `shopify-store.myshopify.com`, enter `shopify-store`. |
| **API Key**        | Activating            | Your Shopify app's **Client ID** (created in Step 2).                              |
| **API Secret Key** | Activating            | Your Shopify app's **Secret**.                                                     |

**Store details** (all optional)

* **Store Display Name** — defaults to the store name retrieved from Shopify; also stamped on imported shipments.
* **Tracking Page** — link imported shipments to one of your tracking pages for consumer notifications and tracking.
* **Store Tag** — tags added to every shipment imported from this store.
* **Manual Sync Duration** (activated integrations only) — shipments flow in automatically, but you can re-pull history on demand: **Today**, **Last week**, **Last month**, or **Last three months**, then **Sync**.

## Step 2 — Create a Shopify app and retrieve credentials

The integration authenticates through an app you create in Shopify's Dev Dashboard.

<Warning>
  Shopify's **Legacy Custom Apps** are no longer supported for new integrations — use **Build apps in Dev Dashboard**.
</Warning>

<Steps>
  <Step title="Open app development">
    Log in to your Shopify store, go to **Settings** → **Apps** → **Develop apps**, and select **Build apps in Dev Dashboard**.

    <img src="https://mintcdn.com/perform-ai/h_wboKDQm_MSwzQD/images/shopify/shopify_step2_image1.png?fit=max&auto=format&n=h_wboKDQm_MSwzQD&q=85&s=a5751287a473ef7b9cdfe05fe9e935ae" alt="Shopify Settings" width="1600" height="834" data-path="images/shopify/shopify_step2_image1.png" />

    <img src="https://mintcdn.com/perform-ai/h_wboKDQm_MSwzQD/images/shopify/shopify_step2_image2.png?fit=max&auto=format&n=h_wboKDQm_MSwzQD&q=85&s=0dc14dbe8e7c22ce7291cfce5c9854d0" alt="Apps and Develop apps" width="1470" height="1100" data-path="images/shopify/shopify_step2_image2.png" />

    <img src="https://mintcdn.com/perform-ai/h_wboKDQm_MSwzQD/images/shopify/shopify_step2_image3.png?fit=max&auto=format&n=h_wboKDQm_MSwzQD&q=85&s=b51a32de9f0cc0437f6b384c085606b1" alt="Build apps in Dev Dashboard" width="1600" height="802" data-path="images/shopify/shopify_step2_image3.png" />
  </Step>

  <Step title="Create the app">
    Select **Create app** and name it — any name works; we recommend `Perform.AI Integration - {your account name}`.

    <img src="https://mintcdn.com/perform-ai/h_wboKDQm_MSwzQD/images/shopify/shopify_step2_image4.png?fit=max&auto=format&n=h_wboKDQm_MSwzQD&q=85&s=20e332e89809cebd84227fba6bf7f610" alt="Create app" width="1600" height="773" data-path="images/shopify/shopify_step2_image4.png" />

    <img src="https://mintcdn.com/perform-ai/h_wboKDQm_MSwzQD/images/shopify/shopify_step2_image5.png?fit=max&auto=format&n=h_wboKDQm_MSwzQD&q=85&s=d5fe072c3413f044de806de20920405b" alt="App name" width="1600" height="620" data-path="images/shopify/shopify_step2_image5.png" />
  </Step>

  <Step title="Configure the app version">
    On the **Versions** page:

    * Set the App URL to `https://www.parcelperform.com` and **uncheck** "Embed app in Shopify admin" — there is no UI to embed; a successful install simply redirects to that website.
    * In **Webhook API Version**, select the **oldest available version**. Shopify updates versions quarterly with fall-forward logic — picking the oldest means you set this once and never need to update it.

          <img src="https://mintcdn.com/perform-ai/h_wboKDQm_MSwzQD/images/shopify/shopify_step2_image6.png?fit=max&auto=format&n=h_wboKDQm_MSwzQD&q=85&s=83b3b419d71a1cfb154662e9a5a2bc8f" alt="Version settings" width="1600" height="778" data-path="images/shopify/shopify_step2_image6.png" />
  </Step>

  <Step title="Select access scopes">
    In the **Access** section, select these four scopes — all read-only, and all **mandatory** for the integration to work:

    * `read_orders` — order and shipment information
    * `read_products` — line-item product images
    * `read_assigned_fulfillment_orders` — fulfillment order information
    * `read_fulfilments` — fulfillment information

          <img src="https://mintcdn.com/perform-ai/h_wboKDQm_MSwzQD/images/shopify/shopify_step2_image7.png?fit=max&auto=format&n=h_wboKDQm_MSwzQD&q=85&s=05889fb72f295180dab964828e804c6b" alt="Select scopes" width="1600" height="764" data-path="images/shopify/shopify_step2_image7.png" />

          <img src="https://mintcdn.com/perform-ai/h_wboKDQm_MSwzQD/images/shopify/shopify_step2_image8.png?fit=max&auto=format&n=h_wboKDQm_MSwzQD&q=85&s=fbe8ebd23c987fa31813782c718d420f" alt="Scopes selected" width="1600" height="777" data-path="images/shopify/shopify_step2_image8.png" />

    Then select **Release** to publish the app version.

    <img src="https://mintcdn.com/perform-ai/h_wboKDQm_MSwzQD/images/shopify/shopify_step2_image9.png?fit=max&auto=format&n=h_wboKDQm_MSwzQD&q=85&s=0aabea888d0a7bc17b18539ae99d4982" alt="Release" width="1600" height="779" data-path="images/shopify/shopify_step2_image9.png" />
  </Step>

  <Step title="Set the contact email">
    Open the app's **Settings** tab — your **Client ID** and **Secret** live here (no access token is required). Scroll to **Contact Information**, select **Edit**, and enter `shopify-integration@parcelperform.com` — this lets Perform.AI receive Shopify's notices about your app and fix issues quickly. **Save**.

    <img src="https://mintcdn.com/perform-ai/h_wboKDQm_MSwzQD/images/shopify/shopify_step2_image10.png?fit=max&auto=format&n=h_wboKDQm_MSwzQD&q=85&s=59018425ca561a05b44a7fc25326effb" alt="App settings with credentials" width="1600" height="776" data-path="images/shopify/shopify_step2_image10.png" />

    <img src="https://mintcdn.com/perform-ai/h_wboKDQm_MSwzQD/images/shopify/shopify_step2_image11.png?fit=max&auto=format&n=h_wboKDQm_MSwzQD&q=85&s=d4a4cd045aae95f62bb0d9e58fc50228" alt="Contact information" width="1600" height="772" data-path="images/shopify/shopify_step2_image11.png" />
  </Step>

  <Step title="Install the app to your store">
    Go to **Home** → **Install app** → **Install**, pick the store, and confirm the installation on the store's Install App page. A successful install redirects you to the Perform.AI website; verify under **Settings → Apps** in your store admin that the app appears in the **Installed** tab.

    <img src="https://mintcdn.com/perform-ai/h_wboKDQm_MSwzQD/images/shopify/shopify_step2_image12.png?fit=max&auto=format&n=h_wboKDQm_MSwzQD&q=85&s=0b14668a82fcea81b2ed28784a8da87f" alt="Install app" width="1600" height="650" data-path="images/shopify/shopify_step2_image12.png" />

    <img src="https://mintcdn.com/perform-ai/h_wboKDQm_MSwzQD/images/shopify/shopify_step2_image13.png?fit=max&auto=format&n=h_wboKDQm_MSwzQD&q=85&s=6de84e4534084c34472e9ddde1a056d6" alt="Store selection" width="1206" height="824" data-path="images/shopify/shopify_step2_image13.png" />

    <img src="https://mintcdn.com/perform-ai/h_wboKDQm_MSwzQD/images/shopify/shopify_step2_image14.png?fit=max&auto=format&n=h_wboKDQm_MSwzQD&q=85&s=c046ca7b5ac2d158173cd3d00d759d83" alt="Install confirmation" width="1296" height="1374" data-path="images/shopify/shopify_step2_image14.png" />

    <img src="https://mintcdn.com/perform-ai/h_wboKDQm_MSwzQD/images/shopify/shopify_step2_image15.png?fit=max&auto=format&n=h_wboKDQm_MSwzQD&q=85&s=2ba53eca9f683722a61e56c1a51bea1b" alt="Installed tab" width="2440" height="1692" data-path="images/shopify/shopify_step2_image15.png" />

    <img src="https://mintcdn.com/perform-ai/h_wboKDQm_MSwzQD/images/shopify/shopify_step2_image16.png?fit=max&auto=format&n=h_wboKDQm_MSwzQD&q=85&s=ef5b58e0514a408e2cafa9027f4ca19a" alt="Installed app detail" width="2174" height="1118" data-path="images/shopify/shopify_step2_image16.png" />
  </Step>

  <Step title="Copy the credentials into Perform.AI">
    Back in **Dev Dashboard → App → Settings**, copy the values into your Perform.AI integration panel: Shopify's **Client ID** → the **API Key** field, and Shopify's **Secret** → the **API Secret Key** field.

    <img src="https://mintcdn.com/perform-ai/h_wboKDQm_MSwzQD/images/shopify/shopify_step2_image17.png?fit=max&auto=format&n=h_wboKDQm_MSwzQD&q=85&s=f1edc8fb05d15cb0a305607cbd109293" alt="Copy credentials" width="1600" height="775" data-path="images/shopify/shopify_step2_image17.png" />

    <img src="https://mintcdn.com/perform-ai/h_wboKDQm_MSwzQD/images/shopify/shopify_step2_image18.png?fit=max&auto=format&n=h_wboKDQm_MSwzQD&q=85&s=9244f63d43b763331b25a3ffb1af817d" alt="Paste into Perform.AI" width="1506" height="1182" data-path="images/shopify/shopify_step2_image18.png" />
  </Step>
</Steps>

## Step 3 — Save and activate

1. **Save** the integration (bottom right) — leaving without saving loses your input. The integration's status becomes **Draft**.
2. **Activate** (bottom left). On success the status shows **Activated (Connected)** — "Activated" is the Perform.AI side, "Connected" is the app status reported by Shopify — and the integration appears as Activated in your Integration Overview.

<img src="https://mintcdn.com/perform-ai/h_wboKDQm_MSwzQD/images/shopify/shopify_step3_image1.png?fit=max&auto=format&n=h_wboKDQm_MSwzQD&q=85&s=cfa39824a4c25cce07de498b63bbc989" alt="Save" width="1468" height="1194" data-path="images/shopify/shopify_step3_image1.png" />

<img src="https://mintcdn.com/perform-ai/h_wboKDQm_MSwzQD/images/shopify/shopify_step3_image2.png?fit=max&auto=format&n=h_wboKDQm_MSwzQD&q=85&s=cc2addbc9c0ba5a7e22c364d8381d427" alt="Draft and Activate" width="1470" height="1198" data-path="images/shopify/shopify_step3_image2.png" />

<img src="https://mintcdn.com/perform-ai/h_wboKDQm_MSwzQD/images/shopify/shopify_step3_image3.png?fit=max&auto=format&n=h_wboKDQm_MSwzQD&q=85&s=deda8d1d2d778cdc025d7b71f1a30349" alt="Activated status" width="1494" height="1204" data-path="images/shopify/shopify_step3_image3.png" />

<img src="https://mintcdn.com/perform-ai/h_wboKDQm_MSwzQD/images/shopify/shopify_step3_image4.png?fit=max&auto=format&n=h_wboKDQm_MSwzQD&q=85&s=8daa6181ebf779185f9d4b62917cd599" alt="Integration overview" width="1600" height="397" data-path="images/shopify/shopify_step3_image4.png" />

Notes for later:

* Credentials display truncated for security — to change the API Key or Secret Key you must re-enter the full value, and only after **deactivating** the integration. Store details (display name, tracking page) can change while active.
* The trash icon (top right of the panel) deletes a saved integration.

<img src="https://mintcdn.com/perform-ai/h_wboKDQm_MSwzQD/images/shopify/shopify_step3_image5.png?fit=max&auto=format&n=h_wboKDQm_MSwzQD&q=85&s=16ec5c05d6cf5a132bfe39913a38d605" alt="Deactivate" width="1478" height="1200" data-path="images/shopify/shopify_step3_image5.png" />

<Check>
  Your Shopify store is now connected — shipments import and track automatically from here on.
</Check>
