Scopes Reference
Request only the scopes your app needs. Scopes control what data your app can access and modify.
Available Scopes
| Scope | Description |
|---|---|
products:read | Read product data including variants, inventory, and collections |
products:write | Create and update products, manage variants and inventory levels |
collections:read | Read collection data and associated products |
collections:write | Create, update, and delete collections |
orders:read | Read order data including line items, fulfillment status, and payment details |
orders:write | Create and update orders, modify order status and fulfillment |
shipping:read | Read shipping zones, rates, and delivery profiles |
shipping:write | Create and update shipping zones and rates |
taxes:read | Read tax settings and tax rates |
taxes:write | Create and update tax settings and rates |
markets:read | Read market data and regional settings |
markets:write | Create and update markets and regional configurations |
offers:read | Read discount and promotion data |
offers:write | Create and update discounts and promotions |
store:read | Read store settings and configuration |
store:write | Update store settings and configuration |
pixels:write | Register and manage web pixel extensions |
Where to Define Scopes
Scopes are defined in the scopes field of your qumra.app.json manifest:
qumra.app.json
{
"scopes": ["products:read", "products:write", "orders:read"]
}
نصيحة
Follow the principle of least privilege -- request only the scopes your app actually needs.