Creates an order from a POS cart. Returns an Order with payment_required and payment_info. Include payment_method to create an initial payment request. When the customer’s loyalty points, credit balance or a discount pay the whole order, no payment is requested, whatever the method. Paid by points or a discount alone, the order comes back already confirmed (awaiting_approval when the store doesn’t approve orders automatically; complete when it is collected in store with nothing to ship) with payment_statussuccess. Paid by its credit balance, with or without points, it stays pending until that balance is settled against it. If the customer can’t be identified at that moment, the order comes back pending, and its purchase completes once the customer is identified. When the credit balance pays only part of the order, its payments include a bank transfer for that credit, and the order stays pending until the credit is settled against it and the rest is paid. If the store’s type can’t be determined for the cashier’s session, the request fails with a 503 and the store-type-unavailable error code, and nothing is placed: retry, or sign in on the device again. Credit balance applied to the cart must be within what the customer can spend now, which leaves out credit their other unpaid orders have claimed. When credit balance can’t be used for a moment, an order using it fails with a 409 and the credit-balance-unavailable error code, and nothing is placed: retry shortly. The payment method must be one the store offers on the POS’s sales channel; any other is refused with a 400.
{
"message": "Paying with credit balance waits for the payment ledger update to finish; try again shortly",
"success": false,
"code": "credit-balance-unavailable",
"details": "<string>"
}
Analytics events to emit for the change this request made, each with a server-issued event_id. Replay them to your analytics destinations so your client-side and server-side copies of the same action dedupe. Empty when the request produced no analytics event.
{
"message": "Paying with credit balance waits for the payment ledger update to finish; try again shortly",
"success": false,
"code": "credit-balance-unavailable",
"details": "<string>"
}
{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"Commerce Engine Docs","description":"Official documentation for Commerce Engine - The modern headless commerce platform for building scalable e-commerce solutions.","colors":{"primary":"#00BF6F","light":"#00BF6F","dark":"#029558"},"logo":{"light":"https://mintcdn.com/tarkai/hIY7_H2biaAvOGu7/logo/CE_Developers_black.svg?fit=max\u0026auto=format\u0026n=hIY7_H2biaAvOGu7\u0026q=85\u0026s=d93f21564dfd373c7f2efc88c9d4301e","dark":"https://mintcdn.com/tarkai/hIY7_H2biaAvOGu7/logo/CE_Developers_white.svg?fit=max\u0026auto=format\u0026n=hIY7_H2biaAvOGu7\u0026q=85\u0026s=def973fb06c07f5eae14319cc3303339","href":"/"},"favicon":"https://mintcdn.com/tarkai/QX_fwpRYnT2rH-8q/favicon.png?fit=max\u0026auto=format\u0026n=QX_fwpRYnT2rH-8q\u0026q=85\u0026s=ebc190f98abe52e0e4220c74cea20fa6","api":{"openapi":{"source":"https://openapi.commercengine.io/ce-storefront.json","directory":"api-reference"},"playground":{"display":"interactive","proxy":false}},"appearance":{"default":"system"},"background":{"decoration":"windows","color":{"light":"#ffffff","dark":"#0d1816"}},"navbar":{"primary":{"type":"button","label":"Return to main site","href":"https://www.commercengine.io"}},"footer":{"socials":{"github":"https://github.com/tark-ai","twitter":"https://x.com/CommerceEngine","linkedin":"https://www.linkedin.com/company/commercengine"}},"search":{"prompt":"Search docs..."},"seo":{"metatags":{"canonical":"https://www.commercengine.io/docs","og:site_name":"Commerce Engine Developer Portal","og:locale":"en_US","og:logo":"/logo/CE_logo_whitebg.svg","twitter:site":"@CommerceEngine","og:image:width":"1200","og:image:height":"630","robots":"index, follow"},"indexing":"navigable"},"fonts":{"heading":{"family":"Satoshi","weight":700,"source":"https://images.tarkai.com/Commerce_Engine/Fonts/Satoshi-Variable.woff2","format":"woff2"},"body":{"family":"Satoshi","weight":450,"source":"https://images.tarkai.com/Commerce_Engine/Fonts/Satoshi-Variable.woff2","format":"woff2"}},"styling":{"eyebrows":"section","codeblocks":{"theme":{"light":"github-light","dark":"github-dark"}},"latex":false},"integrations":{"ga4":{"measurementId":"G-6SVW3L2E90"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"tarkai","hasAudioNarration":false,"actualSubdomain":"tarkai","customDomains":["www.commercengine.io"],"gitSource":{"type":"github","owner":"tark-ai","repo":"ce-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6afda2d272aa9c06fc1d01a8","clientVersion":"0.0.4271","searchFilterCounts":[{"language":"default","tag":"API Reference","count":851},{"language":"default","tag":"Admin API","count":385},{"language":"default","tag":"Customers","count":252},{"language":"default","tag":"Webhooks","count":248},{"language":"default","tag":"Orders","count":168},{"language":"default","tag":"Catalog","count":149},{"language":"default","tag":"Store","count":146},{"language":"default","tag":"Storefront API","count":143},{"language":"default","tag":"Marketplace","count":90},{"language":"default","tag":"Payments","count":89}]},"assistantConfig":{},"basePath":"/docs","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"/* cyrillic-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2JL7SUc.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa0ZL7SUc.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* greek-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2ZL7SUc.woff2) format('woff2');\n unicode-range: U+1F00-1FFF;\n}\n/* greek */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1pL7SUc.woff2) format('woff2');\n unicode-range: U+0370-0377, U+037A-037F, U+0384-038A, U+038C, U+038E-03A1, U+03A3-03FF;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2pL7SUc.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa25L7SUc.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1ZL7.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* cyrillic-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2JL7SUc.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa0ZL7SUc.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* greek-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2ZL7SUc.woff2) format('woff2');\n unicode-range: U+1F00-1FFF;\n}\n/* greek */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1pL7SUc.woff2) format('woff2');\n unicode-range: U+0370-0377, U+037A-037F, U+0384-038A, U+038C, U+038E-03A1, U+03A3-03FF;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2pL7SUc.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa25L7SUc.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1ZL7.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* cyrillic-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2JL7SUc.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa0ZL7SUc.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* greek-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2ZL7SUc.woff2) format('woff2');\n unicode-range: U+1F00-1FFF;\n}\n/* greek */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1pL7SUc.woff2) format('woff2');\n unicode-range: U+0370-0377, U+037A-037F, U+0384-038A, U+038C, U+038E-03A1, U+03A3-03FF;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2pL7SUc.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa25L7SUc.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1ZL7.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n.font-medium{font-weight:525}#content-area.max-w-3xl{max-width:60rem!important}:root{--ce-white: #fff;--ce-black: #0e0e0f;--ce-green: #00bf6f;--ce-chart-green: #009354;--ce-goldenrod: #f6ffdb;--ce-bg-light-green: #e6faf2;--ce-shades-100: #f6f6f6;--ce-shades-300: #ececec;--ce-shades-800: #262626;--ce-shades-950: #e0dede;--ce-grid-line: #8f8f8f14;--ce-grid-fill: #3e3e3e06;--ce-skill-panel: #16191c;--ce-skill-inset: #101315;--ce-skill-border: #ffffff1a;--ce-skill-fg: #f3f5f6;--ce-skill-dim: #98a0a8;--ce-skill-mark: #2fd18c;--ce-code-block-bg: #1a1a1a;--ce-terminal-bg: #061636;--ce-terminal-body: #0c1f45;--ce-chrome-red: #ff5f56;--ce-chrome-amber: #ffbd2e;--ce-chrome-green: #27c93f;--ce-font-primary: \"Satoshi\", \"Satoshi Static\", system-ui, sans-serif;--ce-font-secondary: \"Inter\", system-ui, sans-serif;--ce-font-mono: ui-monospace, SFMono-Regular, Menlo, Consolas, monospace;--ce-text-2xs: 0.75rem;--ce-text-xs: 0.875rem;--ce-text-sm: 1rem;--ce-text-base: 1.125rem;--ce-text-xl: 1.375rem;--ce-text-4xl: 1.75rem;--ce-text-5xl: 2rem;--ce-text-7xl: 3.25rem;--ce-leading-sm: 1.15;--ce-leading-md: 1.3;--ce-leading-lg: 1.5;--ce-tracking-heading: -0.02em;--ce-tracking-eyebrow: 0.18em;--ce-tracking-label: 0.14em;--ce-container-lg: 67.5rem;--ce-container-xl: 75rem;--ce-container-2xl: 79.375rem;--ce-container-3xl: 90rem;--ce-header-shadow: #2416230a;--ce-radius-sm: 0.25rem;--ce-radius-md: 0.5rem;--ce-radius-lg: 0.75rem;--ce-radius-xl: 1rem;--ce-radius-2xl: 1.5rem;--ce-radius-full: 9999px;--ce-shadow-button: 0 2px 4px rgba(0, 0, 0, 0.1);--ce-shadow-tile-hover: 0 10px 24px rgba(0, 0, 0, 0.08);--ce-duration-hover: 300ms}[data-theme=\"dark\"],html.dark,body.dark{--ce-white: #0d1816;--ce-black: #fff;--ce-goldenrod: #002e27;--ce-bg-light-green: #03312e;--ce-shades-100: #142321;--ce-shades-300: #323232;--ce-shades-800: #e3e2e2;--ce-shades-950: #525252;--ce-chart-green: #00ad64;--ce-grid-line: #ffffff12;--ce-grid-fill: #ffffff08;--ce-header-shadow: #42424230}html[data-page-mode=\"custom\"] #navbar>div:nth-child(1),html[data-page-mode=\"custom\"] #navbar>div:nth-child(2){opacity:0;transition:opacity var(--ce-duration-hover) ease-out}html[data-page-mode=\"custom\"] #navbar>*:last-child{border:1px solid transparent;border-radius:var(--ce-radius-sm);background:transparent;box-shadow:0 0 0 0 transparent;margin-inline:auto;transition:all var(--ce-duration-hover) ease-out}html[data-page-mode=\"custom\"][data-scrolled=\"true\"] #navbar>*:last-child{width:calc(100% - 2rem);max-width:var(--ce-container-3xl);transform:translateY(12px);border-color:var(--ce-shades-300);background:var(--ce-white);box-shadow:4px 4px 4px 0 var(--ce-header-shadow)}@media (max-width: 992px){html[data-page-mode=\"custom\"][data-scrolled=\"true\"] #navbar>*:last-child{width:calc(100% - 1rem);transform:translateY(8px)}}@media (prefers-reduced-motion: reduce){html[data-page-mode=\"custom\"] #navbar>*:last-child,html[data-page-mode=\"custom\"] #navbar>div:nth-child(1),html[data-page-mode=\"custom\"] #navbar>div:nth-child(2){transition-duration:0.01ms}}.ce-home{background:var(--ce-white);color:var(--ce-black);font-family:var(--ce-font-primary)}.ce-home a{text-decoration:none}.ce-section{margin:0 auto;max-width:1100px;padding:72px 32px 0}.ce-section--last{padding-bottom:96px}.ce-section--wide{max-width:var(--ce-container-2xl)}.ce-page-title{margin:0;font-size:var(--ce-text-7xl);font-weight:700;line-height:var(--ce-leading-sm);letter-spacing:var(--ce-tracking-heading)}.ce-page-lede{margin:16px 0 0;max-width:46rem;font-size:var(--ce-text-base);line-height:var(--ce-leading-lg);color:var(--ce-shades-800)}@media (max-width: 992px){.ce-page-title{font-size:2.5rem}}.ce-h2{margin:0;font-size:var(--ce-text-5xl);font-weight:700;line-height:var(--ce-leading-md);letter-spacing:var(--ce-tracking-heading)}.ce-home table{width:100%;margin:20px 0 0;border-collapse:collapse;font-size:var(--ce-text-xs);line-height:var(--ce-leading-lg)}.ce-home thead th{border-bottom:1px solid var(--ce-shades-300);padding:10px 14px;text-align:left;font-weight:700;color:var(--ce-black)}.ce-home tbody td{border-bottom:1px solid var(--ce-shades-300);padding:10px 14px;color:var(--ce-shades-800);vertical-align:top}.ce-home tbody tr:hover{background:var(--ce-shades-100)}.ce-home table a{color:var(--ce-black);font-weight:500;text-decoration:underline;text-decoration-color:var(--ce-shades-300);text-underline-offset:3px}.ce-home table a:hover{color:var(--ce-green);text-decoration-color:var(--ce-green)}.ce-home table code,.ce-home p code,.ce-home li code{border-radius:var(--ce-radius-sm);background:var(--ce-shades-100);padding:2px 6px;font-family:var(--ce-font-mono);font-size:0.9em}.ce-home .ce-cmd code,.ce-home .ce-term-pre code,.ce-home .ce-agent-prompt code,.ce-home .ce-frame-url code{background:none;padding:0;border-radius:0;font-size:inherit}.ce-home .ce-section>*+*{margin-top:20px}.ce-home .ce-section>.ce-h2{margin-top:56px}.ce-home .ce-section>.ce-h2:first-child{margin-top:0}.ce-lede{margin:12px 0 0;font-size:var(--ce-text-sm);line-height:var(--ce-leading-lg);color:var(--ce-shades-800)}.ce-hero{position:relative;overflow:hidden;border-bottom:1px solid var(--ce-shades-300)}.ce-hero-inner{position:relative;z-index:10;margin:0 auto;max-width:1100px;padding:80px 32px 72px;display:grid;grid-template-columns:1.05fr 0.95fr;gap:56px;align-items:center}.ce-hero-copy{display:grid;gap:24px;justify-items:start}.ce-hero-title{margin:0;font-size:var(--ce-text-7xl);font-weight:700;line-height:var(--ce-leading-sm);letter-spacing:var(--ce-tracking-heading)}.ce-hero-title em{font-style:normal;color:var(--ce-green)}.ce-hero-body{margin:0;max-width:34rem;font-size:var(--ce-text-base);line-height:var(--ce-leading-lg);color:var(--ce-shades-800)}.ce-hero-actions{display:flex;gap:16px;flex-wrap:wrap}.ce-hero-media{display:grid;gap:16px}.ce-hero-grid{position:absolute;inset:0;z-index:0;background-color:var(--ce-goldenrod);background-image:repeating-linear-gradient(to right, var(--ce-grid-line) 0 1px, transparent 1px 102px),\n repeating-linear-gradient(to bottom, var(--ce-grid-line) 0 1px, transparent 1px 102px)}.ce-hero-grid::before,.ce-hero-grid::after{content:\"\";position:absolute;width:102px;height:102px;background:var(--ce-grid-fill)}.ce-hero-grid::before{left:0;top:0}.ce-hero-grid::after{left:816px;top:102px}.ce-eyebrow{display:inline-flex;align-items:center;gap:8px;margin:0;border-radius:var(--ce-radius-full);border:1px solid var(--ce-shades-300);background:var(--ce-white);padding:6px 12px;font-family:var(--ce-font-secondary);font-size:var(--ce-text-2xs);font-weight:500;text-transform:uppercase;letter-spacing:var(--ce-tracking-eyebrow);color:var(--ce-shades-800)}.ce-eyebrow::before{content:\"\";width:6px;height:6px;flex-shrink:0;border-radius:var(--ce-radius-full);background:var(--ce-green)}.ce-eyebrow--dark{border:0;background:none;padding:0;color:var(--ce-skill-dim);letter-spacing:var(--ce-tracking-eyebrow)}.ce-eyebrow--dark::before{background:var(--ce-skill-mark)}.ce-btn{position:relative;overflow:hidden;display:inline-flex;align-items:center;justify-content:center;gap:10px;border:0;border-radius:var(--ce-radius-full);padding:10px 20px;font-family:var(--ce-font-secondary);font-size:var(--ce-text-sm);line-height:var(--ce-leading-lg);font-weight:500;white-space:nowrap;box-shadow:var(--ce-shadow-button);transition:all var(--ce-duration-hover);cursor:pointer}.ce-btn:hover{transform:translateY(-3px) scale(1.02)}.ce-btn:active{transform:translateY(0) scale(1);transition-duration:75ms}.ce-btn:focus-visible{outline:2px solid var(--ce-black);outline-offset:2px}.ce-btn--primary{background:var(--ce-green);color:#fff}.ce-btn--primary:hover{box-shadow:0 6px 15px rgba(0, 0, 0, 0.15),\n 0 10px 30px -8px color-mix(in srgb, var(--ce-green) 60%, transparent)}.ce-btn--secondary{border:1px solid var(--ce-shades-950);background:var(--ce-white);color:var(--ce-black)}.ce-btn--secondary:hover{border-color:var(--ce-shades-800);box-shadow:0 6px 15px rgba(0, 0, 0, 0.12)}.ce-cards{margin-top:32px;display:grid;grid-template-columns:repeat(3, 1fr);gap:20px}.ce-card{display:grid;gap:10px;align-content:start;border:1px solid var(--ce-shades-300);border-radius:var(--ce-radius-xl);background:var(--ce-white);padding:24px;color:var(--ce-black);transition:transform var(--ce-duration-hover),\n box-shadow var(--ce-duration-hover),\n border-color var(--ce-duration-hover)}.ce-card:hover{transform:translateY(-4px);box-shadow:var(--ce-shadow-tile-hover);border-color:var(--ce-green)}.ce-card-step{font-family:var(--ce-font-mono);font-size:var(--ce-text-2xs);color:var(--ce-chart-green)}.ce-card h3{margin:0;font-size:var(--ce-text-xl);font-weight:700;line-height:var(--ce-leading-md)}.ce-card p{margin:0;font-size:var(--ce-text-sm);line-height:var(--ce-leading-lg);color:var(--ce-shades-800)}.ce-skills{overflow:hidden;border-radius:var(--ce-radius-2xl);background:var(--ce-skill-panel);color:var(--ce-skill-fg);display:grid;grid-template-columns:1fr 1fr;gap:48px;padding:40px}.ce-skills-copy{display:grid;gap:20px;align-content:start}.ce-skills-copy h2{margin:0;font-size:var(--ce-text-5xl);font-weight:700;line-height:var(--ce-leading-md);letter-spacing:var(--ce-tracking-heading);color:var(--ce-skill-fg)}.ce-skills-copy p.ce-skills-body{margin:0;font-size:var(--ce-text-sm);line-height:var(--ce-leading-lg);color:var(--ce-skill-dim)}.ce-agents{display:flex;align-items:center;gap:12px}.ce-agent{display:flex;width:40px;height:40px;align-items:center;justify-content:center;border-radius:var(--ce-radius-lg);background:#fff}.ce-agent img{width:22px;height:22px;object-fit:contain}.ce-skills-links{display:flex;gap:24px;flex-wrap:wrap;padding-top:4px}.ce-skills-links a{font-size:var(--ce-text-sm);color:var(--ce-skill-mark)}.ce-skills-links a:hover{text-decoration:underline}.ce-skills-demo{display:grid;align-content:center}.ce-skills-demo pre{margin:0;border-radius:var(--ce-radius-lg);background:var(--ce-skill-inset);border:1px solid var(--ce-skill-border);padding:16px 18px;font-family:var(--ce-font-mono);font-size:12px;line-height:1.9;color:var(--ce-skill-fg);white-space:pre-wrap;overflow-x:auto}.ce-skills-demo .ce-dim{color:var(--ce-skill-dim)}.ce-skills-demo .ce-mark{color:var(--ce-skill-mark)}.ce-guides{margin-top:28px;display:grid;grid-template-columns:1fr 1fr;gap:0 40px}.ce-guide{display:grid;grid-template-columns:1fr auto;align-items:center;gap:16px;border-top:1px solid var(--ce-shades-300);padding:20px 16px;color:var(--ce-black);transition:background var(--ce-duration-hover)}.ce-guide:hover{background:var(--ce-shades-100)}.ce-guide-title{display:block;font-size:var(--ce-text-base);font-weight:700}.ce-guide-sub{display:block;margin-top:4px;font-size:var(--ce-text-xs);line-height:var(--ce-leading-lg);color:var(--ce-shades-800)}.ce-guide-arrow{color:var(--ce-green)}.ce-starters{border-radius:var(--ce-radius-2xl);border:1px solid var(--ce-shades-300);background:var(--ce-shades-100);padding:32px}.ce-starters-head{display:grid;grid-template-columns:1fr auto;gap:32px;align-items:center}.ce-starters-head h2{margin:0;font-size:var(--ce-text-4xl);font-weight:700;line-height:var(--ce-leading-md);letter-spacing:var(--ce-tracking-heading)}.ce-starters-head p{margin:10px 0 0;max-width:38rem;font-size:var(--ce-text-sm);line-height:var(--ce-leading-lg);color:var(--ce-shades-800)}.ce-chips{margin-top:24px;display:grid;grid-template-columns:repeat(6, 1fr);gap:12px}.ce-chip{display:flex;align-items:center;gap:10px;border:1px solid var(--ce-shades-300);border-radius:var(--ce-radius-lg);background:var(--ce-white);padding:12px;color:var(--ce-black);font-size:var(--ce-text-xs);font-weight:500;transition:transform var(--ce-duration-hover),\n border-color var(--ce-duration-hover)}.ce-chip:hover{transform:translateY(-2px);border-color:var(--ce-green)}.ce-chip-mark{display:flex;width:32px;height:32px;flex-shrink:0;align-items:center;justify-content:center;border-radius:var(--ce-radius-md);background:#fff;box-shadow:0 0 0 1px rgba(0, 0, 0, 0.05)}.ce-chip-mark img{width:18px;height:18px;object-fit:contain}.ce-trio{display:grid;grid-template-columns:repeat(3, 1fr);gap:20px}.ce-trio-item{border-top:2px solid var(--ce-shades-300);padding-top:16px;color:var(--ce-black)}.ce-trio-item--active{border-top-color:var(--ce-green)}a.ce-trio-item{transition:border-color var(--ce-duration-hover),\n transform var(--ce-duration-hover)}a.ce-trio-item:hover{border-top-color:var(--ce-green);transform:translateY(-2px)}a.ce-trio-item:hover h3{color:var(--ce-green)}a.ce-trio-item:focus-visible{outline:2px solid var(--ce-black);outline-offset:4px}.ce-trio-item h3{margin:0;font-size:var(--ce-text-base);font-weight:700}.ce-trio-item p{margin:6px 0 0;font-size:var(--ce-text-xs);line-height:var(--ce-leading-lg);color:var(--ce-shades-800)}.ce-cmd{overflow:hidden;border-radius:var(--ce-radius-lg);background:var(--ce-code-block-bg)}.ce-cmd-label{margin:0;border-bottom:1px solid rgba(255, 255, 255, 0.1);padding:10px 16px;font-family:var(--ce-font-secondary);font-size:11px;font-weight:700;text-transform:uppercase;letter-spacing:var(--ce-tracking-label);color:rgba(255, 255, 255, 0.75)}.ce-cmd ul{list-style:none;margin:0;padding:0}.ce-cmd li{display:flex;align-items:center;gap:12px;padding:10px 16px;border-top:1px solid rgba(255, 255, 255, 0.05)}.ce-cmd li:first-child{border-top:0}.ce-cmd code{min-width:0;flex:1;overflow-x:auto;white-space:pre;font-family:var(--ce-font-mono);font-size:11px;line-height:var(--ce-leading-lg);color:#fff;background:none;border:0;padding:0;scrollbar-width:none}.ce-cmd code::-webkit-scrollbar{display:none}.ce-cmd code[data-wrap=\"true\"]{white-space:pre-wrap;overflow-x:visible}.ce-cmd-prefix{user-select:none;color:var(--ce-green)}.ce-cmd-copy{display:flex;width:28px;height:28px;flex-shrink:0;cursor:pointer;align-items:center;justify-content:center;border:0;border-radius:var(--ce-radius-md);background:none;color:rgba(255, 255, 255, 0.5);font-size:12px;transition:color 0.2s,\n background 0.2s}.ce-cmd-copy:hover{background:rgba(255, 255, 255, 0.1);color:#fff}.ce-cmd-copy[data-copied=\"true\"]{color:var(--ce-green)}div:has(>[role=\"menu\"] a[href$=\"/sdk/installation\"]),div:has(>[role=\"menu\"] a[href$=\"/storefront/quickstart\"]){position:fixed!important;top:calc(var(--banner-height, 0px) + 52px)!important;left:50%!important;transform:translateX(-50%)!important}[role=\"menu\"]:has(.nav-dropdown-item){width:fit-content!important;max-width:calc(100vw - 64px)!important;max-height:none!important;display:grid!important;grid-auto-flow:column;grid-auto-columns:minmax(220px, 300px);align-content:start;gap:6px 24px;padding:24px!important;border-radius:var(--ce-radius-2xl)!important;box-shadow:0 12px 36px rgba(0, 0, 0, 0.09)!important}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]),[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]){width:1000px!important;grid-auto-flow:row;grid-template-columns:repeat(3, minmax(0, 1fr));gap:6px 32px;padding:32px!important}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(1){grid-area:1 / 1}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(2){grid-area:2 / 1}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(3){grid-area:1 / 2}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(4){grid-area:2 / 2}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(5){grid-area:1 / 3}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(6){grid-area:2 / 3}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(7){grid-area:3 / 3}[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(1){grid-area:1 / 1}[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(2){grid-area:2 / 1}[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(3){grid-area:3 / 1}[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(4){grid-area:1 / 2}[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(5){grid-area:2 / 2}[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(6){grid-area:1 / 3}[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(7){grid-area:2 / 3}.nav-dropdown-item{display:grid!important;grid-template-columns:auto minmax(0, 1fr);gap:12px;align-items:start!important;border-radius:var(--ce-radius-md)!important;padding:10px 12px!important;color:var(--ce-black)!important;transition:background var(--ce-duration-hover)}.nav-dropdown-item:hover{background:var(--ce-shades-100)!important}.nav-dropdown-item>svg{width:18px;height:18px;margin-top:2px;color:var(--ce-chart-green)}.nav-dropdown-item>div>span:first-child{font-family:var(--ce-font-mono);font-size:var(--ce-text-sm);font-weight:500;color:var(--ce-black)}.nav-dropdown-item>div>span:last-child{margin-top:3px;font-size:var(--ce-text-xs);line-height:var(--ce-leading-lg);color:var(--ce-shades-800)!important}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(1),[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(3),[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(5),[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(1),[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(4),[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(6){position:relative;margin-top:26px}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(1)::before{content:\"Storefront\"}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(3)::before{content:\"Checkout \u0026 POS\"}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(5)::before{content:\"Growth \u0026 AI\"}[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(1)::before{content:\"Get started\"}[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(4)::before{content:\"Build\"}[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(6)::before{content:\"SEO \u0026 AI\"}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(1)::before,[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(3)::before,[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(5)::before,[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(1)::before,[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(4)::before,[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(6)::before{position:absolute;top:-22px;left:12px;font-family:var(--ce-font-secondary);font-size:var(--ce-text-2xs);font-weight:500;text-transform:uppercase;letter-spacing:var(--ce-tracking-eyebrow);color:var(--ce-shades-600)}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(8){grid-area:4 / 1 / auto / -1;margin-top:20px;border-top:1px solid var(--ce-shades-300);padding-top:20px!important;grid-template-columns:repeat(3, auto);justify-content:center;align-items:center!important;gap:10px}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(8)>svg{margin-top:0}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(8)>div{display:block}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(8)>div>span:first-child{font-family:var(--ce-font-secondary);font-size:var(--ce-text-xs);text-transform:uppercase;letter-spacing:var(--ce-tracking-eyebrow)}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(8)>div>span:last-child{display:none}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(8):hover>div>span:first-child{color:var(--ce-green)}@media (max-width: 1100px){[role=\"menu\"]:has(.nav-dropdown-item){width:auto!important;grid-template-columns:1fr}.nav-dropdown-item:nth-child(n){grid-area:auto!important}}.ce-portal{margin:20px 0;border:1px solid var(--ce-shades-300);border-radius:var(--ce-radius-xl);background:var(--ce-shades-100);padding:20px}.ce-portal-label{display:block;margin-bottom:10px;font-family:var(--ce-font-secondary);font-size:11px;font-weight:700;text-transform:uppercase;letter-spacing:var(--ce-tracking-label);color:var(--ce-shades-800)}.ce-portal-row{display:flex;flex-wrap:wrap;align-items:center;gap:12px}.ce-portal-field{display:flex;min-width:0;flex:1 1 320px;align-items:center;overflow:hidden;border:1px solid var(--ce-shades-300);border-radius:var(--ce-radius-full);background:var(--ce-white);transition:border-color var(--ce-duration-hover)}.ce-portal-field:focus-within{border-color:var(--ce-green)}.ce-portal-field input{min-width:0;flex:1;border:0;background:none;padding:11px 16px;font-family:var(--ce-font-mono);font-size:var(--ce-text-xs);color:var(--ce-black);outline:none}.ce-portal-field select{flex-shrink:0;border:0;border-left:1px solid var(--ce-shades-300);background:none;padding:11px 14px;font-family:var(--ce-font-mono);font-size:var(--ce-text-xs);color:var(--ce-shades-800);cursor:pointer;outline:none}.ce-portal .ce-btn[data-disabled=\"true\"]{pointer-events:none;opacity:0.45}.ce-portal-url{margin:12px 0 0;font-size:var(--ce-text-2xs);line-height:var(--ce-leading-lg);color:var(--ce-shades-800)}.ce-portal-url code{font-family:var(--ce-font-mono);word-break:break-all}@media (max-width: 550px){.ce-portal-row{flex-direction:column;align-items:stretch}}.ce-footer{margin-top:96px;border-top:1px solid var(--ce-shades-300);background:var(--ce-shades-100)}.ce-footer-inner{margin:0 auto;max-width:var(--ce-container-2xl);padding:56px 32px 40px;display:grid;grid-template-columns:minmax(0, 1fr) minmax(0, 2.2fr);gap:48px}.ce-footer-brand img{height:28px;width:auto}.ce-footer-logo-dark{display:none}[data-theme=\"dark\"] .ce-footer-logo-light,html.dark .ce-footer-logo-light{display:none}[data-theme=\"dark\"] .ce-footer-logo-dark,html.dark .ce-footer-logo-dark{display:block}.ce-footer-brand p{margin:14px 0 0;max-width:22rem;font-size:var(--ce-text-xs);line-height:var(--ce-leading-lg);color:var(--ce-shades-800)}.ce-footer-socials{margin-top:20px;display:flex;gap:10px}.ce-footer-socials a{display:flex;width:34px;height:34px;align-items:center;justify-content:center;border-radius:var(--ce-radius-full);border:1px solid var(--ce-shades-300);background:var(--ce-white);color:var(--ce-shades-800);transition:color var(--ce-duration-hover),\n border-color var(--ce-duration-hover),\n transform var(--ce-duration-hover)}.ce-footer-socials a:hover{color:var(--ce-green);border-color:var(--ce-green);transform:translateY(-2px)}.ce-footer-cols{display:grid;grid-template-columns:repeat(4, minmax(0, 1fr));gap:32px}.ce-footer-heading{margin:0 0 12px;font-family:var(--ce-font-secondary);font-size:var(--ce-text-2xs);font-weight:500;text-transform:uppercase;letter-spacing:var(--ce-tracking-eyebrow);color:var(--ce-shades-600, #6e6e6f)}.ce-footer-col ul{margin:0;padding:0;list-style:none;display:grid;gap:9px}.ce-footer-col li{margin:0}.ce-footer-col a{font-size:var(--ce-text-xs);line-height:var(--ce-leading-lg);color:var(--ce-shades-800);transition:color var(--ce-duration-hover)}.ce-footer-col a:hover{color:var(--ce-green)}.ce-footer-bar{border-top:1px solid var(--ce-shades-300)}.ce-footer-bar{margin:0 auto;max-width:var(--ce-container-2xl);padding:20px 32px 32px;display:flex;flex-wrap:wrap;justify-content:space-between;gap:12px;font-size:var(--ce-text-2xs);color:var(--ce-shades-600, #6e6e6f)}@media (max-width: 992px){.ce-footer-inner{grid-template-columns:1fr;gap:36px;padding:40px 24px 32px}.ce-footer-cols{grid-template-columns:repeat(2, minmax(0, 1fr))}.ce-footer-bar{padding:20px 24px 28px}}.ce-starters{display:grid;gap:24px;margin:28px 0}.ce-starter-card{display:grid;grid-template-columns:1.4fr 1fr;overflow:hidden;border:1px solid var(--ce-shades-300);border-radius:var(--ce-radius-2xl);background:var(--ce-white);transition:all var(--ce-duration-hover)}.ce-starter-card:hover{transform:translateY(-4px);border-color:var(--ce-green);box-shadow:0 18px 44px rgba(0, 0, 0, 0.12)}.ce-starter-preview{display:flex;min-width:0;align-items:center;background:var(--ce-shades-100);padding:24px}.ce-frame{width:100%;overflow:hidden;border:1px solid var(--ce-shades-300);border-radius:var(--ce-radius-xl);background:var(--ce-white);box-shadow:0 10px 30px rgba(0, 0, 0, 0.1);transition:transform 500ms var(--ce-ease-out, ease-out)}.ce-starter-card:hover .ce-frame{transform:scale(1.02)}.ce-frame-bar{display:flex;align-items:center;gap:8px;border-bottom:1px solid var(--ce-shades-300);background:var(--ce-shades-100);padding:10px 12px}.ce-frame-bar span:not(.ce-frame-url){width:10px;height:10px;flex-shrink:0;border-radius:var(--ce-radius-full)}.ce-frame-url{margin-left:8px;min-width:0;flex:1;overflow:hidden;text-overflow:ellipsis;white-space:nowrap;border-radius:var(--ce-radius-full);background:var(--ce-white);padding:4px 12px;font-size:var(--ce-text-2xs);line-height:var(--ce-leading-lg);color:var(--ce-shades-800)}.ce-frame-viewport{position:relative;overflow:hidden;aspect-ratio:16 / 10}.ce-frame-viewport img{width:100%;height:100%;object-fit:cover;object-position:top center;display:block}.ce-starter-body{display:flex;min-width:0;flex-direction:column;padding:28px}.ce-starter-category{align-self:start;border-radius:var(--ce-radius-full);border:1px solid var(--ce-shades-300);background:var(--ce-shades-100);padding:4px 10px;font-family:var(--ce-font-secondary);font-size:var(--ce-text-2xs);font-weight:500;color:var(--ce-shades-800)}.ce-starter-name{margin:12px 0 0;font-size:var(--ce-text-5xl);font-weight:700;line-height:var(--ce-leading-md);letter-spacing:var(--ce-tracking-heading);color:var(--ce-black)}.ce-starter-desc{margin:10px 0 0;font-size:var(--ce-text-sm);line-height:var(--ce-leading-lg);color:var(--ce-shades-800)}.ce-starter-features{margin:20px 0 0;padding:0;list-style:none;display:flex;flex-wrap:wrap;gap:6px}.ce-starter-features li{margin:0;border-radius:var(--ce-radius-md);border:1px solid var(--ce-shades-300);background:var(--ce-shades-100);padding:4px 8px;font-family:var(--ce-font-secondary);font-size:11px;line-height:var(--ce-leading-lg);color:var(--ce-shades-800)}.ce-starter-foot{margin-top:auto;padding-top:24px}.ce-fw{min-width:0;margin:0;padding:0;border:0}.ce-fw legend{margin-bottom:10px;padding:0;font-family:var(--ce-font-secondary);font-size:11px;font-weight:500;text-transform:uppercase;letter-spacing:0.12em;color:var(--ce-shades-800)}.ce-fw-grid{display:grid;grid-template-columns:repeat(3, minmax(0, 1fr));gap:6px}.ce-fw-option{display:flex;min-height:40px;cursor:pointer;align-items:center;gap:6px;border-radius:var(--ce-radius-lg);border:1px solid var(--ce-shades-300);background:var(--ce-white);padding:0 8px;color:var(--ce-shades-800);transition:border-color 200ms, background 200ms}.ce-fw-option:hover{border-color:var(--ce-green)}.ce-fw-option[data-active=\"true\"]{border-color:var(--ce-green);background:var(--ce-bg-light-green);color:var(--ce-black)}.ce-fw-option:has(input:focus-visible){outline:2px solid var(--ce-green);outline-offset:2px}.ce-fw-option input{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0, 0, 0, 0);white-space:nowrap;border:0}.ce-fw-mark{display:flex;width:18px;height:18px;flex-shrink:0;align-items:center;justify-content:center;border-radius:var(--ce-radius-full);background:#fff;box-shadow:0 0 0 1px rgba(0, 0, 0, 0.05)}.ce-fw-mark img{width:12px;height:12px;object-fit:contain}.ce-fw-name{min-width:0;flex:1;overflow:hidden;text-overflow:ellipsis;white-space:nowrap;font-family:var(--ce-font-secondary);font-size:11px;font-weight:500}.ce-fw-option svg{flex-shrink:0;color:var(--ce-green)}.ce-fw-spacer{width:12px;flex-shrink:0}.ce-starter-hero-cmd{margin:28px 0 0;display:flex;flex-wrap:wrap;align-items:baseline;gap:8px 14px;border:1px solid var(--ce-shades-300);border-radius:var(--ce-radius-xl);background:var(--ce-shades-100);padding:18px 20px}.ce-starter-hero-label{font-family:var(--ce-font-secondary);font-size:11px;font-weight:700;text-transform:uppercase;letter-spacing:var(--ce-tracking-label);color:var(--ce-shades-800)}.ce-starter-hero-cmd code{border-radius:var(--ce-radius-md);background:var(--ce-code-block-bg);padding:8px 14px;font-family:var(--ce-font-mono);font-size:var(--ce-text-xs);color:#fff}.ce-starter-hero-note{font-size:var(--ce-text-2xs);color:var(--ce-shades-800)}.ce-starter-cmd{margin-top:18px;display:flex;align-items:center;gap:8px;overflow:hidden;border-radius:var(--ce-radius-md);background:var(--ce-code-block-bg);padding:8px 8px 8px 12px}.ce-starter-cmd code{min-width:0;flex:1;overflow-x:auto;white-space:pre;border:0;background:none;padding:0;font-family:var(--ce-font-mono);font-size:11px;line-height:var(--ce-leading-lg);color:#fff;scrollbar-width:none}.ce-starter-cmd code::-webkit-scrollbar{display:none}.ce-starter-actions{margin-top:16px;display:flex;flex-wrap:wrap;align-items:center;gap:12px}@media (max-width: 992px){.ce-starter-card{grid-template-columns:1fr}.ce-starter-preview{padding:16px}.ce-starter-body{padding:20px}.ce-starter-name{font-size:var(--ce-text-4xl)}}@media (max-width: 550px){.ce-fw-grid{grid-template-columns:repeat(2, minmax(0, 1fr))}.ce-starter-actions{flex-direction:column;align-items:stretch}}.ce-agent-setup{display:grid;gap:0}.ce-agent-step{margin:0;font-family:var(--ce-font-secondary);font-size:11px;font-weight:700;text-transform:uppercase;letter-spacing:var(--ce-tracking-label);color:var(--ce-shades-800)}.ce-agent-choices{margin-top:12px;display:flex;flex-wrap:wrap;gap:7px}.ce-agent-choice{display:flex;min-height:44px;cursor:pointer;align-items:center;gap:8px;border-radius:var(--ce-radius-full);border:1px solid var(--ce-shades-300);background:var(--ce-white);padding:8px 12px;color:var(--ce-black);font-family:var(--ce-font-secondary);font-size:var(--ce-text-xs);font-weight:500;line-height:var(--ce-leading-lg);transition:all 200ms}.ce-agent-choice:hover{border-color:var(--ce-green)}.ce-agent-choice[data-active=\"true\"]{border-color:var(--ce-green);background:var(--ce-bg-light-green)}.ce-agent-choice:focus-visible{outline:2px solid var(--ce-green);outline-offset:2px}.ce-agent-choice-mark{display:flex;width:18px;height:18px;flex-shrink:0;align-items:center;justify-content:center;border-radius:var(--ce-radius-full);background:#fff;box-shadow:0 0 0 1px rgba(0, 0, 0, 0.05)}.ce-agent-choice-mark img{width:12px;height:12px;object-fit:contain}.ce-agent-block{margin-top:20px}.ce-agent-prompt{display:flex;align-items:flex-start;gap:12px;padding:12px 16px}.ce-agent-prompt p{min-width:0;flex:1;margin:0;font-family:var(--ce-font-mono);font-size:11px;line-height:1.7;color:rgba(255, 255, 255, 0.9)}.ce-term{display:flex;min-height:280px;width:100%;flex-direction:column;overflow:hidden;border-radius:var(--ce-radius-lg);border:1px solid rgba(255, 255, 255, 0.1);background:var(--ce-terminal-bg)}.ce-term-bar{display:flex;gap:8px;border-bottom:1px solid rgba(255, 255, 255, 0.1);padding:16px}.ce-term-bar span{width:12px;height:12px;border-radius:var(--ce-radius-full)}.ce-term-dot-red{background:var(--ce-chrome-red)}.ce-term-dot-amber{background:var(--ce-chrome-amber)}.ce-term-dot-green{background:var(--ce-chrome-green)}.ce-term-pre{flex:1;overflow-x:auto;margin:0;background:var(--ce-terminal-body);padding:16px;font-family:var(--ce-font-mono);font-size:var(--ce-text-sm);line-height:1.5;color:#fff;scrollbar-width:none}.ce-term-pre::-webkit-scrollbar{display:none}.ce-term-pre code{white-space:pre;background:none;border:0;padding:0;color:inherit}.ce-term-cursor{animation:ce-blink 1s step-end infinite;color:var(--ce-chrome-green)}@keyframes ce-blink{0%,50%{opacity:1}51%,100%{opacity:0}}@media (max-width: 1200px){.ce-hero-title{font-size:2.5rem}}@media (max-width: 992px){.ce-hero-inner,.ce-skills{grid-template-columns:1fr}.ce-hero-inner{gap:40px;padding:56px 24px 56px}.ce-skills{gap:32px;padding:32px 24px}.ce-section{padding:56px 24px 0}.ce-cards,.ce-trio{grid-template-columns:1fr}.ce-guides{grid-template-columns:1fr;gap:0}.ce-chips{grid-template-columns:repeat(3, 1fr)}.ce-starters-head{grid-template-columns:1fr;gap:20px}}@media (max-width: 550px){.ce-hero-title{font-size:2rem}.ce-h2,.ce-skills-copy h2{font-size:1.625rem}.ce-chips{grid-template-columns:repeat(2, 1fr)}}@media (prefers-reduced-motion: reduce){.ce-home *,.ce-home *::before,.ce-home *::after{animation-duration:0.01ms!important;animation-iteration-count:1!important;transition-duration:0.01ms!important}}"}]}
{"page":{"pagePath":"api-reference/pos/orders/create-pos-order","slug":"/api-reference/pos/orders/create-pos-order","pageMetadata":{"title":"Create POS order","description":"Creates an order from a POS cart. Returns an `Order` with `payment_required` and `payment_info`. Include `payment_method` to create an initial payment request. When the customer's loyalty points, credit balance or a discount pay the whole order, no payment is requested, whatever the method. Paid by points or a discount alone, the order comes back already `confirmed` (`awaiting_approval` when the store doesn't approve orders automatically; `complete` when it is collected in store with nothing to ship) with `payment_status` `success`. Paid by its credit balance, with or without points, it stays `pending` until that balance is settled against it. If the customer can't be identified at that moment, the order comes back `pending`, and its purchase completes once the customer is identified. When the credit balance pays only part of the order, its payments include a bank transfer for that credit, and the order stays `pending` until the credit is settled against it and the rest is paid. If the store's type can't be determined for the cashier's session, the request fails with a 503 and the `store-type-unavailable` error code, and nothing is placed: retry, or sign in on the device again. Credit balance applied to the cart must be within what the customer can spend now, which leaves out credit their other unpaid orders have claimed. When credit balance can't be used for a moment, an order using it fails with a 409 and the `credit-balance-unavailable` error code, and nothing is placed: retry shortly. The payment method must be one the store offers on the POS's sales channel; any other is refused with a 400.","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/orders","href":"/api-reference/pos/orders/create-pos-order","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: [\"Creates an order from a POS cart. Returns an \", _jsx(_components.code, {\n children: \"Order\"\n }), \" with \", _jsx(_components.code, {\n children: \"payment_required\"\n }), \" and \", _jsx(_components.code, {\n children: \"payment_info\"\n }), \". Include \", _jsx(_components.code, {\n children: \"payment_method\"\n }), \" to create an initial payment request. When the customer’s loyalty points, credit balance or a discount pay the whole order, no payment is requested, whatever the method. Paid by points or a discount alone, the order comes back already \", _jsx(_components.code, {\n children: \"confirmed\"\n }), \" (\", _jsx(_components.code, {\n children: \"awaiting_approval\"\n }), \" when the store doesn’t approve orders automatically; \", _jsx(_components.code, {\n children: \"complete\"\n }), \" when it is collected in store with nothing to ship) with \", _jsx(_components.code, {\n children: \"payment_status\"\n }), \" \", _jsx(_components.code, {\n children: \"success\"\n }), \". Paid by its credit balance, with or without points, it stays \", _jsx(_components.code, {\n children: \"pending\"\n }), \" until that balance is settled against it. If the customer can’t be identified at that moment, the order comes back \", _jsx(_components.code, {\n children: \"pending\"\n }), \", and its purchase completes once the customer is identified. When the credit balance pays only part of the order, its payments include a bank transfer for that credit, and the order stays \", _jsx(_components.code, {\n children: \"pending\"\n }), \" until the credit is settled against it and the rest is paid. If the store’s type can’t be determined for the cashier’s session, the request fails with a 503 and the \", _jsx(_components.code, {\n children: \"store-type-unavailable\"\n }), \" error code, and nothing is placed: retry, or sign in on the device again. Credit balance applied to the cart must be within what the customer can spend now, which leaves out credit their other unpaid orders have claimed. When credit balance can’t be used for a moment, an order using it fails with a 409 and the \", _jsx(_components.code, {\n children: \"credit-balance-unavailable\"\n }), \" error code, and nothing is placed: retry shortly. The payment method must be one the store offers on the POS’s sales channel; any other is refused with a 400.\"]\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":"Create POS order","description":"Creates an order from a POS cart. Returns an `Order` with `payment_required` and `payment_info`. Include `payment_method` to create an initial payment request. When the customer's loyalty points, credit balance or a discount pay the whole order, no payment is requested, whatever the method. Paid by points or a discount alone, the order comes back already `confirmed` (`awaiting_approval` when the store doesn't approve orders automatically; `complete` when it is collected in store with nothing to ship) with `payment_status` `success`. Paid by its credit balance, with or without points, it stays `pending` until that balance is settled against it. If the customer can't be identified at that moment, the order comes back `pending`, and its purchase completes once the customer is identified. When the credit balance pays only part of the order, its payments include a bank transfer for that credit, and the order stays `pending` until the credit is settled against it and the rest is paid. If the store's type can't be determined for the cashier's session, the request fails with a 503 and the `store-type-unavailable` error code, and nothing is placed: retry, or sign in on the device again. Credit balance applied to the cart must be within what the customer can spend now, which leaves out credit their other unpaid orders have claimed. When credit balance can't be used for a moment, an order using it fails with a 409 and the `credit-balance-unavailable` error code, and nothing is placed: retry shortly. The payment method must be one the store offers on the POS's sales channel; any other is refused with a 400.","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/orders","href":"/api-reference/pos/orders/create-pos-order","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/tarkai/83faf160ccb5c4ff/header-float.js"],"openApiReferenceData":{"operation":{"tags":["Orders"],"operationId":"create-pos-order","summary":"Create POS order","description":"Creates an order from a POS cart. Returns an `Order` with `payment_required` and `payment_info`. Include `payment_method` to create an initial payment request. When the customer's loyalty points, credit balance or a discount pay the whole order, no payment is requested, whatever the method. Paid by points or a discount alone, the order comes back already `confirmed` (`awaiting_approval` when the store doesn't approve orders automatically; `complete` when it is collected in store with nothing to ship) with `payment_status` `success`. Paid by its credit balance, with or without points, it stays `pending` until that balance is settled against it. If the customer can't be identified at that moment, the order comes back `pending`, and its purchase completes once the customer is identified. When the credit balance pays only part of the order, its payments include a bank transfer for that credit, and the order stays `pending` until the credit is settled against it and the rest is paid. If the store's type can't be determined for the cashier's session, the request fails with a 503 and the `store-type-unavailable` error code, and nothing is placed: retry, or sign in on the device again. Credit balance applied to the cart must be within what the customer can spend now, which leaves out credit their other unpaid orders have claimed. When credit balance can't be used for a moment, an order using it fails with a 409 and the `credit-balance-unavailable` error code, and nothing is placed: retry shortly. The payment method must be one the store offers on the POS's sales channel; any other is refused with a 400.","externalDocs":{"url":"https://llm-docs.commercengine.io/admin-pos/operations/create-pos-order"},"parameters":[],"requestBody":"0d2ddeaa-089d-4bb6-adc5-24371810ffdc","responses":{"200":"bcd6694f-6b62-4b3f-b9d1-c796224208e7","400":"17237cb0-d65e-4188-879d-ca4f48e7d9c1","401":"2d85141a-2766-4b57-a967-e195998dc30d","403":"0d7c379e-dc5a-43e0-8ef8-33eea1935079","404":"17222cec-8c1b-43e8-a599-903630dd7cb7","408":"db9eb54e-0753-478a-996c-529adae9a12b","409":"9ff8331c-9caf-4cba-8a3f-9cd6abe33c68","500":"c213868b-7f0b-4c48-a212-33a316c2fede","503":"ba3bab17-7274-48c6-bfcc-9a3155adcf05","504":"d0cba2d7-15cd-448c-bd8a-2ee7284d44d9"},"security":["85e69c6e-b9aa-4433-a28e-3860f777d310"],"x-speakeasy-group":"pos","x-speakeasy-name-override":"createPosOrder","method":"post","type":"path","servers":["d5140fa8-2bd5-4c13-abb4-72a9479f9f58","503d314f-8bfe-43e5-9c58-f8d1033bbbb9"],"path":"/pos/orders","baseUrlOptions":["https://staging.api.commercengine.io/api/v1/{store_id}/storefront","https://prod.api.commercengine.io/api/v1/{store_id}/storefront"],"title":"Create POS order","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{},"requestBody":{"description":"Request body","required":true,"content":{"application/json":{"schema":{"type":"object","required":["cart_id"],"properties":{"cart_id":{"type":"string","maxLength":256,"minLength":1,"pattern":"\\S","isRequired":true,"uniqueKey":"cart_id","typeLabel":"string"},"payment_method":{"oneOf":[{"type":"object","title":"JusPayHyperCheckout","required":["payment_provider_slug","integration_type","return_url","action"],"properties":{"payment_provider_slug":{"description":"The slug of the payment provider in Commerce Engine.","type":"string","isRequired":true,"uniqueKey":"payment_method.oneOf.0.payment_provider_slug","typeLabel":"string"},"integration_type":{"type":"string","const":"hyper-checkout","isRequired":true,"uniqueKey":"payment_method.oneOf.0.integration_type","typeLabel":"string"},"return_url":{"description":"Return URL using http, https, ftp or ftps. App-specific URI schemes are not accepted.","type":"string","format":"uri","pattern":"^(?:[hH][tT][tT][pP][sS]?|[fF][tT][pP][sS]?)://","isRequired":true,"uniqueKey":"payment_method.oneOf.0.return_url","typeLabel":"string\u003curi>"},"action":{"description":"The action to be performed. `paymentPage` is the default option that you should select when using hyper-checkout.","type":"string","enum":["paymentPage"],"isRequired":true,"uniqueKey":"payment_method.oneOf.0.action","typeLabel":"enum\u003cstring>"},"gateway_reference_id":{"description":"The reference ID of the payment gateway. When provided, payments will always be routed through this gateway.","type":"string","minLength":1,"pattern":"\\S","uniqueKey":"payment_method.oneOf.0.gateway_reference_id","typeLabel":"string"}},"uniqueKey":"payment_method.oneOf.0","typeLabel":"JusPayHyperCheckout · object"},{"type":"object","title":"JusPayNewCard","required":["save_to_locker","payment_method_type","card_number","card_exp_month","card_exp_year","name_on_card","card_security_code","payment_provider_slug","integration_type","return_url"],"properties":{"payment_provider_slug":{"description":"The slug of the payment provider in Commerce Engine.","type":"string","isRequired":true,"uniqueKey":"payment_method.oneOf.1.payment_provider_slug","typeLabel":"string"},"integration_type":{"type":"string","const":"express-checkout","isRequired":true,"uniqueKey":"payment_method.oneOf.1.integration_type","typeLabel":"string"},"return_url":{"description":"Return URL using http, https, ftp or ftps. App-specific URI schemes are not accepted.","type":"string","format":"uri","pattern":"^(?:[hH][tT][tT][pP][sS]?|[fF][tT][pP][sS]?)://","isRequired":true,"uniqueKey":"payment_method.oneOf.1.return_url","typeLabel":"string\u003curi>"},"save_to_locker":{"description":"Whether to save the card to the locker. If true, the card will be saved to the locker and can be used for future payments as per RBI regulations.","type":"boolean","isRequired":true,"uniqueKey":"payment_method.oneOf.1.save_to_locker","typeLabel":"boolean"},"payment_method_type":{"type":"string","const":"CARD","isRequired":true,"uniqueKey":"payment_method.oneOf.1.payment_method_type","typeLabel":"string"},"card_number":{"type":"string","minLength":1,"pattern":"\\S","isRequired":true,"uniqueKey":"payment_method.oneOf.1.card_number","typeLabel":"string"},"card_exp_month":{"type":"string","minLength":1,"pattern":"\\S","isRequired":true,"uniqueKey":"payment_method.oneOf.1.card_exp_month","typeLabel":"string"},"card_exp_year":{"type":"string","minLength":1,"pattern":"\\S","isRequired":true,"uniqueKey":"payment_method.oneOf.1.card_exp_year","typeLabel":"string"},"name_on_card":{"type":"string","minLength":1,"pattern":"\\S","isRequired":true,"uniqueKey":"payment_method.oneOf.1.name_on_card","typeLabel":"string"},"card_security_code":{"type":"string","minLength":1,"pattern":"\\S","isRequired":true,"uniqueKey":"payment_method.oneOf.1.card_security_code","typeLabel":"string"},"gateway_reference_id":{"description":"The reference ID of the payment gateway. When provided, payments will always be routed through this gateway.","type":"string","minLength":1,"pattern":"\\S","uniqueKey":"payment_method.oneOf.1.gateway_reference_id","typeLabel":"string"},"get_client_auth_token":{"type":"boolean","default":false,"uniqueKey":"payment_method.oneOf.1.get_client_auth_token","typeLabel":"boolean"},"redirect_after_payment":{"type":"boolean","default":true,"uniqueKey":"payment_method.oneOf.1.redirect_after_payment","typeLabel":"boolean"},"sdk_params":{"type":"boolean","default":true,"uniqueKey":"payment_method.oneOf.1.sdk_params","typeLabel":"boolean"},"auth_type":{"type":"string","default":"OTP","minLength":1,"pattern":"\\S","uniqueKey":"payment_method.oneOf.1.auth_type","typeLabel":"string"}},"uniqueKey":"payment_method.oneOf.1","typeLabel":"JusPayNewCard · object"},{"type":"object","title":"JusPaySavedCardToken","required":["save_to_locker","payment_method_type","card_token","card_security_code","payment_provider_slug","integration_type","return_url"],"properties":{"payment_provider_slug":{"description":"The slug of the payment provider in Commerce Engine.","type":"string","isRequired":true,"uniqueKey":"payment_method.oneOf.2.payment_provider_slug","typeLabel":"string"},"integration_type":{"type":"string","const":"express-checkout","isRequired":true,"uniqueKey":"payment_method.oneOf.2.integration_type","typeLabel":"string"},"return_url":{"description":"Return URL using http, https, ftp or ftps. App-specific URI schemes are not accepted.","type":"string","format":"uri","pattern":"^(?:[hH][tT][tT][pP][sS]?|[fF][tT][pP][sS]?)://","isRequired":true,"uniqueKey":"payment_method.oneOf.2.return_url","typeLabel":"string\u003curi>"},"save_to_locker":{"description":"Whether to save the card to the locker. If true, the card will be saved to the locker and can be used for future payments as per RBI regulations.","type":"boolean","isRequired":true,"uniqueKey":"payment_method.oneOf.2.save_to_locker","typeLabel":"boolean"},"payment_method_type":{"type":"string","const":"CARD","isRequired":true,"uniqueKey":"payment_method.oneOf.2.payment_method_type","typeLabel":"string"},"card_token":{"description":"Token of the card. This is the token that is used to identify the card in the gateway.","type":"string","minLength":1,"pattern":"\\S","isRequired":true,"uniqueKey":"payment_method.oneOf.2.card_token","typeLabel":"string"},"card_security_code":{"description":"Security code of the card. This is the security code that is used to identify the card in the gateway.","type":"string","minLength":1,"pattern":"\\S","isRequired":true,"uniqueKey":"payment_method.oneOf.2.card_security_code","typeLabel":"string"},"gateway_reference_id":{"description":"The reference ID of the payment gateway. When provided, payments will always be routed through this gateway.","type":"string","minLength":1,"pattern":"\\S","uniqueKey":"payment_method.oneOf.2.gateway_reference_id","typeLabel":"string"},"get_client_auth_token":{"type":"boolean","default":false,"uniqueKey":"payment_method.oneOf.2.get_client_auth_token","typeLabel":"boolean"},"redirect_after_payment":{"type":"boolean","default":true,"uniqueKey":"payment_method.oneOf.2.redirect_after_payment","typeLabel":"boolean"},"sdk_params":{"type":"boolean","default":true,"uniqueKey":"payment_method.oneOf.2.sdk_params","typeLabel":"boolean"},"auth_type":{"type":"string","default":"OTP","minLength":1,"pattern":"\\S","uniqueKey":"payment_method.oneOf.2.auth_type","typeLabel":"string"},"payment_method":{"description":"Optional card payment method supported by the payment provider.","type":"string","minLength":1,"pattern":"\\S","uniqueKey":"payment_method.oneOf.2.payment_method","typeLabel":"string"}},"uniqueKey":"payment_method.oneOf.2","typeLabel":"JusPaySavedCardToken · object"},{"type":"object","title":"JuspayNetBanking","required":["payment_method_type","payment_method","payment_provider_slug","integration_type","return_url"],"properties":{"payment_provider_slug":{"description":"The slug of the payment provider in Commerce Engine.","type":"string","isRequired":true,"uniqueKey":"payment_method.oneOf.3.payment_provider_slug","typeLabel":"string"},"integration_type":{"type":"string","const":"express-checkout","isRequired":true,"uniqueKey":"payment_method.oneOf.3.integration_type","typeLabel":"string"},"return_url":{"description":"Return URL using http, https, ftp or ftps. App-specific URI schemes are not accepted.","type":"string","format":"uri","pattern":"^(?:[hH][tT][tT][pP][sS]?|[fF][tT][pP][sS]?)://","isRequired":true,"uniqueKey":"payment_method.oneOf.3.return_url","typeLabel":"string\u003curi>"},"payment_method_type":{"type":"string","const":"NB","isRequired":true,"uniqueKey":"payment_method.oneOf.3.payment_method_type","typeLabel":"string"},"payment_method":{"type":"string","minLength":1,"pattern":"\\S","isRequired":true,"uniqueKey":"payment_method.oneOf.3.payment_method","typeLabel":"string"},"gateway_reference_id":{"description":"The reference ID of the payment gateway. When provided, payments will always be routed through this gateway.","type":"string","minLength":1,"pattern":"\\S","uniqueKey":"payment_method.oneOf.3.gateway_reference_id","typeLabel":"string"},"get_client_auth_token":{"type":"boolean","default":false,"uniqueKey":"payment_method.oneOf.3.get_client_auth_token","typeLabel":"boolean"},"redirect_after_payment":{"type":"boolean","default":true,"uniqueKey":"payment_method.oneOf.3.redirect_after_payment","typeLabel":"boolean"},"sdk_params":{"type":"boolean","default":true,"uniqueKey":"payment_method.oneOf.3.sdk_params","typeLabel":"boolean"},"auth_type":{"type":"string","default":"OTP","uniqueKey":"payment_method.oneOf.3.auth_type","typeLabel":"string"}},"uniqueKey":"payment_method.oneOf.3","typeLabel":"JuspayNetBanking · object"},{"type":"object","title":"JuspayUpiCollect","required":["payment_method_type","payment_method","upi_vpa","payment_provider_slug","integration_type","return_url"],"properties":{"payment_provider_slug":{"description":"The slug of the payment provider in Commerce Engine.","type":"string","isRequired":true,"uniqueKey":"payment_method.oneOf.4.payment_provider_slug","typeLabel":"string"},"integration_type":{"type":"string","const":"express-checkout","isRequired":true,"uniqueKey":"payment_method.oneOf.4.integration_type","typeLabel":"string"},"return_url":{"description":"Return URL using http, https, ftp or ftps. App-specific URI schemes are not accepted.","type":"string","format":"uri","pattern":"^(?:[hH][tT][tT][pP][sS]?|[fF][tT][pP][sS]?)://","isRequired":true,"uniqueKey":"payment_method.oneOf.4.return_url","typeLabel":"string\u003curi>"},"payment_method_type":{"type":"string","const":"UPI","isRequired":true,"uniqueKey":"payment_method.oneOf.4.payment_method_type","typeLabel":"string"},"payment_method":{"type":"string","const":"UPI_COLLECT","isRequired":true,"uniqueKey":"payment_method.oneOf.4.payment_method","typeLabel":"string"},"upi_vpa":{"type":"string","minLength":1,"pattern":"\\S","isRequired":true,"uniqueKey":"payment_method.oneOf.4.upi_vpa","typeLabel":"string"},"gateway_reference_id":{"description":"The reference ID of the payment gateway. When provided, payments will always be routed through this gateway.","type":"string","minLength":1,"pattern":"\\S","uniqueKey":"payment_method.oneOf.4.gateway_reference_id","typeLabel":"string"},"get_client_auth_token":{"type":"boolean","default":false,"uniqueKey":"payment_method.oneOf.4.get_client_auth_token","typeLabel":"boolean"},"redirect_after_payment":{"type":"boolean","default":true,"uniqueKey":"payment_method.oneOf.4.redirect_after_payment","typeLabel":"boolean"},"sdk_params":{"type":"boolean","default":true,"uniqueKey":"payment_method.oneOf.4.sdk_params","typeLabel":"boolean"},"auth_type":{"type":"string","default":"OTP","uniqueKey":"payment_method.oneOf.4.auth_type","typeLabel":"string"}},"uniqueKey":"payment_method.oneOf.4","typeLabel":"JuspayUpiCollect · object"},{"type":"object","title":"JuspayUpiIntent","required":["payment_method_type","payment_method","payment_provider_slug","integration_type","return_url"],"properties":{"payment_provider_slug":{"description":"The slug of the payment provider in Commerce Engine.","type":"string","isRequired":true,"uniqueKey":"payment_method.oneOf.5.payment_provider_slug","typeLabel":"string"},"integration_type":{"type":"string","const":"express-checkout","isRequired":true,"uniqueKey":"payment_method.oneOf.5.integration_type","typeLabel":"string"},"return_url":{"description":"Return URL using http, https, ftp or ftps. App-specific URI schemes are not accepted.","type":"string","format":"uri","pattern":"^(?:[hH][tT][tT][pP][sS]?|[fF][tT][pP][sS]?)://","isRequired":true,"uniqueKey":"payment_method.oneOf.5.return_url","typeLabel":"string\u003curi>"},"payment_method_type":{"type":"string","const":"UPI","isRequired":true,"uniqueKey":"payment_method.oneOf.5.payment_method_type","typeLabel":"string"},"payment_method":{"type":"string","const":"UPI_PAY","isRequired":true,"uniqueKey":"payment_method.oneOf.5.payment_method","typeLabel":"string"},"gateway_reference_id":{"description":"The reference ID of the payment gateway. When provided, payments will always be routed through this gateway.","type":"string","minLength":1,"pattern":"\\S","uniqueKey":"payment_method.oneOf.5.gateway_reference_id","typeLabel":"string"},"get_client_auth_token":{"type":"boolean","default":false,"uniqueKey":"payment_method.oneOf.5.get_client_auth_token","typeLabel":"boolean"},"redirect_after_payment":{"type":"boolean","default":true,"uniqueKey":"payment_method.oneOf.5.redirect_after_payment","typeLabel":"boolean"},"sdk_params":{"type":"boolean","description":"Must be true for UPI intent.","default":true,"const":true,"uniqueKey":"payment_method.oneOf.5.sdk_params","typeLabel":"boolean"},"auth_type":{"type":"string","default":"OTP","uniqueKey":"payment_method.oneOf.5.auth_type","typeLabel":"string"}},"uniqueKey":"payment_method.oneOf.5","typeLabel":"JuspayUpiIntent · object"},{"type":"object","title":"ManualPaymentMethodCheckout","required":["payment_provider_slug"],"properties":{"payment_provider_slug":{"description":"The slug of an active manual payment method configured for the store.","type":"string","isRequired":true,"uniqueKey":"payment_method.oneOf.6.payment_provider_slug","typeLabel":"string"},"payment_method_type":{"description":"Optional label stored on the created payment request.","type":"string","uniqueKey":"payment_method.oneOf.6.payment_method_type","typeLabel":"string"}},"uniqueKey":"payment_method.oneOf.6","typeLabel":"ManualPaymentMethodCheckout · object"}],"uniqueKey":"payment_method","typeLabel":"JusPayHyperCheckout · object | JusPayNewCard · object | JusPaySavedCardToken · object | JuspayNetBanking · object | JuspayUpiCollect · object | JuspayUpiIntent · object | ManualPaymentMethodCheckout · object"},"device_id":{"type":"string","maxLength":256,"minLength":1,"pattern":"\\S","uniqueKey":"device_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"cart_id":"\u003cstring>","payment_method":{"payment_provider_slug":"\u003cstring>","integration_type":"hyper-checkout","return_url":"\u003cstring>","action":"paymentPage","gateway_reference_id":"\u003cstring>"},"device_id":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"bcd6694f-6b62-4b3f-b9d1-c796224208e7":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["message","success","content","events"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"success":{"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"content":{"properties":{"order":{"title":"Order","type":"object","externalDocs":{"url":"https://llm-docs.commercengine.io/admin-pos/schemas/Order"},"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","fulfillment_preference","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","fulfillment_type","items_tax_amount","loyalty_point_eligible_amount","sales_channel","created_at","modified_at","shipments"],"properties":{"order_number":{"description":"Unique, human-readable order identifier used across all order endpoints.","type":"string","isRequired":true,"uniqueKey":"content.order.order_number","typeLabel":"string"},"order_date":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"content.order.order_date","typeLabel":"string\u003cdate-time>"},"status":{"title":"OrderStatus","type":"string","externalDocs":{"url":"https://llm-docs.commercengine.io/admin-pos/schemas/OrderStatus"},"enum":["draft","awaiting_approval","confirmed","schedule_requested","partially_scheduled","awaiting_shipment","shipped","partially_shipped","undelivered","partially_undelivered","return_to_origin","partially_return_to_origin","complete","partially_delivered","cancelled","pending","payment_failed","sent_to_store","ready_to_collect","processing","lost"],"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`.","isRequired":true,"uniqueKey":"content.order.status","typeLabel":"enum\u003cstring>"},"payment_status":{"title":"OrderPaymentStatus","type":"string","externalDocs":{"url":"https://llm-docs.commercengine.io/admin-pos/schemas/OrderPaymentStatus"},"enum":["pending","success","failed","partially_paid","refund_initiated","refunded","unsettled","settled","partially_settled","manual_review","debit_scheduled","collection_due"],"description":"Current payment status. Poll `/orders/{order_number}/payment-status` after a payment attempt until this is `success` or `failed`. `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.","isRequired":true,"uniqueKey":"content.order.payment_status","typeLabel":"enum\u003cstring>"},"payment_success_date":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"content.order.payment_success_date.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"content.order.payment_success_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.payment_success_date","typeLabel":"string\u003cdate-time> | null"},"customer_note":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.customer_note.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.customer_note.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.customer_note","typeLabel":"string | null"},"is_promotion_applied":{"type":"boolean","isRequired":true,"uniqueKey":"content.order.is_promotion_applied","typeLabel":"boolean"},"promotion_discount_amount":{"type":"number","format":"double","isRequired":true,"uniqueKey":"content.order.promotion_discount_amount","typeLabel":"number\u003cdouble>"},"promotion_discount_percent":{"oneOf":[{"type":"number","format":"double","isRequired":true,"uniqueKey":"content.order.promotion_discount_percent.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","format":"double","isRequired":true,"uniqueKey":"content.order.promotion_discount_percent.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.promotion_discount_percent","typeLabel":"number\u003cdouble> | null"},"is_coupon_applied":{"type":"boolean","isRequired":true,"uniqueKey":"content.order.is_coupon_applied","typeLabel":"boolean"},"coupon_code":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.coupon_code.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.coupon_code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.coupon_code","typeLabel":"string | null"},"coupon_discount_amount":{"type":"number","format":"double","isRequired":true,"uniqueKey":"content.order.coupon_discount_amount","typeLabel":"number\u003cdouble>"},"coupon_discount_percent":{"oneOf":[{"type":"number","format":"double","isRequired":true,"uniqueKey":"content.order.coupon_discount_percent.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","format":"double","isRequired":true,"uniqueKey":"content.order.coupon_discount_percent.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.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/admin-pos/schemas/AppliedPromotion"},"required":["promotion_id","promotion_type","savings","product_id","variant_id","product_name","variant_name","applied_sequence","scope"],"properties":{"promotion_id":{"type":"string","isRequired":true,"uniqueKey":"content.order.applied_promotions.items.[INDEX].promotion_id","typeLabel":"string"},"promotion_type":{"enum":["discount","free-goods","free-shipping","buy-x-get-y","volume-based","fixed-price"],"type":"string","isRequired":true,"uniqueKey":"content.order.applied_promotions.items.[INDEX].promotion_type","typeLabel":"enum\u003cstring>"},"savings":{"type":"number","isRequired":true,"uniqueKey":"content.order.applied_promotions.items.[INDEX].savings","typeLabel":"number"},"product_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.applied_promotions.items.[INDEX].product_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.applied_promotions.items.[INDEX].product_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.applied_promotions.items.[INDEX].product_id","typeLabel":"string | null"},"variant_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.applied_promotions.items.[INDEX].variant_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.applied_promotions.items.[INDEX].variant_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.applied_promotions.items.[INDEX].variant_id","typeLabel":"string | null"},"product_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.applied_promotions.items.[INDEX].product_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.applied_promotions.items.[INDEX].product_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.applied_promotions.items.[INDEX].product_name","typeLabel":"string | null"},"variant_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.applied_promotions.items.[INDEX].variant_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.applied_promotions.items.[INDEX].variant_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.applied_promotions.items.[INDEX].variant_name","typeLabel":"string | null"},"applied_sequence":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"content.order.applied_promotions.items.[INDEX].applied_sequence.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"content.order.applied_promotions.items.[INDEX].applied_sequence.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.applied_promotions.items.[INDEX].applied_sequence","typeLabel":"number | null"},"scope":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.applied_promotions.items.[INDEX].scope.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.applied_promotions.items.[INDEX].scope.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.applied_promotions.items.[INDEX].scope","typeLabel":"string | null"}},"uniqueKey":"content.order.applied_promotions.items.[INDEX]","typeLabel":"AppliedPromotion · object"},"isRequired":true,"uniqueKey":"content.order.applied_promotions","typeLabel":"AppliedPromotion · object[]"},"applied_coupons":{"description":"This key provides details about the savings in cart after coupon have been applied to the cart.","type":"array","items":{"title":"AppliedCoupon","description":"Details about an active coupon applied to a cart/order","type":"object","externalDocs":{"url":"https://llm-docs.commercengine.io/admin-pos/schemas/AppliedCoupon"},"required":["coupon_id","coupon_type","savings","product_id","variant_id","product_name","variant_name"],"properties":{"coupon_id":{"type":"string","isRequired":true,"uniqueKey":"content.order.applied_coupons.items.[INDEX].coupon_id","typeLabel":"string"},"coupon_type":{"enum":["discount","free-goods","fixed-price","free-shipping","buy-x-get-y","volume-based","accelerated-rewards","tiered-discount"],"type":"string","isRequired":true,"uniqueKey":"content.order.applied_coupons.items.[INDEX].coupon_type","typeLabel":"enum\u003cstring>"},"savings":{"type":"number","isRequired":true,"uniqueKey":"content.order.applied_coupons.items.[INDEX].savings","typeLabel":"number"},"product_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.applied_coupons.items.[INDEX].product_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.applied_coupons.items.[INDEX].product_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.applied_coupons.items.[INDEX].product_id","typeLabel":"string | null"},"variant_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.applied_coupons.items.[INDEX].variant_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.applied_coupons.items.[INDEX].variant_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.applied_coupons.items.[INDEX].variant_id","typeLabel":"string | null"},"product_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.applied_coupons.items.[INDEX].product_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.applied_coupons.items.[INDEX].product_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.applied_coupons.items.[INDEX].product_name","typeLabel":"string | null"},"variant_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.applied_coupons.items.[INDEX].variant_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.applied_coupons.items.[INDEX].variant_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.applied_coupons.items.[INDEX].variant_name","typeLabel":"string | null"}},"uniqueKey":"content.order.applied_coupons.items.[INDEX]","typeLabel":"AppliedCoupon · object"},"isRequired":true,"uniqueKey":"content.order.applied_coupons","typeLabel":"AppliedCoupon · object[]"},"promotion_savings":{"description":"Monetary promotion savings; bonus loyalty points are excluded.","type":"number","format":"float","minimum":0,"isRequired":true,"uniqueKey":"content.order.promotion_savings","typeLabel":"number\u003cfloat>"},"coupon_savings":{"description":"Monetary coupon savings; bonus loyalty points are excluded.","type":"number","format":"float","minimum":0,"isRequired":true,"uniqueKey":"content.order.coupon_savings","typeLabel":"number\u003cfloat>"},"other_savings":{"description":"Nonnegative markdown savings between listing price and original selling price, across positive-quantity items.","type":"number","format":"float","minimum":0,"isRequired":true,"uniqueKey":"content.order.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":"content.order.total_savings","typeLabel":"number\u003cfloat>"},"on_subscription":{"type":"boolean","isRequired":true,"uniqueKey":"content.order.on_subscription","typeLabel":"boolean"},"subtotal":{"type":"number","format":"double","isRequired":true,"uniqueKey":"content.order.subtotal","typeLabel":"number\u003cdouble>"},"subtotal_including_tax":{"type":"number","format":"double","isRequired":true,"uniqueKey":"content.order.subtotal_including_tax","typeLabel":"number\u003cdouble>"},"shipping_estimated_cost":{"type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"content.order.shipping_estimated_cost","typeLabel":"number\u003cdouble>"},"shipping_discount_amount":{"type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"content.order.shipping_discount_amount","typeLabel":"number\u003cdouble>"},"shipping_amount":{"type":"number","format":"double","isRequired":true,"uniqueKey":"content.order.shipping_amount","typeLabel":"number\u003cdouble>"},"shipping_tax_rate":{"type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"content.order.shipping_tax_rate","typeLabel":"number\u003cdouble>"},"shipping_tax_amount":{"type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"content.order.shipping_tax_amount","typeLabel":"number\u003cdouble>"},"shipping_amount_including_tax":{"type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"content.order.shipping_amount_including_tax","typeLabel":"number\u003cdouble>"},"fulfillment_preference":{"oneOf":[{"type":"object","title":"CollectInStoreFulfillment","description":"How the customer wants to receive the order. `null` when the order has no fulfillment preference (e.g. created without a checkout).","required":["fulfillment_type","pickup_location_id","preference_type"],"x-tags":["Carts"],"properties":{"fulfillment_type":{"type":"string","const":"collect-in-store","isRequired":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.0.fulfillment_type","typeLabel":"string"},"preference_type":{"type":"string","enum":["user","auto"],"readOnly":true,"isRequired":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.0.preference_type","typeLabel":"enum\u003cstring>"},"pickup_location_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.0.pickup_location_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.0.pickup_location_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.0.pickup_location_id","typeLabel":"string | null"},"pickup_location_name":{"oneOf":[{"type":"string","readOnly":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.0.pickup_location_name.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.0.pickup_location_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.order.fulfillment_preference.oneOf.0.pickup_location_name","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.0","typeLabel":"CollectInStoreFulfillment · object"},{"type":"object","title":"DeliveryFulfillment","description":"How the customer wants to receive the order. `null` when the order has no fulfillment preference (e.g. created without a checkout).","required":["fulfillment_type","shipments","preference_type"],"x-tags":["Carts"],"properties":{"fulfillment_type":{"type":"string","const":"delivery","isRequired":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.1.fulfillment_type","typeLabel":"string"},"preference_type":{"type":"string","enum":["user","auto"],"readOnly":true,"isRequired":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.1.preference_type","typeLabel":"enum\u003cstring>"},"shipments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.1.shipments.items.[INDEX].id","typeLabel":"string"},"shipping_provider_id":{"type":"string","isRequired":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.1.shipments.items.[INDEX].shipping_provider_id","typeLabel":"string"},"shipping_provider_name":{"oneOf":[{"type":"string","readOnly":true,"isRequired":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.1.shipments.items.[INDEX].shipping_provider_name.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"isRequired":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.1.shipments.items.[INDEX].shipping_provider_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.1.shipments.items.[INDEX].shipping_provider_name","typeLabel":"string | null"},"courier_company_name":{"oneOf":[{"type":"string","readOnly":true,"isRequired":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.1.shipments.items.[INDEX].courier_company_name.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"isRequired":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.1.shipments.items.[INDEX].courier_company_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.1.shipments.items.[INDEX].courier_company_name","typeLabel":"string | null"},"courier_company_id":{"oneOf":[{"type":"string","uniqueKey":"content.order.fulfillment_preference.oneOf.1.shipments.items.[INDEX].courier_company_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"content.order.fulfillment_preference.oneOf.1.shipments.items.[INDEX].courier_company_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.order.fulfillment_preference.oneOf.1.shipments.items.[INDEX].courier_company_id","typeLabel":"string | null"}},"required":["id","shipping_provider_id","shipping_provider_name","courier_company_name"],"uniqueKey":"content.order.fulfillment_preference.oneOf.1.shipments.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.1.shipments","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.1","typeLabel":"DeliveryFulfillment · object"},{"type":"object","title":"PartialCollectAndDelivery","description":"How the customer wants to receive the order. `null` when the order has no fulfillment preference (e.g. created without a checkout).","required":["fulfillment_type","preference_type"],"x-tags":["Carts"],"properties":{"fulfillment_type":{"type":"string","const":"partial-collect-and-delivery","isRequired":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.2.fulfillment_type","typeLabel":"string"},"preference_type":{"type":"string","enum":["user","auto"],"readOnly":true,"isRequired":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.2.preference_type","typeLabel":"enum\u003cstring>"},"collect_in_store":{"type":"object","properties":{"pickup_location_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.2.collect_in_store.pickup_location_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.2.collect_in_store.pickup_location_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.2.collect_in_store.pickup_location_id","typeLabel":"string | null"},"items":{"type":"array","items":{"title":"FulfillmentItem","type":"object","externalDocs":{"url":"https://llm-docs.commercengine.io/admin-pos/schemas/FulfillmentItem"},"required":["product_id","product_name","variant_id","variant_name","quantity"],"properties":{"product_id":{"type":"string","isRequired":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.2.collect_in_store.\\items.items.[INDEX].product_id","typeLabel":"string"},"product_name":{"type":"string","readOnly":true,"isRequired":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.2.collect_in_store.\\items.items.[INDEX].product_name","typeLabel":"string"},"variant_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.2.collect_in_store.\\items.items.[INDEX].variant_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.2.collect_in_store.\\items.items.[INDEX].variant_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.2.collect_in_store.\\items.items.[INDEX].variant_id","typeLabel":"string | null"},"variant_name":{"oneOf":[{"type":"string","readOnly":true,"isRequired":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.2.collect_in_store.\\items.items.[INDEX].variant_name.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"isRequired":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.2.collect_in_store.\\items.items.[INDEX].variant_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.2.collect_in_store.\\items.items.[INDEX].variant_name","typeLabel":"string | null"},"quantity":{"type":"integer","minimum":1,"isRequired":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.2.collect_in_store.\\items.items.[INDEX].quantity","typeLabel":"integer"}},"uniqueKey":"content.order.fulfillment_preference.oneOf.2.collect_in_store.\\items.items.[INDEX]","typeLabel":"FulfillmentItem · object"},"isRequired":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.2.collect_in_store.\\items","typeLabel":"FulfillmentItem · object[]"},"pickup_location_name":{"oneOf":[{"type":"string","readOnly":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.2.collect_in_store.pickup_location_name.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.2.collect_in_store.pickup_location_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.order.fulfillment_preference.oneOf.2.collect_in_store.pickup_location_name","typeLabel":"string | null"}},"required":["items","pickup_location_id"],"uniqueKey":"content.order.fulfillment_preference.oneOf.2.collect_in_store","typeLabel":"object"},"delivery":{"type":"object","properties":{"shipping_provider_id":{"type":"string","isRequired":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.2.delivery.shipping_provider_id","typeLabel":"string"},"items":{"type":"array","items":{"title":"FulfillmentItem","type":"object","externalDocs":{"url":"https://llm-docs.commercengine.io/admin-pos/schemas/FulfillmentItem"},"required":["product_id","product_name","variant_id","variant_name","quantity"],"properties":{"product_id":{"type":"string","isRequired":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.2.delivery.\\items.items.[INDEX].product_id","typeLabel":"string"},"product_name":{"type":"string","readOnly":true,"isRequired":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.2.delivery.\\items.items.[INDEX].product_name","typeLabel":"string"},"variant_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.2.delivery.\\items.items.[INDEX].variant_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.2.delivery.\\items.items.[INDEX].variant_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.2.delivery.\\items.items.[INDEX].variant_id","typeLabel":"string | null"},"variant_name":{"oneOf":[{"type":"string","readOnly":true,"isRequired":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.2.delivery.\\items.items.[INDEX].variant_name.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"isRequired":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.2.delivery.\\items.items.[INDEX].variant_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.2.delivery.\\items.items.[INDEX].variant_name","typeLabel":"string | null"},"quantity":{"type":"integer","minimum":1,"isRequired":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.2.delivery.\\items.items.[INDEX].quantity","typeLabel":"integer"}},"uniqueKey":"content.order.fulfillment_preference.oneOf.2.delivery.\\items.items.[INDEX]","typeLabel":"FulfillmentItem · object"},"isRequired":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.2.delivery.\\items","typeLabel":"FulfillmentItem · object[]"},"shipping_provider_name":{"oneOf":[{"type":"string","readOnly":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.2.delivery.shipping_provider_name.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.2.delivery.shipping_provider_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.order.fulfillment_preference.oneOf.2.delivery.shipping_provider_name","typeLabel":"string | null"},"courier_company_id":{"oneOf":[{"type":"string","uniqueKey":"content.order.fulfillment_preference.oneOf.2.delivery.courier_company_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"content.order.fulfillment_preference.oneOf.2.delivery.courier_company_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.order.fulfillment_preference.oneOf.2.delivery.courier_company_id","typeLabel":"string | null"},"courier_company_name":{"oneOf":[{"type":"string","readOnly":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.2.delivery.courier_company_name.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.2.delivery.courier_company_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.order.fulfillment_preference.oneOf.2.delivery.courier_company_name","typeLabel":"string | null"}},"required":["shipping_provider_id","items"],"uniqueKey":"content.order.fulfillment_preference.oneOf.2.delivery","typeLabel":"object"}},"isRequired":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.2","typeLabel":"PartialCollectAndDelivery · object"},{"type":"null","description":"How the customer wants to receive the order. `null` when the order has no fulfillment preference (e.g. created without a checkout).","isRequired":true,"uniqueKey":"content.order.fulfillment_preference.oneOf.3","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.fulfillment_preference","typeLabel":"CollectInStoreFulfillment · object | DeliveryFulfillment · object | PartialCollectAndDelivery · object | null"},"estimated_delivery_days":{"oneOf":[{"type":"integer","isRequired":true,"uniqueKey":"content.order.estimated_delivery_days.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"content.order.estimated_delivery_days.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.estimated_delivery_days","typeLabel":"integer | null"},"handling_charge_excluding_tax":{"type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"content.order.handling_charge_excluding_tax","typeLabel":"number\u003cdouble>"},"handling_charge_tax_amount":{"type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"content.order.handling_charge_tax_amount","typeLabel":"number\u003cdouble>"},"handling_charge_including_tax":{"type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"content.order.handling_charge_including_tax","typeLabel":"number\u003cdouble>"},"total_tax":{"type":"number","format":"double","isRequired":true,"uniqueKey":"content.order.total_tax","typeLabel":"number\u003cdouble>"},"grand_total":{"type":"number","format":"double","isRequired":true,"uniqueKey":"content.order.grand_total","typeLabel":"number\u003cdouble>"},"loyalty_points_earned":{"type":"number","minimum":0,"isRequired":true,"uniqueKey":"content.order.loyalty_points_earned","typeLabel":"number"},"loyalty_points_redeemed":{"type":"number","minimum":0,"isRequired":true,"uniqueKey":"content.order.loyalty_points_redeemed","typeLabel":"number"},"credit_balance_used":{"type":"number","isRequired":true,"uniqueKey":"content.order.credit_balance_used","typeLabel":"number"},"to_be_paid":{"type":"number","format":"double","isRequired":true,"uniqueKey":"content.order.to_be_paid","typeLabel":"number\u003cdouble>"},"order_items_count":{"type":"integer","isRequired":true,"uniqueKey":"content.order.order_items_count","typeLabel":"integer"},"order_items":{"type":"array","items":{"type":"object","title":"OrderItemRead","required":["promotion_discount_percent","coupon_discount_percent","discount_amount","attributes","associated_options","seller_id","seller_product_id","seller_variant_id","seller_detail","product_id","product_name","product_image_url","product_type","sku","product_slug","variant_slug","variant_id","variant_name","backorder","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"],"properties":{"product_id":{"type":"string","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].product_id","typeLabel":"string"},"product_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].product_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].product_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].product_name","typeLabel":"string | null"},"product_image_url":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].product_image_url.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].product_image_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].product_image_url","typeLabel":"string | null"},"product_type":{"oneOf":[{"type":"string","enum":["physical","digital","bundle",null],"isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].product_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["physical","digital","bundle",null],"isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].product_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].product_type","typeLabel":"enum\u003cstring> | null"},"sku":{"type":"string","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].sku","typeLabel":"string"},"product_slug":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].product_slug.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].product_slug.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].product_slug","typeLabel":"string | null"},"variant_slug":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].variant_slug.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].variant_slug.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].variant_slug","typeLabel":"string | null"},"variant_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].variant_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].variant_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].variant_id","typeLabel":"string | null"},"variant_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].variant_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].variant_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].variant_name","typeLabel":"string | null"},"backorder":{"description":"backorder\n\nIndicates 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":"content.order.order_items.items.[INDEX].backorder","typeLabel":"boolean"},"on_promotion":{"type":"boolean","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].on_promotion","typeLabel":"boolean"},"on_subscription":{"type":"boolean","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].on_subscription","typeLabel":"boolean"},"subscription_plan":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].subscription_plan.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].subscription_plan.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].subscription_plan","typeLabel":"string | null"},"subscription_interval":{"oneOf":[{"type":"integer","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].subscription_interval.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].subscription_interval.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].subscription_interval","typeLabel":"integer | null"},"subscription_frequency":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].subscription_frequency.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].subscription_frequency.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].subscription_frequency","typeLabel":"string | null"},"quantity":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].quantity","typeLabel":"integer"},"free_quantity":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].free_quantity","typeLabel":"integer"},"is_free_item":{"type":"boolean","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].is_free_item","typeLabel":"boolean"},"price_including_tax":{"oneOf":[{"type":"boolean","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].price_including_tax.oneOf.0","typeLabel":"boolean"},{"type":"null","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].price_including_tax.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].price_including_tax","typeLabel":"boolean | null"},"selling_price":{"type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].selling_price","typeLabel":"number\u003cdouble>"},"listing_price":{"type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].listing_price","typeLabel":"number\u003cdouble>"},"selling_price_excluding_tax":{"type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].selling_price_excluding_tax","typeLabel":"number\u003cdouble>"},"promotion_discount_amount":{"type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].promotion_discount_amount","typeLabel":"number\u003cdouble>"},"coupon_discount_amount":{"type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].coupon_discount_amount","typeLabel":"number\u003cdouble>"},"tax_type":{"description":"The tax type used by the product's pricing, such as `GST`.","type":"string","examples":["GST"],"isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].tax_type","typeLabel":"string"},"tax_rate":{"type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].tax_rate","typeLabel":"number\u003cdouble>"},"tax_amount":{"type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].tax_amount","typeLabel":"number\u003cdouble>"},"handling_charge_excluding_tax":{"type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].handling_charge_excluding_tax","typeLabel":"number\u003cdouble>"},"handling_charge_tax_rate":{"type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].handling_charge_tax_rate","typeLabel":"number\u003cdouble>"},"handling_charge_including_tax":{"type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"content.order.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":"content.order.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":"content.order.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":"content.order.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":"content.order.order_items.items.[INDEX].associated_options.oneOf.0.additionalProperties.oneOf.0.value.name","typeLabel":"string"}},"required":["name","hexcode"],"isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].associated_options.oneOf.0.additionalProperties.oneOf.0.value","typeLabel":"object"}},"uniqueKey":"content.order.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":"content.order.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":"content.order.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":"content.order.order_items.items.[INDEX].associated_options.oneOf.0.additionalProperties.oneOf.1.value","typeLabel":"string"}},"uniqueKey":"content.order.order_items.items.[INDEX].associated_options.oneOf.0.additionalProperties.oneOf.1","typeLabel":"SingleSelectOption · object"}],"uniqueKey":"content.order.order_items.items.[INDEX].associated_options.oneOf.0.additionalProperties","typeLabel":"ColorOption · object | SingleSelectOption · object"},"isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].associated_options.oneOf.0","typeLabel":"AssociatedOption · object"},{"type":"null","description":"Null when `variant_id` is null.","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].associated_options.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].associated_options","typeLabel":"AssociatedOption · object | null"},"attributes":{"type":"array","items":{"oneOf":[{"type":"object","title":"ColorAttribute","description":"Attribute for colors","required":["id","name","key","type","value"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].attributes.items.[INDEX].oneOf.0.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].attributes.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":"content.order.order_items.items.[INDEX].attributes.items.[INDEX].oneOf.0.key","typeLabel":"string"},"type":{"type":"string","example":"color","const":"color","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].attributes.items.[INDEX].oneOf.0.type","typeLabel":"string"},"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":"content.order.order_items.items.[INDEX].attributes.items.[INDEX].oneOf.0.value.hexcode","typeLabel":"string\u003ccolor-hex>"},"name":{"type":"string","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].attributes.items.[INDEX].oneOf.0.value.name","typeLabel":"string"}},"required":["name","hexcode"],"isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].attributes.items.[INDEX].oneOf.0.value","typeLabel":"object"}},"uniqueKey":"content.order.order_items.items.[INDEX].attributes.items.[INDEX].oneOf.0","typeLabel":"ColorAttribute · object"},{"type":"object","title":"SingleSelectAttribute","description":"Attribute for single-select values","required":["id","name","key","type","value"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].attributes.items.[INDEX].oneOf.1.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].attributes.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":"content.order.order_items.items.[INDEX].attributes.items.[INDEX].oneOf.1.key","typeLabel":"string"},"type":{"type":"string","example":"single-select","const":"single-select","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].attributes.items.[INDEX].oneOf.1.type","typeLabel":"string"},"value":{"description":"For single-select attributes","type":"string","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].attributes.items.[INDEX].oneOf.1.value","typeLabel":"string"}},"uniqueKey":"content.order.order_items.items.[INDEX].attributes.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":"content.order.order_items.items.[INDEX].attributes.items.[INDEX].oneOf.2.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].attributes.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":"content.order.order_items.items.[INDEX].attributes.items.[INDEX].oneOf.2.key","typeLabel":"string"},"type":{"type":"string","example":"multi-select","const":"multi-select","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].attributes.items.[INDEX].oneOf.2.type","typeLabel":"string"},"value":{"description":"For multi-select attributes","type":"array","items":{"type":"string","uniqueKey":"content.order.order_items.items.[INDEX].attributes.items.[INDEX].oneOf.2.value.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].attributes.items.[INDEX].oneOf.2.value","typeLabel":"string[]"}},"uniqueKey":"content.order.order_items.items.[INDEX].attributes.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":"content.order.order_items.items.[INDEX].attributes.items.[INDEX].oneOf.3.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].attributes.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":"content.order.order_items.items.[INDEX].attributes.items.[INDEX].oneOf.3.key","typeLabel":"string"},"type":{"type":"string","example":"text","const":"text","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].attributes.items.[INDEX].oneOf.3.type","typeLabel":"string"},"value":{"description":"For text attributes","type":"string","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].attributes.items.[INDEX].oneOf.3.value","typeLabel":"string"}},"uniqueKey":"content.order.order_items.items.[INDEX].attributes.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":"content.order.order_items.items.[INDEX].attributes.items.[INDEX].oneOf.4.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].attributes.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":"content.order.order_items.items.[INDEX].attributes.items.[INDEX].oneOf.4.key","typeLabel":"string"},"type":{"type":"string","example":"date","const":"date","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].attributes.items.[INDEX].oneOf.4.type","typeLabel":"string"},"value":{"description":"`YYYY-MM-DD`, optionally followed by ` HH:MM`, ` HH:MM:SS`, or ` HH:MM:SS.ffffff`.","type":"string","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].attributes.items.[INDEX].oneOf.4.value","typeLabel":"string"}},"uniqueKey":"content.order.order_items.items.[INDEX].attributes.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":"content.order.order_items.items.[INDEX].attributes.items.[INDEX].oneOf.5.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].attributes.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":"content.order.order_items.items.[INDEX].attributes.items.[INDEX].oneOf.5.key","typeLabel":"string"},"type":{"type":"string","example":"number","const":"number","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].attributes.items.[INDEX].oneOf.5.type","typeLabel":"string"},"value":{"description":"For numeric attributes","type":"number","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].attributes.items.[INDEX].oneOf.5.value","typeLabel":"number"}},"uniqueKey":"content.order.order_items.items.[INDEX].attributes.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":"content.order.order_items.items.[INDEX].attributes.items.[INDEX].oneOf.6.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].attributes.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":"content.order.order_items.items.[INDEX].attributes.items.[INDEX].oneOf.6.key","typeLabel":"string"},"type":{"type":"string","example":"boolean","const":"boolean","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].attributes.items.[INDEX].oneOf.6.type","typeLabel":"string"},"value":{"description":"For boolean attributes","type":"boolean","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].attributes.items.[INDEX].oneOf.6.value","typeLabel":"boolean"}},"uniqueKey":"content.order.order_items.items.[INDEX].attributes.items.[INDEX].oneOf.6","typeLabel":"BooleanAttribute · object"}],"uniqueKey":"content.order.order_items.items.[INDEX].attributes.items.[INDEX]","typeLabel":"ColorAttribute · object | SingleSelectAttribute · object | MultiSelectAttribute · object | TextAttribute · object | DateAttribute · object | NumberAttribute · object | BooleanAttribute · object"},"isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].attributes","typeLabel":"(ColorAttribute · object | SingleSelectAttribute · object | MultiSelectAttribute · object | TextAttribute · object | DateAttribute · object | NumberAttribute · object | BooleanAttribute · object)[]"},"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":"content.order.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":"content.order.order_items.items.[INDEX].seller_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.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":"content.order.order_items.items.[INDEX].seller_detail.oneOf.0.id","typeLabel":"string"},"trade_name":{"type":"string","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].seller_detail.oneOf.0.trade_name","typeLabel":"string"},"legal_name":{"type":"string","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].seller_detail.oneOf.0.legal_name","typeLabel":"string"},"business_type":{"type":"string","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].seller_detail.oneOf.0.business_type","typeLabel":"string"},"tax_identification_number":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].seller_detail.oneOf.0.tax_identification_number.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].seller_detail.oneOf.0.tax_identification_number.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].seller_detail.oneOf.0.tax_identification_number","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"content.order.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":"content.order.order_items.items.[INDEX].seller_detail.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.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":"content.order.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":"content.order.order_items.items.[INDEX].coupon_discount_percent","typeLabel":"number\u003cdouble>"},"discount_amount":{"description":"Total discount amount for the line ((listing_price - selling_price) * quantity).","type":"number","format":"double","isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].discount_amount","typeLabel":"number\u003cdouble>"},"seller_product_id":{"oneOf":[{"description":"Seller's product ID. Relevant for marketplace stores; `null` otherwise.","type":"string","isRequired":true,"uniqueKey":"content.order.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":"content.order.order_items.items.[INDEX].seller_product_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.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":"content.order.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":"content.order.order_items.items.[INDEX].seller_variant_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.order_items.items.[INDEX].seller_variant_id","typeLabel":"string | null"}},"uniqueKey":"content.order.order_items.items.[INDEX]","typeLabel":"OrderItemRead · object"},"isRequired":true,"uniqueKey":"content.order.order_items","typeLabel":"OrderItemRead · 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/admin-pos/schemas/OrderAddress"},"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":"content.order.billing_address.id","typeLabel":"null"},"first_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.billing_address.first_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.billing_address.first_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.billing_address.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.billing_address.last_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.billing_address.last_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.billing_address.last_name","typeLabel":"string | null"},"business_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.billing_address.business_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.billing_address.business_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.billing_address.business_name","typeLabel":"string | null"},"phone":{"oneOf":[{"description":"10 digit phone number without country code.","type":"string","isRequired":true,"uniqueKey":"content.order.billing_address.phone.oneOf.0","typeLabel":"string"},{"description":"10 digit phone number without country code.","type":"null","isRequired":true,"uniqueKey":"content.order.billing_address.phone.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.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":"content.order.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":"content.order.billing_address.country_code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.billing_address.country_code","typeLabel":"string | null"},"address_line1":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.billing_address.address_line1.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.billing_address.address_line1.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.billing_address.address_line1","typeLabel":"string | null"},"address_line2":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.billing_address.address_line2.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.billing_address.address_line2.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.billing_address.address_line2","typeLabel":"string | null"},"landmark":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.billing_address.landmark.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.billing_address.landmark.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.billing_address.landmark","typeLabel":"string | null"},"pincode":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.billing_address.pincode.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.billing_address.pincode.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.billing_address.pincode","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.billing_address.city.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.billing_address.city.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.billing_address.city","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.billing_address.state.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.billing_address.state.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.billing_address.state","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.billing_address.country.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.billing_address.country.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.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":"content.order.billing_address.gstin.oneOf.0","typeLabel":"string"},{"description":"GSTIN of the business the order was placed for, if given.","type":"null","isRequired":true,"uniqueKey":"content.order.billing_address.gstin.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.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":"content.order.billing_address.tax_identification_number.oneOf.0","typeLabel":"string"},{"description":"Tax Identification Number specific to the country of operation.","type":"null","isRequired":true,"uniqueKey":"content.order.billing_address.tax_identification_number.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.billing_address.tax_identification_number","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.billing_address.email.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.billing_address.email.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.billing_address.email","typeLabel":"string | null"},"is_email_verified":{"type":"boolean","isRequired":true,"uniqueKey":"content.order.billing_address.is_email_verified","typeLabel":"boolean"},"is_phone_verified":{"type":"boolean","isRequired":true,"uniqueKey":"content.order.billing_address.is_phone_verified","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"content.order.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/admin-pos/schemas/OrderAddress"},"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":"content.order.shipping_address.id","typeLabel":"null"},"first_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.shipping_address.first_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.shipping_address.first_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.shipping_address.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.shipping_address.last_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.shipping_address.last_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.shipping_address.last_name","typeLabel":"string | null"},"business_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.shipping_address.business_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.shipping_address.business_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.shipping_address.business_name","typeLabel":"string | null"},"phone":{"oneOf":[{"description":"10 digit phone number without country code.","type":"string","isRequired":true,"uniqueKey":"content.order.shipping_address.phone.oneOf.0","typeLabel":"string"},{"description":"10 digit phone number without country code.","type":"null","isRequired":true,"uniqueKey":"content.order.shipping_address.phone.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.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":"content.order.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":"content.order.shipping_address.country_code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.shipping_address.country_code","typeLabel":"string | null"},"address_line1":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.shipping_address.address_line1.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.shipping_address.address_line1.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.shipping_address.address_line1","typeLabel":"string | null"},"address_line2":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.shipping_address.address_line2.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.shipping_address.address_line2.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.shipping_address.address_line2","typeLabel":"string | null"},"landmark":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.shipping_address.landmark.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.shipping_address.landmark.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.shipping_address.landmark","typeLabel":"string | null"},"pincode":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.shipping_address.pincode.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.shipping_address.pincode.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.shipping_address.pincode","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.shipping_address.city.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.shipping_address.city.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.shipping_address.city","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.shipping_address.state.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.shipping_address.state.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.shipping_address.state","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.shipping_address.country.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.shipping_address.country.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.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":"content.order.shipping_address.gstin.oneOf.0","typeLabel":"string"},{"description":"GSTIN of the business the order was placed for, if given.","type":"null","isRequired":true,"uniqueKey":"content.order.shipping_address.gstin.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.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":"content.order.shipping_address.tax_identification_number.oneOf.0","typeLabel":"string"},{"description":"Tax Identification Number specific to the country of operation.","type":"null","isRequired":true,"uniqueKey":"content.order.shipping_address.tax_identification_number.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.shipping_address.tax_identification_number","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.shipping_address.email.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.shipping_address.email.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.shipping_address.email","typeLabel":"string | null"},"is_email_verified":{"type":"boolean","isRequired":true,"uniqueKey":"content.order.shipping_address.is_email_verified","typeLabel":"boolean"},"is_phone_verified":{"type":"boolean","isRequired":true,"uniqueKey":"content.order.shipping_address.is_phone_verified","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"content.order.shipping_address","typeLabel":"OrderAddress · object"},"currency":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"content.order.currency.name","typeLabel":"string"},"code":{"type":"string","uniqueKey":"content.order.currency.code","typeLabel":"string"},"symbol":{"type":"string","uniqueKey":"content.order.currency.symbol","typeLabel":"string"}},"isRequired":true,"uniqueKey":"content.order.currency","typeLabel":"object"},"metadata":{"oneOf":[{"description":"Additional metadata associated with the order: its point-of-sale details, and the custom metadata given at checkout as further keys.","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","uniqueKey":"content.order.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","uniqueKey":"content.order.metadata.oneOf.0.pos_user_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.order.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","uniqueKey":"content.order.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","uniqueKey":"content.order.metadata.oneOf.0.pos_device_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.order.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","uniqueKey":"content.order.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","uniqueKey":"content.order.metadata.oneOf.0.origin_location_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.order.metadata.oneOf.0.origin_location_id","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"content.order.metadata.oneOf.0","typeLabel":"object"},{"description":"Additional metadata associated with the order: its point-of-sale details, and the custom metadata given at checkout as further keys.","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"}]}},"isRequired":true,"uniqueKey":"content.order.metadata.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.metadata","typeLabel":"object | null"},"is_cancellation_allowed":{"description":"True for non-POS orders in draft, pending, awaiting_approval, schedule_requested or confirmed status.","type":"boolean","isRequired":true,"uniqueKey":"content.order.is_cancellation_allowed","typeLabel":"boolean"},"cancellation_refund_details":{"description":"Breakdown of the refund the customer would receive upon cancellation. Returned even when cancellation is unavailable; check `is_cancellation_allowed` before offering cancellation.","type":"object","properties":{"loyalty_point":{"description":"loyalty point redeemed will be rollbacked and credited to user account.","type":"number","isRequired":true,"uniqueKey":"content.order.cancellation_refund_details.loyalty_point","typeLabel":"number"},"refundable_amount":{"description":"What the customer gets back on cancellation: what the order's payments have left after its earlier refunds, refunds in progress included. Money held for an admin's review isn't included: it is refunded once the review releases it.","type":"number","isRequired":true,"uniqueKey":"content.order.cancellation_refund_details.refundable_amount","typeLabel":"number"},"cancellation_charges":{"description":"amount deducted from paid amount.","type":"number","isRequired":true,"uniqueKey":"content.order.cancellation_refund_details.cancellation_charges","typeLabel":"number"},"cancellation_charges_reason":{"description":"reason for cancellation charges.","type":"string","isRequired":true,"uniqueKey":"content.order.cancellation_refund_details.cancellation_charges_reason","typeLabel":"string"},"payment_mode":{"description":"How the refund is paid: `bank-transfer` to the customer's bank account when a bank transfer (credit balance included) paid the order; `original-payment-mode`, back through the payment gateway, otherwise. A cash or other offline payment is handed back by the store in the way it was paid, in either mode, with no bank account needed for it.","type":"string","enum":["original-payment-mode","bank-transfer"],"isRequired":true,"uniqueKey":"content.order.cancellation_refund_details.payment_mode","typeLabel":"enum\u003cstring>"}},"required":["loyalty_point","refundable_amount","cancellation_charges","cancellation_charges_reason","payment_mode"],"isRequired":true,"uniqueKey":"content.order.cancellation_refund_details","typeLabel":"object"},"feedback":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.feedback.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.feedback.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.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":"content.order.cart_id.oneOf.0","typeLabel":"string"},{"description":"ULID of the cart this order was created from. `null` if unavailable.","type":"null","isRequired":true,"uniqueKey":"content.order.cart_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.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":"content.order.coupon_id.oneOf.0","typeLabel":"string"},{"description":"ID of the applied coupon. `null` when no coupon is applied.","type":"null","isRequired":true,"uniqueKey":"content.order.coupon_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.coupon_id","typeLabel":"string | null"},"cancellation_reason":{"oneOf":[{"description":"Reason the order was cancelled. `null` when not cancelled.","type":"string","isRequired":true,"uniqueKey":"content.order.cancellation_reason.oneOf.0","typeLabel":"string"},{"description":"Reason the order was cancelled. `null` when not cancelled.","type":"null","isRequired":true,"uniqueKey":"content.order.cancellation_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.cancellation_reason","typeLabel":"string | null"},"shipping_provider_id":{"oneOf":[{"description":"Order-level shipping provider ID. `null` until resolved.","type":"string","isRequired":true,"uniqueKey":"content.order.shipping_provider_id.oneOf.0","typeLabel":"string"},{"description":"Order-level shipping provider ID. `null` until resolved.","type":"null","isRequired":true,"uniqueKey":"content.order.shipping_provider_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.shipping_provider_id","typeLabel":"string | null"},"courier_company_id":{"oneOf":[{"description":"Order-level courier company ID. `null` until resolved.","type":"string","isRequired":true,"uniqueKey":"content.order.courier_company_id.oneOf.0","typeLabel":"string"},{"description":"Order-level courier company ID. `null` until resolved.","type":"null","isRequired":true,"uniqueKey":"content.order.courier_company_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.courier_company_id","typeLabel":"string | null"},"shipping_provider_name":{"oneOf":[{"description":"Order-level shipping provider name. Currently always `null` (resolved per shipment under `shipments[]`).","type":"string","isRequired":true,"uniqueKey":"content.order.shipping_provider_name.oneOf.0","typeLabel":"string"},{"description":"Order-level shipping provider name. Currently always `null` (resolved per shipment under `shipments[]`).","type":"null","isRequired":true,"uniqueKey":"content.order.shipping_provider_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.shipping_provider_name","typeLabel":"string | null"},"courier_company_name":{"oneOf":[{"description":"Order-level courier company name. Currently always `null` (resolved per shipment under `shipments[]`).","type":"string","isRequired":true,"uniqueKey":"content.order.courier_company_name.oneOf.0","typeLabel":"string"},{"description":"Order-level courier company name. Currently always `null` (resolved per shipment under `shipments[]`).","type":"null","isRequired":true,"uniqueKey":"content.order.courier_company_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.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":"content.order.fulfillment_type","typeLabel":"string"},"items_tax_amount":{"description":"Total tax amount for the order items (same concept as the legacy `item_total_tax`).","type":"number","format":"double","minimum":0,"isRequired":true,"uniqueKey":"content.order.items_tax_amount","typeLabel":"number\u003cdouble>"},"loyalty_point_eligible_amount":{"description":"Order amount eligible for loyalty-point earning.","type":"number","isRequired":true,"uniqueKey":"content.order.loyalty_point_eligible_amount","typeLabel":"number"},"sales_channel":{"description":"The sales channel the order belongs to.","type":"object","properties":{"id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.sales_channel.id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.sales_channel.id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.sales_channel.id","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.sales_channel.name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.sales_channel.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.sales_channel.name","typeLabel":"string | null"},"type":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.sales_channel.type.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.sales_channel.type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.sales_channel.type","typeLabel":"string | null"}},"required":["id","name","type"],"isRequired":true,"uniqueKey":"content.order.sales_channel","typeLabel":"object"},"created_at":{"description":"Creation timestamp (ISO-8601).","type":"string","format":"date-time","isRequired":true,"uniqueKey":"content.order.created_at","typeLabel":"string\u003cdate-time>"},"modified_at":{"description":"Last-modification timestamp (ISO-8601).","type":"string","format":"date-time","isRequired":true,"uniqueKey":"content.order.modified_at","typeLabel":"string\u003cdate-time>"},"shipments":{"type":"array","items":{"title":"OrderShipment","description":"Order shipment model","type":"object","externalDocs":{"url":"https://llm-docs.commercengine.io/admin-pos/schemas/OrderShipment"},"required":["reference_number","status","total_weight","total_boxes","shipment_items_count","shipment_items","shipping_amount","shipping_tax_amount","shipping_amount_including_tax","courier_company_name","shipping_label_url","awb_no","tracking_url","eta_delivery","shipped_date","delivered_date","is_return_allowed","cancellation_reason","created_at","modified_at","shipping_estimated_cost","shipping_tax_rate","shipping_discount_amount","courier_company_id","shipping_provider_id","shipping_provider_name","promised_delivery_date","estimated_delivery_date","out_for_delivery_date","fulfillment_type","seller_id","seller_detail"],"properties":{"reference_number":{"type":"string","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].reference_number","typeLabel":"string"},"status":{"type":"string","externalDocs":{"url":"https://llm-docs.commercengine.io/admin-pos/schemas/ShipmentStatus"},"enum":["unscheduled","schedule_requested","scheduled","packed","shipped","in_transit","out_for_delivery","delivery_attempted","undelivered","return_to_origin","delivered","cancelled","ready_to_collect","sent_to_store","processing","lost"],"isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"total_weight":{"type":"number","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].total_weight","typeLabel":"number"},"total_boxes":{"oneOf":[{"type":"integer","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].total_boxes.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].total_boxes.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].total_boxes","typeLabel":"integer | null"},"shipment_items_count":{"type":"integer","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].shipment_items_count","typeLabel":"integer"},"shipment_items":{"type":"array","items":{"title":"OrderShipmentItem","description":"A line in an order shipment.","type":"object","externalDocs":{"url":"https://llm-docs.commercengine.io/admin-pos/schemas/OrderShipmentItem"},"required":["allowed_return_quantity","product_id","product_name","product_image_url","variant_id","variant_name","quantity","free_quantity","is_free_item"],"properties":{"product_id":{"type":"string","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].shipment_items.items.[INDEX].product_id","typeLabel":"string"},"product_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].shipment_items.items.[INDEX].product_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].shipment_items.items.[INDEX].product_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].shipment_items.items.[INDEX].product_name","typeLabel":"string | null"},"product_image_url":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].shipment_items.items.[INDEX].product_image_url.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].shipment_items.items.[INDEX].product_image_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].shipment_items.items.[INDEX].product_image_url","typeLabel":"string | null"},"variant_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].shipment_items.items.[INDEX].variant_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].shipment_items.items.[INDEX].variant_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].shipment_items.items.[INDEX].variant_id","typeLabel":"string | null"},"variant_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].shipment_items.items.[INDEX].variant_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].shipment_items.items.[INDEX].variant_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].shipment_items.items.[INDEX].variant_name","typeLabel":"string | null"},"quantity":{"type":"integer","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].shipment_items.items.[INDEX].quantity","typeLabel":"integer"},"free_quantity":{"type":"integer","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].shipment_items.items.[INDEX].free_quantity","typeLabel":"integer"},"is_free_item":{"type":"boolean","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].shipment_items.items.[INDEX].is_free_item","typeLabel":"boolean"},"allowed_return_quantity":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].shipment_items.items.[INDEX].allowed_return_quantity","typeLabel":"integer"}},"uniqueKey":"content.order.shipments.items.[INDEX].shipment_items.items.[INDEX]","typeLabel":"OrderShipmentItem · object"},"isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].shipment_items","typeLabel":"OrderShipmentItem · object[]"},"shipping_amount":{"type":"number","format":"double","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].shipping_amount","typeLabel":"number\u003cdouble>"},"shipping_tax_amount":{"type":"number","format":"double","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].shipping_tax_amount","typeLabel":"number\u003cdouble>"},"shipping_amount_including_tax":{"type":"number","format":"double","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].shipping_amount_including_tax","typeLabel":"number\u003cdouble>"},"courier_company_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].courier_company_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].courier_company_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].courier_company_name","typeLabel":"string | null"},"shipping_label_url":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].shipping_label_url.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].shipping_label_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].shipping_label_url","typeLabel":"string | null"},"awb_no":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].awb_no.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].awb_no.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].awb_no","typeLabel":"string | null"},"tracking_url":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].tracking_url.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].tracking_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].tracking_url","typeLabel":"string | null"},"eta_delivery":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].eta_delivery.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].eta_delivery.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].eta_delivery","typeLabel":"string | null"},"shipped_date":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].shipped_date.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].shipped_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].shipped_date","typeLabel":"string\u003cdate-time> | null"},"delivered_date":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].delivered_date.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].delivered_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].delivered_date","typeLabel":"string\u003cdate-time> | null"},"is_return_allowed":{"type":"boolean","default":false,"isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].is_return_allowed","typeLabel":"boolean"},"cancellation_reason":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].cancellation_reason.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].cancellation_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].cancellation_reason","typeLabel":"string | null"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"modified_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].modified_at","typeLabel":"string\u003cdate-time>"},"shipping_estimated_cost":{"type":"number","format":"double","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].shipping_estimated_cost","typeLabel":"number\u003cdouble>"},"shipping_tax_rate":{"type":"number","format":"double","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].shipping_tax_rate","typeLabel":"number\u003cdouble>"},"shipping_discount_amount":{"type":"number","format":"double","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].shipping_discount_amount","typeLabel":"number\u003cdouble>"},"courier_company_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].courier_company_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].courier_company_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].courier_company_id","typeLabel":"string | null"},"shipping_provider_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].shipping_provider_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].shipping_provider_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].shipping_provider_id","typeLabel":"string | null"},"shipping_provider_name":{"oneOf":[{"description":"Shipping provider (courier aggregator) name.","type":"string","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].shipping_provider_name.oneOf.0","typeLabel":"string"},{"description":"Shipping provider (courier aggregator) name.","type":"null","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].shipping_provider_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].shipping_provider_name","typeLabel":"string | null"},"promised_delivery_date":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].promised_delivery_date.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].promised_delivery_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].promised_delivery_date","typeLabel":"string\u003cdate-time> | null"},"estimated_delivery_date":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].estimated_delivery_date.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].estimated_delivery_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].estimated_delivery_date","typeLabel":"string\u003cdate-time> | null"},"out_for_delivery_date":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].out_for_delivery_date.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].out_for_delivery_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].out_for_delivery_date","typeLabel":"string\u003cdate-time> | null"},"fulfillment_type":{"description":"Fulfillment type for the shipment (e.g. `delivery`, `collect-in-store`).","type":"string","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].fulfillment_type","typeLabel":"string"},"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":"content.order.shipments.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":"content.order.shipments.items.[INDEX].seller_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].seller_id","typeLabel":"string | null"},"seller_detail":{"oneOf":[{"type":"object","title":"SellerInfo","description":"Seller detail information. This field is relevant for marketplace type stores only. Will return null for b2b and b2c type stores.","required":["id","trade_name","legal_name","business_type","tax_identification_number"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].seller_detail.oneOf.0.id","typeLabel":"string"},"trade_name":{"type":"string","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].seller_detail.oneOf.0.trade_name","typeLabel":"string"},"legal_name":{"type":"string","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].seller_detail.oneOf.0.legal_name","typeLabel":"string"},"business_type":{"type":"string","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].seller_detail.oneOf.0.business_type","typeLabel":"string"},"tax_identification_number":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].seller_detail.oneOf.0.tax_identification_number.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].seller_detail.oneOf.0.tax_identification_number.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].seller_detail.oneOf.0.tax_identification_number","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].seller_detail.oneOf.0","typeLabel":"SellerInfo · object"},{"type":"null","description":"Seller detail information. This field is relevant for marketplace type stores only. Will return null for b2b and b2c type stores.","isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].seller_detail.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.order.shipments.items.[INDEX].seller_detail","typeLabel":"SellerInfo · object | null"}},"uniqueKey":"content.order.shipments.items.[INDEX]","typeLabel":"OrderShipment · object"},"isRequired":true,"uniqueKey":"content.order.shipments","typeLabel":"OrderShipment · object[]"}},"isRequired":true,"uniqueKey":"content.order","typeLabel":"Order · object"},"payment_required":{"description":"`true` when something is left to pay after the customer's loyalty points, credit balance and discounts; `false` when they pay the whole order.","type":"boolean","isRequired":true,"uniqueKey":"content.payment_required","typeLabel":"boolean"},"payment_info":{"oneOf":[{"type":"object","title":"JusPayHyperCheckoutResponse","description":"Gateway initiation details when an auto payment method is used and something is left to pay; otherwise `null`. Always `null` when `payment_required` is `false`.","properties":{"id":{"type":"string","uniqueKey":"content.payment_info.oneOf.0.id","typeLabel":"string"},"status":{"type":"string","uniqueKey":"content.payment_info.oneOf.0.status","typeLabel":"string"},"order_id":{"type":"string","uniqueKey":"content.payment_info.oneOf.0.order_id","typeLabel":"string"},"payment_links":{"type":"object","properties":{"web":{"type":"string","uniqueKey":"content.payment_info.oneOf.0.payment_links.web","typeLabel":"string"},"expiry":{"oneOf":[{"type":"string","uniqueKey":"content.payment_info.oneOf.0.payment_links.expiry.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"content.payment_info.oneOf.0.payment_links.expiry.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.payment_info.oneOf.0.payment_links.expiry","typeLabel":"string | null"}},"uniqueKey":"content.payment_info.oneOf.0.payment_links","typeLabel":"object"},"sdk_payload":{"type":"object","properties":{"requestId":{"type":"string","uniqueKey":"content.payment_info.oneOf.0.sdk_payload.requestId","typeLabel":"string"},"service":{"type":"string","uniqueKey":"content.payment_info.oneOf.0.sdk_payload.service","typeLabel":"string"},"payload":{"type":"object","properties":{"clientId":{"type":"string","uniqueKey":"content.payment_info.oneOf.0.sdk_payload.payload.clientId","typeLabel":"string"},"merchantId":{"type":"string","uniqueKey":"content.payment_info.oneOf.0.sdk_payload.payload.merchantId","typeLabel":"string"},"clientAuthToken":{"type":"string","uniqueKey":"content.payment_info.oneOf.0.sdk_payload.payload.clientAuthToken","typeLabel":"string"},"clientAuthTokenExpiry":{"type":"string","uniqueKey":"content.payment_info.oneOf.0.sdk_payload.payload.clientAuthTokenExpiry","typeLabel":"string"},"environment":{"type":"string","uniqueKey":"content.payment_info.oneOf.0.sdk_payload.payload.environment","typeLabel":"string"},"orderId":{"type":"string","uniqueKey":"content.payment_info.oneOf.0.sdk_payload.payload.orderId","typeLabel":"string"},"amount":{"type":"string","uniqueKey":"content.payment_info.oneOf.0.sdk_payload.payload.amount","typeLabel":"string"},"action":{"type":"string","uniqueKey":"content.payment_info.oneOf.0.sdk_payload.payload.action","typeLabel":"string"},"customerId":{"type":"string","uniqueKey":"content.payment_info.oneOf.0.sdk_payload.payload.customerId","typeLabel":"string"},"firstName":{"type":"string","uniqueKey":"content.payment_info.oneOf.0.sdk_payload.payload.firstName","typeLabel":"string"},"lastName":{"type":"string","uniqueKey":"content.payment_info.oneOf.0.sdk_payload.payload.lastName","typeLabel":"string"},"returnUrl":{"type":"string","uniqueKey":"content.payment_info.oneOf.0.sdk_payload.payload.returnUrl","typeLabel":"string"},"customerPhone":{"type":"string","uniqueKey":"content.payment_info.oneOf.0.sdk_payload.payload.customerPhone","typeLabel":"string"},"customerEmail":{"type":"string","uniqueKey":"content.payment_info.oneOf.0.sdk_payload.payload.customerEmail","typeLabel":"string"},"currency":{"type":"string","uniqueKey":"content.payment_info.oneOf.0.sdk_payload.payload.currency","typeLabel":"string"},"description":{"type":"string","uniqueKey":"content.payment_info.oneOf.0.sdk_payload.payload.description","typeLabel":"string"},"options.createMandate":{"description":"Use for taking consent of subscription payments. If this key is used it will ask user to give consent for subscription payment.\n","const":"REQUIRED","uniqueKey":"content.payment_info.oneOf.0.sdk_payload.payload.options\\.createMandate","typeLabel":"any"},"mandate.maxAmount":{"description":"Maximum amount that can be charged in recurring payment.","type":"string","uniqueKey":"content.payment_info.oneOf.0.sdk_payload.payload.mandate\\.maxAmount","typeLabel":"string"},"mandate.start_date ":{"description":"subscription start time","type":"string","uniqueKey":"content.payment_info.oneOf.0.sdk_payload.payload.mandate\\.start_date ","typeLabel":"string"},"mandate.end_date ":{"description":"subscription end time","type":"string","uniqueKey":"content.payment_info.oneOf.0.sdk_payload.payload.mandate\\.end_date ","typeLabel":"string"},"mandate.frequency":{"description":"subscription frequency","const":"MONTHLY","uniqueKey":"content.payment_info.oneOf.0.sdk_payload.payload.mandate\\.frequency","typeLabel":"any"},"mandate.rule_value ":{"description":"When frequency is passed as WEEKLY, FORTNIGHTLY, MONTHLY, BIMONTHLY, QUARTERLY, HALFYEARLY, or YEARLY then is it required that the exact day of the period should be passed.\n\n1-7 when frequency is WEEKLY. In weekly, serial numbers start from Monday. Monday represents 1 and Sunday represents 7.\n\n1-16 when frequency is FORTNIGHTLY. This mandate is executed twice a month. First day of the month is represented by value '1' and ends with '15' on 15th day of the month. Then again starts with '1' for 16th of the month and ends with the last day of the month.\n\n1-31 when frequency is MONTHLY, BIMONTHLY, QUARTERLY, HALFYEARLY, or YEARLY.","type":"string","enum":["1-7","1-16","1-31"],"uniqueKey":"content.payment_info.oneOf.0.sdk_payload.payload.mandate\\.rule_value ","typeLabel":"enum\u003cstring>"}},"uniqueKey":"content.payment_info.oneOf.0.sdk_payload.payload","typeLabel":"object"}},"uniqueKey":"content.payment_info.oneOf.0.sdk_payload","typeLabel":"object"},"order_expiry":{"type":"string","format":"date-time","uniqueKey":"content.payment_info.oneOf.0.order_expiry","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"content.payment_info.oneOf.0","typeLabel":"JusPayHyperCheckoutResponse · object"},{"type":"object","title":"JusPayExpressCheckoutResponse","description":"Gateway initiation details when an auto payment method is used and something is left to pay; otherwise `null`. Always `null` when `payment_required` is `false`.","required":["txn_id","txn_uuid","status","order_id","payment"],"properties":{"txn_id":{"description":"The transaction ID of the payment.","type":"string","isRequired":true,"uniqueKey":"content.payment_info.oneOf.1.txn_id","typeLabel":"string"},"txn_uuid":{"description":"The transaction UUID of the payment.","type":"string","isRequired":true,"uniqueKey":"content.payment_info.oneOf.1.txn_uuid","typeLabel":"string"},"status":{"description":"The status of the payment.","type":"string","isRequired":true,"uniqueKey":"content.payment_info.oneOf.1.status","typeLabel":"string"},"order_id":{"description":"The order ID of the payment.","type":"string","isRequired":true,"uniqueKey":"content.payment_info.oneOf.1.order_id","typeLabel":"string"},"payment":{"type":"object","properties":{"sdk_params":{"type":"object","properties":{"tr":{"type":"string","uniqueKey":"content.payment_info.oneOf.1.payment.sdk_params.tr","typeLabel":"string"},"merchant_vpa":{"type":"string","uniqueKey":"content.payment_info.oneOf.1.payment.sdk_params.merchant_vpa","typeLabel":"string"},"customer_last_name":{"type":"string","uniqueKey":"content.payment_info.oneOf.1.payment.sdk_params.customer_last_name","typeLabel":"string"},"merchant_name":{"type":"string","uniqueKey":"content.payment_info.oneOf.1.payment.sdk_params.merchant_name","typeLabel":"string"},"pg_intent_url":{"description":"The UPI intent URL of the payment. This URL is used to redirect the customer to the UPI app for payment.","type":"string","uniqueKey":"content.payment_info.oneOf.1.payment.sdk_params.pg_intent_url","typeLabel":"string"},"amount":{"type":"string","uniqueKey":"content.payment_info.oneOf.1.payment.sdk_params.amount","typeLabel":"string"},"tid":{"type":"string","uniqueKey":"content.payment_info.oneOf.1.payment.sdk_params.tid","typeLabel":"string"},"customer_first_name":{"type":"string","uniqueKey":"content.payment_info.oneOf.1.payment.sdk_params.customer_first_name","typeLabel":"string"}},"uniqueKey":"content.payment_info.oneOf.1.payment.sdk_params","typeLabel":"object"},"authentication":{"type":"object","properties":{"method":{"type":"string","const":"GET","isRequired":true,"uniqueKey":"content.payment_info.oneOf.1.payment.authentication.method","typeLabel":"string"},"url":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"content.payment_info.oneOf.1.payment.authentication.url","typeLabel":"string\u003curi>"},"params":{"description":"Available only when Direct OTP is enabled for the card; otherwise this object is absent.","type":"object","properties":{"card_issuer_bank_name":{"type":"string","uniqueKey":"content.payment_info.oneOf.1.payment.authentication.params.card_issuer_bank_name","typeLabel":"string"},"id":{"description":"This field is used as txn_id in Verify Direct OTP and Resend Direct OTP endpoints payload.","type":"string","uniqueKey":"content.payment_info.oneOf.1.payment.authentication.params.id","typeLabel":"string"},"fallback_url":{"type":"string","uniqueKey":"content.payment_info.oneOf.1.payment.authentication.params.fallback_url","typeLabel":"string"},"challenge_id":{"description":"This field is required in Verify Direct OTP and Resend Direct OTP endpoints.","type":"string","uniqueKey":"content.payment_info.oneOf.1.payment.authentication.params.challenge_id","typeLabel":"string"},"resend_otp_allowed":{"description":"This field is used to decide whether API request can be sent to Resend OTP API or not.","type":"boolean","uniqueKey":"content.payment_info.oneOf.1.payment.authentication.params.resend_otp_allowed","typeLabel":"boolean"},"auth_type":{"type":"string","uniqueKey":"content.payment_info.oneOf.1.payment.authentication.params.auth_type","typeLabel":"string"},"submit_otp_allowed":{"description":"This field is used to decide whether OTP can be verified using Authenticate Direct OTP API or not.","type":"boolean","uniqueKey":"content.payment_info.oneOf.1.payment.authentication.params.submit_otp_allowed","typeLabel":"boolean"},"card_isin":{"type":"string","uniqueKey":"content.payment_info.oneOf.1.payment.authentication.params.card_isin","typeLabel":"string"}},"uniqueKey":"content.payment_info.oneOf.1.payment.authentication.params","typeLabel":"object"}},"required":["method","url"],"uniqueKey":"content.payment_info.oneOf.1.payment.authentication","typeLabel":"object"}},"isRequired":true,"uniqueKey":"content.payment_info.oneOf.1.payment","typeLabel":"object"},"juspay":{"type":"object","properties":{"client_auth_token":{"type":"string","uniqueKey":"content.payment_info.oneOf.1.juspay.client_auth_token","typeLabel":"string"},"client_auth_token_expiry":{"type":"string","uniqueKey":"content.payment_info.oneOf.1.juspay.client_auth_token_expiry","typeLabel":"string"}},"uniqueKey":"content.payment_info.oneOf.1.juspay","typeLabel":"object"},"offer_details":{"type":"object","properties":{"offers":{"type":"array","items":{"type":"object","uniqueKey":"content.payment_info.oneOf.1.offer_details.offers.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"content.payment_info.oneOf.1.offer_details.offers","typeLabel":"object[]"}},"required":["offers"],"uniqueKey":"content.payment_info.oneOf.1.offer_details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"content.payment_info.oneOf.1","typeLabel":"JusPayExpressCheckoutResponse · object"},{"type":"null","description":"Gateway initiation details when an auto payment method is used and something is left to pay; otherwise `null`. Always `null` when `payment_required` is `false`.","isRequired":true,"uniqueKey":"content.payment_info.oneOf.2","typeLabel":"null"},{"type":"object","title":"PayuPaymentInfo","description":"Gateway initiation details when an auto payment method is used and something is left to pay; otherwise `null`. Always `null` when `payment_required` is `false`.","required":["key","txnid","amount","productinfo","firstname","email","phone","furl","surl","hash"],"properties":{"key":{"type":"string","isRequired":true,"uniqueKey":"content.payment_info.oneOf.3.key","typeLabel":"string"},"txnid":{"type":"string","isRequired":true,"uniqueKey":"content.payment_info.oneOf.3.txnid","typeLabel":"string"},"amount":{"description":"Payment amount as a decimal string with two fractional digits.","type":"string","isRequired":true,"uniqueKey":"content.payment_info.oneOf.3.amount","typeLabel":"string"},"productinfo":{"type":"string","isRequired":true,"uniqueKey":"content.payment_info.oneOf.3.productinfo","typeLabel":"string"},"firstname":{"oneOf":[{"description":"The billing first name, or null when the order has no billing address (a till sale without one).","type":"string","isRequired":true,"uniqueKey":"content.payment_info.oneOf.3.firstname.oneOf.0","typeLabel":"string"},{"description":"The billing first name, or null when the order has no billing address (a till sale without one).","type":"null","isRequired":true,"uniqueKey":"content.payment_info.oneOf.3.firstname.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.payment_info.oneOf.3.firstname","typeLabel":"string | null"},"email":{"oneOf":[{"description":"The billing email, or null when the order has no billing address (a till sale without one).","type":"string","isRequired":true,"uniqueKey":"content.payment_info.oneOf.3.email.oneOf.0","typeLabel":"string"},{"description":"The billing email, or null when the order has no billing address (a till sale without one).","type":"null","isRequired":true,"uniqueKey":"content.payment_info.oneOf.3.email.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.payment_info.oneOf.3.email","typeLabel":"string | null"},"phone":{"oneOf":[{"description":"The billing phone, or null when the order has no billing address (a till sale without one).","type":"string","isRequired":true,"uniqueKey":"content.payment_info.oneOf.3.phone.oneOf.0","typeLabel":"string"},{"description":"The billing phone, or null when the order has no billing address (a till sale without one).","type":"null","isRequired":true,"uniqueKey":"content.payment_info.oneOf.3.phone.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.payment_info.oneOf.3.phone","typeLabel":"string | null"},"furl":{"description":"return url in case of payment failure.","type":"string","isRequired":true,"uniqueKey":"content.payment_info.oneOf.3.furl","typeLabel":"string"},"surl":{"description":"return url in case of payment success.","type":"string","isRequired":true,"uniqueKey":"content.payment_info.oneOf.3.surl","typeLabel":"string"},"hash":{"type":"string","isRequired":true,"uniqueKey":"content.payment_info.oneOf.3.hash","typeLabel":"string"},"lastname":{"type":"string","uniqueKey":"content.payment_info.oneOf.3.lastname","typeLabel":"string"},"si":{"description":"To be used in case we want to take consent for subscription payment.\nTo create consent for subscription, value of this parameter must be 1.","type":"integer","const":1,"uniqueKey":"content.payment_info.oneOf.3.si","typeLabel":"integer"},"si_details":{"description":"JSON-encoded subscription consent. Contains `billingAmount` as a decimal string, `billingCurrency` `INR`, `billingCycle` `ADHOC`, and `paymentStartDate` and `paymentEndDate` as dates. Pass this string unchanged with the payment.","type":"string","contentMediaType":"application/json","uniqueKey":"content.payment_info.oneOf.3.si_details","typeLabel":"string"}},"isRequired":true,"uniqueKey":"content.payment_info.oneOf.3","typeLabel":"PayuPaymentInfo · object"}],"isRequired":true,"uniqueKey":"content.payment_info","typeLabel":"JusPayHyperCheckoutResponse · object | JusPayExpressCheckoutResponse · object | null | PayuPaymentInfo · object"}},"required":["order","payment_required","payment_info"],"type":"object","isRequired":true,"uniqueKey":"content","typeLabel":"object"},"events":{"description":"Analytics events to emit for the change this request made, each with a server-issued `event_id`. Replay them to your analytics destinations so your client-side and server-side copies of the same action dedupe. Empty when the request produced no analytics event.","type":"array","items":{"title":"OrderCreatedEvent","description":"Emitted when an order is placed, on every channel including POS.","type":"object","externalDocs":{"url":"https://llm-docs.commercengine.io/admin-pos/schemas/OrderCreatedEvent"},"required":["event","event_id","order_number","cart_id"],"properties":{"event":{"type":"string","const":"Order Created","isRequired":true,"uniqueKey":"events.items.[INDEX].event","typeLabel":"string"},"event_id":{"description":"Server-issued event id (ULID). Send it with your client-side copy of this event so both copies dedupe.","type":"string","pattern":"^[0-7][0-9A-HJKMNP-TV-Z]{25}$","isRequired":true,"uniqueKey":"events.items.[INDEX].event_id","typeLabel":"string"},"order_number":{"description":"The `Order` that was created.","type":"string","isRequired":true,"uniqueKey":"events.items.[INDEX].order_number","typeLabel":"string"},"cart_id":{"oneOf":[{"description":"The cart the order was created from, or `null` when it did not originate from a cart.","type":"string","isRequired":true,"uniqueKey":"events.items.[INDEX].cart_id.oneOf.0","typeLabel":"string"},{"description":"The cart the order was created from, or `null` when it did not originate from a cart.","type":"null","isRequired":true,"uniqueKey":"events.items.[INDEX].cart_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"events.items.[INDEX].cart_id","typeLabel":"string | null"}},"uniqueKey":"events.items.[INDEX]","typeLabel":"OrderCreatedEvent · object"},"isRequired":true,"uniqueKey":"events","typeLabel":"OrderCreatedEvent · object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","success":true,"content":{"order":{"order_number":"\u003cstring>","order_date":"2023-11-07T05:31:56Z","status":"draft","payment_status":"pending","payment_success_date":"2023-11-07T05:31:56Z","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>","promotion_type":"discount","savings":123,"product_id":"\u003cstring>","variant_id":"\u003cstring>","product_name":"\u003cstring>","variant_name":"\u003cstring>","applied_sequence":123,"scope":"\u003cstring>"}],"applied_coupons":[{"coupon_id":"\u003cstring>","coupon_type":"discount","savings":123,"product_id":"\u003cstring>","variant_id":"\u003cstring>","product_name":"\u003cstring>","variant_name":"\u003cstring>"}],"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,"fulfillment_preference":{"fulfillment_type":"collect-in-store","preference_type":"user","pickup_location_id":"\u003cstring>","pickup_location_name":"\u003cstring>"},"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>","product_type":"physical","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":{"hexcode":"\u003cstring>","name":"\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,"discount_amount":123,"seller_product_id":"\u003cstring>","seller_variant_id":"\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>"},"is_cancellation_allowed":true,"cancellation_refund_details":{"loyalty_point":123,"refundable_amount":123,"cancellation_charges":123,"cancellation_charges_reason":"\u003cstring>","payment_mode":"original-payment-mode"},"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>","name":"\u003cstring>","type":"\u003cstring>"},"created_at":"2023-11-07T05:31:56Z","modified_at":"2023-11-07T05:31:56Z","shipments":[{"reference_number":"\u003cstring>","status":"unscheduled","total_weight":123,"total_boxes":123,"shipment_items_count":123,"shipment_items":[{"product_id":"\u003cstring>","product_name":"\u003cstring>","product_image_url":"\u003cstring>","variant_id":"\u003cstring>","variant_name":"\u003cstring>","quantity":123,"free_quantity":123,"is_free_item":true,"allowed_return_quantity":1}],"shipping_amount":123,"shipping_tax_amount":123,"shipping_amount_including_tax":123,"courier_company_name":"\u003cstring>","shipping_label_url":"\u003cstring>","awb_no":"\u003cstring>","tracking_url":"\u003cstring>","eta_delivery":"\u003cstring>","shipped_date":"2023-11-07T05:31:56Z","delivered_date":"2023-11-07T05:31:56Z","is_return_allowed":false,"cancellation_reason":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","modified_at":"2023-11-07T05:31:56Z","shipping_estimated_cost":123,"shipping_tax_rate":123,"shipping_discount_amount":123,"courier_company_id":"\u003cstring>","shipping_provider_id":"\u003cstring>","shipping_provider_name":"\u003cstring>","promised_delivery_date":"2023-11-07T05:31:56Z","estimated_delivery_date":"2023-11-07T05:31:56Z","out_for_delivery_date":"2023-11-07T05:31:56Z","fulfillment_type":"\u003cstring>","seller_id":"\u003cstring>","seller_detail":{"id":"\u003cstring>","trade_name":"\u003cstring>","legal_name":"\u003cstring>","business_type":"\u003cstring>","tax_identification_number":"\u003cstring>"}}]},"payment_required":true,"payment_info":{"id":"\u003cstring>","status":"\u003cstring>","order_id":"\u003cstring>","payment_links":{"web":"\u003cstring>","expiry":"\u003cstring>"},"sdk_payload":{"requestId":"\u003cstring>","service":"\u003cstring>","payload":{"clientId":"\u003cstring>","merchantId":"\u003cstring>","clientAuthToken":"\u003cstring>","clientAuthTokenExpiry":"\u003cstring>","environment":"\u003cstring>","orderId":"\u003cstring>","amount":"\u003cstring>","action":"\u003cstring>","customerId":"\u003cstring>","firstName":"\u003cstring>","lastName":"\u003cstring>","returnUrl":"\u003cstring>","customerPhone":"\u003cstring>","customerEmail":"\u003cstring>","currency":"\u003cstring>","description":"\u003cstring>","options.createMandate":"REQUIRED","mandate.maxAmount":"\u003cstring>","mandate.start_date ":"\u003cstring>","mandate.end_date ":"\u003cstring>","mandate.frequency":"MONTHLY","mandate.rule_value ":"1-7"}},"order_expiry":"2023-11-07T05:31:56Z"}},"events":[{"event":"Order Created","event_id":"\u003cstring>","order_number":"\u003cstring>","cart_id":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"17237cb0-d65e-4188-879d-ca4f48e7d9c1":{"description":"Invalid cart, payment method or device. The device must exist and belong to the session location.","content":{"application/json":{"schema":{"type":"object","required":["message","success","code"],"properties":{"message":{"type":"string","x-speakeasy-error-message":true,"isRequired":true,"uniqueKey":"message","typeLabel":"string"},"success":{"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"errors":{"type":"object","uniqueKey":"errors","typeLabel":"object"},"details":{"type":"string","uniqueKey":"details","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","success":true,"code":"\u003cstring>","errors":{},"details":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"2d85141a-2766-4b57-a967-e195998dc30d":{"description":"Authentication failed. Codes include `token-required`, `token-expired` and `token_not_valid` for an invalid or expired token.","content":{"application/json":{"schema":{"type":"object","required":["message","success","code"],"properties":{"message":{"type":"string","examples":["Not authorized for given operation on the Resource."],"x-speakeasy-error-message":true,"isRequired":true,"uniqueKey":"message","typeLabel":"string"},"success":{"type":"boolean","default":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"code":{"type":"string","examples":["unauthorized"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"details":{"type":"string","uniqueKey":"details","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Not authorized for given operation on the Resource.","success":false,"code":"unauthorized","details":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"0d7c379e-dc5a-43e0-8ef8-33eea1935079":{"description":"Access denied. `token-required` requires an authenticated session; `permission-denied` means the caller cannot access this resource. On POS, `session-expired` requires signing in again.","content":{"application/json":{"schema":{"type":"object","required":["code","message","success"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","x-speakeasy-error-message":true,"isRequired":true,"uniqueKey":"message","typeLabel":"string"},"success":{"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"details":{"type":"string","uniqueKey":"details","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","message":"\u003cstring>","success":true,"details":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"17222cec-8c1b-43e8-a599-903630dd7cb7":{"description":"The active cart or requested order was not found.","content":{"application/json":{"schema":{"type":"object","required":["message","success","code"],"properties":{"message":{"type":"string","x-speakeasy-error-message":true,"isRequired":true,"uniqueKey":"message","typeLabel":"string"},"success":{"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"details":{"type":"string","uniqueKey":"details","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","success":true,"code":"\u003cstring>","details":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"db9eb54e-0753-478a-996c-529adae9a12b":{"description":"The request timed out.","content":{"application/json":{"schema":{"type":"object","required":["code","message","success"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","x-speakeasy-error-message":true,"isRequired":true,"uniqueKey":"message","typeLabel":"string"},"success":{"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"details":{"type":"string","uniqueKey":"details","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","message":"\u003cstring>","success":true,"details":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"9ff8331c-9caf-4cba-8a3f-9cd6abe33c68":{"description":"The order uses credit balance, which can't be used at the moment. Nothing is placed; retry shortly.","content":{"application/json":{"schema":{"type":"object","required":["message","success","code"],"properties":{"message":{"type":"string","examples":["Paying with credit balance waits for the payment ledger update to finish; try again shortly"],"isRequired":true,"uniqueKey":"message","typeLabel":"string"},"success":{"type":"boolean","default":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"code":{"type":"string","examples":["credit-balance-unavailable"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"details":{"type":"string","uniqueKey":"details","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Paying with credit balance waits for the payment ledger update to finish; try again shortly","success":false,"code":"credit-balance-unavailable","details":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"c213868b-7f0b-4c48-a212-33a316c2fede":{"description":"The request failed because of an unexpected error.","content":{"application/json":{"schema":{"type":"object","required":["code","message","success"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","x-speakeasy-error-message":true,"isRequired":true,"uniqueKey":"message","typeLabel":"string"},"success":{"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"details":{"type":"string","uniqueKey":"details","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","message":"\u003cstring>","success":true,"details":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"ba3bab17-7274-48c6-bfcc-9a3155adcf05":{"description":"The store's type can't be determined for the cashier's session yet. Nothing is placed; retry, or sign in on the device again.","content":{"application/json":{"schema":{"type":"object","required":["message","success","code"],"properties":{"message":{"type":"string","examples":["The store's type is not known yet. Try again."],"isRequired":true,"uniqueKey":"message","typeLabel":"string"},"success":{"type":"boolean","default":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"code":{"type":"string","examples":["store-type-unavailable"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"details":{"type":"string","uniqueKey":"details","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"The store's type is not known yet. Try again.","success":false,"code":"store-type-unavailable","details":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"d0cba2d7-15cd-448c-bd8a-2ee7284d44d9":{"description":"The request timed out.","content":{"application/json":{"schema":{"type":"object","required":["code","message","success"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","x-speakeasy-error-message":true,"isRequired":true,"uniqueKey":"message","typeLabel":"string"},"success":{"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"details":{"type":"string","uniqueKey":"details","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","message":"\u003cstring>","success":true,"details":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"85e69c6e-b9aa-4433-a28e-3860f777d310":{"Authorization":{"type":"http","description":"Access token","scheme":"bearer","scopes":[],"schemeName":"Authorization"}}},"servers":{"d5140fa8-2bd5-4c13-abb4-72a9479f9f58":{"url":"https://staging.api.commercengine.io/api/v1/{store_id}/storefront","description":"Staging Server","variables":{"store_id":{"description":"Store ID","default":"store_id"}},"x-speakeasy-server-id":"staging"},"503d314f-8bfe-43e5-9c58-f8d1033bbbb9":{"url":"https://prod.api.commercengine.io/api/v1/{store_id}/storefront","description":"Prod Server","variables":{"store_id":{"description":"Store ID","default":"store_id"}},"x-speakeasy-server-id":"prod"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","description":"Access token","scheme":"bearer","scopes":[],"schemeName":"Authorization"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Access token","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"Authorization","name":"Authorization"}],"title":"Authorization"}]},"originalFileLocation":"https://openapi.commercengine.io/ce-pos.json"},"subdomain":"tarkai","siteName":"Commerce Engine Docs","title":"Create POS order - Commerce Engine Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-18T13:06:40.900Z","originalFileLocation":"api-reference/pos/orders/create-pos-order.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=\"Creates an order from a POS cart. Returns an Order with payment_required and payment_info. Include payment_method to create an initial payment request. When the customer\u0026#x27;s loyalty points, credit balance or a discount pay the whole order, no payment is requested, whatever the method. Paid by points or a discount alone, the order comes back already confirmed (awaiting_approval when the store doesn\u0026#x27;t approve orders automatically; complete when it is collected in store with nothing to ship) with payment_status success. Paid by its credit balance, with or without points, it stays pending until that balance is settled against it. If the customer can\u0026#x27;t be identified at that moment, the order comes back pending, and its purchase completes once the customer is identified. When the credit balance pays only part of the order, its payments include a bank transfer for that credit, and the order stays pending until the credit is settled against it and the rest is paid. If the store\u0026#x27;s type can\u0026#x27;t be determined for the cashier\u0026#x27;s session, the request fails with a 503 and the store-type-unavailable error code, and nothing is placed: retry, or sign in on the device again. Credit balance applied to the cart must be within what the customer can spend now, which leaves out credit their other unpaid orders have claimed. When credit balance can\u0026#x27;t be used for a moment, an order using it fails with a 409 and the credit-balance-unavailable error code, and nothing is placed: retry shortly. The payment method must be one the store offers on the POS\u0026#x27;s sales channel; any other is refused with a 400.\">\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=\"Create POS order - Commerce Engine Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates an order from a POS cart. Returns an Order with payment_required and payment_info. Include payment_method to create an initial payment request. When the customer\u0026#x27;s loyalty points, credit balance or a discount pay the whole order, no payment is requested, whatever the method. Paid by points or a discount alone, the order comes back already confirmed (awaiting_approval when the store doesn\u0026#x27;t approve orders automatically; complete when it is collected in store with nothing to ship) with payment_status success. Paid by its credit balance, with or without points, it stays pending until that balance is settled against it. If the customer can\u0026#x27;t be identified at that moment, the order comes back pending, and its purchase completes once the customer is identified. When the credit balance pays only part of the order, its payments include a bank transfer for that credit, and the order stays pending until the credit is settled against it and the rest is paid. If the store\u0026#x27;s type can\u0026#x27;t be determined for the cashier\u0026#x27;s session, the request fails with a 503 and the store-type-unavailable error code, and nothing is placed: retry, or sign in on the device again. Credit balance applied to the cart must be within what the customer can spend now, which leaves out credit their other unpaid orders have claimed. When credit balance can\u0026#x27;t be used for a moment, an order using it fails with a 409 and the credit-balance-unavailable error code, and nothing is placed: retry shortly. The payment method must be one the store offers on the POS\u0026#x27;s sales channel; any other is refused with a 400.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Commerce Engine Developer Portal\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://www.commercengine.io/docs/api-reference/pos/orders/create-pos-order\">\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=Create+POS+order\u0026amp;description=Creates+an+order+from+a+POS+cart.+Returns+an+%60Order%60+with+%60payment_required%60+and+%60payment_info%60.+Include+%60payment_method%60+to+create+an+initial+payment+request.+\u0026amp;theme=76e8f8f14f90cfb8929bc40a\u0026amp;signature=7f2c69f946b76a39e8efd7fbfbee75eb8f992667bcb92a632b07a177130de5fa\">\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=\"Create POS order - Commerce Engine Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates an order from a POS cart. Returns an Order with payment_required and payment_info. Include payment_method to create an initial payment request. When the customer\u0026#x27;s loyalty points, credit balance or a discount pay the whole order, no payment is requested, whatever the method. Paid by points or a discount alone, the order comes back already confirmed (awaiting_approval when the store doesn\u0026#x27;t approve orders automatically; complete when it is collected in store with nothing to ship) with payment_status success. Paid by its credit balance, with or without points, it stays pending until that balance is settled against it. If the customer can\u0026#x27;t be identified at that moment, the order comes back pending, and its purchase completes once the customer is identified. When the credit balance pays only part of the order, its payments include a bank transfer for that credit, and the order stays pending until the credit is settled against it and the rest is paid. If the store\u0026#x27;s type can\u0026#x27;t be determined for the cashier\u0026#x27;s session, the request fails with a 503 and the store-type-unavailable error code, and nothing is placed: retry, or sign in on the device again. Credit balance applied to the cart must be within what the customer can spend now, which leaves out credit their other unpaid orders have claimed. When credit balance can\u0026#x27;t be used for a moment, an order using it fails with a 409 and the credit-balance-unavailable error code, and nothing is placed: retry shortly. The payment method must be one the store offers on the POS\u0026#x27;s sales channel; any other is refused with a 400.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://tarkai.mintlify.site/docs/_mintlify/api/og/v2?division=Orders\u0026amp;title=Create+POS+order\u0026amp;description=Creates+an+order+from+a+POS+cart.+Returns+an+%60Order%60+with+%60payment_required%60+and+%60payment_info%60.+Include+%60payment_method%60+to+create+an+initial+payment+request.+\u0026amp;theme=76e8f8f14f90cfb8929bc40a\u0026amp;signature=7f2c69f946b76a39e8efd7fbfbee75eb8f992667bcb92a632b07a177130de5fa\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/docs/mintlify-assets/_mintlify/favicons/tarkai/OqQIjYq8Q24cGlMx/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Commerce Engine Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#00BF6F\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003cmeta data-mint-head name=\"og:logo\" content=\"/logo/CE_logo_whitebg.svg\">\u003clink data-mint-head rel=\"canonical\" href=\"https://www.commercengine.io/docs/api-reference/pos/orders/create-pos-order\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/pos/orders/create-pos-order.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.commercengine.io/#organization\",\"name\":\"Commerce Engine Docs\",\"url\":\"https://www.commercengine.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/tarkai/hIY7_H2biaAvOGu7/logo/CE_Developers_black.svg?fit=max\u0026auto=format\u0026n=hIY7_H2biaAvOGu7\u0026q=85\u0026s=d93f21564dfd373c7f2efc88c9d4301e\"}},{\"@type\":\"WebSite\",\"@id\":\"https://www.commercengine.io/docs#website\",\"name\":\"Commerce Engine Docs\",\"url\":\"https://www.commercengine.io/docs\",\"publisher\":{\"@id\":\"https://www.commercengine.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://www.commercengine.io/docs/api-reference/pos/orders/create-pos-order#webpage\",\"url\":\"https://www.commercengine.io/docs/api-reference/pos/orders/create-pos-order\",\"name\":\"Create POS order\",\"description\":\"Creates an order from a POS cart. Returns an Order with payment_required and payment_info. Include payment_method to create an initial payment request. When the customer's loyalty points, credit balance or a discount pay the whole order, no payment is requested, whatever the method. Paid by points or a discount alone, the order comes back already confirmed (awaiting_approval when the store doesn't approve orders automatically; complete when it is collected in store with nothing to ship) with payment_status success. Paid by its credit balance, with or without points, it stays pending until that balance is settled against it. If the customer can't be identified at that moment, the order comes back pending, and its purchase completes once the customer is identified. When the credit balance pays only part of the order, its payments include a bank transfer for that credit, and the order stays pending until the credit is settled against it and the rest is paid. If the store's type can't be determined for the cashier's session, the request fails with a 503 and the store-type-unavailable error code, and nothing is placed: retry, or sign in on the device again. Credit balance applied to the cart must be within what the customer can spend now, which leaves out credit their other unpaid orders have claimed. When credit balance can't be used for a moment, an order using it fails with a 409 and the credit-balance-unavailable error code, and nothing is placed: retry shortly. The payment method must be one the store offers on the POS's sales channel; any other is refused with a 400.\",\"dateModified\":\"2026-11-18T13:06:40.900Z\",\"isPartOf\":{\"@id\":\"https://www.commercengine.io/docs#website\"},\"breadcrumb\":{\"@id\":\"https://www.commercengine.io/docs/api-reference/pos/orders/create-pos-order#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://www.commercengine.io/docs/api-reference/pos/orders/create-pos-order#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Orders\",\"item\":\"https://www.commercengine.io/docs/api-reference/pos/orders/list-all-orders\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Orders\",\"item\":\"https://www.commercengine.io/docs/api-reference/pos/orders/list-all-orders\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create POS order\",\"item\":\"https://www.commercengine.io/docs/api-reference/pos/orders/create-pos-order\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://www.commercengine.io/docs/api-reference/pos/orders/create-pos-order#apireference\",\"headline\":\"Create POS order\",\"name\":\"Create POS order\",\"description\":\"Creates an order from a POS cart. Returns an Order with payment_required and payment_info. Include payment_method to create an initial payment request. When the customer's loyalty points, credit balance or a discount pay the whole order, no payment is requested, whatever the method. Paid by points or a discount alone, the order comes back already confirmed (awaiting_approval when the store doesn't approve orders automatically; complete when it is collected in store with nothing to ship) with payment_status success. Paid by its credit balance, with or without points, it stays pending until that balance is settled against it. If the customer can't be identified at that moment, the order comes back pending, and its purchase completes once the customer is identified. When the credit balance pays only part of the order, its payments include a bank transfer for that credit, and the order stays pending until the credit is settled against it and the rest is paid. If the store's type can't be determined for the cashier's session, the request fails with a 503 and the store-type-unavailable error code, and nothing is placed: retry, or sign in on the device again. Credit balance applied to the cart must be within what the customer can spend now, which leaves out credit their other unpaid orders have claimed. When credit balance can't be used for a moment, an order using it fails with a 409 and the credit-balance-unavailable error code, and nothing is placed: retry shortly. The payment method must be one the store offers on the POS's sales channel; any other is refused with a 400.\",\"url\":\"https://www.commercengine.io/docs/api-reference/pos/orders/create-pos-order\",\"mainEntityOfPage\":{\"@id\":\"https://www.commercengine.io/docs/api-reference/pos/orders/create-pos-order#webpage\"},\"dateModified\":\"2026-11-18T13:06:40.900Z\",\"publisher\":{\"@id\":\"https://www.commercengine.io/#organization\"},\"isPartOf\":{\"@id\":\"https://www.commercengine.io/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Commerce Engine Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Commerce Engine Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/docs/api-reference/pos/orders/create-pos-order.md","siteName":"Commerce Engine Docs","nav":{"global":null,"tabs":[{"tab":"Guides","icon":"book-open-cover","menu":[{"item":"Quickstart","icon":"rocket","description":"Get your keys, then make your first API call in under 15 minutes.","pages":[{"title":"Quickstart","href":"/storefront/quickstart"}]},{"item":"Starters","icon":"rocket","description":"Three production storefronts, each cloned across five frameworks.","pages":[{"title":"Starters","href":"/starters/overview"}]},{"item":"AI-assisted development","icon":"wand-magic-sparkles","description":"Skills, prompts and starters for coding agents.","pages":[{"title":"AI-assisted development","href":"/ai/overview"}]},{"item":"AI apps","icon":"plug","description":"Manage your store from Claude, ChatGPT, Codex and other AI apps.","pages":[{"title":"AI apps","href":"/ai/mcp-connector"}]},{"item":"Storefront","icon":"store","description":"Auth, catalog, cart, checkout, account and subscriptions.","pages":[{"title":"Storefront","href":"/storefront/authentication"}]},{"item":"API guides","icon":"code","description":"Authentication, POS setup and webhook delivery.","pages":[{"title":"API guides","href":"/api-reference/getting-started"}]},{"item":"Hosted checkout","icon":"bag-shopping","description":"Drop-in embeddable cart and checkout for any stack.","pages":[{"title":"Hosted checkout","href":"/hosted-checkout/overview"}]},{"item":"SEO \u0026 AEO","icon":"magnifying-glass","description":"Structured data, canonical metadata, sitemaps and llms.txt.","pages":[{"title":"SEO \u0026 AEO","href":"/seo-ai/overview"}]},{"item":"Agent tools","icon":"robot","description":"WebMCP tools that let browser agents shop your store.","pages":[{"title":"Agent tools","href":"/seo-ai/ai"}]}],"pages":[{"title":"Guides","href":"/storefront/quickstart"}]},{"tab":"Hosted Checkout","icon":"bag-shopping","pages":[{"title":"Hosted Checkout","href":"/hosted-checkout/overview"}]},{"tab":"Packages","icon":"cube","menu":[{"item":"storefront","icon":"box","description":"Framework wrappers for React, Next.js, SvelteKit and Astro.","pages":[{"title":"storefront","href":"/sdk/installation"}]},{"item":"ssr-utils","icon":"server","description":"Framework-agnostic cookie-backed SSR session utilities.","pages":[{"title":"ssr-utils","href":"/sdk/ssr-utils"}]},{"item":"checkout","icon":"bag-shopping","description":"Universal checkout SDK — hosted, embedded or headless.","pages":[{"title":"checkout","href":"/hosted-checkout/overview"}]},{"item":"pos","icon":"cash-register","description":"TypeScript SDK for the POS API, for in-store selling.","pages":[{"title":"pos","href":"/pos/overview"}]},{"item":"analytics","icon":"chart-line","description":"Zero-dependency mappers for canonical commerce events.","pages":[{"title":"analytics","href":"/hosted-checkout/analytics"}]},{"item":"seo","icon":"magnifying-glass","description":"Opinionated SEO, AEO, structured data and Markdown output.","pages":[{"title":"seo","href":"/seo-ai/overview"}]},{"item":"ai","icon":"wand-magic-sparkles","description":"Browser-native agent tools (WebMCP) for storefronts.","pages":[{"title":"ai","href":"/seo-ai/ai"}]},{"item":"Browse all packages","icon":"grid-2","description":"Every published Commerce Engine package on npm.","href":"https://www.npmjs.com/org/commercengine"}],"pages":[{"title":"Packages","href":"/sdk/installation"}]},{"tab":"API Reference","icon":"code","menu":[{"item":"Storefront API","icon":"store","description":"Everything a storefront calls — catalog, cart, checkout, auth, orders.","pages":[{"title":"Storefront API","href":"/api-reference/authentication/create-anonymous-session"}]},{"item":"POS API","icon":"cash-register","description":"Point of sale — staff login, device pairing, carts, catalog and order capture on the storefront base URL.","groups":[{"group":"Identity","pages":[{"group":"Devices","pages":[{"title":"Pair POS device","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/auth/pair-device","href":"/api-reference/pos/devices/pair-pos-device"},{"title":"List all available devices","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/devices","href":"/api-reference/pos/devices/list-all-available-devices"},{"title":"Claim device","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/devices/{id}/claim","href":"/api-reference/pos/devices/claim-device"},{"title":"Unclaim device","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/devices/{id}/unclaim","href":"/api-reference/pos/devices/unclaim-device"},{"title":"List all locations","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/locations","href":"/api-reference/pos/devices/list-all-locations"}]},{"group":"Authentication","pages":[{"title":"Login with email","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/auth/login/email","href":"/api-reference/pos/authentication/login-with-email"},{"title":"Login with phone","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/auth/login/phone","href":"/api-reference/pos/authentication/login-with-phone"},{"title":"Login with whatsapp","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/auth/login/whatsapp","href":"/api-reference/pos/authentication/login-with-whatsapp"},{"title":"Logout","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/auth/logout","href":"/api-reference/pos/authentication/logout"},{"title":"Refresh POS access token","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/auth/refresh-token","href":"/api-reference/pos/authentication/refresh-pos-access-token"},{"title":"Verify OTP","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/auth/verify-otp","href":"/api-reference/pos/authentication/verify-otp"}]},{"group":"Users","pages":[{"title":"Get POS User","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/users/{id}","href":"/api-reference/pos/users/get-pos-user"}]}]},{"group":"Customers","pages":[{"group":"Customers","pages":[{"title":"List all customers","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/customers","href":"/api-reference/pos/customers/list-all-customers"},{"title":"Retrieve customer detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/customers/{id}","href":"/api-reference/pos/customers/retrieve-customer-detail"},{"title":"Update customer","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json put /pos/customers/{id}","href":"/api-reference/pos/customers/update-customer"},{"title":"Search customers","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/search-customers","href":"/api-reference/pos/customers/search-customers"}]},{"group":"Addresses","pages":[{"title":"List all addresses","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/customers/{id}/addresses","href":"/api-reference/pos/addresses/list-all-addresses"},{"title":"Create address","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/customers/{id}/addresses","href":"/api-reference/pos/addresses/create-address"},{"title":"Update address detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json put /pos/customers/{id}/addresses/{address_id}","href":"/api-reference/pos/addresses/update-address-detail"},{"title":"Delete address","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json delete /pos/customers/{id}/addresses/{address_id}","href":"/api-reference/pos/addresses/delete-address"}]}]},{"group":"Catalog","pages":[{"group":"Products","pages":[{"title":"List all products","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/catalog/products","href":"/api-reference/pos/products/list-all-products"},{"title":"Retrieve cross-sell products","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/catalog/products/cross-sell","href":"/api-reference/pos/products/retrieve-cross-sell-products"},{"title":"Search products","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/catalog/products/search","href":"/api-reference/pos/products/search-products"},{"title":"Retrieve similar products","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/catalog/products/similar","href":"/api-reference/pos/products/retrieve-similar-products"},{"title":"Retrieve up-sell products","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/catalog/products/up-sell","href":"/api-reference/pos/products/retrieve-up-sell-products"},{"title":"Retrieve a product detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/catalog/products/{product_id}","href":"/api-reference/pos/products/retrieve-a-product-detail"},{"title":"Retrieve product variants","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/catalog/products/{product_id}/variants","href":"/api-reference/pos/products/retrieve-product-variants"},{"title":"Retrieve variant detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/catalog/products/{product_id}/variants/{variant_id}","href":"/api-reference/pos/products/retrieve-variant-detail"},{"title":"List all SKUs","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/catalog/skus","href":"/api-reference/pos/products/list-all-skus"}]},{"group":"Reviews","pages":[{"title":"List all product reviews","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/catalog/products/{product_id}/reviews","href":"/api-reference/pos/reviews/list-all-product-reviews"}]},{"group":"Categories","pages":[{"title":"List all categories","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/catalog/categories","href":"/api-reference/pos/categories/list-all-categories"}]},{"group":"Inventory","pages":[{"title":"List all inventories","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/catalog/inventories","href":"/api-reference/pos/inventory/list-all-inventories"},{"title":"List all inventories activities","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/catalog/inventories/activities","href":"/api-reference/pos/inventory/list-all-inventories-activities"},{"title":"Retrieve inventory detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/catalog/inventories/detail","href":"/api-reference/pos/inventory/retrieve-inventory-detail"}]}]},{"group":"Shopping","pages":[{"group":"Carts","pages":[{"title":"Create cart","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/carts","href":"/api-reference/pos/carts/create-cart"},{"title":"Retrieve cart by user ID","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/carts/users/{user_id}","href":"/api-reference/pos/carts/retrieve-cart-by-user-id"},{"title":"Retrieve cart detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/carts/{id}","href":"/api-reference/pos/carts/retrieve-cart-detail"},{"title":"Delete cart","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json delete /pos/carts/{id}","href":"/api-reference/pos/carts/delete-cart"},{"title":"Set cart address","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/carts/{id}/address","href":"/api-reference/pos/carts/set-cart-address"},{"title":"Use credit balance","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/carts/{id}/credit-balance","href":"/api-reference/pos/carts/use-credit-balance"},{"title":"Remove credit balance","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json delete /pos/carts/{id}/credit-balance","href":"/api-reference/pos/carts/remove-credit-balance"},{"title":"Add, update, or remove a cart item","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/carts/{id}/items","href":"/api-reference/pos/carts/add-update-or-remove-a-cart-item"},{"title":"Redeem loyalty points","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/carts/{id}/loyalty-points","href":"/api-reference/pos/carts/redeem-loyalty-points"},{"title":"Remove loyalty points","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json delete /pos/carts/{id}/loyalty-points","href":"/api-reference/pos/carts/remove-loyalty-points"},{"title":"Update cart customer","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/carts/{id}/update-customer","href":"/api-reference/pos/carts/update-cart-customer"}]},{"group":"Coupons \u0026 promotions","pages":[{"title":"Retrieve all coupons","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/carts/available-coupons","href":"/api-reference/pos/coupons-\u0026-promotions/retrieve-all-coupons"},{"title":"Retrieve all promotions","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/carts/available-promotions","href":"/api-reference/pos/coupons-\u0026-promotions/retrieve-all-promotions"},{"title":"Apply coupon","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/carts/{id}/coupon","href":"/api-reference/pos/coupons-\u0026-promotions/apply-coupon"},{"title":"Remove coupon","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json delete /pos/carts/{id}/coupon","href":"/api-reference/pos/coupons-\u0026-promotions/remove-coupon"},{"title":"Evaluate coupons","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/carts/{id}/evaluate-coupons","href":"/api-reference/pos/coupons-\u0026-promotions/evaluate-coupons"},{"title":"Evaluate promotions","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/carts/{id}/evaluate-promotions","href":"/api-reference/pos/coupons-\u0026-promotions/evaluate-promotions"}]},{"group":"Fulfillment","pages":[{"title":"Retrieve fulfillment options","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/carts/fulfillment-options","href":"/api-reference/pos/fulfillment/retrieve-fulfillment-options"},{"title":"Update fulfillment preference","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/carts/{id}/fulfillment-preference","href":"/api-reference/pos/fulfillment/update-fulfillment-preference"}]}]},{"group":"Orders","pages":[{"group":"Orders","pages":[{"title":"List all orders","description":"Lists orders matching the supplied filters. Staff can retrieve orders across all store locations.","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/orders","href":"/api-reference/pos/orders/list-all-orders"},{"title":"Create POS order","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/orders","href":"/api-reference/pos/orders/create-pos-order"},{"title":"Retrieve order details","description":"Retrieves an order's details. For an order not on the customer's credit line that the customer's loyalty points, credit balance or a discount pay in full, `payments` holds no gateway or manual payment. It lists the bank transfer of the credit balance used, if any, and, for a storefront order, the loyalty points redeemed. Staff can retrieve orders across all store locations.","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/orders/{order_number}","href":"/api-reference/pos/orders/retrieve-order-details"},{"title":"List all order activity","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/orders/{order_number}/activity","href":"/api-reference/pos/orders/list-all-order-activity"},{"title":"Check inventory","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/orders/{order_number}/check-inventory","href":"/api-reference/pos/orders/check-inventory"},{"title":"Retrieve order invoice","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/orders/{order_number}/invoice","href":"/api-reference/pos/orders/retrieve-order-invoice"},{"title":"Retrieve order receipt","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/orders/{order_number}/receipt","href":"/api-reference/pos/orders/retrieve-order-receipt"},{"title":"Retrieve order shipments","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/orders/{order_number}/shipments","href":"/api-reference/pos/orders/retrieve-order-shipments"}]},{"group":"Order payments","pages":[{"title":"Cancel payment request","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/orders/{order_number}/cancel-payment-request","href":"/api-reference/pos/order-payments/cancel-payment-request"},{"title":"Retrieve payment status","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/orders/{order_number}/payment-status","href":"/api-reference/pos/order-payments/retrieve-payment-status"},{"title":"Create order payment","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/orders/{order_number}/payments","href":"/api-reference/pos/order-payments/create-order-payment"},{"title":"Retry payment","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/orders/{order_number}/retry-payment","href":"/api-reference/pos/order-payments/retry-payment"}]},{"group":"Shipments","pages":[{"title":"List all shipments","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/shipping/shipments","href":"/api-reference/pos/shipments/list-all-shipments"},{"title":"Refund shortfall","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/shipping/shipments/{order_number}/refund-shortfall","href":"/api-reference/pos/shipments/refund-shortfall"},{"title":"Wait for inventory","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/shipping/shipments/{order_number}/wait-for-inventory","href":"/api-reference/pos/shipments/wait-for-inventory"},{"title":"Retrieve shipment detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/shipping/shipments/{reference_number}","href":"/api-reference/pos/shipments/retrieve-shipment-detail"},{"title":"Retrieve shipment activities","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/shipping/shipments/{reference_number}/activities","href":"/api-reference/pos/shipments/retrieve-shipment-activities"},{"title":"Approve shipment","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/shipping/shipments/{reference_number}/approve","href":"/api-reference/pos/shipments/approve-shipment"},{"title":"Retrieve shipment invoice","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/shipping/shipments/{reference_number}/invoice","href":"/api-reference/pos/shipments/retrieve-shipment-invoice"},{"title":"Update shipment detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json put /pos/shipping/shipments/{reference_number}/manual-update","href":"/api-reference/pos/shipments/update-shipment-detail"},{"title":"Reject shipment","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/shipping/shipments/{reference_number}/reject","href":"/api-reference/pos/shipments/reject-shipment"},{"title":"Create a replacement shipment","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/shipping/shipments/{reference_number}/replacement","href":"/api-reference/pos/shipments/create-a-replacement-shipment"}]}]},{"group":"Payments","pages":[{"group":"Payments","pages":[{"title":"Authenticate direct OTP","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/payments/authenticate-direct-otp","href":"/api-reference/pos/payments/authenticate-direct-otp"},{"title":"Get card information","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/payments/card-info","href":"/api-reference/pos/payments/get-card-information"},{"title":"List payment methods","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/payments/payment-methods","href":"/api-reference/pos/payments/list-payment-methods"},{"title":"Resend direct OTP","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json post /pos/payments/resend-direct-otp","href":"/api-reference/pos/payments/resend-direct-otp"},{"title":"Verify VPA","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/payments/verify-vpa","href":"/api-reference/pos/payments/verify-vpa"}]}]},{"group":"Store","pages":[{"group":"Locations","pages":[{"title":"Retrieve pincodes","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/common/countries/{country_iso_code}/pincodes","href":"/api-reference/pos/locations/retrieve-pincodes"},{"title":"Retrieve country wise states","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-pos.json get /pos/common/countries/{country_iso_code}/states","href":"/api-reference/pos/locations/retrieve-country-wise-states"}]}]}]},{"item":"Webhooks","icon":"webhook","description":"Events Commerce Engine delivers to your endpoints — orders, payments, shipments, catalog, customers, store and marketplace.","pages":[{"title":"Webhooks","href":"/api-reference/webhooks/orders/checkout-completed"}]},{"item":"Admin API","icon":"gear","description":"Back-office operations — catalog management, customers, fulfilment, store settings.","pages":[{"title":"Admin API","href":"/admin/api-reference/products/list-all-products"}]}]}]},"basePath":"","title":"Create POS order - Commerce Engine Docs","deploymentId":"dpl_B1qJC7o4Nbc1BrDLB8Y5TDHq3c2t","buildId":"dpl_B1qJC7o4Nbc1BrDLB8Y5TDHq3c2t","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-CUHhyXy2.js","snippetPresets-CLZ6zHrE.js","utils-YgZO0660.js","style-to-object-BY3JEAdk.js","utils-BfGpunL-.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-nXeJG4mW.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CfiGwWS2.js","_Uint8Array-DMwpGz7v.js","isObject-FP1Yky1u.js","Page-wRPqmnTs.js","CodeSnippet-CD0M-PIN.js","DynamicMarkdown-B4E-vXj3.js","SectionHeading-Cd1Hebqh.js","icon-CopWpdT0.js","ApiExamples-ClwIRLsI.js","usePlaygroundInputsStore-D3zE52Kn.js","shallow-D4RQzCAp.js","isEqual-Ba6nq9eA.js","CodeSnippets-DK9iv102.js","getApiPlaygroundDisplay-MZpK72mj.js","MethodPill-DHN7T7vW.js","getPastedJson-BuLRhr5B.js","Check2Icon-DTvkZOnk.js","axios-CsQoIw0U.js","Markdown-BZDfk3ee.js","AssistantPageLink-CXXpl6Pb.js","dist-D0qiytnz.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}