AccessScope

The AccessScope resource allows you to retrieve the permissions that a merchant has granted to an app, such as read_orders and write_products. These permissions allow apps to access data from a shop, and are granted when a merchant installs the app.

The list of access scopes retrieved is based on the access token for the request. It returns only those access scopes that are associated with the token.

Note

If your app is already installed on a shop and you'd like your app to be granted additional access scopes, then you'll need to redirect the merchant to the app install page with the additional requested scopes. After a merchant installs the updated app, any subsequent calls made to the AccessScope resource will return the updated list of granted access scopes.

What you can do with AccessScope

The Shopify API lets you do the following with the AccessScope resource. More detailed versions of these general actions may be available:

AccessScope properties

access_scopes
"access_scopes": [
  {
    "handle": "write_product_listings"
  },
  {
    "handle": "read_shipping"
  }
]

The access scopes associated to the access token.

Endpoints

GET /admin/oauth/access_scopes.json
Retrieves a list of access scopes associated to the access token.

List all scopes

GET /admin/oauth/access_scopes.json
View Response
HTTP/1.1 200 OK
{
  "access_scopes": [
    {
      "handle": "read_products"
    },
    {
      "handle": "write_orders"
    },
    {
      "handle": "read_orders"
    }
  ]
}

Sign up for a Partner account to get started.

Sign up