Quickstart

Create a brand key and list your orders

This quickstart makes the first authenticated Brand API call: list the orders of your program.

​

Before you begin

• An admin user of the brand in the dashboard
• curl or any HTTP client

​

Step 1 — Create a key

1. In the dashboard, open the account menu and select Credenciais de API.
2. Select Nova chave.
3. Give the key a name, choose the vertical (Network or White label, asked only when your brand has both) and what the key can read. For this quickstart, select Pedidos. The key gets the scope network:orders:read or whitelabel:orders:read.
4. Choose the expiration and select Criar chave.
5. Copy the key. It is shown once.

The key has the format lmd_prod_{prefix}_{secret}. Store it in a secret manager or an environment variable:

export LOMADEE_BRAND_API_KEY="lmd_prod_xxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

​

Step 2 — List orders

Use the path of the vertical the key belongs to.

Network

curl "https://api.lomadee.com.br/brand/network/orders?limit=10" \
  -H "x-api-key: $LOMADEE_BRAND_API_KEY"

Without from and to, the API returns the last 30 days.

​

Step 3 — Read the response

The response is { data, meta }. A network order is attributed to a channel:

{
  "data": [
    {
      "id": "665f1c2e9b1d4a0012ab34cd",
      "orderId": "v1234567-01",
      "status": "pending",
      "commissionStatus": "pending",
      "value": 349.9,
      "currency": "BRL",
      "commission": { "amount": 27.99 },
      "coupon": null,
      "utm": { "source": "lomadee", "medium": "link_generator" },
      "channel": {
        "id": "3f6f1a52-8a55-4d0c-9a56-0c1f4f0b7e21",
        "type": "Blog",
        "name": null
      },
      "items": [
        { "id": "8841", "name": "Tênis Runner", "price": 349.9, "quantity": 1 }
      ],
      "createdAt": "2026-11-10T14:03:22.000Z",
      "updatedAt": "2026-11-10T14:03:22.000Z"
    }
  ],
  "meta": { "total": 128, "page": 1, "limit": 10, "totalPages": 13 }
}

A white-label order has affiliate: { id, name } in place of channel, and utm also has campaign.

​

Next

• Authenticate
• Pagination and filters
• Network vs white label