Config
The config API stores the initial configuration information for your app and lets you synchronously retrieve it.
Anchor to configConfig
The config API is available on the shopify global. It stores the initial configuration information for your app and shop.
The client ID provided for your application in the Partner Dashboard.
This needs to be provided by the app developer.
An allowlist of origins that your app can send authenticated fetch requests to.
This is useful if your app needs to make authenticated requests to a different domain that you control.
Configuration options for enabling debug features within the app. Includes options for monitoring performance metrics, such as web vitals.
Recommended for use during development and debugging to aid in identifying and resolving performance issues.
Generally not recommended for long-term use in production environments.
The features to disable in your app.
This allows app developers to opt-out of features such as fetch.
The experimental features to enable in your app.
This allows app developers to opt-in to experiement features.
The base64-encoded host of the shop that's embedding your app.
This does not need to be provided by the app developer.
The locale of the shop that's embedding your app.
This does not need to be provided by the app developer.
The shop origin of the shop that's embedding your app.
This does not need to be provided by the app developer.
Shop
Anchor to examplesExamples
Retrieving config values
Anchor to example-retrieving-config-valuesRetrieving config values
Retrieving the shop origin
Retrieving the host
Anchor to example-localeLocale
Retrieving the locale
Anchor to example-apikeyApiKey
Retrieving the apiKey
Anchor to example-disabledfeaturesDisabledFeatures
Retrieving the disabledFeatures
Anchor to example-apporiginsAppOrigins
Retrieving the appOrigins
Configuration for debugging apps.
Shop
Anchor to example-setting-config-valuesSetting config values
Anchor to example-apikeyApiKey
Setting the apiKey
Anchor to example-disabledfeaturesDisabledFeatures
Setting the disabledFeatures
Anchor to example-apporiginsAppOrigins
Setting the appOrigins
Enabling Debug Features for Performance Monitoring