API access scopes

Part of the authorization process requires specifying which parts of a shop's data the client would like access to. Clients can ask for any of the authenticated/unauthenticated access scopes listed:

You can check your granted access scopes for an app via the AccessScope resource.

Authenticated access scopes

Authenticated access scopes control access to resources in the REST Admin API and the GraphQL Admin API. Authenticated access is intended for interacting with a store on behalf of the merchant to perform actions such as creating products and managing discount codes.

  • read_themes, write_themes Access to Asset and Theme.

  • read_products, write_products Access to Product, Product Variant, Product Image, and Product Custom Collection.

  • read_product_listings

    Access to Product Listing, and Collection Listing.

  • read_inventory, write_inventory

    Access to Inventory Level and Inventory Item.

  • read_customers, write_customers Access to Customer Detail and Customer Group.

  • read_orders, write_orders Access to Order, Transaction and Fulfillment.

  • read_fulfillments, write_fulfillments

    Access to Fulfillment Service.

  • read_script_tags, write_script_tags Access to Script Tag.

  • read_content, write_content

    Access to Page and Redirect.

  • read_fulfillments, write_fulfillments Access to Fulfillment Service.

  • read_shipping, write_shipping Access to Carrier Service, Shipping Rate, Country and Province.

  • read_checkouts, write_checkouts Access to Checkouts.

  • read_price_rules, write_price_rules Access to Price Rules.

  • read_analytics

    Access to Analytics.

Last updated