Choose a version:

appInstallation

query

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

Arguments

Anchor to idid • ID: ID used to lookup AppInstallation.

Was this section helpful?

Anchor to Possible returnsPossible returns

AppInstallation

•

AppInstallation

Represents an installed application on a shop.

accessScopes• [AccessScope!]! non-null: The access scopes granted to the application by a merchant during installation.
activeSubscriptions• [AppSubscription!]! non-null: The active application subscriptions billed to the shop on a recurring basis.
allSubscriptions • AppSubscriptionConnection! non-null: All subscriptions created for a shop.
app• App! non-null: Application which is installed.
credits • AppCreditConnection! non-null: Credits that can be used towards future app purchases.
id• ID! non-null: A globally-unique ID.
launchUrl• URL! non-null: The URL to launch the application.
metafield• 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.
metafields • MetafieldConnection! non-null: A list of custom fields that a merchant associates with a Shopify resource.
metafieldsByIdentifiers• [Metafield]! non-null: The metafields associated with the resource matching the supplied list of namespaces and keys.
oneTimePurchases • AppPurchaseOneTimeConnection! non-null: One-time purchases to a shop.
publication• Publication: The publication associated with the installed application.
revenueAttributionRecords • AppRevenueAttributionRecordConnection! non-null: The records that track the externally-captured revenue for the app. The records are used for revenue attribution purposes.
uninstallUrl• URL: The URL to uninstall the application.
channel• Channel: Channel associated with the installed application.
subscriptions• [AppSubscription!]! non-null: Subscriptions charge to a shop on a recurring basis.

Was this section helpful?

Get a metafield attached to an app installation
Get metafields attached to an app installation
Get the URL used to launch the application
Get the URL used to uninstall the application
Get the access scopes associated with the app installation
Get the active subscriptions for the app installation
Get the app associated with the installation
Retrieves all application credits

Examples

Open in GraphiQL

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

query AppInstallationMetafield($namespace: String!, $key: String!, $ownerId: ID!) {

appInstallation(id: $ownerId) {

apiKey: metafield(namespace: $namespace, key: $key) {

value

}

}`,

{

variables: {

"namespace": "secret_keys",

"key": "api_key",

"ownerId": "gid://shopify/AppInstallation/1002334195"

);

const data = await response.json();

query AppInstallationMetafield($namespace: String!, $key: String!, $ownerId: ID!) {
  appInstallation(id: $ownerId) {
    apiKey: metafield(namespace: $namespace, key: $key) {
      value
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query AppInstallationMetafield($namespace: String!, $key: String!, $ownerId: ID!) { appInstallation(id: $ownerId) { apiKey: metafield(namespace: $namespace, key: $key) { value } } }",
 "variables": {
    "namespace": "secret_keys",
    "key": "api_key",
    "ownerId": "gid://shopify/AppInstallation/1002334195"
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  query AppInstallationMetafield($namespace: String!, $key: String!, $ownerId: ID!) {
    appInstallation(id: $ownerId) {
      apiKey: metafield(namespace: $namespace, key: $key) {
        value
      }
    }
  }`,
  {
    variables: {
      "namespace": "secret_keys",
      "key": "api_key",
      "ownerId": "gid://shopify/AppInstallation/1002334195"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `query AppInstallationMetafield($namespace: String!, $key: String!, $ownerId: ID!) {
      appInstallation(id: $ownerId) {
        apiKey: metafield(namespace: $namespace, key: $key) {
          value
        }
      }
    }`,
    "variables": {
      "namespace": "secret_keys",
      "key": "api_key",
      "ownerId": "gid://shopify/AppInstallation/1002334195"
    },
  },
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query AppInstallationMetafield($namespace: String!, $key: String!, $ownerId: ID!) {
    appInstallation(id: $ownerId) {
      apiKey: metafield(namespace: $namespace, key: $key) {
        value
      }
    }
  }
QUERY

variables = {
  "namespace": "secret_keys",
  "key": "api_key",
  "ownerId": "gid://shopify/AppInstallation/1002334195"
}

response = client.query(query: query, variables: variables)

Input variables

JSON

{

"namespace": "secret_keys",

"key": "api_key",

"ownerId": "gid://shopify/AppInstallation/1002334195"

}

Response

JSON

{

"appInstallation": {

"apiKey": {

"value": "aSBhbSBhIHNlY3JldCBrZXk="

}