Skip to main content
GET
cURL
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.
cURL

Path parameters

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 (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

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.
boolean
required
true when the merchant has an active approval of your platform. false before approval, and after they disconnect you or uninstall Branduo.
string | null
required
Where the merchant is. See Stages. null when error is set.
string | null
required
Why the merchant is stuck, or null. See Stage errors.
object[]
After approval only: one entry per offer type your platform serves.

Stages

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

Stage errors

Errors