CINXE.COM

<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><title>About Our APIs | 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="About Our APIs"/><meta property="og:description" content="Build amazing commerce solutions powered by the BigCommerce platform"/><meta property="og:image" content="/api/og?title=About Our APIs&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/start/about"/><meta property="twitter:image" content="https://developer.bigcommerce.com/api/og?title=About Our APIs&description=undefined"/><meta property="twitter:title" content="About Our APIs"/><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/718a2f17d41d944b.css" as="style"/><link rel="stylesheet" href="/_next/static/css/718a2f17d41d944b.css" data-n-p=""/><noscript data-n-css=""></noscript><script defer="" nomodule="" src="/_next/static/chunks/polyfills-78c92fac7aa8fdd8.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/start/about-71bbfc0f2fc5f372.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)] font-bold" 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)]" 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)] font-bold" 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)]" 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"><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/build"><div class="inline-flex items-center"><svg fill="none" viewBox="0 0 24 24" stroke="currentColor" class="aspect-square mr-[0.625rem] inline h-auto w-3.5 shrink-0 stroke-2 ltr:rotate-180"><path d="m9 5 7 7-7 7"></path></svg><span class="text-sm">Home</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"><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="M2.5 15.833h10c.542 0 1.05-.266 1.358-.7L17.5 10l-3.642-5.133a1.652 1.652 0 0 0-1.358-.7h-10L6.25 10 2.5 15.833Zm10-1.666H5.417L8.333 10 5.417 5.833H12.5L15.417 10 12.5 14.167Z" fill="currentColor"></path></svg><span class="whitespace-nowrap text-gray-950 dark:text-white text-sm">Getting started</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/start"><div class="inline-flex items-center"><span class="">Overview</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">Introduction</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/start/intro-to-bigcommerce"><div class="inline-flex items-center"><span class="">Introduction to BigCommerce</span></div></a></li><li class="open active"><button class="nx-items-center nx-justify-between nx-gap-2 nx-text-left nx-w-full 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"><div class="inline-flex items-center"><span class="">About our APIs</span></div><svg fill="none" viewBox="0 0 24 24" stroke="currentColor" class="nx-h-[18px] nx-min-w-[18px] nx-rounded-sm nx-p-0.5 hover:nx-bg-gray-800/5 dark:hover:nx-bg-gray-100/5"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M9 5l7 7-7 7" class="nx-origin-center nx-transition-transform rtl:-nx-rotate-180 ltr:nx-rotate-90 rtl:nx-rotate-[-270deg]"></path></svg></button><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 ltr:nx-pr-0 rtl:nx-pl-0 nx-pt-1"><ul class="nx-flex nx-flex-col nx-gap-1 nx-relative before:nx-absolute before:nx-inset-y-1 before:nx-w-px before:nx-bg-gray-200 before:nx-content-[""] dark:before:nx-bg-neutral-800 ltr:nx-pl-3 ltr:before:nx-left-0 rtl:nx-pr-3 rtl:before:nx-right-0 ltr:nx-ml-3 rtl:nx-mr-3"><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/start/about"><div class="inline-flex items-center"><span class="">Overview</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/start/about/status-codes"><div class="inline-flex items-center"><span class="">Status codes</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/start/about/common-query-params"><div class="inline-flex items-center"><span class="">Common query params</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/start/about/sandboxes"><div class="inline-flex items-center"><span class="">Sandbox stores</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/start/about/support"><div class="inline-flex items-center"><span class="">Communication channels</span></div></a></li></ul></div></div></li><li class=""><button class="nx-items-center nx-justify-between nx-gap-2 nx-text-left nx-w-full 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"><div class="inline-flex items-center"><span class="">Authentication</span></div><svg fill="none" viewBox="0 0 24 24" stroke="currentColor" class="nx-h-[18px] nx-min-w-[18px] nx-rounded-sm nx-p-0.5 hover:nx-bg-gray-800/5 dark:hover:nx-bg-gray-100/5"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M9 5l7 7-7 7" class="nx-origin-center nx-transition-transform rtl:-nx-rotate-180"></path></svg></button><div class="nx-transform-gpu nx-overflow-hidden nx-transition-all nx-ease-in-out motion-reduce:nx-transition-none" style="height:0"><div class="nx-transition-opacity nx-duration-500 nx-ease-in-out motion-reduce:nx-transition-none nx-opacity-0 ltr:nx-pr-0 rtl:nx-pl-0 nx-pt-1"><ul class="nx-flex nx-flex-col nx-gap-1 nx-relative before:nx-absolute before:nx-inset-y-1 before:nx-w-px before:nx-bg-gray-200 before:nx-content-[""] dark:before:nx-bg-neutral-800 ltr:nx-pl-3 ltr:before:nx-left-0 rtl:nx-pr-3 rtl:before:nx-right-0 ltr:nx-ml-3 rtl:nx-mr-3"><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/start/authentication"><div class="inline-flex items-center"><span class="">Strategies and example requests</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/start/authentication/api-accounts"><div class="inline-flex items-center"><span class="">Guide to API accounts</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/start/authentication/graphql-storefront"><div class="inline-flex items-center"><span class="">GraphQL 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/start/authentication/customer-login"><div class="inline-flex items-center"><span class="">Customer Login 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/start/authentication/current-customer"><div class="inline-flex items-center"><span class="">Current Customer 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/start/authentication/passwordless"><div class="inline-flex items-center"><span class="">Passwordless login</span></div></a></li></ul></div></div></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">Best Practices</span></div></li><li class=""><button class="nx-items-center nx-justify-between nx-gap-2 nx-text-left nx-w-full 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"><div class="inline-flex items-center"><span class="">Development</span></div><svg fill="none" viewBox="0 0 24 24" stroke="currentColor" class="nx-h-[18px] nx-min-w-[18px] nx-rounded-sm nx-p-0.5 hover:nx-bg-gray-800/5 dark:hover:nx-bg-gray-100/5"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M9 5l7 7-7 7" class="nx-origin-center nx-transition-transform rtl:-nx-rotate-180"></path></svg></button><div class="nx-transform-gpu nx-overflow-hidden nx-transition-all nx-ease-in-out motion-reduce:nx-transition-none" style="height:0"><div class="nx-transition-opacity nx-duration-500 nx-ease-in-out motion-reduce:nx-transition-none nx-opacity-0 ltr:nx-pr-0 rtl:nx-pl-0 nx-pt-1"><ul class="nx-flex nx-flex-col nx-gap-1 nx-relative before:nx-absolute before:nx-inset-y-1 before:nx-w-px before:nx-bg-gray-200 before:nx-content-[""] dark:before:nx-bg-neutral-800 ltr:nx-pl-3 ltr:before:nx-left-0 rtl:nx-pr-3 rtl:before:nx-right-0 ltr:nx-ml-3 rtl:nx-mr-3"><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/start/best-practices"><div class="inline-flex items-center"><span class="">API requests</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/start/best-practices/api-rate-limits"><div class="inline-flex items-center"><span class="">API rate limits</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/start/best-practices/integration-design"><div class="inline-flex items-center"><span class="">Integration design</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/start/best-practices/sunsets"><div class="inline-flex items-center"><span class="">Deprecations and sunsets</span></div></a></li></ul></div></div></li><li class=""><button class="nx-items-center nx-justify-between nx-gap-2 nx-text-left nx-w-full 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"><div class="inline-flex items-center"><span class="">Design</span></div><svg fill="none" viewBox="0 0 24 24" stroke="currentColor" class="nx-h-[18px] nx-min-w-[18px] nx-rounded-sm nx-p-0.5 hover:nx-bg-gray-800/5 dark:hover:nx-bg-gray-100/5"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M9 5l7 7-7 7" class="nx-origin-center nx-transition-transform rtl:-nx-rotate-180"></path></svg></button><div class="nx-transform-gpu nx-overflow-hidden nx-transition-all nx-ease-in-out motion-reduce:nx-transition-none" style="height:0"><div class="nx-transition-opacity nx-duration-500 nx-ease-in-out motion-reduce:nx-transition-none nx-opacity-0 ltr:nx-pr-0 rtl:nx-pl-0 nx-pt-1"><ul class="nx-flex nx-flex-col nx-gap-1 nx-relative before:nx-absolute before:nx-inset-y-1 before:nx-w-px before:nx-bg-gray-200 before:nx-content-[""] dark:before:nx-bg-neutral-800 ltr:nx-pl-3 ltr:before:nx-left-0 rtl:nx-pr-3 rtl:before:nx-right-0 ltr:nx-ml-3 rtl:nx-mr-3"><li class=""><button class="nx-items-center nx-justify-between nx-gap-2 nx-text-left nx-w-full 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"><div class="inline-flex items-center"><span class="">UX writing guide</span></div><svg fill="none" viewBox="0 0 24 24" stroke="currentColor" class="nx-h-[18px] nx-min-w-[18px] nx-rounded-sm nx-p-0.5 hover:nx-bg-gray-800/5 dark:hover:nx-bg-gray-100/5"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M9 5l7 7-7 7" class="nx-origin-center nx-transition-transform rtl:-nx-rotate-180"></path></svg></button><div class="nx-transform-gpu nx-overflow-hidden nx-transition-all nx-ease-in-out motion-reduce:nx-transition-none" style="height:0"><div class="nx-transition-opacity nx-duration-500 nx-ease-in-out motion-reduce:nx-transition-none nx-opacity-0 ltr:nx-pr-0 rtl:nx-pl-0 nx-pt-1"><ul class="nx-flex nx-flex-col nx-gap-1 nx-relative before:nx-absolute before:nx-inset-y-1 before:nx-w-px before:nx-bg-gray-200 before:nx-content-[""] dark:before:nx-bg-neutral-800 ltr:nx-pl-3 ltr:before:nx-left-0 rtl:nx-pr-3 rtl:before:nx-right-0 ltr:nx-ml-3 rtl:nx-mr-3"><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/start/design/ux-writing"><div class="inline-flex items-center"><span class="">Introduction</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/start/design/ux-writing/basics"><div class="inline-flex items-center"><span class="">Basics</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/start/design/ux-writing/grammar"><div class="inline-flex items-center"><span class="">Grammar</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/start/design/ux-writing/mechanics"><div class="inline-flex items-center"><span class="">Mechanics</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/start/design/ux-writing/interactions"><div class="inline-flex items-center"><span class="">Interactions</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/start/design/ux-writing/status-messages"><div class="inline-flex items-center"><span class="">Status messages</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/start/design/ux-writing/mobile"><div class="inline-flex items-center"><span class="">Writing for mobile</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/start/design/ux-writing/localization"><div class="inline-flex items-center"><span class="">Localization</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/start/design/ux-writing/glossary"><div class="inline-flex items-center"><span class="">Glossary</span></div></a></li></ul></div></div></li></ul></div></div></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">Partner Program</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/start/partner"><div class="inline-flex items-center"><span class="">Becoming a partner</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><nav class="nextra-toc nx-order-last nx-hidden nx-w-64 nx-shrink-0 xl:nx-block print:nx-hidden nx-px-4" aria-label="table of contents"><div class="nextra-scrollbar nx-sticky nx-top-16 nx-overflow-y-auto nx-pr-4 nx-pt-6 nx-text-sm [hyphens:auto] nx-max-h-[calc(100vh-var(--nextra-navbar-height)-env(safe-area-inset-bottom))] ltr:-nx-mr-4 rtl:-nx-ml-4"><p class="nx-mb-4 nx-font-semibold nx-tracking-tight">On This Page</p><ul><li class="nx-my-2 nx-scroll-my-6 nx-scroll-py-6"><a href="#available-apis" class="nx-font-semibold nx-inline-block nx-text-gray-500 hover:nx-text-gray-900 dark:nx-text-gray-400 dark:hover:nx-text-gray-300 contrast-more:nx-text-gray-900 contrast-more:nx-underline contrast-more:dark:nx-text-gray-50 nx-w-full nx-break-words">Available APIs</a></li><li class="nx-my-2 nx-scroll-my-6 nx-scroll-py-6"><a href="#rest-store-management-apis" class="ltr:nx-pl-4 rtl:nx-pr-4 nx-inline-block nx-text-gray-500 hover:nx-text-gray-900 dark:nx-text-gray-400 dark:hover:nx-text-gray-300 contrast-more:nx-text-gray-900 contrast-more:nx-underline contrast-more:dark:nx-text-gray-50 nx-w-full nx-break-words">REST Store Management APIs</a></li><li class="nx-my-2 nx-scroll-my-6 nx-scroll-py-6"><a href="#rest-storefront-api" class="ltr:nx-pl-4 rtl:nx-pr-4 nx-inline-block nx-text-gray-500 hover:nx-text-gray-900 dark:nx-text-gray-400 dark:hover:nx-text-gray-300 contrast-more:nx-text-gray-900 contrast-more:nx-underline contrast-more:dark:nx-text-gray-50 nx-w-full nx-break-words">REST Storefront API</a></li><li class="nx-my-2 nx-scroll-my-6 nx-scroll-py-6"><a href="#graphql-storefront-api" class="ltr:nx-pl-4 rtl:nx-pr-4 nx-inline-block nx-text-gray-500 hover:nx-text-gray-900 dark:nx-text-gray-400 dark:hover:nx-text-gray-300 contrast-more:nx-text-gray-900 contrast-more:nx-underline contrast-more:dark:nx-text-gray-50 nx-w-full nx-break-words">GraphQL Storefront API</a></li><li class="nx-my-2 nx-scroll-my-6 nx-scroll-py-6"><a href="#customer-login-api" class="ltr:nx-pl-4 rtl:nx-pr-4 nx-inline-block nx-text-gray-500 hover:nx-text-gray-900 dark:nx-text-gray-400 dark:hover:nx-text-gray-300 contrast-more:nx-text-gray-900 contrast-more:nx-underline contrast-more:dark:nx-text-gray-50 nx-w-full nx-break-words">Customer Login API</a></li><li class="nx-my-2 nx-scroll-my-6 nx-scroll-py-6"><a href="#current-customer-api" class="ltr:nx-pl-4 rtl:nx-pr-4 nx-inline-block nx-text-gray-500 hover:nx-text-gray-900 dark:nx-text-gray-400 dark:hover:nx-text-gray-300 contrast-more:nx-text-gray-900 contrast-more:nx-underline contrast-more:dark:nx-text-gray-50 nx-w-full nx-break-words">Current Customer API</a></li><li class="nx-my-2 nx-scroll-my-6 nx-scroll-py-6"><a href="#api-authentication-and-context" class="nx-font-semibold nx-inline-block nx-text-gray-500 hover:nx-text-gray-900 dark:nx-text-gray-400 dark:hover:nx-text-gray-300 contrast-more:nx-text-gray-900 contrast-more:nx-underline contrast-more:dark:nx-text-gray-50 nx-w-full nx-break-words">API authentication and context</a></li><li class="nx-my-2 nx-scroll-my-6 nx-scroll-py-6"><a href="#available-store-resources" class="nx-font-semibold nx-inline-block nx-text-gray-500 hover:nx-text-gray-900 dark:nx-text-gray-400 dark:hover:nx-text-gray-300 contrast-more:nx-text-gray-900 contrast-more:nx-underline contrast-more:dark:nx-text-gray-50 nx-w-full nx-break-words">Available store resources</a></li><li class="nx-my-2 nx-scroll-my-6 nx-scroll-py-6"><a href="#anatomy-of-rest-store-management-apis" class="nx-font-semibold nx-inline-block nx-text-gray-500 hover:nx-text-gray-900 dark:nx-text-gray-400 dark:hover:nx-text-gray-300 contrast-more:nx-text-gray-900 contrast-more:nx-underline contrast-more:dark:nx-text-gray-50 nx-w-full nx-break-words">Anatomy of REST Store Management APIs</a></li><li class="nx-my-2 nx-scroll-my-6 nx-scroll-py-6"><a href="#media-types" class="ltr:nx-pl-4 rtl:nx-pr-4 nx-inline-block nx-text-gray-500 hover:nx-text-gray-900 dark:nx-text-gray-400 dark:hover:nx-text-gray-300 contrast-more:nx-text-gray-900 contrast-more:nx-underline contrast-more:dark:nx-text-gray-50 nx-w-full nx-break-words">Media types</a></li><li class="nx-my-2 nx-scroll-my-6 nx-scroll-py-6"><a href="#requests" class="ltr:nx-pl-4 rtl:nx-pr-4 nx-inline-block nx-text-gray-500 hover:nx-text-gray-900 dark:nx-text-gray-400 dark:hover:nx-text-gray-300 contrast-more:nx-text-gray-900 contrast-more:nx-underline contrast-more:dark:nx-text-gray-50 nx-w-full nx-break-words">Requests</a></li><li class="nx-my-2 nx-scroll-my-6 nx-scroll-py-6"><a href="#standard-request-headers" class="ltr:nx-pl-8 rtl:nx-pr-8 nx-inline-block nx-text-gray-500 hover:nx-text-gray-900 dark:nx-text-gray-400 dark:hover:nx-text-gray-300 contrast-more:nx-text-gray-900 contrast-more:nx-underline contrast-more:dark:nx-text-gray-50 nx-w-full nx-break-words">Standard request headers</a></li><li class="nx-my-2 nx-scroll-my-6 nx-scroll-py-6"><a href="#bigcommerce-specific-request-headers" class="ltr:nx-pl-8 rtl:nx-pr-8 nx-inline-block nx-text-gray-500 hover:nx-text-gray-900 dark:nx-text-gray-400 dark:hover:nx-text-gray-300 contrast-more:nx-text-gray-900 contrast-more:nx-underline contrast-more:dark:nx-text-gray-50 nx-w-full nx-break-words">BigCommerce-specific request headers</a></li><li class="nx-my-2 nx-scroll-my-6 nx-scroll-py-6"><a href="#request-content-type" class="ltr:nx-pl-8 rtl:nx-pr-8 nx-inline-block nx-text-gray-500 hover:nx-text-gray-900 dark:nx-text-gray-400 dark:hover:nx-text-gray-300 contrast-more:nx-text-gray-900 contrast-more:nx-underline contrast-more:dark:nx-text-gray-50 nx-w-full nx-break-words">Request content type</a></li><li class="nx-my-2 nx-scroll-my-6 nx-scroll-py-6"><a href="#request-structure" class="ltr:nx-pl-8 rtl:nx-pr-8 nx-inline-block nx-text-gray-500 hover:nx-text-gray-900 dark:nx-text-gray-400 dark:hover:nx-text-gray-300 contrast-more:nx-text-gray-900 contrast-more:nx-underline contrast-more:dark:nx-text-gray-50 nx-w-full nx-break-words">Request structure</a></li><li class="nx-my-2 nx-scroll-my-6 nx-scroll-py-6"><a href="#responses" class="ltr:nx-pl-4 rtl:nx-pr-4 nx-inline-block nx-text-gray-500 hover:nx-text-gray-900 dark:nx-text-gray-400 dark:hover:nx-text-gray-300 contrast-more:nx-text-gray-900 contrast-more:nx-underline contrast-more:dark:nx-text-gray-50 nx-w-full nx-break-words">Responses</a></li><li class="nx-my-2 nx-scroll-my-6 nx-scroll-py-6"><a href="#response-headers" class="ltr:nx-pl-8 rtl:nx-pr-8 nx-inline-block nx-text-gray-500 hover:nx-text-gray-900 dark:nx-text-gray-400 dark:hover:nx-text-gray-300 contrast-more:nx-text-gray-900 contrast-more:nx-underline contrast-more:dark:nx-text-gray-50 nx-w-full nx-break-words">Response headers</a></li><li class="nx-my-2 nx-scroll-my-6 nx-scroll-py-6"><a href="#standard-response-headers" class="ltr:nx-pl-8 rtl:nx-pr-8 nx-inline-block nx-text-gray-500 hover:nx-text-gray-900 dark:nx-text-gray-400 dark:hover:nx-text-gray-300 contrast-more:nx-text-gray-900 contrast-more:nx-underline contrast-more:dark:nx-text-gray-50 nx-w-full nx-break-words">Standard response headers</a></li><li class="nx-my-2 nx-scroll-my-6 nx-scroll-py-6"><a href="#bigcommerce-specific-response-headers" class="ltr:nx-pl-8 rtl:nx-pr-8 nx-inline-block nx-text-gray-500 hover:nx-text-gray-900 dark:nx-text-gray-400 dark:hover:nx-text-gray-300 contrast-more:nx-text-gray-900 contrast-more:nx-underline contrast-more:dark:nx-text-gray-50 nx-w-full nx-break-words">BigCommerce-specific response headers</a></li><li class="nx-my-2 nx-scroll-my-6 nx-scroll-py-6"><a href="#response-content-type" class="ltr:nx-pl-8 rtl:nx-pr-8 nx-inline-block nx-text-gray-500 hover:nx-text-gray-900 dark:nx-text-gray-400 dark:hover:nx-text-gray-300 contrast-more:nx-text-gray-900 contrast-more:nx-underline contrast-more:dark:nx-text-gray-50 nx-w-full nx-break-words">Response content type</a></li><li class="nx-my-2 nx-scroll-my-6 nx-scroll-py-6"><a href="#response-structure" class="ltr:nx-pl-8 rtl:nx-pr-8 nx-inline-block nx-text-gray-500 hover:nx-text-gray-900 dark:nx-text-gray-400 dark:hover:nx-text-gray-300 contrast-more:nx-text-gray-900 contrast-more:nx-underline contrast-more:dark:nx-text-gray-50 nx-w-full nx-break-words">Response structure</a></li><li class="nx-my-2 nx-scroll-my-6 nx-scroll-py-6"><a href="#support" class="nx-font-semibold nx-inline-block nx-text-gray-500 hover:nx-text-gray-900 dark:nx-text-gray-400 dark:hover:nx-text-gray-300 contrast-more:nx-text-gray-900 contrast-more:nx-underline contrast-more:dark:nx-text-gray-50 nx-w-full nx-break-words">Support</a></li><li class="nx-my-2 nx-scroll-my-6 nx-scroll-py-6"><a href="#developer-community" class="ltr:nx-pl-4 rtl:nx-pr-4 nx-inline-block nx-text-gray-500 hover:nx-text-gray-900 dark:nx-text-gray-400 dark:hover:nx-text-gray-300 contrast-more:nx-text-gray-900 contrast-more:nx-underline contrast-more:dark:nx-text-gray-50 nx-w-full nx-break-words">Developer community</a></li><li class="nx-my-2 nx-scroll-my-6 nx-scroll-py-6"><a href="#bigcommerce-at-stack-overflow" class="ltr:nx-pl-4 rtl:nx-pr-4 nx-inline-block nx-text-gray-500 hover:nx-text-gray-900 dark:nx-text-gray-400 dark:hover:nx-text-gray-300 contrast-more:nx-text-gray-900 contrast-more:nx-underline contrast-more:dark:nx-text-gray-50 nx-w-full nx-break-words">BigCommerce at Stack Overflow</a></li><li class="nx-my-2 nx-scroll-my-6 nx-scroll-py-6"><a href="#developer-release-notes" class="ltr:nx-pl-4 rtl:nx-pr-4 nx-inline-block nx-text-gray-500 hover:nx-text-gray-900 dark:nx-text-gray-400 dark:hover:nx-text-gray-300 contrast-more:nx-text-gray-900 contrast-more:nx-underline contrast-more:dark:nx-text-gray-50 nx-w-full nx-break-words">Developer release notes</a></li><li class="nx-my-2 nx-scroll-my-6 nx-scroll-py-6"><a href="#resources" class="nx-font-semibold nx-inline-block nx-text-gray-500 hover:nx-text-gray-900 dark:nx-text-gray-400 dark:hover:nx-text-gray-300 contrast-more:nx-text-gray-900 contrast-more:nx-underline contrast-more:dark:nx-text-gray-50 nx-w-full nx-break-words">Resources</a></li></ul><div class="nx-mt-8 nx-border-t nx-bg-white nx-pt-8 nx-shadow-[0_-12px_16px_white] dark:nx-bg-dark dark:nx-shadow-[0_-12px_16px_#111] nx-sticky nx-bottom-0 nx-flex nx-flex-col nx-items-start nx-gap-2 nx-pb-8 dark:nx-border-neutral-800 contrast-more:nx-border-t contrast-more:nx-border-neutral-400 contrast-more:nx-shadow-none contrast-more:dark:nx-border-neutral-400"><a href="https://github.com/bigcommerce/docs/issues/new?title=Feedback%20for%20%E2%80%9CAbout%20Our%20APIs%E2%80%9D&labels=feedback" target="_blank" rel="noreferrer" class="nx-text-xs nx-font-medium nx-text-gray-500 hover:nx-text-gray-900 dark:nx-text-gray-400 dark:hover:nx-text-gray-100 contrast-more:nx-text-gray-800 contrast-more:dark:nx-text-gray-50">Question? Give us feedback →<span class="nx-sr-only nx-select-none"> (opens in a new tab)</span></a></div></div></nav><div id="reach-skip-nav"></div><article class="nx-w-full nx-break-words nextra-content nx-flex nx-min-h-[calc(100vh-var(--nextra-navbar-height))] nx-min-w-0 nx-justify-center nx-pb-8 nx-pr-[calc(env(safe-area-inset-right)-1.5rem)]"><main class="nx-w-full nx-min-w-0 nx-max-w-6xl nx-px-6 nx-pt-4 md:nx-px-12"><div class="nextra-breadcrumb nx-mt-1.5 nx-flex nx-items-center nx-gap-1 nx-overflow-hidden nx-text-sm nx-text-gray-500 dark:nx-text-gray-400 contrast-more:nx-text-current"><div class="nx-whitespace-nowrap nx-transition-colors nx-min-w-[24px] nx-overflow-hidden nx-text-ellipsis hover:nx-text-gray-900 dark:hover:nx-text-gray-100" title="Docs"><a href="/docs">Docs</a></div><svg fill="none" viewBox="0 0 24 24" stroke="currentColor" class="nx-w-3.5 nx-shrink-0"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M9 5l7 7-7 7"></path></svg><div class="nx-whitespace-nowrap nx-transition-colors nx-min-w-[24px] nx-overflow-hidden nx-text-ellipsis hover:nx-text-gray-900 dark:hover:nx-text-gray-100" title="Getting started"><a href="/docs/start">Getting started</a></div><svg fill="none" viewBox="0 0 24 24" stroke="currentColor" class="nx-w-3.5 nx-shrink-0"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M9 5l7 7-7 7"></path></svg><div class="nx-whitespace-nowrap nx-transition-colors nx-min-w-[24px] nx-overflow-hidden nx-text-ellipsis" title="About our APIs">About our APIs</div><svg fill="none" viewBox="0 0 24 24" stroke="currentColor" class="nx-w-3.5 nx-shrink-0"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M9 5l7 7-7 7"></path></svg><div class="nx-whitespace-nowrap nx-transition-colors nx-font-medium nx-text-gray-700 contrast-more:nx-font-bold contrast-more:nx-text-current dark:nx-text-gray-100 contrast-more:dark:nx-text-current" title="Overview">Overview</div></div><div class="flex h-full flex-col"><h1 class="nx-mt-2 nx-text-4xl nx-font-bold nx-tracking-tight nx-text-slate-900 dark:nx-text-slate-100">About Our APIs</h1> <p class="nx-mt-6 nx-leading-7 first:nx-mt-0">The BigCommerce suite of APIs empowers you to create apps, automate store processes, and build headless ecommerce solutions.</p> <p class="nx-mt-6 nx-leading-7 first:nx-mt-0">If you're new to building BigCommerce apps, we recommend that you start by exploring the <a href="https://www.bigcommerce.com/apps/" target="_blank" rel="noreferrer" class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]">App Marketplace<span class="nx-sr-only nx-select-none"> (opens in a new tab)</span></a> to get a feel for what's possible.</p> <p class="nx-mt-6 nx-leading-7 first:nx-mt-0">When you're ready to play with our APIs, check out the <a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/archive/start/making-requests">API Request Quick Start</a>.</p> <h2 class="nx-font-semibold nx-tracking-tight nx-text-slate-900 dark:nx-text-slate-100 nx-mt-10 nx-border-b nx-pb-1 nx-text-3xl nx-border-neutral-200/70 contrast-more:nx-border-neutral-400 dark:nx-border-primary-100/10 contrast-more:dark:nx-border-neutral-400">Available APIs<a href="#available-apis" id="available-apis" class="subheading-anchor" aria-label="Permalink for this section"></a></h2> <p class="nx-mt-6 nx-leading-7 first:nx-mt-0">BigCommerce has several APIs that let you manage store data, authenticate customers, make client-side queries for product information, and more.</p> <h3 class="nx-font-semibold nx-tracking-tight nx-text-slate-900 dark:nx-text-slate-100 nx-mt-8 nx-text-2xl">REST Store Management APIs<a href="#rest-store-management-apis" id="rest-store-management-apis" class="subheading-anchor" aria-label="Permalink for this section"></a></h3> <p class="nx-mt-6 nx-leading-7 first:nx-mt-0">BigCommerce's Store Management and Payment APIs (for example, the <a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/rest-catalog">Catalog API</a>) allow you to manage transactions, modify store data, and act as store administrator. Example use cases include the following:</p> <ul class="nx-mt-6 nx-list-disc first:nx-mt-0 ltr:nx-ml-6 rtl:nx-mr-6"> <li class="nx-my-2">Add and update products in a store</li> <li class="nx-my-2">Update a customer's order and change the order status</li> <li class="nx-my-2">Create a coupon</li> <li class="nx-my-2">Manage a customer's store account details</li> </ul> <h3 class="nx-font-semibold nx-tracking-tight nx-text-slate-900 dark:nx-text-slate-100 nx-mt-8 nx-text-2xl">REST Storefront API<a href="#rest-storefront-api" id="rest-storefront-api" class="subheading-anchor" aria-label="Permalink for this section"></a></h3> <p class="nx-mt-6 nx-leading-7 first:nx-mt-0">The <a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/rest-storefront/carts">REST Storefront API</a> lets you manage customer carts, checkouts, and order information client-side. Example use cases include the following:</p> <ul class="nx-mt-6 nx-list-disc first:nx-mt-0 ltr:nx-ml-6 rtl:nx-mr-6"> <li class="nx-my-2">Add an item with JavaScript to a shopper's cart from a Stencil storefront</li> <li class="nx-my-2">Programmatically retrieve and display information to a customer about their recent order</li> <li class="nx-my-2">Update the billing address of a checkout</li> <li class="nx-my-2">Clear a customer's current cart</li> </ul> <h3 class="nx-font-semibold nx-tracking-tight nx-text-slate-900 dark:nx-text-slate-100 nx-mt-8 nx-text-2xl">GraphQL Storefront API<a href="#graphql-storefront-api" id="graphql-storefront-api" class="subheading-anchor" aria-label="Permalink for this section"></a></h3> <p class="nx-mt-6 nx-leading-7 first:nx-mt-0">BigCommerce's <a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/graphql-storefront">GraphQL Storefront API</a> lets you query and mutate products, customers, and carts, then launch a checkout on a headless storefront as well as from a native storefront's frontend. Example use cases include the following:</p> <ul class="nx-mt-6 nx-list-disc first:nx-mt-0 ltr:nx-ml-6 rtl:nx-mr-6"> <li class="nx-my-2">Add additional product data to a Stencil storefront</li> <li class="nx-my-2">Access customer data on the frontend of a site</li> <li class="nx-my-2">Manage shopper's carts on a headless storefront</li> <li class="nx-my-2">Fetch category and brand details from a store's frontend</li> </ul> <h3 class="nx-font-semibold nx-tracking-tight nx-text-slate-900 dark:nx-text-slate-100 nx-mt-8 nx-text-2xl">Customer Login API<a href="#customer-login-api" id="customer-login-api" class="subheading-anchor" aria-label="Permalink for this section"></a></h3> <p class="nx-mt-6 nx-leading-7 first:nx-mt-0">The <a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/start/authentication/customer-login">Customer Login API</a> lets you programmatically sign customers in to a BigCommerce storefront. Example use cases include the following:</p> <ul class="nx-mt-6 nx-list-disc first:nx-mt-0 ltr:nx-ml-6 rtl:nx-mr-6"> <li class="nx-my-2">Sign customers in to a BigCommerce store from a third-party account or a headless storefront</li> <li class="nx-my-2">Enable login using credentials other than email and password, such as a phone number</li> <li class="nx-my-2">Integrate a BigCommerce store with an SSO provider</li> </ul> <h3 class="nx-font-semibold nx-tracking-tight nx-text-slate-900 dark:nx-text-slate-100 nx-mt-8 nx-text-2xl">Current Customer API<a href="#current-customer-api" id="current-customer-api" class="subheading-anchor" aria-label="Permalink for this section"></a></h3> <p class="nx-mt-6 nx-leading-7 first:nx-mt-0">BigCommerce's <a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/start/authentication/current-customer">Current Customer API</a> lets you determine which customer is logged in to a storefront during a session.</p> <ul class="nx-mt-6 nx-list-disc first:nx-mt-0 ltr:nx-ml-6 rtl:nx-mr-6"> <li class="nx-my-2">Confirm a customer's identity in the browser</li> <li class="nx-my-2">Validate a customer's identity to display specific information to them from an external app</li> </ul> <h2 class="nx-font-semibold nx-tracking-tight nx-text-slate-900 dark:nx-text-slate-100 nx-mt-10 nx-border-b nx-pb-1 nx-text-3xl nx-border-neutral-200/70 contrast-more:nx-border-neutral-400 dark:nx-border-primary-100/10 contrast-more:dark:nx-border-neutral-400">API authentication and context<a href="#api-authentication-and-context" id="api-authentication-and-context" class="subheading-anchor" aria-label="Permalink for this section"></a></h2> <p class="nx-mt-6 nx-leading-7 first:nx-mt-0">Make BigCommerce API requests in the context of the <strong>storefront</strong>, BigCommerce <strong>API server</strong>, or <strong>app server</strong>. Each of the following APIs listings links to its section of our <a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/start/authentication">Authentication and Example Requests</a> article, which contains the base URL of the API in question.</p> <table class="nx-block nx-overflow-x-scroll nextra-scrollbar nx-mt-6 nx-p-0 first:nx-mt-0"><thead><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><th class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 nx-font-semibold dark:nx-border-gray-600" align="left">API or Use Case</th><th class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 nx-font-semibold dark:nx-border-gray-600" align="left">Context</th></tr></thead><tbody><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/start/authentication#access-tokens">GraphQL Account API</a>, including <a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/graphql-account/users">Users</a></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">server</td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/start/authentication#access-tokens">GraphQL Admin API</a></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">server</td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/start/authentication#bigcommerce-generated-jwts">GraphQL Storefront API</a></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">storefront</td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/start/authentication#access-tokens">REST Management API</a></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">server</td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/start/authentication#same-origin-cors-authentication">REST Storefront API</a></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">storefront</td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/start/authentication#user-generated-jwts">Customer Login API</a></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">storefront</td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/start/authentication#client-id">Current Customer API</a></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">storefront</td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/start/authentication#bigcommerce-generated-jwts">Payments API</a></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">server</td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/start/authentication#developer-configured-authentication">Apps that host REST Provider APIs (provider apps)</a></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">server</td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">Apps hosted in the store control panel (single-click apps)</td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">server</td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">Single-store frontend scripts</td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">storefront</td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">Headless storefronts with backend or request proxy</td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">server</td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">Serverless headless storefronts</td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">storefront, GraphQL-only</td></tr></tbody></table> <h2 class="nx-font-semibold nx-tracking-tight nx-text-slate-900 dark:nx-text-slate-100 nx-mt-10 nx-border-b nx-pb-1 nx-text-3xl nx-border-neutral-200/70 contrast-more:nx-border-neutral-400 dark:nx-border-primary-100/10 contrast-more:dark:nx-border-neutral-400">Available store resources<a href="#available-store-resources" id="available-store-resources" class="subheading-anchor" aria-label="Permalink for this section"></a></h2> <table class="nx-block nx-overflow-x-scroll nextra-scrollbar nx-mt-6 nx-p-0 first:nx-mt-0"><thead><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><th class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 nx-font-semibold dark:nx-border-gray-600" align="left">Resource</th><th class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 nx-font-semibold dark:nx-border-gray-600" align="left">Description</th></tr></thead><tbody><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/rest-catalog">Catalog</a></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">The Catalog API manages products, brands, and categories for a store.</td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/rest-management/store-information">Store Information</a></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">Get system timestamp and basic store information.</td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/rest-management/currencies">Currency</a></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">Manage currency displayed on the storefront.</td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/rest-management/geography">Geography</a></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">Get a list of states and countries.</td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/rest-management/tax-classes">Tax Class</a></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">Manage tax classes available on a store.</td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/rest-storefront/carts">Storefront Cart</a></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">Create a cart or scrape cart data from the frontend.</td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/rest-management/checkouts">Storefront Checkout</a></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">Create a checkout or scrape checkout data from the frontend.</td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/rest-management/carts">Store Management Cart</a></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">Create a cart and bypass the BigCommerce frontend.</td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/rest-storefront/checkouts">Store Management Checkout</a></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">Create a checkout and bypass the BigCommerce frontend.</td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/rest-management/orders">Store Management Orders</a></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">Create and manage orders.</td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/rest-management/transactions">Store Management Order Transactions</a></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">View order payment information.</td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/rest-storefront/orders">Storefront Orders</a></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">View storefront order information.</td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/rest-management/customers-v2">Customers V2</a></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">Manage store customers.</td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/rest-management/customers">Customers V3</a></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">Manage store customers. To learn about using Customers V3 versus V2, see the <a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/store-operations/customers">Customers Overview</a>.</td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/rest-management/subscribers">Subscribers</a></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">Manage newsletter subscribers.</td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/rest-management/price-lists">Price Lists</a></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">Create variations of catalog pricing.</td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/rest-management/scripts">Scripts</a></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">Add and remove scripts from storefront pages.</td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/rest-content/marketing">Marketing</a></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">Create and manage coupons, banners, and gift certificates.</td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/rest-payments/tokens">Payments - Create a payment access token</a></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">Create an order-specific token to process a shopper's payment.</td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/rest-payments/methods">Payments - Get accepted methods</a></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">Get a list of accepted payment methods available on a store.</td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/rest-payments/methods-deprecated">Payments - Get methods (deprecated)</a></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">Get a list of payment gateways available on a store.</td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/rest-payments/processing">Payments - Process Payments</a></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">Process payments using a <a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/rest-payments/tokens">payment access token</a> and <a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/rest-payments/methods">accepted payment method</a>.</td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/rest-management/shipping-v2">Shipping</a></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">Create and manage shipping methods and zones.</td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/rest-content/store-content/blog-posts">Store Content</a></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">Manage a store's blog posts and blog tags.</td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/rest-content/pages">Pages</a></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">Manage a store's web pages.</td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/rest-management/redirects">Redirects</a></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">Manage a store's redirects.</td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/rest-content/themes">Themes</a></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">Manage store's themes.</td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/rest-content/widgets">Widgets</a></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">Programmatically inject content into a BigCommerce theme.</td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/rest-management/wishlists">Wishlists</a></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">Create and manage customer wishlists.</td></tr></tbody></table> <h2 class="nx-font-semibold nx-tracking-tight nx-text-slate-900 dark:nx-text-slate-100 nx-mt-10 nx-border-b nx-pb-1 nx-text-3xl nx-border-neutral-200/70 contrast-more:nx-border-neutral-400 dark:nx-border-primary-100/10 contrast-more:dark:nx-border-neutral-400">Anatomy of REST Store Management APIs<a href="#anatomy-of-rest-store-management-apis" id="anatomy-of-rest-store-management-apis" class="subheading-anchor" aria-label="Permalink for this section"></a></h2> <p class="nx-mt-6 nx-leading-7 first:nx-mt-0">The following sections describe the configuration of well-formed requests and responses to and from BigCommerce-hosted REST APIs.</p> <h3 class="nx-font-semibold nx-tracking-tight nx-text-slate-900 dark:nx-text-slate-100 nx-mt-8 nx-text-2xl">Media types<a href="#media-types" id="media-types" class="subheading-anchor" aria-label="Permalink for this section"></a></h3> <p class="nx-mt-6 nx-leading-7 first:nx-mt-0">A media type is the format of the request or response body. BigCommerce APIs accept requests and send responses in JSON. Encode requests using the UTF-8 character set; other character sets can have unpredictable results.</p> <h3 class="nx-font-semibold nx-tracking-tight nx-text-slate-900 dark:nx-text-slate-100 nx-mt-8 nx-text-2xl">Requests<a href="#requests" id="requests" class="subheading-anchor" aria-label="Permalink for this section"></a></h3> <p class="nx-mt-6 nx-leading-7 first:nx-mt-0">For more information about required request headers, consult the <a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/api">API reference</a> for the endpoint or graph you want to use.</p> <h4 class="nx-font-semibold nx-tracking-tight nx-text-slate-900 dark:nx-text-slate-100 nx-mt-8 nx-text-xl">Standard request headers<a href="#standard-request-headers" id="standard-request-headers" class="subheading-anchor" aria-label="Permalink for this section"></a></h4> <table class="nx-block nx-overflow-x-scroll nextra-scrollbar nx-mt-6 nx-p-0 first:nx-mt-0"><thead><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><th class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 nx-font-semibold dark:nx-border-gray-600" align="left">Header</th><th class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 nx-font-semibold dark:nx-border-gray-600" align="left">Expected value or type</th><th class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 nx-font-semibold dark:nx-border-gray-600" align="left">Description</th><th class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 nx-font-semibold dark:nx-border-gray-600" align="left">Example</th></tr></thead><tbody><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">Accept</code></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">MIME types</td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">The MIME type format that indicates which response type the request expects. For more information, see <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept" target="_blank" rel="noreferrer" class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]">HTTP Docs: Accept Header (MDN)<span class="nx-sr-only nx-select-none"> (opens in a new tab)</span></a>.</td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">application/json</code></td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">Content-Type</code></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">MIME types</td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">The MIME type of the request body. The API uses this value to validate and parse the request. For more information, see <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type" target="_blank" rel="noreferrer" class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]">HTTP Docs: Content-Type Header (MDN)<span class="nx-sr-only nx-select-none"> (opens in a new tab)</span></a>.</td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">application/json</code></td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">User-Agent</code></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">String</td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">We ask that you specify a user agent to identify your integration or client.</td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">PostmanRuntime/7.32.3</code></td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">Authorization</code></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">String</td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">Requests to the <a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/rest-payments/processing">Process payments</a> endpoint and the <a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/graphql-storefront">GraphQL Storefront API</a> use the <code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">Authorization</code> header to authenticate. For more information, see <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization" target="_blank" rel="noreferrer" class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]">HTTP Docs: Authorization Header (MDN)<span class="nx-sr-only nx-select-none"> (opens in a new tab)</span></a>.</td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">Bearer {{STOREFRONT_TOKEN}}</code> or <code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">PAT {{PAYMENT_ACCESS_TOKEN}}</code></td></tr></tbody></table> <h4 class="nx-font-semibold nx-tracking-tight nx-text-slate-900 dark:nx-text-slate-100 nx-mt-8 nx-text-xl">BigCommerce-specific request headers<a href="#bigcommerce-specific-request-headers" id="bigcommerce-specific-request-headers" class="subheading-anchor" aria-label="Permalink for this section"></a></h4> <table class="nx-block nx-overflow-x-scroll nextra-scrollbar nx-mt-6 nx-p-0 first:nx-mt-0"><thead><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><th class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 nx-font-semibold dark:nx-border-gray-600" align="left">Header</th><th class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 nx-font-semibold dark:nx-border-gray-600" align="left">Expected value or type</th><th class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 nx-font-semibold dark:nx-border-gray-600" align="left">Description</th></tr></thead><tbody><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">X-Auth-Token</code></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">API account access token</td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">Requests to the REST Management, Catalog, GraphQL Admin, and GraphQL Account APIs use this header to authenticate. Some Payment endpoints also use this header.</td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">X-Auth-Client</code></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">API account client ID</td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">No longer required for any requests to BigCommerce.</td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">X-Correlation-Id</code></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">UUID in an 8-4-4-4-12 format</td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">An identifier unique to a set of related requests. For use on headless storefronts, excluding BigCommerce for WordPress. For more information, see <a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/start/best-practices#correlating-requests">Best Practices</a> or the <a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/storefront/headless#correlating-requests">Headless Guide</a>.</td></tr></tbody></table> <h4 class="nx-font-semibold nx-tracking-tight nx-text-slate-900 dark:nx-text-slate-100 nx-mt-8 nx-text-xl">Request content type<a href="#request-content-type" id="request-content-type" class="subheading-anchor" aria-label="Permalink for this section"></a></h4> <p class="nx-mt-6 nx-leading-7 first:nx-mt-0">When performing a request that contains a body, specify the type of content you are sending with the <code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">Content-Type</code> header. This typically applies to <code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">PUT</code> and <code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">POST</code> requests.</p> <h4 class="nx-font-semibold nx-tracking-tight nx-text-slate-900 dark:nx-text-slate-100 nx-mt-8 nx-text-xl">Request structure<a href="#request-structure" id="request-structure" class="subheading-anchor" aria-label="Permalink for this section"></a></h4> <p class="nx-mt-6 nx-leading-7 first:nx-mt-0">The body of a JSON request is an object containing a set of key-value pairs. A simple representation of a product object is:</p> <div class="nextra-code-block nx-relative nx-mt-6 first:nx-mt-0"><div class="nx-absolute nx-top-0 nx-z-[1] nx-w-full nx-truncate nx-rounded-t-xl nx-bg-primary-700/5 nx-py-2 nx-px-4 nx-text-xs nx-text-gray-700 dark:nx-bg-primary-300/10 dark:nx-text-gray-200">Example request body: Product object</div><pre class="nx-bg-primary-700/5 nx-mb-4 nx-overflow-x-auto nx-rounded-xl nx-subpixel-antialiased dark:nx-bg-primary-300/10 nx-text-[.9em] contrast-more:nx-border contrast-more:nx-border-primary-900/20 contrast-more:nx-contrast-150 contrast-more:dark:nx-border-primary-100/40 nx-pt-12 nx-pb-4" data-language="json" data-theme="default"><code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10 [counter-reset:line]" dir="ltr" data-line-numbers="" data-language="json" data-theme="default" data-line-numbers-max-digits="1"><span class="line"><span style="color:var(--shiki-color-text)">{</span></span> <span class="line"><span style="color:var(--shiki-color-text)"> </span><span style="color:var(--shiki-token-keyword)">"id"</span><span style="color:var(--shiki-token-punctuation)">:</span><span style="color:var(--shiki-color-text)"> </span><span style="color:var(--shiki-token-constant)">5</span><span style="color:var(--shiki-token-punctuation)">,</span></span> <span class="line"><span style="color:var(--shiki-color-text)"> </span><span style="color:var(--shiki-token-keyword)">"name"</span><span style="color:var(--shiki-token-punctuation)">:</span><span style="color:var(--shiki-color-text)"> </span><span style="color:var(--shiki-token-string-expression)">"iPod"</span><span style="color:var(--shiki-token-punctuation)">,</span></span> <span class="line"><span style="color:var(--shiki-color-text)"> </span><span style="color:var(--shiki-token-keyword)">"description"</span><span style="color:var(--shiki-token-punctuation)">:</span><span style="color:var(--shiki-color-text)"> </span><span style="color:var(--shiki-token-string-expression)">"A portable MP3 music player."</span></span> <span class="line"><span style="color:var(--shiki-color-text)">}</span></span></code></pre><div class="nx-opacity-0 nx-transition [div:hover>&]:nx-opacity-100 focus-within:nx-opacity-100 nx-flex nx-gap-1 nx-absolute nx-m-[11px] nx-right-0 nx-top-8"><button class="nextra-button nx-transition-all active:nx-opacity-50 nx-bg-primary-700/5 nx-border nx-border-black/5 nx-text-gray-600 hover:nx-text-gray-900 nx-rounded-md nx-p-1.5 dark:nx-bg-primary-300/10 dark:nx-border-white/10 dark:nx-text-gray-400 dark:hover:nx-text-gray-50 md:nx-hidden" title="Toggle word wrap"><svg viewBox="0 0 24 24" width="24" height="24" class="nx-pointer-events-none nx-h-4 nx-w-4"><path fill="currentColor" d="M4 19h6v-2H4v2zM20 5H4v2h16V5zm-3 6H4v2h13.25c1.1 0 2 .9 2 2s-.9 2-2 2H15v-2l-3 3l3 3v-2h2c2.21 0 4-1.79 4-4s-1.79-4-4-4z"></path></svg></button><button class="nextra-button nx-transition-all active:nx-opacity-50 nx-bg-primary-700/5 nx-border nx-border-black/5 nx-text-gray-600 hover:nx-text-gray-900 nx-rounded-md nx-p-1.5 dark:nx-bg-primary-300/10 dark:nx-border-white/10 dark:nx-text-gray-400 dark:hover:nx-text-gray-50" title="Copy code" tabindex="0"><svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" stroke="currentColor" class="nextra-copy-icon nx-pointer-events-none nx-h-4 nx-w-4"><rect x="9" y="9" width="13" height="13" rx="2" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"></rect><path d="M5 15H4C2.89543 15 2 14.1046 2 13V4C2 2.89543 2.89543 2 4 2H13C14.1046 2 15 2.89543 15 4V5" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"></path></svg></button></div></div> <h3 class="nx-font-semibold nx-tracking-tight nx-text-slate-900 dark:nx-text-slate-100 nx-mt-8 nx-text-2xl">Responses<a href="#responses" id="responses" class="subheading-anchor" aria-label="Permalink for this section"></a></h3> <h4 class="nx-font-semibold nx-tracking-tight nx-text-slate-900 dark:nx-text-slate-100 nx-mt-8 nx-text-xl">Response headers<a href="#response-headers" id="response-headers" class="subheading-anchor" aria-label="Permalink for this section"></a></h4> <p class="nx-mt-6 nx-leading-7 first:nx-mt-0">HTTP response header names are case-insensitive; see the <a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-field-names" target="_blank" rel="noreferrer" class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]">HTTP specification on field names<span class="nx-sr-only nx-select-none"> (opens in a new tab)</span></a> for more information. For example, your application may receive <code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">x-rate-limit-requests-left</code> rather than <code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">X-Rate-Limit-Requests-Left</code>, so plan your implementation accordingly. Most open source HTTP clients treat headers with the appropriate case insensitivity.</p> <h4 class="nx-font-semibold nx-tracking-tight nx-text-slate-900 dark:nx-text-slate-100 nx-mt-8 nx-text-xl">Standard response headers<a href="#standard-response-headers" id="standard-response-headers" class="subheading-anchor" aria-label="Permalink for this section"></a></h4> <table class="nx-block nx-overflow-x-scroll nextra-scrollbar nx-mt-6 nx-p-0 first:nx-mt-0"><thead><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><th class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 nx-font-semibold dark:nx-border-gray-600" align="left">Header</th><th class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 nx-font-semibold dark:nx-border-gray-600" align="left">Possible Values</th><th class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 nx-font-semibold dark:nx-border-gray-600" align="left">Description</th><th class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 nx-font-semibold dark:nx-border-gray-600" align="left">Example</th></tr></thead><tbody><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">Date</code></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">An <a href="http://tools.ietf.org/html/rfc2822#section-3.3" target="_blank">RFC 2822</a> date.</td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">The date the response was sent.</td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">Tue, 15 Nov 2011 12:45:26 GMT</code></td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">last-modified</code></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">An <a href="http://tools.ietf.org/html/rfc2822#section-3.3" target="_blank">RFC 2822</a> date.</td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">The date the resource was last modified. Please refer to the individual resource pages for support for this header.</td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">Tue, 15 Nov 2011 12:45:26 GMT</code></td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">Content-Type</code></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">application/json</code></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">The MIME type of the response, dependent on the extension of the endpoint that was requested.</td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">application/json</code></td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">Content-Location</code></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">A URI</td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">Sent if the request was redirected.</td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">/api/v2/orders/5.json</code></td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">Location</code></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">A URI</td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">The URI of a newly created resource. Sent with a <code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">201 Created</code> response.</td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">/api/v2/products/7</code></td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">Content-Encoding</code></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">gzip</code></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">Allows API clients to request content to be compressed before being sent back in the response to an API request.</td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">gzip</code></td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">Transfer-Encoding</code></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">chunked</code></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">Specifies the form of encoding used to transfer the resource.</td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">chunked</code></td></tr></tbody></table>  <h4 class="nx-font-semibold nx-tracking-tight nx-text-slate-900 dark:nx-text-slate-100 nx-mt-8 nx-text-xl">BigCommerce-specific response headers<a href="#bigcommerce-specific-response-headers" id="bigcommerce-specific-response-headers" class="subheading-anchor" aria-label="Permalink for this section"></a></h4> <table class="nx-block nx-overflow-x-scroll nextra-scrollbar nx-mt-6 nx-p-0 first:nx-mt-0"><thead><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><th class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 nx-font-semibold dark:nx-border-gray-600" align="left">Header</th><th class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 nx-font-semibold dark:nx-border-gray-600" align="left">Possible Values</th><th class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 nx-font-semibold dark:nx-border-gray-600" align="left">Description</th><th class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 nx-font-semibold dark:nx-border-gray-600" align="left">Example</th></tr></thead><tbody><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">X-Rate-Limit-Time-Window-Ms</code></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">number</td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">Shows the size of your current rate-limiting window, in milliseconds.</td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">30000</code></td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">X-Rate-Limit-Time-Reset-Ms</code></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">number</td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">Shows how many milliseconds are remaining in the window. In this case, 15000 milliseconds – so, 15000 milliseconds after this request, the API quota will be refreshed.</td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">15000 </code></td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">X-Rate-Limit-Requests-Quota</code></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">number</td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">Shows how many API requests are allowed in the current window for your client.</td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">150</code></td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">X-Rate-Limit-Requests-Left</code></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">number</td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">Details how many remaining requests your client can make in the current window before being rate-limited. In this case, you would expect to be able to make 35 more requests in the next 15000 milliseconds; on the 36th request within 15000 milliseconds, you would be rate-limited and receive an HTTP 429 response.</td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">35</code></td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">X-Retry-After</code></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">integer</td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">Rate limited response, indicating the number of seconds before the quota refreshes. See <a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/docs/start/best-practices#api-rate-limits">Rate Limits</a> for more information.</td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">15</code></td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">X-BC-ApiLimit-Remaining</code></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">integer</td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">The number of API requests remaining for the current period (rolling one hour).</td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">987</code></td></tr><tr class="nx-m-0 nx-border-t nx-border-gray-300 nx-p-0 dark:nx-border-gray-600 even:nx-bg-gray-100 even:dark:nx-bg-gray-600/20"><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">X-BC-Store-Version</code></td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">A version number</td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left">The version of BigCommerce on which the store is running. This header is available on versions 7.3.6+.</td><td class="nx-m-0 nx-border nx-border-gray-300 nx-px-4 nx-py-2 dark:nx-border-gray-600" align="left"><code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr"> 7.3.6</code></td></tr></tbody></table>  <h4 class="nx-font-semibold nx-tracking-tight nx-text-slate-900 dark:nx-text-slate-100 nx-mt-8 nx-text-xl">Response content type<a href="#response-content-type" id="response-content-type" class="subheading-anchor" aria-label="Permalink for this section"></a></h4> <p class="nx-mt-6 nx-leading-7 first:nx-mt-0">When requesting a resource that returns a body, specify the type of content you want to receive with the <code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">Accept</code> header. Alternatively, you can supply an extension to the resource you're requesting.</p> <p class="nx-mt-6 nx-leading-7 first:nx-mt-0">The priorities with which you can process these methods are:</p> <ul class="nx-mt-6 nx-list-disc first:nx-mt-0 ltr:nx-ml-6 rtl:nx-mr-6"> <li class="nx-my-2">Accept header high-priority types (eg. <code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">Accept: application/json</code>) extensions on the resource (e.g. <code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">customers.json</code>).</li> <li class="nx-my-2">Accept header low priority types (priorities less than 1, e.g. <code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr">Accept: application/json;q=0.9</code>)</li> </ul> <h4 class="nx-font-semibold nx-tracking-tight nx-text-slate-900 dark:nx-text-slate-100 nx-mt-8 nx-text-xl">Response structure<a href="#response-structure" id="response-structure" class="subheading-anchor" aria-label="Permalink for this section"></a></h4> <p class="nx-mt-6 nx-leading-7 first:nx-mt-0">Responses are structured similarly to requests. If a request returns a single object, then the response will contain a single object containing the fields for that resource.</p> <div class="nextra-code-block nx-relative nx-mt-6 first:nx-mt-0"><div class="nx-absolute nx-top-0 nx-z-[1] nx-w-full nx-truncate nx-rounded-t-xl nx-bg-primary-700/5 nx-py-2 nx-px-4 nx-text-xs nx-text-gray-700 dark:nx-bg-primary-300/10 dark:nx-text-gray-200">Example request: Get a category</div><pre class="nx-bg-primary-700/5 nx-mb-4 nx-overflow-x-auto nx-rounded-xl nx-subpixel-antialiased dark:nx-bg-primary-300/10 nx-text-[.9em] contrast-more:nx-border contrast-more:nx-border-primary-900/20 contrast-more:nx-contrast-150 contrast-more:dark:nx-border-primary-100/40 nx-pt-12 nx-pb-4" data-language="http" data-theme="default"><code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10" dir="ltr" data-language="http" data-theme="default"><span class="line"><span style="color:var(--shiki-token-keyword)">GET</span><span style="color:var(--shiki-color-text)"> https://api.bigcommerce.com/stores/{{store_hash}}/v3/catalog/categories/{{category_id}}</span></span></code></pre><div class="nx-opacity-0 nx-transition [div:hover>&]:nx-opacity-100 focus-within:nx-opacity-100 nx-flex nx-gap-1 nx-absolute nx-m-[11px] nx-right-0 nx-top-8"><button class="nextra-button nx-transition-all active:nx-opacity-50 nx-bg-primary-700/5 nx-border nx-border-black/5 nx-text-gray-600 hover:nx-text-gray-900 nx-rounded-md nx-p-1.5 dark:nx-bg-primary-300/10 dark:nx-border-white/10 dark:nx-text-gray-400 dark:hover:nx-text-gray-50 md:nx-hidden" title="Toggle word wrap"><svg viewBox="0 0 24 24" width="24" height="24" class="nx-pointer-events-none nx-h-4 nx-w-4"><path fill="currentColor" d="M4 19h6v-2H4v2zM20 5H4v2h16V5zm-3 6H4v2h13.25c1.1 0 2 .9 2 2s-.9 2-2 2H15v-2l-3 3l3 3v-2h2c2.21 0 4-1.79 4-4s-1.79-4-4-4z"></path></svg></button><button class="nextra-button nx-transition-all active:nx-opacity-50 nx-bg-primary-700/5 nx-border nx-border-black/5 nx-text-gray-600 hover:nx-text-gray-900 nx-rounded-md nx-p-1.5 dark:nx-bg-primary-300/10 dark:nx-border-white/10 dark:nx-text-gray-400 dark:hover:nx-text-gray-50" title="Copy code" tabindex="0"><svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" stroke="currentColor" class="nextra-copy-icon nx-pointer-events-none nx-h-4 nx-w-4"><rect x="9" y="9" width="13" height="13" rx="2" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"></rect><path d="M5 15H4C2.89543 15 2 14.1046 2 13V4C2 2.89543 2.89543 2 4 2H13C14.1046 2 15 2.89543 15 4V5" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"></path></svg></button></div></div> <div class="nextra-code-block nx-relative nx-mt-6 first:nx-mt-0"><div class="nx-absolute nx-top-0 nx-z-[1] nx-w-full nx-truncate nx-rounded-t-xl nx-bg-primary-700/5 nx-py-2 nx-px-4 nx-text-xs nx-text-gray-700 dark:nx-bg-primary-300/10 dark:nx-text-gray-200">Example response: Get a category</div><pre class="nx-bg-primary-700/5 nx-mb-4 nx-overflow-x-auto nx-rounded-xl nx-subpixel-antialiased dark:nx-bg-primary-300/10 nx-text-[.9em] contrast-more:nx-border contrast-more:nx-border-primary-900/20 contrast-more:nx-contrast-150 contrast-more:dark:nx-border-primary-100/40 nx-pt-12 nx-pb-4" data-language="json" data-theme="default"><code class="nx-border-black nx-border-opacity-[0.04] nx-bg-opacity-[0.03] nx-bg-black nx-break-words nx-rounded-md nx-border nx-py-0.5 nx-px-[.25em] nx-text-[.9em] dark:nx-border-white/10 dark:nx-bg-white/10 [counter-reset:line]" dir="ltr" data-line-numbers="" data-language="json" data-theme="default" data-line-numbers-max-digits="2"><span class="line"><span style="color:var(--shiki-color-text)">{</span></span> <span class="line"><span style="color:var(--shiki-color-text)"> </span><span style="color:var(--shiki-token-keyword)">"data"</span><span style="color:var(--shiki-token-punctuation)">:</span><span style="color:var(--shiki-color-text)"> {</span></span> <span class="line"><span style="color:var(--shiki-color-text)"> </span><span style="color:var(--shiki-token-keyword)">"id"</span><span style="color:var(--shiki-token-punctuation)">:</span><span style="color:var(--shiki-color-text)"> </span><span style="color:var(--shiki-token-constant)">39</span><span style="color:var(--shiki-token-punctuation)">,</span></span> <span class="line"><span style="color:var(--shiki-color-text)"> </span><span style="color:var(--shiki-token-keyword)">"parent_id"</span><span style="color:var(--shiki-token-punctuation)">:</span><span style="color:var(--shiki-color-text)"> </span><span style="color:var(--shiki-token-constant)">19</span><span style="color:var(--shiki-token-punctuation)">,</span></span> <span class="line"><span style="color:var(--shiki-color-text)"> </span><span style="color:var(--shiki-token-keyword)">"name"</span><span style="color:var(--shiki-token-punctuation)">:</span><span style="color:var(--shiki-color-text)"> </span><span style="color:var(--shiki-token-string-expression)">"Bath"</span><span style="color:var(--shiki-token-punctuation)">,</span></span> <span class="line"><span style="color:var(--shiki-color-text)"> </span><span style="color:var(--shiki-token-keyword)">"description"</span><span style="color:var(--shiki-token-punctuation)">:</span><span style="color:var(--shiki-color-text)"> </span><span style="color:var(--shiki-token-string-expression)">""</span><span style="color:var(--shiki-token-punctuation)">,</span></span> <span class="line"><span style="color:var(--shiki-color-text)"> </span><span style="color:var(--shiki-token-keyword)">"views"</span><span style="color:var(--shiki-token-punctuation)">:</span><span style="color:var(--shiki-color-text)"> </span><span style="color:var(--shiki-token-constant)">0</span><span style="color:var(--shiki-token-punctuation)">,</span></span> <span class="line"><span style="color:var(--shiki-color-text)"> </span><span style="color:var(--shiki-token-keyword)">"sort_order"</span><span style="color:var(--shiki-token-punctuation)">:</span><span style="color:var(--shiki-color-text)"> </span><span style="color:var(--shiki-token-constant)">0</span><span style="color:var(--shiki-token-punctuation)">,</span></span> <span class="line"><span style="color:var(--shiki-color-text)"> </span><span style="color:var(--shiki-token-keyword)">"page_title"</span><span style="color:var(--shiki-token-punctuation)">:</span><span style="color:var(--shiki-color-text)"> </span><span style="color:var(--shiki-token-string-expression)">""</span><span style="color:var(--shiki-token-punctuation)">,</span></span> <span class="line"><span style="color:var(--shiki-color-text)"> </span><span style="color:var(--shiki-token-keyword)">"meta_keywords"</span><span style="color:var(--shiki-token-punctuation)">:</span><span style="color:var(--shiki-color-text)"> [</span></span> <span class="line"><span style="color:var(--shiki-color-text)"> </span><span style="color:var(--shiki-token-string-expression)">""</span></span> <span class="line"><span style="color:var(--shiki-color-text)"> ]</span><span style="color:var(--shiki-token-punctuation)">,</span></span> <span class="line"><span style="color:var(--shiki-color-text)"> </span><span style="color:var(--shiki-token-keyword)">"meta_description"</span><span style="color:var(--shiki-token-punctuation)">:</span><span style="color:var(--shiki-color-text)"> </span><span style="color:var(--shiki-token-string-expression)">""</span><span style="color:var(--shiki-token-punctuation)">,</span></span> <span class="line"><span style="color:var(--shiki-color-text)"> </span><span style="color:var(--shiki-token-keyword)">"layout_file"</span><span style="color:var(--shiki-token-punctuation)">:</span><span style="color:var(--shiki-color-text)"> </span><span style="color:var(--shiki-token-string-expression)">"category.html"</span><span style="color:var(--shiki-token-punctuation)">,</span></span> <span class="line"><span style="color:var(--shiki-color-text)"> </span><span style="color:var(--shiki-token-keyword)">"image_url"</span><span style="color:var(--shiki-token-punctuation)">:</span><span style="color:var(--shiki-color-text)"> </span><span style="color:var(--shiki-token-string-expression)">""</span><span style="color:var(--shiki-token-punctuation)">,</span></span> <span class="line"><span style="color:var(--shiki-color-text)"> </span><span style="color:var(--shiki-token-keyword)">"is_visible"</span><span style="color:var(--shiki-token-punctuation)">:</span><span style="color:var(--shiki-color-text)"> </span><span style="color:var(--shiki-token-constant)">true</span><span style="color:var(--shiki-token-punctuation)">,</span></span> <span class="line"><span style="color:var(--shiki-color-text)"> </span><span style="color:var(--shiki-token-keyword)">"search_keywords"</span><span style="color:var(--shiki-token-punctuation)">:</span><span style="color:var(--shiki-color-text)"> </span><span style="color:var(--shiki-token-string-expression)">""</span><span style="color:var(--shiki-token-punctuation)">,</span></span> <span class="line"><span style="color:var(--shiki-color-text)"> </span><span style="color:var(--shiki-token-keyword)">"default_product_sort"</span><span style="color:var(--shiki-token-punctuation)">:</span><span style="color:var(--shiki-color-text)"> </span><span style="color:var(--shiki-token-string-expression)">"use_store_settings"</span><span style="color:var(--shiki-token-punctuation)">,</span></span> <span class="line"><span style="color:var(--shiki-color-text)"> </span><span style="color:var(--shiki-token-keyword)">"custom_url"</span><span style="color:var(--shiki-token-punctuation)">:</span><span style="color:var(--shiki-color-text)"> {</span></span> <span class="line"><span style="color:var(--shiki-color-text)"> </span><span style="color:var(--shiki-token-keyword)">"url"</span><span style="color:var(--shiki-token-punctuation)">:</span><span style="color:var(--shiki-color-text)"> </span><span style="color:var(--shiki-token-string-expression)">"/garden/bath/"</span><span style="color:var(--shiki-token-punctuation)">,</span></span> <span class="line"><span style="color:var(--shiki-color-text)"> </span><span style="color:var(--shiki-token-keyword)">"is_customized"</span><span style="color:var(--shiki-token-punctuation)">:</span><span style="color:var(--shiki-color-text)"> </span><span style="color:var(--shiki-token-constant)">false</span></span> <span class="line"><span style="color:var(--shiki-color-text)"> }</span></span> <span class="line"><span style="color:var(--shiki-color-text)"> }</span><span style="color:var(--shiki-token-punctuation)">,</span></span> <span class="line"><span style="color:var(--shiki-color-text)"> </span><span style="color:var(--shiki-token-keyword)">"meta"</span><span style="color:var(--shiki-token-punctuation)">:</span><span style="color:var(--shiki-color-text)"> {}</span></span> <span class="line"><span style="color:var(--shiki-color-text)">}</span></span></code></pre><div class="nx-opacity-0 nx-transition [div:hover>&]:nx-opacity-100 focus-within:nx-opacity-100 nx-flex nx-gap-1 nx-absolute nx-m-[11px] nx-right-0 nx-top-8"><button class="nextra-button nx-transition-all active:nx-opacity-50 nx-bg-primary-700/5 nx-border nx-border-black/5 nx-text-gray-600 hover:nx-text-gray-900 nx-rounded-md nx-p-1.5 dark:nx-bg-primary-300/10 dark:nx-border-white/10 dark:nx-text-gray-400 dark:hover:nx-text-gray-50 md:nx-hidden" title="Toggle word wrap"><svg viewBox="0 0 24 24" width="24" height="24" class="nx-pointer-events-none nx-h-4 nx-w-4"><path fill="currentColor" d="M4 19h6v-2H4v2zM20 5H4v2h16V5zm-3 6H4v2h13.25c1.1 0 2 .9 2 2s-.9 2-2 2H15v-2l-3 3l3 3v-2h2c2.21 0 4-1.79 4-4s-1.79-4-4-4z"></path></svg></button><button class="nextra-button nx-transition-all active:nx-opacity-50 nx-bg-primary-700/5 nx-border nx-border-black/5 nx-text-gray-600 hover:nx-text-gray-900 nx-rounded-md nx-p-1.5 dark:nx-bg-primary-300/10 dark:nx-border-white/10 dark:nx-text-gray-400 dark:hover:nx-text-gray-50" title="Copy code" tabindex="0"><svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" stroke="currentColor" class="nextra-copy-icon nx-pointer-events-none nx-h-4 nx-w-4"><rect x="9" y="9" width="13" height="13" rx="2" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"></rect><path d="M5 15H4C2.89543 15 2 14.1046 2 13V4C2 2.89543 2.89543 2 4 2H13C14.1046 2 15 2.89543 15 4V5" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"></path></svg></button></div></div> <h2 class="nx-font-semibold nx-tracking-tight nx-text-slate-900 dark:nx-text-slate-100 nx-mt-10 nx-border-b nx-pb-1 nx-text-3xl nx-border-neutral-200/70 contrast-more:nx-border-neutral-400 dark:nx-border-primary-100/10 contrast-more:dark:nx-border-neutral-400">Support<a href="#support" id="support" class="subheading-anchor" aria-label="Permalink for this section"></a></h2> <h3 class="nx-font-semibold nx-tracking-tight nx-text-slate-900 dark:nx-text-slate-100 nx-mt-8 nx-text-2xl">Developer community<a href="#developer-community" id="developer-community" class="subheading-anchor" aria-label="Permalink for this section"></a></h3> <p class="nx-mt-6 nx-leading-7 first:nx-mt-0">The <a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/community">developer community</a> is a great place to get help from other developers who work on the BigCommerce platform. If you have BigCommerce-specific questions, this online forum is the best place to ask. It's also an excellent place for beginners to get assistance.</p> <h3 class="nx-font-semibold nx-tracking-tight nx-text-slate-900 dark:nx-text-slate-100 nx-mt-8 nx-text-2xl">BigCommerce at Stack Overflow<a href="#bigcommerce-at-stack-overflow" id="bigcommerce-at-stack-overflow" class="subheading-anchor" aria-label="Permalink for this section"></a></h3> <p class="nx-mt-6 nx-leading-7 first:nx-mt-0">Are you a more experienced developer or have a programming language-specific question? <a href="https://stackoverflow.com/questions/tagged/bigcommerce" target="_blank" rel="noreferrer" class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]">Stack Overflow<span class="nx-sr-only nx-select-none"> (opens in a new tab)</span></a> is a good place to ask questions and get help. The developer community is the best place to get answers about the BigCommerce platform.</p> <h3 class="nx-font-semibold nx-tracking-tight nx-text-slate-900 dark:nx-text-slate-100 nx-mt-8 nx-text-2xl">Developer release notes<a href="#developer-release-notes" id="developer-release-notes" class="subheading-anchor" aria-label="Permalink for this section"></a></h3> <p class="nx-mt-6 nx-leading-7 first:nx-mt-0">Our <a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/release-notes">release notes</a> catalog notable updates made to the BigCommerce platform and to the documentation. You can find significant changes, such as new features, latest releases, and bug fixes.</p> <h2 class="nx-font-semibold nx-tracking-tight nx-text-slate-900 dark:nx-text-slate-100 nx-mt-10 nx-border-b nx-pb-1 nx-text-3xl nx-border-neutral-200/70 contrast-more:nx-border-neutral-400 dark:nx-border-primary-100/10 contrast-more:dark:nx-border-neutral-400">Resources<a href="#resources" id="resources" class="subheading-anchor" aria-label="Permalink for this section"></a></h2> <ul class="nx-mt-6 nx-list-disc first:nx-mt-0 ltr:nx-ml-6 rtl:nx-mr-6"> <li class="nx-my-2"><a class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]" href="/community">Developer Community</a></li> <li class="nx-my-2"><a href="https://www.bigcommerce.com/terms/api-terms/" target="_blank" rel="noreferrer" class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]">Terms of Service<span class="nx-sr-only nx-select-none"> (opens in a new tab)</span></a></li> <li class="nx-my-2"><a href="https://stackoverflow.com/questions/tagged/bigcommerce" target="_blank" rel="noreferrer" class="nx-text-primary-600 nx-underline nx-decoration-from-font [text-underline-position:from-font]">BigCommerce on Stack Overflow<span class="nx-sr-only nx-select-none"> (opens in a new tab)</span></a></li> </ul><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 class="nx-mb-8 nx-flex nx-items-center nx-border-t nx-pt-8 dark:nx-border-neutral-800 contrast-more:nx-border-neutral-400 dark:contrast-more:nx-border-neutral-400 print:nx-hidden"><a title="Introduction to BigCommerce" class="nx-flex nx-max-w-[50%] nx-items-center nx-gap-1 nx-py-4 nx-text-base nx-font-medium nx-text-gray-600 nx-transition-colors [word-break:break-word] hover:nx-text-primary-600 dark:nx-text-gray-300 md:nx-text-lg ltr:nx-pr-4 rtl:nx-pl-4" href="/docs/start/intro-to-bigcommerce"><svg fill="none" viewBox="0 0 24 24" stroke="currentColor" class="nx-inline nx-h-5 nx-shrink-0 ltr:nx-rotate-180"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M9 5l7 7-7 7"></path></svg>Introduction to BigCommerce</a><a title="Status codes" class="nx-flex nx-max-w-[50%] nx-items-center nx-gap-1 nx-py-4 nx-text-base nx-font-medium nx-text-gray-600 nx-transition-colors [word-break:break-word] hover:nx-text-primary-600 dark:nx-text-gray-300 md:nx-text-lg ltr:nx-ml-auto ltr:nx-pl-4 ltr:nx-text-right rtl:nx-mr-auto rtl:nx-pr-4 rtl:nx-text-left" href="/docs/start/about/status-codes">Status codes<svg fill="none" viewBox="0 0 24 24" stroke="currentColor" class="nx-inline nx-h-5 nx-shrink-0 rtl:nx-rotate-180"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M9 5l7 7-7 7"></path></svg></a></div></div></main></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":{"__nextra_dynamic_mdx":"/*@jsxRuntime automatic @jsxImportSource react*/\n/*| `Strict-Transport-Security` | | | |*/\n/*| `X-Request-ID` | | | |*/\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = Object.assign({\n h1: \"h1\",\n p: \"p\",\n a: \"a\",\n h2: \"h2\",\n h3: \"h3\",\n ul: \"ul\",\n li: \"li\",\n strong: \"strong\",\n table: \"table\",\n thead: \"thead\",\n tr: \"tr\",\n th: \"th\",\n tbody: \"tbody\",\n td: \"td\",\n h4: \"h4\",\n code: \"code\",\n pre: \"pre\",\n span: \"span\"\n }, _provideComponents(), props.components);\n return _jsxs(_Fragment, {\n children: [_jsx(_components.h1, {\n children: \"About Our APIs\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"The BigCommerce suite of APIs empowers you to create apps, automate store processes, and build headless ecommerce solutions.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"If you're new to building BigCommerce apps, we recommend that you start by exploring the \", _jsx(_components.a, {\n href: \"https://www.bigcommerce.com/apps/\",\n children: \"App Marketplace\"\n }), \" to get a feel for what's possible.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"When you're ready to play with our APIs, check out the \", _jsx(_components.a, {\n href: \"/archive/start/making-requests\",\n children: \"API Request Quick Start\"\n }), \".\"]\n }), \"\\n\", _jsx(_components.h2, {\n id: \"available-apis\",\n children: \"Available APIs\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"BigCommerce has several APIs that let you manage store data, authenticate customers, make client-side queries for product information, and more.\"\n }), \"\\n\", _jsx(_components.h3, {\n id: \"rest-store-management-apis\",\n children: \"REST Store Management APIs\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"BigCommerce's Store Management and Payment APIs (for example, the \", _jsx(_components.a, {\n href: \"/docs/rest-catalog\",\n children: \"Catalog API\"\n }), \") allow you to manage transactions, modify store data, and act as store administrator. Example use cases include the following:\"]\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Add and update products in a store\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Update a customer's order and change the order status\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Create a coupon\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Manage a customer's store account details\"\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.h3, {\n id: \"rest-storefront-api\",\n children: \"REST Storefront API\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"The \", _jsx(_components.a, {\n href: \"/docs/rest-storefront/carts\",\n children: \"REST Storefront API\"\n }), \" lets you manage customer carts, checkouts, and order information client-side. Example use cases include the following:\"]\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Add an item with JavaScript to a shopper's cart from a Stencil storefront\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Programmatically retrieve and display information to a customer about their recent order\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Update the billing address of a checkout\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Clear a customer's current cart\"\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.h3, {\n id: \"graphql-storefront-api\",\n children: \"GraphQL Storefront API\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"BigCommerce's \", _jsx(_components.a, {\n href: \"/docs/graphql-storefront\",\n children: \"GraphQL Storefront API\"\n }), \" lets you query and mutate products, customers, and carts, then launch a checkout on a headless storefront as well as from a native storefront's frontend. Example use cases include the following:\"]\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Add additional product data to a Stencil storefront\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Access customer data on the frontend of a site\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Manage shopper's carts on a headless storefront\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Fetch category and brand details from a store's frontend\"\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.h3, {\n id: \"customer-login-api\",\n children: \"Customer Login API\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"The \", _jsx(_components.a, {\n href: \"/docs/start/authentication/customer-login\",\n children: \"Customer Login API\"\n }), \" lets you programmatically sign customers in to a BigCommerce storefront. Example use cases include the following:\"]\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Sign customers in to a BigCommerce store from a third-party account or a headless storefront\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Enable login using credentials other than email and password, such as a phone number\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Integrate a BigCommerce store with an SSO provider\"\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.h3, {\n id: \"current-customer-api\",\n children: \"Current Customer API\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"BigCommerce's \", _jsx(_components.a, {\n href: \"/docs/start/authentication/current-customer\",\n children: \"Current Customer API\"\n }), \" lets you determine which customer is logged in to a storefront during a session.\"]\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Confirm a customer's identity in the browser\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"Validate a customer's identity to display specific information to them from an external app\"\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.h2, {\n id: \"api-authentication-and-context\",\n children: \"API authentication and context\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Make BigCommerce API requests in the context of the \", _jsx(_components.strong, {\n children: \"storefront\"\n }), \", BigCommerce \", _jsx(_components.strong, {\n children: \"API server\"\n }), \", or \", _jsx(_components.strong, {\n children: \"app server\"\n }), \". Each of the following APIs listings links to its section of our \", _jsx(_components.a, {\n href: \"/docs/start/authentication\",\n children: \"Authentication and Example Requests\"\n }), \" article, which contains the base URL of the API in question.\"]\n }), \"\\n\", _jsxs(_components.table, {\n children: [_jsx(_components.thead, {\n children: _jsxs(_components.tr, {\n children: [_jsx(_components.th, {\n align: \"left\",\n children: \"API or Use Case\"\n }), _jsx(_components.th, {\n align: \"left\",\n children: \"Context\"\n })]\n })\n }), _jsxs(_components.tbody, {\n children: [_jsxs(_components.tr, {\n children: [_jsxs(_components.td, {\n align: \"left\",\n children: [_jsx(_components.a, {\n href: \"/docs/start/authentication#access-tokens\",\n children: \"GraphQL Account API\"\n }), \", including \", _jsx(_components.a, {\n href: \"/docs/graphql-account/users\",\n children: \"Users\"\n })]\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"server\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.a, {\n href: \"/docs/start/authentication#access-tokens\",\n children: \"GraphQL Admin API\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"server\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.a, {\n href: \"/docs/start/authentication#bigcommerce-generated-jwts\",\n children: \"GraphQL Storefront API\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"storefront\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.a, {\n href: \"/docs/start/authentication#access-tokens\",\n children: \"REST Management API\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"server\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.a, {\n href: \"/docs/start/authentication#same-origin-cors-authentication\",\n children: \"REST Storefront API\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"storefront\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.a, {\n href: \"/docs/start/authentication#user-generated-jwts\",\n children: \"Customer Login API\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"storefront\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.a, {\n href: \"/docs/start/authentication#client-id\",\n children: \"Current Customer API\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"storefront\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.a, {\n href: \"/docs/start/authentication#bigcommerce-generated-jwts\",\n children: \"Payments API\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"server\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.a, {\n href: \"/docs/start/authentication#developer-configured-authentication\",\n children: \"Apps that host REST Provider APIs (provider apps)\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"server\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: \"Apps hosted in the store control panel (single-click apps)\"\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"server\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: \"Single-store frontend scripts\"\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"storefront\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: \"Headless storefronts with backend or request proxy\"\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"server\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: \"Serverless headless storefronts\"\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"storefront, GraphQL-only\"\n })]\n })]\n })]\n }), \"\\n\", _jsx(_components.h2, {\n id: \"available-store-resources\",\n children: \"Available store resources\"\n }), \"\\n\", _jsxs(_components.table, {\n children: [_jsx(_components.thead, {\n children: _jsxs(_components.tr, {\n children: [_jsx(_components.th, {\n align: \"left\",\n children: \"Resource\"\n }), _jsx(_components.th, {\n align: \"left\",\n children: \"Description\"\n })]\n })\n }), _jsxs(_components.tbody, {\n children: [_jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.a, {\n href: \"/docs/rest-catalog\",\n children: \"Catalog\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"The Catalog API manages products, brands, and categories for a store.\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.a, {\n href: \"/docs/rest-management/store-information\",\n children: \"Store Information\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"Get system timestamp and basic store information.\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.a, {\n href: \"/docs/rest-management/currencies\",\n children: \"Currency\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"Manage currency displayed on the storefront.\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.a, {\n href: \"/docs/rest-management/geography\",\n children: \"Geography\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"Get a list of states and countries.\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.a, {\n href: \"/docs/rest-management/tax-classes\",\n children: \"Tax Class\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"Manage tax classes available on a store.\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.a, {\n href: \"/docs/rest-storefront/carts\",\n children: \"Storefront Cart\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"Create a cart or scrape cart data from the frontend.\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.a, {\n href: \"/docs/rest-management/checkouts\",\n children: \"Storefront Checkout\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"Create a checkout or scrape checkout data from the frontend.\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.a, {\n href: \"/docs/rest-management/carts\",\n children: \"Store Management Cart\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"Create a cart and bypass the BigCommerce frontend.\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.a, {\n href: \"/docs/rest-storefront/checkouts\",\n children: \"Store Management Checkout\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"Create a checkout and bypass the BigCommerce frontend.\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.a, {\n href: \"/docs/rest-management/orders\",\n children: \"Store Management Orders\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"Create and manage orders.\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.a, {\n href: \"/docs/rest-management/transactions\",\n children: \"Store Management Order Transactions\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"View order payment information.\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.a, {\n href: \"/docs/rest-storefront/orders\",\n children: \"Storefront Orders\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"View storefront order information.\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.a, {\n href: \"/docs/rest-management/customers-v2\",\n children: \"Customers V2\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"Manage store customers.\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.a, {\n href: \"/docs/rest-management/customers\",\n children: \"Customers V3\"\n })\n }), _jsxs(_components.td, {\n align: \"left\",\n children: [\"Manage store customers. To learn about using Customers V3 versus V2, see the \", _jsx(_components.a, {\n href: \"/docs/store-operations/customers\",\n children: \"Customers Overview\"\n }), \".\"]\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.a, {\n href: \"/docs/rest-management/subscribers\",\n children: \"Subscribers\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"Manage newsletter subscribers.\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.a, {\n href: \"/docs/rest-management/price-lists\",\n children: \"Price Lists\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"Create variations of catalog pricing.\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.a, {\n href: \"/docs/rest-management/scripts\",\n children: \"Scripts\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"Add and remove scripts from storefront pages.\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.a, {\n href: \"/docs/rest-content/marketing\",\n children: \"Marketing\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"Create and manage coupons, banners, and gift certificates.\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.a, {\n href: \"/docs/rest-payments/tokens\",\n children: \"Payments - Create a payment access token\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"Create an order-specific token to process a shopper's payment.\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.a, {\n href: \"/docs/rest-payments/methods\",\n children: \"Payments - Get accepted methods\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"Get a list of accepted payment methods available on a store.\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.a, {\n href: \"/docs/rest-payments/methods-deprecated\",\n children: \"Payments - Get methods (deprecated)\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"Get a list of payment gateways available on a store.\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.a, {\n href: \"/docs/rest-payments/processing\",\n children: \"Payments - Process Payments\"\n })\n }), _jsxs(_components.td, {\n align: \"left\",\n children: [\"Process payments using a \", _jsx(_components.a, {\n href: \"/docs/rest-payments/tokens\",\n children: \"payment access token\"\n }), \" and \", _jsx(_components.a, {\n href: \"/docs/rest-payments/methods\",\n children: \"accepted payment method\"\n }), \".\"]\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.a, {\n href: \"/docs/rest-management/shipping-v2\",\n children: \"Shipping\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"Create and manage shipping methods and zones.\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.a, {\n href: \"/docs/rest-content/store-content/blog-posts\",\n children: \"Store Content\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"Manage a store's blog posts and blog tags.\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.a, {\n href: \"/docs/rest-content/pages\",\n children: \"Pages\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"Manage a store's web pages.\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.a, {\n href: \"/docs/rest-management/redirects\",\n children: \"Redirects\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"Manage a store's redirects.\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.a, {\n href: \"/docs/rest-content/themes\",\n children: \"Themes\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"Manage store's themes.\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.a, {\n href: \"/docs/rest-content/widgets\",\n children: \"Widgets\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"Programmatically inject content into a BigCommerce theme.\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.a, {\n href: \"/docs/rest-management/wishlists\",\n children: \"Wishlists\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"Create and manage customer wishlists.\"\n })]\n })]\n })]\n }), \"\\n\", _jsx(_components.h2, {\n id: \"anatomy-of-rest-store-management-apis\",\n children: \"Anatomy of REST Store Management APIs\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"The following sections describe the configuration of well-formed requests and responses to and from BigCommerce-hosted REST APIs.\"\n }), \"\\n\", _jsx(_components.h3, {\n id: \"media-types\",\n children: \"Media types\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"A media type is the format of the request or response body. BigCommerce APIs accept requests and send responses in JSON. Encode requests using the UTF-8 character set; other character sets can have unpredictable results.\"\n }), \"\\n\", _jsx(_components.h3, {\n id: \"requests\",\n children: \"Requests\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"For more information about required request headers, consult the \", _jsx(_components.a, {\n href: \"/docs/api\",\n children: \"API reference\"\n }), \" for the endpoint or graph you want to use.\"]\n }), \"\\n\", _jsx(_components.h4, {\n id: \"standard-request-headers\",\n children: \"Standard request headers\"\n }), \"\\n\", _jsxs(_components.table, {\n children: [_jsx(_components.thead, {\n children: _jsxs(_components.tr, {\n children: [_jsx(_components.th, {\n align: \"left\",\n children: \"Header\"\n }), _jsx(_components.th, {\n align: \"left\",\n children: \"Expected value or type\"\n }), _jsx(_components.th, {\n align: \"left\",\n children: \"Description\"\n }), _jsx(_components.th, {\n align: \"left\",\n children: \"Example\"\n })]\n })\n }), _jsxs(_components.tbody, {\n children: [_jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.code, {\n children: \"Accept\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"MIME types\"\n }), _jsxs(_components.td, {\n align: \"left\",\n children: [\"The MIME type format that indicates which response type the request expects. For more information, see \", _jsx(_components.a, {\n href: \"https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept\",\n children: \"HTTP Docs: Accept Header (MDN)\"\n }), \".\"]\n }), _jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.code, {\n children: \"application/json\"\n })\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.code, {\n children: \"Content-Type\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"MIME types\"\n }), _jsxs(_components.td, {\n align: \"left\",\n children: [\"The MIME type of the request body. The API uses this value to validate and parse the request. For more information, see \", _jsx(_components.a, {\n href: \"https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type\",\n children: \"HTTP Docs: Content-Type Header (MDN)\"\n }), \".\"]\n }), _jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.code, {\n children: \"application/json\"\n })\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.code, {\n children: \"User-Agent\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"String\"\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"We ask that you specify a user agent to identify your integration or client.\"\n }), _jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.code, {\n children: \"PostmanRuntime/7.32.3\"\n })\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.code, {\n children: \"Authorization\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"String\"\n }), _jsxs(_components.td, {\n align: \"left\",\n children: [\"Requests to the \", _jsx(_components.a, {\n href: \"/docs/rest-payments/processing\",\n children: \"Process payments\"\n }), \" endpoint and the \", _jsx(_components.a, {\n href: \"/docs/graphql-storefront\",\n children: \"GraphQL Storefront API\"\n }), \" use the \", _jsx(_components.code, {\n children: \"Authorization\"\n }), \" header to authenticate. For more information, see \", _jsx(_components.a, {\n href: \"https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization\",\n children: \"HTTP Docs: Authorization Header (MDN)\"\n }), \".\"]\n }), _jsxs(_components.td, {\n align: \"left\",\n children: [_jsx(_components.code, {\n children: \"Bearer {{STOREFRONT_TOKEN}}\"\n }), \" or \", _jsx(_components.code, {\n children: \"PAT {{PAYMENT_ACCESS_TOKEN}}\"\n })]\n })]\n })]\n })]\n }), \"\\n\", _jsx(_components.h4, {\n id: \"bigcommerce-specific-request-headers\",\n children: \"BigCommerce-specific request headers\"\n }), \"\\n\", _jsxs(_components.table, {\n children: [_jsx(_components.thead, {\n children: _jsxs(_components.tr, {\n children: [_jsx(_components.th, {\n align: \"left\",\n children: \"Header\"\n }), _jsx(_components.th, {\n align: \"left\",\n children: \"Expected value or type\"\n }), _jsx(_components.th, {\n align: \"left\",\n children: \"Description\"\n })]\n })\n }), _jsxs(_components.tbody, {\n children: [_jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.code, {\n children: \"X-Auth-Token\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"API account access token\"\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"Requests to the REST Management, Catalog, GraphQL Admin, and GraphQL Account APIs use this header to authenticate. Some Payment endpoints also use this header.\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.code, {\n children: \"X-Auth-Client\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"API account client ID\"\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"No longer required for any requests to BigCommerce.\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.code, {\n children: \"X-Correlation-Id\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"UUID in an 8-4-4-4-12 format\"\n }), _jsxs(_components.td, {\n align: \"left\",\n children: [\"An identifier unique to a set of related requests. For use on headless storefronts, excluding BigCommerce for WordPress. For more information, see \", _jsx(_components.a, {\n href: \"/docs/start/best-practices#correlating-requests\",\n children: \"Best Practices\"\n }), \" or the \", _jsx(_components.a, {\n href: \"/docs/storefront/headless#correlating-requests\",\n children: \"Headless Guide\"\n }), \".\"]\n })]\n })]\n })]\n }), \"\\n\", _jsx(_components.h4, {\n id: \"request-content-type\",\n children: \"Request content type\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"When performing a request that contains a body, specify the type of content you are sending with the \", _jsx(_components.code, {\n children: \"Content-Type\"\n }), \" header. This typically applies to \", _jsx(_components.code, {\n children: \"PUT\"\n }), \" and \", _jsx(_components.code, {\n children: \"POST\"\n }), \" requests.\"]\n }), \"\\n\", _jsx(_components.h4, {\n id: \"request-structure\",\n children: \"Request structure\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"The body of a JSON request is an object containing a set of key-value pairs. A simple representation of a product object is:\"\n }), \"\\n\", _jsx(_components.pre, {\n \"data-language\": \"json\",\n \"data-theme\": \"default\",\n filename: \"Example request body: Product object\",\n hasCopyCode: true,\n children: _jsxs(_components.code, {\n \"data-line-numbers\": \"\",\n \"data-language\": \"json\",\n \"data-theme\": \"default\",\n \"data-line-numbers-max-digits\": \"1\",\n children: [_jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \"{\"\n })\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" \"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-keyword)\"\n },\n children: \"\\\"id\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-punctuation)\"\n },\n children: \":\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" \"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-constant)\"\n },\n children: \"5\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-punctuation)\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" \"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-keyword)\"\n },\n children: \"\\\"name\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-punctuation)\"\n },\n children: \":\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" \"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-string-expression)\"\n },\n children: \"\\\"iPod\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-punctuation)\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" \"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-keyword)\"\n },\n children: \"\\\"description\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-punctuation)\"\n },\n children: \":\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" \"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-string-expression)\"\n },\n children: \"\\\"A portable MP3 music player.\\\"\"\n })]\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \"}\"\n })\n })]\n })\n }), \"\\n\", _jsx(_components.h3, {\n id: \"responses\",\n children: \"Responses\"\n }), \"\\n\", _jsx(_components.h4, {\n id: \"response-headers\",\n children: \"Response headers\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"HTTP response header names are case-insensitive; see the \", _jsx(_components.a, {\n href: \"https://www.rfc-editor.org/rfc/rfc9110.html#name-field-names\",\n children: \"HTTP specification on field names\"\n }), \" for more information. For example, your application may receive \", _jsx(_components.code, {\n children: \"x-rate-limit-requests-left\"\n }), \" rather than \", _jsx(_components.code, {\n children: \"X-Rate-Limit-Requests-Left\"\n }), \", so plan your implementation accordingly. Most open source HTTP clients treat headers with the appropriate case insensitivity.\"]\n }), \"\\n\", _jsx(_components.h4, {\n id: \"standard-response-headers\",\n children: \"Standard response headers\"\n }), \"\\n\", _jsxs(_components.table, {\n children: [_jsx(_components.thead, {\n children: _jsxs(_components.tr, {\n children: [_jsx(_components.th, {\n align: \"left\",\n children: \"Header\"\n }), _jsx(_components.th, {\n align: \"left\",\n children: \"Possible Values\"\n }), _jsx(_components.th, {\n align: \"left\",\n children: \"Description\"\n }), _jsx(_components.th, {\n align: \"left\",\n children: \"Example\"\n })]\n })\n }), _jsxs(_components.tbody, {\n children: [_jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.code, {\n children: \"Date\"\n })\n }), _jsxs(_components.td, {\n align: \"left\",\n children: [\"An \", _jsx(\"a\", {\n href: \"http://tools.ietf.org/html/rfc2822#section-3.3\",\n target: \"_blank\",\n children: \"RFC 2822\"\n }), \" date.\"]\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"The date the response was sent.\"\n }), _jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.code, {\n children: \"Tue, 15 Nov 2011 12:45:26 GMT\"\n })\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.code, {\n children: \"last-modified\"\n })\n }), _jsxs(_components.td, {\n align: \"left\",\n children: [\"An \", _jsx(\"a\", {\n href: \"http://tools.ietf.org/html/rfc2822#section-3.3\",\n target: \"_blank\",\n children: \"RFC 2822\"\n }), \" date.\"]\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"The date the resource was last modified. Please refer to the individual resource pages for support for this header.\"\n }), _jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.code, {\n children: \"Tue, 15 Nov 2011 12:45:26 GMT\"\n })\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.code, {\n children: \"Content-Type\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.code, {\n children: \"application/json\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"The MIME type of the response, dependent on the extension of the endpoint that was requested.\"\n }), _jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.code, {\n children: \"application/json\"\n })\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.code, {\n children: \"Content-Location\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"A URI\"\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"Sent if the request was redirected.\"\n }), _jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.code, {\n children: \"/api/v2/orders/5.json\"\n })\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.code, {\n children: \"Location\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"A URI\"\n }), _jsxs(_components.td, {\n align: \"left\",\n children: [\"The URI of a newly created resource. Sent with a \", _jsx(_components.code, {\n children: \"201 Created\"\n }), \" response.\"]\n }), _jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.code, {\n children: \"/api/v2/products/7\"\n })\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.code, {\n children: \"Content-Encoding\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.code, {\n children: \"gzip\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"Allows API clients to request content to be compressed before being sent back in the response to an API request.\"\n }), _jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.code, {\n children: \"gzip\"\n })\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.code, {\n children: \"Transfer-Encoding\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.code, {\n children: \"chunked\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"Specifies the form of encoding used to transfer the resource.\"\n }), _jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.code, {\n children: \"chunked\"\n })\n })]\n })]\n })]\n }), \"\\n\", \"\\n\", _jsx(_components.h4, {\n id: \"bigcommerce-specific-response-headers\",\n children: \"BigCommerce-specific response headers\"\n }), \"\\n\", _jsxs(_components.table, {\n children: [_jsx(_components.thead, {\n children: _jsxs(_components.tr, {\n children: [_jsx(_components.th, {\n align: \"left\",\n children: \"Header\"\n }), _jsx(_components.th, {\n align: \"left\",\n children: \"Possible Values\"\n }), _jsx(_components.th, {\n align: \"left\",\n children: \"Description\"\n }), _jsx(_components.th, {\n align: \"left\",\n children: \"Example\"\n })]\n })\n }), _jsxs(_components.tbody, {\n children: [_jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.code, {\n children: \"X-Rate-Limit-Time-Window-Ms\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"number\"\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"Shows the size of your current rate-limiting window, in milliseconds.\"\n }), _jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.code, {\n children: \"30000\"\n })\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.code, {\n children: \"X-Rate-Limit-Time-Reset-Ms\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"number\"\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"Shows how many milliseconds are remaining in the window. In this case, 15000 milliseconds – so, 15000 milliseconds after this request, the API quota will be refreshed.\"\n }), _jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.code, {\n children: \"15000 \"\n })\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.code, {\n children: \"X-Rate-Limit-Requests-Quota\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"number\"\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"Shows how many API requests are allowed in the current window for your client.\"\n }), _jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.code, {\n children: \"150\"\n })\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.code, {\n children: \"X-Rate-Limit-Requests-Left\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"number\"\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"Details how many remaining requests your client can make in the current window before being rate-limited. In this case, you would expect to be able to make 35 more requests in the next 15000 milliseconds; on the 36th request within 15000 milliseconds, you would be rate-limited and receive an HTTP 429 response.\"\n }), _jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.code, {\n children: \"35\"\n })\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.code, {\n children: \"X-Retry-After\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"integer\"\n }), _jsxs(_components.td, {\n align: \"left\",\n children: [\"Rate limited response, indicating the number of seconds before the quota refreshes. See \", _jsx(_components.a, {\n href: \"/docs/start/best-practices#api-rate-limits\",\n children: \"Rate Limits\"\n }), \" for more information.\"]\n }), _jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.code, {\n children: \"15\"\n })\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.code, {\n children: \"X-BC-ApiLimit-Remaining\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"integer\"\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"The number of API requests remaining for the current period (rolling one hour).\"\n }), _jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.code, {\n children: \"987\"\n })\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.code, {\n children: \"X-BC-Store-Version\"\n })\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"A version number\"\n }), _jsx(_components.td, {\n align: \"left\",\n children: \"The version of BigCommerce on which the store is running. This header is available on versions 7.3.6+.\"\n }), _jsx(_components.td, {\n align: \"left\",\n children: _jsx(_components.code, {\n children: \" 7.3.6\"\n })\n })]\n })]\n })]\n }), \"\\n\", \"\\n\", _jsx(_components.h4, {\n id: \"response-content-type\",\n children: \"Response content type\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"When requesting a resource that returns a body, specify the type of content you want to receive with the \", _jsx(_components.code, {\n children: \"Accept\"\n }), \" header. Alternatively, you can supply an extension to the resource you're requesting.\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"The priorities with which you can process these methods are:\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [\"Accept header high-priority types (eg. \", _jsx(_components.code, {\n children: \"Accept: application/json\"\n }), \") extensions on the resource (e.g. \", _jsx(_components.code, {\n children: \"customers.json\"\n }), \").\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"Accept header low priority types (priorities less than 1, e.g. \", _jsx(_components.code, {\n children: \"Accept: application/json;q=0.9\"\n }), \")\"]\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.h4, {\n id: \"response-structure\",\n children: \"Response structure\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Responses are structured similarly to requests. If a request returns a single object, then the response will contain a single object containing the fields for that resource.\"\n }), \"\\n\", _jsx(_components.pre, {\n \"data-language\": \"http\",\n \"data-theme\": \"default\",\n filename: \"Example request: Get a category\",\n hasCopyCode: true,\n children: _jsx(_components.code, {\n \"data-language\": \"http\",\n \"data-theme\": \"default\",\n children: _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-keyword)\"\n },\n children: \"GET\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" https://api.bigcommerce.com/stores/{{store_hash}}/v3/catalog/categories/{{category_id}}\"\n })]\n })\n })\n }), \"\\n\", _jsx(_components.pre, {\n \"data-language\": \"json\",\n \"data-theme\": \"default\",\n filename: \"Example response: Get a category\",\n hasCopyCode: true,\n children: _jsxs(_components.code, {\n \"data-line-numbers\": \"\",\n \"data-language\": \"json\",\n \"data-theme\": \"default\",\n \"data-line-numbers-max-digits\": \"2\",\n children: [_jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \"{\"\n })\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" \"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-keyword)\"\n },\n children: \"\\\"data\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-punctuation)\"\n },\n children: \":\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" {\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" \"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-keyword)\"\n },\n children: \"\\\"id\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-punctuation)\"\n },\n children: \":\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" \"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-constant)\"\n },\n children: \"39\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-punctuation)\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" \"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-keyword)\"\n },\n children: \"\\\"parent_id\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-punctuation)\"\n },\n children: \":\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" \"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-constant)\"\n },\n children: \"19\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-punctuation)\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" \"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-keyword)\"\n },\n children: \"\\\"name\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-punctuation)\"\n },\n children: \":\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" \"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-string-expression)\"\n },\n children: \"\\\"Bath\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-punctuation)\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" \"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-keyword)\"\n },\n children: \"\\\"description\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-punctuation)\"\n },\n children: \":\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" \"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-string-expression)\"\n },\n children: \"\\\"\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-punctuation)\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" \"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-keyword)\"\n },\n children: \"\\\"views\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-punctuation)\"\n },\n children: \":\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" \"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-constant)\"\n },\n children: \"0\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-punctuation)\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" \"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-keyword)\"\n },\n children: \"\\\"sort_order\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-punctuation)\"\n },\n children: \":\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" \"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-constant)\"\n },\n children: \"0\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-punctuation)\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" \"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-keyword)\"\n },\n children: \"\\\"page_title\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-punctuation)\"\n },\n children: \":\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" \"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-string-expression)\"\n },\n children: \"\\\"\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-punctuation)\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" \"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-keyword)\"\n },\n children: \"\\\"meta_keywords\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-punctuation)\"\n },\n children: \":\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" [\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" \"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-string-expression)\"\n },\n children: \"\\\"\\\"\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" ]\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-punctuation)\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" \"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-keyword)\"\n },\n children: \"\\\"meta_description\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-punctuation)\"\n },\n children: \":\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" \"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-string-expression)\"\n },\n children: \"\\\"\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-punctuation)\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" \"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-keyword)\"\n },\n children: \"\\\"layout_file\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-punctuation)\"\n },\n children: \":\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" \"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-string-expression)\"\n },\n children: \"\\\"category.html\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-punctuation)\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" \"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-keyword)\"\n },\n children: \"\\\"image_url\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-punctuation)\"\n },\n children: \":\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" \"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-string-expression)\"\n },\n children: \"\\\"\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-punctuation)\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" \"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-keyword)\"\n },\n children: \"\\\"is_visible\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-punctuation)\"\n },\n children: \":\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" \"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-constant)\"\n },\n children: \"true\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-punctuation)\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" \"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-keyword)\"\n },\n children: \"\\\"search_keywords\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-punctuation)\"\n },\n children: \":\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" \"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-string-expression)\"\n },\n children: \"\\\"\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-punctuation)\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" \"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-keyword)\"\n },\n children: \"\\\"default_product_sort\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-punctuation)\"\n },\n children: \":\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" \"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-string-expression)\"\n },\n children: \"\\\"use_store_settings\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-punctuation)\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" \"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-keyword)\"\n },\n children: \"\\\"custom_url\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-punctuation)\"\n },\n children: \":\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" {\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" \"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-keyword)\"\n },\n children: \"\\\"url\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-punctuation)\"\n },\n children: \":\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" \"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-string-expression)\"\n },\n children: \"\\\"/garden/bath/\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-punctuation)\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" \"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-keyword)\"\n },\n children: \"\\\"is_customized\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-punctuation)\"\n },\n children: \":\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" \"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-constant)\"\n },\n children: \"false\"\n })]\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" }\"\n })\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" }\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-punctuation)\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" \"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-keyword)\"\n },\n children: \"\\\"meta\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-token-punctuation)\"\n },\n children: \":\"\n }), _jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \" {}\"\n })]\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"var(--shiki-color-text)\"\n },\n children: \"}\"\n })\n })]\n })\n }), \"\\n\", _jsx(_components.h2, {\n id: \"support\",\n children: \"Support\"\n }), \"\\n\", _jsx(_components.h3, {\n id: \"developer-community\",\n children: \"Developer community\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"The \", _jsx(_components.a, {\n href: \"/community\",\n children: \"developer community\"\n }), \" is a great place to get help from other developers who work on the BigCommerce platform. If you have BigCommerce-specific questions, this online forum is the best place to ask. It's also an excellent place for beginners to get assistance.\"]\n }), \"\\n\", _jsx(_components.h3, {\n id: \"bigcommerce-at-stack-overflow\",\n children: \"BigCommerce at Stack Overflow\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Are you a more experienced developer or have a programming language-specific question? \", _jsx(_components.a, {\n href: \"https://stackoverflow.com/questions/tagged/bigcommerce\",\n children: \"Stack Overflow\"\n }), \" is a good place to ask questions and get help. The developer community is the best place to get answers about the BigCommerce platform.\"]\n }), \"\\n\", _jsx(_components.h3, {\n id: \"developer-release-notes\",\n children: \"Developer release notes\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Our \", _jsx(_components.a, {\n href: \"/release-notes\",\n children: \"release notes\"\n }), \" catalog notable updates made to the BigCommerce platform and to the documentation. You can find significant changes, such as new features, latest releases, and bug fixes.\"]\n }), \"\\n\", _jsx(_components.h2, {\n id: \"resources\",\n children: \"Resources\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: _jsx(_components.a, {\n href: \"/community\",\n children: \"Developer Community\"\n })\n }), \"\\n\", _jsx(_components.li, {\n children: _jsx(_components.a, {\n href: \"https://www.bigcommerce.com/terms/api-terms/\",\n children: \"Terms of Service\"\n })\n }), \"\\n\", _jsx(_components.li, {\n children: _jsx(_components.a, {\n href: \"https://stackoverflow.com/questions/tagged/bigcommerce\",\n children: \"BigCommerce on Stack Overflow\"\n })\n }), \"\\n\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = Object.assign({}, _provideComponents(), props.components);\n return MDXLayout ? _jsx(MDXLayout, Object.assign({}, props, {\n children: _jsx(_createMdxContent, props)\n })) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","__nextra_dynamic_opts":"{\"headings\":[{\"depth\":2,\"value\":\"Available APIs\",\"id\":\"available-apis\"},{\"depth\":3,\"value\":\"REST Store Management APIs\",\"id\":\"rest-store-management-apis\"},{\"depth\":3,\"value\":\"REST Storefront API\",\"id\":\"rest-storefront-api\"},{\"depth\":3,\"value\":\"GraphQL Storefront API\",\"id\":\"graphql-storefront-api\"},{\"depth\":3,\"value\":\"Customer Login API\",\"id\":\"customer-login-api\"},{\"depth\":3,\"value\":\"Current Customer API\",\"id\":\"current-customer-api\"},{\"depth\":2,\"value\":\"API authentication and context\",\"id\":\"api-authentication-and-context\"},{\"depth\":2,\"value\":\"Available store resources\",\"id\":\"available-store-resources\"},{\"depth\":2,\"value\":\"Anatomy of REST Store Management APIs\",\"id\":\"anatomy-of-rest-store-management-apis\"},{\"depth\":3,\"value\":\"Media types\",\"id\":\"media-types\"},{\"depth\":3,\"value\":\"Requests\",\"id\":\"requests\"},{\"depth\":4,\"value\":\"Standard request headers\",\"id\":\"standard-request-headers\"},{\"depth\":4,\"value\":\"BigCommerce-specific request headers\",\"id\":\"bigcommerce-specific-request-headers\"},{\"depth\":4,\"value\":\"Request content type\",\"id\":\"request-content-type\"},{\"depth\":4,\"value\":\"Request structure\",\"id\":\"request-structure\"},{\"depth\":3,\"value\":\"Responses\",\"id\":\"responses\"},{\"depth\":4,\"value\":\"Response headers\",\"id\":\"response-headers\"},{\"depth\":4,\"value\":\"Standard response headers\",\"id\":\"standard-response-headers\"},{\"depth\":4,\"value\":\"BigCommerce-specific response headers\",\"id\":\"bigcommerce-specific-response-headers\"},{\"depth\":4,\"value\":\"Response content type\",\"id\":\"response-content-type\"},{\"depth\":4,\"value\":\"Response structure\",\"id\":\"response-structure\"},{\"depth\":2,\"value\":\"Support\",\"id\":\"support\"},{\"depth\":3,\"value\":\"Developer community\",\"id\":\"developer-community\"},{\"depth\":3,\"value\":\"BigCommerce at Stack Overflow\",\"id\":\"bigcommerce-at-stack-overflow\"},{\"depth\":3,\"value\":\"Developer release notes\",\"id\":\"developer-release-notes\"},{\"depth\":2,\"value\":\"Resources\",\"id\":\"resources\"}],\"frontMatter\":{\"title\":\"About Our APIs\",\"keywords\":\"address, v2, v3, currency, currencies\"},\"title\":\"About Our APIs\"}"},"__N_SSG":true},"page":"/docs/start/about","query":{},"buildId":"mV98qIah21cAP72QIkfFU","isFallback":false,"isExperimentalCompile":false,"gsp":true,"scriptLoader":[]}</script></body></html>