Overview
API keys use a permission-based scope system that controls access to specific endpoints and operations. Each API key can be configured with one or more scopes to limit access according to your integration needs.API keys can be generated and scopes can be configured from your Komerza
Dashboard.
Scope Categories
Store Management
stores.view
stores.view
Permission to view stores Read access to store information, settings,
and configuration. Required for most store-related read operations.
stores.update
stores.update
Permission to update stores Modify store configuration, settings,
branding, and operational parameters.
stores.create
stores.create
Permission to create new stores Create new store instances. Typically used
for multi-store applications or store management platforms.
stores.analytics.view
stores.analytics.view
Permission to view store analytics Access store performance metrics,
sales data, traffic statistics, and analytical insights.
Categories
stores.categories.view
stores.categories.view
Permission to view categories in stores Read access to product
categories, category hierarchy, and organization structure.
stores.categories.create
stores.categories.create
Permission to create new categories in stores Add new product categories
to organize your store catalog.
stores.categories.update
stores.categories.update
Permission to update categories in stores Modify category information,
reorganize hierarchy, and update category settings.
stores.categories.delete
stores.categories.delete
Permission to delete categories in stores Remove categories from the
store. Ensure products are reassigned before deleting categories.
Products & Inventory
stores.products.view
stores.products.view
Permission to view products in stores Read access to product catalog,
variants, pricing, and inventory information.
stores.products.create
stores.products.create
Permission to create new products in stores Add new products to the store
catalog, including variants and pricing.
stores.products.update
stores.products.update
Permission to update products in stores Modify existing products, update
pricing, inventory levels, and product details.
stores.products.delete
stores.products.delete
Permission to delete products in stores Remove products from the store
catalog. Use with caution as this action may affect order history.
Customer Management
stores.customers.view
stores.customers.view
Permission to view customers in stores Access customer profiles, contact
information, and purchase history.
stores.customers.create
stores.customers.create
Permission to create new customers in stores Add new customer profiles to
the store database.
stores.customers.update
stores.customers.update
Permission to update customers in stores Modify customer information,
update balances, and manage customer accounts.
Order Processing
stores.orders.view
stores.orders.view
Permission to view orders in stores Access order information, payment
status, and order history.
stores.orders.create
stores.orders.create
Permission to create orders Process new orders, including payment
processing and order creation.
stores.orders.deliver
stores.orders.deliver
Permission to deliver orders in stores Mark orders as delivered, update
tracking information, and manage fulfillment.
stores.orders.refund
stores.orders.refund
Permission to refund orders Process refunds, partial refunds, and handle
order cancellations.
Marketing & Promotions
stores.coupons.view
stores.coupons.view
Permission to view coupons in stores Access coupon information, usage
statistics, and discount configurations.
stores.coupons.create
stores.coupons.create
Permission to create new coupons in stores Create discount codes,
promotional campaigns, and coupon configurations.
stores.coupons.update
stores.coupons.update
Permission to update coupons in stores Modify existing coupons, update
discount amounts, and change validity periods.
stores.coupons.delete
stores.coupons.delete
Permission to delete coupons in stores Remove coupons from the system.
Active coupons should be disabled rather than deleted.
Affiliate Program
stores.affiliates.view
stores.affiliates.view
Permission to view affiliates in stores Access affiliate information,
commission data, and performance statistics.
stores.affiliates.update
stores.affiliates.update
Permission to update affiliates in stores Modify affiliate settings,
commission rates, and payout configurations.
Support & Communication
stores.tickets.view
stores.tickets.view
Permission to view tickets in stores Access support tickets, customer
inquiries, and communication history.
stores.tickets.update
stores.tickets.update
Permission to update tickets in stores Respond to tickets, update ticket
status, and manage customer support workflows.
stores.tickets.delete
stores.tickets.delete
Permission to delete tickets in stores Remove tickets from the system.
Consider archiving instead of deleting for audit purposes.
stores.reviews.flagged.create
stores.reviews.flagged.create
Permission to flag reviews in stores Mark reviews as inappropriate,
spam, or requiring moderation.
User Account & Platform
user.view
user.view
Permission to view user profile information Access user account details,
preferences, and profile information.
user.crypto.viewEnabled
user.crypto.viewEnabled
Permission to view enabled cryptocurrencies for a user Access
cryptocurrency payment settings and enabled payment methods.
Webhooks & Integrations
user.webhooks.view
user.webhooks.view
Permission to view webhooks Access webhook configurations, event
subscriptions, and delivery logs.
user.webhooks.create
user.webhooks.create
Permission to manage webhooks: create Set up new webhook endpoints and
event subscriptions.
user.webhooks.update
user.webhooks.update
Permission to manage webhooks: update Modify existing webhook
configurations and event subscriptions.
user.webhooks.delete
user.webhooks.delete
Permission to manage webhooks: delete Remove webhook endpoints and
cancel event subscriptions.
Best Practices
Principle of Least Privilege
Only request the minimum scopes necessary for your application. This reduces security risks and makes it easier to audit API access.Scope Planning
Plan your required scopes during the design phase of your integration. Consider:- Which resources you need to read vs. modify
- Whether you need create/delete permissions
- If your application handles sensitive customer data