HeadKit Engine connects everything through our single API. This can be used to power custom features and integrations for your store.
API Tokens
API tokens issued for your store connections will be displayed here automatically and can be revoked and re-issued as required. Add a custom token for connection to an external service.
⌘I
{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"HeadKit Commerce Documentation","description":"HeadKit is the cloud platform making it fast and easy to build headless commerce stores.","colors":{"primary":"#7F54B3","light":"#9572C0","dark":"#7F54B3"},"logo":{"light":"https://mintcdn.com/headkit/AdOGoeanXouZxizP/logo/HeadKit-Docs_Light.svg?fit=max\u0026auto=format\u0026n=AdOGoeanXouZxizP\u0026q=85\u0026s=39d142f0d6348b4528beb5910af39b58","dark":"https://mintcdn.com/headkit/AdOGoeanXouZxizP/logo/HeadKit-Docs_Dark.svg?fit=max\u0026auto=format\u0026n=AdOGoeanXouZxizP\u0026q=85\u0026s=139252f9afc0d2fe001d8683c9ddabcd","href":"https://docs.headkit.io"},"favicon":"/favicon.svg","appearance":{"default":"system"},"background":{"decoration":"gradient","color":{"dark":"#121212"}},"navbar":{"links":[{"href":"mailto:support@headkit.io","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://headkit.app"}},"footer":{"socials":{"discord":"https://discord.gg/bSNe29JtsX","github":"https://github.com/headkit-commerce","linkedin":"https://www.linkedin.com/company/headkit-commerce","youtube":"https://www.youtube.com/@headkit-commerce"},"links":[{"header":"Platform","items":[{"label":"HeadKit Storefront","href":"https://headkit.io/storefront"},{"label":"HeadKit Cloud","href":"https://headkit.io/cloud"},{"label":"HeadKit Engine","href":"https://headkit.io/engine"},{"label":"Headless Commerce","href":"https://headkit.io/headless-commerce"},{"label":"Pricing","href":"https://headkit.io/pricing"},{"label":"Book a Demo","href":"https://headkit.io/book-demo"}]},{"header":"Solutions","items":[{"label":"Headless WooCommerce","href":"https://headkit.io/headless-woocommerce"}]},{"header":"Developers","items":[{"label":"Documentation","href":"https://docs.headkit.io"},{"label":"Integrations","href":"https://headkit.io/integrations"},{"label":"Github","href":"https://github.com/headkit-commerce"},{"label":"Support","href":"https://headkit.io/support"}]},{"header":"Company","items":[{"label":"About","href":"https://headkit.io/about"},{"label":"Customer Stories","href":"https://headkit.io/customer-stories"},{"label":"Blog","href":"https://headkit.io/blog"},{"label":"FAQ","href":"https://headkit.io/faq"},{"label":"Contact","href":"https://headkit.io/contact"}]}]},"fonts":{"family":"Urbanist","weight":600},"icons":{"library":"fontawesome"},"styling":{"eyebrows":"breadcrumbs","latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"headkit","hasAudioNarration":false,"actualSubdomain":"headkit","customDomains":["docs.headkit.io"],"gitSource":{"type":"github","owner":"headkit-commerce","repo":"headkit-docs-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae921cbdef05aac016e4263:success","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"Documentation","count":14},{"language":"default","tag":"Connections","count":5},{"language":"default","tag":"API Reference","count":4},{"language":"default","tag":"Customisation","count":4},{"language":"default","tag":"Admin","count":3},{"language":"default","tag":"Endpoint Examples","count":3},{"language":"default","tag":"Get Started","count":2},{"language":"default","tag":"API Documentation","count":1}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":"#sidebar-content img[src*=\"HeadKit_Platform_HeadKit-Icon.svg\"],#sidebar img[src*=\"HeadKit_Platform_HeadKit-Icon.svg\"]{display:block;width:1.25rem;height:1.25rem;box-sizing:border-box;object-fit:none;object-position:-9999px -9999px;background-color:#71717a;-webkit-mask-image:url(\"/images/icons/HeadKit_Platform_HeadKit-Icon-mask.svg\");mask-image:url(\"/images/icons/HeadKit_Platform_HeadKit-Icon-mask.svg\");-webkit-mask-size:1.25rem 1.25rem;mask-size:1.25rem 1.25rem;-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;-webkit-mask-position:center;mask-position:center;opacity:0.92}html.dark #sidebar-content img[src*=\"HeadKit_Platform_HeadKit-Icon.svg\"],html.dark #sidebar img[src*=\"HeadKit_Platform_HeadKit-Icon.svg\"]{background-color:#a1a1aa;opacity:0.9}#sidebar-content li[data-active] img[src*=\"HeadKit_Platform_HeadKit-Icon.svg\"],#sidebar-content li[data-active=\"true\"] img[src*=\"HeadKit_Platform_HeadKit-Icon.svg\"],#sidebar-content a[aria-current=\"page\"] img[src*=\"HeadKit_Platform_HeadKit-Icon.svg\"],#sidebar-content li:has(>a[aria-current=\"page\"]) img[src*=\"HeadKit_Platform_HeadKit-Icon.svg\"],#sidebar-content li:has(a[aria-current=\"page\"]) img[src*=\"HeadKit_Platform_HeadKit-Icon.svg\"],#sidebar li[data-active] img[src*=\"HeadKit_Platform_HeadKit-Icon.svg\"],#sidebar a[aria-current=\"page\"] img[src*=\"HeadKit_Platform_HeadKit-Icon.svg\"],#sidebar li:has(a[aria-current=\"page\"]) img[src*=\"HeadKit_Platform_HeadKit-Icon.svg\"]{background-color:#7f54b3;opacity:1}html.dark #sidebar-content li[data-active] img[src*=\"HeadKit_Platform_HeadKit-Icon.svg\"],html.dark #sidebar-content li[data-active=\"true\"] img[src*=\"HeadKit_Platform_HeadKit-Icon.svg\"],html.dark #sidebar-content a[aria-current=\"page\"] img[src*=\"HeadKit_Platform_HeadKit-Icon.svg\"],html.dark #sidebar-content li:has(>a[aria-current=\"page\"]) img[src*=\"HeadKit_Platform_HeadKit-Icon.svg\"],html.dark #sidebar-content li:has(a[aria-current=\"page\"]) img[src*=\"HeadKit_Platform_HeadKit-Icon.svg\"],html.dark #sidebar li[data-active] img[src*=\"HeadKit_Platform_HeadKit-Icon.svg\"],html.dark #sidebar a[aria-current=\"page\"] img[src*=\"HeadKit_Platform_HeadKit-Icon.svg\"],html.dark #sidebar li:has(a[aria-current=\"page\"]) img[src*=\"HeadKit_Platform_HeadKit-Icon.svg\"]{background-color:#9572c0;opacity:1}[data-component-part=\"accordion-button\"]{align-items:center}[data-component-part=\"accordion-icon\"]{display:grid!important;place-items:center;line-height:0;width:auto!important;min-width:1rem!important;max-width:2.875rem!important;height:1rem!important;flex-shrink:0;box-sizing:border-box;padding:0!important}[data-component-part=\"accordion-icon\"] svg[data-component-part=\"icon-svg\"]{display:block;margin:0;vertical-align:0;max-width:100%;max-height:100%}.accordion-group img[src*=\"HeadKit_Integration_WooCommerce.svg\"],details.accordion img[src*=\"HeadKit_Integration_WooCommerce.svg\"]{display:block;width:100%!important;height:1rem!important;max-height:1rem!important;box-sizing:border-box;object-fit:none;object-position:-9999px -9999px;background-color:#292524!important;filter:none;-webkit-mask-image:url(\"/images/icons/HeadKit_Integration_WooCommerce-mask.svg\");mask-image:url(\"/images/icons/HeadKit_Integration_WooCommerce-mask.svg\");-webkit-mask-size:contain;mask-size:contain;-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;-webkit-mask-position:center;mask-position:center}html.dark .accordion-group img[src*=\"HeadKit_Integration_WooCommerce.svg\"],html.dark details.accordion img[src*=\"HeadKit_Integration_WooCommerce.svg\"],html[data-theme=\"dark\"] .accordion-group img[src*=\"HeadKit_Integration_WooCommerce.svg\"],html[data-theme=\"dark\"] details.accordion img[src*=\"HeadKit_Integration_WooCommerce.svg\"],.dark .accordion-group img[src*=\"HeadKit_Integration_WooCommerce.svg\"],.dark details.accordion img[src*=\"HeadKit_Integration_WooCommerce.svg\"]{background-color:#f5f5f4!important}@media (prefers-color-scheme: dark){html:not(.light):not([data-theme=\"light\"]) .accordion-group img[src*=\"HeadKit_Integration_WooCommerce.svg\"],html:not(.light):not([data-theme=\"light\"]) details.accordion img[src*=\"HeadKit_Integration_WooCommerce.svg\"]{background-color:#f5f5f4!important}}.accordion-group img[src*=\"HeadKit_Integration_Stripe.svg\"],details.accordion img[src*=\"HeadKit_Integration_Stripe.svg\"]{display:block;width:100%!important;height:1rem!important;max-height:1rem!important;box-sizing:border-box;object-fit:none;object-position:-9999px -9999px;background-color:#292524!important;filter:none;-webkit-mask-image:url(\"/images/icons/HeadKit_Integration_Stripe-mask.svg\");mask-image:url(\"/images/icons/HeadKit_Integration_Stripe-mask.svg\");-webkit-mask-size:contain;mask-size:contain;-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;-webkit-mask-position:center;mask-position:center}html.dark .accordion-group img[src*=\"HeadKit_Integration_Stripe.svg\"],html.dark details.accordion img[src*=\"HeadKit_Integration_Stripe.svg\"],html[data-theme=\"dark\"] .accordion-group img[src*=\"HeadKit_Integration_Stripe.svg\"],html[data-theme=\"dark\"] details.accordion img[src*=\"HeadKit_Integration_Stripe.svg\"],.dark .accordion-group img[src*=\"HeadKit_Integration_Stripe.svg\"],.dark details.accordion img[src*=\"HeadKit_Integration_Stripe.svg\"]{background-color:#f5f5f4!important}@media (prefers-color-scheme: dark){html:not(.light):not([data-theme=\"light\"]) .accordion-group img[src*=\"HeadKit_Integration_Stripe.svg\"],html:not(.light):not([data-theme=\"light\"]) details.accordion img[src*=\"HeadKit_Integration_Stripe.svg\"]{background-color:#f5f5f4!important}}"}],"page":{"pagePath":"customisation/api","slug":"/customisation/api","pageMetadata":{"title":"API","description":"HeadKit Engine connects everything through our single API. This can be used to power custom features and integrations for your store.","icon":"key","href":"/customisation/api"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"HeadKit Engine connects everything through our single API. This can be used to power custom features and integrations for your store.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,..._provideComponents(),...props.components},{Heading,OptimizedImage}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!OptimizedImage)_missingMdxReference(`OptimizedImage`,true);return _jsxs(_Fragment,{children:[_jsx(OptimizedImage,{className:`mint-block dark:mint-hidden`,src:`https://mintcdn.com/headkit/AdOGoeanXouZxizP/images/HeadKit_Docs_API-Light.svg?fit=max\u0026auto=format\u0026n=AdOGoeanXouZxizP\u0026q=85\u0026s=4b11e7e297184b67b23aed392980e1b8`,alt:`HeadKit Commerce Cloud Customisation API`,title:`Customisation | API`,\"data-og-width\":`1184`,width:`1184`,\"data-og-height\":`320`,height:`320`,\"data-path\":`images/HeadKit_Docs_API-Light.svg`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/headkit/AdOGoeanXouZxizP/images/HeadKit_Docs_API-Light.svg?w=280\u0026fit=max\u0026auto=format\u0026n=AdOGoeanXouZxizP\u0026q=85\u0026s=805f577cd657284b1472999f3826d905 280w, https://mintcdn.com/headkit/AdOGoeanXouZxizP/images/HeadKit_Docs_API-Light.svg?w=560\u0026fit=max\u0026auto=format\u0026n=AdOGoeanXouZxizP\u0026q=85\u0026s=71c85ff125ff118f2ed1245d8eebec00 560w, https://mintcdn.com/headkit/AdOGoeanXouZxizP/images/HeadKit_Docs_API-Light.svg?w=840\u0026fit=max\u0026auto=format\u0026n=AdOGoeanXouZxizP\u0026q=85\u0026s=4aac1884f1b1d08a1579e3629268b72e 840w, https://mintcdn.com/headkit/AdOGoeanXouZxizP/images/HeadKit_Docs_API-Light.svg?w=1100\u0026fit=max\u0026auto=format\u0026n=AdOGoeanXouZxizP\u0026q=85\u0026s=4ec1974a5f11fd8b4a2b6764a80efccf 1100w, https://mintcdn.com/headkit/AdOGoeanXouZxizP/images/HeadKit_Docs_API-Light.svg?w=1650\u0026fit=max\u0026auto=format\u0026n=AdOGoeanXouZxizP\u0026q=85\u0026s=25273498c3081c58922280e318af14b6 1650w, https://mintcdn.com/headkit/AdOGoeanXouZxizP/images/HeadKit_Docs_API-Light.svg?w=2500\u0026fit=max\u0026auto=format\u0026n=AdOGoeanXouZxizP\u0026q=85\u0026s=6ff8312ec795b3fc4d2f815cf1c0014a 2500w`}),`\n`,_jsx(OptimizedImage,{className:`mint-hidden dark:mint-block`,src:`https://mintcdn.com/headkit/AdOGoeanXouZxizP/images/HeadKit_Docs_API-Dark.svg?fit=max\u0026auto=format\u0026n=AdOGoeanXouZxizP\u0026q=85\u0026s=73efaa22f21eff73d0474c87d167b4b4`,alt:`HeadKit Commerce Cloud Customisation API`,title:`Customisation | API`,\"data-og-width\":`1184`,width:`1184`,\"data-og-height\":`320`,height:`320`,\"data-path\":`images/HeadKit_Docs_API-Dark.svg`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/headkit/AdOGoeanXouZxizP/images/HeadKit_Docs_API-Dark.svg?w=280\u0026fit=max\u0026auto=format\u0026n=AdOGoeanXouZxizP\u0026q=85\u0026s=e5998077ceafe1a9f31b591ac6213664 280w, https://mintcdn.com/headkit/AdOGoeanXouZxizP/images/HeadKit_Docs_API-Dark.svg?w=560\u0026fit=max\u0026auto=format\u0026n=AdOGoeanXouZxizP\u0026q=85\u0026s=48821c7ddbe33bba46573c5193907ba8 560w, https://mintcdn.com/headkit/AdOGoeanXouZxizP/images/HeadKit_Docs_API-Dark.svg?w=840\u0026fit=max\u0026auto=format\u0026n=AdOGoeanXouZxizP\u0026q=85\u0026s=272814208c41301cbadd4985c5a8ec84 840w, https://mintcdn.com/headkit/AdOGoeanXouZxizP/images/HeadKit_Docs_API-Dark.svg?w=1100\u0026fit=max\u0026auto=format\u0026n=AdOGoeanXouZxizP\u0026q=85\u0026s=74e84bd76f3349d56ff4abd5a54219c2 1100w, https://mintcdn.com/headkit/AdOGoeanXouZxizP/images/HeadKit_Docs_API-Dark.svg?w=1650\u0026fit=max\u0026auto=format\u0026n=AdOGoeanXouZxizP\u0026q=85\u0026s=abfb74085613798972b2475ad594774c 1650w, https://mintcdn.com/headkit/AdOGoeanXouZxizP/images/HeadKit_Docs_API-Dark.svg?w=2500\u0026fit=max\u0026auto=format\u0026n=AdOGoeanXouZxizP\u0026q=85\u0026s=acaf3c1c4aa3247394446a2e7452070a 2500w`}),`\n`,_jsx(Heading,{level:`2`,id:`api-tokens`,children:`API Tokens`}),`\n`,_jsx(_components.p,{children:`API tokens issued for your store connections will be displayed here automatically and can be revoked and re-issued as required. Add a custom token for connection to an external service.`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"API","description":"HeadKit Engine connects everything through our single API. This can be used to power custom features and integrations for your store.","icon":"key","href":"/customisation/api"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"API Tokens","slug":"api-tokens","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"dynamicCss":".mint-block {\n display: block\n}\n.mint-hidden {\n display: none\n}\n.dark\\:mint-block:is(.dark *) {\n display: block\n}\n.dark\\:mint-hidden:is(.dark *) {\n display: none\n}","subdomain":"headkit","siteName":"HeadKit Commerce Documentation","title":"API - HeadKit Commerce Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-03-17T14:35:01.000Z","originalFileLocation":"customisation/api.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"HeadKit Engine connects everything through our single API. This can be used to power custom features and integrations for your store.\">\u003cmeta data-mint-head name=\"application-name\" content=\"HeadKit Commerce Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/headkit/3FY4Yrm-35d_vncE/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/headkit/3FY4Yrm-35d_vncE/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/headkit/3FY4Yrm-35d_vncE/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/headkit/3FY4Yrm-35d_vncE/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/headkit/3FY4Yrm-35d_vncE/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/headkit/3FY4Yrm-35d_vncE/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/headkit/3FY4Yrm-35d_vncE/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/headkit/3FY4Yrm-35d_vncE/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/headkit/3FY4Yrm-35d_vncE/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"API - HeadKit Commerce Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"HeadKit Engine connects everything through our single API. This can be used to power custom features and integrations for your store.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"HeadKit Commerce Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.headkit.io/customisation/api\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://headkit.mintlify.site/_mintlify/api/og/v2?division=Customisation\u0026amp;title=API\u0026amp;description=HeadKit+Engine+connects+everything+through+our+single+API.+This+can+be+used+to+power+custom+features+and+integrations+for+your+store.\u0026amp;theme=583c55edd31d7c20b9406c5c\u0026amp;signature=eea4918ad7338645dd1e3249a458074384ea1bfdd0083cb7876cbfa5316c2405\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"API - HeadKit Commerce Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"HeadKit Engine connects everything through our single API. This can be used to power custom features and integrations for your store.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://headkit.mintlify.site/_mintlify/api/og/v2?division=Customisation\u0026amp;title=API\u0026amp;description=HeadKit+Engine+connects+everything+through+our+single+API.+This+can+be+used+to+power+custom+features+and+integrations+for+your+store.\u0026amp;theme=583c55edd31d7c20b9406c5c\u0026amp;signature=eea4918ad7338645dd1e3249a458074384ea1bfdd0083cb7876cbfa5316c2405\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/headkit/3FY4Yrm-35d_vncE/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"HeadKit Commerce Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#7F54B3\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.headkit.io/customisation/api\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/customisation/api.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.headkit.io/#organization\",\"name\":\"HeadKit Commerce Documentation\",\"url\":\"https://docs.headkit.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/headkit/AdOGoeanXouZxizP/logo/HeadKit-Docs_Light.svg?fit=max\u0026auto=format\u0026n=AdOGoeanXouZxizP\u0026q=85\u0026s=39d142f0d6348b4528beb5910af39b58\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.headkit.io#website\",\"name\":\"HeadKit Commerce Documentation\",\"url\":\"https://docs.headkit.io\",\"publisher\":{\"@id\":\"https://docs.headkit.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.headkit.io/customisation/api#webpage\",\"url\":\"https://docs.headkit.io/customisation/api\",\"name\":\"API\",\"description\":\"HeadKit Engine connects everything through our single API. This can be used to power custom features and integrations for your store.\",\"dateModified\":\"2026-03-17T14:35:01.000Z\",\"isPartOf\":{\"@id\":\"https://docs.headkit.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.headkit.io/customisation/api#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.headkit.io/customisation/api#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Customisation\",\"item\":\"https://docs.headkit.io/customisation/branding\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API\",\"item\":\"https://docs.headkit.io/customisation/api\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.headkit.io/customisation/api#article\",\"headline\":\"API\",\"name\":\"API\",\"description\":\"HeadKit Engine connects everything through our single API. This can be used to power custom features and integrations for your store.\",\"url\":\"https://docs.headkit.io/customisation/api\",\"mainEntityOfPage\":{\"@id\":\"https://docs.headkit.io/customisation/api#webpage\"},\"dateModified\":\"2026-03-17T14:35:01.000Z\",\"publisher\":{\"@id\":\"https://docs.headkit.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.headkit.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"HeadKit Commerce Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"HeadKit Commerce Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/customisation/api.md","siteName":"HeadKit Commerce Documentation","nav":{"global":null,"tabs":[{"tab":"Documentation","groups":[{"group":"Get Started","pages":[{"title":"Introduction","mode":"frame","icon":"https://mintlify.s3.us-west-1.amazonaws.com/headkit/images/icons/HeadKit_Platform_HeadKit-Icon.svg","href":"/introduction"},{"title":"Quickstart","icon":"rocket","href":"/quickstart"}]},{"group":"Connections","pages":[{"title":"Repository","icon":"folder-closed","href":"/connections/repository"},{"title":"Framework","icon":"rectangles-mixed","href":"/connections/framework"},{"title":"Commerce","icon":"bag-shopping","href":"/connections/commerce"},{"title":"Content","icon":"files","href":"/connections/content"},{"title":"Payments","icon":"circle-dollar","href":"/connections/payments"}]},{"group":"Customisation","pages":[{"title":"Branding","icon":"swatchbook","href":"/customisation/branding"},{"title":"SEO","icon":"magnifying-glass","href":"/customisation/seo"},{"title":"Email","description":"HeadKit Cloud enables you to easily connect email services for Transactional and Marketing emails.","icon":"envelope","href":"/customisation/email"},{"title":"API","icon":"key","href":"/customisation/api"}]},{"group":"Admin","pages":[{"title":"Analytics","description":"See detailed data on your traffic, usage, performance and commerce wins.","icon":"chart-column","href":"/admin/analytics"},{"title":"Plan \u0026 Billing","icon":"credit-card","href":"/admin/plan-billing"},{"title":"Store Settings","icon":"gear","href":"/admin/store-settings"}]}]},{"tab":"Guides"},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/introduction"}]},{"tab":"Changelog"}]},"basePath":"","title":"API - HeadKit Commerce Documentation","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["a74be98ba7"],"chunks":["zoom-image-lightbox-BbK2OBGL.js","lightbox-handle-r17bVUz3.js"]}