currentAppInstallation

query

Return the AppInstallation for the currently authenticated App.

Anchor to Possible returnsPossible returns

Anchor to AppInstallationAppInstallation • AppInstallation!: Represents an installed application on a shop.

Was this section helpful?

Get a list of access scopes
Retrieves a list of application charges
Retrieves a list of recurring application charges

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  query AccessScopeList {
6    currentAppInstallation {
7      accessScopes {
8        handle
9      }
10    }
11  }`,
12);
13
14const data = await response.json();
15

query AccessScopeList {
  currentAppInstallation {
    accessScopes {
      handle
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query AccessScopeList { currentAppInstallation { accessScopes { handle } } }"
}'

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

const response = await admin.graphql(
  `#graphql
  query AccessScopeList {
    currentAppInstallation {
      accessScopes {
        handle
      }
    }
  }`,
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query AccessScopeList {
    currentAppInstallation {
      accessScopes {
        handle
      }
    }
  }`,
});

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 AccessScopeList {
    currentAppInstallation {
      accessScopes {
        handle
      }
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

1{
2  "currentAppInstallation": {
3    "accessScopes": [
4      {
5        "handle": "read_all_orders"
6      },
7      {
8        "handle": "read_all_subscription_contracts"
9      },
10      {
11        "handle": "read_analytics_overviews"
12      },
13      {
14        "handle": "read_billing"
15      },
16      {
17        "handle": "read_checkouts"
18      },
19      {
20        "handle": "read_discovery"
21      },
22      {
23        "handle": "read_discovery_synonym_groups"
24      },
25      {
26        "handle": "read_payment_settings"
27      },
28      {
29        "handle": "read_subscription_plans"
30      },
31      {
32        "handle": "read_users"
33      },
34      {
35        "handle": "read_customer_merge"
36      },
37      {
38        "handle": "write_admin_shop_settings"
39      },
40      {
41        "handle": "write_analytics_overviews"
42      },
43      {
44        "handle": "write_apps"
45      },
46      {
47        "handle": "write_brand"
48      },
49      {
50        "handle": "write_brand_settings"
51      },
52      {
53        "handle": "write_content"
54      },
55      {
56        "handle": "write_customer_data_redaction_requests"
57      },
58      {
59        "handle": "write_customer_payment_methods"
60      },
61      {
62        "handle": "write_customers"
63      },
64      {
65        "handle": "write_discounts"
66      },
67      {
68        "handle": "write_discovery"
69      },
70      {
71        "handle": "write_discovery_synonym_groups"
72      },
73      {
74        "handle": "write_draft_orders"
75      },
76      {
77        "handle": "write_files"
78      },
79      {
80        "handle": "write_fulfillments"
81      },
82      {
83        "handle": "write_gift_cards"
84      },
85      {
86        "handle": "write_home"
87      },
88      {
89        "handle": "write_inventory"
90      },
91      {
92        "handle": "write_locations"
93      },
94      {
95        "handle": "write_marketing_events"
96      },
97      {
98        "handle": "write_media_processing"
99      },
100      {
101        "handle": "write_merchant_managed_fulfillment_orders"
102      },
103      {
104        "handle": "write_metaobjects"
105      },
106      {
107        "handle": "write_metaobject_definitions"
108      },
109      {
110        "handle": "write_notifications"
111      },
112      {
113        "handle": "write_online_store"
114      },
115      {
116        "handle": "write_online_store_pages"
117      },
118      {
119        "handle": "write_online_store_navigation"
120      },
121      {
122        "handle": "write_order_edits"
123      },
124      {
125        "handle": "write_orders"
126      },
127      {
128        "handle": "write_order_refunds"
129      },
130      {
131        "handle": "write_payment_mandate"
132      },
133      {
134        "handle": "write_price_rules"
135      },
136      {
137        "handle": "write_products"
138      },
139      {
140        "handle": "write_publications"
141      },
142      {
143        "handle": "write_reports"
144      },
145      {
146        "handle": "write_script_tags"
147      },
148      {
149        "handle": "write_shipping"
150      },
151      {
152        "handle": "write_themes"
153      },
154      {
155        "handle": "write_third_party_fulfillment_orders"
156      },
157      {
158        "handle": "write_customer_merge"
159      },
160      {
161        "handle": "write_companies"
162      },
163      {
164        "handle": "read_analytics"
165      },
166      {
167        "handle": "read_admin_shop_settings"
168      },
169      {
170        "handle": "read_apps"
171      },
172      {
173        "handle": "read_brand"
174      },
175      {
176        "handle": "read_brand_settings"
177      },
178      {
179        "handle": "read_content"
180      },
181      {
182        "handle": "read_customer_data_redaction_requests"
183      },
184      {
185        "handle": "read_customer_payment_methods"
186      },
187      {
188        "handle": "read_customers"
189      },
190      {
191        "handle": "read_discounts"
192      },
193      {
194        "handle": "read_draft_orders"
195      },
196      {
197        "handle": "read_files"
198      },
199      {
200        "handle": "read_fulfillments"
201      },
202      {
203        "handle": "read_gift_cards"
204      },
205      {
206        "handle": "read_home"
207      },
208      {
209        "handle": "read_inventory"
210      },
211      {
212        "handle": "read_locations"
213      },
214      {
215        "handle": "read_marketing_events"
216      },
217      {
218        "handle": "read_media_processing"
219      },
220      {
221        "handle": "read_merchant_managed_fulfillment_orders"
222      },
223      {
224        "handle": "read_metaobjects"
225      },
226      {
227        "handle": "read_metaobject_definitions"
228      },
229      {
230        "handle": "read_notifications"
231      },
232      {
233        "handle": "read_online_store"
234      },
235      {
236        "handle": "read_online_store_pages"
237      },
238      {
239        "handle": "read_online_store_navigation"
240      },
241      {
242        "handle": "read_order_edits"
243      },
244      {
245        "handle": "read_orders"
246      },
247      {
248        "handle": "read_payment_mandate"
249      },
250      {
251        "handle": "read_price_rules"
252      },
253      {
254        "handle": "read_products"
255      },
256      {
257        "handle": "read_publications"
258      },
259      {
260        "handle": "read_reports"
261      },
262      {
263        "handle": "read_script_tags"
264      },
265      {
266        "handle": "read_shipping"
267      },
268      {
269        "handle": "read_themes"
270      },
271      {
272        "handle": "read_third_party_fulfillment_orders"
273      },
274      {
275        "handle": "read_companies"
276      }
277    ]
278  }
279}