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

# Introduction

> Build POS, ERP, and back-office integrations against klikit's order, menu, and inventory surfaces.

The **klikit Partner API** is a single HTTPS gateway that lets a POS, ERP, or
back-office system integrate with klikit. It covers the operations a vendor
typically needs from the outside: reading orders and menus, flipping items
in-stock or out-of-stock, toggling branch visibility, and receiving real-time
event pushes when orders move through their lifecycle.

This documentation is for **engineers building those integrations**. If you're
a klikit operator or restaurant owner looking for the product itself, go to
[admin.klikit.io](https://admin.klikit.io).

## What you can do today

<CardGroup cols={2}>
  <Card title="Read orders" icon="receipt" href="/partner-api/api-reference/orders">
    List and fetch orders across your business with filters by brand, branch,
    status, and date range.
  </Card>

  <Card title="Read menus" icon="book" href="/partner-api/api-reference/menus">
    Pull the menu for one store (with all overrides applied) or for the
    business as a whole.
  </Card>

  <Card title="Push availability" icon="toggle-on" href="/partner-api/api-reference/menu-oos">
    Mark items in stock or out of stock, individually or in bulk, with
    idempotency keys.
  </Card>

  <Card title="Subscribe to events" icon="bell" href="/partner-api/webhooks/overview">
    Receive `klikit.order.created.v2`, `klikit.order.status.updated`, and
    `klikit.order.cart.updated` events at a URL you host.
  </Card>
</CardGroup>

## How the API is shaped

Three things are worth knowing up front:

* **You authenticate with HTTP Basic.** Username is your partner API key,
  password is the matching secret. See [Authentication](/partner-api/authentication).
* **Every credential is scoped to one business.** You cannot read or write
  anything outside that business — the API enforces it server-side.
* **Every response uses the same envelope.** Even errors. See
  [Response envelope](/partner-api/concepts/envelope).

## Environments

| Environment | Base URL                                          | Notes                                                           |
| ----------- | ------------------------------------------------- | --------------------------------------------------------------- |
| Development | `https://api.dev.shadowchef.co/v1/partner`        | Use this as your sandbox. Real klikit data is not exposed here. |
| Production  | `https://gateway-enterprise.klikit.io/v1/partner` | Live restaurant data. Coordinated rollouts only.                |

We don't run a separate sandbox — the development environment **is** the
sandbox. See [Environments](/partner-api/concepts/environments).

## Next step

<CardGroup cols={2}>
  <Card title="Integration playbook" icon="map" href="/partner-api/integration-playbook">
    The phased path from credentials to production. Branched for POS systems
    and aggregator marketplaces. Read this first.
  </Card>

  <Card title="Quickstart" icon="rocket" href="/partner-api/quickstart">
    Make your first authenticated call, list orders, and verify a webhook in
    under 10 minutes.
  </Card>

  <Card title="Authentication" icon="key" href="/partner-api/authentication">
    HTTP Basic auth with partner key + secret, scoped per business.
  </Card>

  <Card title="Webhooks integration guide" icon="webhook" href="/partner-api/webhooks/overview">
    Stand up a receiver and verify your first event with the reference Node /
    Python implementations.
  </Card>
</CardGroup>