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

# Introduction

> Everything you need to start integrating with the Quickbutik API

Welcome to the **Quickbutik API**! Our REST API allows you to manage your store's orders, products, categories, and more programmatically. Build powerful integrations to automate your e-commerce operations.

## Base URL

All API requests are made to our base URL:

```
https://api.quickbutik.com/v1
```

**OpenAPI Specification:** [https://quickbutik.dev/openapi.yaml](https://quickbutik.dev/openapi.yaml)

## Key Features

<CardGroup cols={2}>
  <Card title="Order Management" icon="cart-shopping">
    Create, update, and retrieve orders with full order lifecycle support
  </Card>

  <Card title="Product Catalog" icon="box">
    Manage your product inventory, pricing, and product information
  </Card>

  <Card title="Category Management" icon="folder">
    Organize products with hierarchical category structures
  </Card>

  <Card title="Real-time Updates" icon="bolt">
    Get instant updates via webhooks when important events occur
  </Card>
</CardGroup>

## Getting Started

<Steps>
  <Step title="Get your API key">
    Generate an API key in the Quickbutik Control Panel under **Settings → API**
  </Step>

  <Step title="Set up authentication">
    All requests require [Basic Authentication](/api-v1/authentication) using your API key
  </Step>

  <Step title="Make your first request">
    Try fetching your product count to test your setup:

    ```bash theme={null}
    curl https://api.quickbutik.com/v1/products/count \
      -u your_api_key:your_api_key
    ```
  </Step>
</Steps>

## Response Format

All API responses are returned in JSON format, including error messages. Successful responses will contain the requested data, while errors will include helpful error codes and descriptions.

### Success Response Example

```json theme={null}
{
  "count": "42"
}
```

### Error Response Example

```json theme={null}
{
  "code": 404,
  "error": "Resource not found"
}
```

## HTTP Status Codes

The API uses conventional HTTP response codes:

* `200` - OK: The request was successful
* `400` - Bad Request: The request was invalid
* `401` - Unauthorized: Authentication failed
* `404` - Not Found: The requested resource doesn't exist
* `500` - Internal Server Error: Something went wrong on our end

## Rate Limiting

To ensure fair usage and optimal performance for all users, please be mindful of your request frequency. If you encounter rate limiting, implement exponential backoff in your retry logic.

## Support

We're here to help! For feature requests, feedback, or technical questions:

<Card title="Contact Support" icon="envelope">
  Email us at [support@quickbutik.com](mailto:support@quickbutik.com)

  We greatly appreciate your feedback and are always working to improve our API.
</Card>

Ready to get started? Check out our [Authentication guide](/api-v1/authentication) to begin integrating with the Quickbutik API.