Skip to main content
POST
cURL
Optional. Tell Branduo which merchants use your platform by store domain. Synced brands appear in List brands with their coarse stage (not_connected or in_progress), so you can see who is already on Branduo. Syncing grants nothing and isn’t needed for anything else: a merchant’s approval comes only from the Branduo Shopify app, and the connect link is what tells Branduo which platform sent a merchant. Each call creates or updates only the brands you send. Brands you leave out stay as they are, including brands you closed earlier. This is not a snapshot replace.
cURL

Authentication

Send your platform key in X-Api-Key. The key selects the platform: don’t send a platform ID. If the body includes a platformId that doesn’t match the key, the request returns 400.

Headers

string
required
application/json

Request body

object[]
required
Brands to create or update. At most 1000 items. See Limits.

Domain normalization

Send the brand’s store domain. We store one row per platform and normalized domain. Syncing does not create a Branduo company. Before we store domain, we:
  • Lowercase the host.
  • Remove the scheme (https:// or http://).
  • Remove a leading www..
  • Remove the port.
  • Remove the path, including a query string or fragment.
Other subdomains stay. shop.northwindgoods.com is not rewritten to the apex domain. The stored domain is at most 100 characters. Sending the same domain again, in any of the forms above, updates that brand. It does not insert a second row.

Upsert behavior

We match each item on the normalized domain for the platform on the key.
  • A domain we have not stored is added. status defaults to active, so EndDate is null.
  • The same domain on a later call updates that brand in place.
  • status closed soft-closes the brand. We set EndDate and keep the row. We do not delete it.
  • status active, or a body that omits status, clears EndDate and makes the brand active again.
  • Domains you omit are unchanged. A brand you do not send stays active if it was active, and stays closed if it was closed.
This route does not replace your catalog. To stop a brand from staying active, send that domain with status closed. Omitting it leaves the previous EndDate in place.
A successful sync does not create a Branduo company, login, or team member, does not approve anything, and does not send mail.

Limits

This route allows 30 requests per minute per key. These checks run on the request you send. Any one of them returns 400, and nothing in that request is written. Split a larger catalog into more requests. Each request upserts only the brands in that body, so a later batch does not reopen or remove brands from an earlier batch unless you send those domains again.

Response

200 means the brands in this request were upserted.
integer
required
How many brands in this request were created or updated.
The response is not a catalog of every brand on the platform. Send the next batch if you have one.

Errors

Errors use the error object (error and message). message explains which check failed. 400 covers:
  • More than 1000 brands, or a JSON body larger than 1 MB.
  • Malformed JSON, or brands missing or not an array.
  • A missing domain, a status other than active or closed, or businessName or the normalized domain longer than 100 characters.
  • A platform id in the body that does not match the platform key.