Access Scopes

Access scopes act as gatekeepers, controlling what data your extension can access within a seller’s store. These access scopes, granted by the seller, dictate your extension’s ability to read, write, or modify information like orders, products, and customer details. Understanding these scopes ensures your extension functions correctly and respects user privacy.

note

Only Platform APIs require access scopes.

How to request access scope?

Follow these steps to update the access scopes of your extension:

1. Refer to the Platform SDK reference to identify the necessary access scopes for the desired APIs.

2. Determine the permissions required for these access scopes by consulting the Access Scope <> Permission mapping.

3. In your extension's setup details, select the permissions identified in step 2 under the Permissions section.

Here is a reference showing how the permissions section appears in the extension setup details:

Access Scope <> Permission Mapping

Company Permission

Access data or perform API operations at the company level or across all the applications (aka sales channels).

Permission	Permission Description	Access Scope	Access Scope Description
Analytics	Get insights on the performance of the company across all sales channels with an option to download the graphs and reports.	company/analytics/read	Read company-level analytics reports.
Analytics	Get insights on the performance of the company across all sales channels with an option to download the graphs and reports.	company/analytics/write	Create company-level analytics data.
Profile	Manage profile details including brands, selling locations, and other company-related properties.	company/brands/read	Read brands of a company.
Profile	Manage profile details including brands, selling locations, and other company-related properties.	company/brands/write	Create, update, and delete brands of a company.
Profile	Manage profile details including brands, selling locations, and other company-related properties.	company/locations/read	Read inventory locations of a company.
Profile	Manage profile details including brands, selling locations, and other company-related properties.	company/locations/write	Create, update, and delete inventory locations of a company.
Profile	Manage profile details including brands, selling locations, and other company-related properties.	company/properties/read	Read specific company properties such as name, address, and contact information.
Profile	Manage profile details including brands, selling locations, and other company-related properties.	company/properties/write	Create, update, and delete specific company properties such as name, address, and contact information.
Profile	Manage profile details including brands, selling locations, and other company-related properties.	company/legal/read	Read legal documents about the company.
Profile	Manage profile details including brands, selling locations, and other company-related properties.	company/legal/write	Write legal documents about the company.
Orders	View and manage orders received across all the applications in a company.	company/orders/read	Fetch orders and their details across all the applications in the company.
Orders	View and manage orders received across all the applications in a company.	company/orders/write	Process orders across all the applications in the company.
Products	Create and manage products, price and inventory details at the company-level.	company/products/read	Fetch catalog data of a company. Catalog data is defined at company-level and is consumed by all the applications across the company.
Products	Create and manage products, price and inventory details at the company-level.	company/products/write	Manage catalog data of a company. Catalog data is defined at company-level and is consumed by all the applications across the company.
Products	Create and manage products, price and inventory details at the company-level.	company/inventory/read	Read inventory details of products in a company.
Products	Create and manage products, price and inventory details at the company-level.	company/inventory/write	Manage inventory details of products in a company.
Products	Create and manage products, price and inventory details at the company-level.	company/price_rules/read	Read price rules of an application including discounts, coupons, and promotions at the company-level.
Products	Create and manage products, price and inventory details at the company-level.	company/price_rules/write	Manage price rules of an application including discounts, coupons, and promotions at the company-level.
Sales Channels	View and manage applications in a company.	company/applications/read	Fetch list of applications and their details in a company.
Sales Channels	View and manage applications in a company.	company/applications/write	Create and manage applications of a company.
Logistics	Read and edit delivery-related configurations at the company-level.	company/logistics/read	Read logistics configurations at the company-level.
Logistics	Read and edit delivery-related configurations at the company-level.	company/logistics/write	Manage logistics configurations at the company-level.
Custom Fields and Objects	Perform create, read, update and delete operations on meta objects and fields at the company-level.	company/meta/read	Read meta objects and fields data.
Custom Fields and Objects	Perform create, read, update and delete operations on meta objects and fields at the company-level.	company/meta/write	Perform create, read, update and delete operations on meta objects and fields.
Settings	View and edit company-level configurations.	company/integrations/read	Get details of company-level integrations.
Settings	View and edit company-level configurations.	company/integrations/write	Edit details of company-level integrations.
Settings	View and edit company-level configurations.	company/settings/read	Read company settings.
Settings	View and edit company-level configurations.	company/settings/write	Modify company settings.
Settings	View and edit company-level configurations.	company/shipping/read	Fetch delivery zones of a company.
Settings	View and edit company-level configurations.	company/shipping/write	Manage delivery zones of a company.

Application Permission (aka sales channel)

Access data or Perform API operations for specific applications (aka sales channels).

Permission	Permission Description	Access Scope	Access Scope Description
Appearance	Manage the themes, layouts, and navigation for an application.	application/themes/read	Get details of themes available in the application.
Appearance	Manage the themes, layouts, and navigation for an application.	application/themes/write	Manage and edit themes available in the application.
Appearance	Manage the themes, layouts, and navigation for an application.	application/navigation/read	Read application navigation settings.
Appearance	Manage the themes, layouts, and navigation for an application.	application/navigation/write	Modify application navigation settings.
Communication	Manage campaigns, communication templates, and trigger event-based communications to enhance user engagement within the application.	application/communications/read	Read communications configurations of the application.
Communication	Manage campaigns, communication templates, and trigger event-based communications to enhance user engagement within the application.	application/communications/write	Edit communications configurations of the application.
Customer Support	Manage the help desk for storing and processing the customer service requests.	application/customer_support/read	Read customer support requests of an application.
Customer Support	Manage the help desk for storing and processing the customer service requests.	application/customer_support/write	Manage customer support requests of an application.
Customer	View and manage all the customer data received in an application.	application/customers/read	Fetch details of customers registered in the application.
Customer	View and manage all the customer data received in an application.	application/protected_customer_data/read	Read personal data of customers registered in the application.
Customer	View and manage all the customer data received in an application.	application/customers/write	Manage registered customers in the application.
Marketing	Create and manage an application's marketing including promotions, collections, coupons, rewards, and blogs.	application/products/read	Fetch products and their details for a specific application.
Marketing	Create and manage an application's marketing including promotions, collections, coupons, rewards, and blogs.	application/products/write	Manage products of a specific application.
Marketing	Create and manage an application's marketing including promotions, collections, coupons, rewards, and blogs.	application/price_rules/read	Read price rules of an application including discounts, coupons, and promotions at the company-level.
Marketing	Create and manage an application's marketing including promotions, collections, coupons, rewards, and blogs.	application/price_rules/write	Manage price rules of an application including discounts, coupons, and promotions at the company-level.
Marketing	Create and manage an application's marketing including promotions, collections, coupons, rewards, and blogs.	application/content/read	Read application content like blogs, short links, pages.
Marketing	Create and manage an application's marketing including promotions, collections, coupons, rewards, and blogs.	application/content/write	Edit application content like blogs, short links, pages.
Marketing	Create and manage an application's marketing including promotions, collections, coupons, rewards, and blogs.	application/rewards/read	Fetch details of rewards of an application.
Marketing	Create and manage an application's marketing including promotions, collections, coupons, rewards, and blogs.	application/rewards/write	Manage rewards of an application.
Products	Manage products, price, and inventory details of an application.	application/products/read	Fetch products and their details for a specific application.
Products	Manage products, price, and inventory details of an application.	application/products/write	Manage products of a specific application.
Settings	Manage application-level settings for catalog, cart, payments, logistics, and other configurations.	application/settings/read	Read application settings.
Settings	Manage application-level settings for catalog, cart, payments, logistics, and other configurations.	application/settings/write	Manage application settings.
Settings	Manage application-level settings for catalog, cart, payments, logistics, and other configurations.	application/integrations/read	Fetch list of integrations in the application.
Settings	Manage application-level settings for catalog, cart, payments, logistics, and other configurations.	application/integrations/write	Modify integrations of an application.
Settings	Manage application-level settings for catalog, cart, payments, logistics, and other configurations.	application/inventory/read	Read inventory of products in an application.
Settings	Manage application-level settings for catalog, cart, payments, logistics, and other configurations.	application/inventory/write	Manage inventory of products in an application.
Settings	Manage application-level settings for catalog, cart, payments, logistics, and other configurations.	application/cart/read	Read cart configurations and data for a specific application.
Settings	Manage application-level settings for catalog, cart, payments, logistics, and other configurations.	application/cart/write	Edit cart configurations and data for a specific application.
Settings	Manage application-level settings for catalog, cart, payments, logistics, and other configurations.	application/currency/read	Read currency configurations of a specific application.
Settings	Manage application-level settings for catalog, cart, payments, logistics, and other configurations.	application/currency/write	Edit currency configurations of a specific application.
Settings	Manage application-level settings for catalog, cart, payments, logistics, and other configurations.	application/credit_note/read	Read credit note configurations of a specific application.
Settings	Manage application-level settings for catalog, cart, payments, logistics, and other configurations.	application/credit_note/write	Edit credit note configurations of a specific application.
Settings	Manage application-level settings for catalog, cart, payments, logistics, and other configurations.	application/logistics/read	Read logistics configurations of a specific application.
Settings	Manage application-level settings for catalog, cart, payments, logistics, and other configurations.	application/logistics/write	Edit logistics configurations of a specific application.
Settings	Manage application-level settings for catalog, cart, payments, logistics, and other configurations.	application/data_loader/read	Read data loader configurations of a specific application.
Settings	Manage application-level settings for catalog, cart, payments, logistics, and other configurations.	application/data_loader/write	Edit data loader configurations of a specific application.
Settings	Manage application level settings for catalog, cart, payments, logistics and other configurations.	application/legal_docs/read	Read application legal documents.
Settings	Manage application level settings for catalog, cart, payments, logistics and other configurations	application/legal_docs/write	Edit application legal documents.
Settings	Manage application level settings for catalog, cart, payments, logistics and other configurations	application/payments/read	Read payment and payout-related configurations of a specific application.
Settings	Manage application level settings for catalog, cart, payments, logistics and other configurations	application/payments/write	Manage payment and payout-related configurations of a specific application.
Settings	Manage application level settings for catalog, cart, payments, logistics and other configurations	application/products/read	Fetch products and their details for a specific application.
Settings	Manage application level settings for catalog, cart, payments, logistics and other configurations	application/products/write	Manage products of a specific application.
Custom Fields and Objects	Perform create, read, update and delete operations on meta objects and fields for a specific application.	application/meta/read	Read meta objects and fields data.
Custom Fields and Objects	Perform create, read, update and delete operations on meta objects and fields for a specific application.	application/meta/write	Perform create, read, update and delete operations on meta objects and fields.
Payments	Manage payment and payout-related configurations of a specific application.	application/payment/read	Read payment and payout-related configurations of a specific application.
Payments	Manage payment and payout-related configurations of a specific application.	application/payment/write	Manage payment and payout-related configurations of a specific application.