Fires once per order when it is purchased: it leaves pending or payment_failed for confirmed, awaiting_approval or complete, paid in full or accepted on a credit line. Not fired by an admin’s approval, or for a seller’s copy of a marketplace order.
{
"message": "Not authorized for given operation on the Resource.",
"success": false,
"code": "unauthorized"
}
Headers
X-CE-Event
string
required
Event name; equals the body event.
X-CE-Signature
string
required
sha256= followed by the hex HMAC-SHA256 of the raw request body, keyed with the webhook secret. Verify with a constant-time comparison before processing.
Pattern: ^sha256=[0-9a-f]{64}$
X-CE-Event-ID
string
required
Equals the body event_id. Stable across retries — use as the idempotency key.
X-CE-Delivery-ID
string
required
Equals the body delivery_id. Unique per delivery attempt.
Body
application/json
Body of every webhook request. The HMAC-SHA256 signature in X-CE-Signature is computed over the raw request body with the webhook secret. Use event_id as the idempotency key: retries of the same event reuse it while delivery_id changes per attempt.
event
enum<string>
required
Event name, e.g. order.created. Also sent as the X-CE-Event header.
Available options:
checkout.completed
event_id
string
required
ULID shared by every delivery attempt of the same event. Also sent as X-CE-Event-ID.
delivery_id
string
required
ULID unique to this delivery attempt. Also sent as X-CE-Delivery-ID.
timestamp
string<date-time>
required
Time this delivery attempt was made.
is_test
boolean
required
true when sent from the admin Send test webhook action.
payload
WebhookPayload · object
required
The inner event record. properties carries the event-specific model documented on each webhook, and each webhook lists the ids it carries at the top level: its entity's (e.g. order_number, cart_id) and related entities'. The other keys are common to all events.
{
"message": "Not authorized for given operation on the Resource.",
"success": false,
"code": "unauthorized"
}
{"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":"6af9711874b4f0f02ee2855a","clientVersion":"0.0.4160","searchFilterCounts":[{"language":"default","tag":"API Reference","count":830},{"language":"default","tag":"Admin API","count":388},{"language":"default","tag":"Customers","count":250},{"language":"default","tag":"Webhooks","count":248},{"language":"default","tag":"Orders","count":156},{"language":"default","tag":"Catalog","count":149},{"language":"default","tag":"Store","count":142},{"language":"default","tag":"Storefront API","count":124},{"language":"default","tag":"Marketplace","count":88},{"language":"default","tag":"Payments","count":80}]},"assistantConfig":{},"basePath":"/docs","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"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/webhooks/orders/checkout-completed","slug":"/api-reference/webhooks/orders/checkout-completed","pageMetadata":{"title":"Checkout completed","description":"Fires once per order when it is purchased: it leaves `pending` or `payment_failed` for `confirmed`, `awaiting_approval` or `complete`, paid in full or accepted on a credit line. Not fired by an admin's approval, or for a seller's copy of a marketplace order.","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook checkout.completed","href":"/api-reference/webhooks/orders/checkout-completed","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: [\"Fires once per order when it is purchased: it leaves \", _jsx(_components.code, {\n children: \"pending\"\n }), \" or \", _jsx(_components.code, {\n children: \"payment_failed\"\n }), \" for \", _jsx(_components.code, {\n children: \"confirmed\"\n }), \", \", _jsx(_components.code, {\n children: \"awaiting_approval\"\n }), \" or \", _jsx(_components.code, {\n children: \"complete\"\n }), \", paid in full or accepted on a credit line. Not fired by an admin’s approval, or for a seller’s copy of a marketplace order.\"]\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":"Checkout completed","description":"Fires once per order when it is purchased: it leaves `pending` or `payment_failed` for `confirmed`, `awaiting_approval` or `complete`, paid in full or accepted on a credit line. Not fired by an admin's approval, or for a seller's copy of a marketplace order.","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook checkout.completed","href":"/api-reference/webhooks/orders/checkout-completed","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/tarkai/83faf160ccb5c4ff/header-float.js"],"openApiReferenceData":{"operation":{"tags":["Orders"],"operationId":"checkout-completed","summary":"Checkout completed","description":"Fires once per order when it is purchased: it leaves `pending` or `payment_failed` for `confirmed`, `awaiting_approval` or `complete`, paid in full or accepted on a credit line. Not fired by an admin's approval, or for a seller's copy of a marketplace order.","parameters":["a46739f5-73e1-41a3-af2e-86077a2a2f77","f9d303bd-2fe8-4fca-95ab-d547401edece","f1cce57c-e9cd-4209-b37d-0d2f851046b7","7e463542-55ae-4c01-a270-2440c497587d"],"requestBody":"7d61b3b8-3bf3-482e-b84a-38ea3a6f2f3d","responses":{"200":"27b6f20c-3b9c-4d0a-9543-8dba30b0328d","400":"1dc2d87b-7c09-40d8-a6a2-0377b8e12eaf","401":"56d0e926-9884-4093-ac97-a12aa7ae4d16","410":"48533afd-0f6f-45a6-aa86-d83b9f107e8d","2XX":"a8af7b21-27f9-41ca-bd5b-31c49c23ad15","5XX":"dd0d9075-3fc7-48e8-9ade-5c6c3cce713a"},"method":"post","type":"webhook","servers":[],"security":[],"path":"checkout.completed","baseUrlOptions":[],"title":"Checkout completed","codeSamples":[],"requiredOnlyExamples":false,"requestExamples":[{"language":"json","filename":"Example","code":"{\n \"event\": \"checkout.completed\",\n \"event_id\": \"\u003cstring>\",\n \"delivery_id\": \"\u003cstring>\",\n \"timestamp\": \"2023-11-07T05:31:56Z\",\n \"is_test\": true,\n \"payload\": {\n \"event\": \"checkout.completed\",\n \"event_id\": \"\u003cstring>\",\n \"store_id\": \"\u003cstring>\",\n \"properties\": {\n \"order_number\": \"\u003cstring>\",\n \"order_date\": \"2023-11-07T05:31:56Z\",\n \"payment_success_date\": \"\u003cstring>\",\n \"customer_note\": \"\u003cstring>\",\n \"is_promotion_applied\": true,\n \"promotion_discount_amount\": 123,\n \"promotion_discount_percent\": 123,\n \"is_coupon_applied\": true,\n \"coupon_code\": \"\u003cstring>\",\n \"coupon_discount_amount\": 123,\n \"coupon_discount_percent\": 123,\n \"applied_promotions\": [\n {\n \"promotion_id\": \"\u003cstring>\",\n \"savings\": 123,\n \"product_id\": \"\u003cstring>\",\n \"variant_id\": \"\u003cstring>\",\n \"product_name\": \"\u003cstring>\",\n \"variant_name\": \"\u003cstring>\",\n \"applied_sequence\": 123,\n \"scope\": \"\u003cstring>\"\n }\n ],\n \"applied_coupons\": [\n {\n \"coupon_id\": \"\u003cstring>\",\n \"savings\": 123,\n \"product_id\": \"\u003cstring>\",\n \"variant_id\": \"\u003cstring>\",\n \"product_name\": \"\u003cstring>\",\n \"variant_name\": \"\u003cstring>\"\n }\n ],\n \"promotion_savings\": 1,\n \"coupon_savings\": 1,\n \"other_savings\": 1,\n \"total_savings\": 1,\n \"on_subscription\": true,\n \"subtotal\": 123,\n \"subtotal_including_tax\": 123,\n \"shipping_estimated_cost\": 1,\n \"shipping_discount_amount\": 1,\n \"shipping_amount\": 123,\n \"shipping_tax_rate\": 1,\n \"shipping_tax_amount\": 1,\n \"shipping_amount_including_tax\": 1,\n \"estimated_delivery_days\": 123,\n \"handling_charge_excluding_tax\": 1,\n \"handling_charge_tax_amount\": 1,\n \"handling_charge_including_tax\": 1,\n \"total_tax\": 123,\n \"grand_total\": 123,\n \"loyalty_points_earned\": 1,\n \"loyalty_points_redeemed\": 1,\n \"credit_balance_used\": 123,\n \"to_be_paid\": 123,\n \"order_items_count\": 123,\n \"order_items\": [\n {\n \"product_id\": \"\u003cstring>\",\n \"product_name\": \"\u003cstring>\",\n \"product_image_url\": \"\u003cstring>\",\n \"sku\": \"\u003cstring>\",\n \"product_slug\": \"\u003cstring>\",\n \"variant_slug\": \"\u003cstring>\",\n \"variant_id\": \"\u003cstring>\",\n \"variant_name\": \"\u003cstring>\",\n \"backorder\": true,\n \"on_promotion\": true,\n \"on_subscription\": true,\n \"subscription_plan\": \"\u003cstring>\",\n \"subscription_interval\": 123,\n \"subscription_frequency\": \"\u003cstring>\",\n \"quantity\": 1,\n \"free_quantity\": 1,\n \"is_free_item\": true,\n \"price_including_tax\": true,\n \"selling_price\": 1,\n \"listing_price\": 1,\n \"selling_price_excluding_tax\": 1,\n \"promotion_discount_amount\": 1,\n \"coupon_discount_amount\": 1,\n \"tax_type\": \"GST\",\n \"tax_rate\": 1,\n \"tax_amount\": 1,\n \"handling_charge_excluding_tax\": 1,\n \"handling_charge_tax_rate\": 1,\n \"handling_charge_including_tax\": 1,\n \"associated_options\": {\n \"background_color\": {\n \"name\": \"Background Color\",\n \"value\": {\n \"name\": \"Blue\",\n \"hexcode\": \"#0000FF\"\n },\n \"type\": \"color\"\n },\n \"size\": {\n \"name\": \"Size\",\n \"value\": \"Large\",\n \"type\": \"single-select\"\n }\n },\n \"attributes\": [\n {\n \"id\": \"\u003cstring>\",\n \"name\": \"\u003cstring>\",\n \"key\": \"\u003cstring>\",\n \"type\": \"color\",\n \"value\": [\n {\n \"name\": \"\u003cstring>\",\n \"hexcode\": \"\u003cstring>\"\n }\n ]\n }\n ],\n \"seller_id\": \"\u003cstring>\",\n \"seller_detail\": {\n \"id\": \"\u003cstring>\",\n \"trade_name\": \"\u003cstring>\",\n \"legal_name\": \"\u003cstring>\",\n \"business_type\": \"\u003cstring>\",\n \"tax_identification_number\": \"\u003cstring>\"\n },\n \"promotion_discount_percent\": 1,\n \"coupon_discount_percent\": 1,\n \"seller_product_id\": \"\u003cstring>\",\n \"seller_variant_id\": \"\u003cstring>\",\n \"product_variant_id\": \"\u003cstring>\",\n \"hsncode\": \"\u003cstring>\",\n \"incremental_quantity\": 1,\n \"on_offer\": true,\n \"slug\": \"\u003cstring>\"\n }\n ],\n \"billing_address\": {\n \"id\": null,\n \"first_name\": \"\u003cstring>\",\n \"last_name\": \"\u003cstring>\",\n \"business_name\": \"\u003cstring>\",\n \"phone\": \"\u003cstring>\",\n \"country_code\": \"\u003cstring>\",\n \"address_line1\": \"\u003cstring>\",\n \"address_line2\": \"\u003cstring>\",\n \"landmark\": \"\u003cstring>\",\n \"pincode\": \"\u003cstring>\",\n \"city\": \"\u003cstring>\",\n \"state\": \"\u003cstring>\",\n \"country\": \"\u003cstring>\",\n \"gstin\": \"\u003cstring>\",\n \"tax_identification_number\": \"\u003cstring>\",\n \"email\": \"\u003cstring>\",\n \"is_email_verified\": true,\n \"is_phone_verified\": true\n },\n \"shipping_address\": {\n \"id\": null,\n \"first_name\": \"\u003cstring>\",\n \"last_name\": \"\u003cstring>\",\n \"business_name\": \"\u003cstring>\",\n \"phone\": \"\u003cstring>\",\n \"country_code\": \"\u003cstring>\",\n \"address_line1\": \"\u003cstring>\",\n \"address_line2\": \"\u003cstring>\",\n \"landmark\": \"\u003cstring>\",\n \"pincode\": \"\u003cstring>\",\n \"city\": \"\u003cstring>\",\n \"state\": \"\u003cstring>\",\n \"country\": \"\u003cstring>\",\n \"gstin\": \"\u003cstring>\",\n \"tax_identification_number\": \"\u003cstring>\",\n \"email\": \"\u003cstring>\",\n \"is_email_verified\": true,\n \"is_phone_verified\": true\n },\n \"currency\": {\n \"name\": \"\u003cstring>\",\n \"code\": \"\u003cstring>\",\n \"symbol\": \"\u003cstring>\"\n },\n \"metadata\": {\n \"pos_user_id\": \"\u003cstring>\",\n \"pos_device_id\": \"\u003cstring>\",\n \"origin_location_id\": \"\u003cstring>\",\n \"custom_metadata\": {}\n },\n \"is_cancellation_allowed\": true,\n \"cancellation_refund_details\": {\n \"loyalty_point\": 123,\n \"refundable_amount\": 123,\n \"cancellation_charges\": 123,\n \"cancellation_charges_reason\": \"\u003cstring>\"\n },\n \"feedback\": \"\u003cstring>\",\n \"cart_id\": \"\u003cstring>\",\n \"coupon_id\": \"\u003cstring>\",\n \"cancellation_reason\": \"\u003cstring>\",\n \"shipping_provider_id\": \"\u003cstring>\",\n \"courier_company_id\": \"\u003cstring>\",\n \"shipping_provider_name\": \"\u003cstring>\",\n \"courier_company_name\": \"\u003cstring>\",\n \"fulfillment_type\": \"\u003cstring>\",\n \"items_tax_amount\": 1,\n \"loyalty_point_eligible_amount\": 123,\n \"sales_channel\": {\n \"id\": \"\u003cstring>\",\n \"type\": \"\u003cstring>\"\n },\n \"payments\": [\n {\n \"request_number\": \"\u003cstring>\",\n \"amount\": 123,\n \"payment_reference_number\": \"\u003cstring>\",\n \"payment_method\": \"\u003cstring>\",\n \"payment_date\": \"2023-11-07T05:31:56Z\",\n \"icon_url\": \"\u003cstring>\",\n \"payment_provider_slug\": \"\u003cstring>\",\n \"payment_mode\": \"\u003cstring>\",\n \"shipment_number\": \"\u003cstring>\",\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"modified_at\": \"2023-11-07T05:31:56Z\",\n \"card_number\": \"\u003cstring>\",\n \"card_type\": \"\u003cstring>\",\n \"bank_name\": \"\u003cstring>\",\n \"upi_id\": \"\u003cstring>\",\n \"wallet_name\": \"\u003cstring>\",\n \"bank_account_number\": \"\u003cstring>\",\n \"payment_gateway\": \"\u003cstring>\"\n }\n ],\n \"customer_email\": \"\u003cstring>\",\n \"customer_phone\": \"\u003cstring>\",\n \"cancelled_by\": \"\u003cstring>\",\n \"kyc_details\": {\n \"documents\": [\n {\n \"document_number\": \"\u003cstring>\",\n \"status\": \"\u003cstring>\",\n \"is_verified\": true,\n \"is_mandatory\": true,\n \"is_attachment_required\": true\n }\n ],\n \"customer_group\": \"\u003cstring>\"\n },\n \"erp_ledger\": {\n \"service_provider_id\": \"\u003cstring>\",\n \"service_provider_slug\": \"\u003cstring>\",\n \"service_provider_name\": \"\u003cstring>\",\n \"external_ledger_id\": \"\u003cstring>\"\n }\n },\n \"order_number\": \"\u003cstring>\",\n \"store_type\": \"\u003cstring>\",\n \"user_id\": \"\u003cstring>\",\n \"customer_id\": \"\u003cstring>\",\n \"admin_user_id\": \"\u003cstring>\",\n \"tenant_id\": \"\u003cstring>\",\n \"seller_id\": \"\u003cstring>\",\n \"timestamp\": \"\u003cstring>\",\n \"is_test\": true,\n \"changes\": {},\n \"context\": {}\n }\n}"}],"requestExampleType":"webhook","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{"a46739f5-73e1-41a3-af2e-86077a2a2f77":{"name":"X-CE-Event","in":"header","required":true,"description":"Event name; equals the body `event`.","schema":{"type":"string","isRequired":true,"description":"Event name; equals the body `event`.","uniqueKey":"","typeLabel":"string"}},"f9d303bd-2fe8-4fca-95ab-d547401edece":{"name":"X-CE-Signature","in":"header","required":true,"description":"`sha256=` followed by the hex HMAC-SHA256 of the raw request body, keyed with the webhook secret. Verify with a constant-time comparison before processing.","schema":{"type":"string","pattern":"^sha256=[0-9a-f]{64}$","isRequired":true,"description":"`sha256=` followed by the hex HMAC-SHA256 of the raw request body, keyed with the webhook secret. Verify with a constant-time comparison before processing.","uniqueKey":"","typeLabel":"string"}},"f1cce57c-e9cd-4209-b37d-0d2f851046b7":{"name":"X-CE-Event-ID","in":"header","required":true,"description":"Equals the body `event_id`. Stable across retries — use as the idempotency key.","schema":{"type":"string","isRequired":true,"description":"Equals the body `event_id`. Stable across retries — use as the idempotency key.","uniqueKey":"","typeLabel":"string"}},"7e463542-55ae-4c01-a270-2440c497587d":{"name":"X-CE-Delivery-ID","in":"header","required":true,"description":"Equals the body `delivery_id`. Unique per delivery attempt.","schema":{"type":"string","isRequired":true,"description":"Equals the body `delivery_id`. Unique per delivery attempt.","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"WebhookEnvelope","description":"Body of every webhook request. The HMAC-SHA256 signature in `X-CE-Signature` is computed over the raw request body with the webhook secret. Use `event_id` as the idempotency key: retries of the same event reuse it while `delivery_id` changes per attempt.","required":["event","event_id","delivery_id","timestamp","payload","is_test"],"properties":{"event":{"type":"string","description":"Event name, e.g. `order.created`. Also sent as the `X-CE-Event` header.","enum":["checkout.completed"],"isRequired":true,"uniqueKey":"event","typeLabel":"enum\u003cstring>"},"event_id":{"description":"ULID shared by every delivery attempt of the same event. Also sent as `X-CE-Event-ID`.","type":"string","isRequired":true,"uniqueKey":"event_id","typeLabel":"string"},"delivery_id":{"description":"ULID unique to this delivery attempt. Also sent as `X-CE-Delivery-ID`.","type":"string","isRequired":true,"uniqueKey":"delivery_id","typeLabel":"string"},"timestamp":{"description":"Time this delivery attempt was made.","type":"string","format":"date-time","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"},"is_test":{"description":"`true` when sent from the admin *Send test webhook* action.","type":"boolean","isRequired":true,"uniqueKey":"is_test","typeLabel":"boolean"},"payload":{"type":"object","title":"WebhookPayload","description":"The inner event record. `properties` carries the event-specific model documented on each webhook, and each webhook lists the ids it carries at the top level: its entity's (e.g. `order_number`, `cart_id`) and related entities'. The other keys are common to all events.","required":["order_number","event","event_id","store_id","properties"],"properties":{"event":{"type":"string","description":"Event name, identical to the envelope `event` and the `X-CE-Event` header.","enum":["checkout.completed"],"isRequired":true,"uniqueKey":"payload.event","typeLabel":"enum\u003cstring>"},"event_id":{"description":"ULID of the event. Identical to the envelope `event_id`.","type":"string","isRequired":true,"uniqueKey":"payload.event_id","typeLabel":"string"},"store_id":{"description":"Store the event belongs to. For `seller.*` events this is the marketplace store; the seller store is in `seller_id`.","type":"string","isRequired":true,"uniqueKey":"payload.store_id","typeLabel":"string"},"properties":{"type":"object","title":"OrderState","description":"An order as its events carry it: its status, totals, items, addresses and payments, the customer's contact (`customer_email`, `customer_phone`), who cancelled the order, and the KYC and ERP ledger details recorded when the merchant approved it.","required":["order_number","order_date","status","payment_status","payment_success_date","customer_note","is_promotion_applied","promotion_discount_amount","promotion_discount_percent","is_coupon_applied","coupon_code","coupon_discount_amount","coupon_discount_percent","applied_promotions","applied_coupons","promotion_savings","coupon_savings","other_savings","total_savings","on_subscription","subtotal","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","loyalty_points_earned","loyalty_points_redeemed","credit_balance_used","to_be_paid","order_items_count","order_items","billing_address","shipping_address","currency","metadata","is_cancellation_allowed","cancellation_refund_details","feedback","cart_id","coupon_id","cancellation_reason","shipping_provider_id","courier_company_id","shipping_provider_name","courier_company_name","items_tax_amount","fulfillment_type","sales_channel","loyalty_point_eligible_amount","payments","customer_email","customer_phone","cancelled_by","kyc_details","erp_ledger"],"properties":{"order_number":{"description":"Unique, human-readable order identifier used across all order endpoints.","type":"string","isRequired":true,"uniqueKey":"payload.properties.order_number","typeLabel":"string"},"order_date":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"payload.properties.order_date","typeLabel":"string\u003cdate-time>"},"status":{"description":"Current fulfillment status of the order. Progresses from `confirmed` through shipping stages to `complete`; a collect-in-store order with nothing to ship is `complete` as soon as it is paid, unless it was already accepted on the customer's credit line (it then stays `confirmed`). `pending` while it awaits payment, and `payment_failed` once every payment attempt failed (a payment retry reopens it). An order with one shipment can also take that shipment's `schedule_requested`, `processing`, `sent_to_store`, `ready_to_collect` or `lost`.","type":"string","enum":["draft","awaiting_approval","confirmed","partially_scheduled","awaiting_shipment","shipped","partially_shipped","undelivered","partially_undelivered","return_to_origin","partially_return_to_origin","complete","partially_delivered","cancelled","pending","schedule_requested","payment_failed","sent_to_store","ready_to_collect","processing","lost"],"isRequired":true,"uniqueKey":"payload.properties.status","typeLabel":"enum\u003cstring>"},"payment_status":{"description":"The order's payment status. `debit_scheduled` and `collection_due`: the order is on the customer's credit line, to be debited from their bank account by NACH mandate, or collected later. `refund_initiated` and `refunded`: refunds covering what was paid are on their way, or done. `manual_review`: the payment is being reviewed.","type":"string","enum":["pending","success","failed","partially_paid","refund_initiated","refunded","debit_scheduled","collection_due","manual_review"],"isRequired":true,"uniqueKey":"payload.properties.payment_status","typeLabel":"enum\u003cstring>"},"payment_success_date":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payload.properties.payment_success_date.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.payment_success_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.payment_success_date","typeLabel":"string | null"},"customer_note":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payload.properties.customer_note.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.customer_note.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.customer_note","typeLabel":"string | null"},"is_promotion_applied":{"type":"boolean","isRequired":true,"uniqueKey":"payload.properties.is_promotion_applied","typeLabel":"boolean"},"promotion_discount_amount":{"type":"number","format":"double","isRequired":true,"uniqueKey":"payload.properties.promotion_discount_amount","typeLabel":"number\u003cdouble>"},"promotion_discount_percent":{"oneOf":[{"type":"number","format":"double","isRequired":true,"uniqueKey":"payload.properties.promotion_discount_percent.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","format":"double","isRequired":true,"uniqueKey":"payload.properties.promotion_discount_percent.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.promotion_discount_percent","typeLabel":"number\u003cdouble> | null"},"is_coupon_applied":{"type":"boolean","isRequired":true,"uniqueKey":"payload.properties.is_coupon_applied","typeLabel":"boolean"},"coupon_code":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payload.properties.coupon_code.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.coupon_code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.coupon_code","typeLabel":"string | null"},"coupon_discount_amount":{"type":"number","format":"double","isRequired":true,"uniqueKey":"payload.properties.coupon_discount_amount","typeLabel":"number\u003cdouble>"},"coupon_discount_percent":{"oneOf":[{"type":"number","format":"double","isRequired":true,"uniqueKey":"payload.properties.coupon_discount_percent.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","format":"double","isRequired":true,"uniqueKey":"payload.properties.coupon_discount_percent.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.coupon_discount_percent","typeLabel":"number\u003cdouble> | 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/storefront/schemas/AppliedPromotion","description":"API reference for the AppliedPromotion schema"},"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":"payload.properties.applied_promotions.items.[INDEX].promotion_id","typeLabel":"string"},"promotion_type":{"enum":["discount","free-goods","free-shipping","buy-x-get-y","volume-based"],"type":"string","isRequired":true,"uniqueKey":"payload.properties.applied_promotions.items.[INDEX].promotion_type","typeLabel":"enum\u003cstring>"},"savings":{"type":"number","isRequired":true,"uniqueKey":"payload.properties.applied_promotions.items.[INDEX].savings","typeLabel":"number"},"product_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payload.properties.applied_promotions.items.[INDEX].product_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.applied_promotions.items.[INDEX].product_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.applied_promotions.items.[INDEX].product_id","typeLabel":"string | null"},"variant_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payload.properties.applied_promotions.items.[INDEX].variant_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.applied_promotions.items.[INDEX].variant_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.applied_promotions.items.[INDEX].variant_id","typeLabel":"string | null"},"product_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payload.properties.applied_promotions.items.[INDEX].product_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.applied_promotions.items.[INDEX].product_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.applied_promotions.items.[INDEX].product_name","typeLabel":"string | null"},"variant_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payload.properties.applied_promotions.items.[INDEX].variant_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.applied_promotions.items.[INDEX].variant_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.applied_promotions.items.[INDEX].variant_name","typeLabel":"string | null"},"applied_sequence":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"payload.properties.applied_promotions.items.[INDEX].applied_sequence.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.applied_promotions.items.[INDEX].applied_sequence.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.applied_promotions.items.[INDEX].applied_sequence","typeLabel":"number | null"},"scope":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payload.properties.applied_promotions.items.[INDEX].scope.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.applied_promotions.items.[INDEX].scope.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.applied_promotions.items.[INDEX].scope","typeLabel":"string | null"}},"uniqueKey":"payload.properties.applied_promotions.items.[INDEX]","typeLabel":"AppliedPromotion · object"},"isRequired":true,"uniqueKey":"payload.properties.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/storefront/schemas/AppliedCoupon","description":"API reference for the AppliedCoupon schema"},"required":["coupon_id","coupon_type","savings","product_id","variant_id","product_name","variant_name"],"properties":{"coupon_id":{"type":"string","isRequired":true,"uniqueKey":"payload.properties.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":"payload.properties.applied_coupons.items.[INDEX].coupon_type","typeLabel":"enum\u003cstring>"},"savings":{"type":"number","isRequired":true,"uniqueKey":"payload.properties.applied_coupons.items.[INDEX].savings","typeLabel":"number"},"product_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payload.properties.applied_coupons.items.[INDEX].product_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.applied_coupons.items.[INDEX].product_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.applied_coupons.items.[INDEX].product_id","typeLabel":"string | null"},"variant_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payload.properties.applied_coupons.items.[INDEX].variant_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.applied_coupons.items.[INDEX].variant_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.applied_coupons.items.[INDEX].variant_id","typeLabel":"string | null"},"product_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payload.properties.applied_coupons.items.[INDEX].product_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.applied_coupons.items.[INDEX].product_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.applied_coupons.items.[INDEX].product_name","typeLabel":"string | null"},"variant_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payload.properties.applied_coupons.items.[INDEX].variant_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.applied_coupons.items.[INDEX].variant_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.applied_coupons.items.[INDEX].variant_name","typeLabel":"string | null"}},"uniqueKey":"payload.properties.applied_coupons.items.[INDEX]","typeLabel":"AppliedCoupon · object"},"isRequired":true,"uniqueKey":"payload.properties.applied_coupons","typeLabel":"AppliedCoupon · object[]"},"promotion_savings":{"description":"Total savings from auto-applied promotions.","type":"number","format":"float","minimum":0,"isRequired":true,"uniqueKey":"payload.properties.promotion_savings","typeLabel":"number\u003cfloat>"},"coupon_savings":{"description":"Total savings from the applied coupon code.","type":"number","format":"float","minimum":0,"isRequired":true,"uniqueKey":"payload.properties.coupon_savings","typeLabel":"number\u003cfloat>"},"other_savings":{"description":"Total savings from loyalty points, credit balance, and other non-promotion/coupon discounts.","type":"number","format":"float","minimum":0,"isRequired":true,"uniqueKey":"payload.properties.other_savings","typeLabel":"number\u003cfloat>"},"total_savings":{"description":"Combined savings across promotions, coupons, and other discounts.","type":"number","format":"float","minimum":0,"isRequired":true,"uniqueKey":"payload.properties.total_savings","typeLabel":"number\u003cfloat>"},"on_subscription":{"type":"boolean","isRequired":true,"uniqueKey":"payload.properties.on_subscription","typeLabel":"boolean"},"subtotal":{"type":"number","format":"double","isRequired":true,"uniqueKey":"payload.properties.subtotal","typeLabel":"number\u003cdouble>"},"subtotal_including_tax":{"type":"number","format":"double","isRequired":true,"uniqueKey":"payload.properties.subtotal_including_tax","typeLabel":"number\u003cdouble>"},"shipping_estimated_cost":{"type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"payload.properties.shipping_estimated_cost","typeLabel":"number\u003cdouble>"},"shipping_discount_amount":{"type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"payload.properties.shipping_discount_amount","typeLabel":"number\u003cdouble>"},"shipping_amount":{"type":"number","format":"double","isRequired":true,"uniqueKey":"payload.properties.shipping_amount","typeLabel":"number\u003cdouble>"},"shipping_tax_rate":{"type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"payload.properties.shipping_tax_rate","typeLabel":"number\u003cdouble>"},"shipping_tax_amount":{"type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"payload.properties.shipping_tax_amount","typeLabel":"number\u003cdouble>"},"shipping_amount_including_tax":{"type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"payload.properties.shipping_amount_including_tax","typeLabel":"number\u003cdouble>"},"estimated_delivery_days":{"oneOf":[{"type":"integer","isRequired":true,"uniqueKey":"payload.properties.estimated_delivery_days.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.estimated_delivery_days.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.estimated_delivery_days","typeLabel":"integer | null"},"handling_charge_excluding_tax":{"type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"payload.properties.handling_charge_excluding_tax","typeLabel":"number\u003cdouble>"},"handling_charge_tax_amount":{"type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"payload.properties.handling_charge_tax_amount","typeLabel":"number\u003cdouble>"},"handling_charge_including_tax":{"type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"payload.properties.handling_charge_including_tax","typeLabel":"number\u003cdouble>"},"total_tax":{"type":"number","format":"double","isRequired":true,"uniqueKey":"payload.properties.total_tax","typeLabel":"number\u003cdouble>"},"grand_total":{"type":"number","format":"double","isRequired":true,"uniqueKey":"payload.properties.grand_total","typeLabel":"number\u003cdouble>"},"loyalty_points_earned":{"type":"number","minimum":0,"isRequired":true,"uniqueKey":"payload.properties.loyalty_points_earned","typeLabel":"number"},"loyalty_points_redeemed":{"type":"number","minimum":0,"isRequired":true,"uniqueKey":"payload.properties.loyalty_points_redeemed","typeLabel":"number"},"credit_balance_used":{"type":"number","isRequired":true,"uniqueKey":"payload.properties.credit_balance_used","typeLabel":"number"},"to_be_paid":{"type":"number","format":"double","isRequired":true,"uniqueKey":"payload.properties.to_be_paid","typeLabel":"number\u003cdouble>"},"order_items_count":{"type":"integer","isRequired":true,"uniqueKey":"payload.properties.order_items_count","typeLabel":"integer"},"order_items":{"type":"array","items":{"title":"OrderStateItem","description":"An item of an order as its events carry it.","type":"object","externalDocs":{"url":"https://llm-docs.commercengine.io/storefront/schemas/OrderStateItem","description":"API reference for the OrderStateItem schema"},"required":["product_id","product_name","product_image_url","product_type","sku","product_slug","variant_slug","variant_id","variant_name","on_promotion","on_subscription","subscription_plan","subscription_interval","subscription_frequency","quantity","free_quantity","is_free_item","price_including_tax","selling_price","listing_price","selling_price_excluding_tax","promotion_discount_amount","coupon_discount_amount","tax_type","tax_rate","tax_amount","handling_charge_excluding_tax","handling_charge_tax_rate","handling_charge_including_tax","backorder","seller_id","seller_detail","promotion_discount_percent","coupon_discount_percent","seller_product_id","seller_variant_id","product_variant_id","hsncode","incremental_quantity","on_offer","slug","associated_options","attributes"],"properties":{"product_id":{"type":"string","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].product_id","typeLabel":"string"},"product_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].product_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].product_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].product_name","typeLabel":"string | null"},"product_image_url":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].product_image_url.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].product_image_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].product_image_url","typeLabel":"string | null"},"product_type":{"oneOf":[{"type":"string","enum":["physical","digital","bundle",null],"isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].product_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["physical","digital","bundle",null],"isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].product_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].product_type","typeLabel":"enum\u003cstring> | null"},"sku":{"type":"string","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].sku","typeLabel":"string"},"product_slug":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].product_slug.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].product_slug.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].product_slug","typeLabel":"string | null"},"variant_slug":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].variant_slug.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].variant_slug.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].variant_slug","typeLabel":"string | null"},"variant_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].variant_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].variant_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].variant_id","typeLabel":"string | null"},"variant_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].variant_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].variant_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].variant_name","typeLabel":"string | null"},"backorder":{"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.","type":"boolean","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].backorder","typeLabel":"boolean"},"on_promotion":{"type":"boolean","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].on_promotion","typeLabel":"boolean"},"on_subscription":{"type":"boolean","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].on_subscription","typeLabel":"boolean"},"subscription_plan":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].subscription_plan.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].subscription_plan.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].subscription_plan","typeLabel":"string | null"},"subscription_interval":{"oneOf":[{"type":"integer","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].subscription_interval.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].subscription_interval.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].subscription_interval","typeLabel":"integer | null"},"subscription_frequency":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].subscription_frequency.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].subscription_frequency.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].subscription_frequency","typeLabel":"string | null"},"quantity":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].quantity","typeLabel":"integer"},"free_quantity":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].free_quantity","typeLabel":"integer"},"is_free_item":{"type":"boolean","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].is_free_item","typeLabel":"boolean"},"price_including_tax":{"oneOf":[{"type":"boolean","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].price_including_tax.oneOf.0","typeLabel":"boolean"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].price_including_tax.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].price_including_tax","typeLabel":"boolean | null"},"selling_price":{"type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].selling_price","typeLabel":"number\u003cdouble>"},"listing_price":{"type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].listing_price","typeLabel":"number\u003cdouble>"},"selling_price_excluding_tax":{"type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].selling_price_excluding_tax","typeLabel":"number\u003cdouble>"},"promotion_discount_amount":{"type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].promotion_discount_amount","typeLabel":"number\u003cdouble>"},"coupon_discount_amount":{"type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].coupon_discount_amount","typeLabel":"number\u003cdouble>"},"tax_type":{"description":"The kind of tax `tax_rate` is, e.g. `GST`, as the product's pricing names it; lowercase (`gst`) on orders an admin created and on a seller's copy of a marketplace order.","type":"string","examples":["GST"],"isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].tax_type","typeLabel":"string"},"tax_rate":{"type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].tax_rate","typeLabel":"number\u003cdouble>"},"tax_amount":{"type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].tax_amount","typeLabel":"number\u003cdouble>"},"handling_charge_excluding_tax":{"type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].handling_charge_excluding_tax","typeLabel":"number\u003cdouble>"},"handling_charge_tax_rate":{"type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].handling_charge_tax_rate","typeLabel":"number\u003cdouble>"},"handling_charge_including_tax":{"type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].handling_charge_including_tax","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":{"description":"The name of the associated option.","type":"string","isRequired":true,"uniqueKey":"payload.properties.order_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":"payload.properties.order_items.items.[INDEX].associated_options.oneOf.0.additionalProperties.oneOf.0.type","typeLabel":"any"},"value":{"type":"object","properties":{"hexcode":{"description":"The hex code of the color (e.g., #000000).","type":"string","format":"color-hex","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}$","isRequired":true,"uniqueKey":"payload.properties.order_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":"payload.properties.order_items.items.[INDEX].associated_options.oneOf.0.additionalProperties.oneOf.0.value.name","typeLabel":"string"}},"required":["name","hexcode"],"isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].associated_options.oneOf.0.additionalProperties.oneOf.0.value","typeLabel":"object"}},"uniqueKey":"payload.properties.order_items.items.[INDEX].associated_options.oneOf.0.additionalProperties.oneOf.0","typeLabel":"ColorOption · object"},{"type":"object","title":"SingleSelectOption","required":["name","type","value"],"properties":{"name":{"description":"The name of the associated option.","type":"string","isRequired":true,"uniqueKey":"payload.properties.order_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":"payload.properties.order_items.items.[INDEX].associated_options.oneOf.0.additionalProperties.oneOf.1.type","typeLabel":"any"},"value":{"description":"The value of the associated option","type":"string","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].associated_options.oneOf.0.additionalProperties.oneOf.1.value","typeLabel":"string"}},"uniqueKey":"payload.properties.order_items.items.[INDEX].associated_options.oneOf.0.additionalProperties.oneOf.1","typeLabel":"SingleSelectOption · object"}],"uniqueKey":"payload.properties.order_items.items.[INDEX].associated_options.oneOf.0.additionalProperties","typeLabel":"ColorOption · object | SingleSelectOption · object"},"isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].associated_options.oneOf.0","typeLabel":"AssociatedOption · object"},{"type":"null","description":"Null when `variant_id` is null.","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].associated_options.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.order_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":"payload.properties.order_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.0.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.0.name","typeLabel":"string"},"key":{"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`","type":"string","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.0.key","typeLabel":"string"},"type":{"type":"string","example":"color","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.0.type","typeLabel":"string"},"value":{"type":"array","items":{"type":"object","required":["name","hexcode"],"properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.0.value.items.[INDEX].name","typeLabel":"string"},"hexcode":{"description":"The hex code of the color (e.g., #000000).","type":"string","format":"color-hex","pattern":"^#(?:[0-9a-fA-F]{3}){1,2}$","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.0.value.items.[INDEX].hexcode","typeLabel":"string\u003ccolor-hex>"}},"uniqueKey":"payload.properties.order_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.0.value.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.0.value","typeLabel":"object[]"}},"uniqueKey":"payload.properties.order_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":"payload.properties.order_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.1.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.1.name","typeLabel":"string"},"key":{"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`","type":"string","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.1.key","typeLabel":"string"},"type":{"type":"string","example":"single-select","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.1.type","typeLabel":"string"},"value":{"description":"For single-select attributes","type":"string","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.1.value","typeLabel":"string"}},"uniqueKey":"payload.properties.order_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.1","typeLabel":"SingleSelectAttribute · object"},{"type":"object","title":"MultiSelectAttribute","description":"Attribute for multi-select values","required":["id","name","key","type","value"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.2.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.2.name","typeLabel":"string"},"key":{"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`","type":"string","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.2.key","typeLabel":"string"},"type":{"type":"string","example":"multi-select","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.2.type","typeLabel":"string"},"value":{"description":"For multi-select attributes","type":"array","items":{"type":"string","uniqueKey":"payload.properties.order_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.2.value.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.2.value","typeLabel":"string[]"}},"uniqueKey":"payload.properties.order_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.2","typeLabel":"MultiSelectAttribute · object"},{"type":"object","title":"TextAttribute","description":"Attribute for text values","required":["id","name","key","type","value"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.3.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.3.name","typeLabel":"string"},"key":{"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`","type":"string","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.3.key","typeLabel":"string"},"type":{"type":"string","example":"text","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.3.type","typeLabel":"string"},"value":{"description":"For text attributes","type":"string","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.3.value","typeLabel":"string"}},"uniqueKey":"payload.properties.order_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.3","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":"payload.properties.order_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.4.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.4.name","typeLabel":"string"},"key":{"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`","type":"string","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.4.key","typeLabel":"string"},"type":{"type":"string","example":"date","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.4.type","typeLabel":"string"},"value":{"description":"For date attributes","type":"string","format":"date-time","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.4.value","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"payload.properties.order_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.4","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":"payload.properties.order_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.5.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.5.name","typeLabel":"string"},"key":{"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`","type":"string","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.5.key","typeLabel":"string"},"type":{"type":"string","example":"number","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.5.type","typeLabel":"string"},"value":{"description":"For numeric attributes","type":"number","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.5.value","typeLabel":"number"}},"uniqueKey":"payload.properties.order_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.5","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":"payload.properties.order_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.6.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.6.name","typeLabel":"string"},"key":{"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`","type":"string","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.6.key","typeLabel":"string"},"type":{"type":"string","example":"boolean","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.6.type","typeLabel":"string"},"value":{"description":"For boolean attributes","type":"boolean","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.6.value","typeLabel":"boolean"}},"uniqueKey":"payload.properties.order_items.items.[INDEX].attributes.oneOf.0.items.[INDEX].oneOf.6","typeLabel":"BooleanAttribute · object"}],"uniqueKey":"payload.properties.order_items.items.[INDEX].attributes.oneOf.0.items.[INDEX]","typeLabel":"ColorAttribute · object | SingleSelectAttribute · object | MultiSelectAttribute · object | TextAttribute · object | DateAttribute · object | NumberAttribute · object | BooleanAttribute · object"},"description":"The product's attributes when it was ordered. `null` when the order was created without them (e.g. by an admin), and empty (`{}`) on a seller's copy of a marketplace order without them.","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].attributes.oneOf.0","typeLabel":"(ColorAttribute · object | SingleSelectAttribute · object | MultiSelectAttribute · object | TextAttribute · object | DateAttribute · object | NumberAttribute · object | BooleanAttribute · object)[]"},{"type":"object","description":"The product's attributes when it was ordered. `null` when the order was created without them (e.g. by an admin), and empty (`{}`) on a seller's copy of a marketplace order without them.","maxProperties":0,"isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].attributes.oneOf.1","typeLabel":"object"},{"type":"null","description":"The product's attributes when it was ordered. `null` when the order was created without them (e.g. by an admin), and empty (`{}`) on a seller's copy of a marketplace order without them.","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].attributes.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].attributes","typeLabel":"(ColorAttribute · object | SingleSelectAttribute · object | MultiSelectAttribute · object | TextAttribute · object | DateAttribute · object | NumberAttribute · object | BooleanAttribute · object)[] | object | null"},"seller_id":{"oneOf":[{"description":"Seller ID. This field is relevant for marketplace type stores only. Will return null for b2b and b2c type stores.","type":"string","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].seller_id.oneOf.0","typeLabel":"string"},{"description":"Seller ID. This field is relevant for marketplace type stores only. Will return null for b2b and b2c type stores.","type":"null","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].seller_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.order_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":"payload.properties.order_items.items.[INDEX].seller_detail.oneOf.0.id","typeLabel":"string"},"trade_name":{"type":"string","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].seller_detail.oneOf.0.trade_name","typeLabel":"string"},"legal_name":{"type":"string","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].seller_detail.oneOf.0.legal_name","typeLabel":"string"},"business_type":{"type":"string","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].seller_detail.oneOf.0.business_type","typeLabel":"string"},"tax_identification_number":{"type":"string","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].seller_detail.oneOf.0.tax_identification_number","typeLabel":"string"}},"isRequired":true,"uniqueKey":"payload.properties.order_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":"payload.properties.order_items.items.[INDEX].seller_detail.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].seller_detail","typeLabel":"SellerInfo · object | null"},"promotion_discount_percent":{"description":"Promotion discount expressed as a percentage.","type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].promotion_discount_percent","typeLabel":"number\u003cdouble>"},"coupon_discount_percent":{"description":"Coupon discount expressed as a percentage.","type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].coupon_discount_percent","typeLabel":"number\u003cdouble>"},"seller_product_id":{"oneOf":[{"description":"Seller's product ID. Relevant for marketplace stores; `null` otherwise.","type":"string","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].seller_product_id.oneOf.0","typeLabel":"string"},{"description":"Seller's product ID. Relevant for marketplace stores; `null` otherwise.","type":"null","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].seller_product_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].seller_product_id","typeLabel":"string | null"},"seller_variant_id":{"oneOf":[{"description":"Seller's variant ID. Relevant for marketplace stores; `null` otherwise.","type":"string","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].seller_variant_id.oneOf.0","typeLabel":"string"},{"description":"Seller's variant ID. Relevant for marketplace stores; `null` otherwise.","type":"null","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].seller_variant_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].seller_variant_id","typeLabel":"string | null"},"product_variant_id":{"oneOf":[{"description":"Same as `variant_id`.","type":"string","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].product_variant_id.oneOf.0","typeLabel":"string"},{"description":"Same as `variant_id`.","type":"null","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].product_variant_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].product_variant_id","typeLabel":"string | null"},"hsncode":{"oneOf":[{"description":"HSN/SAC tax classification code of the product. `null` when not configured.","type":"string","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].hsncode.oneOf.0","typeLabel":"string"},{"description":"HSN/SAC tax classification code of the product. `null` when not configured.","type":"null","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].hsncode.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].hsncode","typeLabel":"string | null"},"incremental_quantity":{"description":"The step the item's quantity changes by.","type":"integer","minimum":0,"isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].incremental_quantity","typeLabel":"integer"},"on_offer":{"description":"Whether the product had an active offer when it was ordered.","type":"boolean","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].on_offer","typeLabel":"boolean"},"slug":{"oneOf":[{"description":"Slug of the ordered entity (the variant's when `variant_id` is set, otherwise the product's).","type":"string","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].slug.oneOf.0","typeLabel":"string"},{"description":"Slug of the ordered entity (the variant's when `variant_id` is set, otherwise the product's).","type":"null","isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].slug.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.order_items.items.[INDEX].slug","typeLabel":"string | null"}},"uniqueKey":"payload.properties.order_items.items.[INDEX]","typeLabel":"OrderStateItem · object"},"isRequired":true,"uniqueKey":"payload.properties.order_items","typeLabel":"OrderStateItem · object[]"},"billing_address":{"title":"OrderAddress","description":"A billing or shipping address as recorded on the order: a copy made when the order was placed, so later changes to the customer's saved addresses don't alter it. Its fields are `null` when the order was placed without them (e.g. at a point of sale).","type":"object","externalDocs":{"url":"https://llm-docs.commercengine.io/storefront/schemas/OrderAddress","description":"API reference for the OrderAddress schema"},"required":["id","first_name","last_name","business_name","phone","country_code","address_line1","address_line2","landmark","pincode","city","state","country","gstin","tax_identification_number","email","is_email_verified","is_phone_verified"],"properties":{"id":{"description":"Always `null`: the order's address is a copy, not a saved address.","type":"null","isRequired":true,"uniqueKey":"payload.properties.billing_address.id","typeLabel":"null"},"first_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payload.properties.billing_address.first_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.billing_address.first_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.billing_address.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payload.properties.billing_address.last_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.billing_address.last_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.billing_address.last_name","typeLabel":"string | null"},"business_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payload.properties.billing_address.business_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.billing_address.business_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.billing_address.business_name","typeLabel":"string | null"},"phone":{"oneOf":[{"description":"10 digit phone number without country code.","type":"string","isRequired":true,"uniqueKey":"payload.properties.billing_address.phone.oneOf.0","typeLabel":"string"},{"description":"10 digit phone number without country code.","type":"null","isRequired":true,"uniqueKey":"payload.properties.billing_address.phone.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.billing_address.phone","typeLabel":"string | null"},"country_code":{"oneOf":[{"description":"Country calling code with a plus sign prefix, e.g. `+91`.","type":"string","isRequired":true,"uniqueKey":"payload.properties.billing_address.country_code.oneOf.0","typeLabel":"string"},{"description":"Country calling code with a plus sign prefix, e.g. `+91`.","type":"null","isRequired":true,"uniqueKey":"payload.properties.billing_address.country_code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.billing_address.country_code","typeLabel":"string | null"},"address_line1":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payload.properties.billing_address.address_line1.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.billing_address.address_line1.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.billing_address.address_line1","typeLabel":"string | null"},"address_line2":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payload.properties.billing_address.address_line2.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.billing_address.address_line2.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.billing_address.address_line2","typeLabel":"string | null"},"landmark":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payload.properties.billing_address.landmark.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.billing_address.landmark.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.billing_address.landmark","typeLabel":"string | null"},"pincode":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payload.properties.billing_address.pincode.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.billing_address.pincode.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.billing_address.pincode","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payload.properties.billing_address.city.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.billing_address.city.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.billing_address.city","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payload.properties.billing_address.state.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.billing_address.state.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.billing_address.state","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payload.properties.billing_address.country.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.billing_address.country.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.billing_address.country","typeLabel":"string | null"},"gstin":{"oneOf":[{"description":"GSTIN of the business the order was placed for, if given.","type":"string","isRequired":true,"uniqueKey":"payload.properties.billing_address.gstin.oneOf.0","typeLabel":"string"},{"description":"GSTIN of the business the order was placed for, if given.","type":"null","isRequired":true,"uniqueKey":"payload.properties.billing_address.gstin.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.billing_address.gstin","typeLabel":"string | null"},"tax_identification_number":{"oneOf":[{"description":"Tax Identification Number specific to the country of operation.","type":"string","isRequired":true,"uniqueKey":"payload.properties.billing_address.tax_identification_number.oneOf.0","typeLabel":"string"},{"description":"Tax Identification Number specific to the country of operation.","type":"null","isRequired":true,"uniqueKey":"payload.properties.billing_address.tax_identification_number.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.billing_address.tax_identification_number","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payload.properties.billing_address.email.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.billing_address.email.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.billing_address.email","typeLabel":"string | null"},"is_email_verified":{"type":"boolean","isRequired":true,"uniqueKey":"payload.properties.billing_address.is_email_verified","typeLabel":"boolean"},"is_phone_verified":{"type":"boolean","isRequired":true,"uniqueKey":"payload.properties.billing_address.is_phone_verified","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"payload.properties.billing_address","typeLabel":"OrderAddress · object"},"shipping_address":{"title":"OrderAddress","description":"A billing or shipping address as recorded on the order: a copy made when the order was placed, so later changes to the customer's saved addresses don't alter it. Its fields are `null` when the order was placed without them (e.g. at a point of sale).","type":"object","externalDocs":{"url":"https://llm-docs.commercengine.io/storefront/schemas/OrderAddress","description":"API reference for the OrderAddress schema"},"required":["id","first_name","last_name","business_name","phone","country_code","address_line1","address_line2","landmark","pincode","city","state","country","gstin","tax_identification_number","email","is_email_verified","is_phone_verified"],"properties":{"id":{"description":"Always `null`: the order's address is a copy, not a saved address.","type":"null","isRequired":true,"uniqueKey":"payload.properties.shipping_address.id","typeLabel":"null"},"first_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payload.properties.shipping_address.first_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.shipping_address.first_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.shipping_address.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payload.properties.shipping_address.last_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.shipping_address.last_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.shipping_address.last_name","typeLabel":"string | null"},"business_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payload.properties.shipping_address.business_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.shipping_address.business_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.shipping_address.business_name","typeLabel":"string | null"},"phone":{"oneOf":[{"description":"10 digit phone number without country code.","type":"string","isRequired":true,"uniqueKey":"payload.properties.shipping_address.phone.oneOf.0","typeLabel":"string"},{"description":"10 digit phone number without country code.","type":"null","isRequired":true,"uniqueKey":"payload.properties.shipping_address.phone.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.shipping_address.phone","typeLabel":"string | null"},"country_code":{"oneOf":[{"description":"Country calling code with a plus sign prefix, e.g. `+91`.","type":"string","isRequired":true,"uniqueKey":"payload.properties.shipping_address.country_code.oneOf.0","typeLabel":"string"},{"description":"Country calling code with a plus sign prefix, e.g. `+91`.","type":"null","isRequired":true,"uniqueKey":"payload.properties.shipping_address.country_code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.shipping_address.country_code","typeLabel":"string | null"},"address_line1":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payload.properties.shipping_address.address_line1.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.shipping_address.address_line1.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.shipping_address.address_line1","typeLabel":"string | null"},"address_line2":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payload.properties.shipping_address.address_line2.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.shipping_address.address_line2.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.shipping_address.address_line2","typeLabel":"string | null"},"landmark":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payload.properties.shipping_address.landmark.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.shipping_address.landmark.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.shipping_address.landmark","typeLabel":"string | null"},"pincode":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payload.properties.shipping_address.pincode.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.shipping_address.pincode.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.shipping_address.pincode","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payload.properties.shipping_address.city.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.shipping_address.city.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.shipping_address.city","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payload.properties.shipping_address.state.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.shipping_address.state.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.shipping_address.state","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payload.properties.shipping_address.country.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.shipping_address.country.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.shipping_address.country","typeLabel":"string | null"},"gstin":{"oneOf":[{"description":"GSTIN of the business the order was placed for, if given.","type":"string","isRequired":true,"uniqueKey":"payload.properties.shipping_address.gstin.oneOf.0","typeLabel":"string"},{"description":"GSTIN of the business the order was placed for, if given.","type":"null","isRequired":true,"uniqueKey":"payload.properties.shipping_address.gstin.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.shipping_address.gstin","typeLabel":"string | null"},"tax_identification_number":{"oneOf":[{"description":"Tax Identification Number specific to the country of operation.","type":"string","isRequired":true,"uniqueKey":"payload.properties.shipping_address.tax_identification_number.oneOf.0","typeLabel":"string"},{"description":"Tax Identification Number specific to the country of operation.","type":"null","isRequired":true,"uniqueKey":"payload.properties.shipping_address.tax_identification_number.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.shipping_address.tax_identification_number","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payload.properties.shipping_address.email.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.shipping_address.email.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.shipping_address.email","typeLabel":"string | null"},"is_email_verified":{"type":"boolean","isRequired":true,"uniqueKey":"payload.properties.shipping_address.is_email_verified","typeLabel":"boolean"},"is_phone_verified":{"type":"boolean","isRequired":true,"uniqueKey":"payload.properties.shipping_address.is_phone_verified","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"payload.properties.shipping_address","typeLabel":"OrderAddress · object"},"currency":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"payload.properties.currency.name","typeLabel":"string"},"code":{"type":"string","uniqueKey":"payload.properties.currency.code","typeLabel":"string"},"symbol":{"type":"string","uniqueKey":"payload.properties.currency.symbol","typeLabel":"string"}},"isRequired":true,"uniqueKey":"payload.properties.currency","typeLabel":"object"},"metadata":{"oneOf":[{"description":"Additional metadata associated with the order: its point-of-sale details and its custom metadata (under `custom_metadata`). `null` when the order has none.","type":"object","properties":{"pos_user_id":{"oneOf":[{"description":"The point-of-sale user who placed the order; `null` when not placed at a point of sale.","type":"string","isRequired":true,"uniqueKey":"payload.properties.metadata.oneOf.0.pos_user_id.oneOf.0","typeLabel":"string"},{"description":"The point-of-sale user who placed the order; `null` when not placed at a point of sale.","type":"null","isRequired":true,"uniqueKey":"payload.properties.metadata.oneOf.0.pos_user_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.metadata.oneOf.0.pos_user_id","typeLabel":"string | null"},"pos_device_id":{"oneOf":[{"description":"The point-of-sale device the order was placed on; `null` when not placed at a point of sale.","type":"string","isRequired":true,"uniqueKey":"payload.properties.metadata.oneOf.0.pos_device_id.oneOf.0","typeLabel":"string"},{"description":"The point-of-sale device the order was placed on; `null` when not placed at a point of sale.","type":"null","isRequired":true,"uniqueKey":"payload.properties.metadata.oneOf.0.pos_device_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.metadata.oneOf.0.pos_device_id","typeLabel":"string | null"},"origin_location_id":{"oneOf":[{"description":"The store location the order was placed at; `null` when not set.","type":"string","isRequired":true,"uniqueKey":"payload.properties.metadata.oneOf.0.origin_location_id.oneOf.0","typeLabel":"string"},{"description":"The store location the order was placed at; `null` when not set.","type":"null","isRequired":true,"uniqueKey":"payload.properties.metadata.oneOf.0.origin_location_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.metadata.oneOf.0.origin_location_id","typeLabel":"string | null"},"custom_metadata":{"oneOf":[{"description":"The custom metadata given for the order.","type":"object","isRequired":true,"uniqueKey":"payload.properties.metadata.oneOf.0.custom_metadata.oneOf.0","typeLabel":"object"},{"description":"The custom metadata given for the order.","type":"null","isRequired":true,"uniqueKey":"payload.properties.metadata.oneOf.0.custom_metadata.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.metadata.oneOf.0.custom_metadata","typeLabel":"object | null"}},"required":["pos_user_id","pos_device_id","origin_location_id","custom_metadata"],"isRequired":true,"uniqueKey":"payload.properties.metadata.oneOf.0","typeLabel":"object"},{"description":"Additional metadata associated with the order: its point-of-sale details and its custom metadata (under `custom_metadata`). `null` when the order has none.","type":"null","properties":{"pos_user_id":{"oneOf":[{"description":"The point-of-sale user who placed the order; `null` when not placed at a point of sale.","type":"string"},{"description":"The point-of-sale user who placed the order; `null` when not placed at a point of sale.","type":"null"}]},"pos_device_id":{"oneOf":[{"description":"The point-of-sale device the order was placed on; `null` when not placed at a point of sale.","type":"string"},{"description":"The point-of-sale device the order was placed on; `null` when not placed at a point of sale.","type":"null"}]},"origin_location_id":{"oneOf":[{"description":"The store location the order was placed at; `null` when not set.","type":"string"},{"description":"The store location the order was placed at; `null` when not set.","type":"null"}]},"custom_metadata":{"oneOf":[{"description":"The custom metadata given for the order.","type":"object"},{"description":"The custom metadata given for the order.","type":"null"}]}},"required":["pos_user_id","pos_device_id","origin_location_id","custom_metadata"],"isRequired":true,"uniqueKey":"payload.properties.metadata.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.metadata","typeLabel":"object | null"},"is_cancellation_allowed":{"description":"Whether the order is eligible for cancellation. Only show the cancel action in your UI when this is `true`.","type":"boolean","isRequired":true,"uniqueKey":"payload.properties.is_cancellation_allowed","typeLabel":"boolean"},"cancellation_refund_details":{"description":"Breakdown of the refund the customer would receive upon cancellation.","type":"object","properties":{"loyalty_point":{"description":"loyalty point redeemed will be rollbacked and credited to user account.","type":"number","uniqueKey":"payload.properties.cancellation_refund_details.loyalty_point","typeLabel":"number"},"refundable_amount":{"description":"amount that will be refunded to customer.","type":"number","uniqueKey":"payload.properties.cancellation_refund_details.refundable_amount","typeLabel":"number"},"cancellation_charges":{"description":"amount deducted from paid amount.","type":"number","uniqueKey":"payload.properties.cancellation_refund_details.cancellation_charges","typeLabel":"number"},"cancellation_charges_reason":{"description":"reason for cancellation charges.","type":"string","uniqueKey":"payload.properties.cancellation_refund_details.cancellation_charges_reason","typeLabel":"string"},"payment_mode":{"description":"payment mode for refund.","type":"string","enum":["original-payment-mode","bank-transfer","nach-mandate"],"uniqueKey":"payload.properties.cancellation_refund_details.payment_mode","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"payload.properties.cancellation_refund_details","typeLabel":"object"},"feedback":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payload.properties.feedback.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.feedback.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.feedback","typeLabel":"string | null"},"cart_id":{"oneOf":[{"description":"ULID of the cart this order was created from. `null` if unavailable.","type":"string","isRequired":true,"uniqueKey":"payload.properties.cart_id.oneOf.0","typeLabel":"string"},{"description":"ULID of the cart this order was created from. `null` if unavailable.","type":"null","isRequired":true,"uniqueKey":"payload.properties.cart_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.cart_id","typeLabel":"string | null"},"coupon_id":{"oneOf":[{"description":"ID of the applied coupon. `null` when no coupon is applied.","type":"string","isRequired":true,"uniqueKey":"payload.properties.coupon_id.oneOf.0","typeLabel":"string"},{"description":"ID of the applied coupon. `null` when no coupon is applied.","type":"null","isRequired":true,"uniqueKey":"payload.properties.coupon_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.coupon_id","typeLabel":"string | null"},"cancellation_reason":{"oneOf":[{"description":"Reason the order was cancelled. `null` when not cancelled.","type":"string","isRequired":true,"uniqueKey":"payload.properties.cancellation_reason.oneOf.0","typeLabel":"string"},{"description":"Reason the order was cancelled. `null` when not cancelled.","type":"null","isRequired":true,"uniqueKey":"payload.properties.cancellation_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.cancellation_reason","typeLabel":"string | null"},"shipping_provider_id":{"oneOf":[{"description":"Order-level shipping provider ID. `null` until resolved.","type":"string","isRequired":true,"uniqueKey":"payload.properties.shipping_provider_id.oneOf.0","typeLabel":"string"},{"description":"Order-level shipping provider ID. `null` until resolved.","type":"null","isRequired":true,"uniqueKey":"payload.properties.shipping_provider_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.shipping_provider_id","typeLabel":"string | null"},"courier_company_id":{"oneOf":[{"description":"Order-level courier company ID. `null` until resolved.","type":"string","isRequired":true,"uniqueKey":"payload.properties.courier_company_id.oneOf.0","typeLabel":"string"},{"description":"Order-level courier company ID. `null` until resolved.","type":"null","isRequired":true,"uniqueKey":"payload.properties.courier_company_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.courier_company_id","typeLabel":"string | null"},"shipping_provider_name":{"oneOf":[{"description":"Order-level shipping provider name. Always `null`: the provider is resolved per shipment.","type":"string","isRequired":true,"uniqueKey":"payload.properties.shipping_provider_name.oneOf.0","typeLabel":"string"},{"description":"Order-level shipping provider name. Always `null`: the provider is resolved per shipment.","type":"null","isRequired":true,"uniqueKey":"payload.properties.shipping_provider_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.shipping_provider_name","typeLabel":"string | null"},"courier_company_name":{"oneOf":[{"description":"Order-level courier company name. Always `null`: the courier is resolved per shipment.","type":"string","isRequired":true,"uniqueKey":"payload.properties.courier_company_name.oneOf.0","typeLabel":"string"},{"description":"Order-level courier company name. Always `null`: the courier is resolved per shipment.","type":"null","isRequired":true,"uniqueKey":"payload.properties.courier_company_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.courier_company_name","typeLabel":"string | null"},"fulfillment_type":{"description":"Fulfillment type for the order (e.g. `delivery`, `collect-in-store`).","type":"string","isRequired":true,"uniqueKey":"payload.properties.fulfillment_type","typeLabel":"string"},"items_tax_amount":{"description":"Total tax amount for the order items.","type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"payload.properties.items_tax_amount","typeLabel":"number\u003cdouble>"},"loyalty_point_eligible_amount":{"description":"Order amount eligible for loyalty-point earning.","type":"number","isRequired":true,"uniqueKey":"payload.properties.loyalty_point_eligible_amount","typeLabel":"number"},"sales_channel":{"description":"The sales channel the order was placed through: its `id` and `type` (e.g. `web`, `app`, `pos`), each `null` when not recorded.","type":"object","properties":{"id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payload.properties.sales_channel.id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.sales_channel.id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.sales_channel.id","typeLabel":"string | null"},"type":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payload.properties.sales_channel.type.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.sales_channel.type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.sales_channel.type","typeLabel":"string | null"}},"required":["id","type"],"isRequired":true,"uniqueKey":"payload.properties.sales_channel","typeLabel":"object"},"payments":{"description":"The order's refunds, then its payments. A seller's copy of a marketplace order has one entry standing for the marketplace order's payment.","type":"array","items":{"oneOf":[{"type":"object","title":"OrderPaymentEvent","description":"A payment of the order, or a refund of one, as an order's events list it in `payments` and a payment's own events (`payment.created`, `payment.success`, `payment.failed` and the like) carry it: the order's payment (`OrderPayment`) and, on a payment, the payment gateway it is made on.","required":["transaction_type","request_number","amount","payment_status","payment_method","payment_reference_number"],"properties":{"transaction_type":{"type":"string","enum":["payment","refund"],"isRequired":true,"uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.0.transaction_type","typeLabel":"enum\u003cstring>"},"request_number":{"type":"string","isRequired":true,"uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.0.request_number","typeLabel":"string"},"amount":{"type":"number","format":"double","isRequired":true,"uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.0.amount","typeLabel":"number\u003cdouble>"},"payment_status":{"type":"string","enum":["pending","success","failed","partially_paid","refund_initiated","refunded","unsettled","settled","partially_settled","manual_review","debit_scheduled","collection_due","initiated"],"isRequired":true,"uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.0.payment_status","typeLabel":"enum\u003cstring>"},"payment_reference_number":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.0.payment_reference_number.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.0.payment_reference_number.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.0.payment_reference_number","typeLabel":"string | null"},"payment_method":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.0.payment_method.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.0.payment_method.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.0.payment_method","typeLabel":"string | null"},"payment_date":{"type":"string","format":"date-time","uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.0.payment_date","typeLabel":"string\u003cdate-time>"},"icon_url":{"oneOf":[{"type":"string","uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.0.icon_url.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.0.icon_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.0.icon_url","typeLabel":"string | null"},"payment_provider_slug":{"oneOf":[{"type":"string","description":"Payment gateway/provider slug for this transaction.","uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.0.payment_provider_slug.oneOf.0","typeLabel":"string"},{"type":"null","description":"Payment gateway/provider slug for this transaction.","uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.0.payment_provider_slug.oneOf.1","typeLabel":"null"}],"uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.0.payment_provider_slug","typeLabel":"string | null"},"payment_mode":{"oneOf":[{"type":"string","uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.0.payment_mode.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.0.payment_mode.oneOf.1","typeLabel":"null"}],"uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.0.payment_mode","typeLabel":"string | null"},"shipment_number":{"oneOf":[{"type":"string","description":"Shipment reference the refund is against. Present only on `refund` transactions; `null` for payments.","uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.0.shipment_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"Shipment reference the refund is against. Present only on `refund` transactions; `null` for payments.","uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.0.shipment_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.0.shipment_number","typeLabel":"string | null"},"created_at":{"type":"string","format":"date-time","uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.0.created_at","typeLabel":"string\u003cdate-time>"},"modified_at":{"type":"string","format":"date-time","uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.0.modified_at","typeLabel":"string\u003cdate-time>"},"card_number":{"oneOf":[{"description":"masked card number\r\ne.g. ************1111","type":"string","uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.0.card_number.oneOf.0","typeLabel":"string"},{"description":"masked card number\r\ne.g. ************1111","type":"null","uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.0.card_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.0.card_number","typeLabel":"string | null"},"card_type":{"oneOf":[{"description":"The card's type, as the store's payment methods name it, e.g. `Visa`, `Rupay`.","type":"string","uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.0.card_type.oneOf.0","typeLabel":"string"},{"description":"The card's type, as the store's payment methods name it, e.g. `Visa`, `Rupay`.","type":"null","uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.0.card_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.0.card_type","typeLabel":"string | null"},"bank_name":{"oneOf":[{"type":"string","uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.0.bank_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.0.bank_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.0.bank_name","typeLabel":"string | null"},"upi_id":{"oneOf":[{"description":"The payer's UPI ID, when the payment provider reports it.","type":"string","uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.0.upi_id.oneOf.0","typeLabel":"string"},{"description":"The payer's UPI ID, when the payment provider reports it.","type":"null","uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.0.upi_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.0.upi_id","typeLabel":"string | null"},"wallet_name":{"oneOf":[{"type":"string","uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.0.wallet_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.0.wallet_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.0.wallet_name","typeLabel":"string | null"},"bank_account_number":{"oneOf":[{"description":"masked account number\r\ne.g. ************1234","type":"string","uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.0.bank_account_number.oneOf.0","typeLabel":"string"},{"description":"masked account number\r\ne.g. ************1234","type":"null","uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.0.bank_account_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.0.bank_account_number","typeLabel":"string | null"},"payment_gateway":{"description":"The payment gateway the payment is made on, as the store's payment settings name it, or `loyalty-point` for loyalty points; empty for a payment an admin recorded manually. On every payment (`transaction_type` `payment`); a refund has none.","type":"string","uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.0.payment_gateway","typeLabel":"string"}},"uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.0","typeLabel":"OrderPaymentEvent · object"},{"type":"object","title":"MarketplaceOrderPayment","description":"The payment of a seller's copy of a marketplace order. The copy has no payments of its own: the marketplace collects the payment, and this one entry stands for it.","required":["transaction_type","amount","payment_status","payment_date","settlement_type"],"properties":{"transaction_type":{"type":"string","enum":["payment"],"isRequired":true,"uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.1.transaction_type","typeLabel":"enum\u003cstring>"},"amount":{"description":"The amount to be paid for the order.","type":"number","format":"double","isRequired":true,"uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.1.amount","typeLabel":"number\u003cdouble>"},"payment_status":{"description":"The order's payment status.","type":"string","enum":["pending","success","failed","partially_paid","refund_initiated","refunded","debit_scheduled","collection_due"],"isRequired":true,"uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.1.payment_status","typeLabel":"enum\u003cstring>"},"payment_date":{"oneOf":[{"description":"When the order was paid; `null` until then.","type":"string","format":"date-time","isRequired":true,"uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.1.payment_date.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"When the order was paid; `null` until then.","type":"null","format":"date-time","isRequired":true,"uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.1.payment_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.1.payment_date","typeLabel":"string\u003cdate-time> | null"},"settlement_type":{"description":"`credit` while the order awaits a debit or collection on the customer's credit line; otherwise `prepaid`.","type":"string","enum":["prepaid","credit"],"isRequired":true,"uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.1.settlement_type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"payload.properties.payments.items.[INDEX].oneOf.1","typeLabel":"MarketplaceOrderPayment · object"}],"uniqueKey":"payload.properties.payments.items.[INDEX]","typeLabel":"OrderPaymentEvent · object | MarketplaceOrderPayment · object"},"isRequired":true,"uniqueKey":"payload.properties.payments","typeLabel":"(OrderPaymentEvent · object | MarketplaceOrderPayment · object)[]"},"customer_email":{"oneOf":[{"description":"The customer's email: the order's contact email, else its billing or shipping address's.","type":"string","isRequired":true,"uniqueKey":"payload.properties.customer_email.oneOf.0","typeLabel":"string"},{"description":"The customer's email: the order's contact email, else its billing or shipping address's.","type":"null","isRequired":true,"uniqueKey":"payload.properties.customer_email.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.customer_email","typeLabel":"string | null"},"customer_phone":{"oneOf":[{"description":"The customer's phone number: the order's contact phone, else its billing or shipping address's.","type":"string","isRequired":true,"uniqueKey":"payload.properties.customer_phone.oneOf.0","typeLabel":"string"},{"description":"The customer's phone number: the order's contact phone, else its billing or shipping address's.","type":"null","isRequired":true,"uniqueKey":"payload.properties.customer_phone.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.customer_phone","typeLabel":"string | null"},"cancelled_by":{"oneOf":[{"description":"Who cancelled the order: `customer`, `system` (cancelled automatically, e.g. when left unpaid) or `admin:` followed by the admin's email. `null` when not cancelled, or cancelled through its shipments.","type":"string","isRequired":true,"uniqueKey":"payload.properties.cancelled_by.oneOf.0","typeLabel":"string"},{"description":"Who cancelled the order: `customer`, `system` (cancelled automatically, e.g. when left unpaid) or `admin:` followed by the admin's email. `null` when not cancelled, or cancelled through its shipments.","type":"null","isRequired":true,"uniqueKey":"payload.properties.cancelled_by.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.cancelled_by","typeLabel":"string | null"},"kyc_details":{"oneOf":[{"description":"The customer's KYC documents and customer group, recorded when the merchant approved the order. `null` until then, or when none were recorded.","type":"object","properties":{"documents":{"type":"array","items":{"type":"object","properties":{"document_type":{"type":"string","enum":["gst","pan","drug_license","drug_license2"],"uniqueKey":"payload.properties.kyc_details.oneOf.0.documents.items.[INDEX].document_type","typeLabel":"enum\u003cstring>"},"document_number":{"oneOf":[{"type":"string","uniqueKey":"payload.properties.kyc_details.oneOf.0.documents.items.[INDEX].document_number.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"payload.properties.kyc_details.oneOf.0.documents.items.[INDEX].document_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"payload.properties.kyc_details.oneOf.0.documents.items.[INDEX].document_number","typeLabel":"string | null"},"status":{"oneOf":[{"type":"string","uniqueKey":"payload.properties.kyc_details.oneOf.0.documents.items.[INDEX].status.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"payload.properties.kyc_details.oneOf.0.documents.items.[INDEX].status.oneOf.1","typeLabel":"null"}],"uniqueKey":"payload.properties.kyc_details.oneOf.0.documents.items.[INDEX].status","typeLabel":"string | null"},"is_verified":{"oneOf":[{"type":"boolean","uniqueKey":"payload.properties.kyc_details.oneOf.0.documents.items.[INDEX].is_verified.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"payload.properties.kyc_details.oneOf.0.documents.items.[INDEX].is_verified.oneOf.1","typeLabel":"null"}],"uniqueKey":"payload.properties.kyc_details.oneOf.0.documents.items.[INDEX].is_verified","typeLabel":"boolean | null"},"is_mandatory":{"oneOf":[{"type":"boolean","uniqueKey":"payload.properties.kyc_details.oneOf.0.documents.items.[INDEX].is_mandatory.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"payload.properties.kyc_details.oneOf.0.documents.items.[INDEX].is_mandatory.oneOf.1","typeLabel":"null"}],"uniqueKey":"payload.properties.kyc_details.oneOf.0.documents.items.[INDEX].is_mandatory","typeLabel":"boolean | null"},"is_attachment_required":{"oneOf":[{"type":"boolean","uniqueKey":"payload.properties.kyc_details.oneOf.0.documents.items.[INDEX].is_attachment_required.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"payload.properties.kyc_details.oneOf.0.documents.items.[INDEX].is_attachment_required.oneOf.1","typeLabel":"null"}],"uniqueKey":"payload.properties.kyc_details.oneOf.0.documents.items.[INDEX].is_attachment_required","typeLabel":"boolean | null"}},"uniqueKey":"payload.properties.kyc_details.oneOf.0.documents.items.[INDEX]","typeLabel":"object"},"uniqueKey":"payload.properties.kyc_details.oneOf.0.documents","typeLabel":"object[]"},"customer_group":{"description":"The customer's group; empty when they have none.","type":"string","uniqueKey":"payload.properties.kyc_details.oneOf.0.customer_group","typeLabel":"string"}},"isRequired":true,"uniqueKey":"payload.properties.kyc_details.oneOf.0","typeLabel":"object"},{"description":"The customer's KYC documents and customer group, recorded when the merchant approved the order. `null` until then, or when none were recorded.","type":"null","properties":{"documents":{"type":"array","items":{"type":"object","properties":{"document_type":{"type":"string","enum":["gst","pan","drug_license","drug_license2"]},"document_number":{"oneOf":[{"type":"string"},{"type":"null"}]},"status":{"oneOf":[{"type":"string"},{"type":"null"}]},"is_verified":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"is_mandatory":{"oneOf":[{"type":"boolean"},{"type":"null"}]},"is_attachment_required":{"oneOf":[{"type":"boolean"},{"type":"null"}]}}}},"customer_group":{"description":"The customer's group; empty when they have none.","type":"string"}},"isRequired":true,"uniqueKey":"payload.properties.kyc_details.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.kyc_details","typeLabel":"object | null"},"erp_ledger":{"oneOf":[{"description":"The customer's ledger in the store's ERP that the order is booked to, recorded when the merchant approved the order. `null` when none is kept for it.","type":"object","properties":{"service_provider_id":{"oneOf":[{"type":"string","uniqueKey":"payload.properties.erp_ledger.oneOf.0.service_provider_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"payload.properties.erp_ledger.oneOf.0.service_provider_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"payload.properties.erp_ledger.oneOf.0.service_provider_id","typeLabel":"string | null"},"service_provider_slug":{"oneOf":[{"type":"string","uniqueKey":"payload.properties.erp_ledger.oneOf.0.service_provider_slug.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"payload.properties.erp_ledger.oneOf.0.service_provider_slug.oneOf.1","typeLabel":"null"}],"uniqueKey":"payload.properties.erp_ledger.oneOf.0.service_provider_slug","typeLabel":"string | null"},"service_provider_name":{"oneOf":[{"type":"string","uniqueKey":"payload.properties.erp_ledger.oneOf.0.service_provider_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"payload.properties.erp_ledger.oneOf.0.service_provider_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"payload.properties.erp_ledger.oneOf.0.service_provider_name","typeLabel":"string | null"},"external_ledger_id":{"oneOf":[{"description":"The ledger's id in the ERP.","type":"string","uniqueKey":"payload.properties.erp_ledger.oneOf.0.external_ledger_id.oneOf.0","typeLabel":"string"},{"description":"The ledger's id in the ERP.","type":"null","uniqueKey":"payload.properties.erp_ledger.oneOf.0.external_ledger_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"payload.properties.erp_ledger.oneOf.0.external_ledger_id","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"payload.properties.erp_ledger.oneOf.0","typeLabel":"object"},{"description":"The customer's ledger in the store's ERP that the order is booked to, recorded when the merchant approved the order. `null` when none is kept for it.","type":"null","properties":{"service_provider_id":{"oneOf":[{"type":"string"},{"type":"null"}]},"service_provider_slug":{"oneOf":[{"type":"string"},{"type":"null"}]},"service_provider_name":{"oneOf":[{"type":"string"},{"type":"null"}]},"external_ledger_id":{"oneOf":[{"description":"The ledger's id in the ERP.","type":"string"},{"description":"The ledger's id in the ERP.","type":"null"}]}},"isRequired":true,"uniqueKey":"payload.properties.erp_ledger.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.properties.erp_ledger","typeLabel":"object | null"}},"isRequired":true,"uniqueKey":"payload.properties","typeLabel":"OrderState · object"},"order_number":{"type":"string","isRequired":true,"uniqueKey":"payload.order_number","typeLabel":"string"},"store_type":{"type":"string","description":"Type of the originating store: `b2c`, `b2b`, `marketplace`, or `seller` (seller-side copies of marketplace records). May be `null` when the producer had no store context.","uniqueKey":"payload.store_type","typeLabel":"string"},"user_id":{"oneOf":[{"description":"Storefront user the event concerns, when applicable: the shopper who caused it, or the one whose order, payment or other record an admin or the system changed (the admin is in `admin_user_id`).","type":"string","uniqueKey":"payload.user_id.oneOf.0","typeLabel":"string"},{"description":"Storefront user the event concerns, when applicable: the shopper who caused it, or the one whose order, payment or other record an admin or the system changed (the admin is in `admin_user_id`).","type":"null","uniqueKey":"payload.user_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"payload.user_id","typeLabel":"string | null"},"customer_id":{"oneOf":[{"description":"Customer the event relates to. Present on customer, KYC, loyalty and invoice events.","type":"string","uniqueKey":"payload.customer_id.oneOf.0","typeLabel":"string"},{"description":"Customer the event relates to. Present on customer, KYC, loyalty and invoice events.","type":"null","uniqueKey":"payload.customer_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"payload.customer_id","typeLabel":"string | null"},"admin_user_id":{"oneOf":[{"description":"Admin user that caused the event, when triggered from the admin API.","type":"string","uniqueKey":"payload.admin_user_id.oneOf.0","typeLabel":"string"},{"description":"Admin user that caused the event, when triggered from the admin API.","type":"null","uniqueKey":"payload.admin_user_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"payload.admin_user_id","typeLabel":"string | null"},"tenant_id":{"oneOf":[{"type":"string","uniqueKey":"payload.tenant_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"payload.tenant_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"payload.tenant_id","typeLabel":"string | null"},"seller_id":{"oneOf":[{"description":"Seller store the event is addressed to. Present on `seller.*` events only.","type":"string","uniqueKey":"payload.seller_id.oneOf.0","typeLabel":"string"},{"description":"Seller store the event is addressed to. Present on `seller.*` events only.","type":"null","uniqueKey":"payload.seller_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"payload.seller_id","typeLabel":"string | null"},"timestamp":{"description":"Time the event was produced by the originating service (ISO 8601, UTC). Absent on a few events; prefer the envelope `timestamp` for ordering.","type":"string","uniqueKey":"payload.timestamp","typeLabel":"string"},"is_test":{"description":"`true` for payloads generated by the admin *Send test webhook* action.","type":"boolean","uniqueKey":"payload.is_test","typeLabel":"boolean"},"changes":{"description":"What this event changed, as `{name: {\"from\": old, \"to\": new}}`: the fields of `properties` that changed and, for some events, details of the action (e.g. `user.account.created`'s `signup_method` and `guest`). `{}` when there is nothing to list.","type":"object","additionalProperties":{"type":"object","properties":{"from":{"description":"The value before the change.","uniqueKey":"payload.changes.additionalProperties.from","typeLabel":"any"},"to":{"description":"The value after the change.","uniqueKey":"payload.changes.additionalProperties.to","typeLabel":"any"}},"uniqueKey":"payload.changes.additionalProperties","typeLabel":"object"},"uniqueKey":"payload.changes","typeLabel":"object"},"context":{"description":"Where the action came from: `channel` (the sales channel's type) and `channel_id`, `ip`, `user_agent`, `locale`, `anonymous_id`, `session_id`, `page`, `campaign`. Delivered only to webhooks that opt in; ad identifiers only with the shopper's marketing consent.","type":"object","uniqueKey":"payload.context","typeLabel":"object"}},"additionalProperties":true,"isRequired":true,"uniqueKey":"payload","typeLabel":"WebhookPayload · object"}},"uniqueKey":"","typeLabel":"WebhookEnvelope · object"},"examples":{"Example":{"title":"Example","value":{"event":"checkout.completed","event_id":"\u003cstring>","delivery_id":"\u003cstring>","timestamp":"2023-11-07T05:31:56Z","is_test":true,"payload":{"event":"checkout.completed","event_id":"\u003cstring>","store_id":"\u003cstring>","properties":{"order_number":"\u003cstring>","order_date":"2023-11-07T05:31:56Z","payment_success_date":"\u003cstring>","customer_note":"\u003cstring>","is_promotion_applied":true,"promotion_discount_amount":123,"promotion_discount_percent":123,"is_coupon_applied":true,"coupon_code":"\u003cstring>","coupon_discount_amount":123,"coupon_discount_percent":123,"applied_promotions":[{"promotion_id":"\u003cstring>","savings":123,"product_id":"\u003cstring>","variant_id":"\u003cstring>","product_name":"\u003cstring>","variant_name":"\u003cstring>","applied_sequence":123,"scope":"\u003cstring>"}],"applied_coupons":[{"coupon_id":"\u003cstring>","savings":123,"product_id":"\u003cstring>","variant_id":"\u003cstring>","product_name":"\u003cstring>","variant_name":"\u003cstring>"}],"promotion_savings":1,"coupon_savings":1,"other_savings":1,"total_savings":1,"on_subscription":true,"subtotal":123,"subtotal_including_tax":123,"shipping_estimated_cost":1,"shipping_discount_amount":1,"shipping_amount":123,"shipping_tax_rate":1,"shipping_tax_amount":1,"shipping_amount_including_tax":1,"estimated_delivery_days":123,"handling_charge_excluding_tax":1,"handling_charge_tax_amount":1,"handling_charge_including_tax":1,"total_tax":123,"grand_total":123,"loyalty_points_earned":1,"loyalty_points_redeemed":1,"credit_balance_used":123,"to_be_paid":123,"order_items_count":123,"order_items":[{"product_id":"\u003cstring>","product_name":"\u003cstring>","product_image_url":"\u003cstring>","sku":"\u003cstring>","product_slug":"\u003cstring>","variant_slug":"\u003cstring>","variant_id":"\u003cstring>","variant_name":"\u003cstring>","backorder":true,"on_promotion":true,"on_subscription":true,"subscription_plan":"\u003cstring>","subscription_interval":123,"subscription_frequency":"\u003cstring>","quantity":1,"free_quantity":1,"is_free_item":true,"price_including_tax":true,"selling_price":1,"listing_price":1,"selling_price_excluding_tax":1,"promotion_discount_amount":1,"coupon_discount_amount":1,"tax_type":"GST","tax_rate":1,"tax_amount":1,"handling_charge_excluding_tax":1,"handling_charge_tax_rate":1,"handling_charge_including_tax":1,"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":[{"name":"\u003cstring>","hexcode":"\u003cstring>"}]}],"seller_id":"\u003cstring>","seller_detail":{"id":"\u003cstring>","trade_name":"\u003cstring>","legal_name":"\u003cstring>","business_type":"\u003cstring>","tax_identification_number":"\u003cstring>"},"promotion_discount_percent":1,"coupon_discount_percent":1,"seller_product_id":"\u003cstring>","seller_variant_id":"\u003cstring>","product_variant_id":"\u003cstring>","hsncode":"\u003cstring>","incremental_quantity":1,"on_offer":true,"slug":"\u003cstring>"}],"billing_address":{"id":null,"first_name":"\u003cstring>","last_name":"\u003cstring>","business_name":"\u003cstring>","phone":"\u003cstring>","country_code":"\u003cstring>","address_line1":"\u003cstring>","address_line2":"\u003cstring>","landmark":"\u003cstring>","pincode":"\u003cstring>","city":"\u003cstring>","state":"\u003cstring>","country":"\u003cstring>","gstin":"\u003cstring>","tax_identification_number":"\u003cstring>","email":"\u003cstring>","is_email_verified":true,"is_phone_verified":true},"shipping_address":{"id":null,"first_name":"\u003cstring>","last_name":"\u003cstring>","business_name":"\u003cstring>","phone":"\u003cstring>","country_code":"\u003cstring>","address_line1":"\u003cstring>","address_line2":"\u003cstring>","landmark":"\u003cstring>","pincode":"\u003cstring>","city":"\u003cstring>","state":"\u003cstring>","country":"\u003cstring>","gstin":"\u003cstring>","tax_identification_number":"\u003cstring>","email":"\u003cstring>","is_email_verified":true,"is_phone_verified":true},"currency":{"name":"\u003cstring>","code":"\u003cstring>","symbol":"\u003cstring>"},"metadata":{"pos_user_id":"\u003cstring>","pos_device_id":"\u003cstring>","origin_location_id":"\u003cstring>","custom_metadata":{}},"is_cancellation_allowed":true,"cancellation_refund_details":{"loyalty_point":123,"refundable_amount":123,"cancellation_charges":123,"cancellation_charges_reason":"\u003cstring>"},"feedback":"\u003cstring>","cart_id":"\u003cstring>","coupon_id":"\u003cstring>","cancellation_reason":"\u003cstring>","shipping_provider_id":"\u003cstring>","courier_company_id":"\u003cstring>","shipping_provider_name":"\u003cstring>","courier_company_name":"\u003cstring>","fulfillment_type":"\u003cstring>","items_tax_amount":1,"loyalty_point_eligible_amount":123,"sales_channel":{"id":"\u003cstring>","type":"\u003cstring>"},"payments":[{"request_number":"\u003cstring>","amount":123,"payment_reference_number":"\u003cstring>","payment_method":"\u003cstring>","payment_date":"2023-11-07T05:31:56Z","icon_url":"\u003cstring>","payment_provider_slug":"\u003cstring>","payment_mode":"\u003cstring>","shipment_number":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","modified_at":"2023-11-07T05:31:56Z","card_number":"\u003cstring>","card_type":"\u003cstring>","bank_name":"\u003cstring>","upi_id":"\u003cstring>","wallet_name":"\u003cstring>","bank_account_number":"\u003cstring>","payment_gateway":"\u003cstring>"}],"customer_email":"\u003cstring>","customer_phone":"\u003cstring>","cancelled_by":"\u003cstring>","kyc_details":{"documents":[{"document_number":"\u003cstring>","status":"\u003cstring>","is_verified":true,"is_mandatory":true,"is_attachment_required":true}],"customer_group":"\u003cstring>"},"erp_ledger":{"service_provider_id":"\u003cstring>","service_provider_slug":"\u003cstring>","service_provider_name":"\u003cstring>","external_ledger_id":"\u003cstring>"}},"order_number":"\u003cstring>","store_type":"\u003cstring>","user_id":"\u003cstring>","customer_id":"\u003cstring>","admin_user_id":"\u003cstring>","tenant_id":"\u003cstring>","seller_id":"\u003cstring>","timestamp":"\u003cstring>","is_test":true,"changes":{},"context":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"27b6f20c-3b9c-4d0a-9543-8dba30b0328d":{"description":"Payload accepted","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"1dc2d87b-7c09-40d8-a6a2-0377b8e12eaf":{"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"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","success":true,"code":"\u003cstring>","errors":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"56d0e926-9884-4093-ac97-a12aa7ae4d16":{"description":"Not authorized for given operation on the Resource","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"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Not authorized for given operation on the Resource.","success":false,"code":"unauthorized"}}},"exampleType":"generated"}},"exampleType":"generated"},"48533afd-0f6f-45a6-aa86-d83b9f107e8d":{"description":"Endpoint permanently removed","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"a8af7b21-27f9-41ca-bd5b-31c49c23ad15":{"description":"Payload accepted","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"dd0d9075-3fc7-48e8-9ade-5c6c3cce713a":{"description":"Temporary server error — we will retry","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{},"servers":{}},"originalFileLocation":"https://openapi.commercengine.io/ce-webhooks.json"},"subdomain":"tarkai","siteName":"Commerce Engine Docs","title":"Checkout completed - Commerce Engine Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-15T08:45:30.994Z","originalFileLocation":"api-reference/webhooks/orders/checkout-completed.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=\"Fires once per order when it is purchased: it leaves pending or payment_failed for confirmed, awaiting_approval or complete, paid in full or accepted on a credit line. Not fired by an admin\u0026#x27;s approval, or for a seller\u0026#x27;s copy of a marketplace order.\">\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=\"Checkout completed - Commerce Engine Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Fires once per order when it is purchased: it leaves pending or payment_failed for confirmed, awaiting_approval or complete, paid in full or accepted on a credit line. Not fired by an admin\u0026#x27;s approval, or for a seller\u0026#x27;s copy of a marketplace order.\">\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/webhooks/orders/checkout-completed\">\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=Orders\u0026amp;title=Checkout+completed\u0026amp;description=Fires+once+per+order+when+it+is+purchased%3A+it+leaves+%60pending%60+or+%60payment_failed%60+for+%60confirmed%60%2C+%60awaiting_approval%60+or+%60complete%60%2C+paid+in+full+or+accepted+\u0026amp;theme=76e8f8f14f90cfb8929bc40a\u0026amp;signature=d3739c7d8921555a42ac005cb26bf71d69b6c86b8b26a86cd14dce71cc622666\">\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=\"Checkout completed - Commerce Engine Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Fires once per order when it is purchased: it leaves pending or payment_failed for confirmed, awaiting_approval or complete, paid in full or accepted on a credit line. Not fired by an admin\u0026#x27;s approval, or for a seller\u0026#x27;s copy of a marketplace order.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://tarkai.mintlify.site/docs/_mintlify/api/og/v2?division=Orders\u0026amp;title=Checkout+completed\u0026amp;description=Fires+once+per+order+when+it+is+purchased%3A+it+leaves+%60pending%60+or+%60payment_failed%60+for+%60confirmed%60%2C+%60awaiting_approval%60+or+%60complete%60%2C+paid+in+full+or+accepted+\u0026amp;theme=76e8f8f14f90cfb8929bc40a\u0026amp;signature=d3739c7d8921555a42ac005cb26bf71d69b6c86b8b26a86cd14dce71cc622666\">\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/webhooks/orders/checkout-completed\">\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/webhooks/orders/checkout-completed.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/webhooks/orders/checkout-completed#webpage\",\"url\":\"https://www.commercengine.io/docs/api-reference/webhooks/orders/checkout-completed\",\"name\":\"Checkout completed\",\"description\":\"Fires once per order when it is purchased: it leaves pending or payment_failed for confirmed, awaiting_approval or complete, paid in full or accepted on a credit line. Not fired by an admin's approval, or for a seller's copy of a marketplace order.\",\"dateModified\":\"2026-11-15T08:45:30.994Z\",\"isPartOf\":{\"@id\":\"https://www.commercengine.io/docs#website\"},\"breadcrumb\":{\"@id\":\"https://www.commercengine.io/docs/api-reference/webhooks/orders/checkout-completed#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://www.commercengine.io/docs/api-reference/webhooks/orders/checkout-completed#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Commerce Engine Docs\",\"item\":\"https://www.commercengine.io/docs\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Checkout completed\",\"item\":\"https://www.commercengine.io/docs/api-reference/webhooks/orders/checkout-completed\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://www.commercengine.io/docs/api-reference/webhooks/orders/checkout-completed#apireference\",\"headline\":\"Checkout completed\",\"name\":\"Checkout completed\",\"description\":\"Fires once per order when it is purchased: it leaves pending or payment_failed for confirmed, awaiting_approval or complete, paid in full or accepted on a credit line. Not fired by an admin's approval, or for a seller's copy of a marketplace order.\",\"url\":\"https://www.commercengine.io/docs/api-reference/webhooks/orders/checkout-completed\",\"mainEntityOfPage\":{\"@id\":\"https://www.commercengine.io/docs/api-reference/webhooks/orders/checkout-completed#webpage\"},\"dateModified\":\"2026-11-15T08:45:30.994Z\",\"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/webhooks/orders/checkout-completed.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.","pages":[{"title":"POS API","href":"/api-reference/pos/devices/pair-pos-device"}]},{"item":"Webhooks","icon":"webhook","description":"Events Commerce Engine delivers to your endpoints — orders, payments, shipments, catalog, customers, store and marketplace.","groups":[{"group":"Orders","pages":[{"group":"Orders","pages":[{"title":"Checkout completed","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook checkout.completed","href":"/api-reference/webhooks/orders/checkout-completed"},{"title":"Order awaiting approval","description":"Fires when a paid order, or one accepted on a credit line, waits for the merchant's approval because the store doesn't approve orders automatically: after a gateway payment, a bank-transfer settlement, a manual payment marked paid, or credit-line acceptance.","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook order.awaiting_approval","href":"/api-reference/webhooks/orders/order-awaiting-approval"},{"title":"Order cancelled","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook order.cancelled","href":"/api-reference/webhooks/orders/order-cancelled"},{"title":"Order completed","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook order.completed","href":"/api-reference/webhooks/orders/order-completed"},{"title":"Order confirmed","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook order.confirmed","href":"/api-reference/webhooks/orders/order-confirmed"},{"title":"Order created","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook order.created","href":"/api-reference/webhooks/orders/order-created"},{"title":"Order payment failed","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook order.payment_failed","href":"/api-reference/webhooks/orders/order-payment-failed"},{"title":"Return approved","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook order.return.approved","href":"/api-reference/webhooks/orders/return-approved"},{"title":"Return cancelled","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook order.return.cancelled","href":"/api-reference/webhooks/orders/return-cancelled"},{"title":"Return rejected","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook order.return.rejected","href":"/api-reference/webhooks/orders/return-rejected"},{"title":"Return requested","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook order.return.requested","href":"/api-reference/webhooks/orders/return-requested"},{"title":"Return updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook order.return.updated","href":"/api-reference/webhooks/orders/return-updated"},{"title":"Order updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook order.updated","href":"/api-reference/webhooks/orders/order-updated"}]},{"group":"Payments","pages":[{"title":"Credit balance refund failed","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook credit_balance.refund.failed","href":"/api-reference/webhooks/payments/credit-balance-refund-failed"},{"title":"Credit balance refund initiated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook credit_balance.refund.initiated","href":"/api-reference/webhooks/payments/credit-balance-refund-initiated"},{"title":"Credit balance refund succeeded","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook credit_balance.refund.success","href":"/api-reference/webhooks/payments/credit-balance-refund-succeeded"},{"title":"Credit balance refund updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook credit_balance.refund.updated","href":"/api-reference/webhooks/payments/credit-balance-refund-updated"},{"title":"Credit balance updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook credit_balance.updated","href":"/api-reference/webhooks/payments/credit-balance-updated"},{"title":"Credit line updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook credit_line.updated","href":"/api-reference/webhooks/payments/credit-line-updated"},{"title":"Payment attributed","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook payment.attributed","href":"/api-reference/webhooks/payments/payment-attributed"},{"title":"Payment cancelled","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook payment.cancelled","href":"/api-reference/webhooks/payments/payment-cancelled"},{"title":"Payment collection due","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook payment.collection_due","href":"/api-reference/webhooks/payments/payment-collection-due"},{"title":"Payment created","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook payment.created","href":"/api-reference/webhooks/payments/payment-created"},{"title":"Payment debit scheduled","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook payment.debit_scheduled","href":"/api-reference/webhooks/payments/payment-debit-scheduled"},{"title":"Payment exception dismissed","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook payment.exception.dismissed","href":"/api-reference/webhooks/payments/payment-exception-dismissed"},{"title":"Payment exception recorded","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook payment.exception.recorded","href":"/api-reference/webhooks/payments/payment-exception-recorded"},{"title":"Payment exception refund initiated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook payment.exception.refund_initiated","href":"/api-reference/webhooks/payments/payment-exception-refund-initiated"},{"title":"Payment exception reopened","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook payment.exception.reopened","href":"/api-reference/webhooks/payments/payment-exception-reopened"},{"title":"Payment exception resolved","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook payment.exception.resolved","href":"/api-reference/webhooks/payments/payment-exception-resolved"},{"title":"Payment failed","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook payment.failed","href":"/api-reference/webhooks/payments/payment-failed"},{"title":"Payment received","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook payment.received","href":"/api-reference/webhooks/payments/payment-received"},{"title":"Refund failed","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook payment.refund.failed","href":"/api-reference/webhooks/payments/refund-failed"},{"title":"Refund forfeited","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook payment.refund.forfeited","href":"/api-reference/webhooks/payments/refund-forfeited"},{"title":"Refund initiated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook payment.refund.initiated","href":"/api-reference/webhooks/payments/refund-initiated"},{"title":"Refund successful","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook payment.refund.success","href":"/api-reference/webhooks/payments/refund-successful"},{"title":"Refund updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook payment.refund.updated","href":"/api-reference/webhooks/payments/refund-updated"},{"title":"Payment retried","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook payment.retried","href":"/api-reference/webhooks/payments/payment-retried"},{"title":"Payment settled","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook payment.settled","href":"/api-reference/webhooks/payments/payment-settled"},{"title":"Payment settlement reversed","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook payment.settlement_reversed","href":"/api-reference/webhooks/payments/payment-settlement-reversed"},{"title":"Payment successful","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook payment.success","href":"/api-reference/webhooks/payments/payment-successful"},{"title":"Payment updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook payment.updated","href":"/api-reference/webhooks/payments/payment-updated"}]},{"group":"Shipping","pages":[{"title":"Shipment cancelled","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook shipment.cancelled","href":"/api-reference/webhooks/shipping/shipment-cancelled"},{"title":"Shipment cancelled and refunded","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook shipment.cancelled-and-refunded","href":"/api-reference/webhooks/shipping/shipment-cancelled-and-refunded"},{"title":"Shipment created","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook shipment.created","href":"/api-reference/webhooks/shipping/shipment-created"},{"title":"Shipment deleted","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook shipment.deleted","href":"/api-reference/webhooks/shipping/shipment-deleted"},{"title":"Shipment delivered","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook shipment.delivered","href":"/api-reference/webhooks/shipping/shipment-delivered"},{"title":"Shipment returned to origin","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook shipment.returned","href":"/api-reference/webhooks/shipping/shipment-returned-to-origin"},{"title":"Shipment schedule requested","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook shipment.schedule_requested","href":"/api-reference/webhooks/shipping/shipment-schedule-requested"},{"title":"Shipment scheduled","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook shipment.scheduled","href":"/api-reference/webhooks/shipping/shipment-scheduled"},{"title":"Shipment shipped","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook shipment.shipped","href":"/api-reference/webhooks/shipping/shipment-shipped"},{"title":"Shipment updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook shipment.updated","href":"/api-reference/webhooks/shipping/shipment-updated"}]},{"group":"Invoices","pages":[{"title":"External invoice re sent to marketplace","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook external_invoice.backsync","href":"/api-reference/webhooks/invoices/external-invoice-re-sent-to-marketplace"},{"title":"External invoice cancelled","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook external_invoice.cancelled","href":"/api-reference/webhooks/invoices/external-invoice-cancelled"},{"title":"External invoice created","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook external_invoice.created","href":"/api-reference/webhooks/invoices/external-invoice-created"},{"title":"External invoice updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook external_invoice.updated","href":"/api-reference/webhooks/invoices/external-invoice-updated"},{"title":"Invoice created","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook invoice.created","href":"/api-reference/webhooks/invoices/invoice-created"},{"title":"Invoice updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook invoice.updated","href":"/api-reference/webhooks/invoices/invoice-updated"}]}]},{"group":"Shopping","pages":[{"group":"Carts","pages":[{"title":"Cart address updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook cart.address.updated","href":"/api-reference/webhooks/carts/cart-address-updated"},{"title":"Cart coupon applied","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook cart.coupon.applied","href":"/api-reference/webhooks/carts/cart-coupon-applied"},{"title":"Cart coupon removed","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook cart.coupon.removed","href":"/api-reference/webhooks/carts/cart-coupon-removed"},{"title":"Cart created","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook cart.created","href":"/api-reference/webhooks/carts/cart-created"},{"title":"Cart credit balance applied","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook cart.creditbalance.applied","href":"/api-reference/webhooks/carts/cart-credit-balance-applied"},{"title":"Cart credit balance removed","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook cart.creditbalance.removed","href":"/api-reference/webhooks/carts/cart-credit-balance-removed"},{"title":"Cart deleted","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook cart.deleted","href":"/api-reference/webhooks/carts/cart-deleted"},{"title":"Cart item added","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook cart.item.created","href":"/api-reference/webhooks/carts/cart-item-added"},{"title":"Cart item removed","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook cart.item.deleted","href":"/api-reference/webhooks/carts/cart-item-removed"},{"title":"Cart item updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook cart.item.updated","href":"/api-reference/webhooks/carts/cart-item-updated"},{"title":"Cart loyalty points applied","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook cart.loyaltypoints.applied","href":"/api-reference/webhooks/carts/cart-loyalty-points-applied"},{"title":"Cart loyalty points removed","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook cart.loyaltypoints.removed","href":"/api-reference/webhooks/carts/cart-loyalty-points-removed"},{"title":"Cart updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook cart.updated","href":"/api-reference/webhooks/carts/cart-updated"},{"title":"Wishlist item added","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook wishlist.item.created","href":"/api-reference/webhooks/carts/wishlist-item-added"},{"title":"Wishlist item removed","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook wishlist.item.removed","href":"/api-reference/webhooks/carts/wishlist-item-removed"}]},{"group":"Coupons \u0026 promotions","pages":[{"title":"Coupon created","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook coupon.created","href":"/api-reference/webhooks/coupons-\u0026-promotions/coupon-created"},{"title":"Coupon deleted","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook coupon.deleted","href":"/api-reference/webhooks/coupons-\u0026-promotions/coupon-deleted"},{"title":"Coupon updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook coupon.updated","href":"/api-reference/webhooks/coupons-\u0026-promotions/coupon-updated"},{"title":"Promotion created","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook promotion.created","href":"/api-reference/webhooks/coupons-\u0026-promotions/promotion-created"},{"title":"Promotion deleted","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook promotion.deleted","href":"/api-reference/webhooks/coupons-\u0026-promotions/promotion-deleted"},{"title":"Promotion updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook promotion.updated","href":"/api-reference/webhooks/coupons-\u0026-promotions/promotion-updated"}]}]},{"group":"Catalog","pages":[{"group":"Catalog","pages":[{"title":"Attribute set created","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook catalog.attribute_set.created","href":"/api-reference/webhooks/catalog/attribute-set-created"},{"title":"Attribute set deleted","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook catalog.attribute_set.deleted","href":"/api-reference/webhooks/catalog/attribute-set-deleted"},{"title":"Attribute set updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook catalog.attribute_set.updated","href":"/api-reference/webhooks/catalog/attribute-set-updated"},{"title":"Category attributes updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook category.attributes.updated","href":"/api-reference/webhooks/catalog/category-attributes-updated"},{"title":"Category created","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook category.created","href":"/api-reference/webhooks/catalog/category-created"},{"title":"Category deleted","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook category.deleted","href":"/api-reference/webhooks/catalog/category-deleted"},{"title":"Category updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook category.updated","href":"/api-reference/webhooks/catalog/category-updated"},{"title":"Inventory updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook inventory.updated","href":"/api-reference/webhooks/catalog/inventory-updated"},{"title":"Attribute created","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook product.attribute.created","href":"/api-reference/webhooks/catalog/attribute-created"},{"title":"Attribute deleted","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook product.attribute.deleted","href":"/api-reference/webhooks/catalog/attribute-deleted"},{"title":"Attribute updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook product.attribute.updated","href":"/api-reference/webhooks/catalog/attribute-updated"},{"title":"Product created","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook product.created","href":"/api-reference/webhooks/catalog/product-created"},{"title":"Product deleted","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook product.deleted","href":"/api-reference/webhooks/catalog/product-deleted"},{"title":"Product review approved","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook product.review.approved","href":"/api-reference/webhooks/catalog/product-review-approved"},{"title":"Product review archived","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook product.review.archived","href":"/api-reference/webhooks/catalog/product-review-archived"},{"title":"Product review created","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook product.review.created","href":"/api-reference/webhooks/catalog/product-review-created"},{"title":"Product review deleted","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook product.review.deleted","href":"/api-reference/webhooks/catalog/product-review-deleted"},{"title":"Product review rejected","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook product.review.rejected","href":"/api-reference/webhooks/catalog/product-review-rejected"},{"title":"Product review updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook product.review.updated","href":"/api-reference/webhooks/catalog/product-review-updated"},{"title":"Product updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook product.updated","href":"/api-reference/webhooks/catalog/product-updated"},{"title":"Variant created","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook product.variant.created","href":"/api-reference/webhooks/catalog/variant-created"},{"title":"Variant deleted","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook product.variant.deleted","href":"/api-reference/webhooks/catalog/variant-deleted"},{"title":"Variant updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook product.variant.updated","href":"/api-reference/webhooks/catalog/variant-updated"}]}]},{"group":"Customers","pages":[{"group":"Customers","pages":[{"title":"Ad audience created","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook ad_audience.created","href":"/api-reference/webhooks/customers/ad-audience-created"},{"title":"Ad audience deleted","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook ad_audience.deleted","href":"/api-reference/webhooks/customers/ad-audience-deleted"},{"title":"Ad audience updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook ad_audience.updated","href":"/api-reference/webhooks/customers/ad-audience-updated"},{"title":"Customer address created","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook customer.address.created","href":"/api-reference/webhooks/customers/customer-address-created"},{"title":"Customer address deleted","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook customer.address.deleted","href":"/api-reference/webhooks/customers/customer-address-deleted"},{"title":"Customer address updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook customer.address.updated","href":"/api-reference/webhooks/customers/customer-address-updated"},{"title":"Bank account added","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook customer.bank_account.created","href":"/api-reference/webhooks/customers/bank-account-added"},{"title":"Bank account deleted","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook customer.bank_account.deleted","href":"/api-reference/webhooks/customers/bank-account-deleted"},{"title":"Bank account updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook customer.bank_account.updated","href":"/api-reference/webhooks/customers/bank-account-updated"},{"title":"Customer created","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook customer.created","href":"/api-reference/webhooks/customers/customer-created"},{"title":"Customer deleted","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook customer.deleted","href":"/api-reference/webhooks/customers/customer-deleted"},{"title":"Mandate activated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook customer.mandate.activated","href":"/api-reference/webhooks/customers/mandate-activated"},{"title":"Mandate created","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook customer.mandate.created","href":"/api-reference/webhooks/customers/mandate-created"},{"title":"Mandate debit cancellation requested","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook customer.mandate.debit.cancel_requested","href":"/api-reference/webhooks/customers/mandate-debit-cancellation-requested"},{"title":"Mandate debit cancelled","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook customer.mandate.debit.cancelled","href":"/api-reference/webhooks/customers/mandate-debit-cancelled"},{"title":"Mandate debit failed","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook customer.mandate.debit.failed","href":"/api-reference/webhooks/customers/mandate-debit-failed"},{"title":"Mandate debit recovered","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook customer.mandate.debit.recovered","href":"/api-reference/webhooks/customers/mandate-debit-recovered"},{"title":"Mandate debit requested","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook customer.mandate.debit.requested","href":"/api-reference/webhooks/customers/mandate-debit-requested"},{"title":"Mandate debit retry scheduled","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook customer.mandate.debit.retry_scheduled","href":"/api-reference/webhooks/customers/mandate-debit-retry-scheduled"},{"title":"Mandate debit scheduled","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook customer.mandate.debit.scheduled","href":"/api-reference/webhooks/customers/mandate-debit-scheduled"},{"title":"Mandate debit succeeded","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook customer.mandate.debit.succeeded","href":"/api-reference/webhooks/customers/mandate-debit-succeeded"},{"title":"Mandate debit updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook customer.mandate.debit.updated","href":"/api-reference/webhooks/customers/mandate-debit-updated"},{"title":"Mandate expired","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook customer.mandate.expired","href":"/api-reference/webhooks/customers/mandate-expired"},{"title":"Mandate failed","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook customer.mandate.failed","href":"/api-reference/webhooks/customers/mandate-failed"},{"title":"Mandate pause requested","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook customer.mandate.pause_requested","href":"/api-reference/webhooks/customers/mandate-pause-requested"},{"title":"Mandate paused","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook customer.mandate.paused","href":"/api-reference/webhooks/customers/mandate-paused"},{"title":"Mandate resumed","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook customer.mandate.resumed","href":"/api-reference/webhooks/customers/mandate-resumed"},{"title":"Mandate revoke requested","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook customer.mandate.revoke_requested","href":"/api-reference/webhooks/customers/mandate-revoke-requested"},{"title":"Mandate revoked","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook customer.mandate.revoked","href":"/api-reference/webhooks/customers/mandate-revoked"},{"title":"Mandate updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook customer.mandate.updated","href":"/api-reference/webhooks/customers/mandate-updated"},{"title":"Customer updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook customer.updated","href":"/api-reference/webhooks/customers/customer-updated"},{"title":"Kyc document approved","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook kyc.document.approved","href":"/api-reference/webhooks/customers/kyc-document-approved"},{"title":"Kyc document submitted","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook kyc.document.created","href":"/api-reference/webhooks/customers/kyc-document-submitted"},{"title":"Kyc document deleted","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook kyc.document.deleted","href":"/api-reference/webhooks/customers/kyc-document-deleted"},{"title":"Kyc document rejected","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook kyc.document.rejected","href":"/api-reference/webhooks/customers/kyc-document-rejected"},{"title":"Kyc document updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook kyc.document.updated","href":"/api-reference/webhooks/customers/kyc-document-updated"},{"title":"Customer kyc submitted","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook kyc.submitted","href":"/api-reference/webhooks/customers/customer-kyc-submitted"},{"title":"Customer kyc unverified","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook kyc.unverified","href":"/api-reference/webhooks/customers/customer-kyc-unverified"},{"title":"Customer kyc verified","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook kyc.verified","href":"/api-reference/webhooks/customers/customer-kyc-verified"},{"title":"Loyalty member enrolled","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook loyalty.member.enrolled","href":"/api-reference/webhooks/customers/loyalty-member-enrolled"},{"title":"Loyalty points earned","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook loyalty.points.earned","href":"/api-reference/webhooks/customers/loyalty-points-earned"},{"title":"Loyalty points redeemed","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook loyalty.points.redeemed","href":"/api-reference/webhooks/customers/loyalty-points-redeemed"},{"title":"Loyalty points reset","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook loyalty.points.reset","href":"/api-reference/webhooks/customers/loyalty-points-reset"},{"title":"Loyalty points reversed","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook loyalty.points.reversed","href":"/api-reference/webhooks/customers/loyalty-points-reversed"},{"title":"Loyalty program activated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook loyalty.program.activated","href":"/api-reference/webhooks/customers/loyalty-program-activated"},{"title":"Loyalty program created","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook loyalty.program.created","href":"/api-reference/webhooks/customers/loyalty-program-created"},{"title":"Loyalty program deactivated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook loyalty.program.deactivated","href":"/api-reference/webhooks/customers/loyalty-program-deactivated"},{"title":"Loyalty program deleted","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook loyalty.program.deleted","href":"/api-reference/webhooks/customers/loyalty-program-deleted"},{"title":"Loyalty program updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook loyalty.program.updated","href":"/api-reference/webhooks/customers/loyalty-program-updated"},{"title":"Newsletter subscribed","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook newsletter.subscribed","href":"/api-reference/webhooks/customers/newsletter-subscribed"},{"title":"Segment created","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook segment.created","href":"/api-reference/webhooks/customers/segment-created"},{"title":"Segment deleted","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook segment.deleted","href":"/api-reference/webhooks/customers/segment-deleted"},{"title":"Segment updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook segment.updated","href":"/api-reference/webhooks/customers/segment-updated"},{"title":"Loyalty tier downgraded","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook tier.downgraded","href":"/api-reference/webhooks/customers/loyalty-tier-downgraded"},{"title":"Loyalty tier upgraded","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook tier.upgraded","href":"/api-reference/webhooks/customers/loyalty-tier-upgraded"},{"title":"User account created","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook user.account.created","href":"/api-reference/webhooks/customers/user-account-created"},{"title":"User account deleted","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook user.account.deleted","href":"/api-reference/webhooks/customers/user-account-deleted"},{"title":"User account updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook user.account.updated","href":"/api-reference/webhooks/customers/user-account-updated"}]}]},{"group":"Store","pages":[{"group":"Store","pages":[{"title":"Channel created","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook channel.created","href":"/api-reference/webhooks/store/channel-created"},{"title":"Channel deleted","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook channel.deleted","href":"/api-reference/webhooks/store/channel-deleted"},{"title":"Channel updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook channel.updated","href":"/api-reference/webhooks/store/channel-updated"},{"title":"Shipping zone created","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook shipping_zone.created","href":"/api-reference/webhooks/store/shipping-zone-created"},{"title":"Shipping zone deleted","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook shipping_zone.deleted","href":"/api-reference/webhooks/store/shipping-zone-deleted"},{"title":"Shipping zone updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook shipping_zone.updated","href":"/api-reference/webhooks/store/shipping-zone-updated"},{"title":"Store config updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook store.config.updated","href":"/api-reference/webhooks/store/store-config-updated"},{"title":"Store created","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook store.created","href":"/api-reference/webhooks/store/store-created"},{"title":"Customer group created","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook store.customer_group.created","href":"/api-reference/webhooks/store/customer-group-created"},{"title":"Customer group deleted","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook store.customer_group.deleted","href":"/api-reference/webhooks/store/customer-group-deleted"},{"title":"Customer group updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook store.customer_group.updated","href":"/api-reference/webhooks/store/customer-group-updated"},{"title":"Store deleted","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook store.deleted","href":"/api-reference/webhooks/store/store-deleted"},{"title":"Kyc document config created","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook store.kyc_document.created","href":"/api-reference/webhooks/store/kyc-document-config-created"},{"title":"Kyc document config deleted","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook store.kyc_document.deleted","href":"/api-reference/webhooks/store/kyc-document-config-deleted"},{"title":"Kyc document config updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook store.kyc_document.updated","href":"/api-reference/webhooks/store/kyc-document-config-updated"},{"title":"Manual shipping method created","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook store.shipping_method.created","href":"/api-reference/webhooks/store/manual-shipping-method-created"},{"title":"Manual shipping method deleted","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook store.shipping_method.deleted","href":"/api-reference/webhooks/store/manual-shipping-method-deleted"},{"title":"Manual shipping method updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook store.shipping_method.updated","href":"/api-reference/webhooks/store/manual-shipping-method-updated"},{"title":"Store template created","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook store.template.created","href":"/api-reference/webhooks/store/store-template-created"},{"title":"Store template deleted","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook store.template.deleted","href":"/api-reference/webhooks/store/store-template-deleted"},{"title":"Store template updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook store.template.updated","href":"/api-reference/webhooks/store/store-template-updated"},{"title":"Store config updated 1","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook store.updated","href":"/api-reference/webhooks/store/store-config-updated-1"},{"title":"Warehouse created","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook warehouse.created","href":"/api-reference/webhooks/store/warehouse-created"},{"title":"Warehouse deleted","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook warehouse.deleted","href":"/api-reference/webhooks/store/warehouse-deleted"},{"title":"Warehouse updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook warehouse.updated","href":"/api-reference/webhooks/store/warehouse-updated"}]},{"group":"Marketplace","pages":[{"title":"Marketplace item created","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook marketplace_item.created","href":"/api-reference/webhooks/marketplace/marketplace-item-created"},{"title":"Marketplace item deleted","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook marketplace_item.deleted","href":"/api-reference/webhooks/marketplace/marketplace-item-deleted"},{"title":"Marketplace item updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook marketplace_item.updated","href":"/api-reference/webhooks/marketplace/marketplace-item-updated"},{"title":"Product marketplace listing created","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook product.marketplace-listing.created","href":"/api-reference/webhooks/marketplace/product-marketplace-listing-created"},{"title":"Product marketplace listing deleted","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook product.marketplace-listing.deleted","href":"/api-reference/webhooks/marketplace/product-marketplace-listing-deleted"},{"title":"Product listed on marketplace","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook product.marketplace-listing.listed","href":"/api-reference/webhooks/marketplace/product-listed-on-marketplace"},{"title":"Product unlisted from marketplace","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook product.marketplace-listing.unlisted","href":"/api-reference/webhooks/marketplace/product-unlisted-from-marketplace"},{"title":"Product marketplace listing updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook product.marketplace-listing.updated","href":"/api-reference/webhooks/marketplace/product-marketplace-listing-updated"},{"title":"Marketplace sync completed","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook product.marketplace-sync.completed","href":"/api-reference/webhooks/marketplace/marketplace-sync-completed"},{"title":"Marketplace sync failed","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook product.marketplace-sync.failed","href":"/api-reference/webhooks/marketplace/marketplace-sync-failed"},{"title":"Marketplace sync partially completed","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook product.marketplace-sync.partially-completed","href":"/api-reference/webhooks/marketplace/marketplace-sync-partially-completed"},{"title":"Marketplace sync requested","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook product.marketplace-sync.requested","href":"/api-reference/webhooks/marketplace/marketplace-sync-requested"},{"title":"Product sync failed","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook product.sync.failed","href":"/api-reference/webhooks/marketplace/product-sync-failed"},{"title":"Product sync succeeded","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook product.sync.success","href":"/api-reference/webhooks/marketplace/product-sync-succeeded"},{"title":"Variant marketplace listing created","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook product.variant.marketplace-listing.created","href":"/api-reference/webhooks/marketplace/variant-marketplace-listing-created"},{"title":"Variant marketplace listing deleted","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook product.variant.marketplace-listing.deleted","href":"/api-reference/webhooks/marketplace/variant-marketplace-listing-deleted"},{"title":"Variant listed on marketplace","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook product.variant.marketplace-listing.listed","href":"/api-reference/webhooks/marketplace/variant-listed-on-marketplace"},{"title":"Variant unlisted from marketplace","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook product.variant.marketplace-listing.unlisted","href":"/api-reference/webhooks/marketplace/variant-unlisted-from-marketplace"},{"title":"Variant marketplace listing updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook product.variant.marketplace-listing.updated","href":"/api-reference/webhooks/marketplace/variant-marketplace-listing-updated"},{"title":"Seller account approved","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook seller.account.approved","href":"/api-reference/webhooks/marketplace/seller-account-approved"},{"title":"Seller account created","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook seller.account.created","href":"/api-reference/webhooks/marketplace/seller-account-created"},{"title":"Seller account deleted","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook seller.account.deleted","href":"/api-reference/webhooks/marketplace/seller-account-deleted"},{"title":"Seller account rejected","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook seller.account.rejected","href":"/api-reference/webhooks/marketplace/seller-account-rejected"},{"title":"Seller account updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook seller.account.updated","href":"/api-reference/webhooks/marketplace/seller-account-updated"},{"title":"Seller bank account added","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook seller.bank_account.created","href":"/api-reference/webhooks/marketplace/seller-bank-account-added"},{"title":"Seller bank account deleted","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook seller.bank_account.deleted","href":"/api-reference/webhooks/marketplace/seller-bank-account-deleted"},{"title":"Seller bank account updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook seller.bank_account.updated","href":"/api-reference/webhooks/marketplace/seller-bank-account-updated"},{"title":"Seller kyc approved","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook seller.kyc.approved","href":"/api-reference/webhooks/marketplace/seller-kyc-approved"},{"title":"Seller kyc pending","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook seller.kyc.pending","href":"/api-reference/webhooks/marketplace/seller-kyc-pending"},{"title":"Seller kyc rejected","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook seller.kyc.rejected","href":"/api-reference/webhooks/marketplace/seller-kyc-rejected"},{"title":"Seller kyc submitted","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook seller.kyc.submitted","href":"/api-reference/webhooks/marketplace/seller-kyc-submitted"},{"title":"Seller kyc documents updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook seller.kyc.updated","href":"/api-reference/webhooks/marketplace/seller-kyc-documents-updated"},{"title":"Seller order cancelled","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook seller.order.cancelled","href":"/api-reference/webhooks/marketplace/seller-order-cancelled"},{"title":"Seller order completed","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook seller.order.completed","href":"/api-reference/webhooks/marketplace/seller-order-completed"},{"title":"Seller order confirmed","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook seller.order.confirmed","href":"/api-reference/webhooks/marketplace/seller-order-confirmed"},{"title":"Seller order created","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook seller.order.created","href":"/api-reference/webhooks/marketplace/seller-order-created"},{"title":"Seller order updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook seller.order.updated","href":"/api-reference/webhooks/marketplace/seller-order-updated"},{"title":"Seller payout batch cancelled","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook seller.payout.batch.cancelled","href":"/api-reference/webhooks/marketplace/seller-payout-batch-cancelled"},{"title":"Seller payout batch completed","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook seller.payout.batch.completed","href":"/api-reference/webhooks/marketplace/seller-payout-batch-completed"},{"title":"Seller payout batch on hold","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook seller.payout.batch.on_hold","href":"/api-reference/webhooks/marketplace/seller-payout-batch-on-hold"},{"title":"Seller payout batch payment failed","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook seller.payout.batch.payment_failed","href":"/api-reference/webhooks/marketplace/seller-payout-batch-payment-failed"},{"title":"Seller payout batch processing","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook seller.payout.batch.processing","href":"/api-reference/webhooks/marketplace/seller-payout-batch-processing"},{"title":"Seller payout batch scheduled","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook seller.payout.batch.scheduled","href":"/api-reference/webhooks/marketplace/seller-payout-batch-scheduled"},{"title":"Seller payout batch updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook seller.payout.batch.updated","href":"/api-reference/webhooks/marketplace/seller-payout-batch-updated"},{"title":"Seller payout config created","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook seller.payout.config.created","href":"/api-reference/webhooks/marketplace/seller-payout-config-created"},{"title":"Seller payout config updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook seller.payout.config.updated","href":"/api-reference/webhooks/marketplace/seller-payout-config-updated"},{"title":"Seller payout invoice batched","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook seller.payout.invoice.batched","href":"/api-reference/webhooks/marketplace/seller-payout-invoice-batched"},{"title":"Seller payout invoice cancelled","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook seller.payout.invoice.cancelled","href":"/api-reference/webhooks/marketplace/seller-payout-invoice-cancelled"},{"title":"Seller payout invoice on hold","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook seller.payout.invoice.on_hold","href":"/api-reference/webhooks/marketplace/seller-payout-invoice-on-hold"},{"title":"Seller payout invoice paid","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook seller.payout.invoice.paid","href":"/api-reference/webhooks/marketplace/seller-payout-invoice-paid"},{"title":"Seller payout invoice pending","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook seller.payout.invoice.pending","href":"/api-reference/webhooks/marketplace/seller-payout-invoice-pending"},{"title":"Seller payout invoice updated","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook seller.payout.invoice.updated","href":"/api-reference/webhooks/marketplace/seller-payout-invoice-updated"},{"title":"Seller shipment cancelled","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook seller.shipment.cancelled","href":"/api-reference/webhooks/marketplace/seller-shipment-cancelled"},{"title":"Seller shipment cancelled and refunded","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook seller.shipment.cancelled-and-refunded","href":"/api-reference/webhooks/marketplace/seller-shipment-cancelled-and-refunded"},{"title":"Seller shipment created","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook seller.shipment.created","href":"/api-reference/webhooks/marketplace/seller-shipment-created"},{"title":"Warehouse sync failed","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook warehouse.sync.failed","href":"/api-reference/webhooks/marketplace/warehouse-sync-failed"},{"title":"Warehouse sync succeeded","version":null,"deprecated":null,"openapi":"https://openapi.commercengine.io/ce-webhooks.json webhook warehouse.sync.success","href":"/api-reference/webhooks/marketplace/warehouse-sync-succeeded"}]}]}]},{"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":"Checkout completed - Commerce Engine Docs","buildId":"dpl_5Wnaxc3m8t3HZwdvwe36fSBdcT12","deploymentId":"dpl_5Wnaxc3m8t3HZwdvwe36fSBdcT12","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-sRLpiqpE.js","utils-S4bU2zRv.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BC7mpg-s.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DTEUL5hG.js","snippetPresets-DXO56z8S.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-SC_m0zVE.js","ApiExamples-CuiF8xsJ.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ToTaBa32.js","shallow-Bw_UfCTY.js","getApiPlaygroundDisplay-BFcVyT7w.js","CodeSnippet-DWwGgYk5.js","CodeSnippets-hAOKmdpX.js","getPastedJson-Q2Yr4e7m.js","icon-CJxLAsPX.js","MethodPill-DBZG10H9.js","DuplicateIcon-BJD7Hrp4.js","createIcon-ja-oQVJo.js","DynamicMarkdown-CKZBuKr4.js","SectionHeading-L-1JTZQZ.js","axios-vUo_bRtp.js","Markdown-Z1l8BMeJ.js","dist-B4nDkaYj.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-ilslkC03.js"]}