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. |