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

# Billbee

> Access Billbee multichannel orders, products, and customers, and update order states for e-commerce order management

## At a glance

* **Availability**: Experimental ([how to enable](/cloud/integrations)).
* **Auth**: Basic auth.
* **Connection**: HTTP Basic auth with `BILLBEE_USERNAME` as the username and `BILLBEE_API_PASSWORD` as the password.
* **Docs**: [https://app.billbee.io/swagger/ui/index](https://app.billbee.io/swagger/ui/index)

## Credentials

Set these per environment. See [Connect an integration](/cloud/integrations).

| Variable               | Required | Description                                                                                                                                                                                                 |
| ---------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `BILLBEE_USERNAME`     | Yes      | Billbee account username (email), used as the HTTP Basic username [Docs](https://app.billbee.io/swagger/ui/index).                                                                                          |
| `BILLBEE_API_PASSWORD` | Yes      | Billbee API password set under Settings → API (not the account login password), used as the HTTP Basic password [Docs](https://app.billbee.io/app_v2/settings/api/general).                                 |
| `BILLBEE_API_KEY`      | Yes      | Billbee developer API key identifying your application, sent in the X-Billbee-Api-Key header (request via [support@billbee.io](mailto:support@billbee.io)) [Docs](https://app.billbee.io/swagger/ui/index). |

## Setup

1. **Create a Billbee account**: Sign up at [https://app.billbee.io](https://app.billbee.io) - a free trial is available for testing.
2. **Activate the API and set an API password**: In Billbee open Settings → API ([https://app.billbee.io/app\_v2/settings/api/general](https://app.billbee.io/app_v2/settings/api/general)), activate the API module, and set a dedicated API password. This is separate from your account login password.
3. **Request an API key**: Email [support@billbee.io](mailto:support@billbee.io) with a short note about what you are building to receive a developer API key. This key identifies your application and is sent as the X-Billbee-Api-Key header.
4. **Store the credentials**: Add BILLBEE\_USERNAME (your Billbee login email), BILLBEE\_API\_PASSWORD, and BILLBEE\_API\_KEY to your .env file, then run the List Orders tool to verify access.

* Every request needs BOTH HTTP Basic auth (username + API password) AND the X-Billbee-Api-Key header
* Rate limit: max 2 requests per second per API key + user combination; some endpoints have stricter per-call throttles
* Responses wrap payloads in a Data field alongside Paging and ErrorMessage fields

Provider API reference: [https://app.billbee.io/swagger/ui/index](https://app.billbee.io/swagger/ui/index)

## Tools

| Tool               | Access | Description                                                                                                                                                                 |
| ------------------ | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| List Orders        | Read   | List orders across all connected shops, optionally filtered by date range, modification time, or order state                                                                |
| Get Order          | Read   | Get a single order with positions, addresses, and payment details by its internal Billbee ID                                                                                |
| Update Order State | Write  | Change the main state of an order, e.g. mark it as confirmed, paid, or shipped                                                                                              |
| List Products      | Read   | List products (articles) in the Billbee account                                                                                                                             |
| List Customers     | Read   | List customers in the Billbee account                                                                                                                                       |
| List Invoices      | Read   | List invoices with positions and amounts over a date range - the export feed into accounting tools. Throttled to 1 request per minute for the same page and minInvoiceDate. |
| Get Order States   | Read   | List all defined order state IDs and names - resolves the NewStateId values used by Update Order State                                                                      |
| Update Stock       | Write  | Set the absolute stock quantity of a product by SKU or Billbee product ID - the most common multichannel write; the change is pushed to connected shops                     |

## Example prompts

* List my recent Billbee orders that are not yet shipped and summarize them by state and shop.
* Look up a Billbee order I specify and update its state to paid.
* Find a Billbee customer and summarize their recent orders.