Analytics events to emit for the change this request made, each with a server-issued event_id. Replay them to your analytics destinations so your client-side and server-side copies of the same action dedupe. Empty when the request produced no analytics event.
Emitted when a cart is created or deleted, or when checkout begins. Checkout Started is sent each time an address is set on the cart, even an unchanged one, matching Commerce Engine's own server-side copy.
{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"Commerce Engine Docs","description":"Official documentation for Commerce Engine - The modern headless commerce platform for building scalable e-commerce solutions.","colors":{"primary":"#00BF6F","light":"#00BF6F","dark":"#029558"},"logo":{"light":"https://mintcdn.com/tarkai/hIY7_H2biaAvOGu7/logo/CE_Developers_black.svg?fit=max\u0026auto=format\u0026n=hIY7_H2biaAvOGu7\u0026q=85\u0026s=d93f21564dfd373c7f2efc88c9d4301e","dark":"https://mintcdn.com/tarkai/hIY7_H2biaAvOGu7/logo/CE_Developers_white.svg?fit=max\u0026auto=format\u0026n=hIY7_H2biaAvOGu7\u0026q=85\u0026s=def973fb06c07f5eae14319cc3303339","href":"/"},"favicon":"https://mintcdn.com/tarkai/QX_fwpRYnT2rH-8q/favicon.png?fit=max\u0026auto=format\u0026n=QX_fwpRYnT2rH-8q\u0026q=85\u0026s=ebc190f98abe52e0e4220c74cea20fa6","api":{"openapi":{"source":"https://openapi.commercengine.io/ce-storefront.json","directory":"api-reference"},"playground":{"display":"interactive","proxy":false}},"appearance":{"default":"system"},"background":{"decoration":"windows","color":{"light":"#ffffff","dark":"#0d1816"}},"navbar":{"primary":{"type":"button","label":"Return to main site","href":"https://www.commercengine.io"}},"footer":{"socials":{"github":"https://github.com/tark-ai","twitter":"https://x.com/CommerceEngine","linkedin":"https://www.linkedin.com/company/commercengine"}},"search":{"prompt":"Search docs..."},"seo":{"metatags":{"canonical":"https://www.commercengine.io/docs","og:site_name":"Commerce Engine Developer Portal","og:locale":"en_US","og:logo":"/logo/CE_logo_whitebg.svg","twitter:site":"@CommerceEngine","og:image:width":"1200","og:image:height":"630","robots":"index, follow"},"indexing":"navigable"},"fonts":{"heading":{"family":"Satoshi","weight":700,"source":"https://images.tarkai.com/Commerce_Engine/Fonts/Satoshi-Variable.woff2","format":"woff2"},"body":{"family":"Satoshi","weight":450,"source":"https://images.tarkai.com/Commerce_Engine/Fonts/Satoshi-Variable.woff2","format":"woff2"}},"styling":{"eyebrows":"section","codeblocks":{"theme":{"light":"github-light","dark":"github-dark"}},"latex":false},"integrations":{"ga4":{"measurementId":"G-6SVW3L2E90"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"tarkai","hasAudioNarration":false,"actualSubdomain":"tarkai","customDomains":["www.commercengine.io"],"gitSource":{"type":"github","owner":"tark-ai","repo":"ce-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6afda2d272aa9c06fc1d01a8","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API Reference","count":851},{"language":"default","tag":"Admin API","count":385},{"language":"default","tag":"Customers","count":252},{"language":"default","tag":"Webhooks","count":248},{"language":"default","tag":"Orders","count":168},{"language":"default","tag":"Catalog","count":149},{"language":"default","tag":"Store","count":146},{"language":"default","tag":"Storefront API","count":143},{"language":"default","tag":"Marketplace","count":90},{"language":"default","tag":"Payments","count":89}]},"assistantConfig":{},"basePath":"/docs","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"/* cyrillic-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2JL7SUc.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa0ZL7SUc.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* greek-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2ZL7SUc.woff2) format('woff2');\n unicode-range: U+1F00-1FFF;\n}\n/* greek */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1pL7SUc.woff2) format('woff2');\n unicode-range: U+0370-0377, U+037A-037F, U+0384-038A, U+038C, U+038E-03A1, U+03A3-03FF;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2pL7SUc.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa25L7SUc.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1ZL7.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* cyrillic-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2JL7SUc.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa0ZL7SUc.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* greek-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2ZL7SUc.woff2) format('woff2');\n unicode-range: U+1F00-1FFF;\n}\n/* greek */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1pL7SUc.woff2) format('woff2');\n unicode-range: U+0370-0377, U+037A-037F, U+0384-038A, U+038C, U+038E-03A1, U+03A3-03FF;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2pL7SUc.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa25L7SUc.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1ZL7.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* cyrillic-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2JL7SUc.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa0ZL7SUc.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* greek-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2ZL7SUc.woff2) format('woff2');\n unicode-range: U+1F00-1FFF;\n}\n/* greek */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1pL7SUc.woff2) format('woff2');\n unicode-range: U+0370-0377, U+037A-037F, U+0384-038A, U+038C, U+038E-03A1, U+03A3-03FF;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2pL7SUc.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa25L7SUc.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1ZL7.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n.font-medium{font-weight:525}#content-area.max-w-3xl{max-width:60rem!important}:root{--ce-white: #fff;--ce-black: #0e0e0f;--ce-green: #00bf6f;--ce-chart-green: #009354;--ce-goldenrod: #f6ffdb;--ce-bg-light-green: #e6faf2;--ce-shades-100: #f6f6f6;--ce-shades-300: #ececec;--ce-shades-800: #262626;--ce-shades-950: #e0dede;--ce-grid-line: #8f8f8f14;--ce-grid-fill: #3e3e3e06;--ce-skill-panel: #16191c;--ce-skill-inset: #101315;--ce-skill-border: #ffffff1a;--ce-skill-fg: #f3f5f6;--ce-skill-dim: #98a0a8;--ce-skill-mark: #2fd18c;--ce-code-block-bg: #1a1a1a;--ce-terminal-bg: #061636;--ce-terminal-body: #0c1f45;--ce-chrome-red: #ff5f56;--ce-chrome-amber: #ffbd2e;--ce-chrome-green: #27c93f;--ce-font-primary: \"Satoshi\", \"Satoshi Static\", system-ui, sans-serif;--ce-font-secondary: \"Inter\", system-ui, sans-serif;--ce-font-mono: ui-monospace, SFMono-Regular, Menlo, Consolas, monospace;--ce-text-2xs: 0.75rem;--ce-text-xs: 0.875rem;--ce-text-sm: 1rem;--ce-text-base: 1.125rem;--ce-text-xl: 1.375rem;--ce-text-4xl: 1.75rem;--ce-text-5xl: 2rem;--ce-text-7xl: 3.25rem;--ce-leading-sm: 1.15;--ce-leading-md: 1.3;--ce-leading-lg: 1.5;--ce-tracking-heading: -0.02em;--ce-tracking-eyebrow: 0.18em;--ce-tracking-label: 0.14em;--ce-container-lg: 67.5rem;--ce-container-xl: 75rem;--ce-container-2xl: 79.375rem;--ce-container-3xl: 90rem;--ce-header-shadow: #2416230a;--ce-radius-sm: 0.25rem;--ce-radius-md: 0.5rem;--ce-radius-lg: 0.75rem;--ce-radius-xl: 1rem;--ce-radius-2xl: 1.5rem;--ce-radius-full: 9999px;--ce-shadow-button: 0 2px 4px rgba(0, 0, 0, 0.1);--ce-shadow-tile-hover: 0 10px 24px rgba(0, 0, 0, 0.08);--ce-duration-hover: 300ms}[data-theme=\"dark\"],html.dark,body.dark{--ce-white: #0d1816;--ce-black: #fff;--ce-goldenrod: #002e27;--ce-bg-light-green: #03312e;--ce-shades-100: #142321;--ce-shades-300: #323232;--ce-shades-800: #e3e2e2;--ce-shades-950: #525252;--ce-chart-green: #00ad64;--ce-grid-line: #ffffff12;--ce-grid-fill: #ffffff08;--ce-header-shadow: #42424230}html[data-page-mode=\"custom\"] #navbar>div:nth-child(1),html[data-page-mode=\"custom\"] #navbar>div:nth-child(2){opacity:0;transition:opacity var(--ce-duration-hover) ease-out}html[data-page-mode=\"custom\"] #navbar>*:last-child{border:1px solid transparent;border-radius:var(--ce-radius-sm);background:transparent;box-shadow:0 0 0 0 transparent;margin-inline:auto;transition:all var(--ce-duration-hover) ease-out}html[data-page-mode=\"custom\"][data-scrolled=\"true\"] #navbar>*:last-child{width:calc(100% - 2rem);max-width:var(--ce-container-3xl);transform:translateY(12px);border-color:var(--ce-shades-300);background:var(--ce-white);box-shadow:4px 4px 4px 0 var(--ce-header-shadow)}@media (max-width: 992px){html[data-page-mode=\"custom\"][data-scrolled=\"true\"] #navbar>*:last-child{width:calc(100% - 1rem);transform:translateY(8px)}}@media (prefers-reduced-motion: reduce){html[data-page-mode=\"custom\"] #navbar>*:last-child,html[data-page-mode=\"custom\"] #navbar>div:nth-child(1),html[data-page-mode=\"custom\"] #navbar>div:nth-child(2){transition-duration:0.01ms}}.ce-home{background:var(--ce-white);color:var(--ce-black);font-family:var(--ce-font-primary)}.ce-home a{text-decoration:none}.ce-section{margin:0 auto;max-width:1100px;padding:72px 32px 0}.ce-section--last{padding-bottom:96px}.ce-section--wide{max-width:var(--ce-container-2xl)}.ce-page-title{margin:0;font-size:var(--ce-text-7xl);font-weight:700;line-height:var(--ce-leading-sm);letter-spacing:var(--ce-tracking-heading)}.ce-page-lede{margin:16px 0 0;max-width:46rem;font-size:var(--ce-text-base);line-height:var(--ce-leading-lg);color:var(--ce-shades-800)}@media (max-width: 992px){.ce-page-title{font-size:2.5rem}}.ce-h2{margin:0;font-size:var(--ce-text-5xl);font-weight:700;line-height:var(--ce-leading-md);letter-spacing:var(--ce-tracking-heading)}.ce-home table{width:100%;margin:20px 0 0;border-collapse:collapse;font-size:var(--ce-text-xs);line-height:var(--ce-leading-lg)}.ce-home thead th{border-bottom:1px solid var(--ce-shades-300);padding:10px 14px;text-align:left;font-weight:700;color:var(--ce-black)}.ce-home tbody td{border-bottom:1px solid var(--ce-shades-300);padding:10px 14px;color:var(--ce-shades-800);vertical-align:top}.ce-home tbody tr:hover{background:var(--ce-shades-100)}.ce-home table a{color:var(--ce-black);font-weight:500;text-decoration:underline;text-decoration-color:var(--ce-shades-300);text-underline-offset:3px}.ce-home table a:hover{color:var(--ce-green);text-decoration-color:var(--ce-green)}.ce-home table code,.ce-home p code,.ce-home li code{border-radius:var(--ce-radius-sm);background:var(--ce-shades-100);padding:2px 6px;font-family:var(--ce-font-mono);font-size:0.9em}.ce-home .ce-cmd code,.ce-home .ce-term-pre code,.ce-home .ce-agent-prompt code,.ce-home .ce-frame-url code{background:none;padding:0;border-radius:0;font-size:inherit}.ce-home .ce-section>*+*{margin-top:20px}.ce-home .ce-section>.ce-h2{margin-top:56px}.ce-home .ce-section>.ce-h2:first-child{margin-top:0}.ce-lede{margin:12px 0 0;font-size:var(--ce-text-sm);line-height:var(--ce-leading-lg);color:var(--ce-shades-800)}.ce-hero{position:relative;overflow:hidden;border-bottom:1px solid var(--ce-shades-300)}.ce-hero-inner{position:relative;z-index:10;margin:0 auto;max-width:1100px;padding:80px 32px 72px;display:grid;grid-template-columns:1.05fr 0.95fr;gap:56px;align-items:center}.ce-hero-copy{display:grid;gap:24px;justify-items:start}.ce-hero-title{margin:0;font-size:var(--ce-text-7xl);font-weight:700;line-height:var(--ce-leading-sm);letter-spacing:var(--ce-tracking-heading)}.ce-hero-title em{font-style:normal;color:var(--ce-green)}.ce-hero-body{margin:0;max-width:34rem;font-size:var(--ce-text-base);line-height:var(--ce-leading-lg);color:var(--ce-shades-800)}.ce-hero-actions{display:flex;gap:16px;flex-wrap:wrap}.ce-hero-media{display:grid;gap:16px}.ce-hero-grid{position:absolute;inset:0;z-index:0;background-color:var(--ce-goldenrod);background-image:repeating-linear-gradient(to right, var(--ce-grid-line) 0 1px, transparent 1px 102px),\n repeating-linear-gradient(to bottom, var(--ce-grid-line) 0 1px, transparent 1px 102px)}.ce-hero-grid::before,.ce-hero-grid::after{content:\"\";position:absolute;width:102px;height:102px;background:var(--ce-grid-fill)}.ce-hero-grid::before{left:0;top:0}.ce-hero-grid::after{left:816px;top:102px}.ce-eyebrow{display:inline-flex;align-items:center;gap:8px;margin:0;border-radius:var(--ce-radius-full);border:1px solid var(--ce-shades-300);background:var(--ce-white);padding:6px 12px;font-family:var(--ce-font-secondary);font-size:var(--ce-text-2xs);font-weight:500;text-transform:uppercase;letter-spacing:var(--ce-tracking-eyebrow);color:var(--ce-shades-800)}.ce-eyebrow::before{content:\"\";width:6px;height:6px;flex-shrink:0;border-radius:var(--ce-radius-full);background:var(--ce-green)}.ce-eyebrow--dark{border:0;background:none;padding:0;color:var(--ce-skill-dim);letter-spacing:var(--ce-tracking-eyebrow)}.ce-eyebrow--dark::before{background:var(--ce-skill-mark)}.ce-btn{position:relative;overflow:hidden;display:inline-flex;align-items:center;justify-content:center;gap:10px;border:0;border-radius:var(--ce-radius-full);padding:10px 20px;font-family:var(--ce-font-secondary);font-size:var(--ce-text-sm);line-height:var(--ce-leading-lg);font-weight:500;white-space:nowrap;box-shadow:var(--ce-shadow-button);transition:all var(--ce-duration-hover);cursor:pointer}.ce-btn:hover{transform:translateY(-3px) scale(1.02)}.ce-btn:active{transform:translateY(0) scale(1);transition-duration:75ms}.ce-btn:focus-visible{outline:2px solid var(--ce-black);outline-offset:2px}.ce-btn--primary{background:var(--ce-green);color:#fff}.ce-btn--primary:hover{box-shadow:0 6px 15px rgba(0, 0, 0, 0.15),\n 0 10px 30px -8px color-mix(in srgb, var(--ce-green) 60%, transparent)}.ce-btn--secondary{border:1px solid var(--ce-shades-950);background:var(--ce-white);color:var(--ce-black)}.ce-btn--secondary:hover{border-color:var(--ce-shades-800);box-shadow:0 6px 15px rgba(0, 0, 0, 0.12)}.ce-cards{margin-top:32px;display:grid;grid-template-columns:repeat(3, 1fr);gap:20px}.ce-card{display:grid;gap:10px;align-content:start;border:1px solid var(--ce-shades-300);border-radius:var(--ce-radius-xl);background:var(--ce-white);padding:24px;color:var(--ce-black);transition:transform var(--ce-duration-hover),\n box-shadow var(--ce-duration-hover),\n border-color var(--ce-duration-hover)}.ce-card:hover{transform:translateY(-4px);box-shadow:var(--ce-shadow-tile-hover);border-color:var(--ce-green)}.ce-card-step{font-family:var(--ce-font-mono);font-size:var(--ce-text-2xs);color:var(--ce-chart-green)}.ce-card h3{margin:0;font-size:var(--ce-text-xl);font-weight:700;line-height:var(--ce-leading-md)}.ce-card p{margin:0;font-size:var(--ce-text-sm);line-height:var(--ce-leading-lg);color:var(--ce-shades-800)}.ce-skills{overflow:hidden;border-radius:var(--ce-radius-2xl);background:var(--ce-skill-panel);color:var(--ce-skill-fg);display:grid;grid-template-columns:1fr 1fr;gap:48px;padding:40px}.ce-skills-copy{display:grid;gap:20px;align-content:start}.ce-skills-copy h2{margin:0;font-size:var(--ce-text-5xl);font-weight:700;line-height:var(--ce-leading-md);letter-spacing:var(--ce-tracking-heading);color:var(--ce-skill-fg)}.ce-skills-copy p.ce-skills-body{margin:0;font-size:var(--ce-text-sm);line-height:var(--ce-leading-lg);color:var(--ce-skill-dim)}.ce-agents{display:flex;align-items:center;gap:12px}.ce-agent{display:flex;width:40px;height:40px;align-items:center;justify-content:center;border-radius:var(--ce-radius-lg);background:#fff}.ce-agent img{width:22px;height:22px;object-fit:contain}.ce-skills-links{display:flex;gap:24px;flex-wrap:wrap;padding-top:4px}.ce-skills-links a{font-size:var(--ce-text-sm);color:var(--ce-skill-mark)}.ce-skills-links a:hover{text-decoration:underline}.ce-skills-demo{display:grid;align-content:center}.ce-skills-demo pre{margin:0;border-radius:var(--ce-radius-lg);background:var(--ce-skill-inset);border:1px solid var(--ce-skill-border);padding:16px 18px;font-family:var(--ce-font-mono);font-size:12px;line-height:1.9;color:var(--ce-skill-fg);white-space:pre-wrap;overflow-x:auto}.ce-skills-demo .ce-dim{color:var(--ce-skill-dim)}.ce-skills-demo .ce-mark{color:var(--ce-skill-mark)}.ce-guides{margin-top:28px;display:grid;grid-template-columns:1fr 1fr;gap:0 40px}.ce-guide{display:grid;grid-template-columns:1fr auto;align-items:center;gap:16px;border-top:1px solid var(--ce-shades-300);padding:20px 16px;color:var(--ce-black);transition:background var(--ce-duration-hover)}.ce-guide:hover{background:var(--ce-shades-100)}.ce-guide-title{display:block;font-size:var(--ce-text-base);font-weight:700}.ce-guide-sub{display:block;margin-top:4px;font-size:var(--ce-text-xs);line-height:var(--ce-leading-lg);color:var(--ce-shades-800)}.ce-guide-arrow{color:var(--ce-green)}.ce-starters{border-radius:var(--ce-radius-2xl);border:1px solid var(--ce-shades-300);background:var(--ce-shades-100);padding:32px}.ce-starters-head{display:grid;grid-template-columns:1fr auto;gap:32px;align-items:center}.ce-starters-head h2{margin:0;font-size:var(--ce-text-4xl);font-weight:700;line-height:var(--ce-leading-md);letter-spacing:var(--ce-tracking-heading)}.ce-starters-head p{margin:10px 0 0;max-width:38rem;font-size:var(--ce-text-sm);line-height:var(--ce-leading-lg);color:var(--ce-shades-800)}.ce-chips{margin-top:24px;display:grid;grid-template-columns:repeat(6, 1fr);gap:12px}.ce-chip{display:flex;align-items:center;gap:10px;border:1px solid var(--ce-shades-300);border-radius:var(--ce-radius-lg);background:var(--ce-white);padding:12px;color:var(--ce-black);font-size:var(--ce-text-xs);font-weight:500;transition:transform var(--ce-duration-hover),\n border-color var(--ce-duration-hover)}.ce-chip:hover{transform:translateY(-2px);border-color:var(--ce-green)}.ce-chip-mark{display:flex;width:32px;height:32px;flex-shrink:0;align-items:center;justify-content:center;border-radius:var(--ce-radius-md);background:#fff;box-shadow:0 0 0 1px rgba(0, 0, 0, 0.05)}.ce-chip-mark img{width:18px;height:18px;object-fit:contain}.ce-trio{display:grid;grid-template-columns:repeat(3, 1fr);gap:20px}.ce-trio-item{border-top:2px solid var(--ce-shades-300);padding-top:16px;color:var(--ce-black)}.ce-trio-item--active{border-top-color:var(--ce-green)}a.ce-trio-item{transition:border-color var(--ce-duration-hover),\n transform var(--ce-duration-hover)}a.ce-trio-item:hover{border-top-color:var(--ce-green);transform:translateY(-2px)}a.ce-trio-item:hover h3{color:var(--ce-green)}a.ce-trio-item:focus-visible{outline:2px solid var(--ce-black);outline-offset:4px}.ce-trio-item h3{margin:0;font-size:var(--ce-text-base);font-weight:700}.ce-trio-item p{margin:6px 0 0;font-size:var(--ce-text-xs);line-height:var(--ce-leading-lg);color:var(--ce-shades-800)}.ce-cmd{overflow:hidden;border-radius:var(--ce-radius-lg);background:var(--ce-code-block-bg)}.ce-cmd-label{margin:0;border-bottom:1px solid rgba(255, 255, 255, 0.1);padding:10px 16px;font-family:var(--ce-font-secondary);font-size:11px;font-weight:700;text-transform:uppercase;letter-spacing:var(--ce-tracking-label);color:rgba(255, 255, 255, 0.75)}.ce-cmd ul{list-style:none;margin:0;padding:0}.ce-cmd li{display:flex;align-items:center;gap:12px;padding:10px 16px;border-top:1px solid rgba(255, 255, 255, 0.05)}.ce-cmd li:first-child{border-top:0}.ce-cmd code{min-width:0;flex:1;overflow-x:auto;white-space:pre;font-family:var(--ce-font-mono);font-size:11px;line-height:var(--ce-leading-lg);color:#fff;background:none;border:0;padding:0;scrollbar-width:none}.ce-cmd code::-webkit-scrollbar{display:none}.ce-cmd code[data-wrap=\"true\"]{white-space:pre-wrap;overflow-x:visible}.ce-cmd-prefix{user-select:none;color:var(--ce-green)}.ce-cmd-copy{display:flex;width:28px;height:28px;flex-shrink:0;cursor:pointer;align-items:center;justify-content:center;border:0;border-radius:var(--ce-radius-md);background:none;color:rgba(255, 255, 255, 0.5);font-size:12px;transition:color 0.2s,\n background 0.2s}.ce-cmd-copy:hover{background:rgba(255, 255, 255, 0.1);color:#fff}.ce-cmd-copy[data-copied=\"true\"]{color:var(--ce-green)}div:has(>[role=\"menu\"] a[href$=\"/sdk/installation\"]),div:has(>[role=\"menu\"] a[href$=\"/storefront/quickstart\"]){position:fixed!important;top:calc(var(--banner-height, 0px) + 52px)!important;left:50%!important;transform:translateX(-50%)!important}[role=\"menu\"]:has(.nav-dropdown-item){width:fit-content!important;max-width:calc(100vw - 64px)!important;max-height:none!important;display:grid!important;grid-auto-flow:column;grid-auto-columns:minmax(220px, 300px);align-content:start;gap:6px 24px;padding:24px!important;border-radius:var(--ce-radius-2xl)!important;box-shadow:0 12px 36px rgba(0, 0, 0, 0.09)!important}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]),[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]){width:1000px!important;grid-auto-flow:row;grid-template-columns:repeat(3, minmax(0, 1fr));gap:6px 32px;padding:32px!important}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(1){grid-area:1 / 1}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(2){grid-area:2 / 1}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(3){grid-area:1 / 2}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(4){grid-area:2 / 2}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(5){grid-area:1 / 3}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(6){grid-area:2 / 3}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(7){grid-area:3 / 3}[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(1){grid-area:1 / 1}[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(2){grid-area:2 / 1}[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(3){grid-area:3 / 1}[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(4){grid-area:1 / 2}[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(5){grid-area:2 / 2}[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(6){grid-area:1 / 3}[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(7){grid-area:2 / 3}.nav-dropdown-item{display:grid!important;grid-template-columns:auto minmax(0, 1fr);gap:12px;align-items:start!important;border-radius:var(--ce-radius-md)!important;padding:10px 12px!important;color:var(--ce-black)!important;transition:background var(--ce-duration-hover)}.nav-dropdown-item:hover{background:var(--ce-shades-100)!important}.nav-dropdown-item>svg{width:18px;height:18px;margin-top:2px;color:var(--ce-chart-green)}.nav-dropdown-item>div>span:first-child{font-family:var(--ce-font-mono);font-size:var(--ce-text-sm);font-weight:500;color:var(--ce-black)}.nav-dropdown-item>div>span:last-child{margin-top:3px;font-size:var(--ce-text-xs);line-height:var(--ce-leading-lg);color:var(--ce-shades-800)!important}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(1),[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(3),[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(5),[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(1),[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(4),[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(6){position:relative;margin-top:26px}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(1)::before{content:\"Storefront\"}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(3)::before{content:\"Checkout \u0026 POS\"}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(5)::before{content:\"Growth \u0026 AI\"}[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(1)::before{content:\"Get started\"}[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(4)::before{content:\"Build\"}[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(6)::before{content:\"SEO \u0026 AI\"}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(1)::before,[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(3)::before,[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(5)::before,[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(1)::before,[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(4)::before,[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(6)::before{position:absolute;top:-22px;left:12px;font-family:var(--ce-font-secondary);font-size:var(--ce-text-2xs);font-weight:500;text-transform:uppercase;letter-spacing:var(--ce-tracking-eyebrow);color:var(--ce-shades-600)}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(8){grid-area:4 / 1 / auto / -1;margin-top:20px;border-top:1px solid var(--ce-shades-300);padding-top:20px!important;grid-template-columns:repeat(3, auto);justify-content:center;align-items:center!important;gap:10px}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(8)>svg{margin-top:0}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(8)>div{display:block}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(8)>div>span:first-child{font-family:var(--ce-font-secondary);font-size:var(--ce-text-xs);text-transform:uppercase;letter-spacing:var(--ce-tracking-eyebrow)}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(8)>div>span:last-child{display:none}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(8):hover>div>span:first-child{color:var(--ce-green)}@media (max-width: 1100px){[role=\"menu\"]:has(.nav-dropdown-item){width:auto!important;grid-template-columns:1fr}.nav-dropdown-item:nth-child(n){grid-area:auto!important}}.ce-portal{margin:20px 0;border:1px solid var(--ce-shades-300);border-radius:var(--ce-radius-xl);background:var(--ce-shades-100);padding:20px}.ce-portal-label{display:block;margin-bottom:10px;font-family:var(--ce-font-secondary);font-size:11px;font-weight:700;text-transform:uppercase;letter-spacing:var(--ce-tracking-label);color:var(--ce-shades-800)}.ce-portal-row{display:flex;flex-wrap:wrap;align-items:center;gap:12px}.ce-portal-field{display:flex;min-width:0;flex:1 1 320px;align-items:center;overflow:hidden;border:1px solid var(--ce-shades-300);border-radius:var(--ce-radius-full);background:var(--ce-white);transition:border-color var(--ce-duration-hover)}.ce-portal-field:focus-within{border-color:var(--ce-green)}.ce-portal-field input{min-width:0;flex:1;border:0;background:none;padding:11px 16px;font-family:var(--ce-font-mono);font-size:var(--ce-text-xs);color:var(--ce-black);outline:none}.ce-portal-field select{flex-shrink:0;border:0;border-left:1px solid var(--ce-shades-300);background:none;padding:11px 14px;font-family:var(--ce-font-mono);font-size:var(--ce-text-xs);color:var(--ce-shades-800);cursor:pointer;outline:none}.ce-portal .ce-btn[data-disabled=\"true\"]{pointer-events:none;opacity:0.45}.ce-portal-url{margin:12px 0 0;font-size:var(--ce-text-2xs);line-height:var(--ce-leading-lg);color:var(--ce-shades-800)}.ce-portal-url code{font-family:var(--ce-font-mono);word-break:break-all}@media (max-width: 550px){.ce-portal-row{flex-direction:column;align-items:stretch}}.ce-footer{margin-top:96px;border-top:1px solid var(--ce-shades-300);background:var(--ce-shades-100)}.ce-footer-inner{margin:0 auto;max-width:var(--ce-container-2xl);padding:56px 32px 40px;display:grid;grid-template-columns:minmax(0, 1fr) minmax(0, 2.2fr);gap:48px}.ce-footer-brand img{height:28px;width:auto}.ce-footer-logo-dark{display:none}[data-theme=\"dark\"] .ce-footer-logo-light,html.dark .ce-footer-logo-light{display:none}[data-theme=\"dark\"] .ce-footer-logo-dark,html.dark .ce-footer-logo-dark{display:block}.ce-footer-brand p{margin:14px 0 0;max-width:22rem;font-size:var(--ce-text-xs);line-height:var(--ce-leading-lg);color:var(--ce-shades-800)}.ce-footer-socials{margin-top:20px;display:flex;gap:10px}.ce-footer-socials a{display:flex;width:34px;height:34px;align-items:center;justify-content:center;border-radius:var(--ce-radius-full);border:1px solid var(--ce-shades-300);background:var(--ce-white);color:var(--ce-shades-800);transition:color var(--ce-duration-hover),\n border-color var(--ce-duration-hover),\n transform var(--ce-duration-hover)}.ce-footer-socials a:hover{color:var(--ce-green);border-color:var(--ce-green);transform:translateY(-2px)}.ce-footer-cols{display:grid;grid-template-columns:repeat(4, minmax(0, 1fr));gap:32px}.ce-footer-heading{margin:0 0 12px;font-family:var(--ce-font-secondary);font-size:var(--ce-text-2xs);font-weight:500;text-transform:uppercase;letter-spacing:var(--ce-tracking-eyebrow);color:var(--ce-shades-600, #6e6e6f)}.ce-footer-col ul{margin:0;padding:0;list-style:none;display:grid;gap:9px}.ce-footer-col li{margin:0}.ce-footer-col a{font-size:var(--ce-text-xs);line-height:var(--ce-leading-lg);color:var(--ce-shades-800);transition:color var(--ce-duration-hover)}.ce-footer-col a:hover{color:var(--ce-green)}.ce-footer-bar{border-top:1px solid var(--ce-shades-300)}.ce-footer-bar{margin:0 auto;max-width:var(--ce-container-2xl);padding:20px 32px 32px;display:flex;flex-wrap:wrap;justify-content:space-between;gap:12px;font-size:var(--ce-text-2xs);color:var(--ce-shades-600, #6e6e6f)}@media (max-width: 992px){.ce-footer-inner{grid-template-columns:1fr;gap:36px;padding:40px 24px 32px}.ce-footer-cols{grid-template-columns:repeat(2, minmax(0, 1fr))}.ce-footer-bar{padding:20px 24px 28px}}.ce-starters{display:grid;gap:24px;margin:28px 0}.ce-starter-card{display:grid;grid-template-columns:1.4fr 1fr;overflow:hidden;border:1px solid var(--ce-shades-300);border-radius:var(--ce-radius-2xl);background:var(--ce-white);transition:all var(--ce-duration-hover)}.ce-starter-card:hover{transform:translateY(-4px);border-color:var(--ce-green);box-shadow:0 18px 44px rgba(0, 0, 0, 0.12)}.ce-starter-preview{display:flex;min-width:0;align-items:center;background:var(--ce-shades-100);padding:24px}.ce-frame{width:100%;overflow:hidden;border:1px solid var(--ce-shades-300);border-radius:var(--ce-radius-xl);background:var(--ce-white);box-shadow:0 10px 30px rgba(0, 0, 0, 0.1);transition:transform 500ms var(--ce-ease-out, ease-out)}.ce-starter-card:hover .ce-frame{transform:scale(1.02)}.ce-frame-bar{display:flex;align-items:center;gap:8px;border-bottom:1px solid var(--ce-shades-300);background:var(--ce-shades-100);padding:10px 12px}.ce-frame-bar span:not(.ce-frame-url){width:10px;height:10px;flex-shrink:0;border-radius:var(--ce-radius-full)}.ce-frame-url{margin-left:8px;min-width:0;flex:1;overflow:hidden;text-overflow:ellipsis;white-space:nowrap;border-radius:var(--ce-radius-full);background:var(--ce-white);padding:4px 12px;font-size:var(--ce-text-2xs);line-height:var(--ce-leading-lg);color:var(--ce-shades-800)}.ce-frame-viewport{position:relative;overflow:hidden;aspect-ratio:16 / 10}.ce-frame-viewport img{width:100%;height:100%;object-fit:cover;object-position:top center;display:block}.ce-starter-body{display:flex;min-width:0;flex-direction:column;padding:28px}.ce-starter-category{align-self:start;border-radius:var(--ce-radius-full);border:1px solid var(--ce-shades-300);background:var(--ce-shades-100);padding:4px 10px;font-family:var(--ce-font-secondary);font-size:var(--ce-text-2xs);font-weight:500;color:var(--ce-shades-800)}.ce-starter-name{margin:12px 0 0;font-size:var(--ce-text-5xl);font-weight:700;line-height:var(--ce-leading-md);letter-spacing:var(--ce-tracking-heading);color:var(--ce-black)}.ce-starter-desc{margin:10px 0 0;font-size:var(--ce-text-sm);line-height:var(--ce-leading-lg);color:var(--ce-shades-800)}.ce-starter-features{margin:20px 0 0;padding:0;list-style:none;display:flex;flex-wrap:wrap;gap:6px}.ce-starter-features li{margin:0;border-radius:var(--ce-radius-md);border:1px solid var(--ce-shades-300);background:var(--ce-shades-100);padding:4px 8px;font-family:var(--ce-font-secondary);font-size:11px;line-height:var(--ce-leading-lg);color:var(--ce-shades-800)}.ce-starter-foot{margin-top:auto;padding-top:24px}.ce-fw{min-width:0;margin:0;padding:0;border:0}.ce-fw legend{margin-bottom:10px;padding:0;font-family:var(--ce-font-secondary);font-size:11px;font-weight:500;text-transform:uppercase;letter-spacing:0.12em;color:var(--ce-shades-800)}.ce-fw-grid{display:grid;grid-template-columns:repeat(3, minmax(0, 1fr));gap:6px}.ce-fw-option{display:flex;min-height:40px;cursor:pointer;align-items:center;gap:6px;border-radius:var(--ce-radius-lg);border:1px solid var(--ce-shades-300);background:var(--ce-white);padding:0 8px;color:var(--ce-shades-800);transition:border-color 200ms, background 200ms}.ce-fw-option:hover{border-color:var(--ce-green)}.ce-fw-option[data-active=\"true\"]{border-color:var(--ce-green);background:var(--ce-bg-light-green);color:var(--ce-black)}.ce-fw-option:has(input:focus-visible){outline:2px solid var(--ce-green);outline-offset:2px}.ce-fw-option input{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0, 0, 0, 0);white-space:nowrap;border:0}.ce-fw-mark{display:flex;width:18px;height:18px;flex-shrink:0;align-items:center;justify-content:center;border-radius:var(--ce-radius-full);background:#fff;box-shadow:0 0 0 1px rgba(0, 0, 0, 0.05)}.ce-fw-mark img{width:12px;height:12px;object-fit:contain}.ce-fw-name{min-width:0;flex:1;overflow:hidden;text-overflow:ellipsis;white-space:nowrap;font-family:var(--ce-font-secondary);font-size:11px;font-weight:500}.ce-fw-option svg{flex-shrink:0;color:var(--ce-green)}.ce-fw-spacer{width:12px;flex-shrink:0}.ce-starter-hero-cmd{margin:28px 0 0;display:flex;flex-wrap:wrap;align-items:baseline;gap:8px 14px;border:1px solid var(--ce-shades-300);border-radius:var(--ce-radius-xl);background:var(--ce-shades-100);padding:18px 20px}.ce-starter-hero-label{font-family:var(--ce-font-secondary);font-size:11px;font-weight:700;text-transform:uppercase;letter-spacing:var(--ce-tracking-label);color:var(--ce-shades-800)}.ce-starter-hero-cmd code{border-radius:var(--ce-radius-md);background:var(--ce-code-block-bg);padding:8px 14px;font-family:var(--ce-font-mono);font-size:var(--ce-text-xs);color:#fff}.ce-starter-hero-note{font-size:var(--ce-text-2xs);color:var(--ce-shades-800)}.ce-starter-cmd{margin-top:18px;display:flex;align-items:center;gap:8px;overflow:hidden;border-radius:var(--ce-radius-md);background:var(--ce-code-block-bg);padding:8px 8px 8px 12px}.ce-starter-cmd code{min-width:0;flex:1;overflow-x:auto;white-space:pre;border:0;background:none;padding:0;font-family:var(--ce-font-mono);font-size:11px;line-height:var(--ce-leading-lg);color:#fff;scrollbar-width:none}.ce-starter-cmd code::-webkit-scrollbar{display:none}.ce-starter-actions{margin-top:16px;display:flex;flex-wrap:wrap;align-items:center;gap:12px}@media (max-width: 992px){.ce-starter-card{grid-template-columns:1fr}.ce-starter-preview{padding:16px}.ce-starter-body{padding:20px}.ce-starter-name{font-size:var(--ce-text-4xl)}}@media (max-width: 550px){.ce-fw-grid{grid-template-columns:repeat(2, minmax(0, 1fr))}.ce-starter-actions{flex-direction:column;align-items:stretch}}.ce-agent-setup{display:grid;gap:0}.ce-agent-step{margin:0;font-family:var(--ce-font-secondary);font-size:11px;font-weight:700;text-transform:uppercase;letter-spacing:var(--ce-tracking-label);color:var(--ce-shades-800)}.ce-agent-choices{margin-top:12px;display:flex;flex-wrap:wrap;gap:7px}.ce-agent-choice{display:flex;min-height:44px;cursor:pointer;align-items:center;gap:8px;border-radius:var(--ce-radius-full);border:1px solid var(--ce-shades-300);background:var(--ce-white);padding:8px 12px;color:var(--ce-black);font-family:var(--ce-font-secondary);font-size:var(--ce-text-xs);font-weight:500;line-height:var(--ce-leading-lg);transition:all 200ms}.ce-agent-choice:hover{border-color:var(--ce-green)}.ce-agent-choice[data-active=\"true\"]{border-color:var(--ce-green);background:var(--ce-bg-light-green)}.ce-agent-choice:focus-visible{outline:2px solid var(--ce-green);outline-offset:2px}.ce-agent-choice-mark{display:flex;width:18px;height:18px;flex-shrink:0;align-items:center;justify-content:center;border-radius:var(--ce-radius-full);background:#fff;box-shadow:0 0 0 1px rgba(0, 0, 0, 0.05)}.ce-agent-choice-mark img{width:12px;height:12px;object-fit:contain}.ce-agent-block{margin-top:20px}.ce-agent-prompt{display:flex;align-items:flex-start;gap:12px;padding:12px 16px}.ce-agent-prompt p{min-width:0;flex:1;margin:0;font-family:var(--ce-font-mono);font-size:11px;line-height:1.7;color:rgba(255, 255, 255, 0.9)}.ce-term{display:flex;min-height:280px;width:100%;flex-direction:column;overflow:hidden;border-radius:var(--ce-radius-lg);border:1px solid rgba(255, 255, 255, 0.1);background:var(--ce-terminal-bg)}.ce-term-bar{display:flex;gap:8px;border-bottom:1px solid rgba(255, 255, 255, 0.1);padding:16px}.ce-term-bar span{width:12px;height:12px;border-radius:var(--ce-radius-full)}.ce-term-dot-red{background:var(--ce-chrome-red)}.ce-term-dot-amber{background:var(--ce-chrome-amber)}.ce-term-dot-green{background:var(--ce-chrome-green)}.ce-term-pre{flex:1;overflow-x:auto;margin:0;background:var(--ce-terminal-body);padding:16px;font-family:var(--ce-font-mono);font-size:var(--ce-text-sm);line-height:1.5;color:#fff;scrollbar-width:none}.ce-term-pre::-webkit-scrollbar{display:none}.ce-term-pre code{white-space:pre;background:none;border:0;padding:0;color:inherit}.ce-term-cursor{animation:ce-blink 1s step-end infinite;color:var(--ce-chrome-green)}@keyframes ce-blink{0%,50%{opacity:1}51%,100%{opacity:0}}@media (max-width: 1200px){.ce-hero-title{font-size:2.5rem}}@media (max-width: 992px){.ce-hero-inner,.ce-skills{grid-template-columns:1fr}.ce-hero-inner{gap:40px;padding:56px 24px 56px}.ce-skills{gap:32px;padding:32px 24px}.ce-section{padding:56px 24px 0}.ce-cards,.ce-trio{grid-template-columns:1fr}.ce-guides{grid-template-columns:1fr;gap:0}.ce-chips{grid-template-columns:repeat(3, 1fr)}.ce-starters-head{grid-template-columns:1fr;gap:20px}}@media (max-width: 550px){.ce-hero-title{font-size:2rem}.ce-h2,.ce-skills-copy h2{font-size:1.625rem}.ce-chips{grid-template-columns:repeat(2, 1fr)}}@media (prefers-reduced-motion: reduce){.ce-home *,.ce-home *::before,.ce-home *::after{animation-duration:0.01ms!important;animation-iteration-count:1!important;transition-duration:0.01ms!important}}"}]}
{"page":{"pagePath":"api-reference/pos/coupons-\u0026-promotions/apply-coupon","slug":"/api-reference/pos/coupons-\u0026-promotions/apply-coupon","pageMetadata":{"title":"Apply coupon","description":"Applies a coupon code to the cart. Returns a fully updated `Cart` object with recalculated totals.","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/carts/{id}/coupon","href":"/api-reference/pos/coupons-\u0026-promotions/apply-coupon","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Applies a coupon code to the cart. Returns a fully updated \", _jsx(_components.code, {\n children: \"Cart\"\n }), \" object with recalculated totals.\"]\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":{"light":"github-light","dark":"github-dark"}},"config":{},"pageMetadata":{"title":"Apply coupon","description":"Applies a coupon code to the cart. Returns a fully updated `Cart` object with recalculated totals.","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/carts/{id}/coupon","href":"/api-reference/pos/coupons-\u0026-promotions/apply-coupon","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/tarkai/83faf160ccb5c4ff/header-float.js"],"openApiReferenceData":{"operation":{"tags":["Coupons \u0026 promotions"],"operationId":"pos-apply-coupon","summary":"Apply coupon","description":"Applies a coupon code to the cart. Returns a fully updated `Cart` object with recalculated totals.","externalDocs":{"url":"https://llm-docs.commercengine.io/admin-pos/operations/pos-apply-coupon"},"parameters":["bcc1ad28-8519-4707-a52f-e7378e9bd72a"],"requestBody":"eacf2550-e0a0-4df5-a00e-084888856915","responses":{"200":"e3d55b79-b541-4d25-9ffa-17c314da9071","400":"4a9b33be-f0d1-41b6-ba96-4af3bbbad472","401":"0ce4d9b5-cab1-4457-afc9-21dbce899a9d","403":"fa4e0079-71c4-45bc-b317-c98255fe5464","404":"f44e4887-5783-43de-9495-386bbc288e63","408":"c504f0aa-2fc8-420f-8cdd-95d50509b496","500":"53a2be0f-9c40-43b3-8828-e27047fd52ce","504":"6355d29a-2d67-4741-8054-88272e8a1f2a"},"security":["aa43f453-7371-4cb4-9531-f3d60c74f096"],"x-speakeasy-group":"pos","x-speakeasy-name-override":"applyCoupon","method":"post","type":"path","servers":["d5140fa8-2bd5-4c13-abb4-72a9479f9f58","503d314f-8bfe-43e5-9c58-f8d1033bbbb9"],"path":"/pos/carts/{id}/coupon","baseUrlOptions":["https://staging.api.commercengine.io/api/v1/{store_id}/storefront","https://prod.api.commercengine.io/api/v1/{store_id}/storefront"],"title":"Apply coupon","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{"bcc1ad28-8519-4707-a52f-e7378e9bd72a":{"name":"id","in":"path","description":"Cart ID","required":true,"schema":{"type":"string","maxLength":128,"minLength":1,"pattern":"^[A-Za-z0-9_-]{1,128}$","isRequired":true,"description":"Cart ID","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":["coupon_code"],"properties":{"coupon_code":{"type":"string","examples":["FLAT100OFF"],"minLength":1,"pattern":"\\S","isRequired":true,"uniqueKey":"coupon_code","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"coupon_code":"FLAT100OFF"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"e3d55b79-b541-4d25-9ffa-17c314da9071":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["message","success","content","events"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"success":{"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"content":{"properties":{"cart":{"type":"object","title":"CartRead","description":"This cart model is structured to capture a wide range of details, facilitating accurate representation and management of user shopping carts in an e-commerce platform.","required":["promotion_discount_percent","coupon_id","fulfillment_preference","shipping_provider_name","courier_company_name","id","user_id","customer_id","active","customer_note","is_promotion_applied","is_coupon_applied","coupon_code","coupon_discount_amount","coupon_discount_percent","promotion_discount_amount","subtotal","items_tax_amount","subtotal_including_tax","shipping_estimated_cost","shipping_discount_amount","shipping_amount","shipping_tax_rate","shipping_tax_amount","shipping_amount_including_tax","estimated_delivery_days","handling_charge_excluding_tax","handling_charge_tax_amount","handling_charge_including_tax","total_tax","grand_total","credit_balance_used","to_be_paid","loyalty_points_redeemed","loyalty_points_earned","cart_items_count","cart_items","billing_address","shipping_address","currency","metadata","expires_at","applied_promotions","applied_coupons","shipments","promotion_savings","coupon_savings","other_savings","total_savings","free_shipping_threshold","status","status_error_message","on_subscription","sales_channel","created_at","modified_at","cart_value","loyalty_point_eligible_amount"],"properties":{"id":{"description":"Unique identifier for the cart.","type":"string","pattern":"^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$","isRequired":true,"uniqueKey":"content.cart.id","typeLabel":"string"},"user_id":{"description":"The user who owns the cart. Can differ from `customer_id`, for example when several users belong to one business customer. For a POS cart, identifies the operator recorded as `pos_user_id` in `metadata`.","type":"string","isRequired":true,"uniqueKey":"content.cart.user_id","typeLabel":"string"},"customer_id":{"oneOf":[{"description":"The unique ID of the customer the cart is for. `null` until a customer is linked. The cart never embeds customer details — fetch them from the customer endpoints so they are always current.","type":"string","isRequired":true,"uniqueKey":"content.cart.customer_id.oneOf.0","typeLabel":"string"},{"description":"The unique ID of the customer the cart is for. `null` until a customer is linked. The cart never embeds customer details — fetch them from the customer endpoints so they are always current.","type":"null","isRequired":true,"uniqueKey":"content.cart.customer_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.customer_id","typeLabel":"string | null"},"active":{"description":"Indicates whether the cart is currently active or inactive.","type":"boolean","isRequired":true,"uniqueKey":"content.cart.active","typeLabel":"boolean"},"customer_note":{"oneOf":[{"description":"customer note for shipping or product customization.","type":"string","isRequired":true,"uniqueKey":"content.cart.customer_note.oneOf.0","typeLabel":"string"},{"description":"customer note for shipping or product customization.","type":"null","isRequired":true,"uniqueKey":"content.cart.customer_note.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.customer_note","typeLabel":"string | null"},"is_promotion_applied":{"description":"Indicates if a promotion is applied or not.","type":"boolean","isRequired":true,"uniqueKey":"content.cart.is_promotion_applied","typeLabel":"boolean"},"is_coupon_applied":{"description":"Indicates if a coupon is applied or not.","type":"boolean","isRequired":true,"uniqueKey":"content.cart.is_coupon_applied","typeLabel":"boolean"},"coupon_code":{"oneOf":[{"description":"Code of the applied coupon.","type":"string","isRequired":true,"uniqueKey":"content.cart.coupon_code.oneOf.0","typeLabel":"string"},{"description":"Code of the applied coupon.","type":"null","isRequired":true,"uniqueKey":"content.cart.coupon_code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.coupon_code","typeLabel":"string | null"},"coupon_discount_amount":{"description":"Discount amount due to the coupon.","type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"content.cart.coupon_discount_amount","typeLabel":"number\u003cdouble>"},"coupon_discount_percent":{"oneOf":[{"description":"Discount percentage of the applied coupon. `null` if no coupon has been applied to the cart yet.","type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"content.cart.coupon_discount_percent.oneOf.0","typeLabel":"number\u003cdouble>"},{"description":"Discount percentage of the applied coupon. `null` if no coupon has been applied to the cart yet.","type":"null","format":"double","minimum":0,"isRequired":true,"uniqueKey":"content.cart.coupon_discount_percent.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.coupon_discount_percent","typeLabel":"number\u003cdouble> | null"},"promotion_discount_amount":{"description":"Discount amount due to promotions(If Applied).","type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"content.cart.promotion_discount_amount","typeLabel":"number\u003cdouble>"},"promotion_discount_percent":{"description":"Discount amount due to promotions(If Applied).","type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"content.cart.promotion_discount_percent","typeLabel":"number\u003cdouble>"},"subtotal":{"description":"Subtotal amount for items in the cart.","type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"content.cart.subtotal","typeLabel":"number\u003cdouble>"},"items_tax_amount":{"description":"Total tax amount for items.","type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"content.cart.items_tax_amount","typeLabel":"number\u003cdouble>"},"subtotal_including_tax":{"description":"Subtotal including tax.","type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"content.cart.subtotal_including_tax","typeLabel":"number\u003cdouble>"},"shipping_estimated_cost":{"oneOf":[{"description":"Estimated cost of shipping.","type":"number","isRequired":true,"uniqueKey":"content.cart.shipping_estimated_cost.oneOf.0","typeLabel":"number"},{"description":"Estimated cost of shipping.","type":"null","isRequired":true,"uniqueKey":"content.cart.shipping_estimated_cost.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.shipping_estimated_cost","typeLabel":"number | null"},"shipping_discount_amount":{"oneOf":[{"description":"Discount applied on estimated shipping cost.","type":"number","isRequired":true,"uniqueKey":"content.cart.shipping_discount_amount.oneOf.0","typeLabel":"number"},{"description":"Discount applied on estimated shipping cost.","type":"null","isRequired":true,"uniqueKey":"content.cart.shipping_discount_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.shipping_discount_amount","typeLabel":"number | null"},"shipping_amount":{"oneOf":[{"description":"Shipping amount chargable to customer.","type":"number","isRequired":true,"uniqueKey":"content.cart.shipping_amount.oneOf.0","typeLabel":"number"},{"description":"Shipping amount chargable to customer.","type":"null","isRequired":true,"uniqueKey":"content.cart.shipping_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.shipping_amount","typeLabel":"number | null"},"shipping_tax_rate":{"oneOf":[{"description":"Shipping tax rate applied on shipping amount.","type":"number","isRequired":true,"uniqueKey":"content.cart.shipping_tax_rate.oneOf.0","typeLabel":"number"},{"description":"Shipping tax rate applied on shipping amount.","type":"null","isRequired":true,"uniqueKey":"content.cart.shipping_tax_rate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.shipping_tax_rate","typeLabel":"number | null"},"shipping_tax_amount":{"oneOf":[{"description":"Tax applied on shipping_amount.","type":"number","isRequired":true,"uniqueKey":"content.cart.shipping_tax_amount.oneOf.0","typeLabel":"number"},{"description":"Tax applied on shipping_amount.","type":"null","isRequired":true,"uniqueKey":"content.cart.shipping_tax_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.shipping_tax_amount","typeLabel":"number | null"},"shipping_amount_including_tax":{"oneOf":[{"description":"Shipping amount including shipping tax.","type":"number","isRequired":true,"uniqueKey":"content.cart.shipping_amount_including_tax.oneOf.0","typeLabel":"number"},{"description":"Shipping amount including shipping tax.","type":"null","isRequired":true,"uniqueKey":"content.cart.shipping_amount_including_tax.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.shipping_amount_including_tax","typeLabel":"number | null"},"fulfillment_preference":{"oneOf":[{"type":"object","title":"CollectInStoreFulfillment","description":"How the customer wants to receive their order. Discriminated by `fulfillment_type`: `delivery` for home delivery, `collect-in-store` for in-store pickup, or `partial-collect-and-delivery` for a mix of both.","required":["fulfillment_type","pickup_location_id","preference_type"],"x-tags":["Carts"],"properties":{"fulfillment_type":{"type":"string","const":"collect-in-store","isRequired":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.0.fulfillment_type","typeLabel":"string"},"preference_type":{"type":"string","enum":["user","auto"],"readOnly":true,"isRequired":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.0.preference_type","typeLabel":"enum\u003cstring>"},"pickup_location_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.0.pickup_location_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.0.pickup_location_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.0.pickup_location_id","typeLabel":"string | null"},"pickup_location_name":{"oneOf":[{"type":"string","readOnly":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.0.pickup_location_name.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.0.pickup_location_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.cart.fulfillment_preference.oneOf.0.pickup_location_name","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.0","typeLabel":"CollectInStoreFulfillment · object"},{"type":"object","title":"DeliveryFulfillment","description":"How the customer wants to receive their order. Discriminated by `fulfillment_type`: `delivery` for home delivery, `collect-in-store` for in-store pickup, or `partial-collect-and-delivery` for a mix of both.","required":["fulfillment_type","shipments","preference_type"],"x-tags":["Carts"],"properties":{"fulfillment_type":{"type":"string","const":"delivery","isRequired":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.1.fulfillment_type","typeLabel":"string"},"preference_type":{"type":"string","enum":["user","auto"],"readOnly":true,"isRequired":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.1.preference_type","typeLabel":"enum\u003cstring>"},"shipments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.1.shipments.items.[INDEX].id","typeLabel":"string"},"shipping_provider_id":{"type":"string","isRequired":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.1.shipments.items.[INDEX].shipping_provider_id","typeLabel":"string"},"shipping_provider_name":{"oneOf":[{"type":"string","readOnly":true,"isRequired":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.1.shipments.items.[INDEX].shipping_provider_name.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"isRequired":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.1.shipments.items.[INDEX].shipping_provider_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.1.shipments.items.[INDEX].shipping_provider_name","typeLabel":"string | null"},"courier_company_name":{"oneOf":[{"type":"string","readOnly":true,"isRequired":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.1.shipments.items.[INDEX].courier_company_name.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"isRequired":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.1.shipments.items.[INDEX].courier_company_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.1.shipments.items.[INDEX].courier_company_name","typeLabel":"string | null"},"courier_company_id":{"oneOf":[{"type":"string","uniqueKey":"content.cart.fulfillment_preference.oneOf.1.shipments.items.[INDEX].courier_company_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"content.cart.fulfillment_preference.oneOf.1.shipments.items.[INDEX].courier_company_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.cart.fulfillment_preference.oneOf.1.shipments.items.[INDEX].courier_company_id","typeLabel":"string | null"}},"required":["id","shipping_provider_id","shipping_provider_name","courier_company_name"],"uniqueKey":"content.cart.fulfillment_preference.oneOf.1.shipments.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.1.shipments","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.1","typeLabel":"DeliveryFulfillment · object"},{"type":"object","title":"PartialCollectAndDelivery","description":"Automatic preferences can omit `collect_in_store` and `delivery`. Provide both for a user-selected preference.","required":["fulfillment_type","preference_type"],"x-tags":["Carts"],"properties":{"fulfillment_type":{"type":"string","const":"partial-collect-and-delivery","isRequired":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.2.fulfillment_type","typeLabel":"string"},"preference_type":{"type":"string","enum":["user","auto"],"readOnly":true,"isRequired":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.2.preference_type","typeLabel":"enum\u003cstring>"},"collect_in_store":{"type":"object","properties":{"pickup_location_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.2.collect_in_store.pickup_location_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.2.collect_in_store.pickup_location_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.2.collect_in_store.pickup_location_id","typeLabel":"string | null"},"items":{"type":"array","items":{"title":"FulfillmentItem","type":"object","externalDocs":{"url":"https://llm-docs.commercengine.io/admin-pos/schemas/FulfillmentItem"},"required":["product_id","product_name","variant_id","variant_name","quantity"],"properties":{"product_id":{"type":"string","isRequired":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.2.collect_in_store.\\items.items.[INDEX].product_id","typeLabel":"string"},"product_name":{"type":"string","readOnly":true,"isRequired":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.2.collect_in_store.\\items.items.[INDEX].product_name","typeLabel":"string"},"variant_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.2.collect_in_store.\\items.items.[INDEX].variant_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.2.collect_in_store.\\items.items.[INDEX].variant_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.2.collect_in_store.\\items.items.[INDEX].variant_id","typeLabel":"string | null"},"variant_name":{"oneOf":[{"type":"string","readOnly":true,"isRequired":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.2.collect_in_store.\\items.items.[INDEX].variant_name.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"isRequired":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.2.collect_in_store.\\items.items.[INDEX].variant_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.2.collect_in_store.\\items.items.[INDEX].variant_name","typeLabel":"string | null"},"quantity":{"type":"integer","minimum":1,"isRequired":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.2.collect_in_store.\\items.items.[INDEX].quantity","typeLabel":"integer"}},"uniqueKey":"content.cart.fulfillment_preference.oneOf.2.collect_in_store.\\items.items.[INDEX]","typeLabel":"FulfillmentItem · object"},"isRequired":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.2.collect_in_store.\\items","typeLabel":"FulfillmentItem · object[]"},"pickup_location_name":{"oneOf":[{"type":"string","readOnly":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.2.collect_in_store.pickup_location_name.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.2.collect_in_store.pickup_location_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.cart.fulfillment_preference.oneOf.2.collect_in_store.pickup_location_name","typeLabel":"string | null"}},"required":["items","pickup_location_id"],"uniqueKey":"content.cart.fulfillment_preference.oneOf.2.collect_in_store","typeLabel":"object"},"delivery":{"type":"object","properties":{"shipping_provider_id":{"type":"string","isRequired":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.2.delivery.shipping_provider_id","typeLabel":"string"},"items":{"type":"array","items":{"title":"FulfillmentItem","type":"object","externalDocs":{"url":"https://llm-docs.commercengine.io/admin-pos/schemas/FulfillmentItem"},"required":["product_id","product_name","variant_id","variant_name","quantity"],"properties":{"product_id":{"type":"string","isRequired":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.2.delivery.\\items.items.[INDEX].product_id","typeLabel":"string"},"product_name":{"type":"string","readOnly":true,"isRequired":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.2.delivery.\\items.items.[INDEX].product_name","typeLabel":"string"},"variant_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.2.delivery.\\items.items.[INDEX].variant_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.2.delivery.\\items.items.[INDEX].variant_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.2.delivery.\\items.items.[INDEX].variant_id","typeLabel":"string | null"},"variant_name":{"oneOf":[{"type":"string","readOnly":true,"isRequired":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.2.delivery.\\items.items.[INDEX].variant_name.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"isRequired":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.2.delivery.\\items.items.[INDEX].variant_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.2.delivery.\\items.items.[INDEX].variant_name","typeLabel":"string | null"},"quantity":{"type":"integer","minimum":1,"isRequired":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.2.delivery.\\items.items.[INDEX].quantity","typeLabel":"integer"}},"uniqueKey":"content.cart.fulfillment_preference.oneOf.2.delivery.\\items.items.[INDEX]","typeLabel":"FulfillmentItem · object"},"isRequired":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.2.delivery.\\items","typeLabel":"FulfillmentItem · object[]"},"shipping_provider_name":{"oneOf":[{"type":"string","readOnly":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.2.delivery.shipping_provider_name.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.2.delivery.shipping_provider_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.cart.fulfillment_preference.oneOf.2.delivery.shipping_provider_name","typeLabel":"string | null"},"courier_company_id":{"oneOf":[{"type":"string","uniqueKey":"content.cart.fulfillment_preference.oneOf.2.delivery.courier_company_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"content.cart.fulfillment_preference.oneOf.2.delivery.courier_company_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.cart.fulfillment_preference.oneOf.2.delivery.courier_company_id","typeLabel":"string | null"},"courier_company_name":{"oneOf":[{"type":"string","readOnly":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.2.delivery.courier_company_name.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.2.delivery.courier_company_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.cart.fulfillment_preference.oneOf.2.delivery.courier_company_name","typeLabel":"string | null"}},"required":["shipping_provider_id","items"],"uniqueKey":"content.cart.fulfillment_preference.oneOf.2.delivery","typeLabel":"object"}},"isRequired":true,"uniqueKey":"content.cart.fulfillment_preference.oneOf.2","typeLabel":"PartialCollectAndDelivery · object"}],"isRequired":true,"uniqueKey":"content.cart.fulfillment_preference","typeLabel":"CollectInStoreFulfillment · object | DeliveryFulfillment · object | PartialCollectAndDelivery · object"},"estimated_delivery_days":{"oneOf":[{"description":"Estimated delivery time across the cart's shipments, as a range of days `\"\u003cmin>-\u003cmax>\"` (e.g. `\"2-5\"`). `null` until the shipments have a delivery estimate.","type":"string","isRequired":true,"uniqueKey":"content.cart.estimated_delivery_days.oneOf.0","typeLabel":"string"},{"description":"Estimated delivery time across the cart's shipments, as a range of days `\"\u003cmin>-\u003cmax>\"` (e.g. `\"2-5\"`). `null` until the shipments have a delivery estimate.","type":"null","isRequired":true,"uniqueKey":"content.cart.estimated_delivery_days.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.estimated_delivery_days","typeLabel":"string | null"},"handling_charge_excluding_tax":{"description":"The additional charge applied to cover the costs associated with processing, packaging, and handling an order. This fee is separate from shipping charges and may include materials, or special handling requirements.","type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"content.cart.handling_charge_excluding_tax","typeLabel":"number\u003cdouble>"},"handling_charge_tax_amount":{"type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"content.cart.handling_charge_tax_amount","typeLabel":"number\u003cdouble>"},"handling_charge_including_tax":{"type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"content.cart.handling_charge_including_tax","typeLabel":"number\u003cdouble>"},"total_tax":{"description":"Total tax amount for the entire cart.","type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"content.cart.total_tax","typeLabel":"number\u003cdouble>"},"grand_total":{"description":"Grand total amount for the cart.","type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"content.cart.grand_total","typeLabel":"number\u003cdouble>"},"credit_balance_used":{"description":"Amount of credit balance used.","type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"content.cart.credit_balance_used","typeLabel":"number\u003cdouble>"},"to_be_paid":{"description":"Amount to be paid by the customer: `grand_total` less the applied credit balance, rounded down to a whole currency unit. Negative when the applied credit exceeds the cart total, for example after items are removed; reduce the credit before checkout.","type":"number","format":"double","isRequired":true,"uniqueKey":"content.cart.to_be_paid","typeLabel":"number\u003cdouble>"},"loyalty_points_redeemed":{"description":"Number of loyalty points redeemed.","type":"number","minimum":0,"isRequired":true,"uniqueKey":"content.cart.loyalty_points_redeemed","typeLabel":"number"},"loyalty_points_earned":{"description":"Number of loyalty points earned.","type":"number","minimum":0,"isRequired":true,"uniqueKey":"content.cart.loyalty_points_earned","typeLabel":"number"},"cart_items_count":{"description":"Number of items in the cart.","type":"integer","minimum":0,"isRequired":true,"uniqueKey":"content.cart.cart_items_count","typeLabel":"integer"},"cart_items":{"type":"array","items":{"type":"object","title":"CartItemRead","description":"This Cart Item model captures the attributes of a cart item, including product details, pricing information, subscription details, and other relevant information related to Cart Item.","required":["original_selling_price","discount_amount","subscription_plan","subscription_interval","subscription_frequency","subscription_eligibility","available_subscription_plans","seller_id","seller_product_id","seller_variant_id","seller_detail","product_id","variant_id","sku","product_slug","variant_slug","product_name","variant_name","product_type","product_image_url","stock_available","backorder","on_subscription","on_promotion","quantity","is_free_item","free_quantity","promotion_discount_amount","coupon_discount_amount","price_including_tax","listing_price","selling_price","selling_price_excluding_tax","min_order_quantity","max_order_quantity","incremental_quantity","handling_charge_excluding_tax","handling_charge_tax_rate","handling_charge_including_tax","tax_type","tax_rate","tax_amount","associated_options","attributes","subscriptions"],"properties":{"product_id":{"type":"string","description":"Unique identifier for the product.","pattern":"^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].product_id","typeLabel":"string"},"variant_id":{"oneOf":[{"type":"string","description":"The product variant identifier. `null` if the product has no variants.","pattern":"^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].variant_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The product variant identifier. `null` if the product has no variants.","pattern":"^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].variant_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].variant_id","typeLabel":"string | null"},"sku":{"oneOf":[{"type":"string","description":"Stock Keeping Unit, a unique identifier for the product within inventory.","example":"SKU1254","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].sku.oneOf.0","typeLabel":"string"},{"type":"null","description":"Stock Keeping Unit, a unique identifier for the product within inventory.","example":"SKU1254","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].sku.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].sku","typeLabel":"string | null"},"product_name":{"type":"string","description":"Name of the product.","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].product_name","typeLabel":"string"},"variant_name":{"oneOf":[{"type":"string","description":"Name of the variant.","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].variant_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Name of the variant.","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].variant_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].variant_name","typeLabel":"string | null"},"product_slug":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].product_slug.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].product_slug.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].product_slug","typeLabel":"string | null"},"variant_slug":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].variant_slug.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].variant_slug.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].variant_slug","typeLabel":"string | null"},"product_type":{"type":"string","enum":["physical","digital","bundle"],"example":"physical","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].product_type","typeLabel":"enum\u003cstring>"},"product_image_url":{"oneOf":[{"type":"string","description":"URL pointing to the product image. `null` when the product has no images.","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].product_image_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL pointing to the product image. `null` when the product has no images.","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].product_image_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].product_image_url","typeLabel":"string | null"},"stock_available":{"type":"boolean","description":"Indicates whether the product is currently in stock.","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].stock_available","typeLabel":"boolean"},"backorder":{"type":"boolean","description":"Indicates whether the item is being fulfilled as a backorder. When true, the item is not currently in stock and will ship later once inventory is available. This may result in the order being split into multiple shipments, with delays for the backordered portion.","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].backorder","typeLabel":"boolean"},"on_subscription":{"type":"boolean","description":"Indicates whether the product is currently on a subscription.","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].on_subscription","typeLabel":"boolean"},"on_promotion":{"type":"boolean","description":"Indicates whether the product is part of a promotion.","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].on_promotion","typeLabel":"boolean"},"quantity":{"type":"integer","description":"The quantity of the product in the cart.","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].quantity","typeLabel":"integer"},"is_free_item":{"type":"boolean","description":"Indicates if the product is offered for free.","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].is_free_item","typeLabel":"boolean"},"free_quantity":{"type":"integer","description":"Quantity of the product that is free.","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].free_quantity","typeLabel":"integer"},"promotion_discount_amount":{"type":"number","description":"Discount amount due to promotions.","format":"double","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].promotion_discount_amount","typeLabel":"number\u003cdouble>"},"coupon_discount_amount":{"type":"number","description":"Discount amount due to applied coupons.","format":"double","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].coupon_discount_amount","typeLabel":"number\u003cdouble>"},"price_including_tax":{"type":"boolean","description":"Indicates whether the item price is inclusive of taxes.","example":false,"isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].price_including_tax","typeLabel":"boolean"},"listing_price":{"type":"number","format":"double","example":200,"isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].listing_price","typeLabel":"number\u003cdouble>"},"selling_price":{"type":"number","format":"double","example":199,"isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].selling_price","typeLabel":"number\u003cdouble>"},"selling_price_excluding_tax":{"type":"number","format":"double","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].selling_price_excluding_tax","typeLabel":"number\u003cdouble>"},"min_order_quantity":{"type":"integer","default":1,"isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].min_order_quantity","typeLabel":"integer"},"max_order_quantity":{"oneOf":[{"type":"integer","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].max_order_quantity.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].max_order_quantity.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].max_order_quantity","typeLabel":"integer | null"},"incremental_quantity":{"type":"integer","default":1,"isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].incremental_quantity","typeLabel":"integer"},"handling_charge_excluding_tax":{"type":"number","description":"Additional cost for shipping associated with the product.","minimum":0,"readOnly":true,"isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].handling_charge_excluding_tax","typeLabel":"number"},"handling_charge_tax_rate":{"type":"number","description":"Additional cost for shipping associated with the product.","minimum":0,"readOnly":true,"isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].handling_charge_tax_rate","typeLabel":"number"},"handling_charge_including_tax":{"type":"number","description":"Additional cost for shipping associated with the product.","minimum":0,"readOnly":true,"isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].handling_charge_including_tax","typeLabel":"number"},"tax_type":{"type":"string","description":"Type of tax applied (e.g., GST).","default":"GST","enum":["GST","VAT","ECO"],"isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].tax_type","typeLabel":"enum\u003cstring>"},"tax_rate":{"type":"number","description":"The rate of tax applied to the product.","format":"double","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].tax_rate","typeLabel":"number\u003cdouble>"},"tax_amount":{"type":"number","description":"The total tax amount for the product.","format":"double","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].tax_amount","typeLabel":"number\u003cdouble>"},"associated_options":{"oneOf":[{"type":"object","title":"AssociatedOption","description":"Used when `variant_id` is not null.","example":{"background_color":{"name":"Background Color","value":{"name":"Blue","hexcode":"#0000FF"},"type":"color"},"size":{"name":"Size","value":"Large","type":"single-select"}},"additionalProperties":{"oneOf":[{"type":"object","title":"ColorOption","required":["name","type","value"],"properties":{"name":{"type":"string","description":"The name of the associated option.","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].associated_options.oneOf.0.additionalProperties.oneOf.0.name","typeLabel":"string"},"type":{"description":"The type of the associated option.","const":"color","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].associated_options.oneOf.0.additionalProperties.oneOf.0.type","typeLabel":"any"},"value":{"type":"object","required":["name","hexcode"],"properties":{"hexcode":{"type":"string","description":"The hex code of the color (e.g., #000000).","format":"color-hex","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}$","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].associated_options.oneOf.0.additionalProperties.oneOf.0.value.hexcode","typeLabel":"string\u003ccolor-hex>"},"name":{"type":"string","description":"The name of the color.","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].associated_options.oneOf.0.additionalProperties.oneOf.0.value.name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].associated_options.oneOf.0.additionalProperties.oneOf.0.value","typeLabel":"object"}},"uniqueKey":"content.cart.cart_items.items.[INDEX].associated_options.oneOf.0.additionalProperties.oneOf.0","typeLabel":"ColorOption · object"},{"type":"object","title":"SingleSelectOption","required":["name","type","value"],"properties":{"name":{"type":"string","description":"The name of the associated option.","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].associated_options.oneOf.0.additionalProperties.oneOf.1.name","typeLabel":"string"},"type":{"description":"The type of the associated option.","const":"single-select","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].associated_options.oneOf.0.additionalProperties.oneOf.1.type","typeLabel":"any"},"value":{"type":"string","description":"The value of the associated option","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].associated_options.oneOf.0.additionalProperties.oneOf.1.value","typeLabel":"string"}},"uniqueKey":"content.cart.cart_items.items.[INDEX].associated_options.oneOf.0.additionalProperties.oneOf.1","typeLabel":"SingleSelectOption · object"}],"uniqueKey":"content.cart.cart_items.items.[INDEX].associated_options.oneOf.0.additionalProperties","typeLabel":"ColorOption · object | SingleSelectOption · object"},"isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].associated_options.oneOf.0","typeLabel":"AssociatedOption · object"},{"type":"null","description":"Null when `variant_id` is null.","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].associated_options.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].associated_options","typeLabel":"AssociatedOption · object | null"},"attributes":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"object","title":"ColorAttribute","description":"Attribute for colors","required":["id","name","key","type","value"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.0.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.0.name","typeLabel":"string"},"key":{"type":"string","description":"A lookup safe version of the name that is lowercased and spaces are replaced with underscores. For instance, if name is `Product Type`, key will be `product_type`","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.0.key","typeLabel":"string"},"type":{"type":"string","const":"color","example":"color","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.0.type","typeLabel":"string"},"value":{"type":"object","required":["name","hexcode"],"properties":{"hexcode":{"type":"string","description":"The hex code of the color (e.g., #000000).","format":"color-hex","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}$","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.0.value.hexcode","typeLabel":"string\u003ccolor-hex>"},"name":{"type":"string","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.0.value.name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.0.value","typeLabel":"object"}},"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.0","typeLabel":"ColorAttribute · object"},{"type":"object","title":"SingleSelectAttribute","description":"Attribute for single-select values","required":["id","name","key","type","value"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.1.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.1.name","typeLabel":"string"},"key":{"type":"string","description":"A lookup safe version of the name that is lowercased and spaces are replaced with underscores. For instance, if name is `Product Type`, key will be `product_type`","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.1.key","typeLabel":"string"},"type":{"type":"string","const":"single-select","example":"single-select","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.1.type","typeLabel":"string"},"value":{"type":"string","description":"For single-select attributes","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.1.value","typeLabel":"string"}},"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.1","typeLabel":"SingleSelectAttribute · object"},{"type":"object","title":"TextAttribute","description":"Attribute for text values","required":["id","name","key","type","value"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.2.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.2.name","typeLabel":"string"},"key":{"type":"string","description":"A lookup safe version of the name that is lowercased and spaces are replaced with underscores. For instance, if name is `Product Type`, key will be `product_type`","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.2.key","typeLabel":"string"},"type":{"type":"string","const":"text","example":"text","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.2.type","typeLabel":"string"},"value":{"type":"string","description":"For text attributes","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.2.value","typeLabel":"string"}},"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.2","typeLabel":"TextAttribute · object"},{"type":"object","title":"DateAttribute","description":"Attribute for date values","required":["id","name","key","type","value"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.3.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.3.name","typeLabel":"string"},"key":{"type":"string","description":"A lookup safe version of the name that is lowercased and spaces are replaced with underscores. For instance, if name is `Product Type`, key will be `product_type`","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.3.key","typeLabel":"string"},"type":{"type":"string","const":"date","example":"date","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.3.type","typeLabel":"string"},"value":{"type":"string","description":"`YYYY-MM-DD`, optionally followed by ` HH:MM`, ` HH:MM:SS`, or ` HH:MM:SS.ffffff`.","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.3.value","typeLabel":"string"}},"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.3","typeLabel":"DateAttribute · object"},{"type":"object","title":"MultiSelectAttribute","description":"Attribute for multi-select values","required":["id","name","key","type","value"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.4.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.4.name","typeLabel":"string"},"key":{"type":"string","description":"A lookup safe version of the name that is lowercased and spaces are replaced with underscores. For instance, if name is `Product Type`, key will be `product_type`","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.4.key","typeLabel":"string"},"type":{"type":"string","const":"multi-select","example":"multi-select","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.4.type","typeLabel":"string"},"value":{"type":"array","items":{"type":"string","uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.4.value.items.[INDEX]","typeLabel":"string"},"description":"For multi-select attributes","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.4.value","typeLabel":"string[]"}},"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.4","typeLabel":"MultiSelectAttribute · object"},{"type":"object","title":"SingleSelectAttribute","description":"Attribute for single-select values","required":["id","name","key","type","value"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.5.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.5.name","typeLabel":"string"},"key":{"type":"string","description":"A lookup safe version of the name that is lowercased and spaces are replaced with underscores. For instance, if name is `Product Type`, key will be `product_type`","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.5.key","typeLabel":"string"},"type":{"type":"string","const":"single-select","example":"single-select","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.5.type","typeLabel":"string"},"value":{"type":"string","description":"For single-select attributes","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.5.value","typeLabel":"string"}},"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.5","typeLabel":"SingleSelectAttribute · object"},{"type":"object","title":"TextAttribute","description":"Attribute for text values","required":["id","name","key","type","value"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.6.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.6.name","typeLabel":"string"},"key":{"type":"string","description":"A lookup safe version of the name that is lowercased and spaces are replaced with underscores. For instance, if name is `Product Type`, key will be `product_type`","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.6.key","typeLabel":"string"},"type":{"type":"string","const":"text","example":"text","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.6.type","typeLabel":"string"},"value":{"type":"string","description":"For text attributes","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.6.value","typeLabel":"string"}},"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.6","typeLabel":"TextAttribute · object"},{"type":"object","title":"DateAttribute","description":"Attribute for date values","required":["id","name","key","type","value"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.7.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.7.name","typeLabel":"string"},"key":{"type":"string","description":"A lookup safe version of the name that is lowercased and spaces are replaced with underscores. For instance, if name is `Product Type`, key will be `product_type`","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.7.key","typeLabel":"string"},"type":{"type":"string","const":"date","example":"date","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.7.type","typeLabel":"string"},"value":{"type":"string","description":"`YYYY-MM-DD`, optionally followed by ` HH:MM`, ` HH:MM:SS`, or ` HH:MM:SS.ffffff`.","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.7.value","typeLabel":"string"}},"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.7","typeLabel":"DateAttribute · object"},{"type":"object","title":"SingleSelectAttribute","description":"Attribute for single-select values","required":["id","name","key","type","value"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.8.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.8.name","typeLabel":"string"},"key":{"type":"string","description":"A lookup safe version of the name that is lowercased and spaces are replaced with underscores. For instance, if name is `Product Type`, key will be `product_type`","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.8.key","typeLabel":"string"},"type":{"type":"string","const":"single-select","example":"single-select","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.8.type","typeLabel":"string"},"value":{"type":"string","description":"For single-select attributes","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.8.value","typeLabel":"string"}},"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.8","typeLabel":"SingleSelectAttribute · object"},{"type":"object","title":"TextAttribute","description":"Attribute for text values","required":["id","name","key","type","value"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.9.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.9.name","typeLabel":"string"},"key":{"type":"string","description":"A lookup safe version of the name that is lowercased and spaces are replaced with underscores. For instance, if name is `Product Type`, key will be `product_type`","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.9.key","typeLabel":"string"},"type":{"type":"string","const":"text","example":"text","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.9.type","typeLabel":"string"},"value":{"type":"string","description":"For text attributes","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.9.value","typeLabel":"string"}},"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.9","typeLabel":"TextAttribute · object"},{"type":"object","title":"DateAttribute","description":"Attribute for date values","required":["id","name","key","type","value"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.10.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.10.name","typeLabel":"string"},"key":{"type":"string","description":"A lookup safe version of the name that is lowercased and spaces are replaced with underscores. For instance, if name is `Product Type`, key will be `product_type`","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.10.key","typeLabel":"string"},"type":{"type":"string","const":"date","example":"date","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.10.type","typeLabel":"string"},"value":{"type":"string","description":"`YYYY-MM-DD`, optionally followed by ` HH:MM`, ` HH:MM:SS`, or ` HH:MM:SS.ffffff`.","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.10.value","typeLabel":"string"}},"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.10","typeLabel":"DateAttribute · object"},{"type":"object","title":"NumberAttribute","description":"Attribute for numeric values","required":["id","name","key","type","value"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.11.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.11.name","typeLabel":"string"},"key":{"type":"string","description":"A lookup safe version of the name that is lowercased and spaces are replaced with underscores. For instance, if name is `Product Type`, key will be `product_type`","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.11.key","typeLabel":"string"},"type":{"type":"string","const":"number","example":"number","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.11.type","typeLabel":"string"},"value":{"type":"number","description":"For numeric attributes","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.11.value","typeLabel":"number"}},"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.11","typeLabel":"NumberAttribute · object"},{"type":"object","title":"BooleanAttribute","description":"Attribute for boolean values","required":["id","name","key","type","value"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.12.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.12.name","typeLabel":"string"},"key":{"type":"string","description":"A lookup safe version of the name that is lowercased and spaces are replaced with underscores. For instance, if name is `Product Type`, key will be `product_type`","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.12.key","typeLabel":"string"},"type":{"type":"string","const":"boolean","example":"boolean","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.12.type","typeLabel":"string"},"value":{"type":"boolean","description":"For boolean attributes","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.12.value","typeLabel":"boolean"}},"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.12","typeLabel":"BooleanAttribute · object"}],"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0.items.[INDEX]","typeLabel":"ColorAttribute · object · SingleSelectAttribute · object · TextAttribute · object · DateAttribute · object · MultiSelectAttribute · object · SingleSelectAttribute · object · TextAttribute · object · DateAttribute · object · SingleSelectAttribute · object · TextAttribute · object · DateAttribute · object · NumberAttribute · object · BooleanAttribute · object"},"description":"The product's attributes. `null` or empty when the product has none.","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.0","typeLabel":"ColorAttribute · object · SingleSelectAttribute · object · TextAttribute · object · DateAttribute · object · MultiSelectAttribute · object · SingleSelectAttribute · object · TextAttribute · object · DateAttribute · object · SingleSelectAttribute · object · TextAttribute · object · DateAttribute · object · NumberAttribute · object · BooleanAttribute · object[]"},{"type":"null","description":"The product's attributes. `null` or empty when the product has none.","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].attributes","typeLabel":"ColorAttribute · object · SingleSelectAttribute · object · TextAttribute · object · DateAttribute · object · MultiSelectAttribute · object · SingleSelectAttribute · object · TextAttribute · object · DateAttribute · object · SingleSelectAttribute · object · TextAttribute · object · DateAttribute · object · NumberAttribute · object · BooleanAttribute · object[] | null"},"subscriptions":{"oneOf":[{"type":"array","items":{"type":"object","title":"ProductSubscription","required":["subscription_plan_id","subscription_plan","subscription_price","billing_interval","billing_frequency","billing_limit","fulfill_separately","order_interval","order_frequency","order_limit","minimum_quantity","billing_trial_days"],"properties":{"subscription_plan_id":{"oneOf":[{"type":"string","description":"Stored subscription plan ID; null for older search entries without one.","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].subscriptions.oneOf.0.items.[INDEX].subscription_plan_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Stored subscription plan ID; null for older search entries without one.","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].subscriptions.oneOf.0.items.[INDEX].subscription_plan_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].subscriptions.oneOf.0.items.[INDEX].subscription_plan_id","typeLabel":"string | null"},"subscription_plan":{"type":"string","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].subscriptions.oneOf.0.items.[INDEX].subscription_plan","typeLabel":"string"},"subscription_price":{"type":"number","format":"double","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].subscriptions.oneOf.0.items.[INDEX].subscription_price","typeLabel":"number\u003cdouble>"},"billing_interval":{"type":"integer","description":"Billing interval determines the frequency for which the customer is charged for the subscription itself.","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].subscriptions.oneOf.0.items.[INDEX].billing_interval","typeLabel":"integer"},"billing_frequency":{"type":"string","enum":["Weekly","Bimonthly","Monthly","Quarterly","Semiannually","Annually"],"example":"Monthly","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].subscriptions.oneOf.0.items.[INDEX].billing_frequency","typeLabel":"enum\u003cstring>"},"billing_limit":{"oneOf":[{"type":"integer","description":"`null` means unlimited billing cycles.","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].subscriptions.oneOf.0.items.[INDEX].billing_limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"`null` means unlimited billing cycles.","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].subscriptions.oneOf.0.items.[INDEX].billing_limit.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].subscriptions.oneOf.0.items.[INDEX].billing_limit","typeLabel":"integer | null"},"fulfill_separately":{"type":"boolean","default":false,"isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].subscriptions.oneOf.0.items.[INDEX].fulfill_separately","typeLabel":"boolean"},"order_interval":{"oneOf":[{"type":"integer","description":"order interval defines the frequency of when the subscription sends customers the product","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].subscriptions.oneOf.0.items.[INDEX].order_interval.oneOf.0","typeLabel":"integer"},{"type":"null","description":"order interval defines the frequency of when the subscription sends customers the product","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].subscriptions.oneOf.0.items.[INDEX].order_interval.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].subscriptions.oneOf.0.items.[INDEX].order_interval","typeLabel":"integer | null"},"order_frequency":{"oneOf":[{"type":"string","enum":["Weekly","Bimonthly","Monthly","Quarterly","Semiannually","Annually",null],"example":"Monthly","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].subscriptions.oneOf.0.items.[INDEX].order_frequency.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["Weekly","Bimonthly","Monthly","Quarterly","Semiannually","Annually",null],"example":"Monthly","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].subscriptions.oneOf.0.items.[INDEX].order_frequency.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].subscriptions.oneOf.0.items.[INDEX].order_frequency","typeLabel":"enum\u003cstring> | null"},"order_limit":{"oneOf":[{"type":"integer","description":"`null` means unlimited fulfillment cycles.","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].subscriptions.oneOf.0.items.[INDEX].order_limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"`null` means unlimited fulfillment cycles.","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].subscriptions.oneOf.0.items.[INDEX].order_limit.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].subscriptions.oneOf.0.items.[INDEX].order_limit","typeLabel":"integer | null"},"minimum_quantity":{"type":"integer","description":"The quantity of the plan to which the customer should be subscribed","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].subscriptions.oneOf.0.items.[INDEX].minimum_quantity","typeLabel":"integer"},"billing_trial_days":{"type":"integer","description":"Use in digital product only for trial period","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].subscriptions.oneOf.0.items.[INDEX].billing_trial_days","typeLabel":"integer"}},"uniqueKey":"content.cart.cart_items.items.[INDEX].subscriptions.oneOf.0.items.[INDEX]","typeLabel":"ProductSubscription · object"},"isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].subscriptions.oneOf.0","typeLabel":"ProductSubscription · object[]"},{"type":"null","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].subscriptions.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].subscriptions","typeLabel":"ProductSubscription · object[] | null"},"seller_id":{"oneOf":[{"type":"string","description":"Seller ID. This field is relevant for marketplace type stores only. Will return null for b2b and b2c type stores.","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].seller_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Seller ID. This field is relevant for marketplace type stores only. Will return null for b2b and b2c type stores.","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].seller_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].seller_id","typeLabel":"string | null"},"seller_detail":{"oneOf":[{"type":"object","title":"SellerInfo","description":"Seller detail information. This field is relevant for marketplace type stores only. Will return null for b2b and b2c type stores.","required":["id","trade_name","legal_name","business_type","tax_identification_number"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].seller_detail.oneOf.0.id","typeLabel":"string"},"trade_name":{"type":"string","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].seller_detail.oneOf.0.trade_name","typeLabel":"string"},"legal_name":{"type":"string","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].seller_detail.oneOf.0.legal_name","typeLabel":"string"},"business_type":{"type":"string","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].seller_detail.oneOf.0.business_type","typeLabel":"string"},"tax_identification_number":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].seller_detail.oneOf.0.tax_identification_number.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].seller_detail.oneOf.0.tax_identification_number.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].seller_detail.oneOf.0.tax_identification_number","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].seller_detail.oneOf.0","typeLabel":"SellerInfo · object"},{"type":"null","description":"Seller detail information. This field is relevant for marketplace type stores only. Will return null for b2b and b2c type stores.","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].seller_detail.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].seller_detail","typeLabel":"SellerInfo · object | null"},"original_selling_price":{"type":"number","description":"Selling price before item-level discounts.","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].original_selling_price","typeLabel":"number"},"discount_amount":{"type":"number","description":"Total discount amount applied to the line.","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].discount_amount","typeLabel":"number"},"subscription_plan":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].subscription_plan.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].subscription_plan.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].subscription_plan","typeLabel":"string | null"},"subscription_interval":{"oneOf":[{"type":"integer","description":"Interval of the line's subscription plan. `null` when the line is not on a subscription.","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].subscription_interval.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Interval of the line's subscription plan. `null` when the line is not on a subscription.","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].subscription_interval.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].subscription_interval","typeLabel":"integer | null"},"subscription_frequency":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].subscription_frequency.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].subscription_frequency.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].subscription_frequency","typeLabel":"string | null"},"subscription_eligibility":{"type":"boolean","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].subscription_eligibility","typeLabel":"boolean"},"available_subscription_plans":{"oneOf":[{"type":"array","items":{"type":"object","title":"ProductSubscription","required":["subscription_plan_id","subscription_plan","subscription_price","billing_interval","billing_frequency","billing_limit","fulfill_separately","order_interval","order_frequency","order_limit","minimum_quantity","billing_trial_days"],"properties":{"subscription_plan_id":{"oneOf":[{"type":"string","description":"Stored subscription plan ID; null for older search entries without one.","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].available_subscription_plans.oneOf.0.items.[INDEX].subscription_plan_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Stored subscription plan ID; null for older search entries without one.","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].available_subscription_plans.oneOf.0.items.[INDEX].subscription_plan_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].available_subscription_plans.oneOf.0.items.[INDEX].subscription_plan_id","typeLabel":"string | null"},"subscription_plan":{"type":"string","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].available_subscription_plans.oneOf.0.items.[INDEX].subscription_plan","typeLabel":"string"},"subscription_price":{"type":"number","format":"double","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].available_subscription_plans.oneOf.0.items.[INDEX].subscription_price","typeLabel":"number\u003cdouble>"},"billing_interval":{"type":"integer","description":"Billing interval determines the frequency for which the customer is charged for the subscription itself.","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].available_subscription_plans.oneOf.0.items.[INDEX].billing_interval","typeLabel":"integer"},"billing_frequency":{"type":"string","enum":["Weekly","Bimonthly","Monthly","Quarterly","Semiannually","Annually"],"example":"Monthly","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].available_subscription_plans.oneOf.0.items.[INDEX].billing_frequency","typeLabel":"enum\u003cstring>"},"billing_limit":{"oneOf":[{"type":"integer","description":"`null` means unlimited billing cycles.","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].available_subscription_plans.oneOf.0.items.[INDEX].billing_limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"`null` means unlimited billing cycles.","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].available_subscription_plans.oneOf.0.items.[INDEX].billing_limit.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].available_subscription_plans.oneOf.0.items.[INDEX].billing_limit","typeLabel":"integer | null"},"fulfill_separately":{"type":"boolean","default":false,"isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].available_subscription_plans.oneOf.0.items.[INDEX].fulfill_separately","typeLabel":"boolean"},"order_interval":{"oneOf":[{"type":"integer","description":"order interval defines the frequency of when the subscription sends customers the product","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].available_subscription_plans.oneOf.0.items.[INDEX].order_interval.oneOf.0","typeLabel":"integer"},{"type":"null","description":"order interval defines the frequency of when the subscription sends customers the product","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].available_subscription_plans.oneOf.0.items.[INDEX].order_interval.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].available_subscription_plans.oneOf.0.items.[INDEX].order_interval","typeLabel":"integer | null"},"order_frequency":{"oneOf":[{"type":"string","enum":["Weekly","Bimonthly","Monthly","Quarterly","Semiannually","Annually",null],"example":"Monthly","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].available_subscription_plans.oneOf.0.items.[INDEX].order_frequency.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["Weekly","Bimonthly","Monthly","Quarterly","Semiannually","Annually",null],"example":"Monthly","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].available_subscription_plans.oneOf.0.items.[INDEX].order_frequency.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].available_subscription_plans.oneOf.0.items.[INDEX].order_frequency","typeLabel":"enum\u003cstring> | null"},"order_limit":{"oneOf":[{"type":"integer","description":"`null` means unlimited fulfillment cycles.","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].available_subscription_plans.oneOf.0.items.[INDEX].order_limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"`null` means unlimited fulfillment cycles.","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].available_subscription_plans.oneOf.0.items.[INDEX].order_limit.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].available_subscription_plans.oneOf.0.items.[INDEX].order_limit","typeLabel":"integer | null"},"minimum_quantity":{"type":"integer","description":"The quantity of the plan to which the customer should be subscribed","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].available_subscription_plans.oneOf.0.items.[INDEX].minimum_quantity","typeLabel":"integer"},"billing_trial_days":{"type":"integer","description":"Use in digital product only for trial period","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].available_subscription_plans.oneOf.0.items.[INDEX].billing_trial_days","typeLabel":"integer"}},"uniqueKey":"content.cart.cart_items.items.[INDEX].available_subscription_plans.oneOf.0.items.[INDEX]","typeLabel":"ProductSubscription · object"},"description":"Available subscription plans for the line (same data as `subscriptions`).","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].available_subscription_plans.oneOf.0","typeLabel":"ProductSubscription · object[]"},{"type":"null","description":"Available subscription plans for the line (same data as `subscriptions`).","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].available_subscription_plans.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].available_subscription_plans","typeLabel":"ProductSubscription · object[] | null"},"seller_product_id":{"oneOf":[{"type":"string","description":"Seller's product ID. Relevant for marketplace stores; `null` otherwise.","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].seller_product_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Seller's product ID. Relevant for marketplace stores; `null` otherwise.","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].seller_product_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].seller_product_id","typeLabel":"string | null"},"seller_variant_id":{"oneOf":[{"type":"string","description":"Seller's variant ID. Relevant for marketplace stores; `null` otherwise.","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].seller_variant_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Seller's variant ID. Relevant for marketplace stores; `null` otherwise.","isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].seller_variant_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.cart_items.items.[INDEX].seller_variant_id","typeLabel":"string | null"}},"uniqueKey":"content.cart.cart_items.items.[INDEX]","typeLabel":"CartItemRead · object"},"description":"List containing detailed information about each item in the cart. ","isRequired":true,"uniqueKey":"content.cart.cart_items","typeLabel":"CartItemRead · object[]"},"billing_address":{"oneOf":[{"title":"CartAddress","description":"Details of the billing address.","type":"object","externalDocs":{"url":"https://llm-docs.commercengine.io/admin-pos/schemas/CartAddress"},"required":["id","first_name","last_name","business_name","phone","country_code","email","address_line1","address_line2","landmark","pincode","city","state","country","gstin","tax_identification_number","is_email_verified","is_phone_verified"],"properties":{"id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.cart.billing_address.oneOf.0.id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.cart.billing_address.oneOf.0.id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.billing_address.oneOf.0.id","typeLabel":"string | null"},"first_name":{"type":"string","isRequired":true,"uniqueKey":"content.cart.billing_address.oneOf.0.first_name","typeLabel":"string"},"last_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.cart.billing_address.oneOf.0.last_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.cart.billing_address.oneOf.0.last_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.billing_address.oneOf.0.last_name","typeLabel":"string | null"},"business_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.cart.billing_address.oneOf.0.business_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.cart.billing_address.oneOf.0.business_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.billing_address.oneOf.0.business_name","typeLabel":"string | null"},"phone":{"description":"10 digit phone number without country code.","type":"string","isRequired":true,"uniqueKey":"content.cart.billing_address.oneOf.0.phone","typeLabel":"string"},"country_code":{"description":"Phone country code with a plus sign prefix, e.g. `+91`.","type":"string","isRequired":true,"uniqueKey":"content.cart.billing_address.oneOf.0.country_code","typeLabel":"string"},"email":{"type":"string","isRequired":true,"uniqueKey":"content.cart.billing_address.oneOf.0.email","typeLabel":"string"},"address_line1":{"type":"string","isRequired":true,"uniqueKey":"content.cart.billing_address.oneOf.0.address_line1","typeLabel":"string"},"address_line2":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.cart.billing_address.oneOf.0.address_line2.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.cart.billing_address.oneOf.0.address_line2.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.billing_address.oneOf.0.address_line2","typeLabel":"string | null"},"landmark":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.cart.billing_address.oneOf.0.landmark.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.cart.billing_address.oneOf.0.landmark.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.billing_address.oneOf.0.landmark","typeLabel":"string | null"},"pincode":{"type":"string","isRequired":true,"uniqueKey":"content.cart.billing_address.oneOf.0.pincode","typeLabel":"string"},"city":{"type":"string","isRequired":true,"uniqueKey":"content.cart.billing_address.oneOf.0.city","typeLabel":"string"},"state":{"type":"string","isRequired":true,"uniqueKey":"content.cart.billing_address.oneOf.0.state","typeLabel":"string"},"country":{"oneOf":[{"description":"`null` when the saved address it was set from has no country.","type":"string","isRequired":true,"uniqueKey":"content.cart.billing_address.oneOf.0.country.oneOf.0","typeLabel":"string"},{"description":"`null` when the saved address it was set from has no country.","type":"null","isRequired":true,"uniqueKey":"content.cart.billing_address.oneOf.0.country.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.billing_address.oneOf.0.country","typeLabel":"string | null"},"gstin":{"oneOf":[{"description":"GST identification number of the buyer's business, when one was given with the address.","type":"string","isRequired":true,"uniqueKey":"content.cart.billing_address.oneOf.0.gstin.oneOf.0","typeLabel":"string"},{"description":"GST identification number of the buyer's business, when one was given with the address.","type":"null","isRequired":true,"uniqueKey":"content.cart.billing_address.oneOf.0.gstin.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.billing_address.oneOf.0.gstin","typeLabel":"string | null"},"tax_identification_number":{"oneOf":[{"description":"Tax Identification Number specific to the country of operation.","type":"string","isRequired":true,"uniqueKey":"content.cart.billing_address.oneOf.0.tax_identification_number.oneOf.0","typeLabel":"string"},{"description":"Tax Identification Number specific to the country of operation.","type":"null","isRequired":true,"uniqueKey":"content.cart.billing_address.oneOf.0.tax_identification_number.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.billing_address.oneOf.0.tax_identification_number","typeLabel":"string | null"},"is_email_verified":{"type":"boolean","isRequired":true,"uniqueKey":"content.cart.billing_address.oneOf.0.is_email_verified","typeLabel":"boolean"},"is_phone_verified":{"type":"boolean","isRequired":true,"uniqueKey":"content.cart.billing_address.oneOf.0.is_phone_verified","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"content.cart.billing_address.oneOf.0","typeLabel":"CartAddress · object"},{"title":"CartAddress","description":"Details of the billing address.","type":"null","externalDocs":{"url":"https://llm-docs.commercengine.io/admin-pos/schemas/CartAddress"},"required":["id","first_name","last_name","business_name","phone","country_code","email","address_line1","address_line2","landmark","pincode","city","state","country","gstin","tax_identification_number","is_email_verified","is_phone_verified"],"properties":{"id":{"oneOf":[{"type":"string"},{"type":"null"}]},"first_name":{"type":"string"},"last_name":{"oneOf":[{"type":"string"},{"type":"null"}]},"business_name":{"oneOf":[{"type":"string"},{"type":"null"}]},"phone":{"description":"10 digit phone number without country code.","type":"string"},"country_code":{"description":"Phone country code with a plus sign prefix, e.g. `+91`.","type":"string"},"email":{"type":"string"},"address_line1":{"type":"string"},"address_line2":{"oneOf":[{"type":"string"},{"type":"null"}]},"landmark":{"oneOf":[{"type":"string"},{"type":"null"}]},"pincode":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"country":{"oneOf":[{"description":"`null` when the saved address it was set from has no country.","type":"string"},{"description":"`null` when the saved address it was set from has no country.","type":"null"}]},"gstin":{"oneOf":[{"description":"GST identification number of the buyer's business, when one was given with the address.","type":"string"},{"description":"GST identification number of the buyer's business, when one was given with the address.","type":"null"}]},"tax_identification_number":{"oneOf":[{"description":"Tax Identification Number specific to the country of operation.","type":"string"},{"description":"Tax Identification Number specific to the country of operation.","type":"null"}]},"is_email_verified":{"type":"boolean"},"is_phone_verified":{"type":"boolean"}},"isRequired":true,"uniqueKey":"content.cart.billing_address.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.billing_address","typeLabel":"CartAddress · object | null"},"shipping_address":{"oneOf":[{"title":"CartAddress","description":"Details of the shipping address.","type":"object","externalDocs":{"url":"https://llm-docs.commercengine.io/admin-pos/schemas/CartAddress"},"required":["id","first_name","last_name","business_name","phone","country_code","email","address_line1","address_line2","landmark","pincode","city","state","country","gstin","tax_identification_number","is_email_verified","is_phone_verified"],"properties":{"id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.cart.shipping_address.oneOf.0.id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.cart.shipping_address.oneOf.0.id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.shipping_address.oneOf.0.id","typeLabel":"string | null"},"first_name":{"type":"string","isRequired":true,"uniqueKey":"content.cart.shipping_address.oneOf.0.first_name","typeLabel":"string"},"last_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.cart.shipping_address.oneOf.0.last_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.cart.shipping_address.oneOf.0.last_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.shipping_address.oneOf.0.last_name","typeLabel":"string | null"},"business_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.cart.shipping_address.oneOf.0.business_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.cart.shipping_address.oneOf.0.business_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.shipping_address.oneOf.0.business_name","typeLabel":"string | null"},"phone":{"description":"10 digit phone number without country code.","type":"string","isRequired":true,"uniqueKey":"content.cart.shipping_address.oneOf.0.phone","typeLabel":"string"},"country_code":{"description":"Phone country code with a plus sign prefix, e.g. `+91`.","type":"string","isRequired":true,"uniqueKey":"content.cart.shipping_address.oneOf.0.country_code","typeLabel":"string"},"email":{"type":"string","isRequired":true,"uniqueKey":"content.cart.shipping_address.oneOf.0.email","typeLabel":"string"},"address_line1":{"type":"string","isRequired":true,"uniqueKey":"content.cart.shipping_address.oneOf.0.address_line1","typeLabel":"string"},"address_line2":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.cart.shipping_address.oneOf.0.address_line2.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.cart.shipping_address.oneOf.0.address_line2.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.shipping_address.oneOf.0.address_line2","typeLabel":"string | null"},"landmark":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.cart.shipping_address.oneOf.0.landmark.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.cart.shipping_address.oneOf.0.landmark.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.shipping_address.oneOf.0.landmark","typeLabel":"string | null"},"pincode":{"type":"string","isRequired":true,"uniqueKey":"content.cart.shipping_address.oneOf.0.pincode","typeLabel":"string"},"city":{"type":"string","isRequired":true,"uniqueKey":"content.cart.shipping_address.oneOf.0.city","typeLabel":"string"},"state":{"type":"string","isRequired":true,"uniqueKey":"content.cart.shipping_address.oneOf.0.state","typeLabel":"string"},"country":{"oneOf":[{"description":"`null` when the saved address it was set from has no country.","type":"string","isRequired":true,"uniqueKey":"content.cart.shipping_address.oneOf.0.country.oneOf.0","typeLabel":"string"},{"description":"`null` when the saved address it was set from has no country.","type":"null","isRequired":true,"uniqueKey":"content.cart.shipping_address.oneOf.0.country.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.shipping_address.oneOf.0.country","typeLabel":"string | null"},"gstin":{"oneOf":[{"description":"GST identification number of the buyer's business, when one was given with the address.","type":"string","isRequired":true,"uniqueKey":"content.cart.shipping_address.oneOf.0.gstin.oneOf.0","typeLabel":"string"},{"description":"GST identification number of the buyer's business, when one was given with the address.","type":"null","isRequired":true,"uniqueKey":"content.cart.shipping_address.oneOf.0.gstin.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.shipping_address.oneOf.0.gstin","typeLabel":"string | null"},"tax_identification_number":{"oneOf":[{"description":"Tax Identification Number specific to the country of operation.","type":"string","isRequired":true,"uniqueKey":"content.cart.shipping_address.oneOf.0.tax_identification_number.oneOf.0","typeLabel":"string"},{"description":"Tax Identification Number specific to the country of operation.","type":"null","isRequired":true,"uniqueKey":"content.cart.shipping_address.oneOf.0.tax_identification_number.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.shipping_address.oneOf.0.tax_identification_number","typeLabel":"string | null"},"is_email_verified":{"type":"boolean","isRequired":true,"uniqueKey":"content.cart.shipping_address.oneOf.0.is_email_verified","typeLabel":"boolean"},"is_phone_verified":{"type":"boolean","isRequired":true,"uniqueKey":"content.cart.shipping_address.oneOf.0.is_phone_verified","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"content.cart.shipping_address.oneOf.0","typeLabel":"CartAddress · object"},{"title":"CartAddress","description":"Details of the shipping address.","type":"null","externalDocs":{"url":"https://llm-docs.commercengine.io/admin-pos/schemas/CartAddress"},"required":["id","first_name","last_name","business_name","phone","country_code","email","address_line1","address_line2","landmark","pincode","city","state","country","gstin","tax_identification_number","is_email_verified","is_phone_verified"],"properties":{"id":{"oneOf":[{"type":"string"},{"type":"null"}]},"first_name":{"type":"string"},"last_name":{"oneOf":[{"type":"string"},{"type":"null"}]},"business_name":{"oneOf":[{"type":"string"},{"type":"null"}]},"phone":{"description":"10 digit phone number without country code.","type":"string"},"country_code":{"description":"Phone country code with a plus sign prefix, e.g. `+91`.","type":"string"},"email":{"type":"string"},"address_line1":{"type":"string"},"address_line2":{"oneOf":[{"type":"string"},{"type":"null"}]},"landmark":{"oneOf":[{"type":"string"},{"type":"null"}]},"pincode":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"country":{"oneOf":[{"description":"`null` when the saved address it was set from has no country.","type":"string"},{"description":"`null` when the saved address it was set from has no country.","type":"null"}]},"gstin":{"oneOf":[{"description":"GST identification number of the buyer's business, when one was given with the address.","type":"string"},{"description":"GST identification number of the buyer's business, when one was given with the address.","type":"null"}]},"tax_identification_number":{"oneOf":[{"description":"Tax Identification Number specific to the country of operation.","type":"string"},{"description":"Tax Identification Number specific to the country of operation.","type":"null"}]},"is_email_verified":{"type":"boolean"},"is_phone_verified":{"type":"boolean"}},"isRequired":true,"uniqueKey":"content.cart.shipping_address.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.shipping_address","typeLabel":"CartAddress · object | null"},"currency":{"type":"object","externalDocs":{"url":"https://llm-docs.commercengine.io/admin-pos/schemas/Currency"},"required":["name","code","symbol"],"properties":{"name":{"type":"string","examples":["Indian Rupee"],"isRequired":true,"uniqueKey":"content.cart.currency.name","typeLabel":"string"},"code":{"type":"string","examples":["INR"],"maxLength":3,"minLength":3,"isRequired":true,"uniqueKey":"content.cart.currency.code","typeLabel":"string"},"symbol":{"type":"string","examples":["₹"],"isRequired":true,"uniqueKey":"content.cart.currency.symbol","typeLabel":"string"}},"description":"Details about the currency being used, including `name`, `code`, and `symbol`.","isRequired":true,"uniqueKey":"content.cart.currency","typeLabel":"object"},"metadata":{"oneOf":[{"description":"Session-derived POS attribution plus custom scalar text/null values. Numbers are returned as strings; reserved keys and unsafe stored nested values are excluded.","type":"object","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"content.cart.metadata.oneOf.0.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"content.cart.metadata.oneOf.0.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.cart.metadata.oneOf.0.additionalProperties","typeLabel":"string | null"},"properties":{"pos_user_id":{"oneOf":[{"description":"POS operator who created the cart. `null` for a cart not created at a POS.","type":"string","uniqueKey":"content.cart.metadata.oneOf.0.pos_user_id.oneOf.0","typeLabel":"string"},{"description":"POS operator who created the cart. `null` for a cart not created at a POS.","type":"null","uniqueKey":"content.cart.metadata.oneOf.0.pos_user_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.cart.metadata.oneOf.0.pos_user_id","typeLabel":"string | null"},"pos_device_id":{"oneOf":[{"description":"POS device the cart was created on. `null` for a cart not created at a POS.","type":"string","uniqueKey":"content.cart.metadata.oneOf.0.pos_device_id.oneOf.0","typeLabel":"string"},{"description":"POS device the cart was created on. `null` for a cart not created at a POS.","type":"null","uniqueKey":"content.cart.metadata.oneOf.0.pos_device_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.cart.metadata.oneOf.0.pos_device_id","typeLabel":"string | null"},"origin_location_id":{"oneOf":[{"description":"Store location the cart was created at, when given.","type":"string","uniqueKey":"content.cart.metadata.oneOf.0.origin_location_id.oneOf.0","typeLabel":"string"},{"description":"Store location the cart was created at, when given.","type":"null","uniqueKey":"content.cart.metadata.oneOf.0.origin_location_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.cart.metadata.oneOf.0.origin_location_id","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"content.cart.metadata.oneOf.0","typeLabel":"object"},{"description":"Session-derived POS attribution plus custom scalar text/null values. Numbers are returned as strings; reserved keys and unsafe stored nested values are excluded.","type":"null","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"content.cart.metadata.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"content.cart.metadata.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.cart.metadata.oneOf.1.additionalProperties","typeLabel":"string | null"},"properties":{"pos_user_id":{"oneOf":[{"description":"POS operator who created the cart. `null` for a cart not created at a POS.","type":"string"},{"description":"POS operator who created the cart. `null` for a cart not created at a POS.","type":"null"}]},"pos_device_id":{"oneOf":[{"description":"POS device the cart was created on. `null` for a cart not created at a POS.","type":"string"},{"description":"POS device the cart was created on. `null` for a cart not created at a POS.","type":"null"}]},"origin_location_id":{"oneOf":[{"description":"Store location the cart was created at, when given.","type":"string"},{"description":"Store location the cart was created at, when given.","type":"null"}]}},"isRequired":true,"uniqueKey":"content.cart.metadata.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.metadata","typeLabel":"object | null"},"expires_at":{"oneOf":[{"description":"ISO 8601 expiry time. Active carts can be refreshed and renewed by cart updates, including loyalty-point and credit-balance redemption. Checkout rejects an expired cart.","type":"string","format":"date-time","isRequired":true,"uniqueKey":"content.cart.expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"ISO 8601 expiry time. Active carts can be refreshed and renewed by cart updates, including loyalty-point and credit-balance redemption. Checkout rejects an expired cart.","type":"null","format":"date-time","isRequired":true,"uniqueKey":"content.cart.expires_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.expires_at","typeLabel":"string\u003cdate-time> | null"},"applied_promotions":{"description":"Information about the promotional offers that have been applied to the cart.","type":"array","items":{"title":"AppliedPromotion","description":"Details about an active promotion applied to a cart/order","type":"object","externalDocs":{"url":"https://llm-docs.commercengine.io/admin-pos/schemas/AppliedPromotion"},"required":["promotion_id","promotion_type","savings","product_id","variant_id","product_name","variant_name","applied_sequence","scope"],"properties":{"promotion_id":{"type":"string","isRequired":true,"uniqueKey":"content.cart.applied_promotions.items.[INDEX].promotion_id","typeLabel":"string"},"promotion_type":{"enum":["discount","free-goods","free-shipping","buy-x-get-y","volume-based","fixed-price"],"type":"string","isRequired":true,"uniqueKey":"content.cart.applied_promotions.items.[INDEX].promotion_type","typeLabel":"enum\u003cstring>"},"savings":{"type":"number","isRequired":true,"uniqueKey":"content.cart.applied_promotions.items.[INDEX].savings","typeLabel":"number"},"product_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.cart.applied_promotions.items.[INDEX].product_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.cart.applied_promotions.items.[INDEX].product_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.applied_promotions.items.[INDEX].product_id","typeLabel":"string | null"},"variant_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.cart.applied_promotions.items.[INDEX].variant_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.cart.applied_promotions.items.[INDEX].variant_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.applied_promotions.items.[INDEX].variant_id","typeLabel":"string | null"},"product_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.cart.applied_promotions.items.[INDEX].product_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.cart.applied_promotions.items.[INDEX].product_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.applied_promotions.items.[INDEX].product_name","typeLabel":"string | null"},"variant_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.cart.applied_promotions.items.[INDEX].variant_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.cart.applied_promotions.items.[INDEX].variant_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.applied_promotions.items.[INDEX].variant_name","typeLabel":"string | null"},"applied_sequence":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"content.cart.applied_promotions.items.[INDEX].applied_sequence.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"content.cart.applied_promotions.items.[INDEX].applied_sequence.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.applied_promotions.items.[INDEX].applied_sequence","typeLabel":"number | null"},"scope":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.cart.applied_promotions.items.[INDEX].scope.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.cart.applied_promotions.items.[INDEX].scope.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.applied_promotions.items.[INDEX].scope","typeLabel":"string | null"}},"uniqueKey":"content.cart.applied_promotions.items.[INDEX]","typeLabel":"AppliedPromotion · object"},"isRequired":true,"uniqueKey":"content.cart.applied_promotions","typeLabel":"AppliedPromotion · object[]"},"applied_coupons":{"description":"This key provides details about the savings in cart after coupon have been applied to the cart.","type":"array","items":{"title":"AppliedCoupon","description":"Details about an active coupon applied to a cart/order","type":"object","externalDocs":{"url":"https://llm-docs.commercengine.io/admin-pos/schemas/AppliedCoupon"},"required":["coupon_id","coupon_type","savings","product_id","variant_id","product_name","variant_name"],"properties":{"coupon_id":{"type":"string","isRequired":true,"uniqueKey":"content.cart.applied_coupons.items.[INDEX].coupon_id","typeLabel":"string"},"coupon_type":{"enum":["discount","free-goods","fixed-price","free-shipping","buy-x-get-y","volume-based","accelerated-rewards","tiered-discount"],"type":"string","isRequired":true,"uniqueKey":"content.cart.applied_coupons.items.[INDEX].coupon_type","typeLabel":"enum\u003cstring>"},"savings":{"type":"number","isRequired":true,"uniqueKey":"content.cart.applied_coupons.items.[INDEX].savings","typeLabel":"number"},"product_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.cart.applied_coupons.items.[INDEX].product_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.cart.applied_coupons.items.[INDEX].product_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.applied_coupons.items.[INDEX].product_id","typeLabel":"string | null"},"variant_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.cart.applied_coupons.items.[INDEX].variant_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.cart.applied_coupons.items.[INDEX].variant_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.applied_coupons.items.[INDEX].variant_id","typeLabel":"string | null"},"product_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.cart.applied_coupons.items.[INDEX].product_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.cart.applied_coupons.items.[INDEX].product_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.applied_coupons.items.[INDEX].product_name","typeLabel":"string | null"},"variant_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.cart.applied_coupons.items.[INDEX].variant_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.cart.applied_coupons.items.[INDEX].variant_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.applied_coupons.items.[INDEX].variant_name","typeLabel":"string | null"}},"uniqueKey":"content.cart.applied_coupons.items.[INDEX]","typeLabel":"AppliedCoupon · object"},"isRequired":true,"uniqueKey":"content.cart.applied_coupons","typeLabel":"AppliedCoupon · object[]"},"shipments":{"description":"List containing detailed information about each shipment in the cart.","type":"array","items":{"title":"CartShipment","description":"Cart shipment model","type":"object","externalDocs":{"url":"https://llm-docs.commercengine.io/admin-pos/schemas/CartShipment"},"required":["id","shipping_provider_id","shipping_provider_name","courier_company_id","courier_company_name","shipping_amount","shipping_tax_amount","shipping_amount_including_tax","shipment_items_count","items"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"content.cart.shipments.items.[INDEX].id","typeLabel":"string"},"shipping_provider_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.cart.shipments.items.[INDEX].shipping_provider_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.cart.shipments.items.[INDEX].shipping_provider_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.shipments.items.[INDEX].shipping_provider_id","typeLabel":"string | null"},"shipping_provider_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.cart.shipments.items.[INDEX].shipping_provider_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.cart.shipments.items.[INDEX].shipping_provider_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.shipments.items.[INDEX].shipping_provider_name","typeLabel":"string | null"},"courier_company_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.cart.shipments.items.[INDEX].courier_company_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.cart.shipments.items.[INDEX].courier_company_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.shipments.items.[INDEX].courier_company_id","typeLabel":"string | null"},"courier_company_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.cart.shipments.items.[INDEX].courier_company_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.cart.shipments.items.[INDEX].courier_company_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.shipments.items.[INDEX].courier_company_name","typeLabel":"string | null"},"shipping_amount":{"type":"number","format":"double","isRequired":true,"uniqueKey":"content.cart.shipments.items.[INDEX].shipping_amount","typeLabel":"number\u003cdouble>"},"shipping_tax_amount":{"type":"number","format":"double","isRequired":true,"uniqueKey":"content.cart.shipments.items.[INDEX].shipping_tax_amount","typeLabel":"number\u003cdouble>"},"shipping_amount_including_tax":{"type":"number","format":"double","isRequired":true,"uniqueKey":"content.cart.shipments.items.[INDEX].shipping_amount_including_tax","typeLabel":"number\u003cdouble>"},"shipment_items_count":{"type":"integer","isRequired":true,"uniqueKey":"content.cart.shipments.items.[INDEX].shipment_items_count","typeLabel":"integer"},"items":{"type":"array","items":{"type":"object","title":"CartShipmentItem","description":"An item in a cart shipment.","required":["product_id","product_name","product_image_url","variant_id","variant_name","sku","quantity","free_quantity","is_free_item"],"properties":{"product_id":{"type":"string","isRequired":true,"uniqueKey":"content.cart.shipments.items.[INDEX].\\items.items.[INDEX].product_id","typeLabel":"string"},"product_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.cart.shipments.items.[INDEX].\\items.items.[INDEX].product_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.cart.shipments.items.[INDEX].\\items.items.[INDEX].product_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.shipments.items.[INDEX].\\items.items.[INDEX].product_name","typeLabel":"string | null"},"product_image_url":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.cart.shipments.items.[INDEX].\\items.items.[INDEX].product_image_url.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.cart.shipments.items.[INDEX].\\items.items.[INDEX].product_image_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.shipments.items.[INDEX].\\items.items.[INDEX].product_image_url","typeLabel":"string | null"},"variant_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.cart.shipments.items.[INDEX].\\items.items.[INDEX].variant_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.cart.shipments.items.[INDEX].\\items.items.[INDEX].variant_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.shipments.items.[INDEX].\\items.items.[INDEX].variant_id","typeLabel":"string | null"},"variant_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.cart.shipments.items.[INDEX].\\items.items.[INDEX].variant_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.cart.shipments.items.[INDEX].\\items.items.[INDEX].variant_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.shipments.items.[INDEX].\\items.items.[INDEX].variant_name","typeLabel":"string | null"},"sku":{"oneOf":[{"description":"Present on cart shipment items; omitted from order shipment items.","type":"string","isRequired":true,"uniqueKey":"content.cart.shipments.items.[INDEX].\\items.items.[INDEX].sku.oneOf.0","typeLabel":"string"},{"description":"Present on cart shipment items; omitted from order shipment items.","type":"null","isRequired":true,"uniqueKey":"content.cart.shipments.items.[INDEX].\\items.items.[INDEX].sku.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.shipments.items.[INDEX].\\items.items.[INDEX].sku","typeLabel":"string | null"},"quantity":{"type":"integer","isRequired":true,"uniqueKey":"content.cart.shipments.items.[INDEX].\\items.items.[INDEX].quantity","typeLabel":"integer"},"free_quantity":{"type":"integer","isRequired":true,"uniqueKey":"content.cart.shipments.items.[INDEX].\\items.items.[INDEX].free_quantity","typeLabel":"integer"},"is_free_item":{"type":"boolean","isRequired":true,"uniqueKey":"content.cart.shipments.items.[INDEX].\\items.items.[INDEX].is_free_item","typeLabel":"boolean"}},"uniqueKey":"content.cart.shipments.items.[INDEX].\\items.items.[INDEX]","typeLabel":"CartShipmentItem · object"},"isRequired":true,"uniqueKey":"content.cart.shipments.items.[INDEX].\\items","typeLabel":"CartShipmentItem · object[]"}},"uniqueKey":"content.cart.shipments.items.[INDEX]","typeLabel":"CartShipment · object"},"isRequired":true,"uniqueKey":"content.cart.shipments","typeLabel":"CartShipment · object[]"},"promotion_savings":{"description":"Monetary promotion savings; bonus loyalty points are excluded.","type":"number","minimum":0,"isRequired":true,"uniqueKey":"content.cart.promotion_savings","typeLabel":"number"},"coupon_savings":{"description":"Monetary coupon savings; bonus loyalty points are excluded.","type":"number","minimum":0,"isRequired":true,"uniqueKey":"content.cart.coupon_savings","typeLabel":"number"},"other_savings":{"description":"Nonnegative markdown savings between listing price and original selling price, across positive-quantity items.","type":"number","minimum":0,"isRequired":true,"uniqueKey":"content.cart.other_savings","typeLabel":"number"},"total_savings":{"description":"Combined savings across promotions, coupons, and other discounts (`promotion_savings` + `coupon_savings` + `other_savings`).","type":"number","minimum":0,"isRequired":true,"uniqueKey":"content.cart.total_savings","typeLabel":"number"},"free_shipping_threshold":{"oneOf":[{"description":"Free shipping threshold of the cart","type":"number","isRequired":true,"uniqueKey":"content.cart.free_shipping_threshold.oneOf.0","typeLabel":"number"},{"description":"Free shipping threshold of the cart","type":"null","isRequired":true,"uniqueKey":"content.cart.free_shipping_threshold.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.free_shipping_threshold","typeLabel":"number | null"},"status":{"description":"Checkout readiness of the cart. Collection carts are ready when they have items. Other carts also need a shipping address, and delivery carts need shipments. This status does not confirm that a pickup preference has been selected. Use `status_error_message` for the reason when `not-ready-for-payment`.","type":"string","default":"not-ready-for-payment","enum":["not-ready-for-payment","ready-for-payment"],"isRequired":true,"uniqueKey":"content.cart.status","typeLabel":"enum\u003cstring>"},"status_error_message":{"oneOf":[{"description":"Human-readable reason why the cart is not ready for payment. `null` when `status` is `ready-for-payment`.","type":"string","isRequired":true,"uniqueKey":"content.cart.status_error_message.oneOf.0","typeLabel":"string"},{"description":"Human-readable reason why the cart is not ready for payment. `null` when `status` is `ready-for-payment`.","type":"null","isRequired":true,"uniqueKey":"content.cart.status_error_message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.status_error_message","typeLabel":"string | null"},"coupon_id":{"oneOf":[{"description":"ID of the applied coupon. `null` when no coupon is applied.","type":"string","readOnly":true,"isRequired":true,"uniqueKey":"content.cart.coupon_id.oneOf.0","typeLabel":"string"},{"description":"ID of the applied coupon. `null` when no coupon is applied.","type":"null","readOnly":true,"isRequired":true,"uniqueKey":"content.cart.coupon_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.coupon_id","typeLabel":"string | null"},"on_subscription":{"description":"Whether the cart is a subscription cart.","type":"boolean","isRequired":true,"uniqueKey":"content.cart.on_subscription","typeLabel":"boolean"},"sales_channel":{"type":"object","description":"The sales channel the cart belongs to.","required":["id","name","type"],"properties":{"id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.cart.sales_channel.id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.cart.sales_channel.id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.sales_channel.id","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.cart.sales_channel.name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.cart.sales_channel.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.sales_channel.name","typeLabel":"string | null"},"type":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.cart.sales_channel.type.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.cart.sales_channel.type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.sales_channel.type","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"content.cart.sales_channel","typeLabel":"object"},"loyalty_point_eligible_amount":{"description":"Order amount eligible for loyalty-point earning.","type":"number","isRequired":true,"uniqueKey":"content.cart.loyalty_point_eligible_amount","typeLabel":"number"},"cart_value":{"description":"Calculated cart value used for coupon/promotion order-value checks.","type":"number","isRequired":true,"uniqueKey":"content.cart.cart_value","typeLabel":"number"},"shipping_provider_name":{"oneOf":[{"description":"Cart-level shipping provider name. Currently always `null` (resolved per shipment under `shipments[]`).","type":"string","isRequired":true,"uniqueKey":"content.cart.shipping_provider_name.oneOf.0","typeLabel":"string"},{"description":"Cart-level shipping provider name. Currently always `null` (resolved per shipment under `shipments[]`).","type":"null","isRequired":true,"uniqueKey":"content.cart.shipping_provider_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.shipping_provider_name","typeLabel":"string | null"},"courier_company_name":{"oneOf":[{"description":"Cart-level courier company name. Currently always `null` (resolved per shipment under `shipments[]`).","type":"string","isRequired":true,"uniqueKey":"content.cart.courier_company_name.oneOf.0","typeLabel":"string"},{"description":"Cart-level courier company name. Currently always `null` (resolved per shipment under `shipments[]`).","type":"null","isRequired":true,"uniqueKey":"content.cart.courier_company_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.cart.courier_company_name","typeLabel":"string | null"},"created_at":{"description":"Creation timestamp (ISO-8601).","type":"string","format":"date-time","readOnly":true,"isRequired":true,"uniqueKey":"content.cart.created_at","typeLabel":"string\u003cdate-time>"},"modified_at":{"description":"Last-modification timestamp (ISO-8601).","type":"string","format":"date-time","readOnly":true,"isRequired":true,"uniqueKey":"content.cart.modified_at","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"content.cart","typeLabel":"CartRead · object"}},"required":["cart"],"type":"object","isRequired":true,"uniqueKey":"content","typeLabel":"object"},"events":{"description":"Analytics events to emit for the change this request made, each with a server-issued `event_id`. Replay them to your analytics destinations so your client-side and server-side copies of the same action dedupe. Empty when the request produced no analytics event.","type":"array","items":{"oneOf":[{"type":"object","title":"CartLifecycleEvent","description":"Emitted when a cart is created or deleted, or when checkout begins. `Checkout Started` is sent each time an address is set on the cart, even an unchanged one, matching Commerce Engine's own server-side copy.","required":["event","event_id","cart_id"],"properties":{"event":{"type":"string","enum":["Cart Created","Cart Deleted","Checkout Started"],"isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.0.event","typeLabel":"enum\u003cstring>"},"event_id":{"description":"Server-issued event id (ULID). Send it with your client-side copy of this event so both copies dedupe.","type":"string","pattern":"^[0-7][0-9A-HJKMNP-TV-Z]{25}$","isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.0.event_id","typeLabel":"string"},"cart_id":{"description":"The `Cart` this event is about.","type":"string","isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.0.cart_id","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].oneOf.0","typeLabel":"CartLifecycleEvent · object"},{"type":"object","title":"CartLineChangeEvent","description":"Emitted when a cart line's quantity changes. `Product Added` carries the units added and `Product Removed` the units removed, relative to the line's previous quantity. A change that nets to zero produces no event.","required":["event","event_id","cart_id","product_id","variant_id","quantity"],"properties":{"event":{"type":"string","enum":["Product Added","Product Removed"],"isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.1.event","typeLabel":"enum\u003cstring>"},"event_id":{"description":"Server-issued event id (ULID). Send it with your client-side copy of this event so both copies dedupe.","type":"string","pattern":"^[0-7][0-9A-HJKMNP-TV-Z]{25}$","isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.1.event_id","typeLabel":"string"},"cart_id":{"description":"The `Cart` the line belongs to.","type":"string","isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.1.cart_id","typeLabel":"string"},"product_id":{"description":"The product whose line changed.","type":"string","isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.1.product_id","typeLabel":"string"},"variant_id":{"oneOf":[{"description":"The product variant, or `null` when the product has no variants.","type":"string","isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.1.variant_id.oneOf.0","typeLabel":"string"},{"description":"The product variant, or `null` when the product has no variants.","type":"null","isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.1.variant_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.1.variant_id","typeLabel":"string | null"},"quantity":{"description":"Units added (`Product Added`) or removed (`Product Removed`).","type":"integer","minimum":1,"isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.1.quantity","typeLabel":"integer"}},"uniqueKey":"events.items.[INDEX].oneOf.1","typeLabel":"CartLineChangeEvent · object"},{"type":"object","title":"CartCouponEvent","description":"Emitted when a coupon is applied to or removed from a cart. Removing a coupon when none is applied emits nothing.","required":["event","event_id","cart_id","coupon_code"],"properties":{"event":{"type":"string","enum":["Coupon Applied","Coupon Removed"],"isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.2.event","typeLabel":"enum\u003cstring>"},"event_id":{"description":"Server-issued event id (ULID). Send it with your client-side copy of this event so both copies dedupe.","type":"string","pattern":"^[0-7][0-9A-HJKMNP-TV-Z]{25}$","isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.2.event_id","typeLabel":"string"},"cart_id":{"description":"The `Cart` the coupon change applies to.","type":"string","isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.2.cart_id","typeLabel":"string"},"coupon_code":{"description":"The coupon code applied or removed.","type":"string","isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.2.coupon_code","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].oneOf.2","typeLabel":"CartCouponEvent · object"},{"type":"object","title":"OrderCreatedEvent","description":"Emitted when an order is placed, on every channel including POS.","required":["event","event_id","order_number","cart_id"],"properties":{"event":{"type":"string","const":"Order Created","isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.3.event","typeLabel":"string"},"event_id":{"description":"Server-issued event id (ULID). Send it with your client-side copy of this event so both copies dedupe.","type":"string","pattern":"^[0-7][0-9A-HJKMNP-TV-Z]{25}$","isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.3.event_id","typeLabel":"string"},"order_number":{"description":"The `Order` that was created.","type":"string","isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.3.order_number","typeLabel":"string"},"cart_id":{"oneOf":[{"description":"The cart the order was created from, or `null` when it did not originate from a cart.","type":"string","isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.3.cart_id.oneOf.0","typeLabel":"string"},{"description":"The cart the order was created from, or `null` when it did not originate from a cart.","type":"null","isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.3.cart_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.3.cart_id","typeLabel":"string | null"}},"uniqueKey":"events.items.[INDEX].oneOf.3","typeLabel":"OrderCreatedEvent · object"},{"type":"object","title":"OrderCancelledEvent","description":"Emitted when an order transitions to `cancelled`. A cancel that does not change the status emits nothing.","required":["event","event_id","order_number"],"properties":{"event":{"type":"string","const":"Order Cancelled","isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.4.event","typeLabel":"string"},"event_id":{"description":"Server-issued event id (ULID). Send it with your client-side copy of this event so both copies dedupe.","type":"string","pattern":"^[0-7][0-9A-HJKMNP-TV-Z]{25}$","isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.4.event_id","typeLabel":"string"},"order_number":{"description":"The `Order` that was cancelled.","type":"string","isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.4.order_number","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].oneOf.4","typeLabel":"OrderCancelledEvent · object"},{"type":"object","title":"WishlistChangeEvent","description":"Emitted when a product is added to or removed from the shopper's wishlist.","required":["event","event_id","product_id","variant_id"],"properties":{"event":{"type":"string","enum":["Product Added to Wishlist","Product Removed from Wishlist"],"isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.5.event","typeLabel":"enum\u003cstring>"},"event_id":{"description":"Server-issued event id (ULID). Send it with your client-side copy of this event so both copies dedupe.","type":"string","pattern":"^[0-7][0-9A-HJKMNP-TV-Z]{25}$","isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.5.event_id","typeLabel":"string"},"product_id":{"description":"The product added to or removed from the wishlist.","type":"string","isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.5.product_id","typeLabel":"string"},"variant_id":{"oneOf":[{"description":"The product variant, or `null` when the product has no variants.","type":"string","isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.5.variant_id.oneOf.0","typeLabel":"string"},{"description":"The product variant, or `null` when the product has no variants.","type":"null","isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.5.variant_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"events.items.[INDEX].oneOf.5.variant_id","typeLabel":"string | null"}},"uniqueKey":"events.items.[INDEX].oneOf.5","typeLabel":"WishlistChangeEvent · object"}],"uniqueKey":"events.items.[INDEX]","typeLabel":"CartLifecycleEvent · object | CartLineChangeEvent · object | CartCouponEvent · object | OrderCreatedEvent · object | OrderCancelledEvent · object | WishlistChangeEvent · object"},"isRequired":true,"uniqueKey":"events","typeLabel":"(CartLifecycleEvent · object | CartLineChangeEvent · object | CartCouponEvent · object | OrderCreatedEvent · object | OrderCancelledEvent · object | WishlistChangeEvent · object)[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","success":true,"content":{"cart":{"id":"\u003cstring>","user_id":"\u003cstring>","customer_id":"\u003cstring>","active":true,"customer_note":"\u003cstring>","is_promotion_applied":true,"is_coupon_applied":true,"coupon_code":"\u003cstring>","coupon_discount_amount":1,"coupon_discount_percent":1,"promotion_discount_amount":1,"promotion_discount_percent":1,"subtotal":1,"items_tax_amount":1,"subtotal_including_tax":1,"shipping_estimated_cost":123,"shipping_discount_amount":123,"shipping_amount":123,"shipping_tax_rate":123,"shipping_tax_amount":123,"shipping_amount_including_tax":123,"fulfillment_preference":{"fulfillment_type":"collect-in-store","preference_type":"user","pickup_location_id":"\u003cstring>","pickup_location_name":"\u003cstring>"},"estimated_delivery_days":"\u003cstring>","handling_charge_excluding_tax":1,"handling_charge_tax_amount":1,"handling_charge_including_tax":1,"total_tax":1,"grand_total":1,"credit_balance_used":1,"to_be_paid":123,"loyalty_points_redeemed":1,"loyalty_points_earned":1,"cart_items_count":1,"cart_items":[{"product_id":"\u003cstring>","variant_id":"\u003cstring>","sku":"SKU1254","product_name":"\u003cstring>","variant_name":"\u003cstring>","product_slug":"\u003cstring>","variant_slug":"\u003cstring>","product_type":"physical","product_image_url":"\u003cstring>","stock_available":true,"backorder":true,"on_subscription":true,"on_promotion":true,"quantity":123,"is_free_item":true,"free_quantity":123,"promotion_discount_amount":123,"coupon_discount_amount":123,"price_including_tax":false,"listing_price":200,"selling_price":199,"selling_price_excluding_tax":123,"min_order_quantity":1,"max_order_quantity":123,"incremental_quantity":1,"handling_charge_excluding_tax":1,"handling_charge_tax_rate":1,"handling_charge_including_tax":1,"tax_type":"GST","tax_rate":123,"tax_amount":123,"associated_options":{"background_color":{"name":"Background Color","value":{"name":"Blue","hexcode":"#0000FF"},"type":"color"},"size":{"name":"Size","value":"Large","type":"single-select"}},"attributes":[{"id":"\u003cstring>","name":"\u003cstring>","key":"\u003cstring>","type":"color","value":{"hexcode":"\u003cstring>","name":"\u003cstring>"}}],"subscriptions":[{"subscription_plan_id":"\u003cstring>","subscription_plan":"\u003cstring>","subscription_price":123,"billing_interval":123,"billing_frequency":"Monthly","billing_limit":123,"fulfill_separately":false,"order_interval":123,"order_frequency":"Monthly","order_limit":123,"minimum_quantity":123,"billing_trial_days":123}],"seller_id":"\u003cstring>","seller_detail":{"id":"\u003cstring>","trade_name":"\u003cstring>","legal_name":"\u003cstring>","business_type":"\u003cstring>","tax_identification_number":"\u003cstring>"},"original_selling_price":123,"discount_amount":123,"subscription_plan":"\u003cstring>","subscription_interval":123,"subscription_frequency":"\u003cstring>","subscription_eligibility":true,"available_subscription_plans":[{"subscription_plan_id":"\u003cstring>","subscription_plan":"\u003cstring>","subscription_price":123,"billing_interval":123,"billing_frequency":"Monthly","billing_limit":123,"fulfill_separately":false,"order_interval":123,"order_frequency":"Monthly","order_limit":123,"minimum_quantity":123,"billing_trial_days":123}],"seller_product_id":"\u003cstring>","seller_variant_id":"\u003cstring>"}],"billing_address":{"id":"\u003cstring>","first_name":"\u003cstring>","last_name":"\u003cstring>","business_name":"\u003cstring>","phone":"\u003cstring>","country_code":"\u003cstring>","email":"\u003cstring>","address_line1":"\u003cstring>","address_line2":"\u003cstring>","landmark":"\u003cstring>","pincode":"\u003cstring>","city":"\u003cstring>","state":"\u003cstring>","country":"\u003cstring>","gstin":"\u003cstring>","tax_identification_number":"\u003cstring>","is_email_verified":true,"is_phone_verified":true},"shipping_address":{"id":"\u003cstring>","first_name":"\u003cstring>","last_name":"\u003cstring>","business_name":"\u003cstring>","phone":"\u003cstring>","country_code":"\u003cstring>","email":"\u003cstring>","address_line1":"\u003cstring>","address_line2":"\u003cstring>","landmark":"\u003cstring>","pincode":"\u003cstring>","city":"\u003cstring>","state":"\u003cstring>","country":"\u003cstring>","gstin":"\u003cstring>","tax_identification_number":"\u003cstring>","is_email_verified":true,"is_phone_verified":true},"currency":{"name":"Indian Rupee","code":"INR","symbol":"₹"},"metadata":{"pos_user_id":"\u003cstring>","pos_device_id":"\u003cstring>","origin_location_id":"\u003cstring>"},"expires_at":"2023-11-07T05:31:56Z","applied_promotions":[{"promotion_id":"\u003cstring>","promotion_type":"discount","savings":123,"product_id":"\u003cstring>","variant_id":"\u003cstring>","product_name":"\u003cstring>","variant_name":"\u003cstring>","applied_sequence":123,"scope":"\u003cstring>"}],"applied_coupons":[{"coupon_id":"\u003cstring>","coupon_type":"discount","savings":123,"product_id":"\u003cstring>","variant_id":"\u003cstring>","product_name":"\u003cstring>","variant_name":"\u003cstring>"}],"shipments":[{"id":"\u003cstring>","shipping_provider_id":"\u003cstring>","shipping_provider_name":"\u003cstring>","courier_company_id":"\u003cstring>","courier_company_name":"\u003cstring>","shipping_amount":123,"shipping_tax_amount":123,"shipping_amount_including_tax":123,"shipment_items_count":123,"items":[{"product_id":"\u003cstring>","product_name":"\u003cstring>","product_image_url":"\u003cstring>","variant_id":"\u003cstring>","variant_name":"\u003cstring>","sku":"\u003cstring>","quantity":123,"free_quantity":123,"is_free_item":true}]}],"promotion_savings":1,"coupon_savings":1,"other_savings":1,"total_savings":1,"free_shipping_threshold":123,"status":"not-ready-for-payment","status_error_message":"\u003cstring>","coupon_id":"\u003cstring>","on_subscription":true,"sales_channel":{"id":"\u003cstring>","name":"\u003cstring>","type":"\u003cstring>"},"loyalty_point_eligible_amount":123,"cart_value":123,"shipping_provider_name":"\u003cstring>","courier_company_name":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","modified_at":"2023-11-07T05:31:56Z"}},"events":[{"event":"Cart Created","event_id":"\u003cstring>","cart_id":"\u003cstring>"}]}}},"exampleType":"generated"}},"links":{"CreateOrderFromCart":{"operationId":"create-pos-order","requestBody":{"cart_id":"$request.path.id"},"description":"Create a POS order from a cart."}},"exampleType":"generated"},"4a9b33be-f0d1-41b6-ba96-4af3bbbad472":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","required":["message","success","code"],"properties":{"message":{"type":"string","x-speakeasy-error-message":true,"isRequired":true,"uniqueKey":"message","typeLabel":"string"},"success":{"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"errors":{"type":"object","uniqueKey":"errors","typeLabel":"object"},"details":{"type":"string","uniqueKey":"details","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","success":true,"code":"\u003cstring>","errors":{},"details":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"0ce4d9b5-cab1-4457-afc9-21dbce899a9d":{"description":"Authentication failed. Codes include `token-required`, `token-expired` and `token_not_valid` for an invalid or expired token.","content":{"application/json":{"schema":{"type":"object","required":["message","success","code"],"properties":{"message":{"type":"string","examples":["Not authorized for given operation on the Resource."],"x-speakeasy-error-message":true,"isRequired":true,"uniqueKey":"message","typeLabel":"string"},"success":{"type":"boolean","default":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"code":{"type":"string","examples":["unauthorized"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"details":{"type":"string","uniqueKey":"details","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Not authorized for given operation on the Resource.","success":false,"code":"unauthorized","details":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"fa4e0079-71c4-45bc-b317-c98255fe5464":{"description":"Access denied. `token-required` requires an authenticated session; `permission-denied` means the caller cannot access this resource. On POS, `session-expired` requires signing in again.","content":{"application/json":{"schema":{"type":"object","required":["code","message","success"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","x-speakeasy-error-message":true,"isRequired":true,"uniqueKey":"message","typeLabel":"string"},"success":{"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"details":{"type":"string","uniqueKey":"details","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","message":"\u003cstring>","success":true,"details":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"f44e4887-5783-43de-9495-386bbc288e63":{"description":"The active cart was not found.","content":{"application/json":{"schema":{"type":"object","required":["message","success","code"],"properties":{"message":{"type":"string","x-speakeasy-error-message":true,"isRequired":true,"uniqueKey":"message","typeLabel":"string"},"success":{"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"details":{"type":"string","uniqueKey":"details","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","success":true,"code":"\u003cstring>","details":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"c504f0aa-2fc8-420f-8cdd-95d50509b496":{"description":"The request timed out.","content":{"application/json":{"schema":{"type":"object","required":["code","message","success"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","x-speakeasy-error-message":true,"isRequired":true,"uniqueKey":"message","typeLabel":"string"},"success":{"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"details":{"type":"string","uniqueKey":"details","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","message":"\u003cstring>","success":true,"details":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"53a2be0f-9c40-43b3-8828-e27047fd52ce":{"description":"The request failed because of an unexpected error.","content":{"application/json":{"schema":{"type":"object","required":["code","message","success"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","x-speakeasy-error-message":true,"isRequired":true,"uniqueKey":"message","typeLabel":"string"},"success":{"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"details":{"type":"string","uniqueKey":"details","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","message":"\u003cstring>","success":true,"details":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"6355d29a-2d67-4741-8054-88272e8a1f2a":{"description":"The request timed out.","content":{"application/json":{"schema":{"type":"object","required":["code","message","success"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","x-speakeasy-error-message":true,"isRequired":true,"uniqueKey":"message","typeLabel":"string"},"success":{"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"details":{"type":"string","uniqueKey":"details","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","message":"\u003cstring>","success":true,"details":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"aa43f453-7371-4cb4-9531-f3d60c74f096":{"Authorization":{"type":"http","description":"Access token","scheme":"bearer","scopes":[],"schemeName":"Authorization"}}},"servers":{"d5140fa8-2bd5-4c13-abb4-72a9479f9f58":{"url":"https://staging.api.commercengine.io/api/v1/{store_id}/storefront","description":"Staging Server","variables":{"store_id":{"description":"Store ID","default":"store_id"}},"x-speakeasy-server-id":"staging"},"503d314f-8bfe-43e5-9c58-f8d1033bbbb9":{"url":"https://prod.api.commercengine.io/api/v1/{store_id}/storefront","description":"Prod Server","variables":{"store_id":{"description":"Store ID","default":"store_id"}},"x-speakeasy-server-id":"prod"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","description":"Access token","scheme":"bearer","scopes":[],"schemeName":"Authorization"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Access token","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"Authorization","name":"Authorization"}],"title":"Authorization"}]},"originalFileLocation":"https://openapi.commercengine.io/ce-pos.json"},"subdomain":"tarkai","siteName":"Commerce Engine Docs","title":"Apply coupon - Commerce Engine Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-18T13:06:40.833Z","originalFileLocation":"api-reference/pos/coupons-\u0026-promotions/apply-coupon.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=\"Applies a coupon code to the cart. Returns a fully updated Cart object with recalculated totals.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Commerce Engine Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"index, follow\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/tarkai/OqQIjYq8Q24cGlMx/_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/tarkai/OqQIjYq8Q24cGlMx/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/tarkai/OqQIjYq8Q24cGlMx/_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/tarkai/OqQIjYq8Q24cGlMx/_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/tarkai/OqQIjYq8Q24cGlMx/_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/tarkai/OqQIjYq8Q24cGlMx/_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/tarkai/OqQIjYq8Q24cGlMx/_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/tarkai/OqQIjYq8Q24cGlMx/_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/tarkai/OqQIjYq8Q24cGlMx/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Apply coupon - Commerce Engine Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Applies a coupon code to the cart. Returns a fully updated Cart object with recalculated totals.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Commerce Engine Developer Portal\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://www.commercengine.io/docs/api-reference/pos/coupons-\u0026amp;-promotions/apply-coupon\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://tarkai.mintlify.site/docs/_mintlify/api/og/v2?division=Coupons+%26+promotions\u0026amp;title=Apply+coupon\u0026amp;description=Applies+a+coupon+code+to+the+cart.+Returns+a+fully+updated+%60Cart%60+object+with+recalculated+totals.\u0026amp;theme=76e8f8f14f90cfb8929bc40a\u0026amp;signature=5d111d71a1c00fa4f10d0800fe9bbf2f57cbc8ec14085bffb7a0123998898486\">\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=\"Apply coupon - Commerce Engine Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Applies a coupon code to the cart. Returns a fully updated Cart object with recalculated totals.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://tarkai.mintlify.site/docs/_mintlify/api/og/v2?division=Coupons+%26+promotions\u0026amp;title=Apply+coupon\u0026amp;description=Applies+a+coupon+code+to+the+cart.+Returns+a+fully+updated+%60Cart%60+object+with+recalculated+totals.\u0026amp;theme=76e8f8f14f90cfb8929bc40a\u0026amp;signature=5d111d71a1c00fa4f10d0800fe9bbf2f57cbc8ec14085bffb7a0123998898486\">\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/tarkai/OqQIjYq8Q24cGlMx/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Commerce Engine Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#00BF6F\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003cmeta data-mint-head name=\"og:logo\" content=\"/logo/CE_logo_whitebg.svg\">\u003clink data-mint-head rel=\"canonical\" href=\"https://www.commercengine.io/docs/api-reference/pos/coupons-\u0026amp;-promotions/apply-coupon\">\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/pos/coupons-%26-promotions/apply-coupon.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.commercengine.io/#organization\",\"name\":\"Commerce Engine Docs\",\"url\":\"https://www.commercengine.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/tarkai/hIY7_H2biaAvOGu7/logo/CE_Developers_black.svg?fit=max\u0026auto=format\u0026n=hIY7_H2biaAvOGu7\u0026q=85\u0026s=d93f21564dfd373c7f2efc88c9d4301e\"}},{\"@type\":\"WebSite\",\"@id\":\"https://www.commercengine.io/docs#website\",\"name\":\"Commerce Engine Docs\",\"url\":\"https://www.commercengine.io/docs\",\"publisher\":{\"@id\":\"https://www.commercengine.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://www.commercengine.io/docs/api-reference/pos/coupons-\u0026-promotions/apply-coupon#webpage\",\"url\":\"https://www.commercengine.io/docs/api-reference/pos/coupons-\u0026-promotions/apply-coupon\",\"name\":\"Apply coupon\",\"description\":\"Applies a coupon code to the cart. Returns a fully updated Cart object with recalculated totals.\",\"dateModified\":\"2026-11-18T13:06:40.833Z\",\"isPartOf\":{\"@id\":\"https://www.commercengine.io/docs#website\"},\"breadcrumb\":{\"@id\":\"https://www.commercengine.io/docs/api-reference/pos/coupons-\u0026-promotions/apply-coupon#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://www.commercengine.io/docs/api-reference/pos/coupons-\u0026-promotions/apply-coupon#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Shopping\",\"item\":\"https://www.commercengine.io/docs/api-reference/pos/carts/create-cart\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Coupons \u0026 promotions\",\"item\":\"https://www.commercengine.io/docs/api-reference/pos/coupons-\u0026-promotions/retrieve-all-coupons\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Apply coupon\",\"item\":\"https://www.commercengine.io/docs/api-reference/pos/coupons-\u0026-promotions/apply-coupon\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://www.commercengine.io/docs/api-reference/pos/coupons-\u0026-promotions/apply-coupon#apireference\",\"headline\":\"Apply coupon\",\"name\":\"Apply coupon\",\"description\":\"Applies a coupon code to the cart. Returns a fully updated Cart object with recalculated totals.\",\"url\":\"https://www.commercengine.io/docs/api-reference/pos/coupons-\u0026-promotions/apply-coupon\",\"mainEntityOfPage\":{\"@id\":\"https://www.commercengine.io/docs/api-reference/pos/coupons-\u0026-promotions/apply-coupon#webpage\"},\"dateModified\":\"2026-11-18T13:06:40.833Z\",\"publisher\":{\"@id\":\"https://www.commercengine.io/#organization\"},\"isPartOf\":{\"@id\":\"https://www.commercengine.io/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Commerce Engine Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Commerce Engine Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/docs/api-reference/pos/coupons-%26-promotions/apply-coupon.md","siteName":"Commerce Engine Docs","nav":{"global":null,"tabs":[{"tab":"Guides","icon":"book-open-cover","menu":[{"item":"Quickstart","icon":"rocket","description":"Get your keys, then make your first API call in under 15 minutes.","pages":[{"title":"Quickstart","href":"/storefront/quickstart"}]},{"item":"Starters","icon":"rocket","description":"Three production storefronts, each cloned across five frameworks.","pages":[{"title":"Starters","href":"/starters/overview"}]},{"item":"AI-assisted development","icon":"wand-magic-sparkles","description":"Skills, prompts and starters for coding agents.","pages":[{"title":"AI-assisted development","href":"/ai/overview"}]},{"item":"AI apps","icon":"plug","description":"Manage your store from Claude, ChatGPT, Codex and other AI apps.","pages":[{"title":"AI apps","href":"/ai/mcp-connector"}]},{"item":"Storefront","icon":"store","description":"Auth, catalog, cart, checkout, account and subscriptions.","pages":[{"title":"Storefront","href":"/storefront/authentication"}]},{"item":"API guides","icon":"code","description":"Authentication, POS setup and webhook delivery.","pages":[{"title":"API guides","href":"/api-reference/getting-started"}]},{"item":"Hosted checkout","icon":"bag-shopping","description":"Drop-in embeddable cart and checkout for any stack.","pages":[{"title":"Hosted checkout","href":"/hosted-checkout/overview"}]},{"item":"SEO \u0026 AEO","icon":"magnifying-glass","description":"Structured data, canonical metadata, sitemaps and llms.txt.","pages":[{"title":"SEO \u0026 AEO","href":"/seo-ai/overview"}]},{"item":"Agent tools","icon":"robot","description":"WebMCP tools that let browser agents shop your store.","pages":[{"title":"Agent tools","href":"/seo-ai/ai"}]}],"pages":[{"title":"Guides","href":"/storefront/quickstart"}]},{"tab":"Hosted Checkout","icon":"bag-shopping","pages":[{"title":"Hosted Checkout","href":"/hosted-checkout/overview"}]},{"tab":"Packages","icon":"cube","menu":[{"item":"storefront","icon":"box","description":"Framework wrappers for React, Next.js, SvelteKit and Astro.","pages":[{"title":"storefront","href":"/sdk/installation"}]},{"item":"ssr-utils","icon":"server","description":"Framework-agnostic cookie-backed SSR session utilities.","pages":[{"title":"ssr-utils","href":"/sdk/ssr-utils"}]},{"item":"checkout","icon":"bag-shopping","description":"Universal checkout SDK — hosted, embedded or headless.","pages":[{"title":"checkout","href":"/hosted-checkout/overview"}]},{"item":"pos","icon":"cash-register","description":"TypeScript SDK for the POS API, for in-store selling.","pages":[{"title":"pos","href":"/pos/overview"}]},{"item":"analytics","icon":"chart-line","description":"Zero-dependency mappers for canonical commerce events.","pages":[{"title":"analytics","href":"/hosted-checkout/analytics"}]},{"item":"seo","icon":"magnifying-glass","description":"Opinionated SEO, AEO, structured data and Markdown output.","pages":[{"title":"seo","href":"/seo-ai/overview"}]},{"item":"ai","icon":"wand-magic-sparkles","description":"Browser-native agent tools (WebMCP) for storefronts.","pages":[{"title":"ai","href":"/seo-ai/ai"}]},{"item":"Browse all packages","icon":"grid-2","description":"Every published Commerce Engine package on npm.","href":"https://www.npmjs.com/org/commercengine"}],"pages":[{"title":"Packages","href":"/sdk/installation"}]},{"tab":"API Reference","icon":"code","menu":[{"item":"Storefront API","icon":"store","description":"Everything a storefront calls — catalog, cart, checkout, auth, orders.","pages":[{"title":"Storefront API","href":"/api-reference/authentication/create-anonymous-session"}]},{"item":"POS API","icon":"cash-register","description":"Point of sale — staff login, device pairing, carts, catalog and order capture on the storefront base URL.","groups":[{"group":"Identity","pages":[{"group":"Devices","pages":[{"title":"Pair POS device","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/auth/pair-device","href":"/api-reference/pos/devices/pair-pos-device"},{"title":"List all available devices","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/devices","href":"/api-reference/pos/devices/list-all-available-devices"},{"title":"Claim device","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/devices/{id}/claim","href":"/api-reference/pos/devices/claim-device"},{"title":"Unclaim device","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/devices/{id}/unclaim","href":"/api-reference/pos/devices/unclaim-device"},{"title":"List all locations","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/locations","href":"/api-reference/pos/devices/list-all-locations"}]},{"group":"Authentication","pages":[{"title":"Login with email","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/auth/login/email","href":"/api-reference/pos/authentication/login-with-email"},{"title":"Login with phone","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/auth/login/phone","href":"/api-reference/pos/authentication/login-with-phone"},{"title":"Login with whatsapp","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/auth/login/whatsapp","href":"/api-reference/pos/authentication/login-with-whatsapp"},{"title":"Logout","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/auth/logout","href":"/api-reference/pos/authentication/logout"},{"title":"Refresh POS access token","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/auth/refresh-token","href":"/api-reference/pos/authentication/refresh-pos-access-token"},{"title":"Verify OTP","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/auth/verify-otp","href":"/api-reference/pos/authentication/verify-otp"}]},{"group":"Users","pages":[{"title":"Get POS User","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/users/{id}","href":"/api-reference/pos/users/get-pos-user"}]}]},{"group":"Customers","pages":[{"group":"Customers","pages":[{"title":"List all customers","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/customers","href":"/api-reference/pos/customers/list-all-customers"},{"title":"Retrieve customer detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/customers/{id}","href":"/api-reference/pos/customers/retrieve-customer-detail"},{"title":"Update customer","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json put /pos/customers/{id}","href":"/api-reference/pos/customers/update-customer"},{"title":"Search customers","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/search-customers","href":"/api-reference/pos/customers/search-customers"}]},{"group":"Addresses","pages":[{"title":"List all addresses","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/customers/{id}/addresses","href":"/api-reference/pos/addresses/list-all-addresses"},{"title":"Create address","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/customers/{id}/addresses","href":"/api-reference/pos/addresses/create-address"},{"title":"Update address detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json put /pos/customers/{id}/addresses/{address_id}","href":"/api-reference/pos/addresses/update-address-detail"},{"title":"Delete address","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json delete /pos/customers/{id}/addresses/{address_id}","href":"/api-reference/pos/addresses/delete-address"}]}]},{"group":"Catalog","pages":[{"group":"Products","pages":[{"title":"List all products","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/catalog/products","href":"/api-reference/pos/products/list-all-products"},{"title":"Retrieve cross-sell products","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/catalog/products/cross-sell","href":"/api-reference/pos/products/retrieve-cross-sell-products"},{"title":"Search products","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/catalog/products/search","href":"/api-reference/pos/products/search-products"},{"title":"Retrieve similar products","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/catalog/products/similar","href":"/api-reference/pos/products/retrieve-similar-products"},{"title":"Retrieve up-sell products","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/catalog/products/up-sell","href":"/api-reference/pos/products/retrieve-up-sell-products"},{"title":"Retrieve a product detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/catalog/products/{product_id}","href":"/api-reference/pos/products/retrieve-a-product-detail"},{"title":"Retrieve product variants","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/catalog/products/{product_id}/variants","href":"/api-reference/pos/products/retrieve-product-variants"},{"title":"Retrieve variant detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/catalog/products/{product_id}/variants/{variant_id}","href":"/api-reference/pos/products/retrieve-variant-detail"},{"title":"List all SKUs","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/catalog/skus","href":"/api-reference/pos/products/list-all-skus"}]},{"group":"Reviews","pages":[{"title":"List all product reviews","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/catalog/products/{product_id}/reviews","href":"/api-reference/pos/reviews/list-all-product-reviews"}]},{"group":"Categories","pages":[{"title":"List all categories","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/catalog/categories","href":"/api-reference/pos/categories/list-all-categories"}]},{"group":"Inventory","pages":[{"title":"List all inventories","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/catalog/inventories","href":"/api-reference/pos/inventory/list-all-inventories"},{"title":"List all inventories activities","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/catalog/inventories/activities","href":"/api-reference/pos/inventory/list-all-inventories-activities"},{"title":"Retrieve inventory detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/catalog/inventories/detail","href":"/api-reference/pos/inventory/retrieve-inventory-detail"}]}]},{"group":"Shopping","pages":[{"group":"Carts","pages":[{"title":"Create cart","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/carts","href":"/api-reference/pos/carts/create-cart"},{"title":"Retrieve cart by user ID","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/carts/users/{user_id}","href":"/api-reference/pos/carts/retrieve-cart-by-user-id"},{"title":"Retrieve cart detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/carts/{id}","href":"/api-reference/pos/carts/retrieve-cart-detail"},{"title":"Delete cart","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json delete /pos/carts/{id}","href":"/api-reference/pos/carts/delete-cart"},{"title":"Set cart address","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/carts/{id}/address","href":"/api-reference/pos/carts/set-cart-address"},{"title":"Use credit balance","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/carts/{id}/credit-balance","href":"/api-reference/pos/carts/use-credit-balance"},{"title":"Remove credit balance","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json delete /pos/carts/{id}/credit-balance","href":"/api-reference/pos/carts/remove-credit-balance"},{"title":"Add, update, or remove a cart item","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/carts/{id}/items","href":"/api-reference/pos/carts/add-update-or-remove-a-cart-item"},{"title":"Redeem loyalty points","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/carts/{id}/loyalty-points","href":"/api-reference/pos/carts/redeem-loyalty-points"},{"title":"Remove loyalty points","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json delete /pos/carts/{id}/loyalty-points","href":"/api-reference/pos/carts/remove-loyalty-points"},{"title":"Update cart customer","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/carts/{id}/update-customer","href":"/api-reference/pos/carts/update-cart-customer"}]},{"group":"Coupons \u0026 promotions","pages":[{"title":"Retrieve all coupons","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/carts/available-coupons","href":"/api-reference/pos/coupons-\u0026-promotions/retrieve-all-coupons"},{"title":"Retrieve all promotions","description":"All active promotions When customer groups are enabled, a missing or unknown x-customer-group-id uses the default group. Requires a signed-in POS staff session with permission for this operation.","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/carts/available-promotions","href":"/api-reference/pos/coupons-\u0026-promotions/retrieve-all-promotions"},{"title":"Apply coupon","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/carts/{id}/coupon","href":"/api-reference/pos/coupons-\u0026-promotions/apply-coupon"},{"title":"Remove coupon","description":"Removes the applied coupon from the cart. Returns a fully updated `Cart` object with recalculated totals.","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json delete /pos/carts/{id}/coupon","href":"/api-reference/pos/coupons-\u0026-promotions/remove-coupon"},{"title":"Evaluate coupons","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/carts/{id}/evaluate-coupons","href":"/api-reference/pos/coupons-\u0026-promotions/evaluate-coupons"},{"title":"Evaluate promotions","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/carts/{id}/evaluate-promotions","href":"/api-reference/pos/coupons-\u0026-promotions/evaluate-promotions"}]},{"group":"Fulfillment","pages":[{"title":"Retrieve fulfillment options","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/carts/fulfillment-options","href":"/api-reference/pos/fulfillment/retrieve-fulfillment-options"},{"title":"Update fulfillment preference","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/carts/{id}/fulfillment-preference","href":"/api-reference/pos/fulfillment/update-fulfillment-preference"}]}]},{"group":"Orders","pages":[{"group":"Orders","pages":[{"title":"List all orders","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/orders","href":"/api-reference/pos/orders/list-all-orders"},{"title":"Create POS order","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/orders","href":"/api-reference/pos/orders/create-pos-order"},{"title":"Retrieve order details","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/orders/{order_number}","href":"/api-reference/pos/orders/retrieve-order-details"},{"title":"List all order activity","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/orders/{order_number}/activity","href":"/api-reference/pos/orders/list-all-order-activity"},{"title":"Check inventory","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/orders/{order_number}/check-inventory","href":"/api-reference/pos/orders/check-inventory"},{"title":"Retrieve order invoice","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/orders/{order_number}/invoice","href":"/api-reference/pos/orders/retrieve-order-invoice"},{"title":"Retrieve order receipt","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/orders/{order_number}/receipt","href":"/api-reference/pos/orders/retrieve-order-receipt"},{"title":"Retrieve order shipments","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/orders/{order_number}/shipments","href":"/api-reference/pos/orders/retrieve-order-shipments"}]},{"group":"Order payments","pages":[{"title":"Cancel payment request","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/orders/{order_number}/cancel-payment-request","href":"/api-reference/pos/order-payments/cancel-payment-request"},{"title":"Retrieve payment status","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/orders/{order_number}/payment-status","href":"/api-reference/pos/order-payments/retrieve-payment-status"},{"title":"Create order payment","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/orders/{order_number}/payments","href":"/api-reference/pos/order-payments/create-order-payment"},{"title":"Retry payment","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/orders/{order_number}/retry-payment","href":"/api-reference/pos/order-payments/retry-payment"}]},{"group":"Shipments","pages":[{"title":"List all shipments","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/shipping/shipments","href":"/api-reference/pos/shipments/list-all-shipments"},{"title":"Refund shortfall","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/shipping/shipments/{order_number}/refund-shortfall","href":"/api-reference/pos/shipments/refund-shortfall"},{"title":"Wait for inventory","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/shipping/shipments/{order_number}/wait-for-inventory","href":"/api-reference/pos/shipments/wait-for-inventory"},{"title":"Retrieve shipment detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/shipping/shipments/{reference_number}","href":"/api-reference/pos/shipments/retrieve-shipment-detail"},{"title":"Retrieve shipment activities","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/shipping/shipments/{reference_number}/activities","href":"/api-reference/pos/shipments/retrieve-shipment-activities"},{"title":"Approve shipment","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/shipping/shipments/{reference_number}/approve","href":"/api-reference/pos/shipments/approve-shipment"},{"title":"Retrieve shipment invoice","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/shipping/shipments/{reference_number}/invoice","href":"/api-reference/pos/shipments/retrieve-shipment-invoice"},{"title":"Update shipment detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json put /pos/shipping/shipments/{reference_number}/manual-update","href":"/api-reference/pos/shipments/update-shipment-detail"},{"title":"Reject shipment","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/shipping/shipments/{reference_number}/reject","href":"/api-reference/pos/shipments/reject-shipment"},{"title":"Create a replacement shipment","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/shipping/shipments/{reference_number}/replacement","href":"/api-reference/pos/shipments/create-a-replacement-shipment"}]}]},{"group":"Payments","pages":[{"group":"Payments","pages":[{"title":"Authenticate direct OTP","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/payments/authenticate-direct-otp","href":"/api-reference/pos/payments/authenticate-direct-otp"},{"title":"Get card information","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/payments/card-info","href":"/api-reference/pos/payments/get-card-information"},{"title":"List payment methods","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/payments/payment-methods","href":"/api-reference/pos/payments/list-payment-methods"},{"title":"Resend direct OTP","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/payments/resend-direct-otp","href":"/api-reference/pos/payments/resend-direct-otp"},{"title":"Verify VPA","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/payments/verify-vpa","href":"/api-reference/pos/payments/verify-vpa"}]}]},{"group":"Store","pages":[{"group":"Locations","pages":[{"title":"Retrieve pincodes","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/common/countries/{country_iso_code}/pincodes","href":"/api-reference/pos/locations/retrieve-pincodes"},{"title":"Retrieve country wise states","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/common/countries/{country_iso_code}/states","href":"/api-reference/pos/locations/retrieve-country-wise-states"}]}]}]},{"item":"Webhooks","icon":"webhook","description":"Events Commerce Engine delivers to your endpoints — orders, payments, shipments, catalog, customers, store and marketplace.","pages":[{"title":"Webhooks","href":"/api-reference/webhooks/orders/checkout-completed"}]},{"item":"Admin API","icon":"gear","description":"Back-office operations — catalog management, customers, fulfilment, store settings.","pages":[{"title":"Admin API","href":"/admin/api-reference/products/list-all-products"}]}]}]},"basePath":"","title":"Apply coupon - Commerce Engine Docs","deploymentId":"dpl_53YqbBPsHdrqSGqXiWPGU7csRVod","buildId":"dpl_53YqbBPsHdrqSGqXiWPGU7csRVod","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-Ku9dSkH0.js","snippetPresets-Cjez4eet.js","utils-BqNa-fnS.js","style-to-object-BY3JEAdk.js","utils-DiE92JCe.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-Bi0DpqVf.js","conditional-requirements-CFM0id0Q.js","cloneDeep-C6xnxscF.js","_Uint8Array-B7g0OYAt.js","isObject-FP1Yky1u.js","Page--B9YZ09u.js","CodeSnippet-CTZvgJfu.js","DynamicMarkdown-CsgNpZb1.js","SectionHeading-C3K437Dy.js","icon-DlxjjqnB.js","ApiExamples-Bf8Ecb5t.js","usePlaygroundInputsStore-BA942cq6.js","shallow-D0sePNkF.js","isEqual-CnnQO8sL.js","CodeSnippets-BTANoy1T.js","getApiPlaygroundDisplay-BK2o1XYu.js","MethodPill-Cr7Ib9nN.js","getPastedJson-DXo3wtHt.js","Check2Icon-ChEI-f_B.js","axios-CsQoIw0U.js","Markdown-CH4mv0N8.js","AssistantPageLink-BHjmqccN.js","dist-DYCPzQwJ.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}