All apps need to request access to specific store data during the app authorization process. This guide provides a list of available access scopes for the GraphQL Admin, Storefront, Payment Apps APIs, and Customer Account APIs.
## How it works
> Tip:
> For more information on how to configure your access scopes, refer to [app configuration](/docs/apps/build/cli-for-apps/app-configuration) and [manage access scopes](/docs/apps/build/authentication-authorization/app-installation/manage-access-scopes).
After you've [generated API credentials](/docs/apps/build/authentication-authorization/client-secrets), your app needs to [be authorized to access store data](/docs/apps/build/authentication-authorization#authorization).
Authorization is the process of giving permissions to apps. Users can authorize Shopify apps to access data in a store. For example, an app might be authorized to access orders and product data in a store.
An app can request authenticated or unauthenticated access scopes.
| Type of access scopes | Description | Example use cases |
|---|---|---|
| [Authenticated](#authenticated-access-scopes) | Controls access to resources in the [GraphQL Admin API](/docs/api/admin-graphql), [Web Pixel API](/docs/api/web-pixels-api), and [Payments Apps API](/docs/api/payments-apps).
Authenticated access is intended for interacting with a store on behalf of a user. |
Scope | Access |
---|---|
read_all_orders |
All relevant orders rather than the default window of orders created within the last 60 daysPermissions required This access scope is used in conjunction with existing order scopes, for example You need to request permission for this access scope from your Partner Dashboard before adding it to your app. |
|
As of API version 2024-10, |
|
CartTransform |
|
CheckoutBranding |
|
Article , Blog , Comment , Page |
|
Web Pixels API |
|
CustomerMergePreview , CustomerMergeRequest |
|
You need to request permission for this access scope from your Partner Dashboard before adding it to your app. |
|
Customer , Segment |
|
DeliveryCustomization |
|
Discounts features |
|
DraftOrder |
|
GenericFile |
|
FulfillmentService |
|
GiftCard |
|
InventoryLevel , InventoryItem |
|
ShopPolicy |
|
ShopLocale |
|
Location |
|
Market |
|
MarketingEvent , MarketingActivity |
read_merchant_approval_signals |
MerchantApprovalSignals |
|
MetaobjectDefinition |
|
Metaobject |
|
UrlRedirect |
|
CalculatedOrder ,
DeliveryCarrierService
|
|
AbandonedCheckout , Fulfillment , Order , OrderTransaction , DeliveryCarrierService |
|
GraphQL Admin API You need to request permission for these access scopes from your Partner Dashboard before adding them to your app. |
|
PaymentCustomization |
|
Payments Apps API PaymentsAppConfiguration |
|
PaymentMandate |
write_payment_sessions |
Payments Apps API PaymentSession , CaptureSession , RefundSession , VoidSession |
|
PaymentSchedule , PaymentTerms |
|
PriceRule |
|
CookieBanner , PrivacySettings |
|
Product , ProductVariant , Collection , ResourceFeedback |
|
SellingPlan |
|
Return |
|
ScriptTag |
|
DeliveryCarrierService |
read_shopify_payments_disputes |
ShopifyPaymentsDispute
|
read_shopify_payments_dispute_evidences |
ShopifyPaymentsDisputeEvidence
|
read_shopify_payments_payouts |
ShopifyPaymentsPayout , ShopifyPaymentsBalanceTransaction
|
read_store_credit_accounts |
StoreCreditAccount |
|
StoreCreditAccountDebitTransaction , StoreCreditAccountCreditTransaction |
|
OnlineStoreTheme |
read_translations |
TranslatableResource |
read_users |
StaffMember SHOPIFY PLUS |
|
Validation |
Scope | Access |
---|---|
unauthenticated_read_checkouts ,
|
Checkout object |
unauthenticated_read_customers ,
|
Customer object |
unauthenticated_read_customer_tags |
tags field on the Customer object |
unauthenticated_read_content |
Storefront content, such as Article, Blog, and Comment objects |
unauthenticated_read_metaobjects |
View metaobjects, such as Metaobject |
unauthenticated_read_product_inventory |
quantityAvailable field on the ProductVariant object and totalAvailable field on the Product object |
unauthenticated_read_product_listings |
Product and Collection objects |
unauthenticated_read_product_pickup_locations |
Location and StoreAvailability objects |
unauthenticated_read_product_tags |
tags field on the Product object |
unauthenticated_read_selling_plans |
Selling plan content on the Product object |
Scope | Access |
---|---|
customer_read_customers ,
|
Customer object |
customer_read_orders ,
|
Order object |
customer_read_draft_orders |
Draft Order object |
customer_read_markets |
Market object |
customer_read_store_credit_accounts |
Store Credit Account object |
customer_read_own_subscription_contracts ,
|
Subscription Contract object for records that belong to your app |
customer_write_subscription_contracts |
Subscription Contract object for all records. Only available for Hydrogen and Headless storefronts |
customer_read_companies ,
|
Company object |
customer_read_locations ,
|
Company Location object |