Skip to main content
Anchor to AppInstallation

AppInstallation

object

Represents an installed application on a shop.

Anchor to Fields and connectionsFields and connections

Anchor to accessScopesaccessScopes
•[AccessScope!]!non-null

The access scopes granted to the application by a merchant during installation.

Anchor to activeSubscriptionsactiveSubscriptions
•[AppSubscription!]!non-null

The active application subscriptions billed to the shop on a recurring basis.

Anchor to allSubscriptionsallSubscriptions
•AppSubscriptionConnection!non-null

All subscriptions created for a shop.

Anchor to appapp
•App!non-null

Application which is installed.

Anchor to creditscredits
•AppCreditConnection!non-null

Credits that can be used towards future app purchases.

Anchor to idid
•ID!non-null

A globally-unique ID.

Anchor to launchUrllaunchUrl
•URL!non-null

The URL to launch the application.

Anchor to metafieldmetafield
•Metafield

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

Anchor to metafieldsmetafields
•MetafieldConnection!non-null

A list of custom fields that a merchant associates with a Shopify resource.

Anchor to metafieldsByIdentifiersmetafieldsByIdentifiers
•[Metafield]!non-null

The metafields associated with the resource matching the supplied list of namespaces and keys.

Anchor to oneTimePurchasesoneTimePurchases
•AppPurchaseOneTimeConnection!non-null

One-time purchases to a shop.

Anchor to publicationpublication
•Publication

The publication associated with the installed application.

Anchor to revenueAttributionRecordsrevenueAttributionRecords
•AppRevenueAttributionRecordConnection!non-null

The records that track the externally-captured revenue for the app. The records are used for revenue attribution purposes.

Anchor to uninstallUrluninstallUrl
•URL

The URL to uninstall the application.

Deprecated fields and connections

Anchor to channelchannel
•ChannelDeprecated
Anchor to subscriptionssubscriptions
•[AppSubscription!]!non-nullDeprecated
Was this section helpful?

Anchor to QueriesQueries

Anchor to appInstallationappInstallation
•query

Lookup an AppInstallation by ID or return the AppInstallation for the currently authenticated App.

Anchor to appInstallationsappInstallations
•query

A list of app installations. To use this query, you need to contact Shopify Support to grant your custom app the read_apps access scope. Public apps can't be granted this access scope.

Anchor to currentAppInstallationcurrentAppInstallation
•query

Return the AppInstallation for the currently authenticated App.

Was this section helpful?

Anchor to InterfacesInterfaces

Was this section helpful?