Skip to main content

Scopes Reference

Request only the scopes your app needs. Scopes control what data your app can access and modify.

Available Scopes

ScopeDescription
products:readRead product data including variants, inventory, and collections
products:writeCreate and update products, manage variants and inventory levels
collections:readRead collection data and associated products
collections:writeCreate, update, and delete collections
orders:readRead order data including line items, fulfillment status, and payment details
orders:writeCreate and update orders, modify order status and fulfillment
shipping:readRead shipping zones, rates, and delivery profiles
shipping:writeCreate and update shipping zones and rates
taxes:readRead tax settings and tax rates
taxes:writeCreate and update tax settings and rates
markets:readRead market data and regional settings
markets:writeCreate and update markets and regional configurations
offers:readRead discount and promotion data
offers:writeCreate and update discounts and promotions
store:readRead store settings and configuration
store:writeUpdate store settings and configuration
pixels:writeRegister 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"]
}
tip

Follow the principle of least privilege -- request only the scopes your app actually needs.