{ "error": "invalid_request", "message": "A request can include at most 1000 brands."}
{ "error": "invalid_request", "message": "JSON body must not exceed 1 MB."}
{ "error": "unauthorized", "message": "A platform token is required for this route."}
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.
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.
Show properties
string
required
The brand’s store domain: its custom domain or its *.myshopify.com
domain. We normalize it before storing. After
normalization it must be 1–100 characters. See
Domain normalization.
string
Brand name. Optional. At most 100 characters. When you send it, we store
that name on the brand. Omitting it keeps the name already stored.
string
default:"active"
active or closed. Omitted means active. closed sets EndDate.
active clears EndDate.
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.
You send
We store
https://www.NorthwindGoods.com/shop
northwindgoods.com
HTTP://HarborLantern.com:8443/about?ref=1
harborlantern.com
shop.northwindgoods.com
shop.northwindgoods.com
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.
statusclosed soft-closes the brand. We set EndDate and keep the row. We do not delete it.
statusactive, 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 statusclosed. 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.
Check
Result
brands contains more than 1000 objects
400 Bad Request
JSON body is larger than 1 MB
400 Bad Request
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.
Status
Cause
400 Bad Request
The body failed a limit or field check. See below.
401 Unauthorized
The platform key is missing or invalid.
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.
{ "upserted": 2}
{ "error": "invalid_request", "message": "A request can include at most 1000 brands."}
{ "error": "invalid_request", "message": "JSON body must not exceed 1 MB."}
{ "error": "unauthorized", "message": "A platform token is required for this route."}
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Branduo","description":"Help and API docs for Branduo, the brand collaboration network. Verified eCommerce brands find complementary partners and run co-marketing campaigns together.","colors":{"primary":"#E6F85E","light":"#E6F85E","dark":"#A8B84A"},"logo":{"light":"https://mintcdn.com/branduo/fb0UraJD8zK1glN5/logo/light.png?fit=max\u0026auto=format\u0026n=fb0UraJD8zK1glN5\u0026q=85\u0026s=bcb9d86e2d0bd305098eb785ac6fbd0d","dark":"https://mintcdn.com/branduo/fb0UraJD8zK1glN5/logo/dark.png?fit=max\u0026auto=format\u0026n=fb0UraJD8zK1glN5\u0026q=85\u0026s=f713eeff22177ba94519008987b29267","href":"https://docs.branduo.io"},"favicon":"https://mintcdn.com/branduo/fb0UraJD8zK1glN5/favicon.png?fit=max\u0026auto=format\u0026n=fb0UraJD8zK1glN5\u0026q=85\u0026s=22a858c78fb606c1afa3ae9e451c51d6","api":{"playground":{"display":"interactive"},"examples":{"defaults":"all","languages":["curl","javascript","python","php","go","ruby","java","csharp"],"autogenerate":false},"mdx":{"auth":{"method":"key","name":"X-Api-Key"},"server":"https://api.branduo.io/v1"}},"appearance":{"default":"dark","strict":true},"navbar":{"links":[{"href":"https://app.branduo.io","label":"Dashboard"},{"href":"https://branduo.io/partnerships","label":"Partnerships >"}]},"footer":{"socials":{"website":"https://branduo.io"}},"seo":{"metatags":{"canonical":"https://docs.branduo.io","author":"Branduo","robots":"index, follow","googlebot":"index, follow","language":"en","theme-color":"#1A1A14","og:site_name":"Branduo","og:locale":"en_US","og:type":"website","og:image":"https://bduo.blob.core.windows.net/marketing/assets/collabs/media-production.webp","og:image:alt":"Co-branded media production shoot with shared brand products","twitter:card":"summary_large_image","twitter:image":"https://bduo.blob.core.windows.net/marketing/assets/collabs/media-production.webp","twitter:image:alt":"Co-branded media production shoot with shared brand products"},"organization":{"id":"https://branduo.io/#organization","name":"Branduo","legalName":"Branduo Inc","url":"https://branduo.io","logo":"https://branduo.io/branduo_icon.png","sameAs":["https://www.linkedin.com/company/joinbranduo"]},"indexing":"navigable"},"fonts":{"family":"Inter"},"icons":{"library":"fontawesome"},"styling":{"codeblocks":{"languages":{"custom":["languages/curl.json"]}},"latex":false},"integrations":{"clarity":{"projectId":"yn1ms5ial7"},"ga4":{"measurementId":"G-RZ75CHBB07"}},"contextual":{"options":["copy","view","assistant","chatgpt","claude","cursor","mcp"],"display":"header"},"interaction":{"drilldown":false},"markdown":{"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}\u0026domain={store domain}. It redirects to Shopify and grants nothing. The return URL gets branduo_connect=return\u0026status=approved|declined|unavailable\u0026shop=…, 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."]},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"branduo","hasAudioNarration":false,"actualSubdomain":"branduo","customDomains":["docs.branduo.io"],"gitSource":{"type":"github","owner":"branduo-inc","repo":"docs-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6af7d62fca7096e633916b79","clientVersion":"0.0.4167","searchFilterCounts":[{"language":"default","tag":"API Reference","count":19},{"language":"default","tag":"Getting started","count":10},{"language":"default","tag":"Partner API","count":7},{"language":"default","tag":"Guides","count":6},{"language":"default","tag":"Embed plugin","count":4},{"language":"default","tag":"Contact us","count":4},{"language":"default","tag":"Contact","count":4},{"language":"default","tag":"Using Branduo","count":3},{"language":"default","tag":"Account","count":1},{"language":"default","tag":"Home","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"styles.css","content":"#sidebar{border-right:1px solid rgb(229 231 235)}.dark #sidebar{border-right-color:rgb(255 255 255 / 10%)}#navigation-items>div+div{border-top:1px solid rgb(229 231 235);padding-top:1.5rem}.dark #navigation-items>div+div{border-top-color:rgb(255 255 255 / 10%)}#sidebar-content li[data-active]>a,#sidebar-content li[data-active-nav-item]>a{background-color:rgb(75 85 99 / 5%);color:rgb(17 24 39);text-shadow:none}#sidebar-content li[data-active]>a span.min-w-0,#sidebar-content li[data-active-nav-item]>a span.min-w-0{color:rgb(17 24 39)}.dark #sidebar-content li[data-active]>a,.dark #sidebar-content li[data-active-nav-item]>a{background-color:rgb(229 231 235 / 5%);color:rgb(209 213 219)}.dark #sidebar-content li[data-active]>a span.min-w-0,.dark #sidebar-content li[data-active-nav-item]>a span.min-w-0{color:rgb(209 213 219)}#sidebar-content li[data-active]>a:has(.method-nav-pill),#sidebar-content li[data-active-nav-item]>a:has(.method-nav-pill){background-color:rgb(230 248 94 / 10%);color:rgb(26 26 20)}#sidebar-content li[data-active]>a:has(.method-nav-pill) span.min-w-0,#sidebar-content li[data-active-nav-item]>a:has(.method-nav-pill) span.min-w-0{color:rgb(26 26 20)}.dark #sidebar-content li[data-active]>a:has(.method-nav-pill),.dark #sidebar-content li[data-active-nav-item]>a:has(.method-nav-pill){background-color:rgb(230 248 94 / 10%);color:rgb(230 248 94)}.dark #sidebar-content li[data-active]>a:has(.method-nav-pill) span.min-w-0,.dark #sidebar-content li[data-active-nav-item]>a:has(.method-nav-pill) span.min-w-0{color:rgb(230 248 94)}#sidebar-content a:has(.method-nav-pill) span.min-w-0{font-size:0.75rem;line-height:1.5rem}"}],"page":{"pagePath":"developer/platform/brands","slug":"/developer/platform/brands","pageMetadata":{"title":"Sync platform brands","description":"Optional: tell Branduo which merchants use your platform. Omitted brands stay. Close a brand with status closed.","sidebarTitle":"Sync brands","api":"POST /platform/brands","keywords":["Branduo API","platform brands","brand sync","platform key"],"href":"/developer/platform/brands"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Optional: tell Branduo which merchants use your platform. Omitted brands stay. Close a brand with status closed.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Expandable,Heading,ParamField,ResponseField,Table,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Optional. Tell Branduo which merchants use your platform by store domain. Synced brands appear in `,_jsx(_components.a,{href:`/developer/platform/list-brands`,children:`List brands`}),` with their coarse stage (`,_jsx(_components.code,{children:`not_connected`}),` or `,_jsx(_components.code,{children:`in_progress`}),`), so you can see who is already on Branduo.`]}),`\n`,_jsxs(_components.p,{children:[`Syncing grants nothing and isn’t needed for anything else: a merchant’s approval comes only from the Branduo Shopify app, and the `,_jsx(_components.a,{href:`/developer/connect-link`,children:`connect link`}),` is what tells Branduo which platform sent a merchant.`]}),`\n`,_jsx(_components.p,{children:`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.`}),`\n`,`\n`,_jsx(Heading,{level:`2`,id:`authentication`,children:`Authentication`}),`\n`,_jsxs(_components.p,{children:[`Send your `,_jsx(_components.a,{href:`/developer/authentication`,children:`platform key`}),` in `,_jsx(_components.code,{children:`X-Api-Key`}),`. The key selects the platform: don’t send a platform ID. If the body includes a `,_jsx(_components.code,{children:`platformId`}),` that doesn’t match the key, the request returns `,_jsx(_components.code,{children:`400`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`headers`,children:`Headers`}),`\n`,_jsx(ParamField,{header:`Content-Type`,type:`string`,required:true,id:`param-content-type`,children:_jsx(_components.p,{children:_jsx(_components.code,{children:`application/json`})})}),`\n`,_jsx(Heading,{level:`2`,id:`request-body`,children:`Request body`}),`\n`,_jsxs(ParamField,{body:`brands`,type:`object[]`,required:true,id:`param-brands`,children:[_jsxs(_components.p,{children:[`Brands to create or update. At most 1000 items. See `,_jsx(_components.a,{href:`#limits`,children:`Limits`}),`.`]}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ParamField,{body:`domain`,type:`string`,required:true,id:`param-domain`,children:_jsxs(_components.p,{children:[`The brand’s store domain: its custom domain or its `,_jsx(_components.code,{children:`*.myshopify.com`}),`\ndomain. We normalize it before storing. After\nnormalization it must be 1–100 characters. See\n`,_jsx(_components.a,{href:`#domain-normalization`,children:`Domain normalization`}),`.`]})}),_jsx(ParamField,{body:`businessName`,type:`string`,id:`param-business-name`,children:_jsx(_components.p,{children:`Brand name. Optional. At most 100 characters. When you send it, we store\nthat name on the brand. Omitting it keeps the name already stored.`})}),_jsx(ParamField,{body:`status`,type:`string`,default:`active`,id:`param-status`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`active`}),` or `,_jsx(_components.code,{children:`closed`}),`. Omitted means `,_jsx(_components.code,{children:`active`}),`. `,_jsx(_components.code,{children:`closed`}),` sets `,_jsx(_components.code,{children:`EndDate`}),`.\n`,_jsx(_components.code,{children:`active`}),` clears `,_jsx(_components.code,{children:`EndDate`}),`.`]})})]})]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`13`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`13`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"brands\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"domain\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://www.NorthwindGoods.com/shop\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"businessName\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Northwind Goods\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"active\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"domain\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"harborlantern.com\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"closed\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`domain-normalization`,children:`Domain normalization`}),`\n`,_jsx(_components.p,{children:`Send the brand’s store domain. We store one row per platform and normalized domain. Syncing does not create a Branduo company.`}),`\n`,_jsxs(_components.p,{children:[`Before we store `,_jsx(_components.code,{children:`domain`}),`, we:`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Lowercase the host.`}),`\n`,_jsxs(_components.li,{children:[`Remove the scheme (`,_jsx(_components.code,{children:`https://`}),` or `,_jsx(_components.code,{children:`http://`}),`).`]}),`\n`,_jsxs(_components.li,{children:[`Remove a leading `,_jsx(_components.code,{children:`www.`}),`.`]}),`\n`,_jsx(_components.li,{children:`Remove the port.`}),`\n`,_jsx(_components.li,{children:`Remove the path, including a query string or fragment.`}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`Other subdomains stay. `,_jsx(_components.code,{children:`shop.northwindgoods.com`}),` is not rewritten to the apex domain.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`You send`}),_jsx(_components.th,{children:`We store`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`https://www.NorthwindGoods.com/shop`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`northwindgoods.com`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`HTTP://HarborLantern.com:8443/about?ref=1`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`harborlantern.com`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`shop.northwindgoods.com`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`shop.northwindgoods.com`})})]})]})]}),`\n`,_jsx(_components.p,{children:`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.`}),`\n`,_jsx(Heading,{level:`2`,id:`upsert-behavior`,children:`Upsert behavior`}),`\n`,_jsx(_components.p,{children:`We match each item on the normalized domain for the platform on the key.`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`A domain we have not stored is added. `,_jsx(_components.code,{children:`status`}),` defaults to `,_jsx(_components.code,{children:`active`}),`, so `,_jsx(_components.code,{children:`EndDate`}),` is null.`]}),`\n`,_jsx(_components.li,{children:`The same domain on a later call updates that brand in place.`}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`status`}),` `,_jsx(_components.code,{children:`closed`}),` soft-closes the brand. We set `,_jsx(_components.code,{children:`EndDate`}),` and keep the row. We do not delete it.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`status`}),` `,_jsx(_components.code,{children:`active`}),`, or a body that omits `,_jsx(_components.code,{children:`status`}),`, clears `,_jsx(_components.code,{children:`EndDate`}),` and makes the brand active again.`]}),`\n`,_jsx(_components.li,{children:`Domains you omit are unchanged. A brand you do not send stays active if it was active, and stays closed if it was closed.`}),`\n`]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`This route does not replace your catalog. To stop a brand from staying\nactive, send that domain with `,_jsx(_components.code,{children:`status`}),` `,_jsx(_components.code,{children:`closed`}),`. Omitting it leaves the\nprevious `,_jsx(_components.code,{children:`EndDate`}),` in place.`]})}),`\n`,_jsx(_components.p,{children:`A successful sync does not create a Branduo company, login, or team member, does not approve anything, and does not send mail.`}),`\n`,_jsx(Heading,{level:`2`,id:`limits`,children:`Limits`}),`\n`,_jsxs(_components.p,{children:[`This route allows 30 requests per minute per key. These checks run on the request you send. Any one of them returns `,_jsx(_components.code,{children:`400`}),`, and nothing in that request is written.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Check`}),_jsx(_components.th,{children:`Result`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`brands`}),` contains more than 1000 objects`]}),_jsx(_components.td,{children:_jsx(_components.code,{children:`400 Bad Request`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`JSON body is larger than 1 MB`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`400 Bad Request`})})]})]})]}),`\n`,_jsx(_components.p,{children:`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.`}),`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`200`}),` means the brands in this request were upserted.`]}),`\n`,_jsx(ResponseField,{name:`upserted`,type:`integer`,required:true,id:`param-upserted`,children:_jsx(_components.p,{children:`How many brands in this request were created or updated.`})}),`\n`,_jsx(_components.p,{children:`The response is not a catalog of every brand on the platform. Send the next batch if you have one.`}),`\n`,_jsx(Heading,{level:`2`,id:`errors`,children:`Errors`}),`\n`,_jsxs(_components.p,{children:[`Errors use the `,_jsx(_components.a,{href:`/developer/errors`,children:`error`}),` object (`,_jsx(_components.code,{children:`error`}),` and `,_jsx(_components.code,{children:`message`}),`). `,_jsx(_components.code,{children:`message`}),` explains which check failed.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Status`}),_jsx(_components.th,{children:`Cause`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`400 Bad Request`})}),_jsx(_components.td,{children:`The body failed a limit or field check. See below.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`401 Unauthorized`})}),_jsx(_components.td,{children:`The platform key is missing or invalid.`})]})]})]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`400`}),` covers:`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`More than 1000 brands, or a JSON body larger than 1 MB.`}),`\n`,_jsxs(_components.li,{children:[`Malformed JSON, or `,_jsx(_components.code,{children:`brands`}),` missing or not an array.`]}),`\n`,_jsxs(_components.li,{children:[`A missing `,_jsx(_components.code,{children:`domain`}),`, a `,_jsx(_components.code,{children:`status`}),` other than `,_jsx(_components.code,{children:`active`}),` or `,_jsx(_components.code,{children:`closed`}),`, or `,_jsx(_components.code,{children:`businessName`}),` or the normalized domain longer than 100 characters.`]}),`\n`,_jsx(_components.li,{children:`A platform id in the body that does not match the platform key.`}),`\n`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":{"languages":{"custom":["languages/curl.json"]}},"config":{},"pageMetadata":{"title":"Sync platform brands","description":"Optional: tell Branduo which merchants use your platform. Omitted brands stay. Close a brand with status closed.","sidebarTitle":"Sync brands","api":"POST /platform/brands","keywords":["Branduo API","platform brands","brand sync","platform key"],"href":"/developer/platform/brands"}}},"mdxSourceWithNoJs":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Expandable,Heading,ParamField,RequestExample,ResponseExample,ResponseField,Table,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!RequestExample)_missingMdxReference(`RequestExample`,true);if(!ResponseExample)_missingMdxReference(`ResponseExample`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Optional. Tell Branduo which merchants use your platform by store domain. Synced brands appear in `,_jsx(_components.a,{href:`/developer/platform/list-brands`,children:`List brands`}),` with their coarse stage (`,_jsx(_components.code,{children:`not_connected`}),` or `,_jsx(_components.code,{children:`in_progress`}),`), so you can see who is already on Branduo.`]}),`\n`,_jsxs(_components.p,{children:[`Syncing grants nothing and isn’t needed for anything else: a merchant’s approval comes only from the Branduo Shopify app, and the `,_jsx(_components.a,{href:`/developer/connect-link`,children:`connect link`}),` is what tells Branduo which platform sent a merchant.`]}),`\n`,_jsx(_components.p,{children:`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.`}),`\n`,_jsxs(RequestExample,{dropdown:true,children:[_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`18`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`18`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`curl --request POST \\\\`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --url 'https://api.branduo.io/v1/platform/brands' \\\\`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --header 'Content-Type: application/json' \\\\`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --header 'X-Api-Key: YOUR_PLATFORM_KEY' \\\\`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` --data '{`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"brands\": [`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"domain\": \"https://www.NorthwindGoods.com/shop\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"businessName\": \"Northwind Goods\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"status\": \"active\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"domain\": \"harborlantern.com\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` \"status\": \"closed\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:` }'`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),_jsx(CodeBlock,{filename:`JavaScript`,numberOfLines:`25`,language:`javascript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`javascript`,children:_jsxs(_components.code,{language:`javascript`,numberOfLines:`25`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` response`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` fetch`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://api.branduo.io/v1/platform/brands\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` method:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"POST\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` headers:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"application/json\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"X-Api-Key\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"YOUR_PLATFORM_KEY\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` body:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` JSON`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`stringify`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`({`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` brands:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` domain:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://www.NorthwindGoods.com/shop\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` businessName:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Northwind Goods\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` status:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"active\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` domain:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"harborlantern.com\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` status:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"closed\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ],`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }),`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`});`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`if`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` (`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`!`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`response`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`ok`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`) {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` error`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` response`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`json`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`();`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` throw`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` new`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` Error`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`error`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`message`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`);`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`Python`,numberOfLines:`24`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`24`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` requests`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`response `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` requests.post(`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.branduo.io/v1/platform/brands\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` headers`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"application/json\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"X-Api-Key\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"YOUR_PLATFORM_KEY\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` json`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"brands\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"domain\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://www.NorthwindGoods.com/shop\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"businessName\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Northwind Goods\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"active\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"domain\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"harborlantern.com\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"closed\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`response.raise_for_status()`})}),`\n`]})})})]}),`\n`,_jsx(Heading,{level:`2`,id:`authentication`,children:`Authentication`}),`\n`,_jsxs(_components.p,{children:[`Send your `,_jsx(_components.a,{href:`/developer/authentication`,children:`platform key`}),` in `,_jsx(_components.code,{children:`X-Api-Key`}),`. The key selects the platform: don’t send a platform ID. If the body includes a `,_jsx(_components.code,{children:`platformId`}),` that doesn’t match the key, the request returns `,_jsx(_components.code,{children:`400`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`headers`,children:`Headers`}),`\n`,_jsx(ParamField,{header:`Content-Type`,type:`string`,required:true,id:`param-content-type`,children:_jsx(_components.p,{children:_jsx(_components.code,{children:`application/json`})})}),`\n`,_jsx(Heading,{level:`2`,id:`request-body`,children:`Request body`}),`\n`,_jsxs(ParamField,{body:`brands`,type:`object[]`,required:true,id:`param-brands`,children:[_jsxs(_components.p,{children:[`Brands to create or update. At most 1000 items. See `,_jsx(_components.a,{href:`#limits`,children:`Limits`}),`.`]}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ParamField,{body:`domain`,type:`string`,required:true,id:`param-domain`,children:_jsxs(_components.p,{children:[`The brand’s store domain: its custom domain or its `,_jsx(_components.code,{children:`*.myshopify.com`}),`\ndomain. We normalize it before storing. After\nnormalization it must be 1–100 characters. See\n`,_jsx(_components.a,{href:`#domain-normalization`,children:`Domain normalization`}),`.`]})}),_jsx(ParamField,{body:`businessName`,type:`string`,id:`param-business-name`,children:_jsx(_components.p,{children:`Brand name. Optional. At most 100 characters. When you send it, we store\nthat name on the brand. Omitting it keeps the name already stored.`})}),_jsx(ParamField,{body:`status`,type:`string`,default:`active`,id:`param-status`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`active`}),` or `,_jsx(_components.code,{children:`closed`}),`. Omitted means `,_jsx(_components.code,{children:`active`}),`. `,_jsx(_components.code,{children:`closed`}),` sets `,_jsx(_components.code,{children:`EndDate`}),`.\n`,_jsx(_components.code,{children:`active`}),` clears `,_jsx(_components.code,{children:`EndDate`}),`.`]})})]})]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`13`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`13`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"brands\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"domain\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://www.NorthwindGoods.com/shop\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"businessName\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Northwind Goods\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"active\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"domain\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"harborlantern.com\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"closed\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`domain-normalization`,children:`Domain normalization`}),`\n`,_jsx(_components.p,{children:`Send the brand’s store domain. We store one row per platform and normalized domain. Syncing does not create a Branduo company.`}),`\n`,_jsxs(_components.p,{children:[`Before we store `,_jsx(_components.code,{children:`domain`}),`, we:`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Lowercase the host.`}),`\n`,_jsxs(_components.li,{children:[`Remove the scheme (`,_jsx(_components.code,{children:`https://`}),` or `,_jsx(_components.code,{children:`http://`}),`).`]}),`\n`,_jsxs(_components.li,{children:[`Remove a leading `,_jsx(_components.code,{children:`www.`}),`.`]}),`\n`,_jsx(_components.li,{children:`Remove the port.`}),`\n`,_jsx(_components.li,{children:`Remove the path, including a query string or fragment.`}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`Other subdomains stay. `,_jsx(_components.code,{children:`shop.northwindgoods.com`}),` is not rewritten to the apex domain.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`You send`}),_jsx(_components.th,{children:`We store`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`https://www.NorthwindGoods.com/shop`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`northwindgoods.com`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`HTTP://HarborLantern.com:8443/about?ref=1`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`harborlantern.com`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`shop.northwindgoods.com`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`shop.northwindgoods.com`})})]})]})]}),`\n`,_jsx(_components.p,{children:`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.`}),`\n`,_jsx(Heading,{level:`2`,id:`upsert-behavior`,children:`Upsert behavior`}),`\n`,_jsx(_components.p,{children:`We match each item on the normalized domain for the platform on the key.`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`A domain we have not stored is added. `,_jsx(_components.code,{children:`status`}),` defaults to `,_jsx(_components.code,{children:`active`}),`, so `,_jsx(_components.code,{children:`EndDate`}),` is null.`]}),`\n`,_jsx(_components.li,{children:`The same domain on a later call updates that brand in place.`}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`status`}),` `,_jsx(_components.code,{children:`closed`}),` soft-closes the brand. We set `,_jsx(_components.code,{children:`EndDate`}),` and keep the row. We do not delete it.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`status`}),` `,_jsx(_components.code,{children:`active`}),`, or a body that omits `,_jsx(_components.code,{children:`status`}),`, clears `,_jsx(_components.code,{children:`EndDate`}),` and makes the brand active again.`]}),`\n`,_jsx(_components.li,{children:`Domains you omit are unchanged. A brand you do not send stays active if it was active, and stays closed if it was closed.`}),`\n`]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`This route does not replace your catalog. To stop a brand from staying\nactive, send that domain with `,_jsx(_components.code,{children:`status`}),` `,_jsx(_components.code,{children:`closed`}),`. Omitting it leaves the\nprevious `,_jsx(_components.code,{children:`EndDate`}),` in place.`]})}),`\n`,_jsx(_components.p,{children:`A successful sync does not create a Branduo company, login, or team member, does not approve anything, and does not send mail.`}),`\n`,_jsx(Heading,{level:`2`,id:`limits`,children:`Limits`}),`\n`,_jsxs(_components.p,{children:[`This route allows 30 requests per minute per key. These checks run on the request you send. Any one of them returns `,_jsx(_components.code,{children:`400`}),`, and nothing in that request is written.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Check`}),_jsx(_components.th,{children:`Result`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`brands`}),` contains more than 1000 objects`]}),_jsx(_components.td,{children:_jsx(_components.code,{children:`400 Bad Request`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`JSON body is larger than 1 MB`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`400 Bad Request`})})]})]})]}),`\n`,_jsx(_components.p,{children:`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.`}),`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`200`}),` means the brands in this request were upserted.`]}),`\n`,_jsx(ResponseField,{name:`upserted`,type:`integer`,required:true,id:`param-upserted`,children:_jsx(_components.p,{children:`How many brands in this request were created or updated.`})}),`\n`,_jsx(_components.p,{children:`The response is not a catalog of every brand on the platform. Send the next batch if you have one.`}),`\n`,_jsx(Heading,{level:`2`,id:`errors`,children:`Errors`}),`\n`,_jsxs(_components.p,{children:[`Errors use the `,_jsx(_components.a,{href:`/developer/errors`,children:`error`}),` object (`,_jsx(_components.code,{children:`error`}),` and `,_jsx(_components.code,{children:`message`}),`). `,_jsx(_components.code,{children:`message`}),` explains which check failed.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Status`}),_jsx(_components.th,{children:`Cause`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`400 Bad Request`})}),_jsx(_components.td,{children:`The body failed a limit or field check. See below.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`401 Unauthorized`})}),_jsx(_components.td,{children:`The platform key is missing or invalid.`})]})]})]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`400`}),` covers:`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`More than 1000 brands, or a JSON body larger than 1 MB.`}),`\n`,_jsxs(_components.li,{children:[`Malformed JSON, or `,_jsx(_components.code,{children:`brands`}),` missing or not an array.`]}),`\n`,_jsxs(_components.li,{children:[`A missing `,_jsx(_components.code,{children:`domain`}),`, a `,_jsx(_components.code,{children:`status`}),` other than `,_jsx(_components.code,{children:`active`}),` or `,_jsx(_components.code,{children:`closed`}),`, or `,_jsx(_components.code,{children:`businessName`}),` or the normalized domain longer than 100 characters.`]}),`\n`,_jsx(_components.li,{children:`A platform id in the body that does not match the platform key.`}),`\n`]}),`\n`,_jsxs(ResponseExample,{children:[_jsx(CodeBlock,{filename:`200`,numberOfLines:`3`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`3`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"upserted\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`2`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`400`,numberOfLines:`4`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`4`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"error\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"invalid_request\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"A request can include at most 1000 brands.\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`400`,numberOfLines:`4`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`4`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"error\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"invalid_request\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"JSON body must not exceed 1 MB.\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`401`,numberOfLines:`4`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`4`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"error\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"unauthorized\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"A platform token is required for this route.\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":{"languages":{"custom":["languages/curl.json"]}},"config":{},"pageMetadata":{"title":"Sync platform brands","description":"Optional: tell Branduo which merchants use your platform. Omitted brands stay. Close a brand with status closed.","sidebarTitle":"Sync brands","api":"POST /platform/brands","keywords":["Branduo API","platform brands","brand sync","platform key"],"href":"/developer/platform/brands"}}}},"mdxExtracts":{"tableOfContents":[{"title":"Authentication","slug":"authentication","depth":2,"children":[]},{"title":"Headers","slug":"headers","depth":2,"children":[]},{"title":"Request body","slug":"request-body","depth":2,"children":[]},{"title":"Domain normalization","slug":"domain-normalization","depth":2,"children":[]},{"title":"Upsert behavior","slug":"upsert-behavior","depth":2,"children":[]},{"title":"Limits","slug":"limits","depth":2,"children":[]},{"title":"Response","slug":"response","depth":2,"children":[]},{"title":"Errors","slug":"errors","depth":2,"children":[]}],"codeExamples":{"request":{"type":"RequestExample","children":[{"filename":"cURL","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"text\">\u003ccode language=\"text\" numberOfLines=\"18\">\u003cspan class=\"line\">\u003cspan>curl --request POST \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> --url 'https://api.branduo.io/v1/platform/brands' \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> --header 'Content-Type: application/json' \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> --header 'X-Api-Key: YOUR_PLATFORM_KEY' \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> --data '{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> \"brands\": [\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> \"domain\": \"https://www.NorthwindGoods.com/shop\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> \"businessName\": \"Northwind Goods\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> \"status\": \"active\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> \"domain\": \"harborlantern.com\",\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> \"status\": \"closed\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> ]\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan> }'\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan>\u003c/span>\u003c/span>\u003c/code>\u003c/pre>"},{"filename":"JavaScript","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"javascript\">\u003ccode language=\"javascript\" numberOfLines=\"25\">\u003cspan class=\"line\">\u003cspan style=\"color:#CF222E;--shiki-dark:#569CD6\">const\u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#4FC1FF\"> response\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D4D4D4\"> =\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#C586C0\"> await\u003c/span>\u003cspan style=\"color:#8250DF;--shiki-dark:#DCDCAA\"> fetch\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">(\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"https://api.branduo.io/v1/platform/brands\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">, {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\"> method:\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"POST\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\"> headers:\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"Content-Type\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\">:\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"application/json\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"X-Api-Key\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\">:\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"YOUR_PLATFORM_KEY\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\"> body:\u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#4FC1FF\"> JSON\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">.\u003c/span>\u003cspan style=\"color:#8250DF;--shiki-dark:#DCDCAA\">stringify\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">({\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\"> brands:\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> [\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\"> domain:\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"https://www.NorthwindGoods.com/shop\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\"> businessName:\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"Northwind Goods\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\"> status:\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"active\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\"> domain:\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"harborlantern.com\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\"> status:\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"closed\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> ],\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> }),\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">});\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#CF222E;--shiki-dark:#C586C0\">if\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> (\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D4D4D4\">!\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\">response\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">.\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\">ok\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">) {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#CF222E;--shiki-dark:#569CD6\"> const\u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#4FC1FF\"> error\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D4D4D4\"> =\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#C586C0\"> await\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\"> response\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">.\u003c/span>\u003cspan style=\"color:#8250DF;--shiki-dark:#DCDCAA\">json\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">();\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#CF222E;--shiki-dark:#C586C0\"> throw\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#569CD6\"> new\u003c/span>\u003cspan style=\"color:#8250DF;--shiki-dark:#DCDCAA\"> Error\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">(\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\">error\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">.\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\">message\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">);\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"},{"filename":"Python","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"python\">\u003ccode language=\"python\" numberOfLines=\"24\">\u003cspan class=\"line\">\u003cspan style=\"color:#CF222E;--shiki-dark:#C586C0\">import\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> requests\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">response \u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D4D4D4\">=\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> requests.post(\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"https://api.branduo.io/v1/platform/brands\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#953800;--shiki-dark:#9CDCFE\"> headers\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D4D4D4\">=\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"Content-Type\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"application/json\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"X-Api-Key\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"YOUR_PLATFORM_KEY\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#953800;--shiki-dark:#9CDCFE\"> json\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D4D4D4\">=\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"brands\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: [\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"domain\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"https://www.NorthwindGoods.com/shop\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"businessName\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"Northwind Goods\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"status\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"active\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"domain\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"harborlantern.com\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"status\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"closed\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> ]\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> },\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">)\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">response.raise_for_status()\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[{"type":"mdxJsxAttribute","name":"dropdown","value":"\"\""}]},"response":{"type":"ResponseExample","children":[{"filename":"200","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"3\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"upserted\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\">2\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"},{"filename":"400","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"4\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"error\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"invalid_request\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"message\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"A request can include at most 1000 brands.\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"},{"filename":"400","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"4\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"error\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"invalid_request\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"message\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"JSON body must not exceed 1 MB.\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"},{"filename":"401","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"4\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"error\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"unauthorized\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"message\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"A platform token is required for this route.\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]}},"endpoint":{"title":"Sync platform brands","path":"/platform/brands","servers":[{"url":"https://api.branduo.io/v1"}],"method":"post","request":{"security":[{"title":"API Key Auth","parameters":{"header":{"X-Api-Key":{"type":"apiKey"}},"query":{},"cookie":{}}}],"parameters":{"query":{},"header":{"Content-Type":{"schema":[{"type":"string","description":"`application/json`","required":true}]}},"cookie":{},"path":{}},"body":{"application/json":{"schemaArray":[{"type":"object","properties":{"brands":[{"type":"array","items":[{"type":"object","properties":{"domain":[{"type":"string","description":"The brand’s store domain: its custom domain or its `*.myshopify.com` domain. We normalize it before storing. After normalization it must be 1–100 characters. See Domain normalization .","required":true}],"businessName":[{"type":"string","description":"Brand name. Optional. At most 100 characters. When you send it, we store that name on the brand. Omitting it keeps the name already stored."}],"status":[{"type":"string","description":"`active` or `closed` . Omitted means `active` . `closed` sets `EndDate` . `active` clears `EndDate` ."}]}}],"description":"Brands to create or update. At most 1000 items. See Limits .","required":true}]}}],"examples":{"example":{"value":{"brands":[{"domain":"\u003cstring>","businessName":"\u003cstring>","status":"\u003cstring>"}]}}}}}},"response":{"200":{"application/json":{"schemaArray":[{"type":"object","properties":{"upserted":[{"type":"integer","description":"How many brands in this request were created or updated.","required":true}]}}],"examples":{"example":{"value":{"upserted":123}}}}}},"deprecated":false}},"jsLinks":["/_mintlify/custom/branduo/eff4ae70fa90f062/tally.js","/_mintlify/custom/branduo/201760221e3b4cdd/nav-hrefs.js"],"subdomain":"branduo","siteName":"Branduo","title":"Sync platform brands - Branduo","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-27T04:02:28.810Z","originalFileLocation":"developer/platform/brands.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"dark\";if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Optional: tell Branduo which merchants use your platform. Omitted brands stay. Close a brand with status closed.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Branduo\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"index, follow\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/branduo/xzdorFiW5glaAGu-/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/branduo/xzdorFiW5glaAGu-/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/branduo/xzdorFiW5glaAGu-/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/branduo/xzdorFiW5glaAGu-/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/branduo/xzdorFiW5glaAGu-/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/branduo/xzdorFiW5glaAGu-/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/branduo/xzdorFiW5glaAGu-/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/branduo/xzdorFiW5glaAGu-/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/branduo/xzdorFiW5glaAGu-/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Sync platform brands - Branduo\">\u003cmeta data-mint-head property=\"og:description\" content=\"Optional: tell Branduo which merchants use your platform. Omitted brands stay. Close a brand with status closed.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Branduo\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.branduo.io/developer/platform/brands\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://bduo.blob.core.windows.net/marketing/assets/collabs/media-production.webp\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Sync platform brands - Branduo\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Optional: tell Branduo which merchants use your platform. Omitted brands stay. Close a brand with status closed.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://bduo.blob.core.windows.net/marketing/assets/collabs/media-production.webp\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/branduo/xzdorFiW5glaAGu-/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Branduo\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#E6F85E\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003cmeta data-mint-head name=\"author\" content=\"Branduo\">\u003cmeta data-mint-head name=\"googlebot\" content=\"index, follow\">\u003cmeta data-mint-head name=\"language\" content=\"en\">\u003cmeta data-mint-head name=\"theme-color\" content=\"#1A1A14\">\u003cmeta data-mint-head name=\"og:image:alt\" content=\"Co-branded media production shoot with shared brand products\">\u003cmeta data-mint-head name=\"twitter:image:alt\" content=\"Co-branded media production shoot with shared brand products\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.branduo.io/developer/platform/brands\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/developer/platform/brands.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://branduo.io/#organization\",\"name\":\"Branduo\",\"legalName\":\"Branduo Inc\",\"url\":\"https://branduo.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://branduo.io/branduo_icon.png\"},\"sameAs\":[\"https://www.linkedin.com/company/joinbranduo\"]},{\"@type\":\"WebSite\",\"@id\":\"https://docs.branduo.io#website\",\"name\":\"Branduo\",\"url\":\"https://docs.branduo.io\",\"publisher\":{\"@id\":\"https://branduo.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.branduo.io/developer/platform/brands#webpage\",\"url\":\"https://docs.branduo.io/developer/platform/brands\",\"name\":\"Sync platform brands\",\"description\":\"Optional: tell Branduo which merchants use your platform. Omitted brands stay. Close a brand with status closed.\",\"dateModified\":\"2026-10-27T04:02:28.810Z\",\"isPartOf\":{\"@id\":\"https://docs.branduo.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.branduo.io/developer/platform/brands#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.branduo.io/developer/platform/brands#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Partner API\",\"item\":\"https://docs.branduo.io/developer/platform/get-platform\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Sync platform brands\",\"item\":\"https://docs.branduo.io/developer/platform/brands\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.branduo.io/developer/platform/brands#apireference\",\"headline\":\"Sync platform brands\",\"name\":\"Sync platform brands\",\"description\":\"Optional: tell Branduo which merchants use your platform. Omitted brands stay. Close a brand with status closed.\",\"url\":\"https://docs.branduo.io/developer/platform/brands\",\"mainEntityOfPage\":{\"@id\":\"https://docs.branduo.io/developer/platform/brands#webpage\"},\"image\":\"https://bduo.blob.core.windows.net/marketing/assets/collabs/media-production.webp\",\"dateModified\":\"2026-10-27T04:02:28.810Z\",\"keywords\":\"Branduo API, platform brands, brand sync, platform key\",\"publisher\":{\"@id\":\"https://branduo.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.branduo.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Branduo\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Branduo\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/developer/platform/brands.md","siteName":"Branduo","nav":{"global":null,"tabs":[{"tab":"Home","pages":[{"title":"Home","href":"/introduction"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/getting-started/quick-start"}]},{"tab":"API Reference","groups":[{"group":"Getting started","icon":"rocket","pages":[{"title":"Introduction","icon":"code","href":"/developer/overview"},{"title":"Integration options","icon":"route","href":"/developer/integration-options"},{"title":"Custom integration","icon":"wrench","href":"/developer/custom-integration"},{"title":"Connect link","icon":"link","href":"/developer/connect-link"},{"title":"Authentication","icon":"key","href":"/developer/authentication"},{"title":"Rate limiting","icon":"gauge-high","href":"/developer/rate-limiting"},{"title":"Errors","icon":"triangle-exclamation","href":"/developer/errors"},{"title":"Pagination","icon":"table-list","href":"/developer/pagination"}]},{"group":"Embed plugin","icon":"puzzle-piece","pages":[{"title":"Embed plugin overview","sidebarTitle":"Overview","icon":"puzzle-piece","href":"/developer/embed/overview"},{"title":"Embed quickstart","sidebarTitle":"Quickstart","icon":"rocket","href":"/developer/embed/quickstart"},{"title":"Stages","sidebarTitle":"Stages","icon":"list-check","href":"/developer/embed/stages"},{"title":"Troubleshooting","sidebarTitle":"Troubleshooting","icon":"wrench","href":"/developer/embed/troubleshooting"}]},{"group":"Partner API","icon":"code","pages":[{"title":"Get your platform","sidebarTitle":"Get your platform","api":"GET /platform","href":"/developer/platform/get-platform"},{"title":"Get a brand","sidebarTitle":"Get a brand","api":"GET /platform/brands/{domain}","href":"/developer/platform/get-brand"},{"title":"List brands","sidebarTitle":"List brands","api":"GET /platform/brands","href":"/developer/platform/list-brands"},{"title":"Get the brand's offer","sidebarTitle":"Get the brand's offer","api":"GET /platform/brands/{domain}/offer","href":"/developer/platform/get-brand-offer"},{"title":"Get offers","sidebarTitle":"Get offers","api":"GET /platform/brands/{domain}/offers","href":"/developer/platform/get-offers"},{"title":"Set placement","description":"Turn a merchant's Branduo placement on your platform off or on, for one offer type.","sidebarTitle":"Set placement","api":"PUT /platform/brands/{domain}/campaigns/{type}","href":"/developer/platform/set-placement"},{"title":"Sync platform brands","sidebarTitle":"Sync brands","api":"POST /platform/brands","href":"/developer/platform/brands"}]}]},{"tab":"Contact us","pages":[{"title":"Contact us","href":"/support/overview"}]}]},"basePath":"","title":"Sync platform brands - Branduo","buildId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","deploymentId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["OpenApiReferenceProvider-BgGj2PGS.js","utils-BhNOqRKb.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BAgRNUZo.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CGkb0TPw.js","snippetPresets-ChLkL1a6.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-Ef10Jrbx.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DlVCnjU8.js","shallow-BA55zJxQ.js","getApiPlaygroundDisplay-DR09dKtp.js","CodeSnippet-BZ8J8Kll.js","CodeSnippets-CcguVheG.js","Page-C7x-eUfk.js","getPastedJson-D5UqeqBp.js","icon-DpD0l99C.js","MethodPill-Wg2NXsp_.js","DuplicateIcon-CCSyX8lh.js","createIcon-C4Ukv9HX.js","DynamicMarkdown-RhjEuCHC.js","SectionHeading-DL1MykRq.js","axios-vUo_bRtp.js"]}