appByKey
Fetches an app by its client ID. Returns null if the app doesn't exist.
Arguments
- Anchor to apiKeyapi•
Key String!required Client ID of the app.
Anchor to Possible returnsPossible returns
- •
A Shopify application.
- api
Key •String!non-null A unique application API identifier.
- app
Store •App Url URL App store page URL of the app.
- app
Store •Developer Url URL App store page URL of the developer who created the app.
- available
Access •Scopes [Accessnon-nullScope!]! All requestable access scopes available to the app.
- banner•Image!non-null
Banner image for the app.
- description•String
Description of the app.
- developer
Name •String The name of the app developer.
- developer
Type •Appnon-nullDeveloper Type! The type of app developer.
- embedded•Boolean!non-null
Whether the app uses the Embedded App SDK.
- failed
Requirements •[Failednon-nullRequirement!]! Requirements that must be met before the app can be installed.
- features•[String!]!non-null
A list of app features that are shown in the Shopify App Store listing.
- feedback•App
Feedback Feedback from this app about the store.
- handle•String
Handle of the app.
- icon•Image!non-null
Icon that represents the app.
- id•ID!non-null
A globally-unique ID.
- installation•App
Installation Corresponding AppInstallation for this shop and App. Returns null if the App is not installed.
- install
Url •URL Webpage where you can install the app.
- is
Post •Purchase App In Use Boolean!non-null Whether the app is the post purchase app in use.
- optional
Access •Scopes [Accessnon-nullScope!]! 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.
- previously
Installed •Boolean!non-null Whether the app was previously installed on the current shop.
- pricing
Details •String Detailed information about the app pricing.
- pricing
Details •Summary String!non-null Summary of the app pricing details.
- privacy
Policy •Url URL Link to app privacy policy.
- public
Category •Appnon-nullPublic Category! The public category for the app.
- published•Boolean!non-null
Whether the app is published to the Shopify App Store.
- requested
Access •Scopes [Accessnon-nullScope!]! 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.
- screenshots•[Image!]!non-null
Screenshots of the app.
- shopify
Developed •Boolean!non-null Whether the app was developed by Shopify.
- star
Rating •Float!non-null The star rating of the app.
- title•String!non-null
Name of the app.
- uninstall
Message •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.
- webhook
Api •Version String!non-null The webhook API version for the app.
- developer
Url •URL!non-nullDeprecated Website of the developer who created the app. Use
instead.
- launch
Url •URL!non-nullDeprecated Webpage that the app starts in. Use AppInstallation.launchUrl instead
- navigation
Items •[Navigationnon-nullDeprecatedItem!]! Menu items for the app, which also appear as submenu items in left navigation sidebar in the Shopify admin. Use AppInstallation.navigationItems instead
- uninstall
Url •URLDeprecated Webpage where you can uninstall the app. Use AppInstallation.uninstallUrl instead
- api