Access Scopes
Access scopes act as gatekeepers, controlling the data your extension can access within a seller’s store. These scopes, granted by the seller, define your extension's permissions to read, write, or modify information such as orders, products, and customer details. Only Platform APIs require access scopes.
Company Permissions
Company Profile
Manage profile details, including brands, selling locations, and other company-related properties.
Scope | Description |
---|---|
company/brands/read | Get brands of a company. |
company/brands/write | Create, update and delete brands of a company. |
company/locations/read | Get inventory locations of a company. |
company/locations/write | Create, update and delete inventory locations of a company. |
company/properties/read | Get specific company properties such as name, address and contact information. |
company/properties/write | Create, update, and delete specific company properties such as name, address, and contact information. |
company/legal/read | Get legal documents about the company. |
company/legal/write | Write legal documents about the company. |
Sales Channels
View and manage applications in a company.
company/applications/read | Get list of applications and their details in a company. |
company/applications/write | Manage applications of a company. |
Products
Create and manage products, price and inventory details at the company-level. Catalog data is defined at the company level and is consumed by all the applications across the company.
company/products/read | Get catalog data of a company. |
company/products/write | Manage catalog data of a company. |
company/inventory/read | Get inventory details of products in a company. |
company/inventory/write | Manage inventory details of products in a company. |
company/price_rules/read | Get price rules of an application including discounts, coupons and promotions at the company level. |
company/price_rules/write | Manage price rules of an application including discounts, coupons and promotions at the company level. |
Orders
View and manage orders received across all the applications in a company.
company/orders/read | Get orders and their details across all the applications in the company. |
company/orders/write | Process orders across all the applications in the company. |
Logistics
Read and edit delivery-related configurations at the company-level.
company/logistics/read | Get logistics configurations at the company-level. |
company/logistics/write | Manage logistics configurations at the company-level. |
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 | Get company-level analytics reports. |
company/analytics/write | Create company-level analytics data. |
Settings
View and edit company-level configurations.
company/settings/read | Get company settings. |
company/settings/write | Modify company settings. |
company/shipping/read | Get delivery zones of a company. |
company/shipping/write | Manage delivery zones of a company. |
Custom Fields and Objects
Perform create, read, update and delete operations on meta objects and fields at the company-level.
company/meta/read | Get meta objects and fields data. |
company/meta/write | Create, read, update and delete operations on meta objects and fields. |
Application Permissions
Customer
View and manage all the customer data received in an application.
Scope | Description |
---|---|
application/customers/read | Get details of customers registered in the application. |
application/protected_customer_data/read | Get personal data of customers registered in the 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 | Get products and their details for a specific application. |
application/products/write | Manage products of a specific application. |
application/price_rules/read | Get price rules of an application including discounts, coupons and promotions at the company-level. |
application/price_rules/write | Manage price rules of an application including discounts, coupons and promotions at the company-level. |
application/content/read | Get application content like blogs, short links and pages. |
application/content/write | Edit application content like blogs, short links and pages. |
application/rewards/read | Get details of rewards of an application. |
application/rewards/write | Manage rewards of an application. |
Communication
Manage campaigns, communication templates and trigger event-based communications to enhance user engagement within the application.
application/communications/read | Get communications configurations of 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 | Get customer support requests of an application. |
application/customer_support/write | Manage customer support requests of an application. |
Appearance
Manage the themes, layouts and navigation for an application.
application/themes/read | Get details of themes available in the application. |
application/themes/write | Manage and edit themes available in the application. |
application/navigation/read | Get application navigation settings. |
application/navigation/write | Modify application navigation settings. |
Products
Manage products, price and inventory details of an application.
application/products/read | Get products and their details for a specific application. |
application/products/write | Manage products of a specific application. |
Payments
Manage payment and payout-related configurations of a specific application.
application/payment/read | Get payment and payout-related configurations of a specific application. |
application/payment/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/settings/read | Get application settings. |
application/settings/write | Manage application settings. |
application/integrations/read | Get list of integrations in the application. |
application/integrations/write | Modify integrations of an application. |
application/inventory/read | Get inventory of products in an application. |
application/inventory/write | Manage inventory of products in an application. |
application/cart/read | Get cart configurations and data for a specific application. |
application/cart/write | Edit cart configurations and data for a specific application. |
application/currency/read | Get currency configurations of a specific application. |
application/currency/write | Edit currency configurations of a specific application. |
application/credit_note/read | Get credit note configurations of a specific application. |
application/credit_note/write | Edit credit note configurations of a specific application. |
application/logistics/read | Get logistics configurations of a specific application. |
application/logistics/write | Edit logistics configurations of a specific application. |
application/data_loader/read | Get data loader configurations of a specific application. |
application/data_loader/write | Edit data loader configurations of a specific application. |
application/legal_docs/read | Get application legal documents. |
application/legal_docs/write | Edit application legal documents. |
application/payments/read | Get payment and payout-related configurations of a specific application. |
application/payments/write | Manage payment and payout-related configurations of a specific application. |
application/products/read | Get products and their details for a specific application. |
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 | Get meta objects and fields data. |
application/meta/write | Create, read, update and delete operations on meta objects and fields. |