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 of the different distribution types
Anchor to config-credentialsConfigure your app
After you have created and configured your app in the Shopify Admin update your code with the API Key, API Secret Key, and the access token.
Configure your app credentials
shopify.server.ts
const shopify = shopifyApp({
apiKey: "your-api-key",
apiSecretKey: "your-api-secret-key",
adminApiAccessToken:"shpat_1234567890",
...
}
Anchor to config-settingsConfigure your app settings
Configure with the following values
distribution--https://localhost:3000or other configured port-false, merchant custom apps cannot be embedded
Configure app settings
/app/shopify.server.ts
const shopify = shopifyApp({
apiKey: "your-api-key",
apiSecretKey: "your-api-secret-key",
adminApiAccessToken:"shpat_1234567890",
distribution: AppDistribution.ShopifyAdmin,
appUrl: "https://localhost:3000",
isEmbeddedApp: false,
...
}
Anchor to local-devRun 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:
Run your app
npm exec remix vite:dev
