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

# Mutasib REST API: Build on a Full Shop Management Platform

> Mutasib's REST API gives you programmatic access to shop details, products, sales, inventory, suppliers, and the public marketplace.

Mutasib is an all-in-one shop management platform built for retailers, boutique owners, and their teams. Whether you run a single register or a multi-cashier storefront, Mutasib handles point-of-sale, inventory tracking, and sales analytics under one roof. The Mutasib REST API exposes the core catalog, sales, and inventory operations so you can integrate Mutasib into your own apps, automate workflows, and build custom dashboards on top of your shop data.

<Info>
  **The API and your dashboard share the same data.** Every action you perform through the API is reflected in your Mutasib dashboard in real time — and vice versa. Record a sale via `POST /api/v1/shops/{shop_id}/sales/` and it appears immediately in your sales history, updates your stock levels, and feeds into your analytics and reports. There is no separate "API mode": the API is a direct interface to the same shop your team uses every day.
</Info>

## Key capabilities

<CardGroup cols={2}>
  <Card title="Authentication" icon="lock">
    Authenticate every request with an API token generated from your Mutasib dashboard. Choose a 30-, 60-, or 90-day expiration and revoke anytime.
  </Card>

  <Card title="Shop Details" icon="store">
    Read and update your shop — name, address, category, contact info, opening hours, and geolocation.
  </Card>

  <Card title="Products & Catalog" icon="tag">
    Add, update, and delete products. Manage pricing, categories, images, and barcode lookups across your entire catalog.
  </Card>

  <Card title="Sales & POS" icon="cash-register">
    Record sales transactions, fetch daily totals, and generate shareable receipts at the point of sale.
  </Card>

  <Card title="Inventory" icon="boxes-stacked">
    Track stock levels in real time, apply manual adjustments, surface low-stock products, and manage suppliers.
  </Card>

  <Card title="Public Marketplace" icon="magnifying-glass">
    Let customers discover your shop through public search, nearby-shop lookups, and shareable receipts, no authentication required.
  </Card>

  <Card title="AI Insights" icon="sparkles">
    Predict demand and get reorder suggestions with confidence scores and reasoning. Pro plan only.
  </Card>
</CardGroup>

## Base URL

All API requests are made over HTTPS. The current version of the API is `v1`.

<Info>
  **Base URL:** `https://api.mutasib.com`

  Prefix every endpoint with `/api/v1/`. For example, to get your shop:

  ```text theme={null}
  GET https://api.mutasib.com/api/v1/shops/{shop_id}
  ```
</Info>

## Authentication

The Mutasib API uses **API tokens** for authentication. Generate a token from your [Mutasib dashboard](https://mutasib.com/dashboard) and include it in the `Authorization` header on every request:

```text theme={null}
Authorization: Bearer YOUR_API_TOKEN
```

API tokens expire after 30, 60, or 90 days depending on the expiration you pick when creating them, and you can revoke them anytime from the dashboard. Never include your token as a query parameter, and never commit it to source control, treat it like a password. If a token is compromised, revoke it from the dashboard and generate a new one.

<Note>
  API tokens are not available on a free trial. An active paid plan is required to create and use them.
</Note>

## Plans & limits

Your shop's plan controls which API features are available and at what scale. Plan features are returned on every `ShopOut` response in the `plan_features` object, so your integration can branch on capabilities at runtime without hard-coding plan names. Manage your subscription from the [Mutasib dashboard](https://mutasib.com/dashboard).

## Next steps

<CardGroup cols={2}>
  <Card title="Quick Start" icon="rocket" href="/quickstart">
    Make your first API call in minutes — generate a token, add a product, and record a sale.
  </Card>

  <Card title="Authentication" icon="key" href="/authentication">
    Learn how API tokens work, which paths are in scope, and how to handle common error codes.
  </Card>
</CardGroup>