Choose a version:

App

object

A Shopify application.

Anchor to FieldsFields

Anchor to apiKeyapiKey •String!non-null: A unique application API identifier.
Anchor to appStoreAppUrlappStoreAppUrl •URL: App store page URL of the app.
Anchor to appStoreDeveloperUrlappStoreDeveloperUrl •URL: App store page URL of the developer who created the app.
Anchor to availableAccessScopesavailableAccessScopes •[AccessScope!]!non-null: All requestable access scopes available to the app.
Anchor to bannerbanner •Image!non-null: Banner image for the app.
Anchor to descriptiondescription •String: Description of the app.
Anchor to developerNamedeveloperName •String: The name of the app developer.
Anchor to developerTypedeveloperType •AppDeveloperType!non-null: The type of app developer.
Anchor to embeddedembedded •Boolean!non-null: Whether the app uses the Embedded App SDK.
Anchor to failedRequirementsfailedRequirements •[FailedRequirement!]!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 •AppFeedback: 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.
Anchor to idid •ID!non-null: A globally-unique ID.
Anchor to installationinstallation •AppInstallation: Corresponding AppInstallation for this shop and App. Returns null if the App is not installed.
Anchor to installUrlinstallUrl •URL: Webpage where you can install the app.
Anchor to isPostPurchaseAppInUseisPostPurchaseAppInUse •Boolean!non-null: Whether the app is the post purchase app in use.
Anchor to optionalAccessScopesoptionalAccessScopes •[AccessScope!]!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 previouslyInstalledpreviouslyInstalled •Boolean!non-null: Whether the app was previously installed on the current shop.
Anchor to pricingDetailspricingDetails •String: Detailed information about the app pricing.
Anchor to pricingDetailsSummarypricingDetailsSummary •String!non-null: Summary of the app pricing details.
Anchor to privacyPolicyUrlprivacyPolicyUrl •URL: Link to app privacy policy.
Anchor to publicCategorypublicCategory •AppPublicCategory!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 requestedAccessScopesrequestedAccessScopes •[AccessScope!]!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 shopifyDevelopedshopifyDeveloped •Boolean!non-null: Whether the app was developed by Shopify.
Anchor to starRatingstarRating •Float!non-null: The star rating of the app.
Anchor to titletitle •String!non-null: Name of the app.
Anchor to uninstallMessageuninstallMessage •String!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 webhookApiVersionwebhookApiVersion •String!non-null: The webhook API version for the app.

Deprecated fields

Anchor to developerUrldeveloperUrl •URL!non-nullDeprecated
Anchor to launchUrllaunchUrl •URL!non-nullDeprecated
Anchor to navigationItemsnavigationItems •[NavigationItem!]!non-nullDeprecated
Anchor to uninstallUrluninstallUrl •URLDeprecated

Was this section helpful?

Anchor to QueriesQueries

Anchor to app app •query: Lookup an App by ID or return the currently authenticated App.
Anchor to appByHandle appByHandle •query: Fetches app by handle. Returns null if the app doesn't exist.
Anchor to appByKey appByKey •query: Fetches an app by its client ID. Returns null if the app doesn't exist.

Was this section helpful?

Anchor to MutationsMutations

appUninstall

•mutation

Uninstalls an app.

Anchor to appapp •App: The uninstalled app.
Anchor to userErrorsuserErrors •[AppUninstallAppUninstallError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to Node Node •interface

Was this section helpful?