Custom apps

You can use this package to build apps that are distributed in the Shopify Admin, also known as merchant custom apps. These apps do not Authorize by OAuth, and instead use a access token that has been generated by the Shopify Admin. > Note: Before creating a new app to be distributed with the shopify admin, you should be familiar with the [limitations](/docs/apps/launch/distribution#capabilities-and-requirements) of the different distribution types

Configure your app

Configure your app

After you have [created and configured your app](https://help.shopify.com/en/manual/apps/app-types/custom-apps) in the Shopify Admin update your code with the API Key, API Secret Key, and the access token.

Configure your app credentials

const shopify = shopifyApp({
  apiKey: "your-api-key",
  apiSecretKey: "your-api-secret-key",
  adminApiAccessToken:"shpat_1234567890",
  ...
}

Configure your app settings

Configure your app settings

Configure `shopifyApp` with the following values 1. `distribution` - `AppDistribution.ShopifyAdmin` 1. `appUrl` - `https://localhost:3000` or other configured port 1. `isEmbeddedApp` - `false`, merchant custom apps cannot be embedded

Configure app settings

const shopify = shopifyApp({
    apiKey: "your-api-key",
    apiSecretKey: "your-api-secret-key",
    adminApiAccessToken:"shpat_1234567890",
    distribution: AppDistribution.ShopifyAdmin,
    appUrl: "https://localhost:3000",
    isEmbeddedApp: false,
    ...
}

Run your app locally

Run your app locally

Merchant custom apps are not compatible with the Shopify CLI, so you must start your app directly. After your app is running you can access it at the following URL: `http://localhost:3000/app?shop=my-shop.myshopify.com`

Run your app

npm exec remix vite:dev

yarn remix vite:dev

pnpm exec remix vite:dev

Resources

Resources