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

# Overview

> Read your program's orders, channels, affiliates, campaigns and commissions over REST

The **Brand API** gives a brand read access to its own affiliate program: orders, campaigns, commission rules and a performance report of orders, revenue and commission. Authenticate with an `x-api-key` of type **brand**, created in the dashboard.

Lomadee has two products, and the API keeps them apart:

| Vertical | What it is | Base path |
| - | - | - |
| **Network** | Your program on the Lomadee affiliate network | `/brand/network` |
| **White label** | Your own affiliate program, on your domain | `/brand/whitelabel` |

Each key belongs to **one** vertical. A network key cannot call `/brand/whitelabel`, and the other way around. If your brand has both products, create one key for each.

If you are an affiliate, use the [Affiliate API](https://docs.lomadee.com.br/api-reference/introduction.md). If you are a partner integrating the catalog, use the [Partner API](https://docs.lomadee.com.br/docs/partner-api/overview.md).

## Base URL

```
https://api.lomadee.com.br
```

## Resources

| Resource | Network | White label | Scope |
| - | - | - | - |
| Program | `GET /brand/network/program` | `GET /brand/whitelabel/program` | `{vertical}:program:read` |
| Orders | `GET /brand/network/orders` | `GET /brand/whitelabel/orders` | `{vertical}:orders:read` |
| Channels | `GET /brand/network/channels` | — | `{vertical}:channels:read` |
| Affiliates | — | `GET /brand/whitelabel/affiliates` | `{vertical}:affiliates:read` |
| Campaigns | `GET /brand/network/campaigns` | `GET /brand/whitelabel/campaigns` | `{vertical}:campaigns:read` |
| Commission rules | `GET /brand/network/commissions` | `GET /brand/whitelabel/commissions` | `{vertical}:commissions:read` |
| Performance report | `GET /brand/network/reports/performance` | `GET /brand/whitelabel/reports/performance` | `{vertical}:reports:read` |

In a scope, `{vertical}` is `network` or `whitelabel`: a network key has `network:orders:read`, a white-label key has `whitelabel:orders:read`.

Every route is read-only (`GET`) and returns only data of the brand that owns the key.

> [!WARNING]
>
> On the **network**, the API never returns who the affiliate is. Orders and reports are attributed to an **affiliate channel** (a blog, a cashback site, a coupon site). See [Affiliate privacy](https://docs.lomadee.com.br/docs/brand-api/concepts/affiliate-privacy.md).

> [card] [Quickstart](https://docs.lomadee.com.br/docs/brand-api/quickstart.md)
>
> Create a key and list your orders

> [card] [Network vs white label](https://docs.lomadee.com.br/docs/brand-api/concepts/network-vs-whitelabel.md)
>
> What each vertical returns

> [card] [Manage API keys](https://docs.lomadee.com.br/docs/brand-api/guides/manage-api-keys.md)
>
> Create, rotate and revoke keys in the dashboard

> [card] [Rate limits and errors](https://docs.lomadee.com.br/docs/brand-api/guides/rate-limits-and-errors.md)
>
> Limits, headers and error codes


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