> ## Documentation Index
> Fetch the complete documentation index at: https://docs.komerza.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Scopes

> Complete reference for all available API key permission scopes

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

<Note>
  API keys can be generated and scopes can be configured from your [Komerza
  Dashboard](https://dashboard.komerza.com/account?api).
</Note>

## Scope Categories

### Store Management

<AccordionGroup>
  <Accordion title="stores.view">
    **Permission to view stores** Read access to store information, settings,
    and configuration. Required for most store-related read operations.
  </Accordion>

  {" "}

  <Accordion title="stores.update">
    **Permission to update stores** Modify store configuration, settings,
    branding, and operational parameters.
  </Accordion>

  {" "}

  <Accordion title="stores.create">
    **Permission to create new stores** Create new store instances. Typically used
    for multi-store applications or store management platforms.
  </Accordion>

  <Accordion title="stores.analytics.view">
    **Permission to view store analytics** Access store performance metrics,
    sales data, traffic statistics, and analytical insights.
  </Accordion>
</AccordionGroup>

### Categories

<AccordionGroup>
  <Accordion title="stores.categories.view">
    **Permission to view categories in stores** Read access to product
    categories, category hierarchy, and organization structure.
  </Accordion>

  {" "}

  <Accordion title="stores.categories.create">
    **Permission to create new categories in stores** Add new product categories
    to organize your store catalog.
  </Accordion>

  {" "}

  <Accordion title="stores.categories.update">
    **Permission to update categories in stores** Modify category information,
    reorganize hierarchy, and update category settings.
  </Accordion>

  <Accordion title="stores.categories.delete">
    **Permission to delete categories in stores** Remove categories from the
    store. Ensure products are reassigned before deleting categories.
  </Accordion>
</AccordionGroup>

### Products & Inventory

<AccordionGroup>
  <Accordion title="stores.products.view">
    **Permission to view products in stores** Read access to product catalog,
    variants, pricing, and inventory information.
  </Accordion>

  {" "}

  <Accordion title="stores.products.create">
    **Permission to create new products in stores** Add new products to the store
    catalog, including variants and pricing.
  </Accordion>

  {" "}

  <Accordion title="stores.products.update">
    **Permission to update products in stores** Modify existing products, update
    pricing, inventory levels, and product details.
  </Accordion>

  <Accordion title="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.
  </Accordion>
</AccordionGroup>

### Customer Management

<AccordionGroup>
  <Accordion title="stores.customers.view">
    **Permission to view customers in stores** Access customer profiles, contact
    information, and purchase history.
  </Accordion>

  {" "}

  <Accordion title="stores.customers.create">
    **Permission to create new customers in stores** Add new customer profiles to
    the store database.
  </Accordion>

  <Accordion title="stores.customers.update">
    **Permission to update customers in stores** Modify customer information,
    update balances, and manage customer accounts.
  </Accordion>
</AccordionGroup>

### Order Processing

<AccordionGroup>
  <Accordion title="stores.orders.view">
    **Permission to view orders in stores** Access order information, payment
    status, and order history.
  </Accordion>

  {" "}

  <Accordion title="stores.orders.create">
    **Permission to create orders** Process new orders, including payment
    processing and order creation.
  </Accordion>

  {" "}

  <Accordion title="stores.orders.deliver">
    **Permission to deliver orders in stores** Mark orders as delivered, update
    tracking information, and manage fulfillment.
  </Accordion>

  <Accordion title="stores.orders.refund">
    **Permission to refund orders** Process refunds, partial refunds, and handle
    order cancellations.
  </Accordion>
</AccordionGroup>

### Marketing & Promotions

<AccordionGroup>
  <Accordion title="stores.coupons.view">
    **Permission to view coupons in stores** Access coupon information, usage
    statistics, and discount configurations.
  </Accordion>

  {" "}

  <Accordion title="stores.coupons.create">
    **Permission to create new coupons in stores** Create discount codes,
    promotional campaigns, and coupon configurations.
  </Accordion>

  {" "}

  <Accordion title="stores.coupons.update">
    **Permission to update coupons in stores** Modify existing coupons, update
    discount amounts, and change validity periods.
  </Accordion>

  <Accordion title="stores.coupons.delete">
    **Permission to delete coupons in stores** Remove coupons from the system.
    Active coupons should be disabled rather than deleted.
  </Accordion>
</AccordionGroup>

### Affiliate Program

<AccordionGroup>
  <Accordion title="stores.affiliates.view">
    **Permission to view affiliates in stores** Access affiliate information,
    commission data, and performance statistics.
  </Accordion>

  <Accordion title="stores.affiliates.update">
    **Permission to update affiliates in stores** Modify affiliate settings,
    commission rates, and payout configurations.
  </Accordion>
</AccordionGroup>

### Support & Communication

<AccordionGroup>
  <Accordion title="stores.tickets.view">
    **Permission to view tickets in stores** Access support tickets, customer
    inquiries, and communication history.
  </Accordion>

  {" "}

  <Accordion title="stores.tickets.update">
    **Permission to update tickets in stores** Respond to tickets, update ticket
    status, and manage customer support workflows.
  </Accordion>

  {" "}

  <Accordion title="stores.tickets.delete">
    **Permission to delete tickets in stores** Remove tickets from the system.
    Consider archiving instead of deleting for audit purposes.
  </Accordion>

  <Accordion title="stores.reviews.flagged.create">
    **Permission to flag reviews in stores** Mark reviews as inappropriate,
    spam, or requiring moderation.
  </Accordion>
</AccordionGroup>

### User Account & Platform

<AccordionGroup>
  <Accordion title="user.view">
    **Permission to view user profile information** Access user account details,
    preferences, and profile information.
  </Accordion>

  <Accordion title="user.crypto.viewEnabled">
    **Permission to view enabled cryptocurrencies for a user** Access
    cryptocurrency payment settings and enabled payment methods.

    <Warning>
      This scope is deprecated and will be removed in future versions. Please avoid
      using it.
    </Warning>
  </Accordion>
</AccordionGroup>

### Webhooks & Integrations

<AccordionGroup>
  <Accordion title="user.webhooks.view">
    **Permission to view webhooks** Access webhook configurations, event
    subscriptions, and delivery logs.
  </Accordion>

  {" "}

  <Accordion title="user.webhooks.create">
    **Permission to manage webhooks: create** Set up new webhook endpoints and
    event subscriptions.
  </Accordion>

  {" "}

  <Accordion title="user.webhooks.update">
    **Permission to manage webhooks: update** Modify existing webhook
    configurations and event subscriptions.
  </Accordion>

  <Accordion title="user.webhooks.delete">
    **Permission to manage webhooks: delete** Remove webhook endpoints and
    cancel event subscriptions.
  </Accordion>
</AccordionGroup>

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