App - admin-graphql - OBJECT

Version: 2024-10

Description:

A Shopify application.

Access Scopes

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.
• availableAccessScopes: AccessScope! - All requestable access scopes available to the app.
• banner: Image! - Banner image for the app.
• description: String - Description of the app.
• developerName: String - The name of the app developer.
• developerType: AppDeveloperType! - The type of app developer.
• developerUrl: URL! - Website of the developer who created the app.
• 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! - A list of app features that are shown in the Shopify App Store listing.
• feedback: AppFeedback - Feedback from this app about the store.
• handle: String - Handle of the app.
• icon: Image! - Icon that represents the app.
• id: ID! - A globally-unique ID.
• 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.
• isPostPurchaseAppInUse: Boolean! - Whether the app is the [post purchase](https://shopify.dev/apps/checkout/post-purchase) app in use.
• launchUrl: URL! - Webpage that the app starts in.
• navigationItems: NavigationItem! - Menu items for the app, which also appear as submenu items in left navigation sidebar in the Shopify admin.
• optionalAccessScopes: AccessScope! - 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.
• previouslyInstalled: Boolean! - Whether the app was previously installed on the current shop.
• pricingDetails: String - Detailed information about the app pricing.
• pricingDetailsSummary: String! - Summary of the app pricing details.
• privacyPolicyUrl: URL - Link to app privacy policy.
• publicCategory: AppPublicCategory! - The public category for the app.
• published: Boolean! - Whether the app is published to the Shopify App Store.
• requestedAccessScopes: AccessScope! - 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! - 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.
• uninstallUrl: URL - Webpage where you can uninstall the app.
• webhookApiVersion: String! - The webhook API version for the app.

Connections

Related queries

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

Related mutations

Related Unions

Examples

• Get an app by its ID

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query { app(id: \\\"gid://shopify/App/193172482\\\") { title } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query {\n    app(id: \"gid://shopify/App/193172482\") {\n      title\n    }\n  }`,\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query {\n    app(id: \"gid://shopify/App/193172482\") {\n      title\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<query([\"query\" => $query]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query {\n    app(id: \"gid://shopify/App/193172482\") {\n      title\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query {\n  app(id: \"gid://shopify/App/193172482\") {\n    title\n  }\n}"
        

  input: null

  response: {
    "data": {
      "app": {
        "title": "Invoicing Application"
      }
    }
  }

  Get the currently authenticated app

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query { app { title } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query {\n    app {\n      title\n    }\n  }`,\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query {\n    app {\n      title\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<query([\"query\" => $query]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query {\n    app {\n      title\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query {\n  app {\n    title\n  }\n}"
        

  input: null

  response: {
    "data": {
      "app": {
        "title": "Invoicing Application"
      }
    }
  }