A Shopify application that extends store functionality. Apps integrate with Shopify through APIs to add features, automate workflows, or connect external services.
Provides metadata about the app including its developer information and listing details in the Shopify App Store. Use the installation field to determine if the app is currently installed on the shop and access installation-specific details like granted objects. Check before installation to identify any prerequisites that must be met.
Anchor to FieldsFields
- Anchor to apiKeyapi•String!
Key non-null A unique application API identifier.
- Anchor to appStoreAppUrlapp•URL
Store App Url App store page URL of the app.
- Anchor to appStoreDeveloperUrlapp•URL
Store Developer Url App store page URL of the developer who created the app.
- Anchor to availableAccessScopesavailable•[Access
Access Scopes Scope!]! non-null All requestable access scopes available to the app.
- •Image!non-null
Banner image for the app.
- Anchor to descriptiondescription•String
Description of the app.
- Anchor to developerNamedeveloper•String
Name The name of the app developer.
- Anchor to developerTypedeveloper•App
Type Developer Type! non-null The type of app developer.
- Anchor to embeddedembedded•Boolean!non-null
Whether the app uses the Embedded App SDK.
- Anchor to failedRequirementsfailed•[Failed
Requirements Requirement!]! non-null Requirements that must be met before the app can be installed.
- Anchor to featuresfeatures•[String!]!non-null
A list of app features that are shown in the Shopify App Store listing.
- Anchor to feedbackfeedback•App
Feedback Feedback from this app about the store.
- Anchor to handlehandle•String
Handle of the app.
- Anchor to iconicon•Image!non-null
Icon that represents the app.
- •ID!non-null
A globally-unique ID.
- Anchor to installationinstallation•App
Installation Corresponding AppInstallation for this shop and App. Returns null if the App is not installed.
- Anchor to installUrlinstall•URL
Url Webpage where you can install the app, if app requires explicit user permission.
- Anchor to isPostPurchaseAppInUseis•Boolean!
Post Purchase App In Use non-null Whether the app is the post purchase app in use.
- Anchor to optionalAccessScopesoptional•[Access
Access Scopes Scope!]! non-null The optional scopes requested by the app. Lists the optional access scopes the app has declared in its configuration. These scopes are optionally requested by the app after installation.
- Anchor to previouslyInstalledpreviously•Boolean!
Installed non-null Whether the app was previously installed on the current shop.
- Anchor to pricingDetailspricing•String
Details Detailed information about the app pricing.
- Anchor to pricingDetailsSummarypricing•String!
Details Summary non-null Summary of the app pricing details.
- Anchor to privacyPolicyUrlprivacy•URL
Policy Url Link to app privacy policy.
- Anchor to publicCategorypublic•App
Category Public Category! non-null The public category for the app.
- Anchor to publishedpublished•Boolean!non-null
Whether the app is published to the Shopify App Store.
- Anchor to requestedAccessScopesrequested•[Access
Access Scopes Scope!]! non-null The access scopes requested by the app. Lists the access scopes the app has declared in its configuration. Merchant must grant approval to these scopes for the app to be installed.
- Anchor to screenshotsscreenshots•[Image!]!non-null
Screenshots of the app.
- Anchor to shopifyDevelopedshopify•Boolean!
Developed non-null Whether the app was developed by Shopify.
- Anchor to titletitle•String!non-null
Name of the app.
- Anchor to uninstallMessageuninstall•String!
Message non-null Message that appears when the app is uninstalled. For example: By removing this app, you will no longer be able to publish products to MySocialSite or view this app in your Shopify admin. You can re-enable this channel at any time.
- Anchor to webhookApiVersionwebhook•String!
Api Version non-null The webhook API version for the app.
Deprecated fields
- Anchor to developerUrldeveloper•URL!
Url non-nullDeprecated - Anchor to launchUrllaunch•URL!
Url non-nullDeprecated - •[Navigation
Item!]! non-nullDeprecated - Anchor to uninstallUrluninstall•URL
Url Deprecated
Anchor to QueriesQueries
- •query
Retrieves an
Appby its ID. If no ID is provided, returns details about the currently authenticated app. The query provides access to app details including title, icon, and pricing information.If the app isn't installed on the current shop, then the
installationfield will benull.- •ID
The ID to lookup the App by.
Arguments
- •query
Retrieves an app by its unique handle. The handle is a URL-friendly identifier for the app.
Returns the
Appif found, ornullif no app exists with the specified handle.- Anchor to handlehandle•String!required
Handle of the App.
Arguments
- •query
Retrieves an
Appby its client ID (API key). Returns the app's configuration, installation status,objects, and developer information.Returns
nullif no app exists with the specified client ID.- Anchor to apiKeyapi•String!
Key required Client ID of the app.
Arguments
Anchor to MutationsMutations
- •mutation
Uninstalls an
Appfrom a shop. Apps use this mutation to uninstall themselves programmatically, removing theirfrom the merchant's store.When an app uninstalls, Shopify automatically performs cleanup tasks, such as deleting
objects and admin links associated with the app.Learn more about app lifecycle management.
CautionThis action is irreversible. You can't restore an uninstalled app's configuration or data. Before you uninstall an app, make sure that you no longer need to make API calls for the store in which the app has been installed.