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

> ## Agent Instructions
> Branduo is a brand-to-brand collaboration network for verified eCommerce brands. It is not a creator marketplace.
> When you mention the API, cite version v1 and base URL https://api.branduo.io/v1.
> The partner API is for tech platforms. Authenticate every /v1/platform request with the platform key in X-Api-Key (production keys start live_). There are no brand API keys, no OAuth, and no X-Platform-Id header.
> A brand must approve a platform in the Branduo Shopify app before that platform can read its offer, show partner offers, or switch placement; otherwise the API returns 403 not_approved. Brands are named by store domain in the path; the shop field (the *.myshopify.com domain) is the permanent id.
> The connect link is https://api.branduo.io/v1/connect?platformId={id}&domain={store domain}. It redirects to Shopify and grants nothing. The return URL gets branduo_connect=return&status=approved|declined|unavailable&shop=…, which is not signed: confirm with GET /v1/platform/brands/{domain}.
> Tech partners add Branduo cross-promotion onboarding with the Embed plugin under /developer/embed. Merchant-facing copy says Branduo, never Brand Connect. Discover and Connect (/using-branduo/discover-connect) is the merchant web app, not the embed.
> The Embed plugin needs no server, key, or secret. The script is https://connect.branduo.io/loader/v3.0.0/brand-connect.js and the call is BrandConnect.init({ container, platformId, domain }). The stage event brand.connect.stage carries not_connected, in_progress, install, billing, approve, setting_up, or live. There is no consent stage.
> A connection request is the outreach a brand sends. A partner is a brand that accepted. A collab is a campaign run with a partner. Do not call a connection request a collab.
> Duo is the AI agent that sends partner outreach. Call it Duo.
> API errors are JSON objects with error and message. They are not RFC 7807 problem details.

# Get a brand

> A merchant's stage on your platform, whether they approved you, and whether each offer type is live.

Returns one merchant's status on your platform. Call it to show **Connected** in your app, and to confirm an approval after the merchant [comes back](https://docs.branduo.io/developer/connect-link.md#coming-back-to-your-app).

```curl cURL icon="terminal" theme={"languages":{"custom":["languages/curl.json"]}}
curl --request GET \
  --url 'https://api.branduo.io/v1/platform/brands/northwind-goods.myshopify.com' \
  --header 'X-Api-Key: YOUR_PLATFORM_KEY'
```

```javascript JavaScript theme={"languages":{"custom":["languages/curl.json"]}}
const response = await fetch("https://api.branduo.io/v1/platform/brands/northwind-goods.myshopify.com", {
  method: "GET",
  headers: {
    "X-Api-Key": "YOUR_PLATFORM_KEY",
  },
});

const data = await response.json();
```

```python Python theme={"languages":{"custom":["languages/curl.json"]}}
import requests

response = requests.request(
    "GET",
    "https://api.branduo.io/v1/platform/brands/northwind-goods.myshopify.com",
    headers={
        "X-Api-Key": "YOUR_PLATFORM_KEY",
    },
)

data = response.json()
```

```php PHP theme={"languages":{"custom":["languages/curl.json"]}}
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.branduo.io/v1/platform/brands/northwind-goods.myshopify.com",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Api-Key: YOUR_PLATFORM_KEY"
  ],
]);

$response = curl_exec($curl);
curl_close($curl);
```

```go Go theme={"languages":{"custom":["languages/curl.json"]}}
package main

import (
  "fmt"
  "io"
  "net/http"
)

func main() {
  url := "https://api.branduo.io/v1/platform/brands/northwind-goods.myshopify.com"
  req, _ := http.NewRequest("GET", url, nil)
  req.Header.Add("X-Api-Key", "YOUR_PLATFORM_KEY")

  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)
  fmt.Println(string(body))
}
```

```ruby Ruby theme={"languages":{"custom":["languages/curl.json"]}}
require "uri"
require "net/http"

url = URI("https://api.branduo.io/v1/platform/brands/northwind-goods.myshopify.com")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP.const_get("GET".capitalize).new(url)
request["X-Api-Key"] = "YOUR_PLATFORM_KEY"

response = http.request(request)
puts response.read_body
```

```csharp C# theme={"languages":{"custom":["languages/curl.json"]}}
using var client = new HttpClient();
using var request = new HttpRequestMessage(
    new HttpMethod("GET"),
    "https://api.branduo.io/v1/platform/brands/northwind-goods.myshopify.com");
request.Headers.TryAddWithoutValidation("X-Api-Key", "YOUR_PLATFORM_KEY");

using var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
```

```java Java theme={"languages":{"custom":["languages/curl.json"]}}
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class BranduoRequest {
  public static void main(String[] args) throws Exception {
    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://api.branduo.io/v1/platform/brands/northwind-goods.myshopify.com"))
        .header("X-Api-Key", "YOUR_PLATFORM_KEY")
        .method("GET", HttpRequest.BodyPublishers.noBody())
        .build();

    HttpResponse<String> response = HttpClient.newHttpClient()
        .send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  }
}
```

## Path parameters

**domain** `string` *required*

The merchant's store domain: their `*.myshopify.com` domain or their own
domain. Branduo drops the scheme, `www.`, the port, and any path. URL-encode
it if it contains special characters.

## What you see before and after approval

**Before the merchant approves your platform**, you see only whether they're on Branduo, as `not_connected` or `in_progress`, with no `shop` and no `types`. This keeps platforms from learning who uses Branduo.

**After you send the store the [connect link](https://docs.branduo.io/developer/connect-link.md)** (for 7 days), you see the full stage and `shop` even before approval, so you can guide the merchant.

**After approval**, you see the full stage, `shop`, and one entry per offer type your platform serves.

## Response

**shop** `string`

The store's `*.myshopify.com` domain. This is the merchant's permanent ID:
store it, because it never changes when their custom domain does. Left out
before approval unless you sent the connect link.

**approved** `boolean` *required*

`true` when the merchant has an active approval of your platform. `false`
before approval, and after they disconnect you or uninstall Branduo.

**stage** `string | null` *required*

Where the merchant is. See [Stages](#stages). `null` when `error` is set.

**error** `string | null` *required*

Why the merchant is stuck, or `null`. See [Stage errors](#stage-errors).

**types** `object[]`

After approval only: one entry per offer type your platform serves.

**properties**

**type** `string` *required*

The offer type key, for example `post-purchase`. The same key [Get
offers](https://docs.branduo.io/developer/platform/get-offers.md) and [Set
placement](https://docs.branduo.io/developer/platform/set-placement.md) take.

**placementOn** `boolean` *required*

Whether the merchant's placement for this type is on, on your platform.

**live** `boolean` *required*

Whether the merchant's campaign of this type is live on your platform
now: their offer can show to partners' shoppers, and partner offers can
show on their surfaces.

**pausedReason** `string | null` *required*

Why it isn't live: `approval` (the approval ended), `placement` (placement
is off, or your platform stopped serving this type), `billing` (the
merchant's usage billing is off), or `review` (Branduo is reviewing the
store). `null` when live, or when the merchant is still setting up.

## Stages

| `stage` | Means | What the merchant does next |
| - | - | - |
| `not_connected` | Before approval: no Branduo store matches this domain. | Click **Connect Branduo**. |
| `in_progress` | Before approval: the store is on Branduo. | Click **Connect Branduo** to approve your platform. |
| `install` | The Branduo app isn't installed on the store. | Install Branduo from Shopify. |
| `billing` | Installed, but usage billing isn't on. | Turn on usage billing in Shopify. |
| `approve` | Billing is on; the merchant hasn't approved your platform. | Approve in the Branduo Shopify app. |
| `setting_up` | Approved. Branduo is importing the store and building the offer. | Nothing. Usually a few minutes. |
| `live` | Approved and set up. | Nothing. Check `types[].live` for each offer type. |

`not_connected` and `in_progress` appear only before approval, for a store you haven't sent the connect link.

## Stage errors

| `error` | Means |
| - | - |
| `unknown_platform` | Your platform isn't set up to serve offers yet. Contact Support. |
| `not_eligible` | The store doesn't meet Branduo's order volume requirement yet. |
| `store_disconnected` | The merchant uninstalled Branduo. The connect link sends them to reinstall. |
| `no_product_images` | The store has no active products with images. |
| `no_qualifying_products` | No products can be featured yet (active, with images, on the Online Store, and shippable). Setup runs again once products qualify. |
| `setup_failed` | Setup failed for another reason. Branduo is looking into it. |

## Errors

| Status | `error` | Cause |
| - | - | - |
| `400` | `invalid_request` | `domain` is not a store hostname. |
| `401` | `unauthorized` | The platform key is missing or invalid. |
| `403` | `platform_inactive` | Your platform isn't active on Branduo. |

```json 200 (approved) theme={"languages":{"custom":["languages/curl.json"]}}
{
  "shop": "northwind-goods.myshopify.com",
  "approved": true,
  "stage": "live",
  "error": null,
  "types": [
    {
      "type": "post-purchase",
      "placementOn": true,
      "live": true,
      "pausedReason": null
    }
  ]
}
```

```json 200 (before approval) theme={"languages":{"custom":["languages/curl.json"]}}
{
  "approved": false,
  "stage": "in_progress",
  "error": null
}
```

```json 200 (connect link sent) theme={"languages":{"custom":["languages/curl.json"]}}
{
  "shop": "northwind-goods.myshopify.com",
  "approved": false,
  "stage": "billing",
  "error": null
}
```

```json 403 theme={"languages":{"custom":["languages/curl.json"]}}
{
  "error": "platform_inactive",
  "message": "This platform isn't active on Branduo."
}
```


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