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

# Introduction

> Welcome to the Scango API Documentation

To use the API, you first need to generate an API key. This can be created under Settings > Organization > API Key.

### Base URL

`https://dashboard.scango.ch/api/v1`

### Authentication

* Type: Bearer Token
* Usage: Include the Bearer Token in the Authorization header for all requests.

### OpenAPI specification

The machine-readable API definition is in [`api-reference/openapi.json`](/api-reference/openapi.json). Use it with OpenAPI-aware tools, codegen, or assistants.

### List responses (`meta`)

Every **list** endpoint returns `data` (the array) and **`meta`** with at least:

| Field      | Meaning                                                                                                                                                                               |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `total`    | For product **search** with `q`, the search index’s **estimated** total matches. For all other list endpoints, this equals the number of items in this response (same as `returned`). |
| `returned` | How many items are in `data` for this response.                                                                                                                                       |
| `limit`    | Applied page size from the `limit` query parameter (default **100**, maximum **5000**). Product search with `q` caps the effective page size at **250**.                              |

List endpoints support an optional **`limit`** query parameter (default 100, max 5000). When you **search products** with `q`, `meta` also includes **`offset`** for pagination.

## API Structure

The Scango API provides access to the following main resources:

<CardGroup>
  <Card title="Agent recipes" icon="sparkles" href="/api-reference/en/agent-recipes">
    Step-by-step flows for automation and AI assistants
  </Card>

  <Card title="Products" icon="box" href="/api-reference/endpoint/products">
    Manage your product catalog
  </Card>

  <Card title="Orders" icon="shopping-cart" href="/api-reference/endpoint/orders">
    Access order information
  </Card>

  <Card title="Suppliers" icon="truck" href="/api-reference/endpoint/suppliers">
    View supplier details
  </Card>

  <Card title="Categories" icon="folder-tree" href="/api-reference/endpoint/categories">
    Browse product categories
  </Card>
</CardGroup>

## Important Notes

<Note>
  Currently, product images cannot be uploaded via the API.
</Note>

<Note>
  Webhooks are not yet available. We recommend checking for new orders at your desired interval.
</Note>