CINXE.COM

<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><title>API reference | BigCommerce Dev Center</title><meta name="robots" content="index,follow"/><meta name="description" content="Build amazing commerce solutions powered by the BigCommerce platform"/><meta name="twitter:card" content="summary_large_image"/><meta name="twitter:creator" content="@BigCommerceDevs"/><meta property="og:title" content="API reference"/><meta property="og:description" content="Build amazing commerce solutions powered by the BigCommerce platform"/><meta property="og:image" content="/api/og?title=API reference&description=Build amazing commerce solutions powered by the BigCommerce platform"/><meta property="og:site_name" content="BigCommerce Dev Center"/><meta name="theme-color" content="#111" media="(prefers-color-scheme: dark)"/><meta name="viewport" content="width=device-width, initial-scale=1.0, viewport-fit=cover"/><style> :root { --nextra-primary-hue: 212deg; --nextra-primary-saturation: 100%; --nextra-navbar-height: 4rem; --nextra-menu-height: 3.75rem; --nextra-banner-height: 2.5rem; } .dark { --nextra-primary-hue: 204deg; --nextra-primary-saturation: 100%; } </style><meta property="og:url" content="https://developer.bigcommerce.com/docs/api"/><meta property="twitter:image" content="https://developer.bigcommerce.com/api/og?title=undefined&description=undefined"/><meta property="twitter:title" content="BigCommerce Dev Center"/><meta property="twitter:description" content=""/><meta name="next-head-count" content="17"/><script>!function(){var analytics=window.analytics=window.analytics||[];if(!analytics.initialize)if(analytics.invoked)window.console&&console.error&&console.error("Segment snippet included twice.");else{analytics.invoked=!0;analytics.methods=["trackSubmit","trackClick","trackLink","trackForm","pageview","identify","reset","group","track","ready","alias","debug","page","once","off","on","addSourceMiddleware","addIntegrationMiddleware","setAnonymousId","addDestinationMiddleware"];analytics.factory=function(e){return function(){if(window.analytics.initialized)return window.analytics[e].apply(window.analytics,arguments);var i=Array.prototype.slice.call(arguments);i.unshift(e);analytics.push(i);return analytics}};for(var i=0;i<analytics.methods.length;i++){var key=analytics.methods[i];analytics[key]=analytics.factory(key)}analytics.load=function(key,i){var t=document.createElement("script");t.type="text/javascript";t.async=!0;t.src="https://cdn.segment.com/analytics.js/v1/" + key + "/analytics.min.js";var n=document.getElementsByTagName("script")[0];n.parentNode.insertBefore(t,n);analytics._loadOptions=i};analytics._writeKey="pcIxZ9NO06csZFSFyDQ0akcPcQadO4M5";;analytics.SNIPPET_VERSION="4.16.1"; analytics.load("pcIxZ9NO06csZFSFyDQ0akcPcQadO4M5"); analytics.page(); }}();</script><script>function mobileMenuChanges() { if (window.innerWidth < 768) { const elements = document.querySelectorAll(".nextra-sidebar-container a"); for (let i = 0; i < elements.length; i++) { const element = elements[i]; const list = [ "Powered By", "Automated Partner Billing", "Users API", "GraphQL Admin API", "App Extensions", ]; list.forEach((item) => { // @ts-ignore if (element.textContent.indexOf(item) !== -1) { element.classList.add("hidden"); } }); } } } window.addEventListener('resize', mobileMenuChanges); window.addEventListener('onLoad', mobileMenuChanges);</script><script id="makeswift-preview-mode" type="module"> const isPreview = false const appOrigin = 'https://app.makeswift.com' const searchParamName = 'x-makeswift-preview-mode' const headerName = 'X-Makeswift-Preview-Mode' const originalUrl = new URL(window.location.href) if (window.parent !== window) { window.addEventListener('message', event => { if (event.origin === appOrigin && event.data.type === 'makeswift_preview_mode') { const { secret } = event.data if (!isPreview && !originalUrl.searchParams.has(searchParamName)) { const url = new URL(originalUrl) url.searchParams.set(searchParamName, secret) window.location.replace(url) } else { const originalFetch = window.fetch window.fetch = function patchedFetch(resource, options) { const request = new Request(resource, options) if (new URL(request.url).origin !== window.location.origin) { return originalFetch.call(this, resource, options) } return originalFetch.call( this, new Request(request, { headers: { [headerName]: secret } }), ) } } } }) window.parent.postMessage({ type: 'makeswift_preview_mode' }, appOrigin) } if (originalUrl.searchParams.has(searchParamName)) { const url = new URL(originalUrl) url.searchParams.delete(searchParamName) window.history.replaceState(null, '', url) } </script><script id="makeswift-connection-check" type="module"> const appOrigin = 'https://app.makeswift.com' if (window.parent !== window) { window.addEventListener('message', event => { if ( event.origin === appOrigin && event.data.type === 'MAKESWIFT_CONNECTION_INIT' ) { setInterval(() => { window.parent.postMessage({ type: 'MAKESWIFT_CONNECTION_CHECK', payload: { currentUrl: window.location.href } }, appOrigin) }, 20) } }) window.parent.postMessage({ type: 'MAKESWIFT_CONNECTION_INIT' }, appOrigin) } </script><link rel="stylesheet" href="https://rsms.me/inter/inter.css"/><link rel="preconnect" href="https://fonts.googleapis.com"/><link rel="preconnect" href="https://fonts.gstatic.com" crossorigin="use-credentials"/><link rel="stylesheet" data-href="https://fonts.googleapis.com/css2?family=Inter:wght@300;400;500;700;900&family=Kode+Mono:wght@400..700&display=swap"/><link data-next-font="" rel="preconnect" href="/" crossorigin="anonymous"/><link rel="preload" href="/_next/static/css/52211a7de07b01b3.css" as="style"/><link rel="stylesheet" href="/_next/static/css/52211a7de07b01b3.css" data-n-g=""/><link rel="preload" href="/_next/static/css/21c0102bad0d4f6b.css" as="style"/><link rel="stylesheet" href="/_next/static/css/21c0102bad0d4f6b.css" data-n-p=""/><noscript data-n-css=""></noscript><script defer="" nomodule="" src="/_next/static/chunks/polyfills-78c92fac7aa8fdd8.js"></script><script defer="" src="/_next/static/chunks/4119.dd6e878ab0dc30d4.js"></script><script defer="" src="/_next/static/chunks/83135.0cf6ccef6a87a594.js"></script><script defer="" src="/_next/static/chunks/8557.0af0f810791ee399.js"></script><script src="/_next/static/chunks/webpack-0c74d815ef7d27f9.js" defer=""></script><script src="/_next/static/chunks/framework-61c213e4782b3a33.js" defer=""></script><script src="/_next/static/chunks/main-fde5d6fc1693ffad.js" defer=""></script><script src="/_next/static/chunks/pages/_app-c9e975a63147be60.js" defer=""></script><script src="/_next/static/chunks/35554-9edd0ad235314945.js" defer=""></script><script src="/_next/static/chunks/35730-4e42ebe5faa80068.js" defer=""></script><script src="/_next/static/chunks/pages/docs/api-db8c107a213278f0.js" defer=""></script><script src="/_next/static/mV98qIah21cAP72QIkfFU/_buildManifest.js" defer=""></script><script src="/_next/static/mV98qIah21cAP72QIkfFU/_ssgManifest.js" defer=""></script><style data-emotion="css "></style><link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Inter:wght@300;400;500;700;900&family=Kode+Mono:wght@400..700&display=swap"/></head><body class="font-sans"><div id="__next"><div class="feedback-widget" style="--color-primary:#03eada;--color-text:#000"><button type="button" aria-label="Feedback" class="feedback-widget-trigger-button"><svg xmlns="http://www.w3.org/2000/svg" width="34" height="34" color="#000" fill="currentColor" viewBox="0 0 256 256"><path d="M132,216H47.7a7.6,7.6,0,0,1-7.7-7.7V124a92,92,0,0,1,92-92h0a92,92,0,0,1,92,92h0A92,92,0,0,1,132,216Z" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="14"></path><circle cx="132" cy="128" r="12"></circle><circle cx="84" cy="128" r="12"></circle><circle cx="180" cy="128" r="12"></circle></svg></button></div><script>!function(){try{var d=document.documentElement,c=d.classList;c.remove('light','dark');var e=localStorage.getItem('theme');if('system'===e||(!e&&true)){var t='(prefers-color-scheme: dark)',m=window.matchMedia(t);if(m.media!==t||m.matches){d.style.colorScheme = 'dark';c.add('dark')}else{d.style.colorScheme = 'light';c.add('light')}}else if(e){c.add(e|| '')}if(e==='light'||e==='dark')d.style.colorScheme=e}catch(e){}}()</script><div dir="ltr"><script>document.documentElement.setAttribute('dir','ltr')</script><div class="navbar_observer navbar_observer-inactive light:hidden fixed top-0 h-[64px] w-full transition-colors"></div><div class="light:hidden absolute top-[100px] md:top-[770px]"></div><div class="nextra-nav-container nx-sticky nx-top-0 nx-z-20 nx-w-full nx-bg-transparent print:nx-hidden"><div class="nextra-nav-container-blur bc-navbar"></div><nav class="nx-mx-auto nx-flex nx-h-[var(--nextra-navbar-height)] nx-max-w-[90rem] nx-items-center nx-justify-end nx-gap-2 nx-pl-[max(env(safe-area-inset-left),1.5rem)] nx-pr-[max(env(safe-area-inset-right),1.5rem)]"><a class="nx-flex nx-items-center hover:nx-opacity-75 ltr:nx-mr-auto rtl:nx-ml-auto" href="/"><svg width="35" height="35" viewBox="0 0 48 48" fill="none" xmlns="http://www.w3.org/2000/svg" class="mr-5"><path d="M.03 44.601a.393.393 0 0 1 .088-.43L44.162.098a.335.335 0 0 1 .434-.035l.057-.057c.956 1.12 3.14 3.176 3.14 3.176l.022.025c.082.093.185.21.185.368v44.13a.308.308 0 0 1-.294.294H3.663c-.208 0-.328-.126-.409-.211l-.029-.03c-.008-.008-.05-.05-.12-.116-.47-.454-2.165-2.09-2.812-2.813A.392.392 0 0 1 .03 44.6Z" fill="currentColor" style="fill:var(--logo-even-color)"></path><path d="M43.807 1.65v42.147H1.687L43.807 1.65Z" fill="currentColor" style="fill:var(--logo-odd-color)"></path><path fill-rule="evenodd" clip-rule="evenodd" d="M18.694 26.082v12.612a.323.323 0 0 0 .335.323h11.798c4.29 0 6.513-2.635 6.513-5.984a5.466 5.466 0 0 0-3.299-5.115.322.322 0 0 1 0-.588 5.283 5.283 0 0 0 3.201-4.737c0-2.928-2.572-5.605-6.765-5.605h-2.726l-9.057 9.095Zm5.175 8.391h5.756c.819 0 1.409-.216 1.79-.561.374-.34.597-.851.597-1.55a2.13 2.13 0 0 0-.707-1.573c-.429-.385-.971-.528-1.68-.528h-5.756v4.212Zm5.47-9.182h-5.482v-3.765h5.482c.675 0 1.192.128 1.6.472.425.358.67.869.673 1.405 0 .626-.212 1.082-.569 1.386-.362.309-.924.502-1.704.502Z" fill="currentColor" style="fill:var(--logo-even-color)"></path></svg></a><nav aria-label="Main" data-orientation="horizontal" dir="ltr" class="relative z-10 hidden w-full sm:flex"><div style="position:relative"><ul data-orientation="horizontal" class="flex items-center gap-8" dir="ltr"><li><button id="radix-:Rbl5m:-trigger-radix-:Rbbl5m:" data-state="closed" aria-expanded="false" aria-controls="radix-:Rbl5m:-content-radix-:Rbbl5m:" class="transition-color group inline-flex items-center gap-x-1 text-sm leading-6 text-gray-700 hover:text-gray-900 group-data-[state=open]:text-gray-900 dark:text-gray-300 hover:dark:text-gray-100 group-data-[state=open]:dark:text-gray-100" data-radix-collection-item=""><span class="after:pointer-events-none after:invisible after:block after:h-0 after:select-none after:overflow-hidden after:font-bold after:content-[attr(data-label)]" data-label="Documentation">Documentation</span><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 20 20" fill="currentColor" aria-hidden="true" data-slot="icon" class="h-5 w-5 transition-transform group-data-[state=open]:-rotate-180 group-data-[state=open]:font-bold"><path fill-rule="evenodd" d="M5.22 8.22a.75.75 0 0 1 1.06 0L10 11.94l3.72-3.72a.75.75 0 1 1 1.06 1.06l-4.25 4.25a.75.75 0 0 1-1.06 0L5.22 9.28a.75.75 0 0 1 0-1.06Z" clip-rule="evenodd"></path></svg></button></li><li><button id="radix-:Rbl5m:-trigger-radix-:Rjbl5m:" data-state="closed" aria-expanded="false" aria-controls="radix-:Rbl5m:-content-radix-:Rjbl5m:" class="transition-color group inline-flex items-center gap-x-1 text-sm leading-6 text-gray-700 hover:text-gray-900 group-data-[state=open]:text-gray-900 dark:text-gray-300 hover:dark:text-gray-100 group-data-[state=open]:dark:text-gray-100" data-radix-collection-item=""><span class="after:pointer-events-none after:invisible after:block after:h-0 after:select-none after:overflow-hidden after:font-bold after:content-[attr(data-label)] font-bold" data-label="API reference">API reference</span><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 20 20" fill="currentColor" aria-hidden="true" data-slot="icon" class="h-5 w-5 transition-transform group-data-[state=open]:-rotate-180 group-data-[state=open]:font-bold"><path fill-rule="evenodd" d="M5.22 8.22a.75.75 0 0 1 1.06 0L10 11.94l3.72-3.72a.75.75 0 1 1 1.06 1.06l-4.25 4.25a.75.75 0 0 1-1.06 0L5.22 9.28a.75.75 0 0 1 0-1.06Z" clip-rule="evenodd"></path></svg></button></li><li><button id="radix-:Rbl5m:-trigger-radix-:Rrbl5m:" data-state="closed" aria-expanded="false" aria-controls="radix-:Rbl5m:-content-radix-:Rrbl5m:" class="transition-color group inline-flex items-center gap-x-1 text-sm leading-6 text-gray-700 hover:text-gray-900 group-data-[state=open]:text-gray-900 dark:text-gray-300 hover:dark:text-gray-100 group-data-[state=open]:dark:text-gray-100" data-radix-collection-item=""><span class="after:pointer-events-none after:invisible after:block after:h-0 after:select-none after:overflow-hidden after:font-bold after:content-[attr(data-label)]" data-label="Community">Community</span><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 20 20" fill="currentColor" aria-hidden="true" data-slot="icon" class="h-5 w-5 transition-transform group-data-[state=open]:-rotate-180 group-data-[state=open]:font-bold"><path fill-rule="evenodd" d="M5.22 8.22a.75.75 0 0 1 1.06 0L10 11.94l3.72-3.72a.75.75 0 1 1 1.06 1.06l-4.25 4.25a.75.75 0 0 1-1.06 0L5.22 9.28a.75.75 0 0 1 0-1.06Z" clip-rule="evenodd"></path></svg></button></li></ul></div><div class="perspective-[2000px] absolute left-0 top-[calc(var(--nextra-navbar-height,4rem)-20px)] flex w-full"></div></nav><div class="flex-grow"></div><div class="flex items-center justify-between gap-4"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search documentation..."><span class="DocSearch-Button-Container overflow-clip"><span class="h-6 w-6"><svg width="24" height="24" fill="none" xmlns="http://www.w3.org/2000/svg" class="dark:fill-gray-50 dark:stroke-gray-50 dark:stroke-0"><path fill-rule="evenodd" clip-rule="evenodd" d="M14.965 14.255h.79l4.99 5-1.49 1.49-5-4.99v-.79l-.27-.28a6.471 6.471 0 0 1-4.23 1.57 6.5 6.5 0 1 1 6.5-6.5c0 1.61-.59 3.09-1.57 4.23l.28.27Zm-9.71-4.5c0 2.49 2.01 4.5 4.5 4.5s4.5-2.01 4.5-4.5-2.01-4.5-4.5-4.5-4.5 2.01-4.5 4.5Z" fill="currentColor"></path></svg></span><span class="DocSearch-Button-Placeholder">Search documentation...</span></span><span class="DocSearch-Button-Keys items-center justify-center gap-0.5 rounded px-1"></span></button><div class="hidden w-8 sm:block"><div class="relative mr-3 flex items-center sm:mx-2"><div class="NoticeableWidget Noticeable_widget__mA3EL"><svg viewBox="0 0 20 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg" class="h-auto w-4"><path d="M0 .667h12l.533 2.666H20v13.334h-9.333L10.133 14H2.667v9.333H0V.667ZM10.347 6l-.534-2.667H2.667v8h9.653L12.853 14h4.48V6h-6.986Z"></path></svg></div></div></div><div class="hidden w-8 sm:block"><div class="relative hidden h-6 w-6 cursor-pointer overflow-clip sm:block" title="Switch to dark mode"><div><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="currentColor" class="h-auto w-full"><path d="M9.528 1.718a.75.75 0 0 1 .162.819A8.97 8.97 0 0 0 9 6a9 9 0 0 0 9 9 8.97 8.97 0 0 0 3.463-.69.75.75 0 0 1 .981.98 10.503 10.503 0 0 1-9.694 6.46c-5.799 0-10.5-4.701-10.5-10.5 0-4.368 2.667-8.112 6.46-9.694a.75.75 0 0 1 .818.162z"></path></svg></div></div></div></div><div class="pl-5"><a class="transition-colors cursor-pointer rounded-md text-sm font-medium bg-blue-50 dark:bg-gray-700 text-blue-600 dark:text-blue-300 hover:bg-[#DBEAFE] dark:hover:bg-gray-800 px-3 py-[0.46875rem]" target="_blank" rel="noreferrer noopener" href="https://devtools.bigcommerce.com/my/apps">DevPortal</a></div><button type="button" aria-label="Menu" class="nextra-hamburger -nx-mr-2 nx-rounded nx-p-2 active:nx-bg-gray-400/20 md:nx-hidden"><svg fill="none" width="24" height="24" viewBox="0 0 24 24" stroke="currentColor" class=""><g><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M4 6h16"></path></g><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M4 12h16"></path><g><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M4 18h16"></path></g></svg></button></nav></div><div class="nx-mx-auto nx-flex nx-max-w-[90rem]"><div class="motion-reduce:nx-transition-none [transition:background-color_1.5s_ease] nx-bg-transparent"></div><aside class="nextra-sidebar-container nx-flex nx-flex-col md:nx-top-16 md:nx-shrink-0 motion-reduce:nx-transform-none nx-transform-gpu nx-transition-all nx-ease-in-out pr-8 print:nx-hidden md:nx-w-64 md:nx-sticky md:nx-self-start max-md:[transform:translate3d(0,-100%,0)]"><div class="nx-px-4 nx-pt-4 md:nx-hidden"><nav aria-label="Main" data-orientation="horizontal" dir="ltr" class="relative z-10 hidden w-full sm:flex"><div style="position:relative"><ul data-orientation="horizontal" class="flex items-center gap-8" dir="ltr"><li><button id="radix-:Rbjdm:-trigger-radix-:Rbbjdm:" data-state="closed" aria-expanded="false" aria-controls="radix-:Rbjdm:-content-radix-:Rbbjdm:" class="transition-color group inline-flex items-center gap-x-1 text-sm leading-6 text-gray-700 hover:text-gray-900 group-data-[state=open]:text-gray-900 dark:text-gray-300 hover:dark:text-gray-100 group-data-[state=open]:dark:text-gray-100" data-radix-collection-item=""><span class="after:pointer-events-none after:invisible after:block after:h-0 after:select-none after:overflow-hidden after:font-bold after:content-[attr(data-label)]" data-label="Documentation">Documentation</span><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 20 20" fill="currentColor" aria-hidden="true" data-slot="icon" class="h-5 w-5 transition-transform group-data-[state=open]:-rotate-180 group-data-[state=open]:font-bold"><path fill-rule="evenodd" d="M5.22 8.22a.75.75 0 0 1 1.06 0L10 11.94l3.72-3.72a.75.75 0 1 1 1.06 1.06l-4.25 4.25a.75.75 0 0 1-1.06 0L5.22 9.28a.75.75 0 0 1 0-1.06Z" clip-rule="evenodd"></path></svg></button></li><li><button id="radix-:Rbjdm:-trigger-radix-:Rjbjdm:" data-state="closed" aria-expanded="false" aria-controls="radix-:Rbjdm:-content-radix-:Rjbjdm:" class="transition-color group inline-flex items-center gap-x-1 text-sm leading-6 text-gray-700 hover:text-gray-900 group-data-[state=open]:text-gray-900 dark:text-gray-300 hover:dark:text-gray-100 group-data-[state=open]:dark:text-gray-100" data-radix-collection-item=""><span class="after:pointer-events-none after:invisible after:block after:h-0 after:select-none after:overflow-hidden after:font-bold after:content-[attr(data-label)] font-bold" data-label="API reference">API reference</span><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 20 20" fill="currentColor" aria-hidden="true" data-slot="icon" class="h-5 w-5 transition-transform group-data-[state=open]:-rotate-180 group-data-[state=open]:font-bold"><path fill-rule="evenodd" d="M5.22 8.22a.75.75 0 0 1 1.06 0L10 11.94l3.72-3.72a.75.75 0 1 1 1.06 1.06l-4.25 4.25a.75.75 0 0 1-1.06 0L5.22 9.28a.75.75 0 0 1 0-1.06Z" clip-rule="evenodd"></path></svg></button></li><li><button id="radix-:Rbjdm:-trigger-radix-:Rrbjdm:" data-state="closed" aria-expanded="false" aria-controls="radix-:Rbjdm:-content-radix-:Rrbjdm:" class="transition-color group inline-flex items-center gap-x-1 text-sm leading-6 text-gray-700 hover:text-gray-900 group-data-[state=open]:text-gray-900 dark:text-gray-300 hover:dark:text-gray-100 group-data-[state=open]:dark:text-gray-100" data-radix-collection-item=""><span class="after:pointer-events-none after:invisible after:block after:h-0 after:select-none after:overflow-hidden after:font-bold after:content-[attr(data-label)]" data-label="Community">Community</span><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 20 20" fill="currentColor" aria-hidden="true" data-slot="icon" class="h-5 w-5 transition-transform group-data-[state=open]:-rotate-180 group-data-[state=open]:font-bold"><path fill-rule="evenodd" d="M5.22 8.22a.75.75 0 0 1 1.06 0L10 11.94l3.72-3.72a.75.75 0 1 1 1.06 1.06l-4.25 4.25a.75.75 0 0 1-1.06 0L5.22 9.28a.75.75 0 0 1 0-1.06Z" clip-rule="evenodd"></path></svg></button></li></ul></div><div class="perspective-[2000px] absolute left-0 top-[calc(var(--nextra-navbar-height,4rem)-20px)] flex w-full"></div></nav><div class="flex-grow"></div><div class="flex items-center justify-between gap-4"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search documentation..."><span class="DocSearch-Button-Container overflow-clip"><span class="h-6 w-6"><svg width="24" height="24" fill="none" xmlns="http://www.w3.org/2000/svg" class="dark:fill-gray-50 dark:stroke-gray-50 dark:stroke-0"><path fill-rule="evenodd" clip-rule="evenodd" d="M14.965 14.255h.79l4.99 5-1.49 1.49-5-4.99v-.79l-.27-.28a6.471 6.471 0 0 1-4.23 1.57 6.5 6.5 0 1 1 6.5-6.5c0 1.61-.59 3.09-1.57 4.23l.28.27Zm-9.71-4.5c0 2.49 2.01 4.5 4.5 4.5s4.5-2.01 4.5-4.5-2.01-4.5-4.5-4.5-4.5 2.01-4.5 4.5Z" fill="currentColor"></path></svg></span><span class="DocSearch-Button-Placeholder">Search documentation...</span></span><span class="DocSearch-Button-Keys items-center justify-center gap-0.5 rounded px-1"></span></button><div class="hidden w-8 sm:block"><div class="relative mr-3 flex items-center sm:mx-2"><div class="NoticeableWidget Noticeable_widget__mA3EL"><svg viewBox="0 0 20 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg" class="h-auto w-4"><path d="M0 .667h12l.533 2.666H20v13.334h-9.333L10.133 14H2.667v9.333H0V.667ZM10.347 6l-.534-2.667H2.667v8h9.653L12.853 14h4.48V6h-6.986Z"></path></svg></div></div></div><div class="hidden w-8 sm:block"><div class="relative hidden h-6 w-6 cursor-pointer overflow-clip sm:block" title="Switch to dark mode"><div><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="currentColor" class="h-auto w-full"><path d="M9.528 1.718a.75.75 0 0 1 .162.819A8.97 8.97 0 0 0 9 6a9 9 0 0 0 9 9 8.97 8.97 0 0 0 3.463-.69.75.75 0 0 1 .981.98 10.503 10.503 0 0 1-9.694 6.46c-5.799 0-10.5-4.701-10.5-10.5 0-4.368 2.667-8.112 6.46-9.694a.75.75 0 0 1 .818.162z"></path></svg></div></div></div></div></div><div class="nx-overflow-y-auto nx-overflow-x-hidden nx-p-4 nx-grow md:nx-h-[calc(100vh-var(--nextra-navbar-height)-var(--nextra-menu-height))] nextra-scrollbar"><div class="nx-transform-gpu nx-overflow-hidden nx-transition-all nx-ease-in-out motion-reduce:nx-transition-none"><div class="nx-transition-opacity nx-duration-500 nx-ease-in-out motion-reduce:nx-transition-none nx-opacity-100"><ul class="nx-flex nx-flex-col nx-gap-1 nextra-menu-desktop max-md:nx-hidden"><li class="nx-flex nx-flex-col nx-gap-1 active"><a class="nx-flex nx-rounded nx-px-2 nx-py-1.5 nx-text-sm nx-transition-colors [word-break:break-word] nx-cursor-pointer [-webkit-tap-highlight-color:transparent] [-webkit-touch-callout:none] contrast-more:nx-border nx-bg-primary-100 nx-font-semibold nx-text-primary-800 dark:nx-bg-primary-400/10 dark:nx-text-primary-600 contrast-more:nx-border-primary-500 contrast-more:dark:nx-border-primary-500" href="/docs/api"><div class="inline-flex items-center"><svg viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" class="aspect-square mr-[0.625rem] inline h-auto w-5"><path fill-rule="evenodd" clip-rule="evenodd" d="M7 3h10c1.1 0 2 .9 2 2v16l-7-3-7 3V5c0-1.1.9-2 2-2Zm5 12.82L17 18V5H7v13l5-2.18Z" fill="currentColor"></path></svg><span class="font-semibold text-sm">API Reference</span></div></a></li><li class="[word-break:break-word] nx-my-3"><hr class="nx-mx-2 nx-border-t nx-border-gray-200 dark:nx-border-primary-100/10"/></li><li class="[word-break:break-word] nx-mt-6 nx-px-2 nx-py-1.5 nx-text-sm nx-font-semibold nx-text-gray-900 first:nx-mt-0 dark:nx-text-gray-100"><div class="inline-flex items-center"><span class="whitespace-nowrap text-xs text-gray-950 dark:text-white uppercase">GraphQL</span></div></li><li class="nx-flex nx-flex-col nx-gap-1"><a class="nx-flex nx-rounded nx-px-2 nx-py-1.5 nx-text-sm nx-transition-colors [word-break:break-word] nx-cursor-pointer [-webkit-tap-highlight-color:transparent] [-webkit-touch-callout:none] contrast-more:nx-border nx-text-gray-700 hover:nx-bg-gray-100 hover:nx-text-gray-900 dark:nx-text-gray-300 dark:hover:nx-bg-primary-100/5 dark:hover:nx-text-gray-50 contrast-more:nx-text-gray-900 contrast-more:dark:nx-text-gray-50 contrast-more:nx-border-transparent contrast-more:hover:nx-border-gray-900 contrast-more:dark:hover:nx-border-gray-50" href="/docs/graphql-storefront"><div class="inline-flex items-center"><svg viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg" class="aspect-square mr-[0.625rem] inline h-auto w-5"><path fill-rule="evenodd" clip-rule="evenodd" d="M3.333 3.333h13.334V5H3.333V3.333ZM15.8 10l-.5-2.5H4.7L4.2 10h11.6Zm.867-4.167H3.333L2.5 10v1.667h.833v5h8.334v-5H15v5h1.667v-5h.833V10l-.833-4.167ZM5 11.667V15h5v-3.333H5Z" fill="currentColor"></path></svg><span class="font-semibold text-sm">Storefront API</span></div></a></li><li class="nx-flex nx-flex-col nx-gap-1"><a class="nx-flex nx-rounded nx-px-2 nx-py-1.5 nx-text-sm nx-transition-colors [word-break:break-word] nx-cursor-pointer [-webkit-tap-highlight-color:transparent] [-webkit-touch-callout:none] contrast-more:nx-border nx-text-gray-700 hover:nx-bg-gray-100 hover:nx-text-gray-900 dark:nx-text-gray-300 dark:hover:nx-bg-primary-100/5 dark:hover:nx-text-gray-50 contrast-more:nx-text-gray-900 contrast-more:dark:nx-text-gray-50 contrast-more:nx-border-transparent contrast-more:hover:nx-border-gray-900 contrast-more:dark:hover:nx-border-gray-50" href="/docs/graphql-admin"><div class="inline-flex items-center"><svg viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg" class="aspect-square mr-[0.625rem] inline h-auto w-5"><path fill-rule="evenodd" clip-rule="evenodd" d="M15.05 9.642h1.674V0L.058 16.667H9.69V15H4.083L15.049 4.025v5.617Zm4.816 7.291-.892-.691c.017-.134.034-.267.034-.409a2.19 2.19 0 0 0-.034-.408l.884-.692a.216.216 0 0 0 .05-.266l-.834-1.442c-.05-.092-.158-.125-.258-.092l-1.033.417a2.85 2.85 0 0 0-.709-.408l-.158-1.1c-.008-.1-.1-.175-.2-.175H15.05c-.1 0-.191.075-.208.175l-.158 1.1c-.25.108-.492.241-.708.408l-1.034-.417a.218.218 0 0 0-.258.092l-.833 1.442c-.05.091-.034.2.05.266l.883.692a3.25 3.25 0 0 0 0 .817l-.883.691a.216.216 0 0 0-.05.267l.833 1.442c.05.091.158.125.258.091l1.034-.416c.216.166.45.308.708.408l.158 1.1c.017.1.1.175.209.175h1.666c.1 0 .192-.075.208-.175l.159-1.1c.25-.108.492-.242.7-.408l1.041.416c.092.034.2 0 .259-.091l.833-1.442a.216.216 0 0 0-.05-.267Zm-5.233-1.1c0 .692.558 1.25 1.25 1.25s1.25-.558 1.25-1.25c0-.691-.558-1.25-1.25-1.25s-1.25.559-1.25 1.25Z" fill="currentColor"></path></svg><span class="font-semibold text-sm">Admin API</span></div></a></li><li class="nx-flex nx-flex-col nx-gap-1"><a class="nx-flex nx-rounded nx-px-2 nx-py-1.5 nx-text-sm nx-transition-colors [word-break:break-word] nx-cursor-pointer [-webkit-tap-highlight-color:transparent] [-webkit-touch-callout:none] contrast-more:nx-border nx-text-gray-700 hover:nx-bg-gray-100 hover:nx-text-gray-900 dark:nx-text-gray-300 dark:hover:nx-bg-primary-100/5 dark:hover:nx-text-gray-50 contrast-more:nx-text-gray-900 contrast-more:dark:nx-text-gray-50 contrast-more:nx-border-transparent contrast-more:hover:nx-border-gray-900 contrast-more:dark:hover:nx-border-gray-50" href="/docs/graphql-account"><div class="inline-flex items-center"><svg width="25" height="24" fill="none" xmlns="http://www.w3.org/2000/svg" class="aspect-square mr-[0.625rem] inline h-auto w-5"><path fill-rule="evenodd" clip-rule="evenodd" d="M10.5 7c1.1 0 2 .9 2 2v6c0 1.1-.9 2-2 2h-6c-1.1 0-2-.9-2-2V9c0-1.1.9-2 2-2h6zm12 0h-8v2h8V7zm0 6h-8v-2h8v2zm0 4h-8v-2h8v2zM8.75 12 11 15H4l1.75-2.25L7 14.26 8.75 12z" fill="currentColor"></path></svg><span class="font-semibold text-sm">Account API</span></div></a></li><li class="nx-flex nx-flex-col nx-gap-1"><a class="nx-flex nx-rounded nx-px-2 nx-py-1.5 nx-text-sm nx-transition-colors [word-break:break-word] nx-cursor-pointer [-webkit-tap-highlight-color:transparent] [-webkit-touch-callout:none] contrast-more:nx-border nx-text-gray-700 hover:nx-bg-gray-100 hover:nx-text-gray-900 dark:nx-text-gray-300 dark:hover:nx-bg-primary-100/5 dark:hover:nx-text-gray-50 contrast-more:nx-text-gray-900 contrast-more:dark:nx-text-gray-50 contrast-more:nx-border-transparent contrast-more:hover:nx-border-gray-900 contrast-more:dark:hover:nx-border-gray-50" href="https://api-b2b.bigcommerce.com/graphql/playground"><div class="inline-flex items-center"><svg viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" class="aspect-square mr-[0.625rem] inline h-auto w-5"><path fill-rule="evenodd" clip-rule="evenodd" d="M2 21V3h10v4h10v14H2Zm2-2h6v-2H4v2Zm0-4h6v-2H4v2Zm0-4h6V9H4v2Zm0-4h6V5H4v2Zm8 12h8V9h-8v10Zm2-6v-2h4v2h-4Zm0 4v-2h4v2h-4Z" fill="currentColor"></path></svg><span class="font-semibold text-sm">B2B Storefront API</span></div></a></li><li class="[word-break:break-word] nx-mt-6 nx-px-2 nx-py-1.5 nx-text-sm nx-font-semibold nx-text-gray-900 first:nx-mt-0 dark:nx-text-gray-100"><div class="inline-flex items-center"><span class="whitespace-nowrap text-xs text-gray-950 dark:text-white uppercase">REST</span></div></li><li class="nx-flex nx-flex-col nx-gap-1"><a class="nx-flex nx-rounded nx-px-2 nx-py-1.5 nx-text-sm nx-transition-colors [word-break:break-word] nx-cursor-pointer [-webkit-tap-highlight-color:transparent] [-webkit-touch-callout:none] contrast-more:nx-border nx-text-gray-700 hover:nx-bg-gray-100 hover:nx-text-gray-900 dark:nx-text-gray-300 dark:hover:nx-bg-primary-100/5 dark:hover:nx-text-gray-50 contrast-more:nx-text-gray-900 contrast-more:dark:nx-text-gray-50 contrast-more:nx-border-transparent contrast-more:hover:nx-border-gray-900 contrast-more:dark:hover:nx-border-gray-50" href="/docs/rest-authentication"><div class="inline-flex items-center"><svg viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg" class="aspect-square mr-[0.625rem] inline h-auto w-5"><path fill-rule="evenodd" clip-rule="evenodd" d="M9 12c1.93 0 3.5-1.57 3.5-3.5S10.93 5 9 5 5.5 6.57 5.5 8.5 7.07 12 9 12Zm-7 5.25c0-2.33 4.66-3.5 7-3.5s7 1.17 7 3.5V19H2v-1.75Zm7-1.5c-1.79 0-3.82.67-4.66 1.25h9.32c-.84-.58-2.87-1.25-4.66-1.25Zm1.5-7.25C10.5 7.67 9.83 7 9 7s-1.5.67-1.5 1.5S8.17 10 9 10s1.5-.67 1.5-1.5Zm5.54 5.31c1.16.84 1.96 1.96 1.96 3.44V19h4v-1.75c0-2.02-3.5-3.17-5.96-3.44ZM18.5 8.5c0 1.93-1.57 3.5-3.5 3.5-.54 0-1.04-.13-1.5-.35.63-.89 1-1.98 1-3.15s-.37-2.26-1-3.15c.46-.22.96-.35 1.5-.35 1.93 0 3.5 1.57 3.5 3.5Z"></path></svg><span class="font-semibold text-sm">Authentication APIs</span></div></a></li><li class="nx-flex nx-flex-col nx-gap-1"><a class="nx-flex nx-rounded nx-px-2 nx-py-1.5 nx-text-sm nx-transition-colors [word-break:break-word] nx-cursor-pointer [-webkit-tap-highlight-color:transparent] [-webkit-touch-callout:none] contrast-more:nx-border nx-text-gray-700 hover:nx-bg-gray-100 hover:nx-text-gray-900 dark:nx-text-gray-300 dark:hover:nx-bg-primary-100/5 dark:hover:nx-text-gray-50 contrast-more:nx-text-gray-900 contrast-more:dark:nx-text-gray-50 contrast-more:nx-border-transparent contrast-more:hover:nx-border-gray-900 contrast-more:dark:hover:nx-border-gray-50" href="/docs/rest-storefront"><div class="inline-flex items-center"><svg viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg" class="aspect-square mr-[0.625rem] inline h-auto w-5"><path fill-rule="evenodd" clip-rule="evenodd" d="M3.333 3.333h13.334V5H3.333V3.333ZM15.8 10l-.5-2.5H4.7L4.2 10h11.6Zm.867-4.167H3.333L2.5 10v1.667h.833v5h8.334v-5H15v5h1.667v-5h.833V10l-.833-4.167ZM5 11.667V15h5v-3.333H5Z" fill="currentColor"></path></svg><span class="font-semibold text-sm">Storefront API</span></div></a></li><li class="nx-flex nx-flex-col nx-gap-1"><a class="nx-flex nx-rounded nx-px-2 nx-py-1.5 nx-text-sm nx-transition-colors [word-break:break-word] nx-cursor-pointer [-webkit-tap-highlight-color:transparent] [-webkit-touch-callout:none] contrast-more:nx-border nx-text-gray-700 hover:nx-bg-gray-100 hover:nx-text-gray-900 dark:nx-text-gray-300 dark:hover:nx-bg-primary-100/5 dark:hover:nx-text-gray-50 contrast-more:nx-text-gray-900 contrast-more:dark:nx-text-gray-50 contrast-more:nx-border-transparent contrast-more:hover:nx-border-gray-900 contrast-more:dark:hover:nx-border-gray-50" href="/docs/rest-management"><div class="inline-flex items-center"><svg viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg" class="aspect-square mr-[0.625rem] inline h-auto w-5"><path fill-rule="evenodd" clip-rule="evenodd" d="M15.05 9.642h1.674V0L.058 16.667H9.69V15H4.083L15.049 4.025v5.617Zm4.816 7.291-.892-.691c.017-.134.034-.267.034-.409a2.19 2.19 0 0 0-.034-.408l.884-.692a.216.216 0 0 0 .05-.266l-.834-1.442c-.05-.092-.158-.125-.258-.092l-1.033.417a2.85 2.85 0 0 0-.709-.408l-.158-1.1c-.008-.1-.1-.175-.2-.175H15.05c-.1 0-.191.075-.208.175l-.158 1.1c-.25.108-.492.241-.708.408l-1.034-.417a.218.218 0 0 0-.258.092l-.833 1.442c-.05.091-.034.2.05.266l.883.692a3.25 3.25 0 0 0 0 .817l-.883.691a.216.216 0 0 0-.05.267l.833 1.442c.05.091.158.125.258.091l1.034-.416c.216.166.45.308.708.408l.158 1.1c.017.1.1.175.209.175h1.666c.1 0 .192-.075.208-.175l.159-1.1c.25-.108.492-.242.7-.408l1.041.416c.092.034.2 0 .259-.091l.833-1.442a.216.216 0 0 0-.05-.267Zm-5.233-1.1c0 .692.558 1.25 1.25 1.25s1.25-.558 1.25-1.25c0-.691-.558-1.25-1.25-1.25s-1.25.559-1.25 1.25Z" fill="currentColor"></path></svg><span class="font-semibold text-sm">Management API</span></div></a></li><li class="nx-flex nx-flex-col nx-gap-1"><a class="nx-flex nx-rounded nx-px-2 nx-py-1.5 nx-text-sm nx-transition-colors [word-break:break-word] nx-cursor-pointer [-webkit-tap-highlight-color:transparent] [-webkit-touch-callout:none] contrast-more:nx-border nx-text-gray-700 hover:nx-bg-gray-100 hover:nx-text-gray-900 dark:nx-text-gray-300 dark:hover:nx-bg-primary-100/5 dark:hover:nx-text-gray-50 contrast-more:nx-text-gray-900 contrast-more:dark:nx-text-gray-50 contrast-more:nx-border-transparent contrast-more:hover:nx-border-gray-900 contrast-more:dark:hover:nx-border-gray-50" href="/docs/rest-catalog"><div class="inline-flex items-center"><svg viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" class="aspect-square mr-[0.625rem] inline h-auto w-5"><path fill-rule="evenodd" clip-rule="evenodd" d="M19 3h-4.18C14.4 1.84 13.3 1 12 1c-1.3 0-2.4.84-2.82 2H5c-1.1 0-2 .9-2 2v16c0 1.1.9 2 2 2h14c1.1 0 2-.9 2-2V5c0-1.1-.9-2-2-2Zm-7 0c.55 0 1 .45 1 1s-.45 1-1 1-1-.45-1-1 .45-1 1-1ZM5 5v16h14V5h-2v3H7V5H5Z" fill="currentColor"></path></svg><span class="font-semibold text-sm">Catalog API</span></div></a></li><li class="nx-flex nx-flex-col nx-gap-1"><a class="nx-flex nx-rounded nx-px-2 nx-py-1.5 nx-text-sm nx-transition-colors [word-break:break-word] nx-cursor-pointer [-webkit-tap-highlight-color:transparent] [-webkit-touch-callout:none] contrast-more:nx-border nx-text-gray-700 hover:nx-bg-gray-100 hover:nx-text-gray-900 dark:nx-text-gray-300 dark:hover:nx-bg-primary-100/5 dark:hover:nx-text-gray-50 contrast-more:nx-text-gray-900 contrast-more:dark:nx-text-gray-50 contrast-more:nx-border-transparent contrast-more:hover:nx-border-gray-900 contrast-more:dark:hover:nx-border-gray-50" href="/docs/rest-payments"><div class="inline-flex items-center"><svg viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" class="aspect-square mr-[0.625rem] inline h-auto w-5"><path fill-rule="evenodd" clip-rule="evenodd" d="M20 4H4c-1.11 0-1.99.89-1.99 2L2 18c0 1.11.89 2 2 2h16c1.11 0 2-.89 2-2V6c0-1.11-.89-2-2-2Zm0 14H4v-6h16v6ZM4 8h16V6H4v2Z" fill="currentColor"></path></svg><span class="font-semibold text-sm">Payments API</span></div></a></li><li class="nx-flex nx-flex-col nx-gap-1"><a class="nx-flex nx-rounded nx-px-2 nx-py-1.5 nx-text-sm nx-transition-colors [word-break:break-word] nx-cursor-pointer [-webkit-tap-highlight-color:transparent] [-webkit-touch-callout:none] contrast-more:nx-border nx-text-gray-700 hover:nx-bg-gray-100 hover:nx-text-gray-900 dark:nx-text-gray-300 dark:hover:nx-bg-primary-100/5 dark:hover:nx-text-gray-50 contrast-more:nx-text-gray-900 contrast-more:dark:nx-text-gray-50 contrast-more:nx-border-transparent contrast-more:hover:nx-border-gray-900 contrast-more:dark:hover:nx-border-gray-50" href="/docs/rest-content"><div class="inline-flex items-center"><svg viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg" class="aspect-square mr-[0.625rem] inline h-auto w-5"><path fill-rule="evenodd" clip-rule="evenodd" d="M2 12c0 5.51 4.49 10 10 10a2.5 2.5 0 0 0 2.5-2.5c0-.61-.23-1.2-.64-1.67a.528.528 0 0 1-.13-.33c0-.28.22-.5.5-.5H16c3.31 0 6-2.69 6-6 0-4.96-4.49-9-10-9S2 6.49 2 12Zm2 0c0-4.41 3.59-8 8-8s8 3.14 8 7c0 2.21-1.79 4-4 4h-1.77a2.5 2.5 0 0 0-2.5 2.5c0 .6.22 1.19.63 1.65.06.07.14.19.14.35 0 .28-.22.5-.5.5-4.41 0-8-3.59-8-8Zm2.5-2a1.5 1.5 0 1 0 0 3 1.5 1.5 0 0 0 0-3ZM8 7.5a1.5 1.5 0 1 1 3 0 1.5 1.5 0 0 1-3 0ZM14.5 6a1.5 1.5 0 1 0 0 3 1.5 1.5 0 0 0 0-3Zm1.5 5.5a1.5 1.5 0 1 1 3 0 1.5 1.5 0 0 1-3 0Z"></path></svg><span class="font-semibold text-sm">Content API</span></div></a></li><li class="nx-flex nx-flex-col nx-gap-1"><a class="nx-flex nx-rounded nx-px-2 nx-py-1.5 nx-text-sm nx-transition-colors [word-break:break-word] nx-cursor-pointer [-webkit-tap-highlight-color:transparent] [-webkit-touch-callout:none] contrast-more:nx-border nx-text-gray-700 hover:nx-bg-gray-100 hover:nx-text-gray-900 dark:nx-text-gray-300 dark:hover:nx-bg-primary-100/5 dark:hover:nx-text-gray-50 contrast-more:nx-text-gray-900 contrast-more:dark:nx-text-gray-50 contrast-more:nx-border-transparent contrast-more:hover:nx-border-gray-900 contrast-more:dark:hover:nx-border-gray-50" href="/b2b-edition/apis"><div class="inline-flex items-center"><svg viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" class="aspect-square mr-[0.625rem] inline h-auto w-5"><path fill-rule="evenodd" clip-rule="evenodd" d="M2 21V3h10v4h10v14H2Zm2-2h6v-2H4v2Zm0-4h6v-2H4v2Zm0-4h6V9H4v2Zm0-4h6V5H4v2Zm8 12h8V9h-8v10Zm2-6v-2h4v2h-4Zm0 4v-2h4v2h-4Z" fill="currentColor"></path></svg><span class="font-semibold text-sm">B2B APIs</span></div></a></li><li class="[word-break:break-word] nx-mt-6 nx-px-2 nx-py-1.5 nx-text-sm nx-font-semibold nx-text-gray-900 first:nx-mt-0 dark:nx-text-gray-100"><div class="inline-flex items-center"><span class="whitespace-nowrap text-xs text-gray-950 dark:text-white uppercase">Integrations</span></div></li><li class="nx-flex nx-flex-col nx-gap-1"><a class="nx-flex nx-rounded nx-px-2 nx-py-1.5 nx-text-sm nx-transition-colors [word-break:break-word] nx-cursor-pointer [-webkit-tap-highlight-color:transparent] [-webkit-touch-callout:none] contrast-more:nx-border nx-text-gray-700 hover:nx-bg-gray-100 hover:nx-text-gray-900 dark:nx-text-gray-300 dark:hover:nx-bg-primary-100/5 dark:hover:nx-text-gray-50 contrast-more:nx-text-gray-900 contrast-more:dark:nx-text-gray-50 contrast-more:nx-border-transparent contrast-more:hover:nx-border-gray-900 contrast-more:dark:hover:nx-border-gray-50" href="/docs/webhooks"><div class="inline-flex items-center"><svg viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg" class="aspect-square mr-[0.625rem] inline h-auto w-5"><path d="M12 2.25A5.26 5.26 0 0 0 6.75 7.5c0 1.57.776 2.903 1.875 3.867l-1.57 2.906a2.109 2.109 0 0 0-.305-.023A2.262 2.262 0 0 0 4.5 16.5a2.262 2.262 0 0 0 2.25 2.25A2.262 2.262 0 0 0 9 16.5a2.24 2.24 0 0 0-.633-1.547l2.133-3.96-.563-.376A3.734 3.734 0 0 1 8.25 7.5c0-2.08 1.67-3.75 3.75-3.75s3.75 1.67 3.75 3.75c0 .44-.073.853-.21 1.242l1.405.516A5.227 5.227 0 0 0 17.25 7.5 5.26 5.26 0 0 0 12 2.25Zm0 3A2.262 2.262 0 0 0 9.75 7.5 2.262 2.262 0 0 0 12 9.75c.105 0 .202-.009.305-.023l2.062 3.28.375.61.633-.375c.55-.32 1.19-.492 1.875-.492 2.08 0 3.75 1.67 3.75 3.75s-1.67 3.75-3.75 3.75a3.709 3.709 0 0 1-2.79-1.242l-1.124.984a5.26 5.26 0 0 0 3.914 1.758 5.26 5.26 0 0 0 5.25-5.25 5.26 5.26 0 0 0-5.25-5.25c-.691 0-1.292.273-1.898.516L13.64 9.023c.375-.4.609-.937.609-1.523A2.262 2.262 0 0 0 12 5.25Zm0 1.5a.74.74 0 0 1 .75.75.74.74 0 0 1-.75.75.74.74 0 0 1-.75-.75.74.74 0 0 1 .75-.75Zm-6.117 4.57c-.6.103-1.201.31-1.758.633a5.264 5.264 0 0 0-1.922 7.172c1.444 2.502 4.667 3.366 7.172 1.922 1.433-.83 2.206-2.274 2.438-3.797h3.328c.313.867 1.14 1.5 2.109 1.5a2.262 2.262 0 0 0 2.25-2.25 2.262 2.262 0 0 0-2.25-2.25c-.97 0-1.796.633-2.11 1.5H10.5v.75a3.753 3.753 0 0 1-7.008 1.875 3.753 3.753 0 0 1 2.625-5.578l-.234-1.477Zm.867 4.43a.74.74 0 0 1 .75.75.74.74 0 0 1-.75.75.74.74 0 0 1-.75-.75.74.74 0 0 1 .75-.75Zm10.5 0a.74.74 0 0 1 .75.75.74.74 0 0 1-.75.75.74.74 0 0 1-.75-.75.74.74 0 0 1 .75-.75Z"></path></svg><span class="font-semibold text-sm">Webhooks</span></div></a></li><li class="nx-flex nx-flex-col nx-gap-1"><a class="nx-flex nx-rounded nx-px-2 nx-py-1.5 nx-text-sm nx-transition-colors [word-break:break-word] nx-cursor-pointer [-webkit-tap-highlight-color:transparent] [-webkit-touch-callout:none] contrast-more:nx-border nx-text-gray-700 hover:nx-bg-gray-100 hover:nx-text-gray-900 dark:nx-text-gray-300 dark:hover:nx-bg-primary-100/5 dark:hover:nx-text-gray-50 contrast-more:nx-text-gray-900 contrast-more:dark:nx-text-gray-50 contrast-more:nx-border-transparent contrast-more:hover:nx-border-gray-900 contrast-more:dark:hover:nx-border-gray-50" href="/docs/rest-contracts/shipping"><div class="inline-flex items-center"><svg viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" class="aspect-square mr-[0.625rem] inline h-auto w-5"><path fill-rule="evenodd" clip-rule="evenodd" d="M20 8h-3V4H3c-1.1 0-2 .9-2 2v11h2c0 1.66 1.34 3 3 3s3-1.34 3-3h6c0 1.66 1.34 3 3 3s3-1.34 3-3h2v-5l-3-4Zm-.5 1.5 1.96 2.5H17V9.5h2.5ZM5 17c0 .55.45 1 1 1s1-.45 1-1-.45-1-1-1-1 .45-1 1Zm3.22-2c-.55-.61-1.33-1-2.22-1-.89 0-1.67.39-2.22 1H3V6h12v9H8.22ZM17 17c0 .55.45 1 1 1s1-.45 1-1-.45-1-1-1-1 .45-1 1Z" fill="currentColor"></path></svg><span class="font-semibold text-sm">Shipping Provider API</span></div></a></li><li class="nx-flex nx-flex-col nx-gap-1"><a class="nx-flex nx-rounded nx-px-2 nx-py-1.5 nx-text-sm nx-transition-colors [word-break:break-word] nx-cursor-pointer [-webkit-tap-highlight-color:transparent] [-webkit-touch-callout:none] contrast-more:nx-border nx-text-gray-700 hover:nx-bg-gray-100 hover:nx-text-gray-900 dark:nx-text-gray-300 dark:hover:nx-bg-primary-100/5 dark:hover:nx-text-gray-50 contrast-more:nx-text-gray-900 contrast-more:dark:nx-text-gray-50 contrast-more:nx-border-transparent contrast-more:hover:nx-border-gray-900 contrast-more:dark:hover:nx-border-gray-50" href="/docs/rest-contracts/tax"><div class="inline-flex items-center"><svg viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg" class="aspect-square mr-[0.625rem] inline h-auto w-5"><path fill-rule="evenodd" clip-rule="evenodd" d="M1.5 5h12v2h-12V5Zm0 4h12v2h-12V9Zm0 6h8v-2h-8v2Zm21-3L21 10.5 15.51 16l-3.01-3-1.5 1.5 4.51 4.5 6.99-7Z"></path></svg><span class="font-semibold text-sm">Tax Provider API</span></div></a></li></ul></div></div></div><div class="nx-sticky nx-bottom-0 nx-bg-white dark:nx-bg-dark nx-mx-4 nx-py-4 nx-shadow-[0_-12px_16px_#fff] nx-flex nx-items-center nx-gap-2 dark:nx-border-neutral-800 dark:nx-shadow-[0_-12px_16px_#111] contrast-more:nx-border-neutral-400 contrast-more:nx-shadow-none contrast-more:dark:nx-shadow-none nx-border-t" data-toggle-animation="off"><div class="nx-grow nx-flex nx-flex-col"></div><button title="Hide sidebar" class="max-md:nx-hidden nx-h-7 nx-rounded-md nx-transition-colors nx-text-gray-600 dark:nx-text-gray-400 nx-px-2 hover:nx-bg-gray-100 hover:nx-text-gray-900 dark:hover:nx-bg-primary-100/5 dark:hover:nx-text-gray-50"><svg height="12" width="12" viewBox="0 0 16 16" fill="currentColor"><path fill-rule="evenodd" d="M4.177 7.823l2.396-2.396A.25.25 0 017 5.604v4.792a.25.25 0 01-.427.177L4.177 8.177a.25.25 0 010-.354z" class=""></path><path fill-rule="evenodd" d="M0 1.75C0 .784.784 0 1.75 0h12.5C15.216 0 16 .784 16 1.75v12.5A1.75 1.75 0 0114.25 16H1.75A1.75 1.75 0 010 14.25V1.75zm1.75-.25a.25.25 0 00-.25.25v12.5c0 .138.112.25.25.25H9.5v-13H1.75zm12.5 13H11v-13h3.25a.25.25 0 01.25.25v12.5a.25.25 0 01-.25.25z"></path></svg></button></div></aside><div id="reach-skip-nav"></div><article class="nx-w-full nx-break-words nextra-content nx-min-h-[calc(100vh-var(--nextra-navbar-height))] nx-pl-[max(env(safe-area-inset-left),1.5rem)] nx-pr-[max(env(safe-area-inset-right),1.5rem)]"><div class="flex h-full flex-col"><div class="mt-6 text-sm">Overview</div> <h1 class="nx-mt-2 nx-text-4xl nx-font-bold nx-tracking-tight nx-text-slate-900 dark:nx-text-slate-100">API reference</h1> <p class="nx-mt-6 nx-leading-7 first:nx-mt-0">Build applications that grow merchant business using our extensive collection of endpoints, webhooks, and other core solutions.</p> <div class="flex Stack_horizontal__M7FJR Stack_gap-medium__dK55U Stack_divider-horizontal__8N5ZA py-12"><a class="block w-full rounded-lg transition ease-in-out duration-200 group dark:bg-bc-dark-blue p-6 border border-gray-200 dark:border-gray-800 hover:shadow-[0_2px_8px_1px_rgb(0_0_0_/_0.1),0_0_4px_2px_rgb(0_0_0_/_0.1)] dark:hover:shadow-[0px_4px_7px_rgb(255_248_248_/_0.03),0px_2px_3px_1px_rgb(255_255_255_/_0.03)] hover:border-transparent shadow-[rgb(0_0_0_/_0.1)]" href="/docs/graphql-storefront"><div class="flex h-full w-full flex-col gap-4"><div class="self-start"><div class="aspect-square rounded-md p-2 text-blue-600 dark:text-blue-300 w-[40px] bg-blue-600 dark:bg-blue-300"><svg viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg" class="aspect-square w-6 h-6 text-white dark:text-black"><path d="m4.175 7.091 6.628-3.867-.806-1.382L3.368 5.71l.807 1.382ZM3.2 15.2V8.8H1.6v6.4h1.6Zm9.997-11.976 6.628 3.867.806-1.382-6.628-3.867-.806 1.382ZM20.8 8.8v6.4h1.6V8.8h-1.6Zm-.403 7.776-7.2 4.2.806 1.382 7.2-4.2-.806-1.382Zm-9.594 4.2-6.628-3.867-.807 1.382 6.629 3.867.806-1.382Zm-.269-17.62-8 12 1.332.888 8-12-1.332-.888Zm10.932 12-8-12-1.332.888 8 12 1.332-.888ZM4 17.6h16V16H4v1.6Zm8-14.4a.8.8 0 0 1-.8-.8H9.6A2.4 2.4 0 0 0 12 4.8V3.2Zm.8-.8a.8.8 0 0 1-.8.8v1.6a2.4 2.4 0 0 0 2.4-2.4h-1.6Zm-.8-.8a.8.8 0 0 1 .8.8h1.6A2.4 2.4 0 0 0 12 0v1.6ZM12 0a2.4 2.4 0 0 0-2.4 2.4h1.6a.8.8 0 0 1 .8-.8V0Zm9.6 8a.8.8 0 0 1-.8-.8h-1.6a2.4 2.4 0 0 0 2.4 2.4V8Zm.8-.8a.8.8 0 0 1-.8.8v1.6A2.4 2.4 0 0 0 24 7.2h-1.6Zm-.8-.8a.8.8 0 0 1 .8.8H24a2.4 2.4 0 0 0-2.4-2.4v1.6Zm0-1.6a2.4 2.4 0 0 0-2.4 2.4h1.6a.8.8 0 0 1 .8-.8V4.8Zm0 12.8a.8.8 0 0 1-.8-.8h-1.6a2.4 2.4 0 0 0 2.4 2.4v-1.6Zm.8-.8a.8.8 0 0 1-.8.8v1.6a2.4 2.4 0 0 0 2.4-2.4h-1.6Zm-.8-.8a.8.8 0 0 1 .8.8H24a2.4 2.4 0 0 0-2.4-2.4V16Zm0-1.6a2.4 2.4 0 0 0-2.4 2.4h1.6a.8.8 0 0 1 .8-.8v-1.6Zm-9.6 8a.8.8 0 0 1-.8-.8H9.6A2.4 2.4 0 0 0 12 24v-1.6Zm.8-.8a.8.8 0 0 1-.8.8V24a2.4 2.4 0 0 0 2.4-2.4h-1.6Zm-.8-.8a.8.8 0 0 1 .8.8h1.6a2.4 2.4 0 0 0-2.4-2.4v1.6Zm0-1.6a2.4 2.4 0 0 0-2.4 2.4h1.6a.8.8 0 0 1 .8-.8v-1.6Zm-9.6-1.6a.8.8 0 0 1-.8-.8H0a2.4 2.4 0 0 0 2.4 2.4v-1.6Zm.8-.8a.8.8 0 0 1-.8.8v1.6a2.4 2.4 0 0 0 2.4-2.4H3.2Zm-.8-.8a.8.8 0 0 1 .8.8h1.6a2.4 2.4 0 0 0-2.4-2.4V16Zm0-1.6A2.4 2.4 0 0 0 0 16.8h1.6a.8.8 0 0 1 .8-.8v-1.6Zm0-6.4a.8.8 0 0 1-.8-.8H0a2.4 2.4 0 0 0 2.4 2.4V8Zm.8-.8a.8.8 0 0 1-.8.8v1.6a2.4 2.4 0 0 0 2.4-2.4H3.2Zm-.8-.8a.8.8 0 0 1 .8.8h1.6a2.4 2.4 0 0 0-2.4-2.4v1.6Zm0-1.6A2.4 2.4 0 0 0 0 7.2h1.6a.8.8 0 0 1 .8-.8V4.8Z"></path></svg></div></div><div class="grow space-y-4"><p class="flex items-center gap-1 font-medium group-hover:text-blue-600 dark:group-hover:text-blue-300">GraphQL APIs <svg viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg" class="h-auto w-4 transition-transform group-hover:translate-x-1"><path d="M3.75 9.75h8.377l-3.66 3.66a.756.756 0 0 0 0 1.065.747.747 0 0 0 1.058 0l4.942-4.942a.747.747 0 0 0 0-1.058l-4.934-4.95a.747.747 0 1 0-1.058 1.058l3.652 3.667H3.75A.752.752 0 0 0 3 9c0 .413.337.75.75.75Z" fill="currentColor"></path></svg></p><p class="leading-6 text-gray-500 dark:text-gray-300">Find the mutations and queries you need from our GraphQL Storefront, Admin, and Account APIs.</p></div><div class="relative mt-auto inline-flex items-center text-black dark:text-white"><div class="inline-flex flex-wrap gap-x-2 gap-y-3 py-2"><a class="whitespace-nowrap rounded-full px-3 py-0.5 text-sm font-medium transition-colors bg-gray-100 text-gray-700 hover:bg-blue-600 hover:text-white active:bg-blue-700 dark:bg-gray-700 dark:text-white dark:hover:bg-blue-300 dark:hover:text-gray-900 dark:active:bg-blue-400" href="/docs/graphql-storefront">Overview</a><a class="whitespace-nowrap rounded-full px-3 py-0.5 text-sm font-medium transition-colors bg-gray-100 text-gray-700 hover:bg-blue-600 hover:text-white active:bg-blue-700 dark:bg-gray-700 dark:text-white dark:hover:bg-blue-300 dark:hover:text-gray-900 dark:active:bg-blue-400" href="/graphql-storefront/explorer">Explorer</a><a class="whitespace-nowrap rounded-full px-3 py-0.5 text-sm font-medium transition-colors bg-gray-100 text-gray-700 hover:bg-blue-600 hover:text-white active:bg-blue-700 dark:bg-gray-700 dark:text-white dark:hover:bg-blue-300 dark:hover:text-gray-900 dark:active:bg-blue-400" href="/graphql-playground">Playground</a><a class="whitespace-nowrap rounded-full px-3 py-0.5 text-sm font-medium transition-colors bg-gray-100 text-gray-700 hover:bg-blue-600 hover:text-white active:bg-blue-700 dark:bg-gray-700 dark:text-white dark:hover:bg-blue-300 dark:hover:text-gray-900 dark:active:bg-blue-400" href="/graphql-storefront/reference#group-Operations-Queries">Queries & Mutations</a></div></div></div></a><a class="block w-full rounded-lg transition ease-in-out duration-200 group dark:bg-bc-dark-blue p-6 border border-gray-200 dark:border-gray-800 hover:shadow-[0_2px_8px_1px_rgb(0_0_0_/_0.1),0_0_4px_2px_rgb(0_0_0_/_0.1)] dark:hover:shadow-[0px_4px_7px_rgb(255_248_248_/_0.03),0px_2px_3px_1px_rgb(255_255_255_/_0.03)] hover:border-transparent shadow-[rgb(0_0_0_/_0.1)]" href="/docs/rest-management"><div class="flex h-full w-full flex-col gap-4"><div class="self-start"><div class="aspect-square rounded-md p-2 text-blue-600 dark:text-blue-300 w-[40px] bg-blue-600 dark:bg-blue-300"><svg viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg" class="aspect-square w-6 h-6 text-white dark:text-black"><path fill-rule="evenodd" clip-rule="evenodd" d="m4.8 12 4.6 4.6L8 18l-6-6 6-6 1.4 1.4L4.8 12Zm14.4 0-4.6 4.6L16 18l6-6-6-6-1.4 1.4 4.6 4.6Z"></path></svg></div></div><div class="grow space-y-4"><p class="flex items-center gap-1 font-medium group-hover:text-blue-600 dark:group-hover:text-blue-300">REST APIs <svg viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg" class="h-auto w-4 transition-transform group-hover:translate-x-1"><path d="M3.75 9.75h8.377l-3.66 3.66a.756.756 0 0 0 0 1.065.747.747 0 0 0 1.058 0l4.942-4.942a.747.747 0 0 0 0-1.058l-4.934-4.95a.747.747 0 1 0-1.058 1.058l3.652 3.667H3.75A.752.752 0 0 0 3 9c0 .413.337.75.75.75Z" fill="currentColor"></path></svg></p><p class="leading-6 text-gray-500 dark:text-gray-300">Customize store features and integrations using our comprehensive set of REST APIs.</p></div><div class="relative mt-auto inline-flex items-center text-black dark:text-white"><div class="inline-flex flex-wrap gap-x-2 gap-y-3 py-2"><a class="whitespace-nowrap rounded-full px-3 py-0.5 text-sm font-medium transition-colors bg-gray-100 text-gray-700 hover:bg-blue-600 hover:text-white active:bg-blue-700 dark:bg-gray-700 dark:text-white dark:hover:bg-blue-300 dark:hover:text-gray-900 dark:active:bg-blue-400" href="/docs/rest-catalog/products">Products</a><a class="whitespace-nowrap rounded-full px-3 py-0.5 text-sm font-medium transition-colors bg-gray-100 text-gray-700 hover:bg-blue-600 hover:text-white active:bg-blue-700 dark:bg-gray-700 dark:text-white dark:hover:bg-blue-300 dark:hover:text-gray-900 dark:active:bg-blue-400" href="/docs/rest-management/orders">Orders</a><a class="whitespace-nowrap rounded-full px-3 py-0.5 text-sm font-medium transition-colors bg-gray-100 text-gray-700 hover:bg-blue-600 hover:text-white active:bg-blue-700 dark:bg-gray-700 dark:text-white dark:hover:bg-blue-300 dark:hover:text-gray-900 dark:active:bg-blue-400" href="/docs/rest-management">Management API</a><a class="whitespace-nowrap rounded-full px-3 py-0.5 text-sm font-medium transition-colors bg-gray-100 text-gray-700 hover:bg-blue-600 hover:text-white active:bg-blue-700 dark:bg-gray-700 dark:text-white dark:hover:bg-blue-300 dark:hover:text-gray-900 dark:active:bg-blue-400" href="/docs/rest-management/customers">Customers</a><a class="whitespace-nowrap rounded-full px-3 py-0.5 text-sm font-medium transition-colors bg-gray-100 text-gray-700 hover:bg-blue-600 hover:text-white active:bg-blue-700 dark:bg-gray-700 dark:text-white dark:hover:bg-blue-300 dark:hover:text-gray-900 dark:active:bg-blue-400" href="/docs/rest-storefront/carts">Carts</a></div></div></div></a></div> <h3 class="nx-font-semibold nx-tracking-tight nx-text-slate-900 dark:nx-text-slate-100 nx-mt-8 nx-text-2xl">Browse by feature<a href="#browse-by-feature" id="browse-by-feature" class="subheading-anchor" aria-label="Permalink for this section"></a></h3> <div class="flex Stack_vertical__TvwU_ Stack_gap-medium__dK55U Stack_divider-horizontal__8N5ZA py-4"><div class="block w-full p-0"><div class="flex flex-row gap-3"><div class="flex-shrink"><div class="self-start"><svg viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg" class="aspect-square w-6 h-6 text-blue-600 dark:text-blue-300"><path fill-rule="evenodd" clip-rule="evenodd" d="M18.296 11.97c-.34.62-1 1.03-1.75 1.03h-7.45l-1.1 2h12v2h-12c-1.52 0-2.48-1.63-1.75-2.97l1.35-2.44L3.996 4h-2V2h3.27l.94 2h14.8c.76 0 1.24.82.87 1.48l-3.58 6.49ZM19.306 6H7.156l2.37 5h7.02l2.76-5ZM7.996 18c-1.1 0-1.99.9-1.99 2s.89 2 1.99 2 2-.9 2-2-.9-2-2-2Zm8.01 2c0-1.1.89-2 1.99-2s2 .9 2 2-.9 2-2 2-1.99-.9-1.99-2Z"></path></svg></div></div><div class="flex flex-grow flex-col gap-y-2 text-base"><div class="flex items-center gap-1 group-hover:text-blue-600 dark:group-hover:text-blue-300"><p class="text-base font-semibold">Carts, checkouts, and orders</p></div><p class="whitespace-pre-wrap leading-6 text-gray-500 dark:text-gray-300">Build delightful cart, checkout, and order experiences.</p><div class="link-group mt-2 grid grid-cols-[repeat(auto-fill,minmax(300px,1fr))] gap-y-4"><div class="text-sm"><p class="mb-2 font-medium text-gray-700 dark:text-gray-300">GraphQL Storefront API</p><ul class="flex flex-col gap-2 sm:flex-wrap"><li class="capitalize"><a class="text-blue-700 underline transition-opacity hover:opacity-70 dark:text-blue-300 dark:hover:opacity-80" href="/graphql-storefront/reference#mutation-cart">Cart mutations</a></li><li class="capitalize"><a class="text-blue-700 underline transition-opacity hover:opacity-70 dark:text-blue-300 dark:hover:opacity-80" href="/graphql-storefront/reference#mutation-checkout">Checkout mutations</a></li></ul></div><div class="text-sm"><p class="mb-2 font-medium text-gray-700 dark:text-gray-300">REST Management API</p><ul class="flex flex-col gap-2 sm:flex-wrap"><li class="capitalize"><a class="text-blue-700 underline transition-opacity hover:opacity-70 dark:text-blue-300 dark:hover:opacity-80" href="/docs/rest-management/carts">Manage carts</a></li><li class="capitalize"><a class="text-blue-700 underline transition-opacity hover:opacity-70 dark:text-blue-300 dark:hover:opacity-80" href="/docs/rest-management/checkouts">Manage checkouts</a></li><li class="capitalize"><a class="text-blue-700 underline transition-opacity hover:opacity-70 dark:text-blue-300 dark:hover:opacity-80" href="/docs/rest-management/orders">Manage orders</a></li></ul></div><div class="text-sm"><p class="mb-2 font-medium text-gray-700 dark:text-gray-300">REST Storefront API</p><ul class="flex flex-col gap-2 sm:flex-wrap"><li class="capitalize"><a class="text-blue-700 underline transition-opacity hover:opacity-70 dark:text-blue-300 dark:hover:opacity-80" href="/docs/rest-storefront/carts">Handle carts</a></li><li class="capitalize"><a class="text-blue-700 underline transition-opacity hover:opacity-70 dark:text-blue-300 dark:hover:opacity-80" href="/docs/rest-storefront/checkouts">Handle checkout</a></li><li class="capitalize"><a class="text-blue-700 underline transition-opacity hover:opacity-70 dark:text-blue-300 dark:hover:opacity-80" href="/docs/rest-storefront/orders#get-order">Get an order</a></li></ul></div></div></div></div></div><div class="block w-full p-0"><div class="flex flex-row gap-3"><div class="flex-shrink"><div class="self-start"><svg viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg" class="aspect-square w-6 h-6 text-blue-600 dark:text-blue-300"><path fill-rule="evenodd" clip-rule="evenodd" d="m12.41 2.58 9 9c.36.36.59.87.59 1.42 0 .55-.22 1.05-.59 1.41l-7 7c-.36.37-.86.59-1.41.59-.55 0-1.05-.22-1.41-.58l-9-9C2.22 12.05 2 11.55 2 11V4c0-1.1.9-2 2-2h7c.55 0 1.05.22 1.41.58ZM4 11l9 9.01 7-7.02-9-9V4H4v7Zm2.5-6a1.5 1.5 0 1 0 0 3 1.5 1.5 0 0 0 0-3Zm3 9c-.37-.38-.6-.88-.6-1.45 0-1.13.92-2.05 2.05-2.05.56 0 1.08.23 1.45.61l.6.59.6-.6a2.053 2.053 0 0 1 2.9 2.9L13 17.5 9.5 14Z"></path></svg></div></div><div class="flex flex-grow flex-col gap-y-2 text-base"><div class="flex items-center gap-1 group-hover:text-blue-600 dark:group-hover:text-blue-300"><p class="text-base font-semibold">Catalog</p></div><p class="whitespace-pre-wrap leading-6 text-gray-500 dark:text-gray-300">Create products, variants, brands, category trees, bulk pricing, and more.</p><div class="link-group mt-2 grid grid-cols-[repeat(auto-fill,minmax(300px,1fr))] gap-y-4"><div class="text-sm"><p class="mb-2 font-medium text-gray-700 dark:text-gray-300">GQL Storefront API</p><ul class="flex flex-col gap-2 sm:flex-wrap"><li class="capitalize"><a class="text-blue-700 underline transition-opacity hover:opacity-70 dark:text-blue-300 dark:hover:opacity-80" href="/graphql-storefront/reference#definition-Product">Product object</a></li><li class="capitalize"><a class="text-blue-700 underline transition-opacity hover:opacity-70 dark:text-blue-300 dark:hover:opacity-80" href="/graphql-storefront/reference#definition-Category">Category object</a></li><li class="capitalize"><a class="text-blue-700 underline transition-opacity hover:opacity-70 dark:text-blue-300 dark:hover:opacity-80" href="/graphql-storefront/reference#definition-Brand">Brand object</a></li></ul></div><div class="text-sm"><p class="mb-2 font-medium text-gray-700 dark:text-gray-300">REST Management API</p><ul class="flex flex-col gap-2 sm:flex-wrap"><li class="capitalize"><a class="text-blue-700 underline transition-opacity hover:opacity-70 dark:text-blue-300 dark:hover:opacity-80" href="/docs/rest-catalog/products">Manage products</a></li><li class="capitalize"><a class="text-blue-700 underline transition-opacity hover:opacity-70 dark:text-blue-300 dark:hover:opacity-80" href="/docs/rest-catalog/categories">Manage categories</a></li><li class="capitalize"><a class="text-blue-700 underline transition-opacity hover:opacity-70 dark:text-blue-300 dark:hover:opacity-80" href="/docs/rest-catalog/brands">Manage brands</a></li></ul></div></div></div></div></div><div class="block w-full p-0"><div class="flex flex-row gap-3"><div class="flex-shrink"><div class="self-start"><svg viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg" class="aspect-square w-6 h-6 text-blue-600 dark:text-blue-300"><path fill-rule="evenodd" clip-rule="evenodd" d="M9 12c1.93 0 3.5-1.57 3.5-3.5S10.93 5 9 5 5.5 6.57 5.5 8.5 7.07 12 9 12Zm-7 5.25c0-2.33 4.66-3.5 7-3.5s7 1.17 7 3.5V19H2v-1.75Zm7-1.5c-1.79 0-3.82.67-4.66 1.25h9.32c-.84-.58-2.87-1.25-4.66-1.25Zm1.5-7.25C10.5 7.67 9.83 7 9 7s-1.5.67-1.5 1.5S8.17 10 9 10s1.5-.67 1.5-1.5Zm5.54 5.31c1.16.84 1.96 1.96 1.96 3.44V19h4v-1.75c0-2.02-3.5-3.17-5.96-3.44ZM18.5 8.5c0 1.93-1.57 3.5-3.5 3.5-.54 0-1.04-.13-1.5-.35.63-.89 1-1.98 1-3.15s-.37-2.26-1-3.15c.46-.22.96-.35 1.5-.35 1.93 0 3.5 1.57 3.5 3.5Z"></path></svg></div></div><div class="flex flex-grow flex-col gap-y-2 text-base"><div class="flex items-center gap-1 group-hover:text-blue-600 dark:group-hover:text-blue-300"><p class="text-base font-semibold">Customers</p></div><p class="whitespace-pre-wrap leading-6 text-gray-500 dark:text-gray-300">Manage customer data, customer groups and segments, and storefront sign in.</p><div class="link-group mt-2 grid grid-cols-[repeat(auto-fill,minmax(300px,1fr))] gap-y-4"><div class="text-sm"><p class="mb-2 font-medium text-gray-700 dark:text-gray-300">GraphQL Storefront API</p><ul class="flex flex-col gap-2 sm:flex-wrap"><li class="capitalize"><a class="text-blue-700 underline transition-opacity hover:opacity-70 dark:text-blue-300 dark:hover:opacity-80" href="/graphql-storefront/reference#mutation-login">Customer Login mutation</a></li><li class="capitalize"><a class="text-blue-700 underline transition-opacity hover:opacity-70 dark:text-blue-300 dark:hover:opacity-80" href="/graphql-storefront/reference#mutation-logout">Customer Logout mutation</a></li><li class="capitalize"><a class="text-blue-700 underline transition-opacity hover:opacity-70 dark:text-blue-300 dark:hover:opacity-80" href="/graphql-storefront/reference#query-customer">Customer query</a></li></ul></div><div class="text-sm"><p class="mb-2 font-medium text-gray-700 dark:text-gray-300">REST Management API</p><ul class="flex flex-col gap-2 sm:flex-wrap"><li class="capitalize"><a class="text-blue-700 underline transition-opacity hover:opacity-70 dark:text-blue-300 dark:hover:opacity-80" href="/docs/rest-management/customers">Manage customers</a></li><li class="capitalize"><a class="text-blue-700 underline transition-opacity hover:opacity-70 dark:text-blue-300 dark:hover:opacity-80" href="/docs/rest-management/customers-v2/customer-groups">Manage customer groups</a></li></ul></div><div class="text-sm"><p class="mb-2 font-medium text-gray-700 dark:text-gray-300">REST Storefront API</p><ul class="flex flex-col gap-2 sm:flex-wrap"><li class="capitalize"><a class="text-blue-700 underline transition-opacity hover:opacity-70 dark:text-blue-300 dark:hover:opacity-80" href="/docs/rest-storefront/customers">Create a customer</a></li></ul></div></div></div></div></div><div class="block w-full p-0"><div class="flex flex-row gap-3"><div class="flex-shrink"><div class="self-start"><svg viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg" class="aspect-square w-6 h-6 text-blue-600 dark:text-blue-300"><path fill-rule="evenodd" clip-rule="evenodd" d="M2 12c0 5.51 4.49 10 10 10a2.5 2.5 0 0 0 2.5-2.5c0-.61-.23-1.2-.64-1.67a.528.528 0 0 1-.13-.33c0-.28.22-.5.5-.5H16c3.31 0 6-2.69 6-6 0-4.96-4.49-9-10-9S2 6.49 2 12Zm2 0c0-4.41 3.59-8 8-8s8 3.14 8 7c0 2.21-1.79 4-4 4h-1.77a2.5 2.5 0 0 0-2.5 2.5c0 .6.22 1.19.63 1.65.06.07.14.19.14.35 0 .28-.22.5-.5.5-4.41 0-8-3.59-8-8Zm2.5-2a1.5 1.5 0 1 0 0 3 1.5 1.5 0 0 0 0-3ZM8 7.5a1.5 1.5 0 1 1 3 0 1.5 1.5 0 0 1-3 0ZM14.5 6a1.5 1.5 0 1 0 0 3 1.5 1.5 0 0 0 0-3Zm1.5 5.5a1.5 1.5 0 1 1 3 0 1.5 1.5 0 0 1-3 0Z"></path></svg></div></div><div class="flex flex-grow flex-col gap-y-2 text-base"><div class="flex items-center gap-1 group-hover:text-blue-600 dark:group-hover:text-blue-300"><p class="text-base font-semibold">Themes</p></div><p class="whitespace-pre-wrap leading-6 text-gray-500 dark:text-gray-300">Design and adapt themes to make storefronts shine.</p><div class="link-group mt-2 grid grid-cols-[repeat(auto-fill,minmax(300px,1fr))] gap-y-4"><div class="text-sm"><p class="mb-2 font-medium text-gray-700 dark:text-gray-300">Configuration</p><ul class="flex flex-col gap-2 sm:flex-wrap"><li class="capitalize"><a class="text-blue-700 underline transition-opacity hover:opacity-70 dark:text-blue-300 dark:hover:opacity-80" href="/docs/storefront/stencil/utils/reference">Stencil utils</a></li><li class="capitalize"><a class="text-blue-700 underline transition-opacity hover:opacity-70 dark:text-blue-300 dark:hover:opacity-80" href="/docs/storefront/stencil/themes/context/object-reference/config">Theme objects</a></li></ul></div><div class="text-sm"><p class="mb-2 font-medium text-gray-700 dark:text-gray-300">Handlebars</p><ul class="flex flex-col gap-2 sm:flex-wrap"><li class="capitalize"><a class="text-blue-700 underline transition-opacity hover:opacity-70 dark:text-blue-300 dark:hover:opacity-80" href="/docs/storefront/stencil/themes/context/handlebars-reference#custom-helpers">Custom helpers</a></li><li class="capitalize"><a class="text-blue-700 underline transition-opacity hover:opacity-70 dark:text-blue-300 dark:hover:opacity-80" href="/docs/storefront/stencil/themes/context/handlebars-reference#standard-helpers">Standard helpers</a></li></ul></div></div></div></div></div><div class="block w-full p-0"><div class="flex flex-row gap-3"><div class="flex-shrink"><div class="self-start"><svg viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg" class="aspect-square w-6 h-6 text-blue-600 dark:text-blue-300"><path d="M12 2.25A5.26 5.26 0 0 0 6.75 7.5c0 1.57.776 2.903 1.875 3.867l-1.57 2.906a2.109 2.109 0 0 0-.305-.023A2.262 2.262 0 0 0 4.5 16.5a2.262 2.262 0 0 0 2.25 2.25A2.262 2.262 0 0 0 9 16.5a2.24 2.24 0 0 0-.633-1.547l2.133-3.96-.563-.376A3.734 3.734 0 0 1 8.25 7.5c0-2.08 1.67-3.75 3.75-3.75s3.75 1.67 3.75 3.75c0 .44-.073.853-.21 1.242l1.405.516A5.227 5.227 0 0 0 17.25 7.5 5.26 5.26 0 0 0 12 2.25Zm0 3A2.262 2.262 0 0 0 9.75 7.5 2.262 2.262 0 0 0 12 9.75c.105 0 .202-.009.305-.023l2.062 3.28.375.61.633-.375c.55-.32 1.19-.492 1.875-.492 2.08 0 3.75 1.67 3.75 3.75s-1.67 3.75-3.75 3.75a3.709 3.709 0 0 1-2.79-1.242l-1.124.984a5.26 5.26 0 0 0 3.914 1.758 5.26 5.26 0 0 0 5.25-5.25 5.26 5.26 0 0 0-5.25-5.25c-.691 0-1.292.273-1.898.516L13.64 9.023c.375-.4.609-.937.609-1.523A2.262 2.262 0 0 0 12 5.25Zm0 1.5a.74.74 0 0 1 .75.75.74.74 0 0 1-.75.75.74.74 0 0 1-.75-.75.74.74 0 0 1 .75-.75Zm-6.117 4.57c-.6.103-1.201.31-1.758.633a5.264 5.264 0 0 0-1.922 7.172c1.444 2.502 4.667 3.366 7.172 1.922 1.433-.83 2.206-2.274 2.438-3.797h3.328c.313.867 1.14 1.5 2.109 1.5a2.262 2.262 0 0 0 2.25-2.25 2.262 2.262 0 0 0-2.25-2.25c-.97 0-1.796.633-2.11 1.5H10.5v.75a3.753 3.753 0 0 1-7.008 1.875 3.753 3.753 0 0 1 2.625-5.578l-.234-1.477Zm.867 4.43a.74.74 0 0 1 .75.75.74.74 0 0 1-.75.75.74.74 0 0 1-.75-.75.74.74 0 0 1 .75-.75Zm10.5 0a.74.74 0 0 1 .75.75.74.74 0 0 1-.75.75.74.74 0 0 1-.75-.75.74.74 0 0 1 .75-.75Z"></path></svg></div></div><div class="flex flex-grow flex-col gap-y-2 text-base"><div class="flex items-center gap-1 group-hover:text-blue-600 dark:group-hover:text-blue-300"><p class="text-base font-semibold">Webhooks</p></div><p class="whitespace-pre-wrap leading-6 text-gray-500 dark:text-gray-300">Register webhooks to listen for store events.</p><div class="link-group mt-2 grid grid-cols-[repeat(auto-fill,minmax(300px,1fr))] gap-y-4"><div class="text-sm"><p class="mb-2 font-medium text-gray-700 dark:text-gray-300">Manage webhooks bulk</p><ul class="flex flex-col gap-2 sm:flex-wrap"><li class="capitalize"><a class="text-blue-700 underline transition-opacity hover:opacity-70 dark:text-blue-300 dark:hover:opacity-80" href="/docs/webhooks/webhooks/manage-webhooks-bulk#create-a-webhook">Create a webhook</a></li><li class="capitalize"><a class="text-blue-700 underline transition-opacity hover:opacity-70 dark:text-blue-300 dark:hover:opacity-80" href="/docs/webhooks/webhooks/manage-webhooks-bulk#get-webhooks">Get a webhook</a></li><li class="capitalize"><a class="text-blue-700 underline transition-opacity hover:opacity-70 dark:text-blue-300 dark:hover:opacity-80" href="/docs/webhooks/callbacks">Call payloads</a></li></ul></div><div class="text-sm"><p class="mb-2 font-medium text-gray-700 dark:text-gray-300">Manage webhooks single</p><ul class="flex flex-col gap-2 sm:flex-wrap"><li class="capitalize"><a class="text-blue-700 underline transition-opacity hover:opacity-70 dark:text-blue-300 dark:hover:opacity-80" href="/docs/webhooks/webhooks/manage-webhooks-single#get-a-webhook">Get a webhook</a></li><li class="capitalize"><a class="text-blue-700 underline transition-opacity hover:opacity-70 dark:text-blue-300 dark:hover:opacity-80" href="/docs/webhooks/webhooks/manage-webhooks-single#update-a-webhook">Update a webhook</a></li><li class="capitalize"><a class="text-blue-700 underline transition-opacity hover:opacity-70 dark:text-blue-300 dark:hover:opacity-80" href="/docs/webhooks/webhooks/manage-webhooks-single#delete-a-webhook">Delete a webhook</a></li></ul></div><div class="text-sm"><p class="mb-2 font-medium text-gray-700 dark:text-gray-300">Webhooks Admin and Events</p><ul class="flex flex-col gap-2 sm:flex-wrap"><li class="capitalize"><a class="text-blue-700 underline transition-opacity hover:opacity-70 dark:text-blue-300 dark:hover:opacity-80" href="/docs/webhooks/webhooks/webhook-events#get-events">Get events</a></li><li class="capitalize"><a class="text-blue-700 underline transition-opacity hover:opacity-70 dark:text-blue-300 dark:hover:opacity-80" href="/docs/webhooks/webhooks/webhooks-admin#get-admin-info">Get admin events</a></li></ul></div></div></div></div></div></div><div class="nx-mt-16"></div><div class="mb-8 inline-flex items-center gap-2 text-sm"><span class="font-semibold">Did you find what you were looking for?</span><button class="transition-colors cursor-pointer rounded-md text-sm font-medium bg-blue-600 dark:bg-blue-300 text-white dark:text-gray-900 hover:bg-blue-700 dark:hover:bg-blue-400 p-2" aria-label="[object Object]"><svg viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" class="h-4 w-4"><path fill-rule="evenodd" clip-rule="evenodd" d="M9 22h9c.83 0 1.54-.5 1.84-1.22l3.02-7.05c.09-.23.14-.47.14-.73v-2c0-1.1-.9-2-2-2h-6.31l.95-4.57.03-.32c0-.41-.17-.79-.44-1.06L14.17 2 7.58 8.59C7.22 8.95 7 9.45 7 10v10c0 1.1.9 2 2 2Zm0-12 4.34-4.34L12 11h9v2l-3 7H9V10Zm-4 0H1v12h4V10Z" fill="currentColor"></path></svg></button><button class="transition-colors cursor-pointer rounded-md text-sm font-medium bg-blue-600 dark:bg-blue-300 text-white dark:text-gray-900 hover:bg-blue-700 dark:hover:bg-blue-400 p-2" aria-label="[object Object]"><svg viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" class="h-4 w-4"><path fill-rule="evenodd" clip-rule="evenodd" d="M15 2H6c-.83 0-1.54.5-1.84 1.22l-3.02 7.05c-.09.23-.14.47-.14.73v2c0 1.1.9 2 2 2h6.31l-.95 4.57-.03.32c0 .41.17.79.44 1.06L9.83 22l6.59-6.59c.36-.36.58-.86.58-1.41V4c0-1.1-.9-2-2-2Zm0 12-4.34 4.34L12 13H3v-2l3-7h9v10Zm8-12h-4v12h4V2Z" fill="currentColor"></path></svg></button></div></div></article></div><footer class="py-[3.75rem]"><div class="container mx-auto max-w-[90rem] pl-[max(env(safe-area-inset-left),1.5rem)] pr-[max(env(safe-area-inset-right),1.5rem)]"><div class="space-y-3 py-8"><p>Join our community of thousands of developers</p><form class="flex flex-col gap-4 sm:flex-row sm:gap-2"><div class="flex w-full shrink flex-col gap-1 sm:w-1/3"><label for="mini-slack-form-email" class="sr-only">Email</label><input id="mini-slack-form-email" class="rounded-md bg-white px-5 py-3 ring-1 ring-gray-200 placeholder:text-gray-400 dark:bg-gray-800 dark:ring-gray-700 dark:placeholder:text-gray-500" type="email" name="email" placeholder="Enter your email" required=""/></div><button class="transition-colors cursor-pointer rounded-md text-sm font-medium bg-blue-600 dark:bg-blue-300 text-white dark:text-gray-900 hover:bg-blue-700 dark:hover:bg-blue-400 px-3 py-1.5 whitespace-nowrap" aria-label="Join #BigCommerceDevs Slack,false" type="submit">Join #BigCommerceDevs Slack</button></form><p class="max-w-[700px] text-gray-500 dark:text-gray-300">Join thousands of other #BigCommerceDevs that are building on BigCommerce. We will also keep you updated with our monthly BigCommerce Developers newsletter. You may opt out at any time.</p></div></div><hr class="border-t-gray-200 dark:border-t-gray-700" style="margin:0rem 0rem"/><div class="container mx-auto max-w-[90rem] pl-[max(env(safe-area-inset-left),1.5rem)] pr-[max(env(safe-area-inset-right),1.5rem)]"><div class="flex flex-col justify-between gap-8 py-12 sm:flex-row"><ul class="space-y-2 text-sm text-gray-700 dark:text-gray-300"><li><svg viewBox="0 0 24 25" fill="none" xmlns="http://www.w3.org/2000/svg" class="mr-2 inline-block h-5 w-5"><path fill-rule="evenodd" clip-rule="evenodd" d="M9.626 7.412c-1.04 0-1.891-.85-1.891-1.891 0-1.04.85-1.89 1.89-1.89 1.042 0 1.892.85 1.892 1.89v1.89H9.626ZM4.89 16.895c1.04 0 1.89-.85 1.89-1.89v-1.892h-1.89c-1.041 0-1.891.85-1.891 1.891s.85 1.891 1.89 1.891Zm4.735-3.781c-1.04 0-1.891.85-1.891 1.89v4.735c0 1.04.85 1.89 1.89 1.89 1.042 0 1.892-.85 1.892-1.89v-4.735c0-1.04-.85-1.89-1.891-1.89Zm1.89-2.859c0-1.04-.85-1.89-1.89-1.89H4.89C3.85 8.364 3 9.214 3 10.254s.85 1.89 1.89 1.89h4.735c1.041 0 1.891-.85 1.891-1.89Zm5.702 0c0-1.04.85-1.89 1.891-1.89S21 9.214 21 10.254s-.85 1.89-1.89 1.89h-1.892v-1.89Zm-2.844 1.891c1.04 0 1.891-.85 1.891-1.89V5.52c0-1.04-.85-1.89-1.89-1.89-1.042 0-1.892.85-1.892 1.89v4.734c0 1.041.85 1.891 1.891 1.891Zm0 5.703c1.04 0 1.891.85 1.891 1.89 0 1.041-.85 1.891-1.89 1.891-1.042 0-1.892-.85-1.892-1.89v-1.891h1.891Zm-1.89-2.845c0 1.041.85 1.891 1.89 1.891h4.735c1.04 0 1.89-.85 1.89-1.89 0-1.041-.85-1.892-1.89-1.892h-4.735c-1.04 0-1.89.85-1.89 1.891Z" fill="currentColor"></path></svg>Need help? <a class="text-blue-600 dark:text-blue-300" href="/slack">Join our BigCommerceDevs Slack</a></li><li><svg viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" class="mr-2 inline-block h-5 w-5"><path fill-rule="evenodd" clip-rule="evenodd" d="M7 3h10c1.1 0 2 .9 2 2v16l-7-3-7 3V5c0-1.1.9-2 2-2Zm5 12.82L17 18V5H7v13l5-2.18Z" fill="currentColor"></path></svg>Find endpoints quickly in the <a class="text-blue-600 dark:text-blue-300" href="/docs/api">API reference</a></li><li><svg viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg" class="mr-2 inline-block h-5 w-5"><path fill-rule="evenodd" clip-rule="evenodd" d="M14.204 3.333c.888 0 1.815.114 2.659.38.57.19 1.064.418 1.52.76v11.093c0 .19-.19.38-.38.38-.076 0-.114 0-.19-.038-1.064-.57-2.356-.798-3.61-.798-1.291 0-3.153.494-4.178 1.14-1.102-.836-2.698-1.14-4.18-1.14-1.101 0-2.583.342-3.608.836-.038 0-.067.01-.095.02-.029.009-.057.018-.095.018-.19 0-.38-.19-.38-.38V4.474c1.101-.837 2.697-1.14 4.179-1.14 1.481 0 3.077.303 4.179 1.14 1.101-.837 2.697-1.14 4.178-1.14Zm0 10.258c.911 0 1.823.114 2.659.38V5.233c-.836-.266-1.748-.38-2.66-.38-1.291 0-3.153.494-4.178 1.14v8.737c1.025-.645 2.887-1.14 4.178-1.14Z" fill="currentColor"></path></svg>Stay up to date with <a class="text-blue-600 dark:text-blue-300" href="/release-notes">Release notes</a></li><li><svg viewBox="0 0 48 48" fill="none" xmlns="http://www.w3.org/2000/svg" class="mr-2 inline-block h-5 w-5"><path d="M.03 44.601a.393.393 0 0 1 .088-.43L44.162.098a.335.335 0 0 1 .434-.035l.057-.057c.956 1.12 3.14 3.176 3.14 3.176l.022.025c.082.093.185.21.185.368v44.13a.308.308 0 0 1-.294.294H3.663c-.208 0-.328-.126-.409-.211l-.029-.03c-.008-.008-.05-.05-.12-.116-.47-.454-2.165-2.09-2.812-2.813A.392.392 0 0 1 .03 44.6Z" fill="currentColor" style="fill:var(--logo-even-color)"></path><path d="M43.807 1.65v42.147H1.687L43.807 1.65Z" fill="currentColor" style="fill:var(--logo-odd-color)"></path><path fill-rule="evenodd" clip-rule="evenodd" d="M18.694 26.082v12.612a.323.323 0 0 0 .335.323h11.798c4.29 0 6.513-2.635 6.513-5.984a5.466 5.466 0 0 0-3.299-5.115.322.322 0 0 1 0-.588 5.283 5.283 0 0 0 3.201-4.737c0-2.928-2.572-5.605-6.765-5.605h-2.726l-9.057 9.095Zm5.175 8.391h5.756c.819 0 1.409-.216 1.79-.561.374-.34.597-.851.597-1.55a2.13 2.13 0 0 0-.707-1.573c-.429-.385-.971-.528-1.68-.528h-5.756v4.212Zm5.47-9.182h-5.482v-3.765h5.482c.675 0 1.192.128 1.6.472.425.358.67.869.673 1.405 0 .626-.212 1.082-.569 1.386-.362.309-.924.502-1.704.502Z" fill="currentColor" style="fill:var(--logo-even-color)"></path></svg>Visit <a class="text-blue-600 dark:text-blue-300" target="_blank" rel="noopener noreferrer" href="https://www.bigcommerce.com">BigCommerce home</a></li></ul><div class="basis-1/4 space-y-6"><div class="space-y-8 text-gray-500 dark:text-gray-400"><svg viewBox="0 0 48 48" fill="none" xmlns="http://www.w3.org/2000/svg" class="h-10 w-10"><path d="M.03 44.601a.393.393 0 0 1 .088-.43L44.162.098a.335.335 0 0 1 .434-.035l.057-.057c.956 1.12 3.14 3.176 3.14 3.176l.022.025c.082.093.185.21.185.368v44.13a.308.308 0 0 1-.294.294H3.663c-.208 0-.328-.126-.409-.211l-.029-.03c-.008-.008-.05-.05-.12-.116-.47-.454-2.165-2.09-2.812-2.813A.392.392 0 0 1 .03 44.6Z" fill="currentColor" style="fill:var(--logo-even-color)"></path><path d="M43.807 1.65v42.147H1.687L43.807 1.65Z" fill="currentColor" style="fill:var(--logo-odd-color)"></path><path fill-rule="evenodd" clip-rule="evenodd" d="M18.694 26.082v12.612a.323.323 0 0 0 .335.323h11.798c4.29 0 6.513-2.635 6.513-5.984a5.466 5.466 0 0 0-3.299-5.115.322.322 0 0 1 0-.588 5.283 5.283 0 0 0 3.201-4.737c0-2.928-2.572-5.605-6.765-5.605h-2.726l-9.057 9.095Zm5.175 8.391h5.756c.819 0 1.409-.216 1.79-.561.374-.34.597-.851.597-1.55a2.13 2.13 0 0 0-.707-1.573c-.429-.385-.971-.528-1.68-.528h-5.756v4.212Zm5.47-9.182h-5.482v-3.765h5.482c.675 0 1.192.128 1.6.472.425.358.67.869.673 1.405 0 .626-.212 1.082-.569 1.386-.362.309-.924.502-1.704.502Z" fill="currentColor" style="fill:var(--logo-even-color)"></path></svg><p class="dark:text-gray-300">Everything you need for growth, all from one modern platform.</p></div><div class="inline-flex gap-6 text-gray-500 dark:text-gray-400"><a href="/slack"><svg viewBox="0 0 24 25" fill="none" xmlns="http://www.w3.org/2000/svg" class="h-6 w-6"><path fill-rule="evenodd" clip-rule="evenodd" d="M9.626 7.412c-1.04 0-1.891-.85-1.891-1.891 0-1.04.85-1.89 1.89-1.89 1.042 0 1.892.85 1.892 1.89v1.89H9.626ZM4.89 16.895c1.04 0 1.89-.85 1.89-1.89v-1.892h-1.89c-1.041 0-1.891.85-1.891 1.891s.85 1.891 1.89 1.891Zm4.735-3.781c-1.04 0-1.891.85-1.891 1.89v4.735c0 1.04.85 1.89 1.89 1.89 1.042 0 1.892-.85 1.892-1.89v-4.735c0-1.04-.85-1.89-1.891-1.89Zm1.89-2.859c0-1.04-.85-1.89-1.89-1.89H4.89C3.85 8.364 3 9.214 3 10.254s.85 1.89 1.89 1.89h4.735c1.041 0 1.891-.85 1.891-1.89Zm5.702 0c0-1.04.85-1.89 1.891-1.89S21 9.214 21 10.254s-.85 1.89-1.89 1.89h-1.892v-1.89Zm-2.844 1.891c1.04 0 1.891-.85 1.891-1.89V5.52c0-1.04-.85-1.89-1.89-1.89-1.042 0-1.892.85-1.892 1.89v4.734c0 1.041.85 1.891 1.891 1.891Zm0 5.703c1.04 0 1.891.85 1.891 1.89 0 1.041-.85 1.891-1.89 1.891-1.042 0-1.892-.85-1.892-1.89v-1.891h1.891Zm-1.89-2.845c0 1.041.85 1.891 1.89 1.891h4.735c1.04 0 1.89-.85 1.89-1.89 0-1.041-.85-1.892-1.89-1.892h-4.735c-1.04 0-1.89.85-1.89 1.891Z" fill="currentColor"></path></svg></a><a href="https://github.com/bigcommerce" target="_blank" rel="noopener noreferrer"><svg viewBox="0 0 36 35" fill="currentColor" xmlns="http://www.w3.org/2000/svg" class="h-6 w-6"><path fill-rule="evenodd" clip-rule="evenodd" d="M18.015 0C8.053 0 0 8.02 0 17.944c0 7.931 5.16 14.646 12.318 17.022.895.179 1.223-.386 1.223-.861 0-.416-.03-1.842-.03-3.328-5.01 1.07-6.055-2.139-6.055-2.139-.805-2.08-1.998-2.614-1.998-2.614-1.64-1.099.12-1.099.12-1.099 1.819.119 2.773 1.842 2.773 1.842 1.61 2.733 4.206 1.96 5.25 1.485.149-1.159.626-1.96 1.133-2.406-3.997-.416-8.202-1.96-8.202-8.853 0-1.96.715-3.565 1.849-4.813-.179-.445-.805-2.287.18-4.753 0 0 1.52-.476 4.95 1.842a17.507 17.507 0 0 1 4.504-.595c1.521 0 3.072.209 4.503.595 3.43-2.318 4.952-1.842 4.952-1.842.984 2.466.357 4.308.178 4.753 1.164 1.248 1.85 2.852 1.85 4.813 0 6.892-4.206 8.407-8.232 8.853.656.564 1.223 1.634 1.223 3.327 0 2.406-.03 4.338-.03 4.931 0 .476.328 1.04 1.223.862C30.84 32.59 36 25.876 36 17.944 36.03 8.02 27.947 0 18.015 0Z"></path></svg></a><a href="https://discord.gg/qzGDFDXc4w" target="_blank" rel="noopener noreferrer"><svg viewBox="0 0 26 23" fill="none" xmlns="http://www.w3.org/2000/svg" class="h-6 w-6"><path d="M19.942 4.927a16.288 16.288 0 0 0-4.126-1.297c-.178.322-.386.754-.529 1.098a15.15 15.15 0 0 0-4.573 0 11.725 11.725 0 0 0-.534-1.098c-1.45.25-2.835.693-4.13 1.3-2.611 3.946-3.319 7.794-2.965 11.587a16.497 16.497 0 0 0 5.06 2.593c.408-.56.771-1.156 1.084-1.784a10.658 10.658 0 0 1-1.706-.831c.143-.106.283-.217.418-.331 3.29 1.54 6.866 1.54 10.118 0 .137.114.277.225.418.33a10.63 10.63 0 0 1-1.71.833c.314.627.675 1.224 1.084 1.785a16.465 16.465 0 0 0 5.064-2.595c.415-4.397-.71-8.21-2.973-11.59ZM9.678 14.185c-.988 0-1.798-.923-1.798-2.046 0-1.123.792-2.047 1.798-2.047 1.005 0 1.815.922 1.798 2.047.001 1.123-.793 2.046-1.798 2.046Zm6.644 0c-.988 0-1.798-.923-1.798-2.046 0-1.123.793-2.047 1.798-2.047 1.006 0 1.816.922 1.798 2.047 0 1.123-.793 2.046-1.798 2.046Z" fill="currentColor"></path></svg></a><a href="https://twitter.com/BigCommerceDevs" target="_blank" rel="noopener noreferrer"><svg viewBox="0 0 21 22" fill="none" xmlns="http://www.w3.org/2000/svg" class="h-6 w-6"><path d="m11.927 9.982 5.584-6.352h-1.323l-4.849 5.515L7.467 3.63H3l5.856 8.34L3 18.63h1.323l5.12-5.824 4.09 5.824H18l-6.073-8.648Zm-1.812 2.061-.594-.83-4.72-6.608h2.032l3.81 5.333.593.83 4.953 6.932h-2.033l-4.041-5.656Z" fill="currentColor"></path></svg></a><a href="https://www.youtube.com/channel/UCVeEYWDqZzjRD2CGMrZ2auQ" target="_blank" rel="noopener noreferrer"><svg viewBox="0 0 51 35" fill="currentColor" xmlns="http://www.w3.org/2000/svg" class="h-6 w-6"><g clip-path="url(#youtube_svg__a)"><path fill-rule="evenodd" clip-rule="evenodd" d="M44.97 1.177a6.246 6.246 0 0 1 4.426 4.391c1.527 6.11 1.428 17.66.032 23.864a6.246 6.246 0 0 1-4.426 4.39c-6.094 1.496-33.39 1.312-39.132 0a6.246 6.246 0 0 1-4.426-4.39C.004 23.609.103 11.296 1.41 5.6a6.246 6.246 0 0 1 4.427-4.39C13.985-.478 42.07.066 44.97 1.176Zm-24.377 8.878L33.68 17.5l-13.087 7.445v-14.89Z"></path></g><defs><clipPath id="youtube_svg__a"><path d="M0 0h51v35H0z"></path></clipPath></defs></svg></a></div></div></div><div class="space-y-4 text-sm text-gray-500 dark:text-gray-300"><span>© Copyright 2003 - 2025 BigCommerce Pty. Ltd.</span><span class="mx-4">––</span><ul class="inline-flex flex-row gap-4"><li><a href="https://support.bigcommerce.com/s/contact" target="_blank" rel="noopener noreferrer">Contact Us</a></li><li><a href="https://careers.bigcommerce.com" target="_blank" rel="noopener noreferrer">Careers</a></li><li><a href="https://www.bigcommerce.com/terms/api-terms" target="_blank" rel="noopener noreferrer">Terms of Service</a></li><li><a href="https://www.bigcommerce.com/privacy/" target="_blank" rel="noopener noreferrer">Privacy Policy</a></li></ul></div></div></footer></div></div><script id="__NEXT_DATA__" type="application/json">{"props":{"pageProps":{}},"page":"/docs/api","query":{},"buildId":"mV98qIah21cAP72QIkfFU","nextExport":true,"autoExport":true,"isFallback":false,"dynamicIds":[4119,83135,8557],"scriptLoader":[]}</script></body></html>