API version: unstable
API version: 2021-01 Release candidate
API version: 2020-10 Latest
API version: 2020-07
API version: 2020-04
API version: 2020-01
API version: 2019-10 Unsupported
API version: 2019-07 Unsupported

App object

Version unstable

A Shopify application.

Fields

apiKey (String!)

A unique application API identifier.
appStoreAppUrl (URL)

App store page URL of the app.
appStoreDeveloperUrl (URL)

App store page URL of the developer who created the app.
description (String)

Description of the app.
developerName (String)

App's developer name.
embedded (Boolean!)

Whether the app uses the Embedded App SDK.
failedRequirements ([FailedRequirement!]!)

Requirements that must be met before the app can be installed.
features ([String!]!)

List of app features.
feedback (AppFeedback)

Feedback from this app about the store.
handle (String)

Handle of the app.
icon (Image!)

Icon that represents the app.
id (ID!)

Globally unique identifier.
installUrl (URL)

Webpage where you can install the app.
installation (AppInstallation)

Corresponding AppInstallation for this shop and App. Returns null if the App is not installed.
pricingDetails (String)

Detailed information about the app pricing.
pricingDetailsSummary (String!)

Summary of the app pricing details.
privacyPolicyUrl (URL)

Link to app privacy policy.
published (Boolean!)

Whether the app is published.
screenshots ([Image!]!)

Screenshots of the app.
shopifyDeveloped (Boolean!)

Whether the app was developed by Shopify.
title (String!)

Name of the app.
uninstallMessage (String!)

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.

Types that return App

Implements

Deprecated fields

developerUrl (URL!) deprecated

Website of the developer who created the app.

Deprecation warning

Use appStoreDeveloperUrl instead
launchUrl (URL!) deprecated

Webpage that the app starts in.

Deprecation warning

Use AppInstallation.launchUrl instead
navigationItems ([NavigationItem!]!) deprecated

Menu items for the app, which also appear as submenu items in left navigation sidebar in the Shopify admin.

Deprecation warning

Use AppInstallation.navigationItems instead
uninstallUrl (URL) deprecated

Webpage where you can uninstall the app.

Deprecation warning

Use AppInstallation.uninstallUrl instead
Version 2021-01 (Release candidate)

A Shopify application.

Fields

apiKey (String!)

A unique application API identifier.
appStoreAppUrl (URL)

App store page URL of the app.
appStoreDeveloperUrl (URL)

App store page URL of the developer who created the app.
description (String)

Description of the app.
developerName (String)

App's developer name.
embedded (Boolean!)

Whether the app uses the Embedded App SDK.
failedRequirements ([FailedRequirement!]!)

Requirements that must be met before the app can be installed.
features ([String!]!)

List of app features.
feedback (AppFeedback)

Feedback from this app about the store.
handle (String)

Handle of the app.
icon (Image!)

Icon that represents the app.
id (ID!)

Globally unique identifier.
installUrl (URL)

Webpage where you can install the app.
installation (AppInstallation)

Corresponding AppInstallation for this shop and App. Returns null if the App is not installed.
pricingDetails (String)

Detailed information about the app pricing.
pricingDetailsSummary (String!)

Summary of the app pricing details.
privacyPolicyUrl (URL)

Link to app privacy policy.
published (Boolean!)

Whether the app is published.
screenshots ([Image!]!)

Screenshots of the app.
shopifyDeveloped (Boolean!)

Whether the app was developed by Shopify.
title (String!)

Name of the app.
uninstallMessage (String!)

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.

Types that return App

Implements

Deprecated fields

developerUrl (URL!) deprecated

Website of the developer who created the app.

Deprecation warning

Use appStoreDeveloperUrl instead
launchUrl (URL!) deprecated

Webpage that the app starts in.

Deprecation warning

Use AppInstallation.launchUrl instead
uninstallUrl (URL) deprecated

Webpage where you can uninstall the app.

Deprecation warning

Use AppInstallation.uninstallUrl instead
Version 2020-10 (Latest)

A Shopify application.

Fields

apiKey (String!)

A unique application API identifier.
appStoreAppUrl (URL)

App store page URL of the app.
appStoreDeveloperUrl (URL)

App store page URL of the developer who created the app.
description (String)

Description of the app.
developerName (String)

App's developer name.
embedded (Boolean!)

Whether the app uses the Embedded App SDK.
failedRequirements ([FailedRequirement!]!)

Requirements that must be met before the app can be installed.
features ([String!]!)

List of app features.
feedback (AppFeedback)

Feedback from this app about the store.
handle (String)

Handle of the app.
icon (Image!)

Icon that represents the app.
id (ID!)

Globally unique identifier.
installUrl (URL)

Webpage where you can install the app.
installation (AppInstallation)

Corresponding AppInstallation for this shop and App. Returns null if the App is not installed.
pricingDetails (String)

Detailed information about the app pricing.
pricingDetailsSummary (String!)

Summary of the app pricing details.
privacyPolicyUrl (URL)

Link to app privacy policy.
published (Boolean!)

Whether the app is published.
screenshots ([Image!]!)

Screenshots of the app.
shopifyDeveloped (Boolean!)

Whether the app was developed by Shopify.
title (String!)

Name of the app.
uninstallMessage (String!)

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.

Types that return App

Implements

Deprecated fields

developerUrl (URL!) deprecated

Website of the developer who created the app.

Deprecation warning

Use appStoreDeveloperUrl instead
launchUrl (URL!) deprecated

Webpage that the app starts in.

Deprecation warning

Use AppInstallation.launchUrl instead
navigationItems ([NavigationItem!]!) deprecated

Menu items for the app, which also appear as submenu items in left navigation sidebar in the Shopify admin.

Deprecation warning

Use AppInstallation.navigationItems instead
uninstallUrl (URL) deprecated

Webpage where you can uninstall the app.

Deprecation warning

Use AppInstallation.uninstallUrl instead
Version 2020-07

A Shopify application.

Fields

apiKey (String!)

A unique application API identifier.
appStoreAppUrl (URL)

App store page URL of the app.
appStoreDeveloperUrl (URL)

App store page URL of the developer who created the app.
description (String)

Description of the app.
developerName (String)

App's developer name.
embedded (Boolean!)

Whether the app uses the Embedded App SDK.
failedRequirements ([FailedRequirement!]!)

Requirements that must be met before the app can be installed.
features ([String!]!)

List of app features.
feedback (AppFeedback)

Feedback from this app about the store.
handle (String)

Handle of the app.
icon (Image!)

Icon that represents the app.
id (ID!)

Globally unique identifier.
installUrl (URL)

Webpage where you can install the app.
installation (AppInstallation)

Corresponding AppInstallation for this shop and App. Returns null if the App is not installed.
pricingDetails (String)

Detailed information about the app pricing.
pricingDetailsSummary (String!)

Summary of the app pricing details.
privacyPolicyUrl (URL)

Link to app privacy policy.
published (Boolean!)

Whether the app is published.
screenshots ([Image!]!)

Screenshots of the app.
shopifyDeveloped (Boolean!)

Whether the app was developed by Shopify.
title (String!)

Name of the app.
uninstallMessage (String!)

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.

Types that return App

Implements

Deprecated fields

developerUrl (URL!) deprecated

Website of the developer who created the app.

Deprecation warning

Use appStoreDeveloperUrl instead
launchUrl (URL!) deprecated

Webpage that the app starts in.

Deprecation warning

Use AppInstallation.launchUrl instead
uninstallUrl (URL) deprecated

Webpage where you can uninstall the app.

Deprecation warning

Use AppInstallation.uninstallUrl instead
Version 2020-04

A Shopify application.

Fields

apiKey (String!)

A unique application API identifier.
appStoreAppUrl (URL)

App store page URL of the app.
appStoreDeveloperUrl (URL)

App store page URL of the developer who created the app.
description (String)

Description of the app.
developerName (String)

App's developer name.
embedded (Boolean!)

Whether the app uses the Embedded App SDK.
failedRequirements ([FailedRequirement!]!)

Requirements that must be met before the app can be installed.
features ([String!]!)

List of app features.
feedback (AppFeedback)

Feedback from this app about the store.
handle (String)

Handle of the app.
icon (Image!)

Icon that represents the app.
id (ID!)

Globally unique identifier.
installUrl (URL)

Webpage where you can install the app.
installation (AppInstallation)

Corresponding AppInstallation for this shop and App. Returns null if the App is not installed.
pricingDetails (String)

Detailed information about the app pricing.
pricingDetailsSummary (String!)

Summary of the app pricing details.
privacyPolicyUrl (URL)

Link to app privacy policy.
published (Boolean!)

Whether the app is published.
screenshots ([Image!]!)

Screenshots of the app.
shopifyDeveloped (Boolean!)

Whether the app was developed by Shopify.
title (String!)

Name of the app.
uninstallMessage (String!)

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.

Types that return App

Implements

Deprecated fields

developerUrl (URL!) deprecated

Website of the developer who created the app.

Deprecation warning

Use appStoreDeveloperUrl instead
launchUrl (URL!) deprecated

Webpage that the app starts in.

Deprecation warning

Use AppInstallation.launchUrl instead
uninstallUrl (URL) deprecated

Webpage where you can uninstall the app.

Deprecation warning

Use AppInstallation.uninstallUrl instead
Version 2020-01

A Shopify application.

Fields

apiKey (String!)

A unique application API identifier.
appStoreAppUrl (URL)

App store page URL of the app.
appStoreDeveloperUrl (URL)

App store page URL of the developer who created the app.
description (String)

Description of the app.
developerName (String)

App's developer name.
embedded (Boolean!)

Whether the app uses the Embedded App SDK.
failedRequirements ([FailedRequirement!]!)

Requirements that must be met before the app can be installed.
features ([String!]!)

List of app features.
feedback (AppFeedback)

Feedback from this app about the store.
handle (String)

Handle of the app.
icon (Image!)

Icon that represents the app.
id (ID!)

Globally unique identifier.
installUrl (URL)

Webpage where you can install the app.
installation (AppInstallation)

Corresponding AppInstallation for this shop and App. Returns null if the App is not installed.
pricingDetails (String)

Detailed information about the app pricing.
pricingDetailsSummary (String!)

Summary of the app pricing details.
privacyPolicyUrl (URL)

Link to app privacy policy.
published (Boolean!)

Whether the app is published.
screenshots ([Image!]!)

Screenshots of the app.
shopifyDeveloped (Boolean!)

Whether the app was developed by Shopify.
title (String!)

Name of the app.
uninstallMessage (String!)

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.

Types that return App

Implements

Deprecated fields

developerUrl (URL!) deprecated

Website of the developer who created the app.

Deprecation warning

Use appStoreDeveloperUrl instead
launchUrl (URL!) deprecated

Webpage that the app starts in.

Deprecation warning

Use AppInstallation.launchUrl instead
navigationItems ([NavigationItem!]!) deprecated

Menu items for the app, which also appear as submenu items in left navigation sidebar in the Shopify admin.

Deprecation warning

Use AppInstallation.navigationItems instead
uninstallUrl (URL) deprecated

Webpage where you can uninstall the app.

Deprecation warning

Use AppInstallation.uninstallUrl instead
Version 2019-10 (Unsupported)

A Shopify application.

Fields

apiKey (String!)

A unique application API identifier.
appStoreAppUrl (URL)

App store page URL of the app.
appStoreDeveloperUrl (URL)

App store page URL of the developer who created the app.
description (String)

Description of the app.
developerName (String)

App's developer name.
embedded (Boolean!)

Whether the app uses the Embedded App SDK.
failedRequirements ([FailedRequirement!]!)

Requirements that must be met before the app can be installed.
features ([String!]!)

List of app features.
feedback (AppFeedback)

Feedback from this app about the store.
handle (String)

Handle of the app.
icon (Image!)

Icon that represents the app.
id (ID!)

Globally unique identifier.
installUrl (URL)

Webpage where you can install the app.
installation (AppInstallation)

Corresponding AppInstallation for this shop and App. Returns null if the App is not installed.
pricingDetails (String)

Detailed information about the app pricing.
pricingDetailsSummary (String!)

Summary of the app pricing details.
privacyPolicyUrl (URL)

Link to app privacy policy.
published (Boolean!)

Whether the app is published.
screenshots ([Image!]!)

Screenshots of the app.
shopifyDeveloped (Boolean!)

Whether the app was developed by Shopify.
title (String!)

Name of the app.
uninstallMessage (String!)

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.

Types that return App

Implements

Deprecated fields

developerUrl (URL!) deprecated

Website of the developer who created the app.

Deprecation warning

Use appStoreDeveloperUrl instead
launchUrl (URL!) deprecated

Webpage that the app starts in.

Deprecation warning

Use AppInstallation.launchUrl instead
navigationItems ([NavigationItem!]!) deprecated

Menu items for the app, which also appear as submenu items in left navigation sidebar in the Shopify admin.

Deprecation warning

Use AppInstallation.navigationItems instead
uninstallUrl (URL) deprecated

Webpage where you can uninstall the app.

Deprecation warning

Use AppInstallation.uninstallUrl instead
Version 2019-07 (Unsupported)

A Shopify application.

Fields

apiKey (String!)

A unique application API identifier.
appStoreAppUrl (URL)

App store page URL of the app.
appStoreDeveloperUrl (URL)

App store page URL of the developer who created the app.
description (String)

Description of the app.
developerName (String)

App's developer name.
embedded (Boolean!)

Whether the app uses the Embedded App SDK.
failedRequirements ([FailedRequirement!]!)

Requirements that must be met before the app can be installed.
features ([String!]!)

List of app features.
feedback (AppFeedback)

Feedback from this app about the store.
handle (String)

Handle of the app.
icon (Image!)

Icon that represents the app.
id (ID!)

Globally unique identifier.
installUrl (URL)

Webpage where you can install the app.
installation (AppInstallation)

Corresponding AppInstallation for this shop and App. Returns null if the App is not installed.
pricingDetails (String)

Detailed information about the app pricing.
pricingDetailsSummary (String!)

Summary of the app pricing details.
privacyPolicyUrl (URL)

Link to app privacy policy.
published (Boolean!)

Whether the app is published.
screenshots ([Image!]!)

Screenshots of the app.
shopifyDeveloped (Boolean!)

Whether the app was developed by Shopify.
title (String!)

Name of the app.
uninstallMessage (String!)

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.

Types that return App

Implements

Deprecated fields

developerUrl (URL!) deprecated

Website of the developer who created the app.

Deprecation warning

Use appStoreDeveloperUrl instead
launchUrl (URL!) deprecated

Webpage that the app starts in.

Deprecation warning

Use AppInstallation.launchUrl instead
navigationItems ([NavigationItem!]!) deprecated

Menu items for the app, which also appear as submenu items in left navigation sidebar in the Shopify admin.

Deprecation warning

Use AppInstallation.navigationItems instead
uninstallUrl (URL) deprecated

Webpage where you can uninstall the app.

Deprecation warning

Use AppInstallation.uninstallUrl instead
Version 2019-04 (Unsupported)

A Shopify application.

Fields

apiKey (String!)

A unique application API identifier.
appStoreAppUrl (URL)

App store page URL of the app.
appStoreDeveloperUrl (URL)

App store page URL of the developer who created the app.
description (String)

Description of the app.
developerName (String)

App's developer name.
embedded (Boolean!)

Whether the app uses the Embedded App SDK.
failedRequirements ([FailedRequirement!]!)

Requirements that must be met before the app can be installed.
features ([String!]!)

List of app features.
feedback (AppFeedback)

Feedback from this app about the store.
handle (String)

Handle of the app.
icon (Image!)

Icon that represents the app.
id (ID!)

Globally unique identifier.
installUrl (URL)

Webpage where you can install the app.
installation (AppInstallation)

Corresponding AppInstallation for this shop and App. Returns null if the App is not installed.
pricingDetails (String)

Detailed information about the app pricing.
pricingDetailsSummary (String!)

Summary of the app pricing details.
privacyPolicyUrl (URL)

Link to app privacy policy.
published (Boolean!)

Whether the app is published.
screenshots ([Image!]!)

Screenshots of the app.
shopifyDeveloped (Boolean!)

Whether the app was developed by Shopify.
title (String!)

Name of the app.
uninstallMessage (String!)

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.

Types that return App

Implements

Deprecated fields

developerUrl (URL!) deprecated

Website of the developer who created the app.

Deprecation warning

Use appStoreDeveloperUrl instead
launchUrl (URL!) deprecated

Webpage that the app starts in.

Deprecation warning

Use AppInstallation.launchUrl instead
navigationItems ([NavigationItem!]!) deprecated

Menu items for the app, which also appear as submenu items in left navigation sidebar in the Shopify admin.

Deprecation warning

Use AppInstallation.navigationItems instead
uninstallUrl (URL) deprecated

Webpage where you can uninstall the app.

Deprecation warning

Use AppInstallation.uninstallUrl instead

Samples