{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"Spree Commerce documentation","colors":{"primary":"#0077ff","light":"#4d9fff","dark":"#0060ce"},"logo":{"light":"https://mintcdn.com/spreecommerce/LxcAXa2TB_svesfi/logo/logo_light.png?fit=max\u0026auto=format\u0026n=LxcAXa2TB_svesfi\u0026q=85\u0026s=fccc5873d5c7a3eeb4e644f96d694ba9","dark":"https://mintcdn.com/spreecommerce/LxcAXa2TB_svesfi/logo/logo_dark.png?fit=max\u0026auto=format\u0026n=LxcAXa2TB_svesfi\u0026q=85\u0026s=3aeefb84d53af450ad04b7283e4d661b"},"favicon":"https://mintcdn.com/spreecommerce/OgdQHBPQ0RbaKyDN/favicon.png?fit=max\u0026auto=format\u0026n=OgdQHBPQ0RbaKyDN\u0026q=85\u0026s=dc14ac5e60560349252428b1dde69c74","api":{"openapi":["api-reference/store.yaml","api-reference/storefront.yaml","api-reference/platform.yaml"],"examples":{"languages":["javascript","curl"]},"mdx":{"server":["http://localhost:3000"]}},"navbar":{"links":[{"icon":{"name":"github","library":"lucide"},"href":"https://github.com/spree/spree","label":"16k"},{"icon":{"name":"discord","library":"lucide"},"href":"https://discord.spreecommerce.org","label":"Join Discord"}]},"footer":{"socials":{"github":"https://github.com/spree/spree","x":"https://x.com/spreecommerce"}},"seo":{"metatags":{"og:locale":"en_US","twitter:site":"@spreecommerce"}},"fonts":{"heading":{"family":"Geist"},"body":{"family":"Geist"}},"icons":{"library":"lucide"},"styling":{"eyebrows":"breadcrumbs","codeblocks":{"theme":"night-owl"},"latex":true},"integrations":{"ga4":{"measurementId":"G-NCVLCVHL5Y"}},"contextual":{"options":["copy","view","chatgpt","claude","mcp","cursor","vscode"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"spreecommerce","hasAudioNarration":false,"actualSubdomain":"spreecommerce","customDomains":["spreecommerce.org"],"gitSource":{"type":"github","owner":"spree","repo":"spree","deployBranch":"main","contentDirectory":"docs","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adfbbe8e55c0c9c0ccda2a6","collectionId":"609e6f33-0e32-4480-b257-6ef8b8e4ddf2","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adfbbe8e55c0c9c0ccda2a6"},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6adfbbe8e55c0c9c0ccda2a6","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"API Reference","count":1119},{"language":"default","tag":"Endpoints","count":784},{"language":"default","tag":"Admin API","count":544},{"language":"default","tag":"Legacy API v2","count":313},{"language":"default","tag":"Platform API","count":231},{"language":"default","tag":"Documentation","count":171},{"language":"default","tag":"Develop","count":171},{"language":"default","tag":"User Guide","count":153},{"language":"default","tag":"Seller API","count":138},{"language":"default","tag":"Store API","count":129}]},"assistantConfig":{"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"deflection":{"enabled":true,"email":"hello@spreecommerce.org","showHelpButton":true}},"basePath":"/docs","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","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":"editor-v7-file-tree","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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":":root{--spree-accent:#0077ff;--spree-accent-strong:#0060ce;--spree-sand-50:#fcfaf7;--spree-sand-100:#f7f5f2;--spree-sand-150:#e9e5dd;--spree-sand-200:#e2dfd8;--spree-dark-sand-500:#32302e;--spree-dark-sand-600:#272626;--spree-dark-sand-700:#1e1c1b;--spree-dark-sand-800:#191818;--spree-neutral-100:#eaeaea;--spree-neutral-200:#d5d5d5;--spree-neutral-400:#999999;--spree-neutral-600:#666666;--spree-neutral-700:#4d4d4d;--spree-neutral-900:#1a1a1a;--spree-ink:#1a1a1a;--spree-heading:#061932;--spree-ink-muted:#666666;--spree-border:#e2dfd8;--spree-sidebar-hover:rgb(0 0 0 / 0.04);--spree-sidebar-active:rgb(0 0 0 / 0.06);--spree-sidebar-radius:0.625rem;--spree-guide:#d8d4cb}.dark{--spree-sidebar-hover:rgb(255 255 255 / 0.06);--spree-sidebar-active:rgb(255 255 255 / 0.10);--spree-border:#3f3e3c;--spree-guide:#3f3e3c}html:not(.dark) body{background:var(--spree-sand-50)}html.dark body{background:var(--spree-dark-sand-800)}html:not(.dark) h1,html:not(.dark) h2,html:not(.dark) h3,html:not(.dark) h4{color:var(--spree-heading)}.nav-logo{height:32px}#sidebar-content .sidebar-group-header{display:none}#sidebar-content a,#sidebar-content button:not([class*=\"group/search\"]){border-radius:var(--spree-sidebar-radius)!important;padding-top:.3125rem!important;padding-bottom:.3125rem!important}#sidebar-content ul.sidebar-group>li>a,#sidebar-content ul.sidebar-group>li>button{font-weight:500;padding-top:.5rem!important;padding-bottom:.5rem!important}#sidebar-content ul.sidebar-group>li+li{margin-top:.25rem}#sidebar-content li[data-group-tag]>ul{margin-top:.125rem;margin-bottom:.375rem;position:relative}#sidebar-content a:hover,#sidebar-content button:not([class*=\"group/search\"]):hover{background-color:var(--spree-sidebar-hover)!important}#sidebar-content li[data-group-tag][data-active=true]>a,#sidebar-content li[data-group-tag][data-active=true]>button{background-color:var(--spree-sidebar-active)!important;color:var(--spree-neutral-900)!important;font-weight:600!important}.dark #sidebar-content a[class*=\"bg-primary-light/10\"],.dark #sidebar-content a[class*=\"bg-primary/10\"],.dark #sidebar-content li[data-group-tag][data-active=true]>a,.dark #sidebar-content li[data-group-tag][data-active=true]>button{color:#fff!important}#sidebar-content a[class*=\"bg-primary-light/10\"],#sidebar-content a[class*=\"bg-primary/10\"]{background-color:transparent!important;color:var(--spree-neutral-900)!important;font-weight:600!important;text-shadow:none!important}#sidebar-content a[class*=\"bg-primary-light/10\"]:hover,#sidebar-content a[class*=\"bg-primary/10\"]:hover{background-color:var(--spree-sidebar-hover)!important}#sidebar-content ul:not(.sidebar-group)>li>a,#sidebar-content ul:not(.sidebar-group)>li>button{padding-left:.5rem!important;margin-left:2.25rem;margin-right:.25rem;width:calc(100% - 2.5rem)!important}#sidebar-content ul:not(.sidebar-group) ul:not(.sidebar-group)>li>a,#sidebar-content ul:not(.sidebar-group) ul:not(.sidebar-group)>li>button{padding-left:.5rem!important;margin-left:3.75rem;width:calc(100% - 4rem)!important}#sidebar-content li[data-group-tag]>ul::before{content:\"\";position:absolute;left:1.75rem;top:0;bottom:0;width:1px;background-color:var(--spree-guide)}#sidebar-content li[data-group-tag] li[data-group-tag]>ul::before{left:3.25rem}#sidebar-content a svg[class*=bg-gray-],#sidebar-content button svg[class*=bg-gray-]{background-color:currentColor!important;opacity:.6}#sidebar-content a:hover svg[class*=bg-gray-],#sidebar-content button:hover svg[class*=bg-gray-],#sidebar-content li[data-group-tag][data-active=true]>button svg[class*=bg-gray-]{opacity:1}#content-container{border-color:var(--spree-border)!important}.dark #content-container{border-color:#3f3e3c!important}@media (min-width:1024px){#content-container{padding-left:3rem!important;padding-right:3rem!important}#content-container>.flex.flex-row-reverse{padding-left:0!important;column-gap:2.5rem!important}}#content-container .flex.flex-row-reverse>.max-w-xl{max-width:52rem}#almond-background-color{background-color:transparent!important}#navbar{background-color:var(--spree-sand-50)}.dark #navbar{background-color:var(--spree-dark-sand-800)}#navbar.is-custom{border-bottom:1px solid var(--spree-border)}.dark #navbar.is-custom{border-bottom-color:#3f3e3c}#navbar>.absolute.inset-0{display:none}.home-band{background:#fff}.dark .home-band{background:var(--spree-dark-sand-700)}.home-band-end{border-bottom:1px solid rgb(233 229 221/.8)}.dark .home-band-end{border-bottom-color:#3f3e3c}#content-container .link{border-bottom:0!important;color:var(--spree-accent)!important;text-decoration:none!important}#content-container .link:hover{color:var(--spree-accent-strong)!important}.dark #content-container .link{color:#4d9fff!important}.dark #content-container .link:hover{color:#7fb8ff!important}:has(>.changelog-header){max-width:56rem;margin:0 auto;padding:4rem 1.25rem 6rem}.changelog-header h1{font-size:2.25rem;font-weight:600;letter-spacing:-.02em;margin-bottom:.75rem}.changelog-header>[data-as=p],.changelog-header>p{color:var(--spree-ink-muted);font-size:1.0625rem;margin-bottom:1.25rem}.changelog-header .changelog-rss{display:inline-flex;align-items:center;gap:.5rem;margin-bottom:3.5rem;padding:.375rem .875rem;border:1px solid var(--spree-border);border-radius:9999px;font-size:.875rem;font-weight:500;text-decoration:none}.changelog-header .changelog-rss:hover{border-color:var(--spree-accent)}:has(>.changelog-header) [data-as=p],:has(>.changelog-header) p{display:block!important;margin:0 0 1rem;line-height:1.7}:has(>.changelog-header) ul{list-style:disc;padding-left:1.25rem;margin:0 0 1rem}:has(>.changelog-header) li{margin:.25rem 0;line-height:1.65}:has(>.changelog-header) li::marker{color:var(--spree-neutral-400)}:has(>.changelog-header) a{color:var(--spree-accent)}:has(>.changelog-header) a:hover{color:var(--spree-accent-strong)}.dark :has(>.changelog-header) a{color:#4d9fff}table{border:1px solid #d0d7de!important;border-radius:.5rem!important;border-collapse:separate!important;border-spacing:0!important;overflow:hidden!important;width:100%}table thead{background-color:#f3f4f6!important}table th{font-weight:500!important;text-align:left;color:#4b5563!important;padding:.625rem .875rem!important;border-bottom:1px solid #d0d7de!important}table td+td,table th+th{border-left:1px solid #e8ebee!important}table td{padding:.75rem .875rem!important;border-bottom:1px solid #e8ebee!important;vertical-align:middle}table tbody tr:last-child td{border-bottom:0!important}.dark table{border-color:#3d444d!important}.dark table thead{background-color:#21262d!important}.dark table th{color:#9198a1!important;border-bottom-color:#3d444d!important}.dark table td+td,.dark table th+th{border-left-color:#2a3038!important}.dark table td{border-bottom-color:#2a3038!important}"}],"page":{"pagePath":"api-reference/admin-api/authentication/logout","slug":"/api-reference/admin-api/authentication/logout","pageMetadata":{"title":"Logout","description":"Revokes the refresh-token cookie, effectively logging the admin out.","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/auth/logout","href":"/api-reference/admin-api/authentication/logout","autogeneratedByOpenApi":true},"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: \"Revokes the refresh-token cookie, effectively logging the admin out.\"\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}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":{"theme":"night-owl"},"config":{},"pageMetadata":{"title":"Logout","description":"Revokes the refresh-token cookie, effectively logging the admin out.","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/auth/logout","href":"/api-reference/admin-api/authentication/logout","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Logout","tags":["Authentication"],"security":["e74c2ff4-835d-4330-bd80-d78daf32350f"],"description":"Revokes the refresh-token cookie, effectively logging the admin out.","x-codeSamples":[{"lang":"javascript","label":"Spree Admin SDK","source":"import { createAdminClient } from '@spree/admin-sdk'\n\nconst client = createAdminClient({\n baseUrl: 'https://your-store.com',\n secretKey: 'sk_xxx',\n})\n\nawait client.auth.logout()"},{"lang":"bash","label":"Spree CLI","source":"spree api post /auth/logout"}],"parameters":["7e391380-57fd-4f54-b77b-ae042e80964c"],"responses":{"204":"bffe406d-df7b-4862-baa7-d45a80ac61c1"},"method":"post","type":"path","servers":["95eb5356-0693-4413-b231-81f5ed5d9c90"],"path":"/api/v3/admin/auth/logout","baseUrlOptions":["http://{defaultHost}"],"title":"Logout","codeSamples":[{"label":"Spree Admin SDK","lang":"javascript","source":"import { createAdminClient } from '@spree/admin-sdk'\n\nconst client = createAdminClient({\n baseUrl: 'https://your-store.com',\n secretKey: 'sk_xxx',\n})\n\nawait client.auth.logout()"},{"label":"Spree CLI","lang":"bash","source":"spree api post /auth/logout"}],"requestExampleLanguages":["javascript","bash"],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"7e391380-57fd-4f54-b77b-ae042e80964c":{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"bffe406d-df7b-4862-baa7-d45a80ac61c1":{"description":"logout successful","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"e74c2ff4-835d-4330-bd80-d78daf32350f":{"api_key":{"type":"apiKey","name":"x-spree-api-key","in":"header","description":"Secret API key for admin access","scopes":[],"schemeName":"api_key"}}},"servers":{"95eb5356-0693-4413-b231-81f5ed5d9c90":{"url":"http://{defaultHost}","variables":{"defaultHost":{"default":"localhost:3000"}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","name":"x-spree-api-key","in":"header","description":"Secret API key for admin access","scopes":[],"schemeName":"api_key"},"schema":{"title":"x-spree-api-key","type":"string","description":"Secret API key for admin access","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"api_key","name":"x-spree-api-key"}],"title":"api_key"}]},"originalFileLocation":"api-reference/admin.yaml"},"subdomain":"spreecommerce","siteName":"Spree Commerce documentation","title":"Logout - Spree Commerce documentation","navMaps":{"firstHrefInVersion":{"v6.x":{"href":"/api-reference/admin-api/authentication/logout","matchLevel":0},"v5.x":{"href":"/api-reference/admin-api/authentication/logout","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-10-26T20:46:30.262Z","originalFileLocation":"api-reference/admin-api/authentication/logout.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=\"Revokes the refresh-token cookie, effectively logging the admin out.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Spree Commerce documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/spreecommerce/jEa7SqO24dLQoV2O/_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=\"/docs/mintlify-assets/_mintlify/favicons/spreecommerce/jEa7SqO24dLQoV2O/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/spreecommerce/jEa7SqO24dLQoV2O/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/spreecommerce/jEa7SqO24dLQoV2O/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/spreecommerce/jEa7SqO24dLQoV2O/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/spreecommerce/jEa7SqO24dLQoV2O/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/spreecommerce/jEa7SqO24dLQoV2O/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/spreecommerce/jEa7SqO24dLQoV2O/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/spreecommerce/jEa7SqO24dLQoV2O/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Logout - Spree Commerce documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Revokes the refresh-token cookie, effectively logging the admin out.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Spree Commerce documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://spreecommerce.org/docs/api-reference/admin-api/authentication/logout\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://spreecommerce.mintlify.app/_mintlify/api/og/v2?division=Authentication\u0026amp;title=Logout\u0026amp;description=Revokes+the+refresh-token+cookie%2C+effectively+logging+the+admin+out.\u0026amp;theme=69587fd3cce8800216628a20\u0026amp;signature=59cff146151ba5c5f416711d8f3b8bc556ca288553bb74c9a8ffb9705739ff60\">\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=\"Logout - Spree Commerce documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Revokes the refresh-token cookie, effectively logging the admin out.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://spreecommerce.mintlify.app/_mintlify/api/og/v2?division=Authentication\u0026amp;title=Logout\u0026amp;description=Revokes+the+refresh-token+cookie%2C+effectively+logging+the+admin+out.\u0026amp;theme=69587fd3cce8800216628a20\u0026amp;signature=59cff146151ba5c5f416711d8f3b8bc556ca288553bb74c9a8ffb9705739ff60\">\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=\"/docs/mintlify-assets/_mintlify/favicons/spreecommerce/jEa7SqO24dLQoV2O/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Spree Commerce documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0077ff\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003clink data-mint-head rel=\"canonical\" href=\"https://spreecommerce.org/docs/api-reference/admin-api/authentication/logout\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/admin-api/authentication/logout.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://spreecommerce.org/#organization\",\"name\":\"Spree Commerce documentation\",\"url\":\"https://spreecommerce.org\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/spreecommerce/LxcAXa2TB_svesfi/logo/logo_light.png?fit=max\u0026auto=format\u0026n=LxcAXa2TB_svesfi\u0026q=85\u0026s=fccc5873d5c7a3eeb4e644f96d694ba9\"}},{\"@type\":\"WebSite\",\"@id\":\"https://spreecommerce.org/docs#website\",\"name\":\"Spree Commerce documentation\",\"url\":\"https://spreecommerce.org/docs\",\"publisher\":{\"@id\":\"https://spreecommerce.org/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://spreecommerce.org/docs/api-reference/admin-api/authentication/logout#webpage\",\"url\":\"https://spreecommerce.org/docs/api-reference/admin-api/authentication/logout\",\"name\":\"Logout\",\"description\":\"Revokes the refresh-token cookie, effectively logging the admin out.\",\"dateModified\":\"2026-10-26T20:46:30.262Z\",\"isPartOf\":{\"@id\":\"https://spreecommerce.org/docs#website\"},\"breadcrumb\":{\"@id\":\"https://spreecommerce.org/docs/api-reference/admin-api/authentication/logout#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://spreecommerce.org/docs/api-reference/admin-api/authentication/logout#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://spreecommerce.org/docs/api-reference/admin-api/authentication/login\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Authentication\",\"item\":\"https://spreecommerce.org/docs/api-reference/admin-api/authentication/login\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Logout\",\"item\":\"https://spreecommerce.org/docs/api-reference/admin-api/authentication/logout\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://spreecommerce.org/docs/api-reference/admin-api/authentication/logout#apireference\",\"headline\":\"Logout\",\"name\":\"Logout\",\"description\":\"Revokes the refresh-token cookie, effectively logging the admin out.\",\"url\":\"https://spreecommerce.org/docs/api-reference/admin-api/authentication/logout\",\"mainEntityOfPage\":{\"@id\":\"https://spreecommerce.org/docs/api-reference/admin-api/authentication/logout#webpage\"},\"dateModified\":\"2026-10-26T20:46:30.262Z\",\"publisher\":{\"@id\":\"https://spreecommerce.org/#organization\"},\"isPartOf\":{\"@id\":\"https://spreecommerce.org/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Spree Commerce documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Spree Commerce documentation","nav":{"global":null,"versions":[{"version":"v6.x","default":true,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/developer/getting-started/quickstart"}]},{"tab":"API Reference","menu":[{"item":"Store API","icon":"store","description":"REST API for storefronts and custom integrations","pages":[{"title":"Store API","href":"/api-reference/store-api/introduction"}]},{"item":"Admin API","icon":"shield","description":"REST API for pragmatically managing stores","groups":[{"group":"API basics","pages":[{"title":"Spree Admin API introduction and SDK quick start","sidebarTitle":"Introduction","href":"/api-reference/admin-api/introduction"},{"title":"Authenticate Admin API requests with keys and JWTs","sidebarTitle":"Authentication","href":"/api-reference/admin-api/authentication"},{"title":"Admin API error responses, status codes, and handling","href":"/api-reference/admin-api/errors"},{"title":"Filter, sort, paginate, and expand Admin API responses","sidebarTitle":"Querying","href":"/api-reference/admin-api/querying"},{"title":"Monetary amounts in the Admin API: prices, costs, formats","sidebarTitle":"Monetary Amounts","href":"/api-reference/admin-api/monetary-amounts"},{"title":"Uploading files to the Admin and Seller APIs","sidebarTitle":"Uploads","href":"/api-reference/admin-api/uploads"},{"title":"Admin API endpoint index","sidebarTitle":"Endpoint index","href":"/api-reference/admin-api/endpoints"}]},{"group":"Endpoints","pages":[{"group":"Authentication","pages":[{"title":"Login","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/auth/login","href":"/api-reference/admin-api/authentication/login"},{"title":"Refresh token","description":"Exchanges the HttpOnly refresh-token cookie for a new access JWT and a\nrotated refresh token cookie. No request body or Authorization header\nis required — the cookie alone authenticates the call.\n","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/auth/refresh","href":"/api-reference/admin-api/authentication/refresh-token"},{"title":"Logout","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/auth/logout","href":"/api-reference/admin-api/authentication/logout"},{"title":"Accept an invitation","description":"Accepts a staff invitation and returns a signed-in admin session, so the\nnew member lands in the dashboard rather than on a login form.\n\nUnauthenticated — the ID and token in the emailed link are the\ncredential. The email is never taken from the request; it always comes\nfrom the invitation.\n\n`password` is required when no account exists for the invited address,\nin which case it sets one. When an account already exists, the same\nfield is how the person proves the account is theirs.\n","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/auth/invitations/{id}/accept","href":"/api-reference/admin-api/authentication/accept-an-invitation"},{"title":"Get current admin user and permissions","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/me","href":"/api-reference/admin-api/authentication/get-current-admin-user-and-permissions"},{"title":"Update the current admin profile","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/me","href":"/api-reference/admin-api/authentication/update-the-current-admin-profile"},{"title":"Request password reset","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/auth/password_resets","href":"/api-reference/admin-api/authentication/request-password-reset"},{"title":"Reset password","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/auth/password_resets/{id}","href":"/api-reference/admin-api/authentication/reset-password"},{"title":"Check first-run setup availability","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/auth/setup","href":"/api-reference/admin-api/authentication/check-first-run-setup-availability"},{"title":"Complete first-run setup","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/auth/setup","href":"/api-reference/admin-api/authentication/complete-first-run-setup"},{"title":"List countries for first-run setup","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/auth/setup/countries","href":"/api-reference/admin-api/authentication/list-countries-for-first-run-setup"}]},{"group":"Allowed Origins","pages":[{"title":"List allowed origins","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/allowed_origins","href":"/api-reference/admin-api/allowed-origins/list-allowed-origins"},{"title":"Create an allowed origin","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/allowed_origins","href":"/api-reference/admin-api/allowed-origins/create-an-allowed-origin"},{"title":"Get an allowed origin","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/allowed_origins/{id}","href":"/api-reference/admin-api/allowed-origins/get-an-allowed-origin"},{"title":"Delete an allowed origin","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/allowed_origins/{id}","href":"/api-reference/admin-api/allowed-origins/delete-an-allowed-origin"},{"title":"Update an allowed origin","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/allowed_origins/{id}","href":"/api-reference/admin-api/allowed-origins/update-an-allowed-origin"}]},{"group":"API Keys","pages":[{"title":"List API keys","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/api_keys","href":"/api-reference/admin-api/api-keys/list-api-keys"},{"title":"Create an API key","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/api_keys","href":"/api-reference/admin-api/api-keys/create-an-api-key"},{"title":"Show an API key","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/api_keys/{id}","href":"/api-reference/admin-api/api-keys/show-an-api-key"},{"title":"Delete an API key","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/api_keys/{id}","href":"/api-reference/admin-api/api-keys/delete-an-api-key"},{"title":"Update an API key","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/api_keys/{id}","href":"/api-reference/admin-api/api-keys/update-an-api-key"},{"title":"Describe the current API key","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/api_keys/current","href":"/api-reference/admin-api/api-keys/describe-the-current-api-key"},{"title":"Revoke an API key","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/api_keys/{id}/revoke","href":"/api-reference/admin-api/api-keys/revoke-an-api-key"}]},{"group":"Categories","pages":[{"title":"List categories","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/categories","href":"/api-reference/admin-api/categories/list-categories"},{"title":"Create a category","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/categories","href":"/api-reference/admin-api/categories/create-a-category"},{"title":"Get a category","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/categories/{id}","href":"/api-reference/admin-api/categories/get-a-category"},{"title":"Delete a category","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/categories/{id}","href":"/api-reference/admin-api/categories/delete-a-category"},{"title":"Update a category","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/categories/{id}","href":"/api-reference/admin-api/categories/update-a-category"},{"title":"Reposition a category","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/categories/{id}/reposition","href":"/api-reference/admin-api/categories/reposition-a-category"},{"title":"List category products","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/categories/{category_id}/products","href":"/api-reference/admin-api/categories/list-category-products"},{"title":"Add products to a category","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/categories/{category_id}/products","href":"/api-reference/admin-api/categories/add-products-to-a-category"},{"title":"Remove products from a category","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/categories/{category_id}/products","href":"/api-reference/admin-api/categories/remove-products-from-a-category"},{"title":"Reposition a category product","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/categories/{category_id}/products/{id}/reposition","href":"/api-reference/admin-api/categories/reposition-a-category-product"},{"title":"List category custom fields","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/categories/{category_id}/custom_fields","href":"/api-reference/admin-api/categories/list-category-custom-fields"}]},{"group":"Channels","pages":[{"title":"List channels","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/channels","href":"/api-reference/admin-api/channels/list-channels"},{"title":"Create a channel","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/channels","href":"/api-reference/admin-api/channels/create-a-channel"},{"title":"Get a channel","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/channels/{id}","href":"/api-reference/admin-api/channels/get-a-channel"},{"title":"Delete a channel","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/channels/{id}","href":"/api-reference/admin-api/channels/delete-a-channel"},{"title":"Update a channel","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/channels/{id}","href":"/api-reference/admin-api/channels/update-a-channel"},{"title":"Publish products on a channel","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/channels/{id}/add_products","href":"/api-reference/admin-api/channels/publish-products-on-a-channel"},{"title":"Unpublish products from a channel","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/channels/{id}/remove_products","href":"/api-reference/admin-api/channels/unpublish-products-from-a-channel"},{"title":"List order routing rules for a channel","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/channels/{channel_id}/order_routing_rules","href":"/api-reference/admin-api/channels/list-order-routing-rules-for-a-channel"},{"title":"Create an order routing rule on a channel","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/channels/{channel_id}/order_routing_rules","href":"/api-reference/admin-api/channels/create-an-order-routing-rule-on-a-channel"},{"title":"Delete an order routing rule","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/channels/{channel_id}/order_routing_rules/{id}","href":"/api-reference/admin-api/channels/delete-an-order-routing-rule"},{"title":"Update an order routing rule","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/channels/{channel_id}/order_routing_rules/{id}","href":"/api-reference/admin-api/channels/update-an-order-routing-rule"},{"title":"List available order routing rule types","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/order_routing_rules/types","href":"/api-reference/admin-api/channels/list-available-order-routing-rule-types"}]},{"group":"Custom Fields","pages":[{"title":"List custom field definitions","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/custom_field_definitions","href":"/api-reference/admin-api/custom-fields/list-custom-field-definitions"},{"title":"Create a custom field definition","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/custom_field_definitions","href":"/api-reference/admin-api/custom-fields/create-a-custom-field-definition"},{"title":"Show a custom field definition","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/custom_field_definitions/{id}","href":"/api-reference/admin-api/custom-fields/show-a-custom-field-definition"},{"title":"Delete a custom field definition","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/custom_field_definitions/{id}","href":"/api-reference/admin-api/custom-fields/delete-a-custom-field-definition"},{"title":"Update a custom field definition","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/custom_field_definitions/{id}","href":"/api-reference/admin-api/custom-fields/update-a-custom-field-definition"}]},{"group":"Customer Groups","pages":[{"title":"List customer groups","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/customer_groups","href":"/api-reference/admin-api/customer-groups/list-customer-groups"},{"title":"Create a customer group","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/customer_groups","href":"/api-reference/admin-api/customer-groups/create-a-customer-group"},{"title":"Get a customer group","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/customer_groups/{id}","href":"/api-reference/admin-api/customer-groups/get-a-customer-group"},{"title":"Delete a customer group","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/customer_groups/{id}","href":"/api-reference/admin-api/customer-groups/delete-a-customer-group"},{"title":"Update a customer group","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/customer_groups/{id}","href":"/api-reference/admin-api/customer-groups/update-a-customer-group"}]},{"group":"Customers","pages":[{"title":"List customer custom fields","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/customers/{customer_id}/custom_fields","href":"/api-reference/admin-api/customers/list-customer-custom-fields"},{"title":"Export a customer's personal data","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/customers/{id}/export","href":"/api-reference/admin-api/customers/export-a-customers-personal-data"},{"title":"Erase a customer's personal data","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/customers/{id}/anonymize","href":"/api-reference/admin-api/customers/erase-a-customers-personal-data"},{"title":"List consent records","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/consent_records","href":"/api-reference/admin-api/customers/list-consent-records"},{"title":"List data requests","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/data_requests","href":"/api-reference/admin-api/customers/list-data-requests"},{"title":"Record a data request","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/data_requests","href":"/api-reference/admin-api/customers/record-a-data-request"},{"title":"List customer addresses","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/customers/{customer_id}/addresses","href":"/api-reference/admin-api/customers/list-customer-addresses"},{"title":"Create a customer address","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/customers/{customer_id}/addresses","href":"/api-reference/admin-api/customers/create-a-customer-address"},{"title":"Delete a customer address","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/customers/{customer_id}/addresses/{id}","href":"/api-reference/admin-api/customers/delete-a-customer-address"},{"title":"Update a customer address","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/customers/{customer_id}/addresses/{id}","href":"/api-reference/admin-api/customers/update-a-customer-address"},{"title":"List customer credit cards","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/customers/{customer_id}/credit_cards","href":"/api-reference/admin-api/customers/list-customer-credit-cards"},{"title":"Show a customer credit card","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/customers/{customer_id}/credit_cards/{id}","href":"/api-reference/admin-api/customers/show-a-customer-credit-card"},{"title":"Delete a customer credit card","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/customers/{customer_id}/credit_cards/{id}","href":"/api-reference/admin-api/customers/delete-a-customer-credit-card"},{"title":"List customer store credits","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/customers/{customer_id}/store_credits","href":"/api-reference/admin-api/customers/list-customer-store-credits"},{"title":"Issue a store credit to a customer","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/customers/{customer_id}/store_credits","href":"/api-reference/admin-api/customers/issue-a-store-credit-to-a-customer"},{"title":"Delete a store credit","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/customers/{customer_id}/store_credits/{id}","href":"/api-reference/admin-api/customers/delete-a-store-credit"},{"title":"Update a store credit","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/customers/{customer_id}/store_credits/{id}","href":"/api-reference/admin-api/customers/update-a-store-credit"},{"title":"List customer tax registrations","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/customers/{customer_id}/tax_identifiers","href":"/api-reference/admin-api/customers/list-customer-tax-registrations"},{"title":"Update a customer tax registration","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/customers/{customer_id}/tax_identifiers/{id}","href":"/api-reference/admin-api/customers/update-a-customer-tax-registration"},{"title":"List customers","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/customers","href":"/api-reference/admin-api/customers/list-customers"},{"title":"Create a customer","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/customers","href":"/api-reference/admin-api/customers/create-a-customer"},{"title":"Show a customer","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/customers/{id}","href":"/api-reference/admin-api/customers/show-a-customer"},{"title":"Delete a customer","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/customers/{id}","href":"/api-reference/admin-api/customers/delete-a-customer"},{"title":"Update a customer","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/customers/{id}","href":"/api-reference/admin-api/customers/update-a-customer"},{"title":"Bulk-add customers to groups","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/customers/bulk_add_to_groups","href":"/api-reference/admin-api/customers/bulk-add-customers-to-groups"},{"title":"Bulk-remove customers from groups","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/customers/bulk_remove_from_groups","href":"/api-reference/admin-api/customers/bulk-remove-customers-from-groups"},{"title":"Bulk-add tags to customers","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/customers/bulk_add_tags","href":"/api-reference/admin-api/customers/bulk-add-tags-to-customers"},{"title":"Bulk-remove tags from customers","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/customers/bulk_remove_tags","href":"/api-reference/admin-api/customers/bulk-remove-tags-from-customers"}]},{"group":"Email Templates","pages":[{"title":"List email templates","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/email_templates","href":"/api-reference/admin-api/email-templates/list-email-templates"},{"title":"Get an email template","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/email_templates/{id}","href":"/api-reference/admin-api/email-templates/get-an-email-template"},{"title":"Revert an email template to Spree's default","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/email_templates/{id}","href":"/api-reference/admin-api/email-templates/revert-an-email-template-to-sprees-default"},{"title":"Save an email template draft","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml put /api/v3/admin/email_templates/{email_template_id}/draft","href":"/api-reference/admin-api/email-templates/save-an-email-template-draft"},{"title":"Discard an email template draft","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/email_templates/{email_template_id}/draft","href":"/api-reference/admin-api/email-templates/discard-an-email-template-draft"},{"title":"Publish an email template draft","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/email_templates/{email_template_id}/publication","href":"/api-reference/admin-api/email-templates/publish-an-email-template-draft"},{"title":"Preview an email template","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/email_templates/{email_template_id}/preview","href":"/api-reference/admin-api/email-templates/preview-an-email-template"},{"title":"Send a test email","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/email_templates/{email_template_id}/test_email","href":"/api-reference/admin-api/email-templates/send-a-test-email"},{"title":"List records to preview an email template with","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/email_templates/{email_template_id}/sample_records","href":"/api-reference/admin-api/email-templates/list-records-to-preview-an-email-template-with"},{"title":"List email template revisions","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/email_templates/{email_template_id}/revisions","href":"/api-reference/admin-api/email-templates/list-email-template-revisions"},{"title":"Restore an email template revision","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/email_templates/{email_template_id}/revisions/{revision_id}/restoration","href":"/api-reference/admin-api/email-templates/restore-an-email-template-revision"}]},{"group":"Exports","pages":[{"title":"List exports","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/exports","href":"/api-reference/admin-api/exports/list-exports"},{"title":"Create an export","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/exports","href":"/api-reference/admin-api/exports/create-an-export"},{"title":"Show an export","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/exports/{id}","href":"/api-reference/admin-api/exports/show-an-export"},{"title":"Delete an export","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/exports/{id}","href":"/api-reference/admin-api/exports/delete-an-export"},{"title":"Download an export","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/exports/{id}/download","href":"/api-reference/admin-api/exports/download-an-export"}]},{"group":"Files","pages":[{"title":"Upload a file","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/files","href":"/api-reference/admin-api/files/upload-a-file"}]},{"group":"Fulfillments","pages":[{"title":"List fulfillments","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/orders/{order_id}/fulfillments","href":"/api-reference/admin-api/fulfillments/list-fulfillments"},{"title":"Create a fulfillment","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/orders/{order_id}/fulfillments","href":"/api-reference/admin-api/fulfillments/create-a-fulfillment"},{"title":"Show a shipment","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/orders/{order_id}/fulfillments/{id}","href":"/api-reference/admin-api/fulfillments/show-a-shipment"},{"title":"Update a shipment","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/fulfillments/{id}","href":"/api-reference/admin-api/fulfillments/update-a-shipment"},{"title":"Fulfill a fulfillment","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/fulfillments/{id}/fulfill","href":"/api-reference/admin-api/fulfillments/fulfill-a-fulfillment"},{"title":"Mark a fulfillment delivered","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/fulfillments/{id}/mark_delivered","href":"/api-reference/admin-api/fulfillments/mark-a-fulfillment-delivered"},{"title":"Cancel a fulfillment","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/fulfillments/{id}/cancel","href":"/api-reference/admin-api/fulfillments/cancel-a-fulfillment"},{"title":"Split a fulfillment","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/fulfillments/{id}/split","href":"/api-reference/admin-api/fulfillments/split-a-fulfillment"}]},{"group":"Gift Cards","pages":[{"title":"List gift card custom fields","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/gift_cards/{gift_card_id}/custom_fields","href":"/api-reference/admin-api/gift-cards/list-gift-card-custom-fields"},{"title":"List gift card batches","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/gift_card_batches","href":"/api-reference/admin-api/gift-cards/list-gift-card-batches"},{"title":"Create a gift card batch","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/gift_card_batches","href":"/api-reference/admin-api/gift-cards/create-a-gift-card-batch"},{"title":"Get a gift card batch","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/gift_card_batches/{id}","href":"/api-reference/admin-api/gift-cards/get-a-gift-card-batch"},{"title":"List gift cards","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/gift_cards","href":"/api-reference/admin-api/gift-cards/list-gift-cards"},{"title":"Create a gift card","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/gift_cards","href":"/api-reference/admin-api/gift-cards/create-a-gift-card"},{"title":"Get a gift card","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/gift_cards/{id}","href":"/api-reference/admin-api/gift-cards/get-a-gift-card"},{"title":"Delete a gift card","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/gift_cards/{id}","href":"/api-reference/admin-api/gift-cards/delete-a-gift-card"},{"title":"Update a gift card","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/gift_cards/{id}","href":"/api-reference/admin-api/gift-cards/update-a-gift-card"}]},{"group":"Imports","pages":[{"title":"List imports","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/imports","href":"/api-reference/admin-api/imports/list-imports"},{"title":"Create an import","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/imports","href":"/api-reference/admin-api/imports/create-an-import"},{"title":"Download an import template","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/imports/template","href":"/api-reference/admin-api/imports/download-an-import-template"},{"title":"Download an example import file","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/imports/example","href":"/api-reference/admin-api/imports/download-an-example-import-file"},{"title":"Show an import","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/imports/{id}","href":"/api-reference/admin-api/imports/show-an-import"},{"title":"Delete an import","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/imports/{id}","href":"/api-reference/admin-api/imports/delete-an-import"},{"title":"Download the originally uploaded file","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/imports/{id}/download","href":"/api-reference/admin-api/imports/download-the-originally-uploaded-file"},{"title":"Complete mapping and start processing","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/imports/{id}/complete_mapping","href":"/api-reference/admin-api/imports/complete-mapping-and-start-processing"},{"title":"Retry failed rows","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/imports/{id}/retry_failed_rows","href":"/api-reference/admin-api/imports/retry-failed-rows"},{"title":"List import rows","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/imports/{import_id}/rows","href":"/api-reference/admin-api/imports/list-import-rows"}]},{"group":"Maintenance Tasks","pages":[{"title":"List maintenance task runs","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/maintenance_task_runs","href":"/api-reference/admin-api/maintenance-tasks/list-maintenance-task-runs"},{"title":"Start a maintenance task","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/maintenance_task_runs","href":"/api-reference/admin-api/maintenance-tasks/start-a-maintenance-task"},{"title":"Retrieve a maintenance task run","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/maintenance_task_runs/{id}","href":"/api-reference/admin-api/maintenance-tasks/retrieve-a-maintenance-task-run"},{"title":"Cancel a maintenance task run","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/maintenance_task_runs/{maintenance_task_run_id}/cancellation","href":"/api-reference/admin-api/maintenance-tasks/cancel-a-maintenance-task-run"}]},{"group":"Markets","pages":[{"title":"List markets","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/markets","href":"/api-reference/admin-api/markets/list-markets"},{"title":"Create a market","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/markets","href":"/api-reference/admin-api/markets/create-a-market"},{"title":"Get a market","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/markets/{id}","href":"/api-reference/admin-api/markets/get-a-market"},{"title":"Delete a market","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/markets/{id}","href":"/api-reference/admin-api/markets/delete-a-market"},{"title":"Update a market","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/markets/{id}","href":"/api-reference/admin-api/markets/update-a-market"}]},{"group":"Option Types","pages":[{"title":"List option type custom fields","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/option_types/{option_type_id}/custom_fields","href":"/api-reference/admin-api/option-types/list-option-type-custom-fields"},{"title":"List option types","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/option_types","href":"/api-reference/admin-api/option-types/list-option-types"},{"title":"Create an option type","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/option_types","href":"/api-reference/admin-api/option-types/create-an-option-type"},{"title":"Get an option type","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/option_types/{id}","href":"/api-reference/admin-api/option-types/get-an-option-type"},{"title":"Delete an option type","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/option_types/{id}","href":"/api-reference/admin-api/option-types/delete-an-option-type"},{"title":"Update an option type","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/option_types/{id}","href":"/api-reference/admin-api/option-types/update-an-option-type"}]},{"group":"Orders","pages":[{"title":"List claims","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/claims","href":"/api-reference/admin-api/orders/list-claims"},{"title":"List order claims","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/orders/{order_id}/claims","href":"/api-reference/admin-api/orders/list-order-claims"},{"title":"Create a claim","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/orders/{order_id}/claims","href":"/api-reference/admin-api/orders/create-a-claim"},{"title":"Update a claim","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/claims/{id}","href":"/api-reference/admin-api/orders/update-a-claim"},{"title":"Resolve a claim","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/claims/{id}/resolve","href":"/api-reference/admin-api/orders/resolve-a-claim"},{"title":"Deny a claim","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/claims/{id}/deny","href":"/api-reference/admin-api/orders/deny-a-claim"},{"title":"Cancel a claim","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/claims/{id}/cancel","href":"/api-reference/admin-api/orders/cancel-a-claim"},{"title":"List order custom fields","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/orders/{order_id}/custom_fields","href":"/api-reference/admin-api/orders/list-order-custom-fields"},{"title":"List digital links","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/digital_links","href":"/api-reference/admin-api/orders/list-digital-links"},{"title":"List exchanges","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/exchanges","href":"/api-reference/admin-api/orders/list-exchanges"},{"title":"List order exchanges","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/orders/{order_id}/exchanges","href":"/api-reference/admin-api/orders/list-order-exchanges"},{"title":"Create an exchange","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/orders/{order_id}/exchanges","href":"/api-reference/admin-api/orders/create-an-exchange"},{"title":"Update an exchange","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/exchanges/{id}","href":"/api-reference/admin-api/orders/update-an-exchange"},{"title":"Receive an exchange","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/exchanges/{id}/receive","href":"/api-reference/admin-api/orders/receive-an-exchange"},{"title":"Fulfill an exchange","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/exchanges/{id}/fulfill","href":"/api-reference/admin-api/orders/fulfill-an-exchange"},{"title":"Cancel an exchange","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/exchanges/{id}/cancel","href":"/api-reference/admin-api/orders/cancel-an-exchange"},{"title":"List tax lines","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/orders/{order_id}/tax_lines","href":"/api-reference/admin-api/orders/list-tax-lines"},{"title":"List discounts","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/orders/{order_id}/discounts","href":"/api-reference/admin-api/orders/list-discounts"},{"title":"Create manual discount","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/orders/{order_id}/discounts","href":"/api-reference/admin-api/orders/create-manual-discount"},{"title":"Update manual discount","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/discounts/{id}","href":"/api-reference/admin-api/orders/update-manual-discount"},{"title":"List fees","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/orders/{order_id}/fees","href":"/api-reference/admin-api/orders/list-fees"},{"title":"Create fee","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/orders/{order_id}/fees","href":"/api-reference/admin-api/orders/create-fee"},{"title":"Update fee","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/fees/{id}","href":"/api-reference/admin-api/orders/update-fee"},{"title":"List order groups","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/order_groups","href":"/api-reference/admin-api/orders/list-order-groups"},{"title":"Apply a discount code","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/orders/{order_id}/discount_codes","href":"/api-reference/admin-api/orders/apply-a-discount-code"},{"title":"Apply a gift card to an order","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/orders/{order_id}/gift_cards","href":"/api-reference/admin-api/orders/apply-a-gift-card-to-an-order"},{"title":"Remove a gift card from an order","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/orders/{order_id}/gift_cards/{id}","href":"/api-reference/admin-api/orders/remove-a-gift-card-from-an-order"},{"title":"List order items","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/orders/{order_id}/items","href":"/api-reference/admin-api/orders/list-order-items"},{"title":"Add an item","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/orders/{order_id}/items","href":"/api-reference/admin-api/orders/add-an-item"},{"title":"Show an item","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/orders/{order_id}/items/{id}","href":"/api-reference/admin-api/orders/show-an-item"},{"title":"Remove an item","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/orders/{order_id}/items/{id}","href":"/api-reference/admin-api/orders/remove-an-item"},{"title":"Update an item","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/items/{id}","href":"/api-reference/admin-api/orders/update-an-item"},{"title":"Apply customer's store credit to an order","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/orders/{order_id}/store_credits","href":"/api-reference/admin-api/orders/apply-customers-store-credit-to-an-order"},{"title":"Remove store credit from an order","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/orders/{order_id}/store_credits","href":"/api-reference/admin-api/orders/remove-store-credit-from-an-order"},{"title":"List orders","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/orders","href":"/api-reference/admin-api/orders/list-orders"},{"title":"Create a draft order","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/orders","href":"/api-reference/admin-api/orders/create-a-draft-order"},{"title":"Show an order","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/orders/{id}","href":"/api-reference/admin-api/orders/show-an-order"},{"title":"Delete a draft order","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/orders/{id}","href":"/api-reference/admin-api/orders/delete-a-draft-order"},{"title":"Update an order","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{id}","href":"/api-reference/admin-api/orders/update-an-order"},{"title":"Complete an order","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{id}/complete","href":"/api-reference/admin-api/orders/complete-an-order"},{"title":"Cancel an order","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{id}/cancel","href":"/api-reference/admin-api/orders/cancel-an-order"},{"title":"Approve an order","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{id}/approve","href":"/api-reference/admin-api/orders/approve-an-order"},{"title":"Resend confirmation email","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/orders/{id}/resend_confirmation","href":"/api-reference/admin-api/orders/resend-confirmation-email"},{"title":"List returns","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/returns","href":"/api-reference/admin-api/orders/list-returns"},{"title":"List order returns","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/orders/{order_id}/returns","href":"/api-reference/admin-api/orders/list-order-returns"},{"title":"Create a return","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/orders/{order_id}/returns","href":"/api-reference/admin-api/orders/create-a-return"},{"title":"Update a return","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/returns/{id}","href":"/api-reference/admin-api/orders/update-a-return"},{"title":"Receive a return","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/returns/{id}/receive","href":"/api-reference/admin-api/orders/receive-a-return"},{"title":"Refund a return","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/returns/{id}/refund","href":"/api-reference/admin-api/orders/refund-a-return"},{"title":"Cancel a return","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/returns/{id}/cancel","href":"/api-reference/admin-api/orders/cancel-a-return"},{"title":"List return labels","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/orders/{order_id}/returns/{return_id}/labels","href":"/api-reference/admin-api/orders/list-return-labels"}]},{"group":"Payment Methods","pages":[{"title":"List payment method custom fields","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/payment_methods/{payment_method_id}/custom_fields","href":"/api-reference/admin-api/payment-methods/list-payment-method-custom-fields"},{"title":"List payment methods","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/payment_methods","href":"/api-reference/admin-api/payment-methods/list-payment-methods"},{"title":"Create a payment method","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/payment_methods","href":"/api-reference/admin-api/payment-methods/create-a-payment-method"},{"title":"List available payment provider types","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/payment_methods/types","href":"/api-reference/admin-api/payment-methods/list-available-payment-provider-types"},{"title":"Show a payment method","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/payment_methods/{id}","href":"/api-reference/admin-api/payment-methods/show-a-payment-method"},{"title":"Update a payment method","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/payment_methods/{id}","href":"/api-reference/admin-api/payment-methods/update-a-payment-method"}]},{"group":"Payments","pages":[{"title":"List payments","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/orders/{order_id}/payments","href":"/api-reference/admin-api/payments/list-payments"},{"title":"Create a payment","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/orders/{order_id}/payments","href":"/api-reference/admin-api/payments/create-a-payment"},{"title":"Show a payment","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/orders/{order_id}/payments/{id}","href":"/api-reference/admin-api/payments/show-a-payment"},{"title":"Capture a payment","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/payments/{id}/capture","href":"/api-reference/admin-api/payments/capture-a-payment"},{"title":"Void a payment","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/payments/{id}/void","href":"/api-reference/admin-api/payments/void-a-payment"}]},{"group":"Pricing","pages":[{"title":"List price lists","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/price_lists","href":"/api-reference/admin-api/pricing/list-price-lists"},{"title":"Create a price list","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/price_lists","href":"/api-reference/admin-api/pricing/create-a-price-list"},{"title":"Get a price list","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/price_lists/{id}","href":"/api-reference/admin-api/pricing/get-a-price-list"},{"title":"Delete a price list","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/price_lists/{id}","href":"/api-reference/admin-api/pricing/delete-a-price-list"},{"title":"Update a price list","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/price_lists/{id}","href":"/api-reference/admin-api/pricing/update-a-price-list"},{"title":"Activate a price list","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/price_lists/{id}/activate","href":"/api-reference/admin-api/pricing/activate-a-price-list"},{"title":"Deactivate a price list","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/price_lists/{id}/deactivate","href":"/api-reference/admin-api/pricing/deactivate-a-price-list"},{"title":"List prices","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/prices","href":"/api-reference/admin-api/pricing/list-prices"},{"title":"Create a price","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/prices","href":"/api-reference/admin-api/pricing/create-a-price"},{"title":"Get a price","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/prices/{id}","href":"/api-reference/admin-api/pricing/get-a-price"},{"title":"Delete a price","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/prices/{id}","href":"/api-reference/admin-api/pricing/delete-a-price"},{"title":"Update a price","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/prices/{id}","href":"/api-reference/admin-api/pricing/update-a-price"},{"title":"Bulk-upsert prices","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/prices/bulk_upsert","href":"/api-reference/admin-api/pricing/bulk-upsert-prices"},{"title":"Bulk-delete prices","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/prices/bulk_destroy","href":"/api-reference/admin-api/pricing/bulk-delete-prices"}]},{"group":"Products","pages":[{"title":"List product custom fields","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/products/{product_id}/custom_fields","href":"/api-reference/admin-api/products/list-product-custom-fields"},{"title":"Create a product custom field","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/products/{product_id}/custom_fields","href":"/api-reference/admin-api/products/create-a-product-custom-field"},{"title":"Show a product custom field","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/products/{product_id}/custom_fields/{id}","href":"/api-reference/admin-api/products/show-a-product-custom-field"},{"title":"Delete a product custom field","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/products/{product_id}/custom_fields/{id}","href":"/api-reference/admin-api/products/delete-a-product-custom-field"},{"title":"Update a product custom field","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/products/{product_id}/custom_fields/{id}","href":"/api-reference/admin-api/products/update-a-product-custom-field"},{"title":"List product digital assets","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/products/{product_id}/digital_assets","href":"/api-reference/admin-api/products/list-product-digital-assets"},{"title":"Create a product digital asset","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/products/{product_id}/digital_assets","href":"/api-reference/admin-api/products/create-a-product-digital-asset"},{"title":"Update a product digital asset","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/products/{product_id}/digital_assets/{id}","href":"/api-reference/admin-api/products/update-a-product-digital-asset"},{"title":"List product translations","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/products/{product_id}/translations","href":"/api-reference/admin-api/products/list-product-translations"},{"title":"List products","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/products","href":"/api-reference/admin-api/products/list-products"},{"title":"Create a product","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/products","href":"/api-reference/admin-api/products/create-a-product"},{"title":"Get a product","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/products/{id}","href":"/api-reference/admin-api/products/get-a-product"},{"title":"Delete a product","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/products/{id}","href":"/api-reference/admin-api/products/delete-a-product"},{"title":"Update a product","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/products/{id}","href":"/api-reference/admin-api/products/update-a-product"},{"title":"Bulk-update product status","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/products/bulk_status_update","href":"/api-reference/admin-api/products/bulk-update-product-status"},{"title":"Bulk-add products to categories","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/products/bulk_add_to_categories","href":"/api-reference/admin-api/products/bulk-add-products-to-categories"},{"title":"Bulk-remove products from categories","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/products/bulk_remove_from_categories","href":"/api-reference/admin-api/products/bulk-remove-products-from-categories"},{"title":"Bulk-add products to collections","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/products/bulk_add_to_collections","href":"/api-reference/admin-api/products/bulk-add-products-to-collections"},{"title":"Bulk-remove products from collections","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/products/bulk_remove_from_collections","href":"/api-reference/admin-api/products/bulk-remove-products-from-collections"},{"title":"Bulk-add products to channels","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/products/bulk_add_to_channels","href":"/api-reference/admin-api/products/bulk-add-products-to-channels"},{"title":"Bulk-remove products from channels","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/products/bulk_remove_from_channels","href":"/api-reference/admin-api/products/bulk-remove-products-from-channels"},{"title":"Bulk-add tags to products","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/products/bulk_add_tags","href":"/api-reference/admin-api/products/bulk-add-tags-to-products"},{"title":"Bulk-remove tags from products","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/products/bulk_remove_tags","href":"/api-reference/admin-api/products/bulk-remove-tags-from-products"},{"title":"Bulk-delete products","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/products/bulk_destroy","href":"/api-reference/admin-api/products/bulk-delete-products"},{"title":"Approve a submitted product","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/products/{id}/approve","href":"/api-reference/admin-api/products/approve-a-submitted-product"},{"title":"Reject a submitted product","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/products/{id}/reject","href":"/api-reference/admin-api/products/reject-a-submitted-product"},{"title":"Translation coverage for a resource type","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/translations","href":"/api-reference/admin-api/products/translation-coverage-for-a-resource-type"}]},{"group":"Policies","pages":[{"title":"List policies","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/policies","href":"/api-reference/admin-api/policies/list-policies"},{"title":"Create a policy","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/policies","href":"/api-reference/admin-api/policies/create-a-policy"},{"title":"Get a policy","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/policies/{id}","href":"/api-reference/admin-api/policies/get-a-policy"},{"title":"Delete a policy","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/policies/{id}","href":"/api-reference/admin-api/policies/delete-a-policy"},{"title":"Update a policy","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/policies/{id}","href":"/api-reference/admin-api/policies/update-a-policy"}]},{"group":"Reasons","pages":[{"title":"List claim reasons","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/claim_reasons","href":"/api-reference/admin-api/reasons/list-claim-reasons"},{"title":"Create a claim reason","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/claim_reasons","href":"/api-reference/admin-api/reasons/create-a-claim-reason"},{"title":"Get a claim reason","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/claim_reasons/{id}","href":"/api-reference/admin-api/reasons/get-a-claim-reason"},{"title":"Delete a claim reason","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/claim_reasons/{id}","href":"/api-reference/admin-api/reasons/delete-a-claim-reason"},{"title":"Update a claim reason","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/claim_reasons/{id}","href":"/api-reference/admin-api/reasons/update-a-claim-reason"},{"title":"List order cancellation reasons","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/order_cancellation_reasons","href":"/api-reference/admin-api/reasons/list-order-cancellation-reasons"},{"title":"Create a order cancellation reason","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/order_cancellation_reasons","href":"/api-reference/admin-api/reasons/create-a-order-cancellation-reason"},{"title":"Get a order cancellation reason","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/order_cancellation_reasons/{id}","href":"/api-reference/admin-api/reasons/get-a-order-cancellation-reason"},{"title":"Delete a order cancellation reason","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/order_cancellation_reasons/{id}","href":"/api-reference/admin-api/reasons/delete-a-order-cancellation-reason"},{"title":"Update a order cancellation reason","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/order_cancellation_reasons/{id}","href":"/api-reference/admin-api/reasons/update-a-order-cancellation-reason"},{"title":"List refund reasons","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/refund_reasons","href":"/api-reference/admin-api/reasons/list-refund-reasons"},{"title":"Create a refund reason","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/refund_reasons","href":"/api-reference/admin-api/reasons/create-a-refund-reason"},{"title":"Get a refund reason","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/refund_reasons/{id}","href":"/api-reference/admin-api/reasons/get-a-refund-reason"},{"title":"Delete a refund reason","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/refund_reasons/{id}","href":"/api-reference/admin-api/reasons/delete-a-refund-reason"},{"title":"Update a refund reason","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/refund_reasons/{id}","href":"/api-reference/admin-api/reasons/update-a-refund-reason"},{"title":"List return reasons","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/return_reasons","href":"/api-reference/admin-api/reasons/list-return-reasons"},{"title":"Create a return reason","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/return_reasons","href":"/api-reference/admin-api/reasons/create-a-return-reason"},{"title":"Get a return reason","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/return_reasons/{id}","href":"/api-reference/admin-api/reasons/get-a-return-reason"},{"title":"Delete a return reason","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/return_reasons/{id}","href":"/api-reference/admin-api/reasons/delete-a-return-reason"},{"title":"Update a return reason","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/return_reasons/{id}","href":"/api-reference/admin-api/reasons/update-a-return-reason"},{"title":"List tax exemption reasons","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/tax_exemption_reasons","href":"/api-reference/admin-api/reasons/list-tax-exemption-reasons"},{"title":"Create a tax exemption reason","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/tax_exemption_reasons","href":"/api-reference/admin-api/reasons/create-a-tax-exemption-reason"},{"title":"Get a tax exemption reason","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/tax_exemption_reasons/{id}","href":"/api-reference/admin-api/reasons/get-a-tax-exemption-reason"},{"title":"Delete a tax exemption reason","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/tax_exemption_reasons/{id}","href":"/api-reference/admin-api/reasons/delete-a-tax-exemption-reason"},{"title":"Update a tax exemption reason","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/tax_exemption_reasons/{id}","href":"/api-reference/admin-api/reasons/update-a-tax-exemption-reason"}]},{"group":"Promotions","pages":[{"title":"List coupon codes for a promotion","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/promotions/{promotion_id}/coupon_codes","href":"/api-reference/admin-api/promotions/list-coupon-codes-for-a-promotion"},{"title":"List promotion custom fields","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/promotions/{promotion_id}/custom_fields","href":"/api-reference/admin-api/promotions/list-promotion-custom-fields"},{"title":"List actions for a promotion","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/promotions/{promotion_id}/promotion_actions","href":"/api-reference/admin-api/promotions/list-actions-for-a-promotion"},{"title":"Create an action on a promotion","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/promotions/{promotion_id}/promotion_actions","href":"/api-reference/admin-api/promotions/create-an-action-on-a-promotion"},{"title":"Delete an action from a promotion","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/promotions/{promotion_id}/promotion_actions/{id}","href":"/api-reference/admin-api/promotions/delete-an-action-from-a-promotion"},{"title":"Update an action on a promotion","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/promotions/{promotion_id}/promotion_actions/{id}","href":"/api-reference/admin-api/promotions/update-an-action-on-a-promotion"},{"title":"List rules for a promotion","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/promotions/{promotion_id}/promotion_rules","href":"/api-reference/admin-api/promotions/list-rules-for-a-promotion"},{"title":"Create a rule on a promotion","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/promotions/{promotion_id}/promotion_rules","href":"/api-reference/admin-api/promotions/create-a-rule-on-a-promotion"},{"title":"Delete a rule from a promotion","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/promotions/{promotion_id}/promotion_rules/{id}","href":"/api-reference/admin-api/promotions/delete-a-rule-from-a-promotion"},{"title":"Update a rule's preferences","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/promotions/{promotion_id}/promotion_rules/{id}","href":"/api-reference/admin-api/promotions/update-a-rules-preferences"},{"title":"List promotions","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/promotions","href":"/api-reference/admin-api/promotions/list-promotions"},{"title":"Create a promotion","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/promotions","href":"/api-reference/admin-api/promotions/create-a-promotion"},{"title":"Show a promotion","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/promotions/{id}","href":"/api-reference/admin-api/promotions/show-a-promotion"},{"title":"Delete a promotion","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/promotions/{id}","href":"/api-reference/admin-api/promotions/delete-a-promotion"},{"title":"Update a promotion","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/promotions/{id}","href":"/api-reference/admin-api/promotions/update-a-promotion"},{"title":"List available promotion action types","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/promotion_actions/types","href":"/api-reference/admin-api/promotions/list-available-promotion-action-types"},{"title":"List available promotion rule types","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/promotion_rules/types","href":"/api-reference/admin-api/promotions/list-available-promotion-rule-types"}]},{"group":"Refunds","pages":[{"title":"List refunds","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/orders/{order_id}/refunds","href":"/api-reference/admin-api/refunds/list-refunds"},{"title":"Create a refund","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/orders/{order_id}/refunds","href":"/api-reference/admin-api/refunds/create-a-refund"}]},{"group":"Settings","pages":[{"title":"List tax rate custom fields","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/tax_rates/{tax_rate_id}/custom_fields","href":"/api-reference/admin-api/settings/list-tax-rate-custom-fields"},{"title":"List store custom fields","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/stores/{store_id}/custom_fields","href":"/api-reference/admin-api/settings/list-store-custom-fields"},{"title":"List supported locales","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/locales","href":"/api-reference/admin-api/settings/list-supported-locales"},{"title":"Get the current store","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/store","href":"/api-reference/admin-api/settings/get-the-current-store"},{"title":"Update the current store","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/store","href":"/api-reference/admin-api/settings/update-the-current-store"},{"title":"List tags","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/tags","href":"/api-reference/admin-api/settings/list-tags"},{"title":"List tax categories","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/tax_categories","href":"/api-reference/admin-api/settings/list-tax-categories"},{"title":"Create a tax category","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/tax_categories","href":"/api-reference/admin-api/settings/create-a-tax-category"},{"title":"Update a tax category","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/tax_categories/{id}","href":"/api-reference/admin-api/settings/update-a-tax-category"},{"title":"List tax rates","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/tax_rates","href":"/api-reference/admin-api/settings/list-tax-rates"},{"title":"Create a tax rate","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/tax_rates","href":"/api-reference/admin-api/settings/create-a-tax-rate"},{"title":"Get a tax rate","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/tax_rates/{id}","href":"/api-reference/admin-api/settings/get-a-tax-rate"},{"title":"Delete a tax rate","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/tax_rates/{id}","href":"/api-reference/admin-api/settings/delete-a-tax-rate"},{"title":"Update a tax rate","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/tax_rates/{id}","href":"/api-reference/admin-api/settings/update-a-tax-rate"},{"title":"List translatable resources","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/translatable_resources","href":"/api-reference/admin-api/settings/list-translatable-resources"},{"title":"Batch upsert translations","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/translations/batch","href":"/api-reference/admin-api/settings/batch-upsert-translations"},{"title":"Check for a newer Spree release","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/updates","href":"/api-reference/admin-api/settings/check-for-a-newer-spree-release"}]},{"group":"Staff","pages":[{"title":"List staff","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/admin_users","href":"/api-reference/admin-api/staff/list-staff"},{"title":"Show a staff member","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/admin_users/{id}","href":"/api-reference/admin-api/staff/show-a-staff-member"},{"title":"Remove a staff member from this store","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/admin_users/{id}","href":"/api-reference/admin-api/staff/remove-a-staff-member-from-this-store"},{"title":"Update a staff member","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/admin_users/{id}","href":"/api-reference/admin-api/staff/update-a-staff-member"},{"title":"List invitations","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/invitations","href":"/api-reference/admin-api/staff/list-invitations"},{"title":"Create an invitation","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/invitations","href":"/api-reference/admin-api/staff/create-an-invitation"},{"title":"Revoke an invitation","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/invitations/{id}","href":"/api-reference/admin-api/staff/revoke-an-invitation"},{"title":"Get an invitation acceptance link","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/invitations/{invitation_id}/acceptance_link","href":"/api-reference/admin-api/staff/get-an-invitation-acceptance-link"},{"title":"Resend an invitation","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/invitations/{id}/resend","href":"/api-reference/admin-api/staff/resend-an-invitation"},{"title":"List the permission catalog","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/permissions","href":"/api-reference/admin-api/staff/list-the-permission-catalog"},{"title":"List roles","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/roles","href":"/api-reference/admin-api/staff/list-roles"},{"title":"Create a role","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/roles","href":"/api-reference/admin-api/staff/create-a-role"},{"title":"Delete a role","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/roles/{id}","href":"/api-reference/admin-api/staff/delete-a-role"},{"title":"Update a role","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/roles/{id}","href":"/api-reference/admin-api/staff/update-a-role"}]},{"group":"Stock Locations","pages":[{"title":"List stock locations","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/stock_locations","href":"/api-reference/admin-api/stock-locations/list-stock-locations"},{"title":"Create a stock location","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/stock_locations","href":"/api-reference/admin-api/stock-locations/create-a-stock-location"},{"title":"Get a stock location","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/stock_locations/{id}","href":"/api-reference/admin-api/stock-locations/get-a-stock-location"},{"title":"Delete a stock location","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/stock_locations/{id}","href":"/api-reference/admin-api/stock-locations/delete-a-stock-location"},{"title":"Update a stock location","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/stock_locations/{id}","href":"/api-reference/admin-api/stock-locations/update-a-stock-location"}]},{"group":"Store Credits","pages":[{"title":"List store credit custom fields","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/store_credits/{store_credit_id}/custom_fields","href":"/api-reference/admin-api/store-credits/list-store-credit-custom-fields"},{"title":"List store credits","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/store_credits","href":"/api-reference/admin-api/store-credits/list-store-credits"},{"title":"Retrieve a store credit","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/store_credits/{id}","href":"/api-reference/admin-api/store-credits/retrieve-a-store-credit"},{"title":"List a store credit's ledger","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/store_credits/{store_credit_id}/events","href":"/api-reference/admin-api/store-credits/list-a-store-credits-ledger"}]},{"group":"Variants","pages":[{"title":"List variant custom fields","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/variants/{variant_id}/custom_fields","href":"/api-reference/admin-api/variants/list-variant-custom-fields"},{"title":"List product variants","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/products/{product_id}/variants","href":"/api-reference/admin-api/variants/list-product-variants"},{"title":"Create a variant","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/products/{product_id}/variants","href":"/api-reference/admin-api/variants/create-a-variant"},{"title":"Get a variant","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/products/{product_id}/variants/{id}","href":"/api-reference/admin-api/variants/get-a-variant"},{"title":"Delete a variant","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/products/{product_id}/variants/{id}","href":"/api-reference/admin-api/variants/delete-a-variant"},{"title":"Update a variant","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/products/{product_id}/variants/{id}","href":"/api-reference/admin-api/variants/update-a-variant"},{"title":"List variants","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/variants","href":"/api-reference/admin-api/variants/list-variants"}]},{"group":"Webhooks","pages":[{"title":"List webhook deliveries","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/webhook_endpoints/{webhook_endpoint_id}/deliveries","href":"/api-reference/admin-api/webhooks/list-webhook-deliveries"},{"title":"Get a webhook delivery","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/webhook_endpoints/{webhook_endpoint_id}/deliveries/{id}","href":"/api-reference/admin-api/webhooks/get-a-webhook-delivery"},{"title":"Redeliver a webhook delivery","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/webhook_endpoints/{webhook_endpoint_id}/deliveries/{id}/redeliver","href":"/api-reference/admin-api/webhooks/redeliver-a-webhook-delivery"},{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/webhook_endpoints","href":"/api-reference/admin-api/webhooks/list-webhook-endpoints"},{"title":"Create a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/webhook_endpoints","href":"/api-reference/admin-api/webhooks/create-a-webhook-endpoint"},{"title":"Get a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/webhook_endpoints/{id}","href":"/api-reference/admin-api/webhooks/get-a-webhook-endpoint"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/webhook_endpoints/{id}","href":"/api-reference/admin-api/webhooks/delete-a-webhook-endpoint"},{"title":"Update a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/webhook_endpoints/{id}","href":"/api-reference/admin-api/webhooks/update-a-webhook-endpoint"},{"title":"Send a test delivery","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/webhook_endpoints/{id}/send_test","href":"/api-reference/admin-api/webhooks/send-a-test-delivery"},{"title":"Re-enable a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/webhook_endpoints/{id}/enable","href":"/api-reference/admin-api/webhooks/re-enable-a-webhook-endpoint"},{"title":"Disable a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/webhook_endpoints/{id}/disable","href":"/api-reference/admin-api/webhooks/disable-a-webhook-endpoint"},{"title":"List webhook events","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/webhook_events","href":"/api-reference/admin-api/webhooks/list-webhook-events"}]},{"group":"Catalogs","pages":[{"title":"List catalogs","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/catalogs","href":"/api-reference/admin-api/catalogs/list-catalogs"},{"title":"Create a catalog","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/catalogs","href":"/api-reference/admin-api/catalogs/create-a-catalog"},{"title":"Update a catalog","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/catalogs/{id}","href":"/api-reference/admin-api/catalogs/update-a-catalog"},{"title":"Assign a catalog to an audience","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/catalogs/{id}/assign","href":"/api-reference/admin-api/catalogs/assign-a-catalog-to-an-audience"},{"title":"List catalog products","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/catalogs/{catalog_id}/products","href":"/api-reference/admin-api/catalogs/list-catalog-products"},{"title":"Add products to a catalog","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/catalogs/{catalog_id}/products","href":"/api-reference/admin-api/catalogs/add-products-to-a-catalog"},{"title":"Remove products from a catalog","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/catalogs/{catalog_id}/products","href":"/api-reference/admin-api/catalogs/remove-products-from-a-catalog"},{"title":"List catalog order minimums","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/catalogs/{catalog_id}/order_minimums","href":"/api-reference/admin-api/catalogs/list-catalog-order-minimums"},{"title":"Create a catalog order minimum","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/catalogs/{catalog_id}/order_minimums","href":"/api-reference/admin-api/catalogs/create-a-catalog-order-minimum"},{"title":"Delete a catalog order minimum","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/catalogs/{catalog_id}/order_minimums/{id}","href":"/api-reference/admin-api/catalogs/delete-a-catalog-order-minimum"},{"title":"Update a catalog order minimum","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/catalogs/{catalog_id}/order_minimums/{id}","href":"/api-reference/admin-api/catalogs/update-a-catalog-order-minimum"},{"title":"Set catalog quantity rules","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml put /api/v3/admin/catalogs/{catalog_id}/quantity_rules","href":"/api-reference/admin-api/catalogs/set-catalog-quantity-rules"},{"title":"Activate a catalog","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/catalogs/{id}/activate","href":"/api-reference/admin-api/catalogs/activate-a-catalog"},{"title":"Deactivate a catalog","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/catalogs/{id}/deactivate","href":"/api-reference/admin-api/catalogs/deactivate-a-catalog"}]},{"group":"Collections","pages":[{"title":"List collections","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/collections","href":"/api-reference/admin-api/collections/list-collections"},{"title":"Create a collection","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/collections","href":"/api-reference/admin-api/collections/create-a-collection"},{"title":"Get a collection","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/collections/{id}","href":"/api-reference/admin-api/collections/get-a-collection"},{"title":"Delete a collection","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/collections/{id}","href":"/api-reference/admin-api/collections/delete-a-collection"},{"title":"Update a collection","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/collections/{id}","href":"/api-reference/admin-api/collections/update-a-collection"},{"title":"List collection products","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/collections/{collection_id}/products","href":"/api-reference/admin-api/collections/list-collection-products"},{"title":"Add products to a collection","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/collections/{collection_id}/products","href":"/api-reference/admin-api/collections/add-products-to-a-collection"},{"title":"Remove products from a collection","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/collections/{collection_id}/products","href":"/api-reference/admin-api/collections/remove-products-from-a-collection"},{"title":"Reposition a collection product","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/collections/{collection_id}/products/{id}/reposition","href":"/api-reference/admin-api/collections/reposition-a-collection-product"},{"title":"List available collection rule types","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/collection_rules/types","href":"/api-reference/admin-api/collections/list-available-collection-rule-types"},{"title":"List collection custom fields","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/collections/{collection_id}/custom_fields","href":"/api-reference/admin-api/collections/list-collection-custom-fields"}]},{"group":"Commission Lines","pages":[{"title":"List commission lines","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/commission_lines","href":"/api-reference/admin-api/commission-lines/list-commission-lines"},{"title":"Get a commission line","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/commission_lines/{id}","href":"/api-reference/admin-api/commission-lines/get-a-commission-line"}]},{"group":"Commission Rates","pages":[{"title":"List commission rates","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/commission_rates","href":"/api-reference/admin-api/commission-rates/list-commission-rates"},{"title":"Create a commission rate","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/commission_rates","href":"/api-reference/admin-api/commission-rates/create-a-commission-rate"},{"title":"List the commission rule kinds","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/commission_rates/rule_types","href":"/api-reference/admin-api/commission-rates/list-the-commission-rule-kinds"},{"title":"Get a commission rate","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/commission_rates/{id}","href":"/api-reference/admin-api/commission-rates/get-a-commission-rate"},{"title":"Delete a commission rate","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/commission_rates/{id}","href":"/api-reference/admin-api/commission-rates/delete-a-commission-rate"},{"title":"Update a commission rate","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/commission_rates/{id}","href":"/api-reference/admin-api/commission-rates/update-a-commission-rate"}]},{"group":"Companies","pages":[{"title":"List company addresses","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/companies/{company_id}/addresses","href":"/api-reference/admin-api/companies/list-company-addresses"},{"title":"Create a company address","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/companies/{company_id}/addresses","href":"/api-reference/admin-api/companies/create-a-company-address"},{"title":"Update a company address","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/companies/{company_id}/addresses/{id}","href":"/api-reference/admin-api/companies/update-a-company-address"},{"title":"List company invitations","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/companies/{company_id}/invitations","href":"/api-reference/admin-api/companies/list-company-invitations"},{"title":"List company members","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/companies/{company_id}/memberships","href":"/api-reference/admin-api/companies/list-company-members"},{"title":"Add a member by email","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/companies/{company_id}/memberships","href":"/api-reference/admin-api/companies/add-a-member-by-email"},{"title":"List tax exemption certificates","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/companies/{company_id}/tax_exemption_certificates","href":"/api-reference/admin-api/companies/list-tax-exemption-certificates"},{"title":"Create a tax exemption certificate","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/companies/{company_id}/tax_exemption_certificates","href":"/api-reference/admin-api/companies/create-a-tax-exemption-certificate"},{"title":"Update a tax exemption certificate","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/companies/{company_id}/tax_exemption_certificates/{id}","href":"/api-reference/admin-api/companies/update-a-tax-exemption-certificate"},{"title":"Verify a tax exemption certificate","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/companies/{company_id}/tax_exemption_certificates/{id}/verify","href":"/api-reference/admin-api/companies/verify-a-tax-exemption-certificate"},{"title":"Revoke a tax exemption certificate","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/companies/{company_id}/tax_exemption_certificates/{id}/revoke","href":"/api-reference/admin-api/companies/revoke-a-tax-exemption-certificate"},{"title":"Download a certificate document","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/companies/{company_id}/tax_exemption_certificates/{id}/download","href":"/api-reference/admin-api/companies/download-a-certificate-document"},{"title":"List company tax registrations","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/companies/{company_id}/tax_identifiers","href":"/api-reference/admin-api/companies/list-company-tax-registrations"},{"title":"Create a company tax registration","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/companies/{company_id}/tax_identifiers","href":"/api-reference/admin-api/companies/create-a-company-tax-registration"},{"title":"Re-check a company tax registration","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/companies/{company_id}/tax_identifiers/{id}/validate","href":"/api-reference/admin-api/companies/re-check-a-company-tax-registration"},{"title":"List companies","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/companies","href":"/api-reference/admin-api/companies/list-companies"},{"title":"Create a company","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/companies","href":"/api-reference/admin-api/companies/create-a-company"},{"title":"Update a company","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/companies/{id}","href":"/api-reference/admin-api/companies/update-a-company"},{"title":"List company custom fields","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/companies/{company_id}/custom_fields","href":"/api-reference/admin-api/companies/list-company-custom-fields"}]},{"group":"Custom Field Definitions","pages":[{"title":"List what custom fields can be attached to","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/custom_field_definitions/resource_types","href":"/api-reference/admin-api/custom-field-definitions/list-what-custom-fields-can-be-attached-to"}]},{"group":"Sellers","pages":[{"title":"List seller custom fields","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/sellers/{seller_id}/custom_fields","href":"/api-reference/admin-api/sellers/list-seller-custom-fields"},{"title":"List a seller's requirement submissions","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/sellers/{seller_id}/requirement_submissions","href":"/api-reference/admin-api/sellers/list-a-sellers-requirement-submissions"},{"title":"Waive a requirement for a seller","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/sellers/{seller_id}/requirement_submissions","href":"/api-reference/admin-api/sellers/waive-a-requirement-for-a-seller"},{"title":"Accept a seller's submission","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/sellers/{seller_id}/requirement_submissions/{id}/accept","href":"/api-reference/admin-api/sellers/accept-a-sellers-submission"},{"title":"Reject a seller's submission","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/sellers/{seller_id}/requirement_submissions/{id}/reject","href":"/api-reference/admin-api/sellers/reject-a-sellers-submission"},{"title":"List sellers","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/sellers","href":"/api-reference/admin-api/sellers/list-sellers"},{"title":"Create a seller","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/sellers","href":"/api-reference/admin-api/sellers/create-a-seller"},{"title":"Get a seller","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/sellers/{id}","href":"/api-reference/admin-api/sellers/get-a-seller"},{"title":"Delete a seller","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/sellers/{id}","href":"/api-reference/admin-api/sellers/delete-a-seller"},{"title":"Update a seller","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/sellers/{id}","href":"/api-reference/admin-api/sellers/update-a-seller"},{"title":"Invite someone to run a seller","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/sellers/{id}/invite","href":"/api-reference/admin-api/sellers/invite-someone-to-run-a-seller"},{"title":"Approve a seller","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/sellers/{id}/approve","href":"/api-reference/admin-api/sellers/approve-a-seller"},{"title":"Send a seller back to onboarding","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/sellers/{id}/reopen_onboarding","href":"/api-reference/admin-api/sellers/send-a-seller-back-to-onboarding"},{"title":"Suspend a seller","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/sellers/{id}/suspend","href":"/api-reference/admin-api/sellers/suspend-a-seller"},{"title":"Reject a seller","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/sellers/{id}/reject","href":"/api-reference/admin-api/sellers/reject-a-seller"},{"title":"List a seller's balances","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/sellers/{seller_id}/balances","href":"/api-reference/admin-api/sellers/list-a-sellers-balances"},{"title":"Settle a seller","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/sellers/{seller_id}/payouts","href":"/api-reference/admin-api/sellers/settle-a-seller"},{"title":"List seller transfers","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/seller_transfers","href":"/api-reference/admin-api/sellers/list-seller-transfers"},{"title":"List seller payouts","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/seller_payouts","href":"/api-reference/admin-api/sellers/list-seller-payouts"},{"title":"Mark a payout paid","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/seller_payouts/{id}/complete","href":"/api-reference/admin-api/sellers/mark-a-payout-paid"}]},{"group":"Stock Transfers","pages":[{"title":"List stock transfer custom fields","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/stock_transfers/{stock_transfer_id}/custom_fields","href":"/api-reference/admin-api/stock-transfers/list-stock-transfer-custom-fields"},{"title":"List stock transfers","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/stock_transfers","href":"/api-reference/admin-api/stock-transfers/list-stock-transfers"},{"title":"Create a stock transfer","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/stock_transfers","href":"/api-reference/admin-api/stock-transfers/create-a-stock-transfer"},{"title":"Get a stock transfer","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/stock_transfers/{id}","href":"/api-reference/admin-api/stock-transfers/get-a-stock-transfer"},{"title":"Delete a stock transfer","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/stock_transfers/{id}","href":"/api-reference/admin-api/stock-transfers/delete-a-stock-transfer"},{"title":"Update a stock transfer","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/stock_transfers/{id}","href":"/api-reference/admin-api/stock-transfers/update-a-stock-transfer"},{"title":"Mark a transfer ready to ship","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/stock_transfers/{id}/mark_ready","href":"/api-reference/admin-api/stock-transfers/mark-a-transfer-ready-to-ship"},{"title":"Send a transfer","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/stock_transfers/{id}/mark_in_transit","href":"/api-reference/admin-api/stock-transfers/send-a-transfer"},{"title":"List the deliveries counted in against a transfer","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/stock_transfers/{stock_transfer_id}/stock_receipts","href":"/api-reference/admin-api/stock-transfers/list-the-deliveries-counted-in-against-a-transfer"},{"title":"Count a delivery in","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/stock_transfers/{stock_transfer_id}/stock_receipts","href":"/api-reference/admin-api/stock-transfers/count-a-delivery-in"},{"title":"Take a transfer back to draft","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/stock_transfers/{id}/mark_draft","href":"/api-reference/admin-api/stock-transfers/take-a-transfer-back-to-draft"},{"title":"Close a transfer short","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/stock_transfers/{id}/close","href":"/api-reference/admin-api/stock-transfers/close-a-transfer-short"},{"title":"Cancel a stock transfer","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/stock_transfers/{id}/cancel","href":"/api-reference/admin-api/stock-transfers/cancel-a-stock-transfer"}]},{"group":"Purchase Orders","pages":[{"title":"List purchase order custom fields","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/purchase_orders/{purchase_order_id}/custom_fields","href":"/api-reference/admin-api/purchase-orders/list-purchase-order-custom-fields"},{"title":"List purchase orders","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/purchase_orders","href":"/api-reference/admin-api/purchase-orders/list-purchase-orders"},{"title":"Create a purchase order","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/purchase_orders","href":"/api-reference/admin-api/purchase-orders/create-a-purchase-order"},{"title":"Get a purchase order","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/purchase_orders/{id}","href":"/api-reference/admin-api/purchase-orders/get-a-purchase-order"},{"title":"Update a purchase order","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/purchase_orders/{id}","href":"/api-reference/admin-api/purchase-orders/update-a-purchase-order"},{"title":"Place the order with the supplier","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/purchase_orders/{id}/mark_ordered","href":"/api-reference/admin-api/purchase-orders/place-the-order-with-the-supplier"},{"title":"List the deliveries booked against an order","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/purchase_orders/{purchase_order_id}/stock_receipts","href":"/api-reference/admin-api/purchase-orders/list-the-deliveries-booked-against-an-order"},{"title":"Book in a delivery","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/purchase_orders/{purchase_order_id}/stock_receipts","href":"/api-reference/admin-api/purchase-orders/book-in-a-delivery"},{"title":"Take an order back to draft","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/purchase_orders/{id}/mark_draft","href":"/api-reference/admin-api/purchase-orders/take-an-order-back-to-draft"},{"title":"Close an order short","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/purchase_orders/{id}/close","href":"/api-reference/admin-api/purchase-orders/close-an-order-short"},{"title":"Cancel a purchase order","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/purchase_orders/{id}/cancel","href":"/api-reference/admin-api/purchase-orders/cancel-a-purchase-order"}]},{"group":"Delivery","pages":[{"title":"List delivery method custom fields","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/delivery_methods/{delivery_method_id}/custom_fields","href":"/api-reference/admin-api/delivery/list-delivery-method-custom-fields"},{"title":"List delivery profiles","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/delivery_profiles","href":"/api-reference/admin-api/delivery/list-delivery-profiles"},{"title":"Create a delivery profile","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/delivery_profiles","href":"/api-reference/admin-api/delivery/create-a-delivery-profile"},{"title":"List origin groups","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/delivery_profiles/{delivery_profile_id}/origin_groups","href":"/api-reference/admin-api/delivery/list-origin-groups"},{"title":"Create an origin group","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/delivery_profiles/{delivery_profile_id}/origin_groups","href":"/api-reference/admin-api/delivery/create-an-origin-group"},{"title":"Delete a delivery profile","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/delivery_profiles/{id}","href":"/api-reference/admin-api/delivery/delete-a-delivery-profile"},{"title":"Update a delivery profile","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/delivery_profiles/{id}","href":"/api-reference/admin-api/delivery/update-a-delivery-profile"},{"title":"List delivery methods","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/delivery_methods","href":"/api-reference/admin-api/delivery/list-delivery-methods"},{"title":"Create delivery method","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/delivery_methods","href":"/api-reference/admin-api/delivery/create-delivery-method"},{"title":"Update delivery method","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/delivery_methods/{id}","href":"/api-reference/admin-api/delivery/update-delivery-method"},{"title":"List delivery calculators","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/delivery_methods/calculators","href":"/api-reference/admin-api/delivery/list-delivery-calculators"},{"title":"List delivery zones","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/delivery_zones","href":"/api-reference/admin-api/delivery/list-delivery-zones"},{"title":"Create delivery zone","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/delivery_zones","href":"/api-reference/admin-api/delivery/create-delivery-zone"},{"title":"Update delivery zone","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/delivery_zones/{id}","href":"/api-reference/admin-api/delivery/update-delivery-zone"},{"title":"List delivery method rules","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/delivery_methods/{delivery_method_id}/rules","href":"/api-reference/admin-api/delivery/list-delivery-method-rules"},{"title":"Create a delivery method rule","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/delivery_methods/{delivery_method_id}/rules","href":"/api-reference/admin-api/delivery/create-a-delivery-method-rule"},{"title":"Update a delivery method rule","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/delivery_methods/{delivery_method_id}/rules/{id}","href":"/api-reference/admin-api/delivery/update-a-delivery-method-rule"}]},{"group":"Product Types","pages":[{"title":"List product type custom fields","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/product_types/{product_type_id}/custom_fields","href":"/api-reference/admin-api/product-types/list-product-type-custom-fields"},{"title":"List product types","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/product_types","href":"/api-reference/admin-api/product-types/list-product-types"},{"title":"Create a product type","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/product_types","href":"/api-reference/admin-api/product-types/create-a-product-type"},{"title":"Retrieve a product type","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/product_types/{id}","href":"/api-reference/admin-api/product-types/retrieve-a-product-type"},{"title":"Delete a product type","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/product_types/{id}","href":"/api-reference/admin-api/product-types/delete-a-product-type"},{"title":"Update a product type","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/product_types/{id}","href":"/api-reference/admin-api/product-types/update-a-product-type"},{"title":"Apply a product type to its existing products","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/product_types/{id}/apply_to_products","href":"/api-reference/admin-api/product-types/apply-a-product-type-to-its-existing-products"}]},{"group":"Media","pages":[{"title":"List media file custom fields","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/media/{medium_id}/custom_fields","href":"/api-reference/admin-api/media/list-media-file-custom-fields"},{"title":"List media","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/media","href":"/api-reference/admin-api/media/list-media"},{"title":"Upload a file to the library","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/media","href":"/api-reference/admin-api/media/upload-a-file-to-the-library"},{"title":"Update a library file","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/media/{id}","href":"/api-reference/admin-api/media/update-a-library-file"},{"title":"Where a file is used","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/media/{id}/usage","href":"/api-reference/admin-api/media/where-a-file-is-used"},{"title":"List product media","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/products/{product_id}/media","href":"/api-reference/admin-api/media/list-product-media"},{"title":"Place a library file on a product","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/products/{product_id}/media","href":"/api-reference/admin-api/media/place-a-library-file-on-a-product"},{"title":"Update product media","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/products/{product_id}/media/{id}","href":"/api-reference/admin-api/media/update-product-media"},{"title":"List variant media","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/products/{product_id}/variants/{variant_id}/media","href":"/api-reference/admin-api/media/list-variant-media"}]},{"group":"Integrations","pages":[{"title":"List integrations","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/integrations","href":"/api-reference/admin-api/integrations/list-integrations"},{"title":"Connect integration","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/integrations","href":"/api-reference/admin-api/integrations/connect-integration"},{"title":"List integration types","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/integrations/types","href":"/api-reference/admin-api/integrations/list-integration-types"},{"title":"Update integration","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/integrations/{id}","href":"/api-reference/admin-api/integrations/update-integration"},{"title":"Test integration connection","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/integrations/{id}/test","href":"/api-reference/admin-api/integrations/test-integration-connection"}]},{"group":"OAuth","pages":[{"title":"List connected applications","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/oauth/applications","href":"/api-reference/admin-api/oauth/list-connected-applications"},{"title":"Register an application","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/oauth/applications","href":"/api-reference/admin-api/oauth/register-an-application"},{"title":"Remove an application","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/oauth/applications/{id}","href":"/api-reference/admin-api/oauth/remove-an-application"},{"title":"Update an application","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/oauth/applications/{id}","href":"/api-reference/admin-api/oauth/update-an-application"},{"title":"List who is connected","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/oauth/applications/{application_id}/tokens","href":"/api-reference/admin-api/oauth/list-who-is-connected"},{"title":"Revoke one person's access","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/oauth/applications/{application_id}/tokens/{id}","href":"/api-reference/admin-api/oauth/revoke-one-persons-access"},{"title":"Describe what a client is asking for","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/oauth/authorize","href":"/api-reference/admin-api/oauth/describe-what-a-client-is-asking-for"},{"title":"Approve a request","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/oauth/authorize","href":"/api-reference/admin-api/oauth/approve-a-request"},{"title":"Turn a request down","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/oauth/authorize","href":"/api-reference/admin-api/oauth/turn-a-request-down"},{"title":"Discover the authorization server","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/oauth/protected-resource/{resource_key}","href":"/api-reference/admin-api/oauth/discover-the-authorization-server"}]},{"group":"Deliveries","pages":[{"title":"List deliveries","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/orders/{order_id}/fulfillments/{fulfillment_id}/deliveries","href":"/api-reference/admin-api/deliveries/list-deliveries"},{"title":"Record a delivery","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/orders/{order_id}/fulfillments/{fulfillment_id}/deliveries","href":"/api-reference/admin-api/deliveries/record-a-delivery"},{"title":"Delete a delivery","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/orders/{order_id}/fulfillments/{fulfillment_id}/deliveries/{id}","href":"/api-reference/admin-api/deliveries/delete-a-delivery"},{"title":"Correct a delivery","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/fulfillments/{fulfillment_id}/deliveries/{id}","href":"/api-reference/admin-api/deliveries/correct-a-delivery"},{"title":"Mark a delivery delivered","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/fulfillments/{fulfillment_id}/deliveries/{id}/mark_delivered","href":"/api-reference/admin-api/deliveries/mark-a-delivery-delivered"}]},{"group":"Shipping Labels","pages":[{"title":"List shipping labels","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/orders/{order_id}/fulfillments/{fulfillment_id}/labels","href":"/api-reference/admin-api/shipping-labels/list-shipping-labels"},{"title":"Buy or record a shipping label","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/orders/{order_id}/fulfillments/{fulfillment_id}/labels","href":"/api-reference/admin-api/shipping-labels/buy-or-record-a-shipping-label"},{"title":"Get a shipping label","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/orders/{order_id}/fulfillments/{fulfillment_id}/labels/{id}","href":"/api-reference/admin-api/shipping-labels/get-a-shipping-label"},{"title":"Delete an uploaded label","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/orders/{order_id}/fulfillments/{fulfillment_id}/labels/{id}","href":"/api-reference/admin-api/shipping-labels/delete-an-uploaded-label"},{"title":"Refund a shipping label","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/fulfillments/{fulfillment_id}/labels/{id}/refund","href":"/api-reference/admin-api/shipping-labels/refund-a-shipping-label"}]},{"group":"Package Types","pages":[{"title":"List package types","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/package_types","href":"/api-reference/admin-api/package-types/list-package-types"},{"title":"Create a package type","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/package_types","href":"/api-reference/admin-api/package-types/create-a-package-type"},{"title":"Get a package type","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/package_types/{id}","href":"/api-reference/admin-api/package-types/get-a-package-type"},{"title":"Delete a package type","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/package_types/{id}","href":"/api-reference/admin-api/package-types/delete-a-package-type"},{"title":"Update a package type","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/package_types/{id}","href":"/api-reference/admin-api/package-types/update-a-package-type"}]},{"group":"Price Lists","pages":[{"title":"List price list products","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/price_lists/{price_list_id}/products","href":"/api-reference/admin-api/price-lists/list-price-list-products"},{"title":"Add products to a price list","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/price_lists/{price_list_id}/products","href":"/api-reference/admin-api/price-lists/add-products-to-a-price-list"},{"title":"Remove products from a price list","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/price_lists/{price_list_id}/products","href":"/api-reference/admin-api/price-lists/remove-products-from-a-price-list"}]},{"group":"Reports","pages":[{"title":"List saved reports","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/reporting/saved_reports","href":"/api-reference/admin-api/reports/list-saved-reports"},{"title":"Create a saved report","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/reporting/saved_reports","href":"/api-reference/admin-api/reports/create-a-saved-report"},{"title":"Update a saved report","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/reporting/saved_reports/{id}","href":"/api-reference/admin-api/reports/update-a-saved-report"},{"title":"Run a reporting query","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/reporting/query","href":"/api-reference/admin-api/reports/run-a-reporting-query"}]},{"group":"Seller Requirements","pages":[{"title":"List seller requirements","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/seller_requirements","href":"/api-reference/admin-api/seller-requirements/list-seller-requirements"},{"title":"Add a seller requirement","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/seller_requirements","href":"/api-reference/admin-api/seller-requirements/add-a-seller-requirement"},{"title":"List seller requirement kinds","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/seller_requirements/types","href":"/api-reference/admin-api/seller-requirements/list-seller-requirement-kinds"},{"title":"Delete a seller requirement","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/seller_requirements/{id}","href":"/api-reference/admin-api/seller-requirements/delete-a-seller-requirement"},{"title":"Update a seller requirement","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/seller_requirements/{id}","href":"/api-reference/admin-api/seller-requirements/update-a-seller-requirement"}]},{"group":"Stock","pages":[{"title":"List stock levels","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/stock_levels","href":"/api-reference/admin-api/stock/list-stock-levels"},{"title":"Bulk-upsert stock levels","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/stock_levels/bulk_upsert","href":"/api-reference/admin-api/stock/bulk-upsert-stock-levels"},{"title":"Update a stock level","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/stock_levels/{id}","href":"/api-reference/admin-api/stock/update-a-stock-level"},{"title":"List stock reservations","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/stock_reservations","href":"/api-reference/admin-api/stock/list-stock-reservations"}]},{"group":"Stock Movements","pages":[{"title":"List stock movements","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/stock_movements","href":"/api-reference/admin-api/stock-movements/list-stock-movements"},{"title":"Get a stock movement","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/stock_movements/{id}","href":"/api-reference/admin-api/stock-movements/get-a-stock-movement"}]},{"group":"Suppliers","pages":[{"title":"List suppliers","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/suppliers","href":"/api-reference/admin-api/suppliers/list-suppliers"},{"title":"Create a supplier","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/suppliers","href":"/api-reference/admin-api/suppliers/create-a-supplier"},{"title":"Get a supplier","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/suppliers/{id}","href":"/api-reference/admin-api/suppliers/get-a-supplier"},{"title":"Delete a supplier","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/suppliers/{id}","href":"/api-reference/admin-api/suppliers/delete-a-supplier"},{"title":"Update a supplier","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/suppliers/{id}","href":"/api-reference/admin-api/suppliers/update-a-supplier"}]}]}]},{"item":"Seller API","icon":"shop","description":"REST API for the marketplace seller panel","pages":[{"title":"Seller API","href":"/api-reference/seller-api/introduction"}]},{"item":"Webhooks","icon":"webhook","description":"Event payloads and delivery reference","pages":[{"title":"Webhooks","href":"/api-reference/webhooks-events"}]}]},{"tab":"User Guide","pages":[{"title":"User Guide","href":"/user/what-is-spree-commerce"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},{"version":"v5.x","tabs":[{"tab":"Guides","menu":[{"item":"Getting Started","icon":"rocket","description":"Quickstart guide and core concepts","pages":[{"title":"Getting Started","href":"/v5/developer/getting-started/quickstart"}]},{"item":"Building a Storefront","icon":"store","description":"Next.js, custom frontend, or Rails engine","pages":[{"title":"Building a Storefront","href":"/v5/developer/storefront/nextjs/quickstart"}]},{"item":"Use Cases","icon":"book-open","description":"Multi-store/multi-tenant, and marketplace setups","pages":[{"title":"Use Cases","href":"/v5/developer/multi-tenant/quickstart"}]}],"pages":[{"title":"Guides","href":"/v5/developer/getting-started/quickstart"}]},{"tab":"Framework","menu":[{"item":"Extending","icon":"puzzle","description":"Customize admin panel, API, and business logic","pages":[{"title":"Extending","href":"/v5/developer/tutorial/introduction"}]},{"item":"How-to Guides","icon":"book-open","description":"Step-by-step guides for common tasks","pages":[{"title":"How-to Guides","href":"/v5/developer/how-to/custom-order-routing"}]},{"item":"Operations","icon":"server","description":"Deploy, upgrade, and maintain your store","pages":[{"title":"Operations","href":"/v5/developer/deployment/quickstart"}]}],"pages":[{"title":"Framework","href":"/v5/developer/tutorial/introduction"}]},{"tab":"SDK \u0026 Tools","menu":[{"item":"Store SDK","icon":"code","description":"TypeScript SDK for the Store API","pages":[{"title":"Store SDK","href":"/v5/developer/sdk/quickstart"}]},{"item":"Admin SDK","icon":"shield-check","description":"TypeScript SDK for the Admin API","pages":[{"title":"Admin SDK","href":"/v5/developer/sdk/admin/quickstart"}]},{"item":"CLI","icon":"square-terminal","description":"Command-line interface for Spree","pages":[{"title":"CLI","href":"/v5/developer/cli/quickstart"}]},{"item":"create-spree-app","icon":"rocket","description":"Scaffold a new Spree project","pages":[{"title":"create-spree-app","href":"/v5/developer/create-spree-app/quickstart"}]},{"item":"Agentic Development","icon":"bot","description":"Build Spree with AI coding agents","pages":[{"title":"Agentic Development","href":"/v5/developer/agentic/overview"}]}],"pages":[{"title":"SDK \u0026 Tools","href":"/v5/developer/sdk/quickstart"}]},{"tab":"API Reference","menu":[{"item":"Store API","icon":"store","description":"REST API for storefronts and custom integrations","pages":[{"title":"Store API","href":"/api-reference/store-api/introduction"}]},{"item":"Admin API","icon":"shield","description":"REST API for pragmatically managing stores","groups":[{"group":"API basics","pages":[{"title":"Spree Admin API introduction and SDK quick start","sidebarTitle":"Introduction","href":"/api-reference/admin-api/introduction"},{"title":"Authenticate Admin API requests with keys and JWTs","sidebarTitle":"Authentication","href":"/api-reference/admin-api/authentication"},{"title":"Admin API error responses, status codes, and handling","href":"/api-reference/admin-api/errors"},{"title":"Filter, sort, paginate, and expand Admin API responses","sidebarTitle":"Querying","href":"/api-reference/admin-api/querying"},{"title":"Monetary amounts in the Admin API: prices, costs, formats","sidebarTitle":"Monetary Amounts","href":"/api-reference/admin-api/monetary-amounts"},{"title":"Uploading files to the Admin and Seller APIs","sidebarTitle":"Uploads","href":"/api-reference/admin-api/uploads"},{"title":"Admin API endpoint index","sidebarTitle":"Endpoint index","href":"/api-reference/admin-api/endpoints"}]},{"group":"Endpoints","pages":[{"group":"Authentication","pages":[{"title":"Login","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/auth/login","href":"/api-reference/admin-api/authentication/login"},{"title":"Refresh token","description":"Exchanges the HttpOnly refresh-token cookie for a new access JWT and a\nrotated refresh token cookie. No request body or Authorization header\nis required — the cookie alone authenticates the call.\n","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/auth/refresh","href":"/api-reference/admin-api/authentication/refresh-token"},{"title":"Logout","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/auth/logout","href":"/api-reference/admin-api/authentication/logout"},{"title":"Accept an invitation","description":"Accepts a staff invitation and returns a signed-in admin session, so the\nnew member lands in the dashboard rather than on a login form.\n\nUnauthenticated — the ID and token in the emailed link are the\ncredential. The email is never taken from the request; it always comes\nfrom the invitation.\n\n`password` is required when no account exists for the invited address,\nin which case it sets one. When an account already exists, the same\nfield is how the person proves the account is theirs.\n","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/auth/invitations/{id}/accept","href":"/api-reference/admin-api/authentication/accept-an-invitation"},{"title":"Get current admin user and permissions","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/me","href":"/api-reference/admin-api/authentication/get-current-admin-user-and-permissions"},{"title":"Update the current admin profile","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/me","href":"/api-reference/admin-api/authentication/update-the-current-admin-profile"},{"title":"Request password reset","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/auth/password_resets","href":"/api-reference/admin-api/authentication/request-password-reset"},{"title":"Reset password","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/auth/password_resets/{id}","href":"/api-reference/admin-api/authentication/reset-password"},{"title":"Check first-run setup availability","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/auth/setup","href":"/api-reference/admin-api/authentication/check-first-run-setup-availability"},{"title":"Complete first-run setup","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/auth/setup","href":"/api-reference/admin-api/authentication/complete-first-run-setup"},{"title":"List countries for first-run setup","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/auth/setup/countries","href":"/api-reference/admin-api/authentication/list-countries-for-first-run-setup"}]},{"group":"Allowed Origins","pages":[{"title":"List allowed origins","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/allowed_origins","href":"/api-reference/admin-api/allowed-origins/list-allowed-origins"},{"title":"Create an allowed origin","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/allowed_origins","href":"/api-reference/admin-api/allowed-origins/create-an-allowed-origin"},{"title":"Get an allowed origin","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/allowed_origins/{id}","href":"/api-reference/admin-api/allowed-origins/get-an-allowed-origin"},{"title":"Delete an allowed origin","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/allowed_origins/{id}","href":"/api-reference/admin-api/allowed-origins/delete-an-allowed-origin"},{"title":"Update an allowed origin","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/allowed_origins/{id}","href":"/api-reference/admin-api/allowed-origins/update-an-allowed-origin"}]},{"group":"API Keys","pages":[{"title":"List API keys","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/api_keys","href":"/api-reference/admin-api/api-keys/list-api-keys"},{"title":"Create an API key","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/api_keys","href":"/api-reference/admin-api/api-keys/create-an-api-key"},{"title":"Show an API key","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/api_keys/{id}","href":"/api-reference/admin-api/api-keys/show-an-api-key"},{"title":"Delete an API key","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/api_keys/{id}","href":"/api-reference/admin-api/api-keys/delete-an-api-key"},{"title":"Update an API key","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/api_keys/{id}","href":"/api-reference/admin-api/api-keys/update-an-api-key"},{"title":"Describe the current API key","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/api_keys/current","href":"/api-reference/admin-api/api-keys/describe-the-current-api-key"},{"title":"Revoke an API key","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/api_keys/{id}/revoke","href":"/api-reference/admin-api/api-keys/revoke-an-api-key"}]},{"group":"Categories","pages":[{"title":"List categories","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/categories","href":"/api-reference/admin-api/categories/list-categories"},{"title":"Create a category","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/categories","href":"/api-reference/admin-api/categories/create-a-category"},{"title":"Get a category","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/categories/{id}","href":"/api-reference/admin-api/categories/get-a-category"},{"title":"Delete a category","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/categories/{id}","href":"/api-reference/admin-api/categories/delete-a-category"},{"title":"Update a category","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/categories/{id}","href":"/api-reference/admin-api/categories/update-a-category"},{"title":"Reposition a category","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/categories/{id}/reposition","href":"/api-reference/admin-api/categories/reposition-a-category"},{"title":"List category products","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/categories/{category_id}/products","href":"/api-reference/admin-api/categories/list-category-products"},{"title":"Add products to a category","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/categories/{category_id}/products","href":"/api-reference/admin-api/categories/add-products-to-a-category"},{"title":"Remove products from a category","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/categories/{category_id}/products","href":"/api-reference/admin-api/categories/remove-products-from-a-category"},{"title":"Reposition a category product","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/categories/{category_id}/products/{id}/reposition","href":"/api-reference/admin-api/categories/reposition-a-category-product"},{"title":"List category custom fields","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/categories/{category_id}/custom_fields","href":"/api-reference/admin-api/categories/list-category-custom-fields"}]},{"group":"Channels","pages":[{"title":"List channels","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/channels","href":"/api-reference/admin-api/channels/list-channels"},{"title":"Create a channel","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/channels","href":"/api-reference/admin-api/channels/create-a-channel"},{"title":"Get a channel","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/channels/{id}","href":"/api-reference/admin-api/channels/get-a-channel"},{"title":"Delete a channel","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/channels/{id}","href":"/api-reference/admin-api/channels/delete-a-channel"},{"title":"Update a channel","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/channels/{id}","href":"/api-reference/admin-api/channels/update-a-channel"},{"title":"Publish products on a channel","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/channels/{id}/add_products","href":"/api-reference/admin-api/channels/publish-products-on-a-channel"},{"title":"Unpublish products from a channel","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/channels/{id}/remove_products","href":"/api-reference/admin-api/channels/unpublish-products-from-a-channel"},{"title":"List order routing rules for a channel","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/channels/{channel_id}/order_routing_rules","href":"/api-reference/admin-api/channels/list-order-routing-rules-for-a-channel"},{"title":"Create an order routing rule on a channel","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/channels/{channel_id}/order_routing_rules","href":"/api-reference/admin-api/channels/create-an-order-routing-rule-on-a-channel"},{"title":"Delete an order routing rule","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/channels/{channel_id}/order_routing_rules/{id}","href":"/api-reference/admin-api/channels/delete-an-order-routing-rule"},{"title":"Update an order routing rule","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/channels/{channel_id}/order_routing_rules/{id}","href":"/api-reference/admin-api/channels/update-an-order-routing-rule"},{"title":"List available order routing rule types","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/order_routing_rules/types","href":"/api-reference/admin-api/channels/list-available-order-routing-rule-types"}]},{"group":"Custom Fields","pages":[{"title":"List custom field definitions","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/custom_field_definitions","href":"/api-reference/admin-api/custom-fields/list-custom-field-definitions"},{"title":"Create a custom field definition","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/custom_field_definitions","href":"/api-reference/admin-api/custom-fields/create-a-custom-field-definition"},{"title":"Show a custom field definition","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/custom_field_definitions/{id}","href":"/api-reference/admin-api/custom-fields/show-a-custom-field-definition"},{"title":"Delete a custom field definition","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/custom_field_definitions/{id}","href":"/api-reference/admin-api/custom-fields/delete-a-custom-field-definition"},{"title":"Update a custom field definition","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/custom_field_definitions/{id}","href":"/api-reference/admin-api/custom-fields/update-a-custom-field-definition"}]},{"group":"Customer Groups","pages":[{"title":"List customer groups","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/customer_groups","href":"/api-reference/admin-api/customer-groups/list-customer-groups"},{"title":"Create a customer group","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/customer_groups","href":"/api-reference/admin-api/customer-groups/create-a-customer-group"},{"title":"Get a customer group","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/customer_groups/{id}","href":"/api-reference/admin-api/customer-groups/get-a-customer-group"},{"title":"Delete a customer group","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/customer_groups/{id}","href":"/api-reference/admin-api/customer-groups/delete-a-customer-group"},{"title":"Update a customer group","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/customer_groups/{id}","href":"/api-reference/admin-api/customer-groups/update-a-customer-group"}]},{"group":"Customers","pages":[{"title":"List customer custom fields","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/customers/{customer_id}/custom_fields","href":"/api-reference/admin-api/customers/list-customer-custom-fields"},{"title":"Export a customer's personal data","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/customers/{id}/export","href":"/api-reference/admin-api/customers/export-a-customers-personal-data"},{"title":"Erase a customer's personal data","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/customers/{id}/anonymize","href":"/api-reference/admin-api/customers/erase-a-customers-personal-data"},{"title":"List consent records","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/consent_records","href":"/api-reference/admin-api/customers/list-consent-records"},{"title":"List data requests","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/data_requests","href":"/api-reference/admin-api/customers/list-data-requests"},{"title":"Record a data request","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/data_requests","href":"/api-reference/admin-api/customers/record-a-data-request"},{"title":"List customer addresses","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/customers/{customer_id}/addresses","href":"/api-reference/admin-api/customers/list-customer-addresses"},{"title":"Create a customer address","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/customers/{customer_id}/addresses","href":"/api-reference/admin-api/customers/create-a-customer-address"},{"title":"Delete a customer address","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/customers/{customer_id}/addresses/{id}","href":"/api-reference/admin-api/customers/delete-a-customer-address"},{"title":"Update a customer address","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/customers/{customer_id}/addresses/{id}","href":"/api-reference/admin-api/customers/update-a-customer-address"},{"title":"List customer credit cards","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/customers/{customer_id}/credit_cards","href":"/api-reference/admin-api/customers/list-customer-credit-cards"},{"title":"Show a customer credit card","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/customers/{customer_id}/credit_cards/{id}","href":"/api-reference/admin-api/customers/show-a-customer-credit-card"},{"title":"Delete a customer credit card","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/customers/{customer_id}/credit_cards/{id}","href":"/api-reference/admin-api/customers/delete-a-customer-credit-card"},{"title":"List customer store credits","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/customers/{customer_id}/store_credits","href":"/api-reference/admin-api/customers/list-customer-store-credits"},{"title":"Issue a store credit to a customer","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/customers/{customer_id}/store_credits","href":"/api-reference/admin-api/customers/issue-a-store-credit-to-a-customer"},{"title":"Delete a store credit","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/customers/{customer_id}/store_credits/{id}","href":"/api-reference/admin-api/customers/delete-a-store-credit"},{"title":"Update a store credit","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/customers/{customer_id}/store_credits/{id}","href":"/api-reference/admin-api/customers/update-a-store-credit"},{"title":"List customer tax registrations","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/customers/{customer_id}/tax_identifiers","href":"/api-reference/admin-api/customers/list-customer-tax-registrations"},{"title":"Update a customer tax registration","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/customers/{customer_id}/tax_identifiers/{id}","href":"/api-reference/admin-api/customers/update-a-customer-tax-registration"},{"title":"List customers","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/customers","href":"/api-reference/admin-api/customers/list-customers"},{"title":"Create a customer","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/customers","href":"/api-reference/admin-api/customers/create-a-customer"},{"title":"Show a customer","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/customers/{id}","href":"/api-reference/admin-api/customers/show-a-customer"},{"title":"Delete a customer","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/customers/{id}","href":"/api-reference/admin-api/customers/delete-a-customer"},{"title":"Update a customer","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/customers/{id}","href":"/api-reference/admin-api/customers/update-a-customer"},{"title":"Bulk-add customers to groups","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/customers/bulk_add_to_groups","href":"/api-reference/admin-api/customers/bulk-add-customers-to-groups"},{"title":"Bulk-remove customers from groups","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/customers/bulk_remove_from_groups","href":"/api-reference/admin-api/customers/bulk-remove-customers-from-groups"},{"title":"Bulk-add tags to customers","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/customers/bulk_add_tags","href":"/api-reference/admin-api/customers/bulk-add-tags-to-customers"},{"title":"Bulk-remove tags from customers","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/customers/bulk_remove_tags","href":"/api-reference/admin-api/customers/bulk-remove-tags-from-customers"}]},{"group":"Email Templates","pages":[{"title":"List email templates","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/email_templates","href":"/api-reference/admin-api/email-templates/list-email-templates"},{"title":"Get an email template","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/email_templates/{id}","href":"/api-reference/admin-api/email-templates/get-an-email-template"},{"title":"Revert an email template to Spree's default","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/email_templates/{id}","href":"/api-reference/admin-api/email-templates/revert-an-email-template-to-sprees-default"},{"title":"Save an email template draft","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml put /api/v3/admin/email_templates/{email_template_id}/draft","href":"/api-reference/admin-api/email-templates/save-an-email-template-draft"},{"title":"Discard an email template draft","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/email_templates/{email_template_id}/draft","href":"/api-reference/admin-api/email-templates/discard-an-email-template-draft"},{"title":"Publish an email template draft","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/email_templates/{email_template_id}/publication","href":"/api-reference/admin-api/email-templates/publish-an-email-template-draft"},{"title":"Preview an email template","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/email_templates/{email_template_id}/preview","href":"/api-reference/admin-api/email-templates/preview-an-email-template"},{"title":"Send a test email","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/email_templates/{email_template_id}/test_email","href":"/api-reference/admin-api/email-templates/send-a-test-email"},{"title":"List records to preview an email template with","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/email_templates/{email_template_id}/sample_records","href":"/api-reference/admin-api/email-templates/list-records-to-preview-an-email-template-with"},{"title":"List email template revisions","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/email_templates/{email_template_id}/revisions","href":"/api-reference/admin-api/email-templates/list-email-template-revisions"},{"title":"Restore an email template revision","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/email_templates/{email_template_id}/revisions/{revision_id}/restoration","href":"/api-reference/admin-api/email-templates/restore-an-email-template-revision"}]},{"group":"Exports","pages":[{"title":"List exports","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/exports","href":"/api-reference/admin-api/exports/list-exports"},{"title":"Create an export","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/exports","href":"/api-reference/admin-api/exports/create-an-export"},{"title":"Show an export","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/exports/{id}","href":"/api-reference/admin-api/exports/show-an-export"},{"title":"Delete an export","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/exports/{id}","href":"/api-reference/admin-api/exports/delete-an-export"},{"title":"Download an export","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/exports/{id}/download","href":"/api-reference/admin-api/exports/download-an-export"}]},{"group":"Files","pages":[{"title":"Upload a file","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/files","href":"/api-reference/admin-api/files/upload-a-file"}]},{"group":"Fulfillments","pages":[{"title":"List fulfillments","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/orders/{order_id}/fulfillments","href":"/api-reference/admin-api/fulfillments/list-fulfillments"},{"title":"Create a fulfillment","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/orders/{order_id}/fulfillments","href":"/api-reference/admin-api/fulfillments/create-a-fulfillment"},{"title":"Show a shipment","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/orders/{order_id}/fulfillments/{id}","href":"/api-reference/admin-api/fulfillments/show-a-shipment"},{"title":"Update a shipment","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/fulfillments/{id}","href":"/api-reference/admin-api/fulfillments/update-a-shipment"},{"title":"Fulfill a fulfillment","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/fulfillments/{id}/fulfill","href":"/api-reference/admin-api/fulfillments/fulfill-a-fulfillment"},{"title":"Mark a fulfillment delivered","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/fulfillments/{id}/mark_delivered","href":"/api-reference/admin-api/fulfillments/mark-a-fulfillment-delivered"},{"title":"Cancel a fulfillment","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/fulfillments/{id}/cancel","href":"/api-reference/admin-api/fulfillments/cancel-a-fulfillment"},{"title":"Split a fulfillment","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/fulfillments/{id}/split","href":"/api-reference/admin-api/fulfillments/split-a-fulfillment"}]},{"group":"Gift Cards","pages":[{"title":"List gift card custom fields","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/gift_cards/{gift_card_id}/custom_fields","href":"/api-reference/admin-api/gift-cards/list-gift-card-custom-fields"},{"title":"List gift card batches","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/gift_card_batches","href":"/api-reference/admin-api/gift-cards/list-gift-card-batches"},{"title":"Create a gift card batch","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/gift_card_batches","href":"/api-reference/admin-api/gift-cards/create-a-gift-card-batch"},{"title":"Get a gift card batch","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/gift_card_batches/{id}","href":"/api-reference/admin-api/gift-cards/get-a-gift-card-batch"},{"title":"List gift cards","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/gift_cards","href":"/api-reference/admin-api/gift-cards/list-gift-cards"},{"title":"Create a gift card","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/gift_cards","href":"/api-reference/admin-api/gift-cards/create-a-gift-card"},{"title":"Get a gift card","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/gift_cards/{id}","href":"/api-reference/admin-api/gift-cards/get-a-gift-card"},{"title":"Delete a gift card","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/gift_cards/{id}","href":"/api-reference/admin-api/gift-cards/delete-a-gift-card"},{"title":"Update a gift card","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/gift_cards/{id}","href":"/api-reference/admin-api/gift-cards/update-a-gift-card"}]},{"group":"Imports","pages":[{"title":"List imports","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/imports","href":"/api-reference/admin-api/imports/list-imports"},{"title":"Create an import","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/imports","href":"/api-reference/admin-api/imports/create-an-import"},{"title":"Download an import template","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/imports/template","href":"/api-reference/admin-api/imports/download-an-import-template"},{"title":"Download an example import file","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/imports/example","href":"/api-reference/admin-api/imports/download-an-example-import-file"},{"title":"Show an import","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/imports/{id}","href":"/api-reference/admin-api/imports/show-an-import"},{"title":"Delete an import","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/imports/{id}","href":"/api-reference/admin-api/imports/delete-an-import"},{"title":"Download the originally uploaded file","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/imports/{id}/download","href":"/api-reference/admin-api/imports/download-the-originally-uploaded-file"},{"title":"Complete mapping and start processing","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/imports/{id}/complete_mapping","href":"/api-reference/admin-api/imports/complete-mapping-and-start-processing"},{"title":"Retry failed rows","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/imports/{id}/retry_failed_rows","href":"/api-reference/admin-api/imports/retry-failed-rows"},{"title":"List import rows","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/imports/{import_id}/rows","href":"/api-reference/admin-api/imports/list-import-rows"}]},{"group":"Maintenance Tasks","pages":[{"title":"List maintenance task runs","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/maintenance_task_runs","href":"/api-reference/admin-api/maintenance-tasks/list-maintenance-task-runs"},{"title":"Start a maintenance task","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/maintenance_task_runs","href":"/api-reference/admin-api/maintenance-tasks/start-a-maintenance-task"},{"title":"Retrieve a maintenance task run","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/maintenance_task_runs/{id}","href":"/api-reference/admin-api/maintenance-tasks/retrieve-a-maintenance-task-run"},{"title":"Cancel a maintenance task run","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/maintenance_task_runs/{maintenance_task_run_id}/cancellation","href":"/api-reference/admin-api/maintenance-tasks/cancel-a-maintenance-task-run"}]},{"group":"Markets","pages":[{"title":"List markets","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/markets","href":"/api-reference/admin-api/markets/list-markets"},{"title":"Create a market","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/markets","href":"/api-reference/admin-api/markets/create-a-market"},{"title":"Get a market","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/markets/{id}","href":"/api-reference/admin-api/markets/get-a-market"},{"title":"Delete a market","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/markets/{id}","href":"/api-reference/admin-api/markets/delete-a-market"},{"title":"Update a market","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/markets/{id}","href":"/api-reference/admin-api/markets/update-a-market"}]},{"group":"Option Types","pages":[{"title":"List option type custom fields","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/option_types/{option_type_id}/custom_fields","href":"/api-reference/admin-api/option-types/list-option-type-custom-fields"},{"title":"List option types","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/option_types","href":"/api-reference/admin-api/option-types/list-option-types"},{"title":"Create an option type","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/option_types","href":"/api-reference/admin-api/option-types/create-an-option-type"},{"title":"Get an option type","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/option_types/{id}","href":"/api-reference/admin-api/option-types/get-an-option-type"},{"title":"Delete an option type","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/option_types/{id}","href":"/api-reference/admin-api/option-types/delete-an-option-type"},{"title":"Update an option type","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/option_types/{id}","href":"/api-reference/admin-api/option-types/update-an-option-type"}]},{"group":"Orders","pages":[{"title":"List claims","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/claims","href":"/api-reference/admin-api/orders/list-claims"},{"title":"List order claims","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/orders/{order_id}/claims","href":"/api-reference/admin-api/orders/list-order-claims"},{"title":"Create a claim","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/orders/{order_id}/claims","href":"/api-reference/admin-api/orders/create-a-claim"},{"title":"Update a claim","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/claims/{id}","href":"/api-reference/admin-api/orders/update-a-claim"},{"title":"Resolve a claim","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/claims/{id}/resolve","href":"/api-reference/admin-api/orders/resolve-a-claim"},{"title":"Deny a claim","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/claims/{id}/deny","href":"/api-reference/admin-api/orders/deny-a-claim"},{"title":"Cancel a claim","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/claims/{id}/cancel","href":"/api-reference/admin-api/orders/cancel-a-claim"},{"title":"List order custom fields","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/orders/{order_id}/custom_fields","href":"/api-reference/admin-api/orders/list-order-custom-fields"},{"title":"List digital links","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/digital_links","href":"/api-reference/admin-api/orders/list-digital-links"},{"title":"List exchanges","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/exchanges","href":"/api-reference/admin-api/orders/list-exchanges"},{"title":"List order exchanges","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/orders/{order_id}/exchanges","href":"/api-reference/admin-api/orders/list-order-exchanges"},{"title":"Create an exchange","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/orders/{order_id}/exchanges","href":"/api-reference/admin-api/orders/create-an-exchange"},{"title":"Update an exchange","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/exchanges/{id}","href":"/api-reference/admin-api/orders/update-an-exchange"},{"title":"Receive an exchange","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/exchanges/{id}/receive","href":"/api-reference/admin-api/orders/receive-an-exchange"},{"title":"Fulfill an exchange","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/exchanges/{id}/fulfill","href":"/api-reference/admin-api/orders/fulfill-an-exchange"},{"title":"Cancel an exchange","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/exchanges/{id}/cancel","href":"/api-reference/admin-api/orders/cancel-an-exchange"},{"title":"List tax lines","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/orders/{order_id}/tax_lines","href":"/api-reference/admin-api/orders/list-tax-lines"},{"title":"List discounts","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/orders/{order_id}/discounts","href":"/api-reference/admin-api/orders/list-discounts"},{"title":"Create manual discount","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/orders/{order_id}/discounts","href":"/api-reference/admin-api/orders/create-manual-discount"},{"title":"Update manual discount","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/discounts/{id}","href":"/api-reference/admin-api/orders/update-manual-discount"},{"title":"List fees","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/orders/{order_id}/fees","href":"/api-reference/admin-api/orders/list-fees"},{"title":"Create fee","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/orders/{order_id}/fees","href":"/api-reference/admin-api/orders/create-fee"},{"title":"Update fee","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/fees/{id}","href":"/api-reference/admin-api/orders/update-fee"},{"title":"List order groups","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/order_groups","href":"/api-reference/admin-api/orders/list-order-groups"},{"title":"Apply a discount code","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/orders/{order_id}/discount_codes","href":"/api-reference/admin-api/orders/apply-a-discount-code"},{"title":"Apply a gift card to an order","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/orders/{order_id}/gift_cards","href":"/api-reference/admin-api/orders/apply-a-gift-card-to-an-order"},{"title":"Remove a gift card from an order","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/orders/{order_id}/gift_cards/{id}","href":"/api-reference/admin-api/orders/remove-a-gift-card-from-an-order"},{"title":"List order items","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/orders/{order_id}/items","href":"/api-reference/admin-api/orders/list-order-items"},{"title":"Add an item","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/orders/{order_id}/items","href":"/api-reference/admin-api/orders/add-an-item"},{"title":"Show an item","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/orders/{order_id}/items/{id}","href":"/api-reference/admin-api/orders/show-an-item"},{"title":"Remove an item","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/orders/{order_id}/items/{id}","href":"/api-reference/admin-api/orders/remove-an-item"},{"title":"Update an item","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/items/{id}","href":"/api-reference/admin-api/orders/update-an-item"},{"title":"Apply customer's store credit to an order","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/orders/{order_id}/store_credits","href":"/api-reference/admin-api/orders/apply-customers-store-credit-to-an-order"},{"title":"Remove store credit from an order","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/orders/{order_id}/store_credits","href":"/api-reference/admin-api/orders/remove-store-credit-from-an-order"},{"title":"List orders","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/orders","href":"/api-reference/admin-api/orders/list-orders"},{"title":"Create a draft order","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/orders","href":"/api-reference/admin-api/orders/create-a-draft-order"},{"title":"Show an order","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/orders/{id}","href":"/api-reference/admin-api/orders/show-an-order"},{"title":"Delete a draft order","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/orders/{id}","href":"/api-reference/admin-api/orders/delete-a-draft-order"},{"title":"Update an order","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{id}","href":"/api-reference/admin-api/orders/update-an-order"},{"title":"Complete an order","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{id}/complete","href":"/api-reference/admin-api/orders/complete-an-order"},{"title":"Cancel an order","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{id}/cancel","href":"/api-reference/admin-api/orders/cancel-an-order"},{"title":"Approve an order","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{id}/approve","href":"/api-reference/admin-api/orders/approve-an-order"},{"title":"Resend confirmation email","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/orders/{id}/resend_confirmation","href":"/api-reference/admin-api/orders/resend-confirmation-email"},{"title":"List returns","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/returns","href":"/api-reference/admin-api/orders/list-returns"},{"title":"List order returns","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/orders/{order_id}/returns","href":"/api-reference/admin-api/orders/list-order-returns"},{"title":"Create a return","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/orders/{order_id}/returns","href":"/api-reference/admin-api/orders/create-a-return"},{"title":"Update a return","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/returns/{id}","href":"/api-reference/admin-api/orders/update-a-return"},{"title":"Receive a return","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/returns/{id}/receive","href":"/api-reference/admin-api/orders/receive-a-return"},{"title":"Refund a return","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/returns/{id}/refund","href":"/api-reference/admin-api/orders/refund-a-return"},{"title":"Cancel a return","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/returns/{id}/cancel","href":"/api-reference/admin-api/orders/cancel-a-return"},{"title":"List return labels","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/orders/{order_id}/returns/{return_id}/labels","href":"/api-reference/admin-api/orders/list-return-labels"}]},{"group":"Payment Methods","pages":[{"title":"List payment method custom fields","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/payment_methods/{payment_method_id}/custom_fields","href":"/api-reference/admin-api/payment-methods/list-payment-method-custom-fields"},{"title":"List payment methods","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/payment_methods","href":"/api-reference/admin-api/payment-methods/list-payment-methods"},{"title":"Create a payment method","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/payment_methods","href":"/api-reference/admin-api/payment-methods/create-a-payment-method"},{"title":"List available payment provider types","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/payment_methods/types","href":"/api-reference/admin-api/payment-methods/list-available-payment-provider-types"},{"title":"Show a payment method","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/payment_methods/{id}","href":"/api-reference/admin-api/payment-methods/show-a-payment-method"},{"title":"Update a payment method","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/payment_methods/{id}","href":"/api-reference/admin-api/payment-methods/update-a-payment-method"}]},{"group":"Payments","pages":[{"title":"List payments","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/orders/{order_id}/payments","href":"/api-reference/admin-api/payments/list-payments"},{"title":"Create a payment","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/orders/{order_id}/payments","href":"/api-reference/admin-api/payments/create-a-payment"},{"title":"Show a payment","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/orders/{order_id}/payments/{id}","href":"/api-reference/admin-api/payments/show-a-payment"},{"title":"Capture a payment","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/payments/{id}/capture","href":"/api-reference/admin-api/payments/capture-a-payment"},{"title":"Void a payment","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/payments/{id}/void","href":"/api-reference/admin-api/payments/void-a-payment"}]},{"group":"Pricing","pages":[{"title":"List price lists","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/price_lists","href":"/api-reference/admin-api/pricing/list-price-lists"},{"title":"Create a price list","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/price_lists","href":"/api-reference/admin-api/pricing/create-a-price-list"},{"title":"Get a price list","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/price_lists/{id}","href":"/api-reference/admin-api/pricing/get-a-price-list"},{"title":"Delete a price list","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/price_lists/{id}","href":"/api-reference/admin-api/pricing/delete-a-price-list"},{"title":"Update a price list","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/price_lists/{id}","href":"/api-reference/admin-api/pricing/update-a-price-list"},{"title":"Activate a price list","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/price_lists/{id}/activate","href":"/api-reference/admin-api/pricing/activate-a-price-list"},{"title":"Deactivate a price list","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/price_lists/{id}/deactivate","href":"/api-reference/admin-api/pricing/deactivate-a-price-list"},{"title":"List prices","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/prices","href":"/api-reference/admin-api/pricing/list-prices"},{"title":"Create a price","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/prices","href":"/api-reference/admin-api/pricing/create-a-price"},{"title":"Get a price","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/prices/{id}","href":"/api-reference/admin-api/pricing/get-a-price"},{"title":"Delete a price","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/prices/{id}","href":"/api-reference/admin-api/pricing/delete-a-price"},{"title":"Update a price","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/prices/{id}","href":"/api-reference/admin-api/pricing/update-a-price"},{"title":"Bulk-upsert prices","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/prices/bulk_upsert","href":"/api-reference/admin-api/pricing/bulk-upsert-prices"},{"title":"Bulk-delete prices","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/prices/bulk_destroy","href":"/api-reference/admin-api/pricing/bulk-delete-prices"}]},{"group":"Products","pages":[{"title":"List product custom fields","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/products/{product_id}/custom_fields","href":"/api-reference/admin-api/products/list-product-custom-fields"},{"title":"Create a product custom field","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/products/{product_id}/custom_fields","href":"/api-reference/admin-api/products/create-a-product-custom-field"},{"title":"Show a product custom field","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/products/{product_id}/custom_fields/{id}","href":"/api-reference/admin-api/products/show-a-product-custom-field"},{"title":"Delete a product custom field","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/products/{product_id}/custom_fields/{id}","href":"/api-reference/admin-api/products/delete-a-product-custom-field"},{"title":"Update a product custom field","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/products/{product_id}/custom_fields/{id}","href":"/api-reference/admin-api/products/update-a-product-custom-field"},{"title":"List product digital assets","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/products/{product_id}/digital_assets","href":"/api-reference/admin-api/products/list-product-digital-assets"},{"title":"Create a product digital asset","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/products/{product_id}/digital_assets","href":"/api-reference/admin-api/products/create-a-product-digital-asset"},{"title":"Update a product digital asset","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/products/{product_id}/digital_assets/{id}","href":"/api-reference/admin-api/products/update-a-product-digital-asset"},{"title":"List product translations","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/products/{product_id}/translations","href":"/api-reference/admin-api/products/list-product-translations"},{"title":"List products","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/products","href":"/api-reference/admin-api/products/list-products"},{"title":"Create a product","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/products","href":"/api-reference/admin-api/products/create-a-product"},{"title":"Get a product","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/products/{id}","href":"/api-reference/admin-api/products/get-a-product"},{"title":"Delete a product","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/products/{id}","href":"/api-reference/admin-api/products/delete-a-product"},{"title":"Update a product","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/products/{id}","href":"/api-reference/admin-api/products/update-a-product"},{"title":"Bulk-update product status","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/products/bulk_status_update","href":"/api-reference/admin-api/products/bulk-update-product-status"},{"title":"Bulk-add products to categories","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/products/bulk_add_to_categories","href":"/api-reference/admin-api/products/bulk-add-products-to-categories"},{"title":"Bulk-remove products from categories","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/products/bulk_remove_from_categories","href":"/api-reference/admin-api/products/bulk-remove-products-from-categories"},{"title":"Bulk-add products to collections","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/products/bulk_add_to_collections","href":"/api-reference/admin-api/products/bulk-add-products-to-collections"},{"title":"Bulk-remove products from collections","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/products/bulk_remove_from_collections","href":"/api-reference/admin-api/products/bulk-remove-products-from-collections"},{"title":"Bulk-add products to channels","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/products/bulk_add_to_channels","href":"/api-reference/admin-api/products/bulk-add-products-to-channels"},{"title":"Bulk-remove products from channels","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/products/bulk_remove_from_channels","href":"/api-reference/admin-api/products/bulk-remove-products-from-channels"},{"title":"Bulk-add tags to products","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/products/bulk_add_tags","href":"/api-reference/admin-api/products/bulk-add-tags-to-products"},{"title":"Bulk-remove tags from products","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/products/bulk_remove_tags","href":"/api-reference/admin-api/products/bulk-remove-tags-from-products"},{"title":"Bulk-delete products","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/products/bulk_destroy","href":"/api-reference/admin-api/products/bulk-delete-products"},{"title":"Approve a submitted product","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/products/{id}/approve","href":"/api-reference/admin-api/products/approve-a-submitted-product"},{"title":"Reject a submitted product","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/products/{id}/reject","href":"/api-reference/admin-api/products/reject-a-submitted-product"},{"title":"Translation coverage for a resource type","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/translations","href":"/api-reference/admin-api/products/translation-coverage-for-a-resource-type"}]},{"group":"Policies","pages":[{"title":"List policies","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/policies","href":"/api-reference/admin-api/policies/list-policies"},{"title":"Create a policy","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/policies","href":"/api-reference/admin-api/policies/create-a-policy"},{"title":"Get a policy","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/policies/{id}","href":"/api-reference/admin-api/policies/get-a-policy"},{"title":"Delete a policy","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/policies/{id}","href":"/api-reference/admin-api/policies/delete-a-policy"},{"title":"Update a policy","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/policies/{id}","href":"/api-reference/admin-api/policies/update-a-policy"}]},{"group":"Reasons","pages":[{"title":"List claim reasons","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/claim_reasons","href":"/api-reference/admin-api/reasons/list-claim-reasons"},{"title":"Create a claim reason","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/claim_reasons","href":"/api-reference/admin-api/reasons/create-a-claim-reason"},{"title":"Get a claim reason","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/claim_reasons/{id}","href":"/api-reference/admin-api/reasons/get-a-claim-reason"},{"title":"Delete a claim reason","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/claim_reasons/{id}","href":"/api-reference/admin-api/reasons/delete-a-claim-reason"},{"title":"Update a claim reason","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/claim_reasons/{id}","href":"/api-reference/admin-api/reasons/update-a-claim-reason"},{"title":"List order cancellation reasons","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/order_cancellation_reasons","href":"/api-reference/admin-api/reasons/list-order-cancellation-reasons"},{"title":"Create a order cancellation reason","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/order_cancellation_reasons","href":"/api-reference/admin-api/reasons/create-a-order-cancellation-reason"},{"title":"Get a order cancellation reason","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/order_cancellation_reasons/{id}","href":"/api-reference/admin-api/reasons/get-a-order-cancellation-reason"},{"title":"Delete a order cancellation reason","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/order_cancellation_reasons/{id}","href":"/api-reference/admin-api/reasons/delete-a-order-cancellation-reason"},{"title":"Update a order cancellation reason","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/order_cancellation_reasons/{id}","href":"/api-reference/admin-api/reasons/update-a-order-cancellation-reason"},{"title":"List refund reasons","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/refund_reasons","href":"/api-reference/admin-api/reasons/list-refund-reasons"},{"title":"Create a refund reason","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/refund_reasons","href":"/api-reference/admin-api/reasons/create-a-refund-reason"},{"title":"Get a refund reason","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/refund_reasons/{id}","href":"/api-reference/admin-api/reasons/get-a-refund-reason"},{"title":"Delete a refund reason","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/refund_reasons/{id}","href":"/api-reference/admin-api/reasons/delete-a-refund-reason"},{"title":"Update a refund reason","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/refund_reasons/{id}","href":"/api-reference/admin-api/reasons/update-a-refund-reason"},{"title":"List return reasons","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/return_reasons","href":"/api-reference/admin-api/reasons/list-return-reasons"},{"title":"Create a return reason","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/return_reasons","href":"/api-reference/admin-api/reasons/create-a-return-reason"},{"title":"Get a return reason","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/return_reasons/{id}","href":"/api-reference/admin-api/reasons/get-a-return-reason"},{"title":"Delete a return reason","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/return_reasons/{id}","href":"/api-reference/admin-api/reasons/delete-a-return-reason"},{"title":"Update a return reason","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/return_reasons/{id}","href":"/api-reference/admin-api/reasons/update-a-return-reason"},{"title":"List tax exemption reasons","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/tax_exemption_reasons","href":"/api-reference/admin-api/reasons/list-tax-exemption-reasons"},{"title":"Create a tax exemption reason","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/tax_exemption_reasons","href":"/api-reference/admin-api/reasons/create-a-tax-exemption-reason"},{"title":"Get a tax exemption reason","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/tax_exemption_reasons/{id}","href":"/api-reference/admin-api/reasons/get-a-tax-exemption-reason"},{"title":"Delete a tax exemption reason","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/tax_exemption_reasons/{id}","href":"/api-reference/admin-api/reasons/delete-a-tax-exemption-reason"},{"title":"Update a tax exemption reason","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/tax_exemption_reasons/{id}","href":"/api-reference/admin-api/reasons/update-a-tax-exemption-reason"}]},{"group":"Promotions","pages":[{"title":"List coupon codes for a promotion","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/promotions/{promotion_id}/coupon_codes","href":"/api-reference/admin-api/promotions/list-coupon-codes-for-a-promotion"},{"title":"List promotion custom fields","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/promotions/{promotion_id}/custom_fields","href":"/api-reference/admin-api/promotions/list-promotion-custom-fields"},{"title":"List actions for a promotion","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/promotions/{promotion_id}/promotion_actions","href":"/api-reference/admin-api/promotions/list-actions-for-a-promotion"},{"title":"Create an action on a promotion","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/promotions/{promotion_id}/promotion_actions","href":"/api-reference/admin-api/promotions/create-an-action-on-a-promotion"},{"title":"Delete an action from a promotion","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/promotions/{promotion_id}/promotion_actions/{id}","href":"/api-reference/admin-api/promotions/delete-an-action-from-a-promotion"},{"title":"Update an action on a promotion","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/promotions/{promotion_id}/promotion_actions/{id}","href":"/api-reference/admin-api/promotions/update-an-action-on-a-promotion"},{"title":"List rules for a promotion","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/promotions/{promotion_id}/promotion_rules","href":"/api-reference/admin-api/promotions/list-rules-for-a-promotion"},{"title":"Create a rule on a promotion","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/promotions/{promotion_id}/promotion_rules","href":"/api-reference/admin-api/promotions/create-a-rule-on-a-promotion"},{"title":"Delete a rule from a promotion","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/promotions/{promotion_id}/promotion_rules/{id}","href":"/api-reference/admin-api/promotions/delete-a-rule-from-a-promotion"},{"title":"Update a rule's preferences","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/promotions/{promotion_id}/promotion_rules/{id}","href":"/api-reference/admin-api/promotions/update-a-rules-preferences"},{"title":"List promotions","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/promotions","href":"/api-reference/admin-api/promotions/list-promotions"},{"title":"Create a promotion","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/promotions","href":"/api-reference/admin-api/promotions/create-a-promotion"},{"title":"Show a promotion","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/promotions/{id}","href":"/api-reference/admin-api/promotions/show-a-promotion"},{"title":"Delete a promotion","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/promotions/{id}","href":"/api-reference/admin-api/promotions/delete-a-promotion"},{"title":"Update a promotion","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/promotions/{id}","href":"/api-reference/admin-api/promotions/update-a-promotion"},{"title":"List available promotion action types","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/promotion_actions/types","href":"/api-reference/admin-api/promotions/list-available-promotion-action-types"},{"title":"List available promotion rule types","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/promotion_rules/types","href":"/api-reference/admin-api/promotions/list-available-promotion-rule-types"}]},{"group":"Refunds","pages":[{"title":"List refunds","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/orders/{order_id}/refunds","href":"/api-reference/admin-api/refunds/list-refunds"},{"title":"Create a refund","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/orders/{order_id}/refunds","href":"/api-reference/admin-api/refunds/create-a-refund"}]},{"group":"Settings","pages":[{"title":"List tax rate custom fields","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/tax_rates/{tax_rate_id}/custom_fields","href":"/api-reference/admin-api/settings/list-tax-rate-custom-fields"},{"title":"List store custom fields","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/stores/{store_id}/custom_fields","href":"/api-reference/admin-api/settings/list-store-custom-fields"},{"title":"List supported locales","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/locales","href":"/api-reference/admin-api/settings/list-supported-locales"},{"title":"Get the current store","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/store","href":"/api-reference/admin-api/settings/get-the-current-store"},{"title":"Update the current store","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/store","href":"/api-reference/admin-api/settings/update-the-current-store"},{"title":"List tags","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/tags","href":"/api-reference/admin-api/settings/list-tags"},{"title":"List tax categories","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/tax_categories","href":"/api-reference/admin-api/settings/list-tax-categories"},{"title":"Create a tax category","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/tax_categories","href":"/api-reference/admin-api/settings/create-a-tax-category"},{"title":"Update a tax category","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/tax_categories/{id}","href":"/api-reference/admin-api/settings/update-a-tax-category"},{"title":"List tax rates","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/tax_rates","href":"/api-reference/admin-api/settings/list-tax-rates"},{"title":"Create a tax rate","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/tax_rates","href":"/api-reference/admin-api/settings/create-a-tax-rate"},{"title":"Get a tax rate","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/tax_rates/{id}","href":"/api-reference/admin-api/settings/get-a-tax-rate"},{"title":"Delete a tax rate","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/tax_rates/{id}","href":"/api-reference/admin-api/settings/delete-a-tax-rate"},{"title":"Update a tax rate","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/tax_rates/{id}","href":"/api-reference/admin-api/settings/update-a-tax-rate"},{"title":"List translatable resources","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/translatable_resources","href":"/api-reference/admin-api/settings/list-translatable-resources"},{"title":"Batch upsert translations","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/translations/batch","href":"/api-reference/admin-api/settings/batch-upsert-translations"},{"title":"Check for a newer Spree release","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/updates","href":"/api-reference/admin-api/settings/check-for-a-newer-spree-release"}]},{"group":"Staff","pages":[{"title":"List staff","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/admin_users","href":"/api-reference/admin-api/staff/list-staff"},{"title":"Show a staff member","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/admin_users/{id}","href":"/api-reference/admin-api/staff/show-a-staff-member"},{"title":"Remove a staff member from this store","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/admin_users/{id}","href":"/api-reference/admin-api/staff/remove-a-staff-member-from-this-store"},{"title":"Update a staff member","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/admin_users/{id}","href":"/api-reference/admin-api/staff/update-a-staff-member"},{"title":"List invitations","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/invitations","href":"/api-reference/admin-api/staff/list-invitations"},{"title":"Create an invitation","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/invitations","href":"/api-reference/admin-api/staff/create-an-invitation"},{"title":"Revoke an invitation","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/invitations/{id}","href":"/api-reference/admin-api/staff/revoke-an-invitation"},{"title":"Get an invitation acceptance link","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/invitations/{invitation_id}/acceptance_link","href":"/api-reference/admin-api/staff/get-an-invitation-acceptance-link"},{"title":"Resend an invitation","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/invitations/{id}/resend","href":"/api-reference/admin-api/staff/resend-an-invitation"},{"title":"List the permission catalog","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/permissions","href":"/api-reference/admin-api/staff/list-the-permission-catalog"},{"title":"List roles","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/roles","href":"/api-reference/admin-api/staff/list-roles"},{"title":"Create a role","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/roles","href":"/api-reference/admin-api/staff/create-a-role"},{"title":"Delete a role","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/roles/{id}","href":"/api-reference/admin-api/staff/delete-a-role"},{"title":"Update a role","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/roles/{id}","href":"/api-reference/admin-api/staff/update-a-role"}]},{"group":"Stock Locations","pages":[{"title":"List stock locations","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/stock_locations","href":"/api-reference/admin-api/stock-locations/list-stock-locations"},{"title":"Create a stock location","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/stock_locations","href":"/api-reference/admin-api/stock-locations/create-a-stock-location"},{"title":"Get a stock location","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/stock_locations/{id}","href":"/api-reference/admin-api/stock-locations/get-a-stock-location"},{"title":"Delete a stock location","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/stock_locations/{id}","href":"/api-reference/admin-api/stock-locations/delete-a-stock-location"},{"title":"Update a stock location","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/stock_locations/{id}","href":"/api-reference/admin-api/stock-locations/update-a-stock-location"}]},{"group":"Store Credits","pages":[{"title":"List store credit custom fields","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/store_credits/{store_credit_id}/custom_fields","href":"/api-reference/admin-api/store-credits/list-store-credit-custom-fields"},{"title":"List store credits","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/store_credits","href":"/api-reference/admin-api/store-credits/list-store-credits"},{"title":"Retrieve a store credit","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/store_credits/{id}","href":"/api-reference/admin-api/store-credits/retrieve-a-store-credit"},{"title":"List a store credit's ledger","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/store_credits/{store_credit_id}/events","href":"/api-reference/admin-api/store-credits/list-a-store-credits-ledger"}]},{"group":"Variants","pages":[{"title":"List variant custom fields","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/variants/{variant_id}/custom_fields","href":"/api-reference/admin-api/variants/list-variant-custom-fields"},{"title":"List product variants","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/products/{product_id}/variants","href":"/api-reference/admin-api/variants/list-product-variants"},{"title":"Create a variant","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/products/{product_id}/variants","href":"/api-reference/admin-api/variants/create-a-variant"},{"title":"Get a variant","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/products/{product_id}/variants/{id}","href":"/api-reference/admin-api/variants/get-a-variant"},{"title":"Delete a variant","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/products/{product_id}/variants/{id}","href":"/api-reference/admin-api/variants/delete-a-variant"},{"title":"Update a variant","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/products/{product_id}/variants/{id}","href":"/api-reference/admin-api/variants/update-a-variant"},{"title":"List variants","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/variants","href":"/api-reference/admin-api/variants/list-variants"}]},{"group":"Webhooks","pages":[{"title":"List webhook deliveries","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/webhook_endpoints/{webhook_endpoint_id}/deliveries","href":"/api-reference/admin-api/webhooks/list-webhook-deliveries"},{"title":"Get a webhook delivery","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/webhook_endpoints/{webhook_endpoint_id}/deliveries/{id}","href":"/api-reference/admin-api/webhooks/get-a-webhook-delivery"},{"title":"Redeliver a webhook delivery","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/webhook_endpoints/{webhook_endpoint_id}/deliveries/{id}/redeliver","href":"/api-reference/admin-api/webhooks/redeliver-a-webhook-delivery"},{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/webhook_endpoints","href":"/api-reference/admin-api/webhooks/list-webhook-endpoints"},{"title":"Create a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/webhook_endpoints","href":"/api-reference/admin-api/webhooks/create-a-webhook-endpoint"},{"title":"Get a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/webhook_endpoints/{id}","href":"/api-reference/admin-api/webhooks/get-a-webhook-endpoint"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/webhook_endpoints/{id}","href":"/api-reference/admin-api/webhooks/delete-a-webhook-endpoint"},{"title":"Update a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/webhook_endpoints/{id}","href":"/api-reference/admin-api/webhooks/update-a-webhook-endpoint"},{"title":"Send a test delivery","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/webhook_endpoints/{id}/send_test","href":"/api-reference/admin-api/webhooks/send-a-test-delivery"},{"title":"Re-enable a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/webhook_endpoints/{id}/enable","href":"/api-reference/admin-api/webhooks/re-enable-a-webhook-endpoint"},{"title":"Disable a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/webhook_endpoints/{id}/disable","href":"/api-reference/admin-api/webhooks/disable-a-webhook-endpoint"},{"title":"List webhook events","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/webhook_events","href":"/api-reference/admin-api/webhooks/list-webhook-events"}]},{"group":"Catalogs","pages":[{"title":"List catalogs","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/catalogs","href":"/api-reference/admin-api/catalogs/list-catalogs"},{"title":"Create a catalog","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/catalogs","href":"/api-reference/admin-api/catalogs/create-a-catalog"},{"title":"Update a catalog","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/catalogs/{id}","href":"/api-reference/admin-api/catalogs/update-a-catalog"},{"title":"Assign a catalog to an audience","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/catalogs/{id}/assign","href":"/api-reference/admin-api/catalogs/assign-a-catalog-to-an-audience"},{"title":"List catalog products","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/catalogs/{catalog_id}/products","href":"/api-reference/admin-api/catalogs/list-catalog-products"},{"title":"Add products to a catalog","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/catalogs/{catalog_id}/products","href":"/api-reference/admin-api/catalogs/add-products-to-a-catalog"},{"title":"Remove products from a catalog","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/catalogs/{catalog_id}/products","href":"/api-reference/admin-api/catalogs/remove-products-from-a-catalog"},{"title":"List catalog order minimums","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/catalogs/{catalog_id}/order_minimums","href":"/api-reference/admin-api/catalogs/list-catalog-order-minimums"},{"title":"Create a catalog order minimum","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/catalogs/{catalog_id}/order_minimums","href":"/api-reference/admin-api/catalogs/create-a-catalog-order-minimum"},{"title":"Delete a catalog order minimum","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/catalogs/{catalog_id}/order_minimums/{id}","href":"/api-reference/admin-api/catalogs/delete-a-catalog-order-minimum"},{"title":"Update a catalog order minimum","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/catalogs/{catalog_id}/order_minimums/{id}","href":"/api-reference/admin-api/catalogs/update-a-catalog-order-minimum"},{"title":"Set catalog quantity rules","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml put /api/v3/admin/catalogs/{catalog_id}/quantity_rules","href":"/api-reference/admin-api/catalogs/set-catalog-quantity-rules"},{"title":"Activate a catalog","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/catalogs/{id}/activate","href":"/api-reference/admin-api/catalogs/activate-a-catalog"},{"title":"Deactivate a catalog","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/catalogs/{id}/deactivate","href":"/api-reference/admin-api/catalogs/deactivate-a-catalog"}]},{"group":"Collections","pages":[{"title":"List collections","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/collections","href":"/api-reference/admin-api/collections/list-collections"},{"title":"Create a collection","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/collections","href":"/api-reference/admin-api/collections/create-a-collection"},{"title":"Get a collection","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/collections/{id}","href":"/api-reference/admin-api/collections/get-a-collection"},{"title":"Delete a collection","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/collections/{id}","href":"/api-reference/admin-api/collections/delete-a-collection"},{"title":"Update a collection","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/collections/{id}","href":"/api-reference/admin-api/collections/update-a-collection"},{"title":"List collection products","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/collections/{collection_id}/products","href":"/api-reference/admin-api/collections/list-collection-products"},{"title":"Add products to a collection","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/collections/{collection_id}/products","href":"/api-reference/admin-api/collections/add-products-to-a-collection"},{"title":"Remove products from a collection","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/collections/{collection_id}/products","href":"/api-reference/admin-api/collections/remove-products-from-a-collection"},{"title":"Reposition a collection product","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/collections/{collection_id}/products/{id}/reposition","href":"/api-reference/admin-api/collections/reposition-a-collection-product"},{"title":"List available collection rule types","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/collection_rules/types","href":"/api-reference/admin-api/collections/list-available-collection-rule-types"},{"title":"List collection custom fields","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/collections/{collection_id}/custom_fields","href":"/api-reference/admin-api/collections/list-collection-custom-fields"}]},{"group":"Commission Lines","pages":[{"title":"List commission lines","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/commission_lines","href":"/api-reference/admin-api/commission-lines/list-commission-lines"},{"title":"Get a commission line","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/commission_lines/{id}","href":"/api-reference/admin-api/commission-lines/get-a-commission-line"}]},{"group":"Commission Rates","pages":[{"title":"List commission rates","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/commission_rates","href":"/api-reference/admin-api/commission-rates/list-commission-rates"},{"title":"Create a commission rate","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/commission_rates","href":"/api-reference/admin-api/commission-rates/create-a-commission-rate"},{"title":"List the commission rule kinds","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/commission_rates/rule_types","href":"/api-reference/admin-api/commission-rates/list-the-commission-rule-kinds"},{"title":"Get a commission rate","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/commission_rates/{id}","href":"/api-reference/admin-api/commission-rates/get-a-commission-rate"},{"title":"Delete a commission rate","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/commission_rates/{id}","href":"/api-reference/admin-api/commission-rates/delete-a-commission-rate"},{"title":"Update a commission rate","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/commission_rates/{id}","href":"/api-reference/admin-api/commission-rates/update-a-commission-rate"}]},{"group":"Companies","pages":[{"title":"List company addresses","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/companies/{company_id}/addresses","href":"/api-reference/admin-api/companies/list-company-addresses"},{"title":"Create a company address","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/companies/{company_id}/addresses","href":"/api-reference/admin-api/companies/create-a-company-address"},{"title":"Update a company address","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/companies/{company_id}/addresses/{id}","href":"/api-reference/admin-api/companies/update-a-company-address"},{"title":"List company invitations","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/companies/{company_id}/invitations","href":"/api-reference/admin-api/companies/list-company-invitations"},{"title":"List company members","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/companies/{company_id}/memberships","href":"/api-reference/admin-api/companies/list-company-members"},{"title":"Add a member by email","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/companies/{company_id}/memberships","href":"/api-reference/admin-api/companies/add-a-member-by-email"},{"title":"List tax exemption certificates","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/companies/{company_id}/tax_exemption_certificates","href":"/api-reference/admin-api/companies/list-tax-exemption-certificates"},{"title":"Create a tax exemption certificate","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/companies/{company_id}/tax_exemption_certificates","href":"/api-reference/admin-api/companies/create-a-tax-exemption-certificate"},{"title":"Update a tax exemption certificate","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/companies/{company_id}/tax_exemption_certificates/{id}","href":"/api-reference/admin-api/companies/update-a-tax-exemption-certificate"},{"title":"Verify a tax exemption certificate","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/companies/{company_id}/tax_exemption_certificates/{id}/verify","href":"/api-reference/admin-api/companies/verify-a-tax-exemption-certificate"},{"title":"Revoke a tax exemption certificate","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/companies/{company_id}/tax_exemption_certificates/{id}/revoke","href":"/api-reference/admin-api/companies/revoke-a-tax-exemption-certificate"},{"title":"Download a certificate document","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/companies/{company_id}/tax_exemption_certificates/{id}/download","href":"/api-reference/admin-api/companies/download-a-certificate-document"},{"title":"List company tax registrations","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/companies/{company_id}/tax_identifiers","href":"/api-reference/admin-api/companies/list-company-tax-registrations"},{"title":"Create a company tax registration","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/companies/{company_id}/tax_identifiers","href":"/api-reference/admin-api/companies/create-a-company-tax-registration"},{"title":"Re-check a company tax registration","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/companies/{company_id}/tax_identifiers/{id}/validate","href":"/api-reference/admin-api/companies/re-check-a-company-tax-registration"},{"title":"List companies","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/companies","href":"/api-reference/admin-api/companies/list-companies"},{"title":"Create a company","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/companies","href":"/api-reference/admin-api/companies/create-a-company"},{"title":"Update a company","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/companies/{id}","href":"/api-reference/admin-api/companies/update-a-company"},{"title":"List company custom fields","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/companies/{company_id}/custom_fields","href":"/api-reference/admin-api/companies/list-company-custom-fields"}]},{"group":"Custom Field Definitions","pages":[{"title":"List what custom fields can be attached to","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/custom_field_definitions/resource_types","href":"/api-reference/admin-api/custom-field-definitions/list-what-custom-fields-can-be-attached-to"}]},{"group":"Sellers","pages":[{"title":"List seller custom fields","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/sellers/{seller_id}/custom_fields","href":"/api-reference/admin-api/sellers/list-seller-custom-fields"},{"title":"List a seller's requirement submissions","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/sellers/{seller_id}/requirement_submissions","href":"/api-reference/admin-api/sellers/list-a-sellers-requirement-submissions"},{"title":"Waive a requirement for a seller","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/sellers/{seller_id}/requirement_submissions","href":"/api-reference/admin-api/sellers/waive-a-requirement-for-a-seller"},{"title":"Accept a seller's submission","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/sellers/{seller_id}/requirement_submissions/{id}/accept","href":"/api-reference/admin-api/sellers/accept-a-sellers-submission"},{"title":"Reject a seller's submission","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/sellers/{seller_id}/requirement_submissions/{id}/reject","href":"/api-reference/admin-api/sellers/reject-a-sellers-submission"},{"title":"List sellers","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/sellers","href":"/api-reference/admin-api/sellers/list-sellers"},{"title":"Create a seller","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/sellers","href":"/api-reference/admin-api/sellers/create-a-seller"},{"title":"Get a seller","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/sellers/{id}","href":"/api-reference/admin-api/sellers/get-a-seller"},{"title":"Delete a seller","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/sellers/{id}","href":"/api-reference/admin-api/sellers/delete-a-seller"},{"title":"Update a seller","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/sellers/{id}","href":"/api-reference/admin-api/sellers/update-a-seller"},{"title":"Invite someone to run a seller","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/sellers/{id}/invite","href":"/api-reference/admin-api/sellers/invite-someone-to-run-a-seller"},{"title":"Approve a seller","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/sellers/{id}/approve","href":"/api-reference/admin-api/sellers/approve-a-seller"},{"title":"Send a seller back to onboarding","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/sellers/{id}/reopen_onboarding","href":"/api-reference/admin-api/sellers/send-a-seller-back-to-onboarding"},{"title":"Suspend a seller","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/sellers/{id}/suspend","href":"/api-reference/admin-api/sellers/suspend-a-seller"},{"title":"Reject a seller","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/sellers/{id}/reject","href":"/api-reference/admin-api/sellers/reject-a-seller"},{"title":"List a seller's balances","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/sellers/{seller_id}/balances","href":"/api-reference/admin-api/sellers/list-a-sellers-balances"},{"title":"Settle a seller","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/sellers/{seller_id}/payouts","href":"/api-reference/admin-api/sellers/settle-a-seller"},{"title":"List seller transfers","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/seller_transfers","href":"/api-reference/admin-api/sellers/list-seller-transfers"},{"title":"List seller payouts","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/seller_payouts","href":"/api-reference/admin-api/sellers/list-seller-payouts"},{"title":"Mark a payout paid","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/seller_payouts/{id}/complete","href":"/api-reference/admin-api/sellers/mark-a-payout-paid"}]},{"group":"Stock Transfers","pages":[{"title":"List stock transfer custom fields","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/stock_transfers/{stock_transfer_id}/custom_fields","href":"/api-reference/admin-api/stock-transfers/list-stock-transfer-custom-fields"},{"title":"List stock transfers","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/stock_transfers","href":"/api-reference/admin-api/stock-transfers/list-stock-transfers"},{"title":"Create a stock transfer","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/stock_transfers","href":"/api-reference/admin-api/stock-transfers/create-a-stock-transfer"},{"title":"Get a stock transfer","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/stock_transfers/{id}","href":"/api-reference/admin-api/stock-transfers/get-a-stock-transfer"},{"title":"Delete a stock transfer","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/stock_transfers/{id}","href":"/api-reference/admin-api/stock-transfers/delete-a-stock-transfer"},{"title":"Update a stock transfer","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/stock_transfers/{id}","href":"/api-reference/admin-api/stock-transfers/update-a-stock-transfer"},{"title":"Mark a transfer ready to ship","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/stock_transfers/{id}/mark_ready","href":"/api-reference/admin-api/stock-transfers/mark-a-transfer-ready-to-ship"},{"title":"Send a transfer","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/stock_transfers/{id}/mark_in_transit","href":"/api-reference/admin-api/stock-transfers/send-a-transfer"},{"title":"List the deliveries counted in against a transfer","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/stock_transfers/{stock_transfer_id}/stock_receipts","href":"/api-reference/admin-api/stock-transfers/list-the-deliveries-counted-in-against-a-transfer"},{"title":"Count a delivery in","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/stock_transfers/{stock_transfer_id}/stock_receipts","href":"/api-reference/admin-api/stock-transfers/count-a-delivery-in"},{"title":"Take a transfer back to draft","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/stock_transfers/{id}/mark_draft","href":"/api-reference/admin-api/stock-transfers/take-a-transfer-back-to-draft"},{"title":"Close a transfer short","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/stock_transfers/{id}/close","href":"/api-reference/admin-api/stock-transfers/close-a-transfer-short"},{"title":"Cancel a stock transfer","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/stock_transfers/{id}/cancel","href":"/api-reference/admin-api/stock-transfers/cancel-a-stock-transfer"}]},{"group":"Purchase Orders","pages":[{"title":"List purchase order custom fields","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/purchase_orders/{purchase_order_id}/custom_fields","href":"/api-reference/admin-api/purchase-orders/list-purchase-order-custom-fields"},{"title":"List purchase orders","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/purchase_orders","href":"/api-reference/admin-api/purchase-orders/list-purchase-orders"},{"title":"Create a purchase order","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/purchase_orders","href":"/api-reference/admin-api/purchase-orders/create-a-purchase-order"},{"title":"Get a purchase order","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/purchase_orders/{id}","href":"/api-reference/admin-api/purchase-orders/get-a-purchase-order"},{"title":"Update a purchase order","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/purchase_orders/{id}","href":"/api-reference/admin-api/purchase-orders/update-a-purchase-order"},{"title":"Place the order with the supplier","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/purchase_orders/{id}/mark_ordered","href":"/api-reference/admin-api/purchase-orders/place-the-order-with-the-supplier"},{"title":"List the deliveries booked against an order","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/purchase_orders/{purchase_order_id}/stock_receipts","href":"/api-reference/admin-api/purchase-orders/list-the-deliveries-booked-against-an-order"},{"title":"Book in a delivery","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/purchase_orders/{purchase_order_id}/stock_receipts","href":"/api-reference/admin-api/purchase-orders/book-in-a-delivery"},{"title":"Take an order back to draft","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/purchase_orders/{id}/mark_draft","href":"/api-reference/admin-api/purchase-orders/take-an-order-back-to-draft"},{"title":"Close an order short","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/purchase_orders/{id}/close","href":"/api-reference/admin-api/purchase-orders/close-an-order-short"},{"title":"Cancel a purchase order","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/purchase_orders/{id}/cancel","href":"/api-reference/admin-api/purchase-orders/cancel-a-purchase-order"}]},{"group":"Delivery","pages":[{"title":"List delivery method custom fields","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/delivery_methods/{delivery_method_id}/custom_fields","href":"/api-reference/admin-api/delivery/list-delivery-method-custom-fields"},{"title":"List delivery profiles","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/delivery_profiles","href":"/api-reference/admin-api/delivery/list-delivery-profiles"},{"title":"Create a delivery profile","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/delivery_profiles","href":"/api-reference/admin-api/delivery/create-a-delivery-profile"},{"title":"List origin groups","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/delivery_profiles/{delivery_profile_id}/origin_groups","href":"/api-reference/admin-api/delivery/list-origin-groups"},{"title":"Create an origin group","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/delivery_profiles/{delivery_profile_id}/origin_groups","href":"/api-reference/admin-api/delivery/create-an-origin-group"},{"title":"Delete a delivery profile","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/delivery_profiles/{id}","href":"/api-reference/admin-api/delivery/delete-a-delivery-profile"},{"title":"Update a delivery profile","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/delivery_profiles/{id}","href":"/api-reference/admin-api/delivery/update-a-delivery-profile"},{"title":"List delivery methods","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/delivery_methods","href":"/api-reference/admin-api/delivery/list-delivery-methods"},{"title":"Create delivery method","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/delivery_methods","href":"/api-reference/admin-api/delivery/create-delivery-method"},{"title":"Update delivery method","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/delivery_methods/{id}","href":"/api-reference/admin-api/delivery/update-delivery-method"},{"title":"List delivery calculators","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/delivery_methods/calculators","href":"/api-reference/admin-api/delivery/list-delivery-calculators"},{"title":"List delivery zones","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/delivery_zones","href":"/api-reference/admin-api/delivery/list-delivery-zones"},{"title":"Create delivery zone","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/delivery_zones","href":"/api-reference/admin-api/delivery/create-delivery-zone"},{"title":"Update delivery zone","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/delivery_zones/{id}","href":"/api-reference/admin-api/delivery/update-delivery-zone"},{"title":"List delivery method rules","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/delivery_methods/{delivery_method_id}/rules","href":"/api-reference/admin-api/delivery/list-delivery-method-rules"},{"title":"Create a delivery method rule","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/delivery_methods/{delivery_method_id}/rules","href":"/api-reference/admin-api/delivery/create-a-delivery-method-rule"},{"title":"Update a delivery method rule","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/delivery_methods/{delivery_method_id}/rules/{id}","href":"/api-reference/admin-api/delivery/update-a-delivery-method-rule"}]},{"group":"Product Types","pages":[{"title":"List product type custom fields","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/product_types/{product_type_id}/custom_fields","href":"/api-reference/admin-api/product-types/list-product-type-custom-fields"},{"title":"List product types","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/product_types","href":"/api-reference/admin-api/product-types/list-product-types"},{"title":"Create a product type","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/product_types","href":"/api-reference/admin-api/product-types/create-a-product-type"},{"title":"Retrieve a product type","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/product_types/{id}","href":"/api-reference/admin-api/product-types/retrieve-a-product-type"},{"title":"Delete a product type","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/product_types/{id}","href":"/api-reference/admin-api/product-types/delete-a-product-type"},{"title":"Update a product type","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/product_types/{id}","href":"/api-reference/admin-api/product-types/update-a-product-type"},{"title":"Apply a product type to its existing products","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/product_types/{id}/apply_to_products","href":"/api-reference/admin-api/product-types/apply-a-product-type-to-its-existing-products"}]},{"group":"Media","pages":[{"title":"List media file custom fields","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/media/{medium_id}/custom_fields","href":"/api-reference/admin-api/media/list-media-file-custom-fields"},{"title":"List media","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/media","href":"/api-reference/admin-api/media/list-media"},{"title":"Upload a file to the library","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/media","href":"/api-reference/admin-api/media/upload-a-file-to-the-library"},{"title":"Update a library file","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/media/{id}","href":"/api-reference/admin-api/media/update-a-library-file"},{"title":"Where a file is used","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/media/{id}/usage","href":"/api-reference/admin-api/media/where-a-file-is-used"},{"title":"List product media","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/products/{product_id}/media","href":"/api-reference/admin-api/media/list-product-media"},{"title":"Place a library file on a product","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/products/{product_id}/media","href":"/api-reference/admin-api/media/place-a-library-file-on-a-product"},{"title":"Update product media","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/products/{product_id}/media/{id}","href":"/api-reference/admin-api/media/update-product-media"},{"title":"List variant media","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/products/{product_id}/variants/{variant_id}/media","href":"/api-reference/admin-api/media/list-variant-media"}]},{"group":"Integrations","pages":[{"title":"List integrations","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/integrations","href":"/api-reference/admin-api/integrations/list-integrations"},{"title":"Connect integration","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/integrations","href":"/api-reference/admin-api/integrations/connect-integration"},{"title":"List integration types","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/integrations/types","href":"/api-reference/admin-api/integrations/list-integration-types"},{"title":"Update integration","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/integrations/{id}","href":"/api-reference/admin-api/integrations/update-integration"},{"title":"Test integration connection","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/integrations/{id}/test","href":"/api-reference/admin-api/integrations/test-integration-connection"}]},{"group":"OAuth","pages":[{"title":"List connected applications","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/oauth/applications","href":"/api-reference/admin-api/oauth/list-connected-applications"},{"title":"Register an application","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/oauth/applications","href":"/api-reference/admin-api/oauth/register-an-application"},{"title":"Remove an application","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/oauth/applications/{id}","href":"/api-reference/admin-api/oauth/remove-an-application"},{"title":"Update an application","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/oauth/applications/{id}","href":"/api-reference/admin-api/oauth/update-an-application"},{"title":"List who is connected","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/oauth/applications/{application_id}/tokens","href":"/api-reference/admin-api/oauth/list-who-is-connected"},{"title":"Revoke one person's access","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/oauth/applications/{application_id}/tokens/{id}","href":"/api-reference/admin-api/oauth/revoke-one-persons-access"},{"title":"Describe what a client is asking for","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/oauth/authorize","href":"/api-reference/admin-api/oauth/describe-what-a-client-is-asking-for"},{"title":"Approve a request","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/oauth/authorize","href":"/api-reference/admin-api/oauth/approve-a-request"},{"title":"Turn a request down","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/oauth/authorize","href":"/api-reference/admin-api/oauth/turn-a-request-down"},{"title":"Discover the authorization server","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/oauth/protected-resource/{resource_key}","href":"/api-reference/admin-api/oauth/discover-the-authorization-server"}]},{"group":"Deliveries","pages":[{"title":"List deliveries","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/orders/{order_id}/fulfillments/{fulfillment_id}/deliveries","href":"/api-reference/admin-api/deliveries/list-deliveries"},{"title":"Record a delivery","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/orders/{order_id}/fulfillments/{fulfillment_id}/deliveries","href":"/api-reference/admin-api/deliveries/record-a-delivery"},{"title":"Delete a delivery","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/orders/{order_id}/fulfillments/{fulfillment_id}/deliveries/{id}","href":"/api-reference/admin-api/deliveries/delete-a-delivery"},{"title":"Correct a delivery","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/fulfillments/{fulfillment_id}/deliveries/{id}","href":"/api-reference/admin-api/deliveries/correct-a-delivery"},{"title":"Mark a delivery delivered","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/fulfillments/{fulfillment_id}/deliveries/{id}/mark_delivered","href":"/api-reference/admin-api/deliveries/mark-a-delivery-delivered"}]},{"group":"Shipping Labels","pages":[{"title":"List shipping labels","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/orders/{order_id}/fulfillments/{fulfillment_id}/labels","href":"/api-reference/admin-api/shipping-labels/list-shipping-labels"},{"title":"Buy or record a shipping label","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/orders/{order_id}/fulfillments/{fulfillment_id}/labels","href":"/api-reference/admin-api/shipping-labels/buy-or-record-a-shipping-label"},{"title":"Get a shipping label","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/orders/{order_id}/fulfillments/{fulfillment_id}/labels/{id}","href":"/api-reference/admin-api/shipping-labels/get-a-shipping-label"},{"title":"Delete an uploaded label","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/orders/{order_id}/fulfillments/{fulfillment_id}/labels/{id}","href":"/api-reference/admin-api/shipping-labels/delete-an-uploaded-label"},{"title":"Refund a shipping label","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/orders/{order_id}/fulfillments/{fulfillment_id}/labels/{id}/refund","href":"/api-reference/admin-api/shipping-labels/refund-a-shipping-label"}]},{"group":"Package Types","pages":[{"title":"List package types","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/package_types","href":"/api-reference/admin-api/package-types/list-package-types"},{"title":"Create a package type","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/package_types","href":"/api-reference/admin-api/package-types/create-a-package-type"},{"title":"Get a package type","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/package_types/{id}","href":"/api-reference/admin-api/package-types/get-a-package-type"},{"title":"Delete a package type","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/package_types/{id}","href":"/api-reference/admin-api/package-types/delete-a-package-type"},{"title":"Update a package type","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/package_types/{id}","href":"/api-reference/admin-api/package-types/update-a-package-type"}]},{"group":"Price Lists","pages":[{"title":"List price list products","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/price_lists/{price_list_id}/products","href":"/api-reference/admin-api/price-lists/list-price-list-products"},{"title":"Add products to a price list","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/price_lists/{price_list_id}/products","href":"/api-reference/admin-api/price-lists/add-products-to-a-price-list"},{"title":"Remove products from a price list","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/price_lists/{price_list_id}/products","href":"/api-reference/admin-api/price-lists/remove-products-from-a-price-list"}]},{"group":"Reports","pages":[{"title":"List saved reports","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/reporting/saved_reports","href":"/api-reference/admin-api/reports/list-saved-reports"},{"title":"Create a saved report","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/reporting/saved_reports","href":"/api-reference/admin-api/reports/create-a-saved-report"},{"title":"Update a saved report","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/reporting/saved_reports/{id}","href":"/api-reference/admin-api/reports/update-a-saved-report"},{"title":"Run a reporting query","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/reporting/query","href":"/api-reference/admin-api/reports/run-a-reporting-query"}]},{"group":"Seller Requirements","pages":[{"title":"List seller requirements","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/seller_requirements","href":"/api-reference/admin-api/seller-requirements/list-seller-requirements"},{"title":"Add a seller requirement","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/seller_requirements","href":"/api-reference/admin-api/seller-requirements/add-a-seller-requirement"},{"title":"List seller requirement kinds","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/seller_requirements/types","href":"/api-reference/admin-api/seller-requirements/list-seller-requirement-kinds"},{"title":"Delete a seller requirement","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/seller_requirements/{id}","href":"/api-reference/admin-api/seller-requirements/delete-a-seller-requirement"},{"title":"Update a seller requirement","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/seller_requirements/{id}","href":"/api-reference/admin-api/seller-requirements/update-a-seller-requirement"}]},{"group":"Stock","pages":[{"title":"List stock levels","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/stock_levels","href":"/api-reference/admin-api/stock/list-stock-levels"},{"title":"Bulk-upsert stock levels","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/stock_levels/bulk_upsert","href":"/api-reference/admin-api/stock/bulk-upsert-stock-levels"},{"title":"Update a stock level","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/stock_levels/{id}","href":"/api-reference/admin-api/stock/update-a-stock-level"},{"title":"List stock reservations","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/stock_reservations","href":"/api-reference/admin-api/stock/list-stock-reservations"}]},{"group":"Stock Movements","pages":[{"title":"List stock movements","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/stock_movements","href":"/api-reference/admin-api/stock-movements/list-stock-movements"},{"title":"Get a stock movement","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/stock_movements/{id}","href":"/api-reference/admin-api/stock-movements/get-a-stock-movement"}]},{"group":"Suppliers","pages":[{"title":"List suppliers","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/suppliers","href":"/api-reference/admin-api/suppliers/list-suppliers"},{"title":"Create a supplier","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml post /api/v3/admin/suppliers","href":"/api-reference/admin-api/suppliers/create-a-supplier"},{"title":"Get a supplier","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml get /api/v3/admin/suppliers/{id}","href":"/api-reference/admin-api/suppliers/get-a-supplier"},{"title":"Delete a supplier","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml delete /api/v3/admin/suppliers/{id}","href":"/api-reference/admin-api/suppliers/delete-a-supplier"},{"title":"Update a supplier","deprecated":null,"version":null,"openapi":"/api-reference/admin.yaml patch /api/v3/admin/suppliers/{id}","href":"/api-reference/admin-api/suppliers/update-a-supplier"}]}]}]},{"item":"Webhooks","icon":"webhook","description":"Event payloads and delivery reference","pages":[{"title":"Webhooks","href":"/api-reference/webhooks-events"}]},{"item":"Legacy API v2","icon":"clock","description":"Previous-generation Storefront and Platform APIs","pages":[{"title":"Legacy API v2","href":"/api-reference/v2/introduction"}]}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations/integrations"}]},{"tab":"User Guide","pages":[{"title":"User Guide","href":"/v5/user/what-is-spree-commerce"}]}]}]},"title":"Logout - Spree Commerce documentation","buildId":"dpl_GvhK4qVXq51DpfYJLCtPpYNN4YHN","deploymentId":"dpl_GvhK4qVXq51DpfYJLCtPpYNN4YHN","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Bg4Z7D_G.js","utils-Biz734EK.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C6F9YHs6.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BoJjY_VP.js","snippetPresets-CnZ-mOFh.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-DC_SB2pp.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BYKtOiIP.js","shallow-COAac_UD.js","getApiPlaygroundDisplay-BV4Viqi2.js","CodeSnippet-DDgW-JXl.js","CodeSnippets-CP1LpNhG.js","Page-BeiUfucV.js","getPastedJson-Cvgvbfmv.js","icon-D-H368xH.js","MethodPill-CXSxH1VW.js","DuplicateIcon-JcbBzF1x.js","createIcon-BDt_aHZM.js","DynamicMarkdown-DO1Fz7ar.js","SectionHeading-mwKBArs3.js","axios-vUo_bRtp.js","Markdown-C3KUTGJN.js","clsx-C6CAjViH.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C3vb5JQZ.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C8Hisf3g.js"]}