Before you start
From Branduo Support, get your platform ID and platform key, and give us your return URL (an https page in your app). See Integration options. Keep the platform key on your server. Every call below is server to server.1. Show a Connect Branduo button
Add a Connect Branduo button where your merchant manages integrations. To show Connected instead for a merchant who already approved you, call Get a brand first:approved: true means the merchant approved your platform. Before that, the response only says not_connected or in_progress. You see the merchant’s full stage once you’ve sent them the connect link.
2. Open the connect link
The button opens:domain is the merchant’s store domain, their *.myshopify.com domain or their own. Branduo remembers that you sent this store (for 7 days), then sends the merchant on:
- Store already on Branduo: the Branduo app in that store’s Shopify admin.
- Not on Branduo,
*.myshopify.comdomain: the Branduo install for that store. - Not on Branduo, custom domain: the Branduo listing on the Shopify App Store.
- No domain: a Branduo page that asks for the store name, then continues.
3. The merchant finishes in Shopify
In the Branduo Shopify app, a new merchant installs and turns on usage billing. Then every merchant sees Run your offer on {your platform}, with a preview of their offer, and chooses Approve or Not now. Approving turns on their placement for each offer type you serve and starts their campaign on your platform.4. Handle the return
After Approve or Not now, Branduo sends the merchant to your return URL:status is approved, declined, or unavailable (your platform isn’t active on Branduo). Any query string already on your return URL is kept.
5. Confirm the approval
Call Get a brand with theshop value. Store shop: it is the merchant’s permanent ID and never changes, even if their custom domain does.
setting_up while Branduo builds the merchant’s offer. It becomes live when setup finishes. If setup fails, error says why (for example no_product_images). See Get a brand.
To list every merchant who approved you, page through List brands with approved=true.
6. Show partner offers
Wherever your platform shows offers for this merchant (for example, their order confirmation page), call Get offers from your server at the moment you show them:viewId per display, such as the order ID. The response is empty when the merchant’s campaign isn’t live. Show nothing in that case.
A merchant’s own offer is shown to other brands’ shoppers only after one of
that merchant’s surfaces has asked for offers. Call this route from every
surface where you show offers, even when it returns nothing.
7. Turn placement off and on
When the merchant turns off your Branduo placement, or removes your app, call Set placement withactive: false. Call it with active: true when it’s back, or to start an offer type you added after the merchant approved.
When things change
- The merchant disconnects you in Branduo: Get a brand shows
approved: false, offers stop, and the API returns403 not_approvedfor that merchant. Send them through the connect link again to ask for a new approval. - The merchant uninstalls Branduo: every approval ends. A reinstall asks again.
- Usage billing is off: the merchant stays approved, but
stageisbillingand each type showspausedReason: "billing"until they turn it back on.

