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

# Introduction

> Get started with the YaVendio Business API in minutes

# YaVendio Business API

The Business API lets YaVendio merchants programmatically read their **orders**, **conversations**, **contacts** and **company profile**, manage their **product catalog** and **send WhatsApp template messages** (once the account is enabled for sending). Use it to build integrations, sync data with external systems, or power custom dashboards.

## Quick Start

Get your first API response in three steps:

### 1. Create an API Key

Go to the [YaVendio Dashboard](https://ya.onl) → **Settings** → **API Keys** and click **"Create API Key"**. Assign a descriptive name; the key is created with full API access.

### 2. Make Your First Request

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET "https://api.ya.onl/v1/orders?page=1&limit=5" \
    -H "X-API-Key: yv_live_v1_your_api_key"
  ```

  ```python Python theme={null}
  import httpx

  response = httpx.get(
      "https://api.ya.onl/v1/orders",
      params={"page": 1, "limit": 5},
      headers={"X-API-Key": "yv_live_v1_your_api_key"},
  )
  print(response.json())
  ```

  ```javascript Node.js theme={null}
  const response = await fetch(
    "https://api.ya.onl/v1/orders?page=1&limit=5",
    {
      headers: { "X-API-Key": "yv_live_v1_your_api_key" },
    }
  );
  const data = await response.json();
  console.log(data);
  ```
</CodeGroup>

### 3. Explore the Response

```json theme={null}
{
  "data": [
    {
      "id": 12345,
      "order_date": "2026-03-10T15:30:00Z",
      "status": "confirmed",
      "currency": "PEN",
      "total_amount": 139.70
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 5,
    "total_pages": 10,
    "total_items": 48,
    "has_more": true
  }
}
```

## What's Next?

<CardGroup cols={2}>
  <Card title="Authentication" icon="key" href="/en/authentication">
    Learn how API keys work, scopes, and best practices.
  </Card>

  <Card title="Pagination" icon="arrow-right" href="/en/pagination">
    Navigate through large result sets efficiently.
  </Card>

  <Card title="Rate Limiting" icon="gauge" href="/en/rate-limiting">
    Understand request limits and how to handle them.
  </Card>

  <Card title="Error Handling" icon="triangle-exclamation" href="/en/errors">
    Handle errors gracefully in your integration.
  </Card>

  <Card title="Manage Products" icon="box" href="/en/products/data-model">
    Learn how to create and manage products with variants, options, media, and categories.
  </Card>

  <Card title="Template Messages" icon="paper-plane" href="/en/outbound/cart-abandonment">
    Write to a customer first with an approved template — recovering a cart, telling
    someone their order is ready — and check where the message got to.
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.