{"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":"6aeee83b8e01a92054be452b","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"API Reference","count":824},{"language":"default","tag":"Admin API","count":382},{"language":"default","tag":"Admin","count":382},{"language":"default","tag":"Webhooks","count":252},{"language":"default","tag":"Events","count":237},{"language":"default","tag":"Customers","count":142},{"language":"default","tag":"Storefront API","count":128},{"language":"default","tag":"Catalog","count":114},{"language":"default","tag":"Store","count":82},{"language":"default","tag":"POS API","count":76}]},"assistantConfig":{},"basePath":"/docs","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","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":"admin/api-reference/catalog/create-variant","slug":"/admin/api-reference/catalog/create-variant","pageMetadata":{"title":"Create variant","description":"Create variant","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /catalog/products/{id}/variants","href":"/admin/api-reference/catalog/create-variant","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Create variant\"\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 variant","description":"Create variant","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /catalog/products/{id}/variants","href":"/admin/api-reference/catalog/create-variant","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/tarkai/83faf160ccb5c4ff/header-float.js"],"openApiReferenceData":{"operation":{"tags":["Catalog"],"operationId":"create-variant","summary":"Create variant","description":"Create variant","requestBody":"ae4b3e78-344b-4790-a6e3-83d46be16c57","responses":{"200":"82f067a7-e304-4cb4-982c-78c2fe2ae5b5"},"method":"post","type":"path","servers":["506eb153-5ecc-46fb-a8e2-3c415e5074c2","1a1af4af-a5a0-4bb7-8748-eb6bfe80502e"],"security":["40cf46b8-447c-4ad1-be68-0627685ec9bf"],"path":"/catalog/products/{id}/variants","baseUrlOptions":["https://staging.api.commercengine.io/api/v1/{store_id}/admin","https://prod.api.commercengine.io/api/v1/{store_id}/admin"],"title":"Create variant","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{"c728f0eb-c90d-4eda-a174-c710172b51e9":{"name":"id","in":"path","description":"product id","required":true,"schema":{"type":"string","isRequired":true,"description":"product id","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","title":"CreateVariant","required":["name","associated_options"],"x-tags":["Catalog"],"properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].name","typeLabel":"string"},"associated_options":{"type":"array","items":{"title":"AssociatedOption","type":"object","required":["attribute_id","attribute_value"],"properties":{"attribute_id":{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].associated_options.items.[INDEX].attribute_id","typeLabel":"string"},"attribute_value":{"oneOf":[{"type":"string","description":"Attributes with type of **single-select**, the value will be represented as a **string**.","isRequired":true,"uniqueKey":"items.[INDEX].associated_options.items.[INDEX].attribute_value.oneOf.0","typeLabel":"string"},{"type":"object","title":"ColorObject","description":"**Color** attributes will have their value represented as a color object, specifying the color details with name and hexcode.","required":["name","hexcode"],"properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].associated_options.items.[INDEX].attribute_value.oneOf.1.name","typeLabel":"string"},"hexcode":{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].associated_options.items.[INDEX].attribute_value.oneOf.1.hexcode","typeLabel":"string"}},"isRequired":true,"uniqueKey":"items.[INDEX].associated_options.items.[INDEX].attribute_value.oneOf.1","typeLabel":"ColorObject · object"}],"isRequired":true,"uniqueKey":"items.[INDEX].associated_options.items.[INDEX].attribute_value","typeLabel":"string | ColorObject · object"}},"uniqueKey":"items.[INDEX].associated_options.items.[INDEX]","typeLabel":"AssociatedOption · object"},"isRequired":true,"uniqueKey":"items.[INDEX].associated_options","typeLabel":"AssociatedOption · object[]"},"is_default":{"type":"boolean","uniqueKey":"items.[INDEX].is_default","typeLabel":"boolean"},"short_description":{"oneOf":[{"type":"string","uniqueKey":"items.[INDEX].short_description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"items.[INDEX].short_description.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].short_description","typeLabel":"string | null"},"metadata":{"oneOf":[{"type":"object","additionalProperties":{"type":"string","uniqueKey":"items.[INDEX].metadata.oneOf.0.additionalProperties","typeLabel":"string"},"uniqueKey":"items.[INDEX].metadata.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"string","uniqueKey":"items.[INDEX].metadata.oneOf.1.additionalProperties","typeLabel":"string"},"uniqueKey":"items.[INDEX].metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].metadata","typeLabel":"object | null"},"sku":{"oneOf":[{"description":"variant sku. can be null for digital product.","type":"string","uniqueKey":"items.[INDEX].sku.oneOf.0","typeLabel":"string"},{"description":"variant sku. can be null for digital product.","type":"null","uniqueKey":"items.[INDEX].sku.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].sku","typeLabel":"string | null"},"slug":{"description":"variant sku. can be null for digital product.","type":"string","uniqueKey":"items.[INDEX].slug","typeLabel":"string"},"pricing":{"type":"array","items":{"title":"ProductPricing","type":"object","required":["customer_group_id","cost_price","listing_price","selling_price","tax_rate"],"properties":{"customer_group_id":{"oneOf":[{"description":"customer group id. for different pricing model in case of multiple customer groups.","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].pricing.items.[INDEX].customer_group_id.oneOf.0","typeLabel":"string"},{"description":"customer group id. for different pricing model in case of multiple customer groups.","type":"null","isRequired":true,"uniqueKey":"items.[INDEX].pricing.items.[INDEX].customer_group_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"items.[INDEX].pricing.items.[INDEX].customer_group_id","typeLabel":"string | null"},"cost_price":{"oneOf":[{"type":"number","format":"double","isRequired":true,"uniqueKey":"items.[INDEX].pricing.items.[INDEX].cost_price.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","format":"double","isRequired":true,"uniqueKey":"items.[INDEX].pricing.items.[INDEX].cost_price.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"items.[INDEX].pricing.items.[INDEX].cost_price","typeLabel":"number\u003cdouble> | null"},"listing_price":{"type":"number","format":"double","isRequired":true,"uniqueKey":"items.[INDEX].pricing.items.[INDEX].listing_price","typeLabel":"number\u003cdouble>"},"selling_price":{"type":"number","format":"double","isRequired":true,"uniqueKey":"items.[INDEX].pricing.items.[INDEX].selling_price","typeLabel":"number\u003cdouble>"},"tax_rate":{"type":"number","format":"double","isRequired":true,"uniqueKey":"items.[INDEX].pricing.items.[INDEX].tax_rate","typeLabel":"number\u003cdouble>"},"min_order_quantity":{"oneOf":[{"type":"integer","format":"int32","default":1,"uniqueKey":"items.[INDEX].pricing.items.[INDEX].min_order_quantity.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","default":1,"uniqueKey":"items.[INDEX].pricing.items.[INDEX].min_order_quantity.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].pricing.items.[INDEX].min_order_quantity","typeLabel":"integer\u003cint32> | null"},"max_order_quantity":{"oneOf":[{"type":"integer","format":"int32","uniqueKey":"items.[INDEX].pricing.items.[INDEX].max_order_quantity.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","uniqueKey":"items.[INDEX].pricing.items.[INDEX].max_order_quantity.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].pricing.items.[INDEX].max_order_quantity","typeLabel":"integer\u003cint32> | null"},"incremental_quantity":{"oneOf":[{"type":"integer","format":"int32","default":1,"uniqueKey":"items.[INDEX].pricing.items.[INDEX].incremental_quantity.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","default":1,"uniqueKey":"items.[INDEX].pricing.items.[INDEX].incremental_quantity.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].pricing.items.[INDEX].incremental_quantity","typeLabel":"integer\u003cint32> | null"}},"x-tags":["Catalog"],"uniqueKey":"items.[INDEX].pricing.items.[INDEX]","typeLabel":"ProductPricing · object"},"uniqueKey":"items.[INDEX].pricing","typeLabel":"ProductPricing · object[]"},"variant_attributes":{"type":"array","items":{"title":"ProductAttribute","type":"object","properties":{"id":{"description":"Attribute id as returned on SKU and search payloads; same as `attribute_id` on write.","type":"string","uniqueKey":"items.[INDEX].variant_attributes.items.[INDEX].id","typeLabel":"string"},"value":{"oneOf":[{"type":"string","description":"Resolved value; same as `attribute_value` on write payloads.","uniqueKey":"items.[INDEX].variant_attributes.items.[INDEX].value.oneOf.0","typeLabel":"string"},{"type":"number","description":"Resolved value; same as `attribute_value` on write payloads.","uniqueKey":"items.[INDEX].variant_attributes.items.[INDEX].value.oneOf.1","typeLabel":"number"},{"type":"boolean","description":"Resolved value; same as `attribute_value` on write payloads.","uniqueKey":"items.[INDEX].variant_attributes.items.[INDEX].value.oneOf.2","typeLabel":"boolean"},{"type":"array","items":{"type":"string","uniqueKey":"items.[INDEX].variant_attributes.items.[INDEX].value.oneOf.3.items.[INDEX]","typeLabel":"string"},"description":"Resolved value; same as `attribute_value` on write payloads.","uniqueKey":"items.[INDEX].variant_attributes.items.[INDEX].value.oneOf.3","typeLabel":"string[]"},{"type":"object","title":"ColorObject","description":"Resolved value; same as `attribute_value` on write payloads.","required":["name","hexcode"],"properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].variant_attributes.items.[INDEX].value.oneOf.4.name","typeLabel":"string"},"hexcode":{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].variant_attributes.items.[INDEX].value.oneOf.4.hexcode","typeLabel":"string"}},"uniqueKey":"items.[INDEX].variant_attributes.items.[INDEX].value.oneOf.4","typeLabel":"ColorObject · object"}],"uniqueKey":"items.[INDEX].variant_attributes.items.[INDEX].value","typeLabel":"string | number | boolean | string[] | ColorObject · object"},"attribute_id":{"type":"string","uniqueKey":"items.[INDEX].variant_attributes.items.[INDEX].attribute_id","typeLabel":"string"},"attribute_value":{"oneOf":[{"type":"string","description":"string value for attribute type **text**, **single select** and **date**.","uniqueKey":"items.[INDEX].variant_attributes.items.[INDEX].attribute_value.oneOf.0","typeLabel":"string"},{"type":"number","description":"numeric value for attribute type number.","uniqueKey":"items.[INDEX].variant_attributes.items.[INDEX].attribute_value.oneOf.1","typeLabel":"number"},{"type":"boolean","description":"true/false for attribute type boolean.","uniqueKey":"items.[INDEX].variant_attributes.items.[INDEX].attribute_value.oneOf.2","typeLabel":"boolean"},{"type":"array","items":{"type":"string","uniqueKey":"items.[INDEX].variant_attributes.items.[INDEX].attribute_value.oneOf.3.items.[INDEX]","typeLabel":"string"},"description":"for attribute type = multi-select","uniqueKey":"items.[INDEX].variant_attributes.items.[INDEX].attribute_value.oneOf.3","typeLabel":"string[]"},{"type":"object","title":"ColorObject","description":"for attribute type = color","required":["name","hexcode"],"properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].variant_attributes.items.[INDEX].attribute_value.oneOf.4.name","typeLabel":"string"},"hexcode":{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].variant_attributes.items.[INDEX].attribute_value.oneOf.4.hexcode","typeLabel":"string"}},"uniqueKey":"items.[INDEX].variant_attributes.items.[INDEX].attribute_value.oneOf.4","typeLabel":"ColorObject · object"}],"uniqueKey":"items.[INDEX].variant_attributes.items.[INDEX].attribute_value","typeLabel":"string | number | boolean | string[] | ColorObject · object"}},"examples":[],"x-tags":["Catalog"],"uniqueKey":"items.[INDEX].variant_attributes.items.[INDEX]","typeLabel":"ProductAttribute · object"},"uniqueKey":"items.[INDEX].variant_attributes","typeLabel":"ProductAttribute · object[]"},"description":{"oneOf":[{"type":"string","uniqueKey":"items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].description","typeLabel":"string | null"},"images":{"type":"array","items":{"type":"string","uniqueKey":"items.[INDEX].images.items.[INDEX]","typeLabel":"string"},"uniqueKey":"items.[INDEX].images","typeLabel":"string[]"},"videos":{"type":"array","items":{"type":"string","uniqueKey":"items.[INDEX].videos.items.[INDEX]","typeLabel":"string"},"uniqueKey":"items.[INDEX].videos","typeLabel":"string[]"},"seo":{"title":"Seo","type":"object","required":["title","description","keywords"],"properties":{"title":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].seo.title.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"items.[INDEX].seo.title.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"items.[INDEX].seo.title","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].seo.description.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"items.[INDEX].seo.description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"items.[INDEX].seo.description","typeLabel":"string | null"},"keywords":{"oneOf":[{"type":"array","isRequired":true,"uniqueKey":"items.[INDEX].seo.keywords.oneOf.0","typeLabel":"array"},{"type":"null","isRequired":true,"uniqueKey":"items.[INDEX].seo.keywords.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"items.[INDEX].seo.keywords","typeLabel":"array | null"}},"uniqueKey":"items.[INDEX].seo","typeLabel":"Seo · object"},"shipping":{"title":"ProductShipping","type":"object","required":["handling_charge"],"properties":{"handling_charge":{"description":"A handling charge is an additional fee applied to cover the costs associated with preparing, packaging, and processing an order for shipment or delivery.","type":"number","minimum":0,"isRequired":true,"uniqueKey":"items.[INDEX].shipping.handling_charge","typeLabel":"number"}},"x-tags":["Catalog"],"uniqueKey":"items.[INDEX].shipping","typeLabel":"ProductShipping · object"},"packaging":{"oneOf":[{"title":"ProductPackaging","type":"object","required":["pack_width","pack_height","pack_length","pack_dry_weight","units_per_pack","vertical_rotation"],"properties":{"pack_width":{"type":"number","format":"float","isRequired":true,"uniqueKey":"items.[INDEX].packaging.oneOf.0.pack_width","typeLabel":"number\u003cfloat>"},"pack_height":{"type":"number","format":"float","isRequired":true,"uniqueKey":"items.[INDEX].packaging.oneOf.0.pack_height","typeLabel":"number\u003cfloat>"},"pack_length":{"type":"number","format":"float","isRequired":true,"uniqueKey":"items.[INDEX].packaging.oneOf.0.pack_length","typeLabel":"number\u003cfloat>"},"pack_dry_weight":{"type":"number","format":"float","isRequired":true,"uniqueKey":"items.[INDEX].packaging.oneOf.0.pack_dry_weight","typeLabel":"number\u003cfloat>"},"units_per_pack":{"type":"integer","format":"int32","isRequired":true,"uniqueKey":"items.[INDEX].packaging.oneOf.0.units_per_pack","typeLabel":"integer\u003cint32>"},"vertical_rotation":{"description":"Indicates whether items can be rotated during packing or if they must be kept in a strictly vertical orientation.","type":"boolean","isRequired":true,"uniqueKey":"items.[INDEX].packaging.oneOf.0.vertical_rotation","typeLabel":"boolean"},"shipper_width":{"oneOf":[{"type":"number","format":"float","uniqueKey":"items.[INDEX].packaging.oneOf.0.shipper_width.oneOf.0","typeLabel":"number\u003cfloat>"},{"type":"null","format":"float","uniqueKey":"items.[INDEX].packaging.oneOf.0.shipper_width.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].packaging.oneOf.0.shipper_width","typeLabel":"number\u003cfloat> | null"},"shipper_height":{"oneOf":[{"type":"number","format":"float","uniqueKey":"items.[INDEX].packaging.oneOf.0.shipper_height.oneOf.0","typeLabel":"number\u003cfloat>"},{"type":"null","format":"float","uniqueKey":"items.[INDEX].packaging.oneOf.0.shipper_height.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].packaging.oneOf.0.shipper_height","typeLabel":"number\u003cfloat> | null"},"shipper_length":{"oneOf":[{"type":"number","format":"float","uniqueKey":"items.[INDEX].packaging.oneOf.0.shipper_length.oneOf.0","typeLabel":"number\u003cfloat>"},{"type":"null","format":"float","uniqueKey":"items.[INDEX].packaging.oneOf.0.shipper_length.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].packaging.oneOf.0.shipper_length","typeLabel":"number\u003cfloat> | null"},"shipper_dry_weight":{"oneOf":[{"type":"number","format":"float","uniqueKey":"items.[INDEX].packaging.oneOf.0.shipper_dry_weight.oneOf.0","typeLabel":"number\u003cfloat>"},{"type":"null","format":"float","uniqueKey":"items.[INDEX].packaging.oneOf.0.shipper_dry_weight.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].packaging.oneOf.0.shipper_dry_weight","typeLabel":"number\u003cfloat> | null"},"units_per_shipper":{"oneOf":[{"type":"integer","format":"int32","uniqueKey":"items.[INDEX].packaging.oneOf.0.units_per_shipper.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","uniqueKey":"items.[INDEX].packaging.oneOf.0.units_per_shipper.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].packaging.oneOf.0.units_per_shipper","typeLabel":"integer\u003cint32> | null"}},"x-tags":["Catalog"],"uniqueKey":"items.[INDEX].packaging.oneOf.0","typeLabel":"ProductPackaging · object"},{"title":"ProductPackaging","type":"null","required":["pack_width","pack_height","pack_length","pack_dry_weight","units_per_pack","vertical_rotation"],"properties":{"pack_width":{"type":"number","format":"float"},"pack_height":{"type":"number","format":"float"},"pack_length":{"type":"number","format":"float"},"pack_dry_weight":{"type":"number","format":"float"},"units_per_pack":{"type":"integer","format":"int32"},"vertical_rotation":{"description":"Indicates whether items can be rotated during packing or if they must be kept in a strictly vertical orientation.","type":"boolean"},"shipper_width":{"oneOf":[{"type":"number","format":"float"},{"type":"null","format":"float"}]},"shipper_height":{"oneOf":[{"type":"number","format":"float"},{"type":"null","format":"float"}]},"shipper_length":{"oneOf":[{"type":"number","format":"float"},{"type":"null","format":"float"}]},"shipper_dry_weight":{"oneOf":[{"type":"number","format":"float"},{"type":"null","format":"float"}]},"units_per_shipper":{"oneOf":[{"type":"integer","format":"int32"},{"type":"null","format":"int32"}]}},"x-tags":["Catalog"],"uniqueKey":"items.[INDEX].packaging.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].packaging","typeLabel":"ProductPackaging · object | null"},"related_products":{"type":"object","properties":{"cross_sell":{"description":"Array of IDs. The ID value should be the product ID if a non-variant product is selected. For variant products, the ID should be a combination of the product ID and variant ID, separated by a hyphen ('-').","type":"array","items":{"type":"string","uniqueKey":"items.[INDEX].related_products.cross_sell.items.[INDEX]","typeLabel":"string"},"uniqueKey":"items.[INDEX].related_products.cross_sell","typeLabel":"string[]"},"upsell":{"description":"Array of IDs. The ID value should be the product ID if a non-variant product is selected. For variant products, the ID should be a combination of the product ID and variant ID, separated by a hyphen ('-').","type":"array","items":{"type":"string","uniqueKey":"items.[INDEX].related_products.upsell.items.[INDEX]","typeLabel":"string"},"uniqueKey":"items.[INDEX].related_products.upsell","typeLabel":"string[]"}},"uniqueKey":"items.[INDEX].related_products","typeLabel":"object"},"promotions":{"oneOf":[{"type":"object","title":"DiscountBasedPromotion","description":"promotion_type = discount","required":["promotion_type","starts_at","details"],"x-tags":["Catalog"],"properties":{"promotion_type":{"enum":["discount"],"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.0.promotion_type","typeLabel":"enum\u003cstring>"},"starts_at":{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.0.starts_at","typeLabel":"string"},"details":{"type":"array","items":{"oneOf":[{"type":"object","title":"PercentageBasedDiscount","description":"promotion_type = discount","required":["discount_type","discount_percent","customer_group_id","minimum_quantity","maximum_quantity","maximum_discount_amount"],"properties":{"discount_type":{"type":"string","const":"percentage","isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.0.discount_type","typeLabel":"string"},"discount_percent":{"type":"number","isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.0.discount_percent","typeLabel":"number"},"customer_group_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.0.customer_group_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.0.customer_group_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.0.customer_group_id","typeLabel":"string | null"},"minimum_quantity":{"description":"It refers to the minimum quantity of a specific item a customer must purchase to qualify for the promotion.","type":"integer","default":1,"isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.0.minimum_quantity","typeLabel":"integer"},"maximum_quantity":{"oneOf":[{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"integer","isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.0.maximum_quantity.oneOf.0","typeLabel":"integer"},{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"null","isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.0.maximum_quantity.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.0.maximum_quantity","typeLabel":"integer | null"},"maximum_discount_amount":{"oneOf":[{"description":"When a value is specified, the discount amount will not exceed the defined maximum, ensuring that the promotion stays within a controlled discount range. If this field is set to null, it indicates that there is no limit to the discount amount.","type":"number","isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.0.maximum_discount_amount.oneOf.0","typeLabel":"number"},{"description":"When a value is specified, the discount amount will not exceed the defined maximum, ensuring that the promotion stays within a controlled discount range. If this field is set to null, it indicates that there is no limit to the discount amount.","type":"null","isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.0.maximum_discount_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.0.maximum_discount_amount","typeLabel":"number | null"}},"uniqueKey":"items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.0","typeLabel":"PercentageBasedDiscount · object"},{"type":"null","title":"PercentageBasedDiscount","description":"promotion_type = discount","required":["discount_type","discount_percent","customer_group_id","minimum_quantity","maximum_quantity","maximum_discount_amount"],"properties":{"discount_type":{"type":"string","const":"percentage"},"discount_percent":{"type":"number"},"customer_group_id":{"oneOf":[{"type":"string"},{"type":"null"}]},"minimum_quantity":{"description":"It refers to the minimum quantity of a specific item a customer must purchase to qualify for the promotion.","type":"integer","default":1},"maximum_quantity":{"oneOf":[{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"integer"},{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"null"}]},"maximum_discount_amount":{"oneOf":[{"description":"When a value is specified, the discount amount will not exceed the defined maximum, ensuring that the promotion stays within a controlled discount range. If this field is set to null, it indicates that there is no limit to the discount amount.","type":"number"},{"description":"When a value is specified, the discount amount will not exceed the defined maximum, ensuring that the promotion stays within a controlled discount range. If this field is set to null, it indicates that there is no limit to the discount amount.","type":"null"}]}},"uniqueKey":"items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.1","typeLabel":"null"},{"type":"object","title":"FixedAmountBasedDiscount","description":"promotion_type = discount","required":["discount_type","discount_fixed_amount","customer_group_id","minimum_quantity","maximum_quantity"],"properties":{"discount_type":{"type":"string","const":"fixed-amount","isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.2.discount_type","typeLabel":"string"},"discount_fixed_amount":{"type":"integer","isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.2.discount_fixed_amount","typeLabel":"integer"},"customer_group_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.2.customer_group_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.2.customer_group_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.2.customer_group_id","typeLabel":"string | null"},"minimum_quantity":{"description":"It refers to the minimum quantity of a specific item a customer must purchase to qualify for the promotion.","type":"integer","default":1,"isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.2.minimum_quantity","typeLabel":"integer"},"maximum_quantity":{"oneOf":[{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"integer","isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.2.maximum_quantity.oneOf.0","typeLabel":"integer"},{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"null","isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.2.maximum_quantity.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.2.maximum_quantity","typeLabel":"integer | null"}},"uniqueKey":"items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.2","typeLabel":"FixedAmountBasedDiscount · object"},{"type":"null","title":"FixedAmountBasedDiscount","description":"promotion_type = discount","required":["discount_type","discount_fixed_amount","customer_group_id","minimum_quantity","maximum_quantity"],"properties":{"discount_type":{"type":"string","const":"fixed-amount"},"discount_fixed_amount":{"type":"integer"},"customer_group_id":{"oneOf":[{"type":"string"},{"type":"null"}]},"minimum_quantity":{"description":"It refers to the minimum quantity of a specific item a customer must purchase to qualify for the promotion.","type":"integer","default":1},"maximum_quantity":{"oneOf":[{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"integer"},{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"null"}]}},"uniqueKey":"items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.3","typeLabel":"null"}],"uniqueKey":"items.[INDEX].promotions.oneOf.0.details.items.[INDEX]","typeLabel":"PercentageBasedDiscount · object · null · FixedAmountBasedDiscount · object · null"},"isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.0.details","typeLabel":"PercentageBasedDiscount · object · null · FixedAmountBasedDiscount · object · null[]"},"expires_at":{"oneOf":[{"description":"null means never expires.","type":"string","uniqueKey":"items.[INDEX].promotions.oneOf.0.expires_at.oneOf.0","typeLabel":"string"},{"description":"null means never expires.","type":"null","uniqueKey":"items.[INDEX].promotions.oneOf.0.expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].promotions.oneOf.0.expires_at","typeLabel":"string | null"}},"uniqueKey":"items.[INDEX].promotions.oneOf.0","typeLabel":"DiscountBasedPromotion · object"},{"type":"null","title":"DiscountBasedPromotion","description":"promotion_type = discount","required":["promotion_type","starts_at","details"],"x-tags":["Catalog"],"properties":{"promotion_type":{"enum":["discount"],"type":"string"},"starts_at":{"type":"string"},"expires_at":{"oneOf":[{"description":"null means never expires.","type":"string"},{"description":"null means never expires.","type":"null"}]},"details":{"type":"array","items":{"oneOf":[{"type":"object","title":"PercentageBasedDiscount","description":"promotion_type = discount","required":["discount_type","discount_percent","customer_group_id","minimum_quantity","maximum_quantity","maximum_discount_amount"],"properties":{"discount_type":{"type":"string","const":"percentage"},"discount_percent":{"type":"number"},"customer_group_id":{"oneOf":[{"type":"string"},{"type":"null"}]},"minimum_quantity":{"description":"It refers to the minimum quantity of a specific item a customer must purchase to qualify for the promotion.","type":"integer","default":1},"maximum_quantity":{"oneOf":[{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"integer"},{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"null"}]},"maximum_discount_amount":{"oneOf":[{"description":"When a value is specified, the discount amount will not exceed the defined maximum, ensuring that the promotion stays within a controlled discount range. If this field is set to null, it indicates that there is no limit to the discount amount.","type":"number"},{"description":"When a value is specified, the discount amount will not exceed the defined maximum, ensuring that the promotion stays within a controlled discount range. If this field is set to null, it indicates that there is no limit to the discount amount.","type":"null"}]}}},{"type":"null","title":"PercentageBasedDiscount","description":"promotion_type = discount","required":["discount_type","discount_percent","customer_group_id","minimum_quantity","maximum_quantity","maximum_discount_amount"],"properties":{"discount_type":{"type":"string","const":"percentage"},"discount_percent":{"type":"number"},"customer_group_id":{"oneOf":[{"type":"string"},{"type":"null"}]},"minimum_quantity":{"description":"It refers to the minimum quantity of a specific item a customer must purchase to qualify for the promotion.","type":"integer","default":1},"maximum_quantity":{"oneOf":[{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"integer"},{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"null"}]},"maximum_discount_amount":{"oneOf":[{"description":"When a value is specified, the discount amount will not exceed the defined maximum, ensuring that the promotion stays within a controlled discount range. If this field is set to null, it indicates that there is no limit to the discount amount.","type":"number"},{"description":"When a value is specified, the discount amount will not exceed the defined maximum, ensuring that the promotion stays within a controlled discount range. If this field is set to null, it indicates that there is no limit to the discount amount.","type":"null"}]}}},{"type":"object","title":"FixedAmountBasedDiscount","description":"promotion_type = discount","required":["discount_type","discount_fixed_amount","customer_group_id","minimum_quantity","maximum_quantity"],"properties":{"discount_type":{"type":"string","const":"fixed-amount"},"discount_fixed_amount":{"type":"integer"},"customer_group_id":{"oneOf":[{"type":"string"},{"type":"null"}]},"minimum_quantity":{"description":"It refers to the minimum quantity of a specific item a customer must purchase to qualify for the promotion.","type":"integer","default":1},"maximum_quantity":{"oneOf":[{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"integer"},{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"null"}]}}},{"type":"null","title":"FixedAmountBasedDiscount","description":"promotion_type = discount","required":["discount_type","discount_fixed_amount","customer_group_id","minimum_quantity","maximum_quantity"],"properties":{"discount_type":{"type":"string","const":"fixed-amount"},"discount_fixed_amount":{"type":"integer"},"customer_group_id":{"oneOf":[{"type":"string"},{"type":"null"}]},"minimum_quantity":{"description":"It refers to the minimum quantity of a specific item a customer must purchase to qualify for the promotion.","type":"integer","default":1},"maximum_quantity":{"oneOf":[{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"integer"},{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"null"}]}}}]}}},"uniqueKey":"items.[INDEX].promotions.oneOf.1","typeLabel":"null"},{"type":"object","title":"FixedPricePromotion","description":"promotion_type = fixed-price","required":["promotion_type","starts_at","details"],"x-tags":["Catalog"],"properties":{"promotion_type":{"enum":["fixed-price"],"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.2.promotion_type","typeLabel":"enum\u003cstring>"},"starts_at":{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.2.starts_at","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","required":["offer_price","customer_group_id","minimum_quantity","maximum_quantity"],"properties":{"offer_price":{"type":"number","isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.2.details.items.[INDEX].offer_price","typeLabel":"number"},"customer_group_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.2.details.items.[INDEX].customer_group_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.2.details.items.[INDEX].customer_group_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.2.details.items.[INDEX].customer_group_id","typeLabel":"string | null"},"minimum_quantity":{"description":"It refers to the minimum quantity of a specific item a customer must purchase to qualify for the promotion.","type":"integer","default":1,"isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.2.details.items.[INDEX].minimum_quantity","typeLabel":"integer"},"maximum_quantity":{"oneOf":[{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"integer","isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.2.details.items.[INDEX].maximum_quantity.oneOf.0","typeLabel":"integer"},{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"null","isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.2.details.items.[INDEX].maximum_quantity.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.2.details.items.[INDEX].maximum_quantity","typeLabel":"integer | null"}},"uniqueKey":"items.[INDEX].promotions.oneOf.2.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.2.details","typeLabel":"object[]"},"expires_at":{"oneOf":[{"description":"null means never expires.","type":"string","uniqueKey":"items.[INDEX].promotions.oneOf.2.expires_at.oneOf.0","typeLabel":"string"},{"description":"null means never expires.","type":"null","uniqueKey":"items.[INDEX].promotions.oneOf.2.expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].promotions.oneOf.2.expires_at","typeLabel":"string | null"}},"uniqueKey":"items.[INDEX].promotions.oneOf.2","typeLabel":"FixedPricePromotion · object"},{"type":"null","title":"FixedPricePromotion","description":"promotion_type = fixed-price","required":["promotion_type","starts_at","details"],"x-tags":["Catalog"],"properties":{"promotion_type":{"enum":["fixed-price"],"type":"string"},"starts_at":{"type":"string"},"expires_at":{"oneOf":[{"description":"null means never expires.","type":"string"},{"description":"null means never expires.","type":"null"}]},"details":{"type":"array","items":{"type":"object","required":["offer_price","customer_group_id","minimum_quantity","maximum_quantity"],"properties":{"offer_price":{"type":"number"},"customer_group_id":{"oneOf":[{"type":"string"},{"type":"null"}]},"minimum_quantity":{"description":"It refers to the minimum quantity of a specific item a customer must purchase to qualify for the promotion.","type":"integer","default":1},"maximum_quantity":{"oneOf":[{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"integer"},{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"null"}]}}}}},"uniqueKey":"items.[INDEX].promotions.oneOf.3","typeLabel":"null"},{"type":"object","title":"VolumeBasedPromotion","description":"promotion_type = volume-based","required":["promotion_type","starts_at","details"],"x-tags":["Catalog"],"properties":{"promotion_type":{"enum":["volume-based"],"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.4.promotion_type","typeLabel":"enum\u003cstring>"},"starts_at":{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.4.starts_at","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","required":["customer_group_id","slabs"],"properties":{"customer_group_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.4.details.items.[INDEX].customer_group_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.4.details.items.[INDEX].customer_group_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.4.details.items.[INDEX].customer_group_id","typeLabel":"string | null"},"slabs":{"type":"array","items":{"type":"object","required":["quantity","quantity_condition","discount_percent"],"properties":{"quantity":{"type":"integer","isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.4.details.items.[INDEX].slabs.items.[INDEX].quantity","typeLabel":"integer"},"quantity_condition":{"description":"This key defines how the system will evaluate the quantity to determine if the promotion should be applied, based on the specified slab.","enum":["less","less-or-equal","greater","greater-or-equal"],"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.4.details.items.[INDEX].slabs.items.[INDEX].quantity_condition","typeLabel":"enum\u003cstring>"},"discount_percent":{"type":"number","isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.4.details.items.[INDEX].slabs.items.[INDEX].discount_percent","typeLabel":"number"}},"uniqueKey":"items.[INDEX].promotions.oneOf.4.details.items.[INDEX].slabs.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.4.details.items.[INDEX].slabs","typeLabel":"object[]"}},"uniqueKey":"items.[INDEX].promotions.oneOf.4.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.4.details","typeLabel":"object[]"},"expires_at":{"oneOf":[{"description":"null means never expires.","type":"string","uniqueKey":"items.[INDEX].promotions.oneOf.4.expires_at.oneOf.0","typeLabel":"string"},{"description":"null means never expires.","type":"null","uniqueKey":"items.[INDEX].promotions.oneOf.4.expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].promotions.oneOf.4.expires_at","typeLabel":"string | null"}},"uniqueKey":"items.[INDEX].promotions.oneOf.4","typeLabel":"VolumeBasedPromotion · object"},{"type":"null","title":"VolumeBasedPromotion","description":"promotion_type = volume-based","required":["promotion_type","starts_at","details"],"x-tags":["Catalog"],"properties":{"promotion_type":{"enum":["volume-based"],"type":"string"},"starts_at":{"type":"string"},"expires_at":{"oneOf":[{"description":"null means never expires.","type":"string"},{"description":"null means never expires.","type":"null"}]},"details":{"type":"array","items":{"type":"object","required":["customer_group_id","slabs"],"properties":{"customer_group_id":{"oneOf":[{"type":"string"},{"type":"null"}]},"slabs":{"type":"array","items":{"type":"object","required":["quantity","quantity_condition","discount_percent"],"properties":{"quantity":{"type":"integer"},"quantity_condition":{"description":"This key defines how the system will evaluate the quantity to determine if the promotion should be applied, based on the specified slab.","enum":["less","less-or-equal","greater","greater-or-equal"],"type":"string"},"discount_percent":{"type":"number"}}}}}}}},"uniqueKey":"items.[INDEX].promotions.oneOf.5","typeLabel":"null"},{"type":"object","title":"FreeGoodsPromotion","description":"promotion_type = free-goods","required":["promotion_type","starts_at","details"],"x-tags":["Catalog"],"properties":{"promotion_type":{"enum":["free-goods"],"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.6.promotion_type","typeLabel":"enum\u003cstring>"},"starts_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.6.starts_at","typeLabel":"string\u003cdate-time>"},"details":{"type":"array","items":{"oneOf":[{"type":"object","title":"ScaleAutomatically","required":["auto_scale","slab","customer_group_id"],"properties":{"customer_group_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.6.details.items.[INDEX].oneOf.0.customer_group_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.6.details.items.[INDEX].oneOf.0.customer_group_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.6.details.items.[INDEX].oneOf.0.customer_group_id","typeLabel":"string | null"},"auto_scale":{"description":"The **auto_scale** key determines whether the promotion should be automatically adjusted based on the ratio between the quantities bought and the quantities received.\\n\\nIf **true**: The promotion will be applied dynamically according to the ratio of the buy quantity to the get quantity. For example, if the promotion is \\\"Buy 2, Get 1\\\" and the customer buys 4 items, they would receive 2 free items (scaling based on the original ratio).\\n\\nIf **false**: The promotion will be applied strictly according to the predefined conditions. For example, even if the customer buys more items, they will receive the fixed free quantity as defined in the original promotion (e.g., buying 4 would still only get them 1 free item).","type":"boolean","isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.6.details.items.[INDEX].oneOf.0.auto_scale","typeLabel":"boolean"},"slab":{"type":"object","properties":{"buy_quantity":{"type":"integer","isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.6.details.items.[INDEX].oneOf.0.slab.buy_quantity","typeLabel":"integer"},"get_quantity":{"type":"integer","isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.6.details.items.[INDEX].oneOf.0.slab.get_quantity","typeLabel":"integer"},"quantity_condition":{"description":"Defines how the system will evaluate the buy_quantity to determine if the promotion should be applied.","enum":["less","less-or-equal","greater","greater-or-equal"],"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.6.details.items.[INDEX].oneOf.0.slab.quantity_condition","typeLabel":"enum\u003cstring>"}},"required":["buy_quantity","get_quantity","quantity_condition"],"isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.6.details.items.[INDEX].oneOf.0.slab","typeLabel":"object"}},"uniqueKey":"items.[INDEX].promotions.oneOf.6.details.items.[INDEX].oneOf.0","typeLabel":"ScaleAutomatically · object"},{"type":"object","title":"CustomSlabs","required":["slabs","customer_group_id"],"properties":{"customer_group_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.6.details.items.[INDEX].oneOf.1.customer_group_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.6.details.items.[INDEX].oneOf.1.customer_group_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.6.details.items.[INDEX].oneOf.1.customer_group_id","typeLabel":"string | null"},"slabs":{"type":"array","items":{"type":"object","properties":{"buy_quantity":{"type":"integer","isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.6.details.items.[INDEX].oneOf.1.slabs.items.[INDEX].buy_quantity","typeLabel":"integer"},"get_quantity":{"type":"integer","isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.6.details.items.[INDEX].oneOf.1.slabs.items.[INDEX].get_quantity","typeLabel":"integer"},"quantity_condition":{"description":"Defines how the system will evaluate the buy_quantity to determine if the promotion should be applied.","enum":["less","less-or-equal","greater","greater-or-equal"],"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.6.details.items.[INDEX].oneOf.1.slabs.items.[INDEX].quantity_condition","typeLabel":"enum\u003cstring>"}},"required":["buy_quantity","get_quantity","quantity_condition"],"uniqueKey":"items.[INDEX].promotions.oneOf.6.details.items.[INDEX].oneOf.1.slabs.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.6.details.items.[INDEX].oneOf.1.slabs","typeLabel":"object[]"}},"uniqueKey":"items.[INDEX].promotions.oneOf.6.details.items.[INDEX].oneOf.1","typeLabel":"CustomSlabs · object"}],"uniqueKey":"items.[INDEX].promotions.oneOf.6.details.items.[INDEX]","typeLabel":"ScaleAutomatically · object | CustomSlabs · object"},"isRequired":true,"uniqueKey":"items.[INDEX].promotions.oneOf.6.details","typeLabel":"(ScaleAutomatically · object | CustomSlabs · object)[]"},"expires_at":{"oneOf":[{"description":"null means never expires.","type":"string","format":"date-time","uniqueKey":"items.[INDEX].promotions.oneOf.6.expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"null means never expires.","type":"null","format":"date-time","uniqueKey":"items.[INDEX].promotions.oneOf.6.expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].promotions.oneOf.6.expires_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"items.[INDEX].promotions.oneOf.6","typeLabel":"FreeGoodsPromotion · object"},{"type":"null","title":"FreeGoodsPromotion","description":"promotion_type = free-goods","required":["promotion_type","starts_at","details"],"x-tags":["Catalog"],"properties":{"promotion_type":{"enum":["free-goods"],"type":"string"},"starts_at":{"type":"string","format":"date-time"},"expires_at":{"oneOf":[{"description":"null means never expires.","type":"string","format":"date-time"},{"description":"null means never expires.","type":"null","format":"date-time"}]},"details":{"type":"array","items":{"oneOf":[{"type":"object","title":"ScaleAutomatically","required":["auto_scale","slab","customer_group_id"],"properties":{"customer_group_id":{"oneOf":[{"type":"string"},{"type":"null"}]},"auto_scale":{"description":"The **auto_scale** key determines whether the promotion should be automatically adjusted based on the ratio between the quantities bought and the quantities received.\\n\\nIf **true**: The promotion will be applied dynamically according to the ratio of the buy quantity to the get quantity. For example, if the promotion is \\\"Buy 2, Get 1\\\" and the customer buys 4 items, they would receive 2 free items (scaling based on the original ratio).\\n\\nIf **false**: The promotion will be applied strictly according to the predefined conditions. For example, even if the customer buys more items, they will receive the fixed free quantity as defined in the original promotion (e.g., buying 4 would still only get them 1 free item).","type":"boolean"},"slab":{"type":"object","properties":{"buy_quantity":{"type":"integer"},"get_quantity":{"type":"integer"},"quantity_condition":{"description":"Defines how the system will evaluate the buy_quantity to determine if the promotion should be applied.","enum":["less","less-or-equal","greater","greater-or-equal"],"type":"string"}},"required":["buy_quantity","get_quantity","quantity_condition"]}}},{"type":"object","title":"CustomSlabs","required":["slabs","customer_group_id"],"properties":{"customer_group_id":{"oneOf":[{"type":"string"},{"type":"null"}]},"slabs":{"type":"array","items":{"type":"object","properties":{"buy_quantity":{"type":"integer"},"get_quantity":{"type":"integer"},"quantity_condition":{"description":"Defines how the system will evaluate the buy_quantity to determine if the promotion should be applied.","enum":["less","less-or-equal","greater","greater-or-equal"],"type":"string"}},"required":["buy_quantity","get_quantity","quantity_condition"]}}}}]}}},"uniqueKey":"items.[INDEX].promotions.oneOf.7","typeLabel":"null"}],"uniqueKey":"items.[INDEX].promotions","typeLabel":"DiscountBasedPromotion · object · null · FixedPricePromotion · object · null · VolumeBasedPromotion · object · null · FreeGoodsPromotion · object · null"},"subscriptions":{"type":"array","items":{"title":"ProductSubscription","type":"object","required":["subscription_plan","billing_interval","billing_frequency","billing_limit","billing_trial_days","fulfill_separately","subscription_price"],"properties":{"subscription_plan":{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].subscriptions.items.[INDEX].subscription_plan","typeLabel":"string"},"billing_interval":{"type":"integer","format":"int32","isRequired":true,"uniqueKey":"items.[INDEX].subscriptions.items.[INDEX].billing_interval","typeLabel":"integer\u003cint32>"},"billing_frequency":{"enum":["monthly"],"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].subscriptions.items.[INDEX].billing_frequency","typeLabel":"enum\u003cstring>"},"billing_limit":{"oneOf":[{"type":"integer","isRequired":true,"uniqueKey":"items.[INDEX].subscriptions.items.[INDEX].billing_limit.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"items.[INDEX].subscriptions.items.[INDEX].billing_limit.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"items.[INDEX].subscriptions.items.[INDEX].billing_limit","typeLabel":"integer | null"},"billing_trial_days":{"type":"integer","format":"int32","default":0,"isRequired":true,"uniqueKey":"items.[INDEX].subscriptions.items.[INDEX].billing_trial_days","typeLabel":"integer\u003cint32>"},"fulfill_separately":{"type":"boolean","isRequired":true,"uniqueKey":"items.[INDEX].subscriptions.items.[INDEX].fulfill_separately","typeLabel":"boolean"},"subscription_price":{"type":"array","items":{"type":"object","required":["suscription_price","minimum_quantity","customer_group_id"],"properties":{"suscription_price":{"type":"number","format":"double","isRequired":true,"uniqueKey":"items.[INDEX].subscriptions.items.[INDEX].subscription_price.items.[INDEX].suscription_price","typeLabel":"number\u003cdouble>"},"minimum_quantity":{"type":"integer","default":1,"isRequired":true,"uniqueKey":"items.[INDEX].subscriptions.items.[INDEX].subscription_price.items.[INDEX].minimum_quantity","typeLabel":"integer"},"customer_group_id":{"oneOf":[{"description":"customer group id.","type":"string","isRequired":true,"uniqueKey":"items.[INDEX].subscriptions.items.[INDEX].subscription_price.items.[INDEX].customer_group_id.oneOf.0","typeLabel":"string"},{"description":"customer group id.","type":"null","isRequired":true,"uniqueKey":"items.[INDEX].subscriptions.items.[INDEX].subscription_price.items.[INDEX].customer_group_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"items.[INDEX].subscriptions.items.[INDEX].subscription_price.items.[INDEX].customer_group_id","typeLabel":"string | null"}},"uniqueKey":"items.[INDEX].subscriptions.items.[INDEX].subscription_price.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"items.[INDEX].subscriptions.items.[INDEX].subscription_price","typeLabel":"object[]"},"order_interval":{"oneOf":[{"type":"integer","uniqueKey":"items.[INDEX].subscriptions.items.[INDEX].order_interval.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"items.[INDEX].subscriptions.items.[INDEX].order_interval.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].subscriptions.items.[INDEX].order_interval","typeLabel":"integer | null"},"order_frequency":{"oneOf":[{"type":"string","enum":["monthly"],"uniqueKey":"items.[INDEX].subscriptions.items.[INDEX].order_frequency.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["monthly"],"uniqueKey":"items.[INDEX].subscriptions.items.[INDEX].order_frequency.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].subscriptions.items.[INDEX].order_frequency","typeLabel":"enum\u003cstring> | null"},"order_limit":{"oneOf":[{"type":"integer","uniqueKey":"items.[INDEX].subscriptions.items.[INDEX].order_limit.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"items.[INDEX].subscriptions.items.[INDEX].order_limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].subscriptions.items.[INDEX].order_limit","typeLabel":"integer | null"}},"x-tags":["Catalog"],"uniqueKey":"items.[INDEX].subscriptions.items.[INDEX]","typeLabel":"ProductSubscription · object"},"uniqueKey":"items.[INDEX].subscriptions","typeLabel":"ProductSubscription · object[]"}},"uniqueKey":"items.[INDEX]","typeLabel":"CreateVariant · object"},"uniqueKey":"","typeLabel":"CreateVariant · object[]"},"examples":{"Example":{"title":"Example","value":[{"name":"\u003cstring>","associated_options":[{"attribute_id":"\u003cstring>","attribute_value":"\u003cstring>"}],"is_default":true,"short_description":"\u003cstring>","metadata":{},"sku":"\u003cstring>","slug":"\u003cstring>","pricing":[{"customer_group_id":"\u003cstring>","cost_price":123,"listing_price":123,"selling_price":123,"tax_rate":123,"min_order_quantity":1,"max_order_quantity":123,"incremental_quantity":1}],"variant_attributes":[{"id":"\u003cstring>","value":"\u003cstring>","attribute_id":"\u003cstring>","attribute_value":"\u003cstring>"}],"description":"\u003cstring>","images":["\u003cstring>"],"videos":["\u003cstring>"],"packaging":{"pack_width":123,"pack_height":123,"pack_length":123,"pack_dry_weight":123,"units_per_pack":123,"vertical_rotation":true,"shipper_width":123,"shipper_height":123,"shipper_length":123,"shipper_dry_weight":123,"units_per_shipper":123},"related_products":{"cross_sell":["\u003cstring>"],"upsell":["\u003cstring>"]},"promotions":{"promotion_type":"discount","starts_at":"\u003cstring>","details":[{"discount_type":"percentage","discount_percent":123,"customer_group_id":"\u003cstring>","minimum_quantity":1,"maximum_quantity":123,"maximum_discount_amount":123}],"expires_at":"\u003cstring>"},"subscriptions":[{"subscription_plan":"\u003cstring>","billing_interval":123,"billing_frequency":"monthly","billing_limit":123,"billing_trial_days":0,"fulfill_separately":true,"subscription_price":[{"suscription_price":123,"minimum_quantity":1,"customer_group_id":"\u003cstring>"}],"order_interval":123,"order_frequency":"monthly","order_limit":123}]}]}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"82f067a7-e304-4cb4-982c-78c2fe2ae5b5":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"success":{"type":"boolean","uniqueKey":"success","typeLabel":"boolean"},"content":{"properties":{"variants":{"type":"array","items":{"type":"object","title":"VariantDetail","x-tags":["Catalog"],"properties":{"id":{"description":"variant id","type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].id","typeLabel":"string"},"active":{"type":"boolean","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].active","typeLabel":"boolean"},"stock_available":{"type":"boolean","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].stock_available","typeLabel":"boolean"},"is_default":{"type":"boolean","uniqueKey":"content.variants.items.[INDEX].is_default","typeLabel":"boolean"},"short_description":{"oneOf":[{"type":"string","uniqueKey":"content.variants.items.[INDEX].short_description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"content.variants.items.[INDEX].short_description.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].short_description","typeLabel":"string | null"},"metadata":{"oneOf":[{"type":"object","additionalProperties":{"type":"string","uniqueKey":"content.variants.items.[INDEX].metadata.oneOf.0.additionalProperties","typeLabel":"string"},"uniqueKey":"content.variants.items.[INDEX].metadata.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"string","uniqueKey":"content.variants.items.[INDEX].metadata.oneOf.1.additionalProperties","typeLabel":"string"},"uniqueKey":"content.variants.items.[INDEX].metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].metadata","typeLabel":"object | null"},"sku":{"oneOf":[{"description":"variant sku. can be null for digital product.","type":"string","uniqueKey":"content.variants.items.[INDEX].sku.oneOf.0","typeLabel":"string"},{"description":"variant sku. can be null for digital product.","type":"null","uniqueKey":"content.variants.items.[INDEX].sku.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].sku","typeLabel":"string | null"},"slug":{"description":"variant sku. can be null for digital product.","type":"string","uniqueKey":"content.variants.items.[INDEX].slug","typeLabel":"string"},"hsn_code":{"oneOf":[{"type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].hsn_code.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].hsn_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].hsn_code","typeLabel":"string | null"},"on_offer":{"type":"boolean","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].on_offer","typeLabel":"boolean"},"on_promotion":{"type":"boolean","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].on_promotion","typeLabel":"boolean"},"on_subscription":{"type":"boolean","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].on_subscription","typeLabel":"boolean"},"product_type":{"enum":["physical","digital"],"readOnly":true,"type":"string","uniqueKey":"content.variants.items.[INDEX].product_type","typeLabel":"enum\u003cstring>"},"product_id":{"type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].product_id","typeLabel":"string"},"product_name":{"type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].product_name","typeLabel":"string"},"pricing":{"type":"array","items":{"title":"ProductPricing","type":"object","required":["customer_group_id","cost_price","listing_price","selling_price","tax_rate"],"properties":{"customer_group_id":{"oneOf":[{"description":"customer group id. for different pricing model in case of multiple customer groups.","type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].pricing.items.[INDEX].customer_group_id.oneOf.0","typeLabel":"string"},{"description":"customer group id. for different pricing model in case of multiple customer groups.","type":"null","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].pricing.items.[INDEX].customer_group_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].pricing.items.[INDEX].customer_group_id","typeLabel":"string | null"},"cost_price":{"oneOf":[{"type":"number","format":"double","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].pricing.items.[INDEX].cost_price.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","format":"double","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].pricing.items.[INDEX].cost_price.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].pricing.items.[INDEX].cost_price","typeLabel":"number\u003cdouble> | null"},"listing_price":{"type":"number","format":"double","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].pricing.items.[INDEX].listing_price","typeLabel":"number\u003cdouble>"},"selling_price":{"type":"number","format":"double","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].pricing.items.[INDEX].selling_price","typeLabel":"number\u003cdouble>"},"tax_rate":{"type":"number","format":"double","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].pricing.items.[INDEX].tax_rate","typeLabel":"number\u003cdouble>"},"min_order_quantity":{"oneOf":[{"type":"integer","format":"int32","default":1,"uniqueKey":"content.variants.items.[INDEX].pricing.items.[INDEX].min_order_quantity.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","default":1,"uniqueKey":"content.variants.items.[INDEX].pricing.items.[INDEX].min_order_quantity.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].pricing.items.[INDEX].min_order_quantity","typeLabel":"integer\u003cint32> | null"},"max_order_quantity":{"oneOf":[{"type":"integer","format":"int32","uniqueKey":"content.variants.items.[INDEX].pricing.items.[INDEX].max_order_quantity.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","uniqueKey":"content.variants.items.[INDEX].pricing.items.[INDEX].max_order_quantity.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].pricing.items.[INDEX].max_order_quantity","typeLabel":"integer\u003cint32> | null"},"incremental_quantity":{"oneOf":[{"type":"integer","format":"int32","default":1,"uniqueKey":"content.variants.items.[INDEX].pricing.items.[INDEX].incremental_quantity.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","default":1,"uniqueKey":"content.variants.items.[INDEX].pricing.items.[INDEX].incremental_quantity.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].pricing.items.[INDEX].incremental_quantity","typeLabel":"integer\u003cint32> | null"},"tax_type":{"enum":["GST"],"readOnly":true,"type":"string","uniqueKey":"content.variants.items.[INDEX].pricing.items.[INDEX].tax_type","typeLabel":"enum\u003cstring>"}},"x-tags":["Catalog"],"uniqueKey":"content.variants.items.[INDEX].pricing.items.[INDEX]","typeLabel":"ProductPricing · object"},"uniqueKey":"content.variants.items.[INDEX].pricing","typeLabel":"ProductPricing · object[]"},"created_at":{"type":"string","format":"date-time","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"modified_at":{"type":"string","format":"date-time","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].modified_at","typeLabel":"string\u003cdate-time>"},"variant_attributes":{"type":"array","items":{"title":"ProductAttribute","type":"object","properties":{"id":{"description":"Attribute id as returned on SKU and search payloads; same as `attribute_id` on write.","type":"string","uniqueKey":"content.variants.items.[INDEX].variant_attributes.items.[INDEX].id","typeLabel":"string"},"name":{"description":"Display name; same as `attribute_name` on write payloads.","type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].variant_attributes.items.[INDEX].name","typeLabel":"string"},"type":{"description":"Same as `attribute_type` on write payloads.","type":"string","enum":["text","number","boolean","date","single-select","multi-select","color"],"readOnly":true,"uniqueKey":"content.variants.items.[INDEX].variant_attributes.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"value":{"oneOf":[{"type":"string","description":"Resolved value; same as `attribute_value` on write payloads.","uniqueKey":"content.variants.items.[INDEX].variant_attributes.items.[INDEX].value.oneOf.0","typeLabel":"string"},{"type":"number","description":"Resolved value; same as `attribute_value` on write payloads.","uniqueKey":"content.variants.items.[INDEX].variant_attributes.items.[INDEX].value.oneOf.1","typeLabel":"number"},{"type":"boolean","description":"Resolved value; same as `attribute_value` on write payloads.","uniqueKey":"content.variants.items.[INDEX].variant_attributes.items.[INDEX].value.oneOf.2","typeLabel":"boolean"},{"type":"array","items":{"type":"string","uniqueKey":"content.variants.items.[INDEX].variant_attributes.items.[INDEX].value.oneOf.3.items.[INDEX]","typeLabel":"string"},"description":"Resolved value; same as `attribute_value` on write payloads.","uniqueKey":"content.variants.items.[INDEX].variant_attributes.items.[INDEX].value.oneOf.3","typeLabel":"string[]"},{"type":"object","title":"ColorObject","description":"Resolved value; same as `attribute_value` on write payloads.","required":["name","hexcode"],"properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].variant_attributes.items.[INDEX].value.oneOf.4.name","typeLabel":"string"},"hexcode":{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].variant_attributes.items.[INDEX].value.oneOf.4.hexcode","typeLabel":"string"}},"uniqueKey":"content.variants.items.[INDEX].variant_attributes.items.[INDEX].value.oneOf.4","typeLabel":"ColorObject · object"}],"uniqueKey":"content.variants.items.[INDEX].variant_attributes.items.[INDEX].value","typeLabel":"string | number | boolean | string[] | ColorObject · object"},"is_visible":{"type":"boolean","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].variant_attributes.items.[INDEX].is_visible","typeLabel":"boolean"},"is_filterable":{"type":"boolean","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].variant_attributes.items.[INDEX].is_filterable","typeLabel":"boolean"},"attribute_id":{"type":"string","uniqueKey":"content.variants.items.[INDEX].variant_attributes.items.[INDEX].attribute_id","typeLabel":"string"},"attribute_name":{"type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].variant_attributes.items.[INDEX].attribute_name","typeLabel":"string"},"attribute_type":{"type":"string","enum":["text","number","boolean","date","single-select","multi-select","color"],"readOnly":true,"uniqueKey":"content.variants.items.[INDEX].variant_attributes.items.[INDEX].attribute_type","typeLabel":"enum\u003cstring>"},"attribute_value":{"oneOf":[{"type":"string","description":"string value for attribute type **text**, **single select** and **date**.","uniqueKey":"content.variants.items.[INDEX].variant_attributes.items.[INDEX].attribute_value.oneOf.0","typeLabel":"string"},{"type":"number","description":"numeric value for attribute type number.","uniqueKey":"content.variants.items.[INDEX].variant_attributes.items.[INDEX].attribute_value.oneOf.1","typeLabel":"number"},{"type":"boolean","description":"true/false for attribute type boolean.","uniqueKey":"content.variants.items.[INDEX].variant_attributes.items.[INDEX].attribute_value.oneOf.2","typeLabel":"boolean"},{"type":"array","items":{"type":"string","uniqueKey":"content.variants.items.[INDEX].variant_attributes.items.[INDEX].attribute_value.oneOf.3.items.[INDEX]","typeLabel":"string"},"description":"for attribute type = multi-select","uniqueKey":"content.variants.items.[INDEX].variant_attributes.items.[INDEX].attribute_value.oneOf.3","typeLabel":"string[]"},{"type":"object","title":"ColorObject","description":"for attribute type = color","required":["name","hexcode"],"properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].variant_attributes.items.[INDEX].attribute_value.oneOf.4.name","typeLabel":"string"},"hexcode":{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].variant_attributes.items.[INDEX].attribute_value.oneOf.4.hexcode","typeLabel":"string"}},"uniqueKey":"content.variants.items.[INDEX].variant_attributes.items.[INDEX].attribute_value.oneOf.4","typeLabel":"ColorObject · object"}],"uniqueKey":"content.variants.items.[INDEX].variant_attributes.items.[INDEX].attribute_value","typeLabel":"string | number | boolean | string[] | ColorObject · object"},"key":{"description":"Value in snake case.","type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].variant_attributes.items.[INDEX].key","typeLabel":"string"}},"examples":[],"x-tags":["Catalog"],"uniqueKey":"content.variants.items.[INDEX].variant_attributes.items.[INDEX]","typeLabel":"ProductAttribute · object"},"uniqueKey":"content.variants.items.[INDEX].variant_attributes","typeLabel":"ProductAttribute · object[]"},"name":{"type":"string","uniqueKey":"content.variants.items.[INDEX].name","typeLabel":"string"},"associated_options":{"type":"array","items":{"title":"AssociatedOption","type":"object","required":["attribute_id","attribute_value"],"properties":{"attribute_id":{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].associated_options.items.[INDEX].attribute_id","typeLabel":"string"},"attribute_value":{"oneOf":[{"type":"string","description":"Attributes with type of **single-select**, the value will be represented as a **string**.","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].associated_options.items.[INDEX].attribute_value.oneOf.0","typeLabel":"string"},{"type":"object","title":"ColorObject","description":"**Color** attributes will have their value represented as a color object, specifying the color details with name and hexcode.","required":["name","hexcode"],"properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].associated_options.items.[INDEX].attribute_value.oneOf.1.name","typeLabel":"string"},"hexcode":{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].associated_options.items.[INDEX].attribute_value.oneOf.1.hexcode","typeLabel":"string"}},"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].associated_options.items.[INDEX].attribute_value.oneOf.1","typeLabel":"ColorObject · object"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].associated_options.items.[INDEX].attribute_value","typeLabel":"string | ColorObject · object"},"attribute_name":{"type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].associated_options.items.[INDEX].attribute_name","typeLabel":"string"},"attribute_type":{"enum":["single-select","color"],"readOnly":true,"type":"string","uniqueKey":"content.variants.items.[INDEX].associated_options.items.[INDEX].attribute_type","typeLabel":"enum\u003cstring>"},"key":{"description":"value in snake case.","type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].associated_options.items.[INDEX].key","typeLabel":"string"}},"uniqueKey":"content.variants.items.[INDEX].associated_options.items.[INDEX]","typeLabel":"AssociatedOption · object"},"uniqueKey":"content.variants.items.[INDEX].associated_options","typeLabel":"AssociatedOption · object[]"},"images":{"type":"array","items":{"title":"ProductImage","type":"object","properties":{"title":{"oneOf":[{"type":"string","maxLength":128,"uniqueKey":"content.variants.items.[INDEX].images.items.[INDEX].title.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":128,"uniqueKey":"content.variants.items.[INDEX].images.items.[INDEX].title.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].images.items.[INDEX].title","typeLabel":"string | null"},"alternate_text":{"oneOf":[{"type":"string","maxLength":128,"uniqueKey":"content.variants.items.[INDEX].images.items.[INDEX].alternate_text.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":128,"uniqueKey":"content.variants.items.[INDEX].images.items.[INDEX].alternate_text.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].images.items.[INDEX].alternate_text","typeLabel":"string | null"},"sort_order":{"type":"integer","format":"int32","uniqueKey":"content.variants.items.[INDEX].images.items.[INDEX].sort_order","typeLabel":"integer\u003cint32>"},"url_tiny":{"type":"string","maxLength":512,"uniqueKey":"content.variants.items.[INDEX].images.items.[INDEX].url_tiny","typeLabel":"string"},"url_thumbnail":{"type":"string","maxLength":512,"uniqueKey":"content.variants.items.[INDEX].images.items.[INDEX].url_thumbnail","typeLabel":"string"},"url_standard":{"type":"string","maxLength":512,"uniqueKey":"content.variants.items.[INDEX].images.items.[INDEX].url_standard","typeLabel":"string"},"url_zoom":{"type":"string","maxLength":512,"uniqueKey":"content.variants.items.[INDEX].images.items.[INDEX].url_zoom","typeLabel":"string"},"file_id":{"type":"string","uniqueKey":"content.variants.items.[INDEX].images.items.[INDEX].file_id","typeLabel":"string"},"file_type":{"description":"MIME type of the file, e.g. `image/png`.","type":"string","uniqueKey":"content.variants.items.[INDEX].images.items.[INDEX].file_type","typeLabel":"string"}},"x-tags":["Catalog"],"uniqueKey":"content.variants.items.[INDEX].images.items.[INDEX]","typeLabel":"ProductImage · object"},"uniqueKey":"content.variants.items.[INDEX].images","typeLabel":"ProductImage · object[]"},"sales_channels":{"type":"array","items":{"type":"object","title":"SalesChannel","required":["id","name","active"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].sales_channels.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","readOnly":true,"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].sales_channels.items.[INDEX].name","typeLabel":"string"},"active":{"type":"boolean","readOnly":true,"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].sales_channels.items.[INDEX].active","typeLabel":"boolean"},"kind":{"type":"string","enum":["storefront","marketplace"],"uniqueKey":"content.variants.items.[INDEX].sales_channels.items.[INDEX].kind","typeLabel":"enum\u003cstring>"},"sales_channel_type":{"oneOf":[{"type":"string","description":"Observed values: `commercengine`, `web`, `pos`.","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].sales_channels.items.[INDEX].sales_channel_type.oneOf.0","typeLabel":"string"},{"type":"null","description":"Observed values: `commercengine`, `web`, `pos`.","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].sales_channels.items.[INDEX].sales_channel_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].sales_channels.items.[INDEX].sales_channel_type","typeLabel":"string | null"},"sales_channel_slug":{"oneOf":[{"type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].sales_channels.items.[INDEX].sales_channel_slug.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].sales_channels.items.[INDEX].sales_channel_slug.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].sales_channels.items.[INDEX].sales_channel_slug","typeLabel":"string | null"}},"uniqueKey":"content.variants.items.[INDEX].sales_channels.items.[INDEX]","typeLabel":"SalesChannel · object"},"uniqueKey":"content.variants.items.[INDEX].sales_channels","typeLabel":"SalesChannel · object[]"},"status":{"enum":["draft","active","inactive"],"description":"Computed status of the variant (same convention as product `status`).","readOnly":true,"type":"string","uniqueKey":"content.variants.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"packaging":{"oneOf":[{"type":"object","title":"ProductPackaging","description":"Variant packing dimensions. `null` when none configured.","required":["pack_width","pack_height","pack_length","pack_dry_weight","units_per_pack","vertical_rotation"],"x-tags":["Catalog"],"properties":{"pack_width":{"type":"number","format":"float","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].packaging.oneOf.0.pack_width","typeLabel":"number\u003cfloat>"},"pack_height":{"type":"number","format":"float","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].packaging.oneOf.0.pack_height","typeLabel":"number\u003cfloat>"},"pack_length":{"type":"number","format":"float","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].packaging.oneOf.0.pack_length","typeLabel":"number\u003cfloat>"},"pack_dry_weight":{"type":"number","format":"float","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].packaging.oneOf.0.pack_dry_weight","typeLabel":"number\u003cfloat>"},"units_per_pack":{"type":"integer","format":"int32","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].packaging.oneOf.0.units_per_pack","typeLabel":"integer\u003cint32>"},"vertical_rotation":{"description":"Indicates whether items can be rotated during packing or if they must be kept in a strictly vertical orientation.","type":"boolean","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].packaging.oneOf.0.vertical_rotation","typeLabel":"boolean"},"product_id":{"type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].packaging.oneOf.0.product_id","typeLabel":"string"},"product_variant_id":{"oneOf":[{"description":"`null` when packaging applies to a product without variants.","type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].packaging.oneOf.0.product_variant_id.oneOf.0","typeLabel":"string"},{"description":"`null` when packaging applies to a product without variants.","type":"null","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].packaging.oneOf.0.product_variant_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].packaging.oneOf.0.product_variant_id","typeLabel":"string | null"},"product_name":{"type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].packaging.oneOf.0.product_name","typeLabel":"string"},"variant_name":{"oneOf":[{"description":"`null` when packaging applies to a product without variants.","type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].packaging.oneOf.0.variant_name.oneOf.0","typeLabel":"string"},{"description":"`null` when packaging applies to a product without variants.","type":"null","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].packaging.oneOf.0.variant_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].packaging.oneOf.0.variant_name","typeLabel":"string | null"},"shipper_width":{"oneOf":[{"type":"number","format":"float","uniqueKey":"content.variants.items.[INDEX].packaging.oneOf.0.shipper_width.oneOf.0","typeLabel":"number\u003cfloat>"},{"type":"null","format":"float","uniqueKey":"content.variants.items.[INDEX].packaging.oneOf.0.shipper_width.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].packaging.oneOf.0.shipper_width","typeLabel":"number\u003cfloat> | null"},"shipper_height":{"oneOf":[{"type":"number","format":"float","uniqueKey":"content.variants.items.[INDEX].packaging.oneOf.0.shipper_height.oneOf.0","typeLabel":"number\u003cfloat>"},{"type":"null","format":"float","uniqueKey":"content.variants.items.[INDEX].packaging.oneOf.0.shipper_height.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].packaging.oneOf.0.shipper_height","typeLabel":"number\u003cfloat> | null"},"shipper_length":{"oneOf":[{"type":"number","format":"float","uniqueKey":"content.variants.items.[INDEX].packaging.oneOf.0.shipper_length.oneOf.0","typeLabel":"number\u003cfloat>"},{"type":"null","format":"float","uniqueKey":"content.variants.items.[INDEX].packaging.oneOf.0.shipper_length.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].packaging.oneOf.0.shipper_length","typeLabel":"number\u003cfloat> | null"},"shipper_dry_weight":{"oneOf":[{"type":"number","format":"float","uniqueKey":"content.variants.items.[INDEX].packaging.oneOf.0.shipper_dry_weight.oneOf.0","typeLabel":"number\u003cfloat>"},{"type":"null","format":"float","uniqueKey":"content.variants.items.[INDEX].packaging.oneOf.0.shipper_dry_weight.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].packaging.oneOf.0.shipper_dry_weight","typeLabel":"number\u003cfloat> | null"},"units_per_shipper":{"oneOf":[{"type":"integer","format":"int32","uniqueKey":"content.variants.items.[INDEX].packaging.oneOf.0.units_per_shipper.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","uniqueKey":"content.variants.items.[INDEX].packaging.oneOf.0.units_per_shipper.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].packaging.oneOf.0.units_per_shipper","typeLabel":"integer\u003cint32> | null"}},"uniqueKey":"content.variants.items.[INDEX].packaging.oneOf.0","typeLabel":"ProductPackaging · object"},{"type":"null","title":"ProductPackaging","description":"Variant packing dimensions. `null` when none configured.","required":["pack_width","pack_height","pack_length","pack_dry_weight","units_per_pack","vertical_rotation"],"x-tags":["Catalog"],"properties":{"product_id":{"type":"string","readOnly":true},"product_variant_id":{"oneOf":[{"description":"`null` when packaging applies to a product without variants.","type":"string","readOnly":true},{"description":"`null` when packaging applies to a product without variants.","type":"null","readOnly":true}]},"product_name":{"type":"string","readOnly":true},"variant_name":{"oneOf":[{"description":"`null` when packaging applies to a product without variants.","type":"string","readOnly":true},{"description":"`null` when packaging applies to a product without variants.","type":"null","readOnly":true}]},"pack_width":{"type":"number","format":"float"},"pack_height":{"type":"number","format":"float"},"pack_length":{"type":"number","format":"float"},"pack_dry_weight":{"type":"number","format":"float"},"units_per_pack":{"type":"integer","format":"int32"},"vertical_rotation":{"description":"Indicates whether items can be rotated during packing or if they must be kept in a strictly vertical orientation.","type":"boolean"},"shipper_width":{"oneOf":[{"type":"number","format":"float"},{"type":"null","format":"float"}]},"shipper_height":{"oneOf":[{"type":"number","format":"float"},{"type":"null","format":"float"}]},"shipper_length":{"oneOf":[{"type":"number","format":"float"},{"type":"null","format":"float"}]},"shipper_dry_weight":{"oneOf":[{"type":"number","format":"float"},{"type":"null","format":"float"}]},"units_per_shipper":{"oneOf":[{"type":"integer","format":"int32"},{"type":"null","format":"int32"}]}},"uniqueKey":"content.variants.items.[INDEX].packaging.oneOf.1","typeLabel":"null"},{"type":"null","description":"Variant packing dimensions. `null` when none configured.","uniqueKey":"content.variants.items.[INDEX].packaging.oneOf.2","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].packaging","typeLabel":"ProductPackaging · object · null · null"},"shipping":{"oneOf":[{"type":"object","title":"ProductShipping","description":"Variant shipping configuration. `null` when none configured.","required":["handling_charge"],"x-tags":["Catalog"],"properties":{"handling_charge":{"description":"A handling charge is an additional fee applied to cover the costs associated with preparing, packaging, and processing an order for shipment or delivery.","type":"number","minimum":0,"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].shipping.oneOf.0.handling_charge","typeLabel":"number"}},"uniqueKey":"content.variants.items.[INDEX].shipping.oneOf.0","typeLabel":"ProductShipping · object"},{"type":"null","description":"Variant shipping configuration. `null` when none configured.","uniqueKey":"content.variants.items.[INDEX].shipping.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].shipping","typeLabel":"ProductShipping · object | null"},"description":{"oneOf":[{"type":"string","uniqueKey":"content.variants.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"content.variants.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].description","typeLabel":"string | null"},"videos":{"type":"array","items":{"title":"ProductVideo","type":"object","properties":{"title":{"oneOf":[{"type":"string","uniqueKey":"content.variants.items.[INDEX].videos.items.[INDEX].title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"content.variants.items.[INDEX].videos.items.[INDEX].title.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].videos.items.[INDEX].title","typeLabel":"string | null"},"alternate_text":{"oneOf":[{"type":"string","uniqueKey":"content.variants.items.[INDEX].videos.items.[INDEX].alternate_text.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"content.variants.items.[INDEX].videos.items.[INDEX].alternate_text.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].videos.items.[INDEX].alternate_text","typeLabel":"string | null"},"sort_order":{"type":"integer","uniqueKey":"content.variants.items.[INDEX].videos.items.[INDEX].sort_order","typeLabel":"integer"},"video_preview_url":{"type":"string","uniqueKey":"content.variants.items.[INDEX].videos.items.[INDEX].video_preview_url","typeLabel":"string"},"video_stream_hls_url":{"type":"string","uniqueKey":"content.variants.items.[INDEX].videos.items.[INDEX].video_stream_hls_url","typeLabel":"string"},"video_stream_dash_url":{"type":"string","uniqueKey":"content.variants.items.[INDEX].videos.items.[INDEX].video_stream_dash_url","typeLabel":"string"},"image_thumbnail_url":{"type":"string","uniqueKey":"content.variants.items.[INDEX].videos.items.[INDEX].image_thumbnail_url","typeLabel":"string"},"video_duration":{"oneOf":[{"type":"number","uniqueKey":"content.variants.items.[INDEX].videos.items.[INDEX].video_duration.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"content.variants.items.[INDEX].videos.items.[INDEX].video_duration.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].videos.items.[INDEX].video_duration","typeLabel":"number | null"},"file_id":{"type":"string","uniqueKey":"content.variants.items.[INDEX].videos.items.[INDEX].file_id","typeLabel":"string"}},"x-tags":["Catalog"],"uniqueKey":"content.variants.items.[INDEX].videos.items.[INDEX]","typeLabel":"ProductVideo · object"},"uniqueKey":"content.variants.items.[INDEX].videos","typeLabel":"ProductVideo · object[]"},"seo":{"title":"Seo","type":"object","required":["title","description","keywords"],"properties":{"title":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].seo.title.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].seo.title.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].seo.title","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].seo.description.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].seo.description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].seo.description","typeLabel":"string | null"},"keywords":{"oneOf":[{"type":"array","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].seo.keywords.oneOf.0","typeLabel":"array"},{"type":"null","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].seo.keywords.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].seo.keywords","typeLabel":"array | null"}},"uniqueKey":"content.variants.items.[INDEX].seo","typeLabel":"Seo · object"},"related_products":{"type":"object","properties":{"upsell":{"type":"array","items":{"title":"ProductBasicDetail","type":"object","properties":{"id":{"description":"product id or combination of product id and variant id separated by hyphen.","type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].id","typeLabel":"string"},"product_id":{"type":"string","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].product_id","typeLabel":"string"},"product_name":{"type":"string","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].product_name","typeLabel":"string"},"product_type":{"enum":["physical","digital","bundle"],"type":"string","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].product_type","typeLabel":"enum\u003cstring>"},"status":{"enum":["draft","active","inactive"],"readOnly":true,"type":"string","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"tags":{"type":"array","items":{"type":"string","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].tags.items.[INDEX]","typeLabel":"string"},"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].tags","typeLabel":"string[]"},"reviews_rating_sum":{"type":"integer","format":"int32","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].reviews_rating_sum","typeLabel":"integer\u003cint32>"},"reviews_count":{"type":"integer","format":"int32","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].reviews_count","typeLabel":"integer\u003cint32>"},"hsn_code":{"oneOf":[{"type":"string","maxLength":128,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].hsn_code.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":128,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].hsn_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].hsn_code","typeLabel":"string | null"},"variant_id":{"oneOf":[{"type":"string","maxLength":128,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].variant_id.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":128,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].variant_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].variant_id","typeLabel":"string | null"},"variant_name":{"oneOf":[{"type":"string","maxLength":128,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].variant_name.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":128,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].variant_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].variant_name","typeLabel":"string | null"},"slug":{"type":"string","maxLength":128,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].slug","typeLabel":"string"},"sku":{"oneOf":[{"type":"string","maxLength":128,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].sku.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":128,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].sku.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].sku","typeLabel":"string | null"},"associated_options":{"type":"array","items":{"title":"AssociatedOption","type":"object","required":["attribute_id","attribute_value"],"properties":{"attribute_id":{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].associated_options.items.[INDEX].attribute_id","typeLabel":"string"},"attribute_value":{"oneOf":[{"type":"string","description":"Attributes with type of **single-select**, the value will be represented as a **string**.","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].associated_options.items.[INDEX].attribute_value.oneOf.0","typeLabel":"string"},{"type":"object","title":"ColorObject","description":"**Color** attributes will have their value represented as a color object, specifying the color details with name and hexcode.","required":["name","hexcode"],"properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].associated_options.items.[INDEX].attribute_value.oneOf.1.name","typeLabel":"string"},"hexcode":{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].associated_options.items.[INDEX].attribute_value.oneOf.1.hexcode","typeLabel":"string"}},"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].associated_options.items.[INDEX].attribute_value.oneOf.1","typeLabel":"ColorObject · object"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].associated_options.items.[INDEX].attribute_value","typeLabel":"string | ColorObject · object"},"attribute_name":{"type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].associated_options.items.[INDEX].attribute_name","typeLabel":"string"},"attribute_type":{"enum":["single-select","color"],"readOnly":true,"type":"string","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].associated_options.items.[INDEX].attribute_type","typeLabel":"enum\u003cstring>"},"key":{"description":"value in snake case.","type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].associated_options.items.[INDEX].key","typeLabel":"string"}},"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].associated_options.items.[INDEX]","typeLabel":"AssociatedOption · object"},"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].associated_options","typeLabel":"AssociatedOption · object[]"},"active":{"type":"boolean","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].active","typeLabel":"boolean"},"stock_available":{"type":"boolean","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].stock_available","typeLabel":"boolean"},"images":{"type":"array","items":{"title":"ProductImage","type":"object","properties":{"title":{"oneOf":[{"type":"string","maxLength":128,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].images.items.[INDEX].title.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":128,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].images.items.[INDEX].title.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].images.items.[INDEX].title","typeLabel":"string | null"},"alternate_text":{"oneOf":[{"type":"string","maxLength":128,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].images.items.[INDEX].alternate_text.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":128,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].images.items.[INDEX].alternate_text.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].images.items.[INDEX].alternate_text","typeLabel":"string | null"},"sort_order":{"type":"integer","format":"int32","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].images.items.[INDEX].sort_order","typeLabel":"integer\u003cint32>"},"url_tiny":{"type":"string","maxLength":512,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].images.items.[INDEX].url_tiny","typeLabel":"string"},"url_thumbnail":{"type":"string","maxLength":512,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].images.items.[INDEX].url_thumbnail","typeLabel":"string"},"url_standard":{"type":"string","maxLength":512,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].images.items.[INDEX].url_standard","typeLabel":"string"},"url_zoom":{"type":"string","maxLength":512,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].images.items.[INDEX].url_zoom","typeLabel":"string"},"file_id":{"type":"string","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].images.items.[INDEX].file_id","typeLabel":"string"},"file_type":{"description":"MIME type of the file, e.g. `image/png`.","type":"string","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].images.items.[INDEX].file_type","typeLabel":"string"}},"x-tags":["Catalog"],"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].images.items.[INDEX]","typeLabel":"ProductImage · object"},"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].images","typeLabel":"ProductImage · object[]"},"pricing":{"type":"array","items":{"title":"ProductPricing","type":"object","required":["customer_group_id","cost_price","listing_price","selling_price","tax_rate"],"properties":{"customer_group_id":{"oneOf":[{"description":"customer group id. for different pricing model in case of multiple customer groups.","type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].pricing.items.[INDEX].customer_group_id.oneOf.0","typeLabel":"string"},{"description":"customer group id. for different pricing model in case of multiple customer groups.","type":"null","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].pricing.items.[INDEX].customer_group_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].pricing.items.[INDEX].customer_group_id","typeLabel":"string | null"},"cost_price":{"oneOf":[{"type":"number","format":"double","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].pricing.items.[INDEX].cost_price.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","format":"double","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].pricing.items.[INDEX].cost_price.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].pricing.items.[INDEX].cost_price","typeLabel":"number\u003cdouble> | null"},"listing_price":{"type":"number","format":"double","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].pricing.items.[INDEX].listing_price","typeLabel":"number\u003cdouble>"},"selling_price":{"type":"number","format":"double","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].pricing.items.[INDEX].selling_price","typeLabel":"number\u003cdouble>"},"tax_rate":{"type":"number","format":"double","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].pricing.items.[INDEX].tax_rate","typeLabel":"number\u003cdouble>"},"min_order_quantity":{"oneOf":[{"type":"integer","format":"int32","default":1,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].pricing.items.[INDEX].min_order_quantity.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","default":1,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].pricing.items.[INDEX].min_order_quantity.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].pricing.items.[INDEX].min_order_quantity","typeLabel":"integer\u003cint32> | null"},"max_order_quantity":{"oneOf":[{"type":"integer","format":"int32","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].pricing.items.[INDEX].max_order_quantity.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].pricing.items.[INDEX].max_order_quantity.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].pricing.items.[INDEX].max_order_quantity","typeLabel":"integer\u003cint32> | null"},"incremental_quantity":{"oneOf":[{"type":"integer","format":"int32","default":1,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].pricing.items.[INDEX].incremental_quantity.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","default":1,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].pricing.items.[INDEX].incremental_quantity.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].pricing.items.[INDEX].incremental_quantity","typeLabel":"integer\u003cint32> | null"},"tax_type":{"enum":["GST"],"readOnly":true,"type":"string","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].pricing.items.[INDEX].tax_type","typeLabel":"enum\u003cstring>"}},"x-tags":["Catalog"],"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].pricing.items.[INDEX]","typeLabel":"ProductPricing · object"},"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].pricing","typeLabel":"ProductPricing · object[]"},"metadata":{"oneOf":[{"type":"object","additionalProperties":{"type":"string","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].metadata.oneOf.0.additionalProperties","typeLabel":"string"},"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].metadata.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"string","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].metadata.oneOf.1.additionalProperties","typeLabel":"string"},"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].metadata","typeLabel":"object | null"},"attributes":{"type":"array","items":{"title":"ProductAttribute","type":"object","properties":{"id":{"description":"Attribute id as returned on SKU and search payloads; same as `attribute_id` on write.","type":"string","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].attributes.items.[INDEX].id","typeLabel":"string"},"name":{"description":"Display name; same as `attribute_name` on write payloads.","type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].attributes.items.[INDEX].name","typeLabel":"string"},"type":{"description":"Same as `attribute_type` on write payloads.","type":"string","enum":["text","number","boolean","date","single-select","multi-select","color"],"readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].attributes.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"value":{"oneOf":[{"type":"string","description":"Resolved value; same as `attribute_value` on write payloads.","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].attributes.items.[INDEX].value.oneOf.0","typeLabel":"string"},{"type":"number","description":"Resolved value; same as `attribute_value` on write payloads.","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].attributes.items.[INDEX].value.oneOf.1","typeLabel":"number"},{"type":"boolean","description":"Resolved value; same as `attribute_value` on write payloads.","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].attributes.items.[INDEX].value.oneOf.2","typeLabel":"boolean"},{"type":"array","items":{"type":"string","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].attributes.items.[INDEX].value.oneOf.3.items.[INDEX]","typeLabel":"string"},"description":"Resolved value; same as `attribute_value` on write payloads.","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].attributes.items.[INDEX].value.oneOf.3","typeLabel":"string[]"},{"type":"object","title":"ColorObject","description":"Resolved value; same as `attribute_value` on write payloads.","required":["name","hexcode"],"properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].attributes.items.[INDEX].value.oneOf.4.name","typeLabel":"string"},"hexcode":{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].attributes.items.[INDEX].value.oneOf.4.hexcode","typeLabel":"string"}},"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].attributes.items.[INDEX].value.oneOf.4","typeLabel":"ColorObject · object"}],"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].attributes.items.[INDEX].value","typeLabel":"string | number | boolean | string[] | ColorObject · object"},"is_visible":{"type":"boolean","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].attributes.items.[INDEX].is_visible","typeLabel":"boolean"},"is_filterable":{"type":"boolean","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].attributes.items.[INDEX].is_filterable","typeLabel":"boolean"},"attribute_id":{"type":"string","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].attributes.items.[INDEX].attribute_id","typeLabel":"string"},"attribute_name":{"type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].attributes.items.[INDEX].attribute_name","typeLabel":"string"},"attribute_type":{"type":"string","enum":["text","number","boolean","date","single-select","multi-select","color"],"readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].attributes.items.[INDEX].attribute_type","typeLabel":"enum\u003cstring>"},"attribute_value":{"oneOf":[{"type":"string","description":"string value for attribute type **text**, **single select** and **date**.","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].attributes.items.[INDEX].attribute_value.oneOf.0","typeLabel":"string"},{"type":"number","description":"numeric value for attribute type number.","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].attributes.items.[INDEX].attribute_value.oneOf.1","typeLabel":"number"},{"type":"boolean","description":"true/false for attribute type boolean.","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].attributes.items.[INDEX].attribute_value.oneOf.2","typeLabel":"boolean"},{"type":"array","items":{"type":"string","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].attributes.items.[INDEX].attribute_value.oneOf.3.items.[INDEX]","typeLabel":"string"},"description":"for attribute type = multi-select","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].attributes.items.[INDEX].attribute_value.oneOf.3","typeLabel":"string[]"},{"type":"object","title":"ColorObject","description":"for attribute type = color","required":["name","hexcode"],"properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].attributes.items.[INDEX].attribute_value.oneOf.4.name","typeLabel":"string"},"hexcode":{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].attributes.items.[INDEX].attribute_value.oneOf.4.hexcode","typeLabel":"string"}},"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].attributes.items.[INDEX].attribute_value.oneOf.4","typeLabel":"ColorObject · object"}],"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].attributes.items.[INDEX].attribute_value","typeLabel":"string | number | boolean | string[] | ColorObject · object"},"key":{"description":"Value in snake case.","type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].attributes.items.[INDEX].key","typeLabel":"string"}},"examples":[],"x-tags":["Catalog"],"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].attributes.items.[INDEX]","typeLabel":"ProductAttribute · object"},"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].attributes","typeLabel":"ProductAttribute · object[]"},"category_ids":{"type":"array","items":{"type":"string","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].category_ids.items.[INDEX]","typeLabel":"string"},"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].category_ids","typeLabel":"string[]"},"is_featured":{"type":"boolean","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].is_featured","typeLabel":"boolean"},"on_offer":{"type":"boolean","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].on_offer","typeLabel":"boolean"},"on_promotion":{"type":"boolean","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].on_promotion","typeLabel":"boolean"},"on_subscription":{"type":"boolean","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].on_subscription","typeLabel":"boolean"},"description":{"oneOf":[{"type":"string","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].description","typeLabel":"string | null"},"short_description":{"oneOf":[{"type":"string","maxLength":1024,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].short_description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":1024,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].short_description.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].short_description","typeLabel":"string | null"},"promotion":{"oneOf":[{"type":"object","title":"DiscountBasedPromotion","description":"promotion_type = discount","required":["promotion_type","starts_at","details"],"x-tags":["Catalog"],"properties":{"promotion_type":{"enum":["discount"],"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.0.promotion_type","typeLabel":"enum\u003cstring>"},"starts_at":{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.0.starts_at","typeLabel":"string"},"details":{"type":"array","items":{"oneOf":[{"type":"object","title":"PercentageBasedDiscount","description":"promotion_type = discount","required":["discount_type","discount_percent","customer_group_id","minimum_quantity","maximum_quantity","maximum_discount_amount"],"properties":{"discount_type":{"type":"string","const":"percentage","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.0.discount_type","typeLabel":"string"},"discount_percent":{"type":"number","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.0.discount_percent","typeLabel":"number"},"customer_group_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.0.customer_group_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.0.customer_group_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.0.customer_group_id","typeLabel":"string | null"},"minimum_quantity":{"description":"It refers to the minimum quantity of a specific item a customer must purchase to qualify for the promotion.","type":"integer","default":1,"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.0.minimum_quantity","typeLabel":"integer"},"maximum_quantity":{"oneOf":[{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"integer","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.0.maximum_quantity.oneOf.0","typeLabel":"integer"},{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"null","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.0.maximum_quantity.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.0.maximum_quantity","typeLabel":"integer | null"},"maximum_discount_amount":{"oneOf":[{"description":"When a value is specified, the discount amount will not exceed the defined maximum, ensuring that the promotion stays within a controlled discount range. If this field is set to null, it indicates that there is no limit to the discount amount.","type":"number","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.0.maximum_discount_amount.oneOf.0","typeLabel":"number"},{"description":"When a value is specified, the discount amount will not exceed the defined maximum, ensuring that the promotion stays within a controlled discount range. If this field is set to null, it indicates that there is no limit to the discount amount.","type":"null","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.0.maximum_discount_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.0.maximum_discount_amount","typeLabel":"number | null"}},"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.0","typeLabel":"PercentageBasedDiscount · object"},{"type":"null","title":"PercentageBasedDiscount","description":"promotion_type = discount","required":["discount_type","discount_percent","customer_group_id","minimum_quantity","maximum_quantity","maximum_discount_amount"],"properties":{"discount_type":{"type":"string","const":"percentage"},"discount_percent":{"type":"number"},"customer_group_id":{"oneOf":[{"type":"string"},{"type":"null"}]},"minimum_quantity":{"description":"It refers to the minimum quantity of a specific item a customer must purchase to qualify for the promotion.","type":"integer","default":1},"maximum_quantity":{"oneOf":[{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"integer"},{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"null"}]},"maximum_discount_amount":{"oneOf":[{"description":"When a value is specified, the discount amount will not exceed the defined maximum, ensuring that the promotion stays within a controlled discount range. If this field is set to null, it indicates that there is no limit to the discount amount.","type":"number"},{"description":"When a value is specified, the discount amount will not exceed the defined maximum, ensuring that the promotion stays within a controlled discount range. If this field is set to null, it indicates that there is no limit to the discount amount.","type":"null"}]}},"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.1","typeLabel":"null"},{"type":"object","title":"FixedAmountBasedDiscount","description":"promotion_type = discount","required":["discount_type","discount_fixed_amount","customer_group_id","minimum_quantity","maximum_quantity"],"properties":{"discount_type":{"type":"string","const":"fixed-amount","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.2.discount_type","typeLabel":"string"},"discount_fixed_amount":{"type":"integer","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.2.discount_fixed_amount","typeLabel":"integer"},"customer_group_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.2.customer_group_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.2.customer_group_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.2.customer_group_id","typeLabel":"string | null"},"minimum_quantity":{"description":"It refers to the minimum quantity of a specific item a customer must purchase to qualify for the promotion.","type":"integer","default":1,"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.2.minimum_quantity","typeLabel":"integer"},"maximum_quantity":{"oneOf":[{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"integer","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.2.maximum_quantity.oneOf.0","typeLabel":"integer"},{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"null","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.2.maximum_quantity.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.2.maximum_quantity","typeLabel":"integer | null"}},"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.2","typeLabel":"FixedAmountBasedDiscount · object"},{"type":"null","title":"FixedAmountBasedDiscount","description":"promotion_type = discount","required":["discount_type","discount_fixed_amount","customer_group_id","minimum_quantity","maximum_quantity"],"properties":{"discount_type":{"type":"string","const":"fixed-amount"},"discount_fixed_amount":{"type":"integer"},"customer_group_id":{"oneOf":[{"type":"string"},{"type":"null"}]},"minimum_quantity":{"description":"It refers to the minimum quantity of a specific item a customer must purchase to qualify for the promotion.","type":"integer","default":1},"maximum_quantity":{"oneOf":[{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"integer"},{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"null"}]}},"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.3","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX]","typeLabel":"PercentageBasedDiscount · object · null · FixedAmountBasedDiscount · object · null"},"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.0.details","typeLabel":"PercentageBasedDiscount · object · null · FixedAmountBasedDiscount · object · null[]"},"id":{"type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.0.id","typeLabel":"string"},"expires_at":{"oneOf":[{"description":"null means never expires.","type":"string","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.0.expires_at.oneOf.0","typeLabel":"string"},{"description":"null means never expires.","type":"null","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.0.expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.0.expires_at","typeLabel":"string | null"}},"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.0","typeLabel":"DiscountBasedPromotion · object"},{"type":"null","title":"DiscountBasedPromotion","description":"promotion_type = discount","required":["promotion_type","starts_at","details"],"x-tags":["Catalog"],"properties":{"id":{"type":"string","readOnly":true},"promotion_type":{"enum":["discount"],"type":"string"},"starts_at":{"type":"string"},"expires_at":{"oneOf":[{"description":"null means never expires.","type":"string"},{"description":"null means never expires.","type":"null"}]},"details":{"type":"array","items":{"oneOf":[{"type":"object","title":"PercentageBasedDiscount","description":"promotion_type = discount","required":["discount_type","discount_percent","customer_group_id","minimum_quantity","maximum_quantity","maximum_discount_amount"],"properties":{"discount_type":{"type":"string","const":"percentage"},"discount_percent":{"type":"number"},"customer_group_id":{"oneOf":[{"type":"string"},{"type":"null"}]},"minimum_quantity":{"description":"It refers to the minimum quantity of a specific item a customer must purchase to qualify for the promotion.","type":"integer","default":1},"maximum_quantity":{"oneOf":[{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"integer"},{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"null"}]},"maximum_discount_amount":{"oneOf":[{"description":"When a value is specified, the discount amount will not exceed the defined maximum, ensuring that the promotion stays within a controlled discount range. If this field is set to null, it indicates that there is no limit to the discount amount.","type":"number"},{"description":"When a value is specified, the discount amount will not exceed the defined maximum, ensuring that the promotion stays within a controlled discount range. If this field is set to null, it indicates that there is no limit to the discount amount.","type":"null"}]}}},{"type":"null","title":"PercentageBasedDiscount","description":"promotion_type = discount","required":["discount_type","discount_percent","customer_group_id","minimum_quantity","maximum_quantity","maximum_discount_amount"],"properties":{"discount_type":{"type":"string","const":"percentage"},"discount_percent":{"type":"number"},"customer_group_id":{"oneOf":[{"type":"string"},{"type":"null"}]},"minimum_quantity":{"description":"It refers to the minimum quantity of a specific item a customer must purchase to qualify for the promotion.","type":"integer","default":1},"maximum_quantity":{"oneOf":[{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"integer"},{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"null"}]},"maximum_discount_amount":{"oneOf":[{"description":"When a value is specified, the discount amount will not exceed the defined maximum, ensuring that the promotion stays within a controlled discount range. If this field is set to null, it indicates that there is no limit to the discount amount.","type":"number"},{"description":"When a value is specified, the discount amount will not exceed the defined maximum, ensuring that the promotion stays within a controlled discount range. If this field is set to null, it indicates that there is no limit to the discount amount.","type":"null"}]}}},{"type":"object","title":"FixedAmountBasedDiscount","description":"promotion_type = discount","required":["discount_type","discount_fixed_amount","customer_group_id","minimum_quantity","maximum_quantity"],"properties":{"discount_type":{"type":"string","const":"fixed-amount"},"discount_fixed_amount":{"type":"integer"},"customer_group_id":{"oneOf":[{"type":"string"},{"type":"null"}]},"minimum_quantity":{"description":"It refers to the minimum quantity of a specific item a customer must purchase to qualify for the promotion.","type":"integer","default":1},"maximum_quantity":{"oneOf":[{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"integer"},{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"null"}]}}},{"type":"null","title":"FixedAmountBasedDiscount","description":"promotion_type = discount","required":["discount_type","discount_fixed_amount","customer_group_id","minimum_quantity","maximum_quantity"],"properties":{"discount_type":{"type":"string","const":"fixed-amount"},"discount_fixed_amount":{"type":"integer"},"customer_group_id":{"oneOf":[{"type":"string"},{"type":"null"}]},"minimum_quantity":{"description":"It refers to the minimum quantity of a specific item a customer must purchase to qualify for the promotion.","type":"integer","default":1},"maximum_quantity":{"oneOf":[{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"integer"},{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"null"}]}}}]}}},"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.1","typeLabel":"null"},{"type":"object","title":"FixedPricePromotion","description":"promotion_type = fixed-price","required":["promotion_type","starts_at","details"],"x-tags":["Catalog"],"properties":{"promotion_type":{"enum":["fixed-price"],"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.2.promotion_type","typeLabel":"enum\u003cstring>"},"starts_at":{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.2.starts_at","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","required":["offer_price","customer_group_id","minimum_quantity","maximum_quantity"],"properties":{"offer_price":{"type":"number","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.2.details.items.[INDEX].offer_price","typeLabel":"number"},"customer_group_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.2.details.items.[INDEX].customer_group_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.2.details.items.[INDEX].customer_group_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.2.details.items.[INDEX].customer_group_id","typeLabel":"string | null"},"minimum_quantity":{"description":"It refers to the minimum quantity of a specific item a customer must purchase to qualify for the promotion.","type":"integer","default":1,"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.2.details.items.[INDEX].minimum_quantity","typeLabel":"integer"},"maximum_quantity":{"oneOf":[{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"integer","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.2.details.items.[INDEX].maximum_quantity.oneOf.0","typeLabel":"integer"},{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"null","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.2.details.items.[INDEX].maximum_quantity.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.2.details.items.[INDEX].maximum_quantity","typeLabel":"integer | null"}},"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.2.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.2.details","typeLabel":"object[]"},"id":{"type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.2.id","typeLabel":"string"},"expires_at":{"oneOf":[{"description":"null means never expires.","type":"string","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.2.expires_at.oneOf.0","typeLabel":"string"},{"description":"null means never expires.","type":"null","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.2.expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.2.expires_at","typeLabel":"string | null"}},"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.2","typeLabel":"FixedPricePromotion · object"},{"type":"null","title":"FixedPricePromotion","description":"promotion_type = fixed-price","required":["promotion_type","starts_at","details"],"x-tags":["Catalog"],"properties":{"id":{"type":"string","readOnly":true},"promotion_type":{"enum":["fixed-price"],"type":"string"},"starts_at":{"type":"string"},"expires_at":{"oneOf":[{"description":"null means never expires.","type":"string"},{"description":"null means never expires.","type":"null"}]},"details":{"type":"array","items":{"type":"object","required":["offer_price","customer_group_id","minimum_quantity","maximum_quantity"],"properties":{"offer_price":{"type":"number"},"customer_group_id":{"oneOf":[{"type":"string"},{"type":"null"}]},"minimum_quantity":{"description":"It refers to the minimum quantity of a specific item a customer must purchase to qualify for the promotion.","type":"integer","default":1},"maximum_quantity":{"oneOf":[{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"integer"},{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"null"}]}}}}},"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.3","typeLabel":"null"},{"type":"object","title":"VolumeBasedPromotion","description":"promotion_type = volume-based","required":["promotion_type","starts_at","details"],"x-tags":["Catalog"],"properties":{"promotion_type":{"enum":["volume-based"],"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.4.promotion_type","typeLabel":"enum\u003cstring>"},"starts_at":{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.4.starts_at","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","required":["customer_group_id","slabs"],"properties":{"customer_group_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.4.details.items.[INDEX].customer_group_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.4.details.items.[INDEX].customer_group_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.4.details.items.[INDEX].customer_group_id","typeLabel":"string | null"},"slabs":{"type":"array","items":{"type":"object","required":["quantity","quantity_condition","discount_percent"],"properties":{"quantity":{"type":"integer","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.4.details.items.[INDEX].slabs.items.[INDEX].quantity","typeLabel":"integer"},"quantity_condition":{"description":"This key defines how the system will evaluate the quantity to determine if the promotion should be applied, based on the specified slab.","enum":["less","less-or-equal","greater","greater-or-equal"],"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.4.details.items.[INDEX].slabs.items.[INDEX].quantity_condition","typeLabel":"enum\u003cstring>"},"discount_percent":{"type":"number","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.4.details.items.[INDEX].slabs.items.[INDEX].discount_percent","typeLabel":"number"}},"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.4.details.items.[INDEX].slabs.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.4.details.items.[INDEX].slabs","typeLabel":"object[]"}},"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.4.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.4.details","typeLabel":"object[]"},"id":{"type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.4.id","typeLabel":"string"},"expires_at":{"oneOf":[{"description":"null means never expires.","type":"string","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.4.expires_at.oneOf.0","typeLabel":"string"},{"description":"null means never expires.","type":"null","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.4.expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.4.expires_at","typeLabel":"string | null"}},"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.4","typeLabel":"VolumeBasedPromotion · object"},{"type":"null","title":"VolumeBasedPromotion","description":"promotion_type = volume-based","required":["promotion_type","starts_at","details"],"x-tags":["Catalog"],"properties":{"id":{"type":"string","readOnly":true},"promotion_type":{"enum":["volume-based"],"type":"string"},"starts_at":{"type":"string"},"expires_at":{"oneOf":[{"description":"null means never expires.","type":"string"},{"description":"null means never expires.","type":"null"}]},"details":{"type":"array","items":{"type":"object","required":["customer_group_id","slabs"],"properties":{"customer_group_id":{"oneOf":[{"type":"string"},{"type":"null"}]},"slabs":{"type":"array","items":{"type":"object","required":["quantity","quantity_condition","discount_percent"],"properties":{"quantity":{"type":"integer"},"quantity_condition":{"description":"This key defines how the system will evaluate the quantity to determine if the promotion should be applied, based on the specified slab.","enum":["less","less-or-equal","greater","greater-or-equal"],"type":"string"},"discount_percent":{"type":"number"}}}}}}}},"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.5","typeLabel":"null"},{"type":"object","title":"FreeGoodsPromotion","description":"promotion_type = free-goods","required":["promotion_type","starts_at","details"],"x-tags":["Catalog"],"properties":{"promotion_type":{"enum":["free-goods"],"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.6.promotion_type","typeLabel":"enum\u003cstring>"},"starts_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.6.starts_at","typeLabel":"string\u003cdate-time>"},"details":{"type":"array","items":{"oneOf":[{"type":"object","title":"ScaleAutomatically","required":["auto_scale","slab","customer_group_id"],"properties":{"customer_group_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.6.details.items.[INDEX].oneOf.0.customer_group_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.6.details.items.[INDEX].oneOf.0.customer_group_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.6.details.items.[INDEX].oneOf.0.customer_group_id","typeLabel":"string | null"},"auto_scale":{"description":"The **auto_scale** key determines whether the promotion should be automatically adjusted based on the ratio between the quantities bought and the quantities received.\\n\\nIf **true**: The promotion will be applied dynamically according to the ratio of the buy quantity to the get quantity. For example, if the promotion is \\\"Buy 2, Get 1\\\" and the customer buys 4 items, they would receive 2 free items (scaling based on the original ratio).\\n\\nIf **false**: The promotion will be applied strictly according to the predefined conditions. For example, even if the customer buys more items, they will receive the fixed free quantity as defined in the original promotion (e.g., buying 4 would still only get them 1 free item).","type":"boolean","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.6.details.items.[INDEX].oneOf.0.auto_scale","typeLabel":"boolean"},"slab":{"type":"object","properties":{"buy_quantity":{"type":"integer","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.6.details.items.[INDEX].oneOf.0.slab.buy_quantity","typeLabel":"integer"},"get_quantity":{"type":"integer","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.6.details.items.[INDEX].oneOf.0.slab.get_quantity","typeLabel":"integer"},"quantity_condition":{"description":"Defines how the system will evaluate the buy_quantity to determine if the promotion should be applied.","enum":["less","less-or-equal","greater","greater-or-equal"],"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.6.details.items.[INDEX].oneOf.0.slab.quantity_condition","typeLabel":"enum\u003cstring>"}},"required":["buy_quantity","get_quantity","quantity_condition"],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.6.details.items.[INDEX].oneOf.0.slab","typeLabel":"object"}},"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.6.details.items.[INDEX].oneOf.0","typeLabel":"ScaleAutomatically · object"},{"type":"object","title":"CustomSlabs","required":["slabs","customer_group_id"],"properties":{"customer_group_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.6.details.items.[INDEX].oneOf.1.customer_group_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.6.details.items.[INDEX].oneOf.1.customer_group_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.6.details.items.[INDEX].oneOf.1.customer_group_id","typeLabel":"string | null"},"slabs":{"type":"array","items":{"type":"object","properties":{"buy_quantity":{"type":"integer","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.6.details.items.[INDEX].oneOf.1.slabs.items.[INDEX].buy_quantity","typeLabel":"integer"},"get_quantity":{"type":"integer","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.6.details.items.[INDEX].oneOf.1.slabs.items.[INDEX].get_quantity","typeLabel":"integer"},"quantity_condition":{"description":"Defines how the system will evaluate the buy_quantity to determine if the promotion should be applied.","enum":["less","less-or-equal","greater","greater-or-equal"],"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.6.details.items.[INDEX].oneOf.1.slabs.items.[INDEX].quantity_condition","typeLabel":"enum\u003cstring>"}},"required":["buy_quantity","get_quantity","quantity_condition"],"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.6.details.items.[INDEX].oneOf.1.slabs.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.6.details.items.[INDEX].oneOf.1.slabs","typeLabel":"object[]"}},"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.6.details.items.[INDEX].oneOf.1","typeLabel":"CustomSlabs · object"}],"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.6.details.items.[INDEX]","typeLabel":"ScaleAutomatically · object | CustomSlabs · object"},"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.6.details","typeLabel":"(ScaleAutomatically · object | CustomSlabs · object)[]"},"id":{"type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.6.id","typeLabel":"string"},"expires_at":{"oneOf":[{"description":"null means never expires.","type":"string","format":"date-time","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.6.expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"null means never expires.","type":"null","format":"date-time","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.6.expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.6.expires_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.6","typeLabel":"FreeGoodsPromotion · object"},{"type":"null","title":"FreeGoodsPromotion","description":"promotion_type = free-goods","required":["promotion_type","starts_at","details"],"x-tags":["Catalog"],"properties":{"id":{"type":"string","readOnly":true},"promotion_type":{"enum":["free-goods"],"type":"string"},"starts_at":{"type":"string","format":"date-time"},"expires_at":{"oneOf":[{"description":"null means never expires.","type":"string","format":"date-time"},{"description":"null means never expires.","type":"null","format":"date-time"}]},"details":{"type":"array","items":{"oneOf":[{"type":"object","title":"ScaleAutomatically","required":["auto_scale","slab","customer_group_id"],"properties":{"customer_group_id":{"oneOf":[{"type":"string"},{"type":"null"}]},"auto_scale":{"description":"The **auto_scale** key determines whether the promotion should be automatically adjusted based on the ratio between the quantities bought and the quantities received.\\n\\nIf **true**: The promotion will be applied dynamically according to the ratio of the buy quantity to the get quantity. For example, if the promotion is \\\"Buy 2, Get 1\\\" and the customer buys 4 items, they would receive 2 free items (scaling based on the original ratio).\\n\\nIf **false**: The promotion will be applied strictly according to the predefined conditions. For example, even if the customer buys more items, they will receive the fixed free quantity as defined in the original promotion (e.g., buying 4 would still only get them 1 free item).","type":"boolean"},"slab":{"type":"object","properties":{"buy_quantity":{"type":"integer"},"get_quantity":{"type":"integer"},"quantity_condition":{"description":"Defines how the system will evaluate the buy_quantity to determine if the promotion should be applied.","enum":["less","less-or-equal","greater","greater-or-equal"],"type":"string"}},"required":["buy_quantity","get_quantity","quantity_condition"]}}},{"type":"object","title":"CustomSlabs","required":["slabs","customer_group_id"],"properties":{"customer_group_id":{"oneOf":[{"type":"string"},{"type":"null"}]},"slabs":{"type":"array","items":{"type":"object","properties":{"buy_quantity":{"type":"integer"},"get_quantity":{"type":"integer"},"quantity_condition":{"description":"Defines how the system will evaluate the buy_quantity to determine if the promotion should be applied.","enum":["less","less-or-equal","greater","greater-or-equal"],"type":"string"}},"required":["buy_quantity","get_quantity","quantity_condition"]}}}}]}}},"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion.oneOf.7","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].promotion","typeLabel":"DiscountBasedPromotion · object · null · FixedPricePromotion · object · null · VolumeBasedPromotion · object · null · FreeGoodsPromotion · object · null"},"subscription":{"type":"array","items":{"title":"ProductSubscription","type":"object","required":["subscription_plan","billing_interval","billing_frequency","billing_limit","billing_trial_days","fulfill_separately","subscription_price"],"properties":{"subscription_plan":{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].subscription.items.[INDEX].subscription_plan","typeLabel":"string"},"billing_interval":{"type":"integer","format":"int32","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].subscription.items.[INDEX].billing_interval","typeLabel":"integer\u003cint32>"},"billing_frequency":{"enum":["monthly"],"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].subscription.items.[INDEX].billing_frequency","typeLabel":"enum\u003cstring>"},"billing_limit":{"oneOf":[{"type":"integer","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].subscription.items.[INDEX].billing_limit.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].subscription.items.[INDEX].billing_limit.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].subscription.items.[INDEX].billing_limit","typeLabel":"integer | null"},"billing_trial_days":{"type":"integer","format":"int32","default":0,"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].subscription.items.[INDEX].billing_trial_days","typeLabel":"integer\u003cint32>"},"fulfill_separately":{"type":"boolean","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].subscription.items.[INDEX].fulfill_separately","typeLabel":"boolean"},"subscription_price":{"type":"array","items":{"type":"object","required":["suscription_price","minimum_quantity","customer_group_id"],"properties":{"suscription_price":{"type":"number","format":"double","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].subscription.items.[INDEX].subscription_price.items.[INDEX].suscription_price","typeLabel":"number\u003cdouble>"},"minimum_quantity":{"type":"integer","default":1,"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].subscription.items.[INDEX].subscription_price.items.[INDEX].minimum_quantity","typeLabel":"integer"},"customer_group_id":{"oneOf":[{"description":"customer group id.","type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].subscription.items.[INDEX].subscription_price.items.[INDEX].customer_group_id.oneOf.0","typeLabel":"string"},{"description":"customer group id.","type":"null","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].subscription.items.[INDEX].subscription_price.items.[INDEX].customer_group_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].subscription.items.[INDEX].subscription_price.items.[INDEX].customer_group_id","typeLabel":"string | null"}},"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].subscription.items.[INDEX].subscription_price.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].subscription.items.[INDEX].subscription_price","typeLabel":"object[]"},"subscription_plan_id":{"type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].subscription.items.[INDEX].subscription_plan_id","typeLabel":"string"},"order_interval":{"oneOf":[{"type":"integer","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].subscription.items.[INDEX].order_interval.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].subscription.items.[INDEX].order_interval.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].subscription.items.[INDEX].order_interval","typeLabel":"integer | null"},"order_frequency":{"oneOf":[{"type":"string","enum":["monthly"],"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].subscription.items.[INDEX].order_frequency.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["monthly"],"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].subscription.items.[INDEX].order_frequency.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].subscription.items.[INDEX].order_frequency","typeLabel":"enum\u003cstring> | null"},"order_limit":{"oneOf":[{"type":"integer","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].subscription.items.[INDEX].order_limit.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].subscription.items.[INDEX].order_limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].subscription.items.[INDEX].order_limit","typeLabel":"integer | null"}},"x-tags":["Catalog"],"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].subscription.items.[INDEX]","typeLabel":"ProductSubscription · object"},"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].subscription","typeLabel":"ProductSubscription · object[]"},"shipping":{"oneOf":[{"type":"object","title":"ProductShipping","required":["handling_charge"],"x-tags":["Catalog"],"properties":{"handling_charge":{"description":"A handling charge is an additional fee applied to cover the costs associated with preparing, packaging, and processing an order for shipment or delivery.","type":"number","minimum":0,"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].shipping.oneOf.0.handling_charge","typeLabel":"number"}},"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].shipping.oneOf.0","typeLabel":"ProductShipping · object"},{"type":"null","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].shipping.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].shipping","typeLabel":"ProductShipping · object | null"},"packaging":{"oneOf":[{"type":"object","title":"ProductPackaging","required":["pack_width","pack_height","pack_length","pack_dry_weight","units_per_pack","vertical_rotation"],"x-tags":["Catalog"],"properties":{"pack_width":{"type":"number","format":"float","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].packaging.oneOf.0.pack_width","typeLabel":"number\u003cfloat>"},"pack_height":{"type":"number","format":"float","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].packaging.oneOf.0.pack_height","typeLabel":"number\u003cfloat>"},"pack_length":{"type":"number","format":"float","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].packaging.oneOf.0.pack_length","typeLabel":"number\u003cfloat>"},"pack_dry_weight":{"type":"number","format":"float","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].packaging.oneOf.0.pack_dry_weight","typeLabel":"number\u003cfloat>"},"units_per_pack":{"type":"integer","format":"int32","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].packaging.oneOf.0.units_per_pack","typeLabel":"integer\u003cint32>"},"vertical_rotation":{"description":"Indicates whether items can be rotated during packing or if they must be kept in a strictly vertical orientation.","type":"boolean","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].packaging.oneOf.0.vertical_rotation","typeLabel":"boolean"},"product_id":{"type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].packaging.oneOf.0.product_id","typeLabel":"string"},"product_variant_id":{"oneOf":[{"description":"`null` when packaging applies to a product without variants.","type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].packaging.oneOf.0.product_variant_id.oneOf.0","typeLabel":"string"},{"description":"`null` when packaging applies to a product without variants.","type":"null","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].packaging.oneOf.0.product_variant_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].packaging.oneOf.0.product_variant_id","typeLabel":"string | null"},"product_name":{"type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].packaging.oneOf.0.product_name","typeLabel":"string"},"variant_name":{"oneOf":[{"description":"`null` when packaging applies to a product without variants.","type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].packaging.oneOf.0.variant_name.oneOf.0","typeLabel":"string"},{"description":"`null` when packaging applies to a product without variants.","type":"null","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].packaging.oneOf.0.variant_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].packaging.oneOf.0.variant_name","typeLabel":"string | null"},"shipper_width":{"oneOf":[{"type":"number","format":"float","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].packaging.oneOf.0.shipper_width.oneOf.0","typeLabel":"number\u003cfloat>"},{"type":"null","format":"float","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].packaging.oneOf.0.shipper_width.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].packaging.oneOf.0.shipper_width","typeLabel":"number\u003cfloat> | null"},"shipper_height":{"oneOf":[{"type":"number","format":"float","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].packaging.oneOf.0.shipper_height.oneOf.0","typeLabel":"number\u003cfloat>"},{"type":"null","format":"float","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].packaging.oneOf.0.shipper_height.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].packaging.oneOf.0.shipper_height","typeLabel":"number\u003cfloat> | null"},"shipper_length":{"oneOf":[{"type":"number","format":"float","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].packaging.oneOf.0.shipper_length.oneOf.0","typeLabel":"number\u003cfloat>"},{"type":"null","format":"float","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].packaging.oneOf.0.shipper_length.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].packaging.oneOf.0.shipper_length","typeLabel":"number\u003cfloat> | null"},"shipper_dry_weight":{"oneOf":[{"type":"number","format":"float","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].packaging.oneOf.0.shipper_dry_weight.oneOf.0","typeLabel":"number\u003cfloat>"},{"type":"null","format":"float","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].packaging.oneOf.0.shipper_dry_weight.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].packaging.oneOf.0.shipper_dry_weight","typeLabel":"number\u003cfloat> | null"},"units_per_shipper":{"oneOf":[{"type":"integer","format":"int32","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].packaging.oneOf.0.units_per_shipper.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].packaging.oneOf.0.units_per_shipper.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].packaging.oneOf.0.units_per_shipper","typeLabel":"integer\u003cint32> | null"}},"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].packaging.oneOf.0","typeLabel":"ProductPackaging · object"},{"type":"null","title":"ProductPackaging","required":["pack_width","pack_height","pack_length","pack_dry_weight","units_per_pack","vertical_rotation"],"x-tags":["Catalog"],"properties":{"product_id":{"type":"string","readOnly":true},"product_variant_id":{"oneOf":[{"description":"`null` when packaging applies to a product without variants.","type":"string","readOnly":true},{"description":"`null` when packaging applies to a product without variants.","type":"null","readOnly":true}]},"product_name":{"type":"string","readOnly":true},"variant_name":{"oneOf":[{"description":"`null` when packaging applies to a product without variants.","type":"string","readOnly":true},{"description":"`null` when packaging applies to a product without variants.","type":"null","readOnly":true}]},"pack_width":{"type":"number","format":"float"},"pack_height":{"type":"number","format":"float"},"pack_length":{"type":"number","format":"float"},"pack_dry_weight":{"type":"number","format":"float"},"units_per_pack":{"type":"integer","format":"int32"},"vertical_rotation":{"description":"Indicates whether items can be rotated during packing or if they must be kept in a strictly vertical orientation.","type":"boolean"},"shipper_width":{"oneOf":[{"type":"number","format":"float"},{"type":"null","format":"float"}]},"shipper_height":{"oneOf":[{"type":"number","format":"float"},{"type":"null","format":"float"}]},"shipper_length":{"oneOf":[{"type":"number","format":"float"},{"type":"null","format":"float"}]},"shipper_dry_weight":{"oneOf":[{"type":"number","format":"float"},{"type":"null","format":"float"}]},"units_per_shipper":{"oneOf":[{"type":"integer","format":"int32"},{"type":"null","format":"int32"}]}},"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].packaging.oneOf.1","typeLabel":"null"},{"type":"null","uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].packaging.oneOf.2","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX].packaging","typeLabel":"ProductPackaging · object · null · null"}},"x-tags":["Catalog"],"uniqueKey":"content.variants.items.[INDEX].related_products.upsell.items.[INDEX]","typeLabel":"ProductBasicDetail · object"},"uniqueKey":"content.variants.items.[INDEX].related_products.upsell","typeLabel":"ProductBasicDetail · object[]"},"cross_sell":{"type":"array","items":{"title":"ProductBasicDetail","type":"object","properties":{"id":{"description":"product id or combination of product id and variant id separated by hyphen.","type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].id","typeLabel":"string"},"product_id":{"type":"string","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].product_id","typeLabel":"string"},"product_name":{"type":"string","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].product_name","typeLabel":"string"},"product_type":{"enum":["physical","digital","bundle"],"type":"string","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].product_type","typeLabel":"enum\u003cstring>"},"status":{"enum":["draft","active","inactive"],"readOnly":true,"type":"string","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"tags":{"type":"array","items":{"type":"string","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].tags.items.[INDEX]","typeLabel":"string"},"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].tags","typeLabel":"string[]"},"reviews_rating_sum":{"type":"integer","format":"int32","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].reviews_rating_sum","typeLabel":"integer\u003cint32>"},"reviews_count":{"type":"integer","format":"int32","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].reviews_count","typeLabel":"integer\u003cint32>"},"hsn_code":{"oneOf":[{"type":"string","maxLength":128,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].hsn_code.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":128,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].hsn_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].hsn_code","typeLabel":"string | null"},"variant_id":{"oneOf":[{"type":"string","maxLength":128,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].variant_id.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":128,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].variant_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].variant_id","typeLabel":"string | null"},"variant_name":{"oneOf":[{"type":"string","maxLength":128,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].variant_name.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":128,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].variant_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].variant_name","typeLabel":"string | null"},"slug":{"type":"string","maxLength":128,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].slug","typeLabel":"string"},"sku":{"oneOf":[{"type":"string","maxLength":128,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].sku.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":128,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].sku.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].sku","typeLabel":"string | null"},"associated_options":{"type":"array","items":{"title":"AssociatedOption","type":"object","required":["attribute_id","attribute_value"],"properties":{"attribute_id":{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].associated_options.items.[INDEX].attribute_id","typeLabel":"string"},"attribute_value":{"oneOf":[{"type":"string","description":"Attributes with type of **single-select**, the value will be represented as a **string**.","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].associated_options.items.[INDEX].attribute_value.oneOf.0","typeLabel":"string"},{"type":"object","title":"ColorObject","description":"**Color** attributes will have their value represented as a color object, specifying the color details with name and hexcode.","required":["name","hexcode"],"properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].associated_options.items.[INDEX].attribute_value.oneOf.1.name","typeLabel":"string"},"hexcode":{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].associated_options.items.[INDEX].attribute_value.oneOf.1.hexcode","typeLabel":"string"}},"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].associated_options.items.[INDEX].attribute_value.oneOf.1","typeLabel":"ColorObject · object"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].associated_options.items.[INDEX].attribute_value","typeLabel":"string | ColorObject · object"},"attribute_name":{"type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].associated_options.items.[INDEX].attribute_name","typeLabel":"string"},"attribute_type":{"enum":["single-select","color"],"readOnly":true,"type":"string","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].associated_options.items.[INDEX].attribute_type","typeLabel":"enum\u003cstring>"},"key":{"description":"value in snake case.","type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].associated_options.items.[INDEX].key","typeLabel":"string"}},"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].associated_options.items.[INDEX]","typeLabel":"AssociatedOption · object"},"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].associated_options","typeLabel":"AssociatedOption · object[]"},"active":{"type":"boolean","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].active","typeLabel":"boolean"},"stock_available":{"type":"boolean","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].stock_available","typeLabel":"boolean"},"images":{"type":"array","items":{"title":"ProductImage","type":"object","properties":{"title":{"oneOf":[{"type":"string","maxLength":128,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].images.items.[INDEX].title.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":128,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].images.items.[INDEX].title.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].images.items.[INDEX].title","typeLabel":"string | null"},"alternate_text":{"oneOf":[{"type":"string","maxLength":128,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].images.items.[INDEX].alternate_text.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":128,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].images.items.[INDEX].alternate_text.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].images.items.[INDEX].alternate_text","typeLabel":"string | null"},"sort_order":{"type":"integer","format":"int32","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].images.items.[INDEX].sort_order","typeLabel":"integer\u003cint32>"},"url_tiny":{"type":"string","maxLength":512,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].images.items.[INDEX].url_tiny","typeLabel":"string"},"url_thumbnail":{"type":"string","maxLength":512,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].images.items.[INDEX].url_thumbnail","typeLabel":"string"},"url_standard":{"type":"string","maxLength":512,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].images.items.[INDEX].url_standard","typeLabel":"string"},"url_zoom":{"type":"string","maxLength":512,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].images.items.[INDEX].url_zoom","typeLabel":"string"},"file_id":{"type":"string","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].images.items.[INDEX].file_id","typeLabel":"string"},"file_type":{"description":"MIME type of the file, e.g. `image/png`.","type":"string","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].images.items.[INDEX].file_type","typeLabel":"string"}},"x-tags":["Catalog"],"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].images.items.[INDEX]","typeLabel":"ProductImage · object"},"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].images","typeLabel":"ProductImage · object[]"},"pricing":{"type":"array","items":{"title":"ProductPricing","type":"object","required":["customer_group_id","cost_price","listing_price","selling_price","tax_rate"],"properties":{"customer_group_id":{"oneOf":[{"description":"customer group id. for different pricing model in case of multiple customer groups.","type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].pricing.items.[INDEX].customer_group_id.oneOf.0","typeLabel":"string"},{"description":"customer group id. for different pricing model in case of multiple customer groups.","type":"null","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].pricing.items.[INDEX].customer_group_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].pricing.items.[INDEX].customer_group_id","typeLabel":"string | null"},"cost_price":{"oneOf":[{"type":"number","format":"double","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].pricing.items.[INDEX].cost_price.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","format":"double","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].pricing.items.[INDEX].cost_price.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].pricing.items.[INDEX].cost_price","typeLabel":"number\u003cdouble> | null"},"listing_price":{"type":"number","format":"double","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].pricing.items.[INDEX].listing_price","typeLabel":"number\u003cdouble>"},"selling_price":{"type":"number","format":"double","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].pricing.items.[INDEX].selling_price","typeLabel":"number\u003cdouble>"},"tax_rate":{"type":"number","format":"double","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].pricing.items.[INDEX].tax_rate","typeLabel":"number\u003cdouble>"},"min_order_quantity":{"oneOf":[{"type":"integer","format":"int32","default":1,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].pricing.items.[INDEX].min_order_quantity.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","default":1,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].pricing.items.[INDEX].min_order_quantity.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].pricing.items.[INDEX].min_order_quantity","typeLabel":"integer\u003cint32> | null"},"max_order_quantity":{"oneOf":[{"type":"integer","format":"int32","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].pricing.items.[INDEX].max_order_quantity.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].pricing.items.[INDEX].max_order_quantity.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].pricing.items.[INDEX].max_order_quantity","typeLabel":"integer\u003cint32> | null"},"incremental_quantity":{"oneOf":[{"type":"integer","format":"int32","default":1,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].pricing.items.[INDEX].incremental_quantity.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","default":1,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].pricing.items.[INDEX].incremental_quantity.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].pricing.items.[INDEX].incremental_quantity","typeLabel":"integer\u003cint32> | null"},"tax_type":{"enum":["GST"],"readOnly":true,"type":"string","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].pricing.items.[INDEX].tax_type","typeLabel":"enum\u003cstring>"}},"x-tags":["Catalog"],"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].pricing.items.[INDEX]","typeLabel":"ProductPricing · object"},"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].pricing","typeLabel":"ProductPricing · object[]"},"metadata":{"oneOf":[{"type":"object","additionalProperties":{"type":"string","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].metadata.oneOf.0.additionalProperties","typeLabel":"string"},"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].metadata.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"string","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].metadata.oneOf.1.additionalProperties","typeLabel":"string"},"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].metadata","typeLabel":"object | null"},"attributes":{"type":"array","items":{"title":"ProductAttribute","type":"object","properties":{"id":{"description":"Attribute id as returned on SKU and search payloads; same as `attribute_id` on write.","type":"string","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].attributes.items.[INDEX].id","typeLabel":"string"},"name":{"description":"Display name; same as `attribute_name` on write payloads.","type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].attributes.items.[INDEX].name","typeLabel":"string"},"type":{"description":"Same as `attribute_type` on write payloads.","type":"string","enum":["text","number","boolean","date","single-select","multi-select","color"],"readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].attributes.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"value":{"oneOf":[{"type":"string","description":"Resolved value; same as `attribute_value` on write payloads.","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].attributes.items.[INDEX].value.oneOf.0","typeLabel":"string"},{"type":"number","description":"Resolved value; same as `attribute_value` on write payloads.","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].attributes.items.[INDEX].value.oneOf.1","typeLabel":"number"},{"type":"boolean","description":"Resolved value; same as `attribute_value` on write payloads.","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].attributes.items.[INDEX].value.oneOf.2","typeLabel":"boolean"},{"type":"array","items":{"type":"string","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].attributes.items.[INDEX].value.oneOf.3.items.[INDEX]","typeLabel":"string"},"description":"Resolved value; same as `attribute_value` on write payloads.","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].attributes.items.[INDEX].value.oneOf.3","typeLabel":"string[]"},{"type":"object","title":"ColorObject","description":"Resolved value; same as `attribute_value` on write payloads.","required":["name","hexcode"],"properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].attributes.items.[INDEX].value.oneOf.4.name","typeLabel":"string"},"hexcode":{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].attributes.items.[INDEX].value.oneOf.4.hexcode","typeLabel":"string"}},"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].attributes.items.[INDEX].value.oneOf.4","typeLabel":"ColorObject · object"}],"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].attributes.items.[INDEX].value","typeLabel":"string | number | boolean | string[] | ColorObject · object"},"is_visible":{"type":"boolean","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].attributes.items.[INDEX].is_visible","typeLabel":"boolean"},"is_filterable":{"type":"boolean","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].attributes.items.[INDEX].is_filterable","typeLabel":"boolean"},"attribute_id":{"type":"string","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].attributes.items.[INDEX].attribute_id","typeLabel":"string"},"attribute_name":{"type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].attributes.items.[INDEX].attribute_name","typeLabel":"string"},"attribute_type":{"type":"string","enum":["text","number","boolean","date","single-select","multi-select","color"],"readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].attributes.items.[INDEX].attribute_type","typeLabel":"enum\u003cstring>"},"attribute_value":{"oneOf":[{"type":"string","description":"string value for attribute type **text**, **single select** and **date**.","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].attributes.items.[INDEX].attribute_value.oneOf.0","typeLabel":"string"},{"type":"number","description":"numeric value for attribute type number.","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].attributes.items.[INDEX].attribute_value.oneOf.1","typeLabel":"number"},{"type":"boolean","description":"true/false for attribute type boolean.","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].attributes.items.[INDEX].attribute_value.oneOf.2","typeLabel":"boolean"},{"type":"array","items":{"type":"string","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].attributes.items.[INDEX].attribute_value.oneOf.3.items.[INDEX]","typeLabel":"string"},"description":"for attribute type = multi-select","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].attributes.items.[INDEX].attribute_value.oneOf.3","typeLabel":"string[]"},{"type":"object","title":"ColorObject","description":"for attribute type = color","required":["name","hexcode"],"properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].attributes.items.[INDEX].attribute_value.oneOf.4.name","typeLabel":"string"},"hexcode":{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].attributes.items.[INDEX].attribute_value.oneOf.4.hexcode","typeLabel":"string"}},"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].attributes.items.[INDEX].attribute_value.oneOf.4","typeLabel":"ColorObject · object"}],"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].attributes.items.[INDEX].attribute_value","typeLabel":"string | number | boolean | string[] | ColorObject · object"},"key":{"description":"Value in snake case.","type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].attributes.items.[INDEX].key","typeLabel":"string"}},"examples":[],"x-tags":["Catalog"],"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].attributes.items.[INDEX]","typeLabel":"ProductAttribute · object"},"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].attributes","typeLabel":"ProductAttribute · object[]"},"category_ids":{"type":"array","items":{"type":"string","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].category_ids.items.[INDEX]","typeLabel":"string"},"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].category_ids","typeLabel":"string[]"},"is_featured":{"type":"boolean","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].is_featured","typeLabel":"boolean"},"on_offer":{"type":"boolean","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].on_offer","typeLabel":"boolean"},"on_promotion":{"type":"boolean","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].on_promotion","typeLabel":"boolean"},"on_subscription":{"type":"boolean","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].on_subscription","typeLabel":"boolean"},"description":{"oneOf":[{"type":"string","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].description","typeLabel":"string | null"},"short_description":{"oneOf":[{"type":"string","maxLength":1024,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].short_description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":1024,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].short_description.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].short_description","typeLabel":"string | null"},"promotion":{"oneOf":[{"type":"object","title":"DiscountBasedPromotion","description":"promotion_type = discount","required":["promotion_type","starts_at","details"],"x-tags":["Catalog"],"properties":{"promotion_type":{"enum":["discount"],"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.0.promotion_type","typeLabel":"enum\u003cstring>"},"starts_at":{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.0.starts_at","typeLabel":"string"},"details":{"type":"array","items":{"oneOf":[{"type":"object","title":"PercentageBasedDiscount","description":"promotion_type = discount","required":["discount_type","discount_percent","customer_group_id","minimum_quantity","maximum_quantity","maximum_discount_amount"],"properties":{"discount_type":{"type":"string","const":"percentage","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.0.discount_type","typeLabel":"string"},"discount_percent":{"type":"number","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.0.discount_percent","typeLabel":"number"},"customer_group_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.0.customer_group_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.0.customer_group_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.0.customer_group_id","typeLabel":"string | null"},"minimum_quantity":{"description":"It refers to the minimum quantity of a specific item a customer must purchase to qualify for the promotion.","type":"integer","default":1,"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.0.minimum_quantity","typeLabel":"integer"},"maximum_quantity":{"oneOf":[{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"integer","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.0.maximum_quantity.oneOf.0","typeLabel":"integer"},{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"null","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.0.maximum_quantity.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.0.maximum_quantity","typeLabel":"integer | null"},"maximum_discount_amount":{"oneOf":[{"description":"When a value is specified, the discount amount will not exceed the defined maximum, ensuring that the promotion stays within a controlled discount range. If this field is set to null, it indicates that there is no limit to the discount amount.","type":"number","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.0.maximum_discount_amount.oneOf.0","typeLabel":"number"},{"description":"When a value is specified, the discount amount will not exceed the defined maximum, ensuring that the promotion stays within a controlled discount range. If this field is set to null, it indicates that there is no limit to the discount amount.","type":"null","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.0.maximum_discount_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.0.maximum_discount_amount","typeLabel":"number | null"}},"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.0","typeLabel":"PercentageBasedDiscount · object"},{"type":"null","title":"PercentageBasedDiscount","description":"promotion_type = discount","required":["discount_type","discount_percent","customer_group_id","minimum_quantity","maximum_quantity","maximum_discount_amount"],"properties":{"discount_type":{"type":"string","const":"percentage"},"discount_percent":{"type":"number"},"customer_group_id":{"oneOf":[{"type":"string"},{"type":"null"}]},"minimum_quantity":{"description":"It refers to the minimum quantity of a specific item a customer must purchase to qualify for the promotion.","type":"integer","default":1},"maximum_quantity":{"oneOf":[{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"integer"},{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"null"}]},"maximum_discount_amount":{"oneOf":[{"description":"When a value is specified, the discount amount will not exceed the defined maximum, ensuring that the promotion stays within a controlled discount range. If this field is set to null, it indicates that there is no limit to the discount amount.","type":"number"},{"description":"When a value is specified, the discount amount will not exceed the defined maximum, ensuring that the promotion stays within a controlled discount range. If this field is set to null, it indicates that there is no limit to the discount amount.","type":"null"}]}},"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.1","typeLabel":"null"},{"type":"object","title":"FixedAmountBasedDiscount","description":"promotion_type = discount","required":["discount_type","discount_fixed_amount","customer_group_id","minimum_quantity","maximum_quantity"],"properties":{"discount_type":{"type":"string","const":"fixed-amount","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.2.discount_type","typeLabel":"string"},"discount_fixed_amount":{"type":"integer","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.2.discount_fixed_amount","typeLabel":"integer"},"customer_group_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.2.customer_group_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.2.customer_group_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.2.customer_group_id","typeLabel":"string | null"},"minimum_quantity":{"description":"It refers to the minimum quantity of a specific item a customer must purchase to qualify for the promotion.","type":"integer","default":1,"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.2.minimum_quantity","typeLabel":"integer"},"maximum_quantity":{"oneOf":[{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"integer","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.2.maximum_quantity.oneOf.0","typeLabel":"integer"},{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"null","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.2.maximum_quantity.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.2.maximum_quantity","typeLabel":"integer | null"}},"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.2","typeLabel":"FixedAmountBasedDiscount · object"},{"type":"null","title":"FixedAmountBasedDiscount","description":"promotion_type = discount","required":["discount_type","discount_fixed_amount","customer_group_id","minimum_quantity","maximum_quantity"],"properties":{"discount_type":{"type":"string","const":"fixed-amount"},"discount_fixed_amount":{"type":"integer"},"customer_group_id":{"oneOf":[{"type":"string"},{"type":"null"}]},"minimum_quantity":{"description":"It refers to the minimum quantity of a specific item a customer must purchase to qualify for the promotion.","type":"integer","default":1},"maximum_quantity":{"oneOf":[{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"integer"},{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"null"}]}},"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX].oneOf.3","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.0.details.items.[INDEX]","typeLabel":"PercentageBasedDiscount · object · null · FixedAmountBasedDiscount · object · null"},"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.0.details","typeLabel":"PercentageBasedDiscount · object · null · FixedAmountBasedDiscount · object · null[]"},"id":{"type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.0.id","typeLabel":"string"},"expires_at":{"oneOf":[{"description":"null means never expires.","type":"string","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.0.expires_at.oneOf.0","typeLabel":"string"},{"description":"null means never expires.","type":"null","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.0.expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.0.expires_at","typeLabel":"string | null"}},"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.0","typeLabel":"DiscountBasedPromotion · object"},{"type":"null","title":"DiscountBasedPromotion","description":"promotion_type = discount","required":["promotion_type","starts_at","details"],"x-tags":["Catalog"],"properties":{"id":{"type":"string","readOnly":true},"promotion_type":{"enum":["discount"],"type":"string"},"starts_at":{"type":"string"},"expires_at":{"oneOf":[{"description":"null means never expires.","type":"string"},{"description":"null means never expires.","type":"null"}]},"details":{"type":"array","items":{"oneOf":[{"type":"object","title":"PercentageBasedDiscount","description":"promotion_type = discount","required":["discount_type","discount_percent","customer_group_id","minimum_quantity","maximum_quantity","maximum_discount_amount"],"properties":{"discount_type":{"type":"string","const":"percentage"},"discount_percent":{"type":"number"},"customer_group_id":{"oneOf":[{"type":"string"},{"type":"null"}]},"minimum_quantity":{"description":"It refers to the minimum quantity of a specific item a customer must purchase to qualify for the promotion.","type":"integer","default":1},"maximum_quantity":{"oneOf":[{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"integer"},{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"null"}]},"maximum_discount_amount":{"oneOf":[{"description":"When a value is specified, the discount amount will not exceed the defined maximum, ensuring that the promotion stays within a controlled discount range. If this field is set to null, it indicates that there is no limit to the discount amount.","type":"number"},{"description":"When a value is specified, the discount amount will not exceed the defined maximum, ensuring that the promotion stays within a controlled discount range. If this field is set to null, it indicates that there is no limit to the discount amount.","type":"null"}]}}},{"type":"null","title":"PercentageBasedDiscount","description":"promotion_type = discount","required":["discount_type","discount_percent","customer_group_id","minimum_quantity","maximum_quantity","maximum_discount_amount"],"properties":{"discount_type":{"type":"string","const":"percentage"},"discount_percent":{"type":"number"},"customer_group_id":{"oneOf":[{"type":"string"},{"type":"null"}]},"minimum_quantity":{"description":"It refers to the minimum quantity of a specific item a customer must purchase to qualify for the promotion.","type":"integer","default":1},"maximum_quantity":{"oneOf":[{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"integer"},{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"null"}]},"maximum_discount_amount":{"oneOf":[{"description":"When a value is specified, the discount amount will not exceed the defined maximum, ensuring that the promotion stays within a controlled discount range. If this field is set to null, it indicates that there is no limit to the discount amount.","type":"number"},{"description":"When a value is specified, the discount amount will not exceed the defined maximum, ensuring that the promotion stays within a controlled discount range. If this field is set to null, it indicates that there is no limit to the discount amount.","type":"null"}]}}},{"type":"object","title":"FixedAmountBasedDiscount","description":"promotion_type = discount","required":["discount_type","discount_fixed_amount","customer_group_id","minimum_quantity","maximum_quantity"],"properties":{"discount_type":{"type":"string","const":"fixed-amount"},"discount_fixed_amount":{"type":"integer"},"customer_group_id":{"oneOf":[{"type":"string"},{"type":"null"}]},"minimum_quantity":{"description":"It refers to the minimum quantity of a specific item a customer must purchase to qualify for the promotion.","type":"integer","default":1},"maximum_quantity":{"oneOf":[{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"integer"},{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"null"}]}}},{"type":"null","title":"FixedAmountBasedDiscount","description":"promotion_type = discount","required":["discount_type","discount_fixed_amount","customer_group_id","minimum_quantity","maximum_quantity"],"properties":{"discount_type":{"type":"string","const":"fixed-amount"},"discount_fixed_amount":{"type":"integer"},"customer_group_id":{"oneOf":[{"type":"string"},{"type":"null"}]},"minimum_quantity":{"description":"It refers to the minimum quantity of a specific item a customer must purchase to qualify for the promotion.","type":"integer","default":1},"maximum_quantity":{"oneOf":[{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"integer"},{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"null"}]}}}]}}},"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.1","typeLabel":"null"},{"type":"object","title":"FixedPricePromotion","description":"promotion_type = fixed-price","required":["promotion_type","starts_at","details"],"x-tags":["Catalog"],"properties":{"promotion_type":{"enum":["fixed-price"],"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.2.promotion_type","typeLabel":"enum\u003cstring>"},"starts_at":{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.2.starts_at","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","required":["offer_price","customer_group_id","minimum_quantity","maximum_quantity"],"properties":{"offer_price":{"type":"number","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.2.details.items.[INDEX].offer_price","typeLabel":"number"},"customer_group_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.2.details.items.[INDEX].customer_group_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.2.details.items.[INDEX].customer_group_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.2.details.items.[INDEX].customer_group_id","typeLabel":"string | null"},"minimum_quantity":{"description":"It refers to the minimum quantity of a specific item a customer must purchase to qualify for the promotion.","type":"integer","default":1,"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.2.details.items.[INDEX].minimum_quantity","typeLabel":"integer"},"maximum_quantity":{"oneOf":[{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"integer","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.2.details.items.[INDEX].maximum_quantity.oneOf.0","typeLabel":"integer"},{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"null","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.2.details.items.[INDEX].maximum_quantity.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.2.details.items.[INDEX].maximum_quantity","typeLabel":"integer | null"}},"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.2.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.2.details","typeLabel":"object[]"},"id":{"type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.2.id","typeLabel":"string"},"expires_at":{"oneOf":[{"description":"null means never expires.","type":"string","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.2.expires_at.oneOf.0","typeLabel":"string"},{"description":"null means never expires.","type":"null","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.2.expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.2.expires_at","typeLabel":"string | null"}},"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.2","typeLabel":"FixedPricePromotion · object"},{"type":"null","title":"FixedPricePromotion","description":"promotion_type = fixed-price","required":["promotion_type","starts_at","details"],"x-tags":["Catalog"],"properties":{"id":{"type":"string","readOnly":true},"promotion_type":{"enum":["fixed-price"],"type":"string"},"starts_at":{"type":"string"},"expires_at":{"oneOf":[{"description":"null means never expires.","type":"string"},{"description":"null means never expires.","type":"null"}]},"details":{"type":"array","items":{"type":"object","required":["offer_price","customer_group_id","minimum_quantity","maximum_quantity"],"properties":{"offer_price":{"type":"number"},"customer_group_id":{"oneOf":[{"type":"string"},{"type":"null"}]},"minimum_quantity":{"description":"It refers to the minimum quantity of a specific item a customer must purchase to qualify for the promotion.","type":"integer","default":1},"maximum_quantity":{"oneOf":[{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"integer"},{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"null"}]}}}}},"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.3","typeLabel":"null"},{"type":"object","title":"VolumeBasedPromotion","description":"promotion_type = volume-based","required":["promotion_type","starts_at","details"],"x-tags":["Catalog"],"properties":{"promotion_type":{"enum":["volume-based"],"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.4.promotion_type","typeLabel":"enum\u003cstring>"},"starts_at":{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.4.starts_at","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","required":["customer_group_id","slabs"],"properties":{"customer_group_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.4.details.items.[INDEX].customer_group_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.4.details.items.[INDEX].customer_group_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.4.details.items.[INDEX].customer_group_id","typeLabel":"string | null"},"slabs":{"type":"array","items":{"type":"object","required":["quantity","quantity_condition","discount_percent"],"properties":{"quantity":{"type":"integer","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.4.details.items.[INDEX].slabs.items.[INDEX].quantity","typeLabel":"integer"},"quantity_condition":{"description":"This key defines how the system will evaluate the quantity to determine if the promotion should be applied, based on the specified slab.","enum":["less","less-or-equal","greater","greater-or-equal"],"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.4.details.items.[INDEX].slabs.items.[INDEX].quantity_condition","typeLabel":"enum\u003cstring>"},"discount_percent":{"type":"number","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.4.details.items.[INDEX].slabs.items.[INDEX].discount_percent","typeLabel":"number"}},"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.4.details.items.[INDEX].slabs.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.4.details.items.[INDEX].slabs","typeLabel":"object[]"}},"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.4.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.4.details","typeLabel":"object[]"},"id":{"type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.4.id","typeLabel":"string"},"expires_at":{"oneOf":[{"description":"null means never expires.","type":"string","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.4.expires_at.oneOf.0","typeLabel":"string"},{"description":"null means never expires.","type":"null","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.4.expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.4.expires_at","typeLabel":"string | null"}},"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.4","typeLabel":"VolumeBasedPromotion · object"},{"type":"null","title":"VolumeBasedPromotion","description":"promotion_type = volume-based","required":["promotion_type","starts_at","details"],"x-tags":["Catalog"],"properties":{"id":{"type":"string","readOnly":true},"promotion_type":{"enum":["volume-based"],"type":"string"},"starts_at":{"type":"string"},"expires_at":{"oneOf":[{"description":"null means never expires.","type":"string"},{"description":"null means never expires.","type":"null"}]},"details":{"type":"array","items":{"type":"object","required":["customer_group_id","slabs"],"properties":{"customer_group_id":{"oneOf":[{"type":"string"},{"type":"null"}]},"slabs":{"type":"array","items":{"type":"object","required":["quantity","quantity_condition","discount_percent"],"properties":{"quantity":{"type":"integer"},"quantity_condition":{"description":"This key defines how the system will evaluate the quantity to determine if the promotion should be applied, based on the specified slab.","enum":["less","less-or-equal","greater","greater-or-equal"],"type":"string"},"discount_percent":{"type":"number"}}}}}}}},"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.5","typeLabel":"null"},{"type":"object","title":"FreeGoodsPromotion","description":"promotion_type = free-goods","required":["promotion_type","starts_at","details"],"x-tags":["Catalog"],"properties":{"promotion_type":{"enum":["free-goods"],"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.6.promotion_type","typeLabel":"enum\u003cstring>"},"starts_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.6.starts_at","typeLabel":"string\u003cdate-time>"},"details":{"type":"array","items":{"oneOf":[{"type":"object","title":"ScaleAutomatically","required":["auto_scale","slab","customer_group_id"],"properties":{"customer_group_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.6.details.items.[INDEX].oneOf.0.customer_group_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.6.details.items.[INDEX].oneOf.0.customer_group_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.6.details.items.[INDEX].oneOf.0.customer_group_id","typeLabel":"string | null"},"auto_scale":{"description":"The **auto_scale** key determines whether the promotion should be automatically adjusted based on the ratio between the quantities bought and the quantities received.\\n\\nIf **true**: The promotion will be applied dynamically according to the ratio of the buy quantity to the get quantity. For example, if the promotion is \\\"Buy 2, Get 1\\\" and the customer buys 4 items, they would receive 2 free items (scaling based on the original ratio).\\n\\nIf **false**: The promotion will be applied strictly according to the predefined conditions. For example, even if the customer buys more items, they will receive the fixed free quantity as defined in the original promotion (e.g., buying 4 would still only get them 1 free item).","type":"boolean","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.6.details.items.[INDEX].oneOf.0.auto_scale","typeLabel":"boolean"},"slab":{"type":"object","properties":{"buy_quantity":{"type":"integer","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.6.details.items.[INDEX].oneOf.0.slab.buy_quantity","typeLabel":"integer"},"get_quantity":{"type":"integer","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.6.details.items.[INDEX].oneOf.0.slab.get_quantity","typeLabel":"integer"},"quantity_condition":{"description":"Defines how the system will evaluate the buy_quantity to determine if the promotion should be applied.","enum":["less","less-or-equal","greater","greater-or-equal"],"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.6.details.items.[INDEX].oneOf.0.slab.quantity_condition","typeLabel":"enum\u003cstring>"}},"required":["buy_quantity","get_quantity","quantity_condition"],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.6.details.items.[INDEX].oneOf.0.slab","typeLabel":"object"}},"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.6.details.items.[INDEX].oneOf.0","typeLabel":"ScaleAutomatically · object"},{"type":"object","title":"CustomSlabs","required":["slabs","customer_group_id"],"properties":{"customer_group_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.6.details.items.[INDEX].oneOf.1.customer_group_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.6.details.items.[INDEX].oneOf.1.customer_group_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.6.details.items.[INDEX].oneOf.1.customer_group_id","typeLabel":"string | null"},"slabs":{"type":"array","items":{"type":"object","properties":{"buy_quantity":{"type":"integer","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.6.details.items.[INDEX].oneOf.1.slabs.items.[INDEX].buy_quantity","typeLabel":"integer"},"get_quantity":{"type":"integer","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.6.details.items.[INDEX].oneOf.1.slabs.items.[INDEX].get_quantity","typeLabel":"integer"},"quantity_condition":{"description":"Defines how the system will evaluate the buy_quantity to determine if the promotion should be applied.","enum":["less","less-or-equal","greater","greater-or-equal"],"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.6.details.items.[INDEX].oneOf.1.slabs.items.[INDEX].quantity_condition","typeLabel":"enum\u003cstring>"}},"required":["buy_quantity","get_quantity","quantity_condition"],"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.6.details.items.[INDEX].oneOf.1.slabs.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.6.details.items.[INDEX].oneOf.1.slabs","typeLabel":"object[]"}},"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.6.details.items.[INDEX].oneOf.1","typeLabel":"CustomSlabs · object"}],"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.6.details.items.[INDEX]","typeLabel":"ScaleAutomatically · object | CustomSlabs · object"},"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.6.details","typeLabel":"(ScaleAutomatically · object | CustomSlabs · object)[]"},"id":{"type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.6.id","typeLabel":"string"},"expires_at":{"oneOf":[{"description":"null means never expires.","type":"string","format":"date-time","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.6.expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"null means never expires.","type":"null","format":"date-time","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.6.expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.6.expires_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.6","typeLabel":"FreeGoodsPromotion · object"},{"type":"null","title":"FreeGoodsPromotion","description":"promotion_type = free-goods","required":["promotion_type","starts_at","details"],"x-tags":["Catalog"],"properties":{"id":{"type":"string","readOnly":true},"promotion_type":{"enum":["free-goods"],"type":"string"},"starts_at":{"type":"string","format":"date-time"},"expires_at":{"oneOf":[{"description":"null means never expires.","type":"string","format":"date-time"},{"description":"null means never expires.","type":"null","format":"date-time"}]},"details":{"type":"array","items":{"oneOf":[{"type":"object","title":"ScaleAutomatically","required":["auto_scale","slab","customer_group_id"],"properties":{"customer_group_id":{"oneOf":[{"type":"string"},{"type":"null"}]},"auto_scale":{"description":"The **auto_scale** key determines whether the promotion should be automatically adjusted based on the ratio between the quantities bought and the quantities received.\\n\\nIf **true**: The promotion will be applied dynamically according to the ratio of the buy quantity to the get quantity. For example, if the promotion is \\\"Buy 2, Get 1\\\" and the customer buys 4 items, they would receive 2 free items (scaling based on the original ratio).\\n\\nIf **false**: The promotion will be applied strictly according to the predefined conditions. For example, even if the customer buys more items, they will receive the fixed free quantity as defined in the original promotion (e.g., buying 4 would still only get them 1 free item).","type":"boolean"},"slab":{"type":"object","properties":{"buy_quantity":{"type":"integer"},"get_quantity":{"type":"integer"},"quantity_condition":{"description":"Defines how the system will evaluate the buy_quantity to determine if the promotion should be applied.","enum":["less","less-or-equal","greater","greater-or-equal"],"type":"string"}},"required":["buy_quantity","get_quantity","quantity_condition"]}}},{"type":"object","title":"CustomSlabs","required":["slabs","customer_group_id"],"properties":{"customer_group_id":{"oneOf":[{"type":"string"},{"type":"null"}]},"slabs":{"type":"array","items":{"type":"object","properties":{"buy_quantity":{"type":"integer"},"get_quantity":{"type":"integer"},"quantity_condition":{"description":"Defines how the system will evaluate the buy_quantity to determine if the promotion should be applied.","enum":["less","less-or-equal","greater","greater-or-equal"],"type":"string"}},"required":["buy_quantity","get_quantity","quantity_condition"]}}}}]}}},"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion.oneOf.7","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].promotion","typeLabel":"DiscountBasedPromotion · object · null · FixedPricePromotion · object · null · VolumeBasedPromotion · object · null · FreeGoodsPromotion · object · null"},"subscription":{"type":"array","items":{"title":"ProductSubscription","type":"object","required":["subscription_plan","billing_interval","billing_frequency","billing_limit","billing_trial_days","fulfill_separately","subscription_price"],"properties":{"subscription_plan":{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].subscription.items.[INDEX].subscription_plan","typeLabel":"string"},"billing_interval":{"type":"integer","format":"int32","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].subscription.items.[INDEX].billing_interval","typeLabel":"integer\u003cint32>"},"billing_frequency":{"enum":["monthly"],"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].subscription.items.[INDEX].billing_frequency","typeLabel":"enum\u003cstring>"},"billing_limit":{"oneOf":[{"type":"integer","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].subscription.items.[INDEX].billing_limit.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].subscription.items.[INDEX].billing_limit.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].subscription.items.[INDEX].billing_limit","typeLabel":"integer | null"},"billing_trial_days":{"type":"integer","format":"int32","default":0,"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].subscription.items.[INDEX].billing_trial_days","typeLabel":"integer\u003cint32>"},"fulfill_separately":{"type":"boolean","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].subscription.items.[INDEX].fulfill_separately","typeLabel":"boolean"},"subscription_price":{"type":"array","items":{"type":"object","required":["suscription_price","minimum_quantity","customer_group_id"],"properties":{"suscription_price":{"type":"number","format":"double","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].subscription.items.[INDEX].subscription_price.items.[INDEX].suscription_price","typeLabel":"number\u003cdouble>"},"minimum_quantity":{"type":"integer","default":1,"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].subscription.items.[INDEX].subscription_price.items.[INDEX].minimum_quantity","typeLabel":"integer"},"customer_group_id":{"oneOf":[{"description":"customer group id.","type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].subscription.items.[INDEX].subscription_price.items.[INDEX].customer_group_id.oneOf.0","typeLabel":"string"},{"description":"customer group id.","type":"null","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].subscription.items.[INDEX].subscription_price.items.[INDEX].customer_group_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].subscription.items.[INDEX].subscription_price.items.[INDEX].customer_group_id","typeLabel":"string | null"}},"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].subscription.items.[INDEX].subscription_price.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].subscription.items.[INDEX].subscription_price","typeLabel":"object[]"},"subscription_plan_id":{"type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].subscription.items.[INDEX].subscription_plan_id","typeLabel":"string"},"order_interval":{"oneOf":[{"type":"integer","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].subscription.items.[INDEX].order_interval.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].subscription.items.[INDEX].order_interval.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].subscription.items.[INDEX].order_interval","typeLabel":"integer | null"},"order_frequency":{"oneOf":[{"type":"string","enum":["monthly"],"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].subscription.items.[INDEX].order_frequency.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["monthly"],"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].subscription.items.[INDEX].order_frequency.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].subscription.items.[INDEX].order_frequency","typeLabel":"enum\u003cstring> | null"},"order_limit":{"oneOf":[{"type":"integer","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].subscription.items.[INDEX].order_limit.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].subscription.items.[INDEX].order_limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].subscription.items.[INDEX].order_limit","typeLabel":"integer | null"}},"x-tags":["Catalog"],"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].subscription.items.[INDEX]","typeLabel":"ProductSubscription · object"},"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].subscription","typeLabel":"ProductSubscription · object[]"},"shipping":{"oneOf":[{"type":"object","title":"ProductShipping","required":["handling_charge"],"x-tags":["Catalog"],"properties":{"handling_charge":{"description":"A handling charge is an additional fee applied to cover the costs associated with preparing, packaging, and processing an order for shipment or delivery.","type":"number","minimum":0,"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].shipping.oneOf.0.handling_charge","typeLabel":"number"}},"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].shipping.oneOf.0","typeLabel":"ProductShipping · object"},{"type":"null","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].shipping.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].shipping","typeLabel":"ProductShipping · object | null"},"packaging":{"oneOf":[{"type":"object","title":"ProductPackaging","required":["pack_width","pack_height","pack_length","pack_dry_weight","units_per_pack","vertical_rotation"],"x-tags":["Catalog"],"properties":{"pack_width":{"type":"number","format":"float","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].packaging.oneOf.0.pack_width","typeLabel":"number\u003cfloat>"},"pack_height":{"type":"number","format":"float","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].packaging.oneOf.0.pack_height","typeLabel":"number\u003cfloat>"},"pack_length":{"type":"number","format":"float","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].packaging.oneOf.0.pack_length","typeLabel":"number\u003cfloat>"},"pack_dry_weight":{"type":"number","format":"float","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].packaging.oneOf.0.pack_dry_weight","typeLabel":"number\u003cfloat>"},"units_per_pack":{"type":"integer","format":"int32","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].packaging.oneOf.0.units_per_pack","typeLabel":"integer\u003cint32>"},"vertical_rotation":{"description":"Indicates whether items can be rotated during packing or if they must be kept in a strictly vertical orientation.","type":"boolean","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].packaging.oneOf.0.vertical_rotation","typeLabel":"boolean"},"product_id":{"type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].packaging.oneOf.0.product_id","typeLabel":"string"},"product_variant_id":{"oneOf":[{"description":"`null` when packaging applies to a product without variants.","type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].packaging.oneOf.0.product_variant_id.oneOf.0","typeLabel":"string"},{"description":"`null` when packaging applies to a product without variants.","type":"null","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].packaging.oneOf.0.product_variant_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].packaging.oneOf.0.product_variant_id","typeLabel":"string | null"},"product_name":{"type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].packaging.oneOf.0.product_name","typeLabel":"string"},"variant_name":{"oneOf":[{"description":"`null` when packaging applies to a product without variants.","type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].packaging.oneOf.0.variant_name.oneOf.0","typeLabel":"string"},{"description":"`null` when packaging applies to a product without variants.","type":"null","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].packaging.oneOf.0.variant_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].packaging.oneOf.0.variant_name","typeLabel":"string | null"},"shipper_width":{"oneOf":[{"type":"number","format":"float","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].packaging.oneOf.0.shipper_width.oneOf.0","typeLabel":"number\u003cfloat>"},{"type":"null","format":"float","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].packaging.oneOf.0.shipper_width.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].packaging.oneOf.0.shipper_width","typeLabel":"number\u003cfloat> | null"},"shipper_height":{"oneOf":[{"type":"number","format":"float","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].packaging.oneOf.0.shipper_height.oneOf.0","typeLabel":"number\u003cfloat>"},{"type":"null","format":"float","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].packaging.oneOf.0.shipper_height.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].packaging.oneOf.0.shipper_height","typeLabel":"number\u003cfloat> | null"},"shipper_length":{"oneOf":[{"type":"number","format":"float","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].packaging.oneOf.0.shipper_length.oneOf.0","typeLabel":"number\u003cfloat>"},{"type":"null","format":"float","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].packaging.oneOf.0.shipper_length.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].packaging.oneOf.0.shipper_length","typeLabel":"number\u003cfloat> | null"},"shipper_dry_weight":{"oneOf":[{"type":"number","format":"float","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].packaging.oneOf.0.shipper_dry_weight.oneOf.0","typeLabel":"number\u003cfloat>"},{"type":"null","format":"float","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].packaging.oneOf.0.shipper_dry_weight.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].packaging.oneOf.0.shipper_dry_weight","typeLabel":"number\u003cfloat> | null"},"units_per_shipper":{"oneOf":[{"type":"integer","format":"int32","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].packaging.oneOf.0.units_per_shipper.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].packaging.oneOf.0.units_per_shipper.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].packaging.oneOf.0.units_per_shipper","typeLabel":"integer\u003cint32> | null"}},"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].packaging.oneOf.0","typeLabel":"ProductPackaging · object"},{"type":"null","title":"ProductPackaging","required":["pack_width","pack_height","pack_length","pack_dry_weight","units_per_pack","vertical_rotation"],"x-tags":["Catalog"],"properties":{"product_id":{"type":"string","readOnly":true},"product_variant_id":{"oneOf":[{"description":"`null` when packaging applies to a product without variants.","type":"string","readOnly":true},{"description":"`null` when packaging applies to a product without variants.","type":"null","readOnly":true}]},"product_name":{"type":"string","readOnly":true},"variant_name":{"oneOf":[{"description":"`null` when packaging applies to a product without variants.","type":"string","readOnly":true},{"description":"`null` when packaging applies to a product without variants.","type":"null","readOnly":true}]},"pack_width":{"type":"number","format":"float"},"pack_height":{"type":"number","format":"float"},"pack_length":{"type":"number","format":"float"},"pack_dry_weight":{"type":"number","format":"float"},"units_per_pack":{"type":"integer","format":"int32"},"vertical_rotation":{"description":"Indicates whether items can be rotated during packing or if they must be kept in a strictly vertical orientation.","type":"boolean"},"shipper_width":{"oneOf":[{"type":"number","format":"float"},{"type":"null","format":"float"}]},"shipper_height":{"oneOf":[{"type":"number","format":"float"},{"type":"null","format":"float"}]},"shipper_length":{"oneOf":[{"type":"number","format":"float"},{"type":"null","format":"float"}]},"shipper_dry_weight":{"oneOf":[{"type":"number","format":"float"},{"type":"null","format":"float"}]},"units_per_shipper":{"oneOf":[{"type":"integer","format":"int32"},{"type":"null","format":"int32"}]}},"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].packaging.oneOf.1","typeLabel":"null"},{"type":"null","uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].packaging.oneOf.2","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX].packaging","typeLabel":"ProductPackaging · object · null · null"}},"x-tags":["Catalog"],"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell.items.[INDEX]","typeLabel":"ProductBasicDetail · object"},"uniqueKey":"content.variants.items.[INDEX].related_products.cross_sell","typeLabel":"ProductBasicDetail · object[]"}},"uniqueKey":"content.variants.items.[INDEX].related_products","typeLabel":"object"},"promotions":{"oneOf":[{"type":"object","title":"DiscountBasedPromotion","description":"promotion_type = discount","required":["promotion_type","starts_at","details"],"x-tags":["Catalog"],"properties":{"promotion_type":{"enum":["discount"],"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.0.promotion_type","typeLabel":"enum\u003cstring>"},"starts_at":{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.0.starts_at","typeLabel":"string"},"details":{"type":"array","items":{"oneOf":[{"type":"object","title":"PercentageBasedDiscount","description":"promotion_type = discount","required":["discount_type","discount_percent","customer_group_id","minimum_quantity","maximum_quantity","maximum_discount_amount"],"properties":{"discount_type":{"type":"string","const":"percentage","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.0.discount_type","typeLabel":"string"},"discount_percent":{"type":"number","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.0.discount_percent","typeLabel":"number"},"customer_group_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.0.customer_group_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.0.customer_group_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.0.customer_group_id","typeLabel":"string | null"},"minimum_quantity":{"description":"It refers to the minimum quantity of a specific item a customer must purchase to qualify for the promotion.","type":"integer","default":1,"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.0.minimum_quantity","typeLabel":"integer"},"maximum_quantity":{"oneOf":[{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"integer","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.0.maximum_quantity.oneOf.0","typeLabel":"integer"},{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"null","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.0.maximum_quantity.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.0.maximum_quantity","typeLabel":"integer | null"},"maximum_discount_amount":{"oneOf":[{"description":"When a value is specified, the discount amount will not exceed the defined maximum, ensuring that the promotion stays within a controlled discount range. If this field is set to null, it indicates that there is no limit to the discount amount.","type":"number","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.0.maximum_discount_amount.oneOf.0","typeLabel":"number"},{"description":"When a value is specified, the discount amount will not exceed the defined maximum, ensuring that the promotion stays within a controlled discount range. If this field is set to null, it indicates that there is no limit to the discount amount.","type":"null","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.0.maximum_discount_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.0.maximum_discount_amount","typeLabel":"number | null"}},"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.0","typeLabel":"PercentageBasedDiscount · object"},{"type":"null","title":"PercentageBasedDiscount","description":"promotion_type = discount","required":["discount_type","discount_percent","customer_group_id","minimum_quantity","maximum_quantity","maximum_discount_amount"],"properties":{"discount_type":{"type":"string","const":"percentage"},"discount_percent":{"type":"number"},"customer_group_id":{"oneOf":[{"type":"string"},{"type":"null"}]},"minimum_quantity":{"description":"It refers to the minimum quantity of a specific item a customer must purchase to qualify for the promotion.","type":"integer","default":1},"maximum_quantity":{"oneOf":[{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"integer"},{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"null"}]},"maximum_discount_amount":{"oneOf":[{"description":"When a value is specified, the discount amount will not exceed the defined maximum, ensuring that the promotion stays within a controlled discount range. If this field is set to null, it indicates that there is no limit to the discount amount.","type":"number"},{"description":"When a value is specified, the discount amount will not exceed the defined maximum, ensuring that the promotion stays within a controlled discount range. If this field is set to null, it indicates that there is no limit to the discount amount.","type":"null"}]}},"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.1","typeLabel":"null"},{"type":"object","title":"FixedAmountBasedDiscount","description":"promotion_type = discount","required":["discount_type","discount_fixed_amount","customer_group_id","minimum_quantity","maximum_quantity"],"properties":{"discount_type":{"type":"string","const":"fixed-amount","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.2.discount_type","typeLabel":"string"},"discount_fixed_amount":{"type":"integer","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.2.discount_fixed_amount","typeLabel":"integer"},"customer_group_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.2.customer_group_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.2.customer_group_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.2.customer_group_id","typeLabel":"string | null"},"minimum_quantity":{"description":"It refers to the minimum quantity of a specific item a customer must purchase to qualify for the promotion.","type":"integer","default":1,"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.2.minimum_quantity","typeLabel":"integer"},"maximum_quantity":{"oneOf":[{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"integer","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.2.maximum_quantity.oneOf.0","typeLabel":"integer"},{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"null","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.2.maximum_quantity.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.2.maximum_quantity","typeLabel":"integer | null"}},"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.2","typeLabel":"FixedAmountBasedDiscount · object"},{"type":"null","title":"FixedAmountBasedDiscount","description":"promotion_type = discount","required":["discount_type","discount_fixed_amount","customer_group_id","minimum_quantity","maximum_quantity"],"properties":{"discount_type":{"type":"string","const":"fixed-amount"},"discount_fixed_amount":{"type":"integer"},"customer_group_id":{"oneOf":[{"type":"string"},{"type":"null"}]},"minimum_quantity":{"description":"It refers to the minimum quantity of a specific item a customer must purchase to qualify for the promotion.","type":"integer","default":1},"maximum_quantity":{"oneOf":[{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"integer"},{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"null"}]}},"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.0.details.items.[INDEX].oneOf.3","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.0.details.items.[INDEX]","typeLabel":"PercentageBasedDiscount · object · null · FixedAmountBasedDiscount · object · null"},"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.0.details","typeLabel":"PercentageBasedDiscount · object · null · FixedAmountBasedDiscount · object · null[]"},"id":{"type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.0.id","typeLabel":"string"},"expires_at":{"oneOf":[{"description":"null means never expires.","type":"string","uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.0.expires_at.oneOf.0","typeLabel":"string"},{"description":"null means never expires.","type":"null","uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.0.expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.0.expires_at","typeLabel":"string | null"}},"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.0","typeLabel":"DiscountBasedPromotion · object"},{"type":"null","title":"DiscountBasedPromotion","description":"promotion_type = discount","required":["promotion_type","starts_at","details"],"x-tags":["Catalog"],"properties":{"id":{"type":"string","readOnly":true},"promotion_type":{"enum":["discount"],"type":"string"},"starts_at":{"type":"string"},"expires_at":{"oneOf":[{"description":"null means never expires.","type":"string"},{"description":"null means never expires.","type":"null"}]},"details":{"type":"array","items":{"oneOf":[{"type":"object","title":"PercentageBasedDiscount","description":"promotion_type = discount","required":["discount_type","discount_percent","customer_group_id","minimum_quantity","maximum_quantity","maximum_discount_amount"],"properties":{"discount_type":{"type":"string","const":"percentage"},"discount_percent":{"type":"number"},"customer_group_id":{"oneOf":[{"type":"string"},{"type":"null"}]},"minimum_quantity":{"description":"It refers to the minimum quantity of a specific item a customer must purchase to qualify for the promotion.","type":"integer","default":1},"maximum_quantity":{"oneOf":[{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"integer"},{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"null"}]},"maximum_discount_amount":{"oneOf":[{"description":"When a value is specified, the discount amount will not exceed the defined maximum, ensuring that the promotion stays within a controlled discount range. If this field is set to null, it indicates that there is no limit to the discount amount.","type":"number"},{"description":"When a value is specified, the discount amount will not exceed the defined maximum, ensuring that the promotion stays within a controlled discount range. If this field is set to null, it indicates that there is no limit to the discount amount.","type":"null"}]}}},{"type":"null","title":"PercentageBasedDiscount","description":"promotion_type = discount","required":["discount_type","discount_percent","customer_group_id","minimum_quantity","maximum_quantity","maximum_discount_amount"],"properties":{"discount_type":{"type":"string","const":"percentage"},"discount_percent":{"type":"number"},"customer_group_id":{"oneOf":[{"type":"string"},{"type":"null"}]},"minimum_quantity":{"description":"It refers to the minimum quantity of a specific item a customer must purchase to qualify for the promotion.","type":"integer","default":1},"maximum_quantity":{"oneOf":[{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"integer"},{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"null"}]},"maximum_discount_amount":{"oneOf":[{"description":"When a value is specified, the discount amount will not exceed the defined maximum, ensuring that the promotion stays within a controlled discount range. If this field is set to null, it indicates that there is no limit to the discount amount.","type":"number"},{"description":"When a value is specified, the discount amount will not exceed the defined maximum, ensuring that the promotion stays within a controlled discount range. If this field is set to null, it indicates that there is no limit to the discount amount.","type":"null"}]}}},{"type":"object","title":"FixedAmountBasedDiscount","description":"promotion_type = discount","required":["discount_type","discount_fixed_amount","customer_group_id","minimum_quantity","maximum_quantity"],"properties":{"discount_type":{"type":"string","const":"fixed-amount"},"discount_fixed_amount":{"type":"integer"},"customer_group_id":{"oneOf":[{"type":"string"},{"type":"null"}]},"minimum_quantity":{"description":"It refers to the minimum quantity of a specific item a customer must purchase to qualify for the promotion.","type":"integer","default":1},"maximum_quantity":{"oneOf":[{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"integer"},{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"null"}]}}},{"type":"null","title":"FixedAmountBasedDiscount","description":"promotion_type = discount","required":["discount_type","discount_fixed_amount","customer_group_id","minimum_quantity","maximum_quantity"],"properties":{"discount_type":{"type":"string","const":"fixed-amount"},"discount_fixed_amount":{"type":"integer"},"customer_group_id":{"oneOf":[{"type":"string"},{"type":"null"}]},"minimum_quantity":{"description":"It refers to the minimum quantity of a specific item a customer must purchase to qualify for the promotion.","type":"integer","default":1},"maximum_quantity":{"oneOf":[{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"integer"},{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"null"}]}}}]}}},"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.1","typeLabel":"null"},{"type":"object","title":"FixedPricePromotion","description":"promotion_type = fixed-price","required":["promotion_type","starts_at","details"],"x-tags":["Catalog"],"properties":{"promotion_type":{"enum":["fixed-price"],"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.2.promotion_type","typeLabel":"enum\u003cstring>"},"starts_at":{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.2.starts_at","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","required":["offer_price","customer_group_id","minimum_quantity","maximum_quantity"],"properties":{"offer_price":{"type":"number","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.2.details.items.[INDEX].offer_price","typeLabel":"number"},"customer_group_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.2.details.items.[INDEX].customer_group_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.2.details.items.[INDEX].customer_group_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.2.details.items.[INDEX].customer_group_id","typeLabel":"string | null"},"minimum_quantity":{"description":"It refers to the minimum quantity of a specific item a customer must purchase to qualify for the promotion.","type":"integer","default":1,"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.2.details.items.[INDEX].minimum_quantity","typeLabel":"integer"},"maximum_quantity":{"oneOf":[{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"integer","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.2.details.items.[INDEX].maximum_quantity.oneOf.0","typeLabel":"integer"},{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"null","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.2.details.items.[INDEX].maximum_quantity.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.2.details.items.[INDEX].maximum_quantity","typeLabel":"integer | null"}},"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.2.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.2.details","typeLabel":"object[]"},"id":{"type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.2.id","typeLabel":"string"},"expires_at":{"oneOf":[{"description":"null means never expires.","type":"string","uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.2.expires_at.oneOf.0","typeLabel":"string"},{"description":"null means never expires.","type":"null","uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.2.expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.2.expires_at","typeLabel":"string | null"}},"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.2","typeLabel":"FixedPricePromotion · object"},{"type":"null","title":"FixedPricePromotion","description":"promotion_type = fixed-price","required":["promotion_type","starts_at","details"],"x-tags":["Catalog"],"properties":{"id":{"type":"string","readOnly":true},"promotion_type":{"enum":["fixed-price"],"type":"string"},"starts_at":{"type":"string"},"expires_at":{"oneOf":[{"description":"null means never expires.","type":"string"},{"description":"null means never expires.","type":"null"}]},"details":{"type":"array","items":{"type":"object","required":["offer_price","customer_group_id","minimum_quantity","maximum_quantity"],"properties":{"offer_price":{"type":"number"},"customer_group_id":{"oneOf":[{"type":"string"},{"type":"null"}]},"minimum_quantity":{"description":"It refers to the minimum quantity of a specific item a customer must purchase to qualify for the promotion.","type":"integer","default":1},"maximum_quantity":{"oneOf":[{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"integer"},{"description":"It refers to the maximum quantity of a specific item a customer can purchase in order to qualify for the promotion. If this field is set to null, it indicates that there is no limit.","type":"null"}]}}}}},"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.3","typeLabel":"null"},{"type":"object","title":"VolumeBasedPromotion","description":"promotion_type = volume-based","required":["promotion_type","starts_at","details"],"x-tags":["Catalog"],"properties":{"promotion_type":{"enum":["volume-based"],"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.4.promotion_type","typeLabel":"enum\u003cstring>"},"starts_at":{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.4.starts_at","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","required":["customer_group_id","slabs"],"properties":{"customer_group_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.4.details.items.[INDEX].customer_group_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.4.details.items.[INDEX].customer_group_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.4.details.items.[INDEX].customer_group_id","typeLabel":"string | null"},"slabs":{"type":"array","items":{"type":"object","required":["quantity","quantity_condition","discount_percent"],"properties":{"quantity":{"type":"integer","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.4.details.items.[INDEX].slabs.items.[INDEX].quantity","typeLabel":"integer"},"quantity_condition":{"description":"This key defines how the system will evaluate the quantity to determine if the promotion should be applied, based on the specified slab.","enum":["less","less-or-equal","greater","greater-or-equal"],"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.4.details.items.[INDEX].slabs.items.[INDEX].quantity_condition","typeLabel":"enum\u003cstring>"},"discount_percent":{"type":"number","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.4.details.items.[INDEX].slabs.items.[INDEX].discount_percent","typeLabel":"number"}},"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.4.details.items.[INDEX].slabs.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.4.details.items.[INDEX].slabs","typeLabel":"object[]"}},"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.4.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.4.details","typeLabel":"object[]"},"id":{"type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.4.id","typeLabel":"string"},"expires_at":{"oneOf":[{"description":"null means never expires.","type":"string","uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.4.expires_at.oneOf.0","typeLabel":"string"},{"description":"null means never expires.","type":"null","uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.4.expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.4.expires_at","typeLabel":"string | null"}},"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.4","typeLabel":"VolumeBasedPromotion · object"},{"type":"null","title":"VolumeBasedPromotion","description":"promotion_type = volume-based","required":["promotion_type","starts_at","details"],"x-tags":["Catalog"],"properties":{"id":{"type":"string","readOnly":true},"promotion_type":{"enum":["volume-based"],"type":"string"},"starts_at":{"type":"string"},"expires_at":{"oneOf":[{"description":"null means never expires.","type":"string"},{"description":"null means never expires.","type":"null"}]},"details":{"type":"array","items":{"type":"object","required":["customer_group_id","slabs"],"properties":{"customer_group_id":{"oneOf":[{"type":"string"},{"type":"null"}]},"slabs":{"type":"array","items":{"type":"object","required":["quantity","quantity_condition","discount_percent"],"properties":{"quantity":{"type":"integer"},"quantity_condition":{"description":"This key defines how the system will evaluate the quantity to determine if the promotion should be applied, based on the specified slab.","enum":["less","less-or-equal","greater","greater-or-equal"],"type":"string"},"discount_percent":{"type":"number"}}}}}}}},"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.5","typeLabel":"null"},{"type":"object","title":"FreeGoodsPromotion","description":"promotion_type = free-goods","required":["promotion_type","starts_at","details"],"x-tags":["Catalog"],"properties":{"promotion_type":{"enum":["free-goods"],"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.6.promotion_type","typeLabel":"enum\u003cstring>"},"starts_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.6.starts_at","typeLabel":"string\u003cdate-time>"},"details":{"type":"array","items":{"oneOf":[{"type":"object","title":"ScaleAutomatically","required":["auto_scale","slab","customer_group_id"],"properties":{"customer_group_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.6.details.items.[INDEX].oneOf.0.customer_group_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.6.details.items.[INDEX].oneOf.0.customer_group_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.6.details.items.[INDEX].oneOf.0.customer_group_id","typeLabel":"string | null"},"auto_scale":{"description":"The **auto_scale** key determines whether the promotion should be automatically adjusted based on the ratio between the quantities bought and the quantities received.\\n\\nIf **true**: The promotion will be applied dynamically according to the ratio of the buy quantity to the get quantity. For example, if the promotion is \\\"Buy 2, Get 1\\\" and the customer buys 4 items, they would receive 2 free items (scaling based on the original ratio).\\n\\nIf **false**: The promotion will be applied strictly according to the predefined conditions. For example, even if the customer buys more items, they will receive the fixed free quantity as defined in the original promotion (e.g., buying 4 would still only get them 1 free item).","type":"boolean","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.6.details.items.[INDEX].oneOf.0.auto_scale","typeLabel":"boolean"},"slab":{"type":"object","properties":{"buy_quantity":{"type":"integer","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.6.details.items.[INDEX].oneOf.0.slab.buy_quantity","typeLabel":"integer"},"get_quantity":{"type":"integer","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.6.details.items.[INDEX].oneOf.0.slab.get_quantity","typeLabel":"integer"},"quantity_condition":{"description":"Defines how the system will evaluate the buy_quantity to determine if the promotion should be applied.","enum":["less","less-or-equal","greater","greater-or-equal"],"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.6.details.items.[INDEX].oneOf.0.slab.quantity_condition","typeLabel":"enum\u003cstring>"}},"required":["buy_quantity","get_quantity","quantity_condition"],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.6.details.items.[INDEX].oneOf.0.slab","typeLabel":"object"}},"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.6.details.items.[INDEX].oneOf.0","typeLabel":"ScaleAutomatically · object"},{"type":"object","title":"CustomSlabs","required":["slabs","customer_group_id"],"properties":{"customer_group_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.6.details.items.[INDEX].oneOf.1.customer_group_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.6.details.items.[INDEX].oneOf.1.customer_group_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.6.details.items.[INDEX].oneOf.1.customer_group_id","typeLabel":"string | null"},"slabs":{"type":"array","items":{"type":"object","properties":{"buy_quantity":{"type":"integer","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.6.details.items.[INDEX].oneOf.1.slabs.items.[INDEX].buy_quantity","typeLabel":"integer"},"get_quantity":{"type":"integer","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.6.details.items.[INDEX].oneOf.1.slabs.items.[INDEX].get_quantity","typeLabel":"integer"},"quantity_condition":{"description":"Defines how the system will evaluate the buy_quantity to determine if the promotion should be applied.","enum":["less","less-or-equal","greater","greater-or-equal"],"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.6.details.items.[INDEX].oneOf.1.slabs.items.[INDEX].quantity_condition","typeLabel":"enum\u003cstring>"}},"required":["buy_quantity","get_quantity","quantity_condition"],"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.6.details.items.[INDEX].oneOf.1.slabs.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.6.details.items.[INDEX].oneOf.1.slabs","typeLabel":"object[]"}},"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.6.details.items.[INDEX].oneOf.1","typeLabel":"CustomSlabs · object"}],"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.6.details.items.[INDEX]","typeLabel":"ScaleAutomatically · object | CustomSlabs · object"},"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.6.details","typeLabel":"(ScaleAutomatically · object | CustomSlabs · object)[]"},"id":{"type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.6.id","typeLabel":"string"},"expires_at":{"oneOf":[{"description":"null means never expires.","type":"string","format":"date-time","uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.6.expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"null means never expires.","type":"null","format":"date-time","uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.6.expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.6.expires_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.6","typeLabel":"FreeGoodsPromotion · object"},{"type":"null","title":"FreeGoodsPromotion","description":"promotion_type = free-goods","required":["promotion_type","starts_at","details"],"x-tags":["Catalog"],"properties":{"id":{"type":"string","readOnly":true},"promotion_type":{"enum":["free-goods"],"type":"string"},"starts_at":{"type":"string","format":"date-time"},"expires_at":{"oneOf":[{"description":"null means never expires.","type":"string","format":"date-time"},{"description":"null means never expires.","type":"null","format":"date-time"}]},"details":{"type":"array","items":{"oneOf":[{"type":"object","title":"ScaleAutomatically","required":["auto_scale","slab","customer_group_id"],"properties":{"customer_group_id":{"oneOf":[{"type":"string"},{"type":"null"}]},"auto_scale":{"description":"The **auto_scale** key determines whether the promotion should be automatically adjusted based on the ratio between the quantities bought and the quantities received.\\n\\nIf **true**: The promotion will be applied dynamically according to the ratio of the buy quantity to the get quantity. For example, if the promotion is \\\"Buy 2, Get 1\\\" and the customer buys 4 items, they would receive 2 free items (scaling based on the original ratio).\\n\\nIf **false**: The promotion will be applied strictly according to the predefined conditions. For example, even if the customer buys more items, they will receive the fixed free quantity as defined in the original promotion (e.g., buying 4 would still only get them 1 free item).","type":"boolean"},"slab":{"type":"object","properties":{"buy_quantity":{"type":"integer"},"get_quantity":{"type":"integer"},"quantity_condition":{"description":"Defines how the system will evaluate the buy_quantity to determine if the promotion should be applied.","enum":["less","less-or-equal","greater","greater-or-equal"],"type":"string"}},"required":["buy_quantity","get_quantity","quantity_condition"]}}},{"type":"object","title":"CustomSlabs","required":["slabs","customer_group_id"],"properties":{"customer_group_id":{"oneOf":[{"type":"string"},{"type":"null"}]},"slabs":{"type":"array","items":{"type":"object","properties":{"buy_quantity":{"type":"integer"},"get_quantity":{"type":"integer"},"quantity_condition":{"description":"Defines how the system will evaluate the buy_quantity to determine if the promotion should be applied.","enum":["less","less-or-equal","greater","greater-or-equal"],"type":"string"}},"required":["buy_quantity","get_quantity","quantity_condition"]}}}}]}}},"uniqueKey":"content.variants.items.[INDEX].promotions.oneOf.7","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].promotions","typeLabel":"DiscountBasedPromotion · object · null · FixedPricePromotion · object · null · VolumeBasedPromotion · object · null · FreeGoodsPromotion · object · null"},"subscriptions":{"type":"array","items":{"title":"ProductSubscription","type":"object","required":["subscription_plan","billing_interval","billing_frequency","billing_limit","billing_trial_days","fulfill_separately","subscription_price"],"properties":{"subscription_plan":{"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].subscriptions.items.[INDEX].subscription_plan","typeLabel":"string"},"billing_interval":{"type":"integer","format":"int32","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].subscriptions.items.[INDEX].billing_interval","typeLabel":"integer\u003cint32>"},"billing_frequency":{"enum":["monthly"],"type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].subscriptions.items.[INDEX].billing_frequency","typeLabel":"enum\u003cstring>"},"billing_limit":{"oneOf":[{"type":"integer","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].subscriptions.items.[INDEX].billing_limit.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].subscriptions.items.[INDEX].billing_limit.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].subscriptions.items.[INDEX].billing_limit","typeLabel":"integer | null"},"billing_trial_days":{"type":"integer","format":"int32","default":0,"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].subscriptions.items.[INDEX].billing_trial_days","typeLabel":"integer\u003cint32>"},"fulfill_separately":{"type":"boolean","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].subscriptions.items.[INDEX].fulfill_separately","typeLabel":"boolean"},"subscription_price":{"type":"array","items":{"type":"object","required":["suscription_price","minimum_quantity","customer_group_id"],"properties":{"suscription_price":{"type":"number","format":"double","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].subscriptions.items.[INDEX].subscription_price.items.[INDEX].suscription_price","typeLabel":"number\u003cdouble>"},"minimum_quantity":{"type":"integer","default":1,"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].subscriptions.items.[INDEX].subscription_price.items.[INDEX].minimum_quantity","typeLabel":"integer"},"customer_group_id":{"oneOf":[{"description":"customer group id.","type":"string","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].subscriptions.items.[INDEX].subscription_price.items.[INDEX].customer_group_id.oneOf.0","typeLabel":"string"},{"description":"customer group id.","type":"null","isRequired":true,"uniqueKey":"content.variants.items.[INDEX].subscriptions.items.[INDEX].subscription_price.items.[INDEX].customer_group_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].subscriptions.items.[INDEX].subscription_price.items.[INDEX].customer_group_id","typeLabel":"string | null"}},"uniqueKey":"content.variants.items.[INDEX].subscriptions.items.[INDEX].subscription_price.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"content.variants.items.[INDEX].subscriptions.items.[INDEX].subscription_price","typeLabel":"object[]"},"subscription_plan_id":{"type":"string","readOnly":true,"uniqueKey":"content.variants.items.[INDEX].subscriptions.items.[INDEX].subscription_plan_id","typeLabel":"string"},"order_interval":{"oneOf":[{"type":"integer","uniqueKey":"content.variants.items.[INDEX].subscriptions.items.[INDEX].order_interval.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"content.variants.items.[INDEX].subscriptions.items.[INDEX].order_interval.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].subscriptions.items.[INDEX].order_interval","typeLabel":"integer | null"},"order_frequency":{"oneOf":[{"type":"string","enum":["monthly"],"uniqueKey":"content.variants.items.[INDEX].subscriptions.items.[INDEX].order_frequency.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["monthly"],"uniqueKey":"content.variants.items.[INDEX].subscriptions.items.[INDEX].order_frequency.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].subscriptions.items.[INDEX].order_frequency","typeLabel":"enum\u003cstring> | null"},"order_limit":{"oneOf":[{"type":"integer","uniqueKey":"content.variants.items.[INDEX].subscriptions.items.[INDEX].order_limit.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"content.variants.items.[INDEX].subscriptions.items.[INDEX].order_limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.variants.items.[INDEX].subscriptions.items.[INDEX].order_limit","typeLabel":"integer | null"}},"x-tags":["Catalog"],"uniqueKey":"content.variants.items.[INDEX].subscriptions.items.[INDEX]","typeLabel":"ProductSubscription · object"},"uniqueKey":"content.variants.items.[INDEX].subscriptions","typeLabel":"ProductSubscription · object[]"}},"uniqueKey":"content.variants.items.[INDEX]","typeLabel":"VariantDetail · object"},"uniqueKey":"content.variants","typeLabel":"VariantDetail · object[]"}},"type":"object","uniqueKey":"content","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","success":true,"content":{"variants":[{"id":"\u003cstring>","active":true,"stock_available":true,"is_default":true,"short_description":"\u003cstring>","metadata":{},"sku":"\u003cstring>","slug":"\u003cstring>","hsn_code":"\u003cstring>","on_offer":true,"on_promotion":true,"on_subscription":true,"product_type":"physical","product_id":"\u003cstring>","product_name":"\u003cstring>","pricing":[{"customer_group_id":"\u003cstring>","cost_price":123,"listing_price":123,"selling_price":123,"tax_rate":123,"min_order_quantity":1,"max_order_quantity":123,"incremental_quantity":1,"tax_type":"GST"}],"created_at":"2023-11-07T05:31:56Z","modified_at":"2023-11-07T05:31:56Z","variant_attributes":[{"id":"\u003cstring>","name":"\u003cstring>","type":"text","value":"\u003cstring>","is_visible":true,"is_filterable":true,"attribute_id":"\u003cstring>","attribute_name":"\u003cstring>","attribute_type":"text","attribute_value":"\u003cstring>","key":"\u003cstring>"}],"name":"\u003cstring>","associated_options":[{"attribute_id":"\u003cstring>","attribute_value":"\u003cstring>","attribute_name":"\u003cstring>","attribute_type":"single-select","key":"\u003cstring>"}],"images":[{"title":"\u003cstring>","alternate_text":"\u003cstring>","sort_order":123,"url_tiny":"\u003cstring>","url_thumbnail":"\u003cstring>","url_standard":"\u003cstring>","url_zoom":"\u003cstring>","file_id":"\u003cstring>","file_type":"\u003cstring>"}],"sales_channels":[{"id":"\u003cstring>","name":"\u003cstring>","active":true,"kind":"storefront","sales_channel_type":"\u003cstring>","sales_channel_slug":"\u003cstring>"}],"status":"draft","packaging":{"pack_width":123,"pack_height":123,"pack_length":123,"pack_dry_weight":123,"units_per_pack":123,"vertical_rotation":true,"product_id":"\u003cstring>","product_variant_id":"\u003cstring>","product_name":"\u003cstring>","variant_name":"\u003cstring>","shipper_width":123,"shipper_height":123,"shipper_length":123,"shipper_dry_weight":123,"units_per_shipper":123},"shipping":{"handling_charge":1},"description":"\u003cstring>","videos":[{"title":"\u003cstring>","alternate_text":"\u003cstring>","sort_order":123,"video_preview_url":"\u003cstring>","video_stream_hls_url":"\u003cstring>","video_stream_dash_url":"\u003cstring>","image_thumbnail_url":"\u003cstring>","video_duration":123,"file_id":"\u003cstring>"}],"seo":{"title":"\u003cstring>","description":"\u003cstring>","keywords":"\u003carray>"},"related_products":{"upsell":[{"id":"\u003cstring>","product_id":"\u003cstring>","product_name":"\u003cstring>","product_type":"physical","status":"draft","tags":["\u003cstring>"],"reviews_rating_sum":123,"reviews_count":123,"hsn_code":"\u003cstring>","variant_id":"\u003cstring>","variant_name":"\u003cstring>","slug":"\u003cstring>","sku":"\u003cstring>","associated_options":[{"attribute_id":"\u003cstring>","attribute_value":"\u003cstring>","attribute_name":"\u003cstring>","attribute_type":"single-select","key":"\u003cstring>"}],"active":true,"stock_available":true,"images":[{"title":"\u003cstring>","alternate_text":"\u003cstring>","sort_order":123,"url_tiny":"\u003cstring>","url_thumbnail":"\u003cstring>","url_standard":"\u003cstring>","url_zoom":"\u003cstring>","file_id":"\u003cstring>","file_type":"\u003cstring>"}],"pricing":[{"customer_group_id":"\u003cstring>","cost_price":123,"listing_price":123,"selling_price":123,"tax_rate":123,"min_order_quantity":1,"max_order_quantity":123,"incremental_quantity":1,"tax_type":"GST"}],"metadata":{},"attributes":[{"id":"\u003cstring>","name":"\u003cstring>","type":"text","value":"\u003cstring>","is_visible":true,"is_filterable":true,"attribute_id":"\u003cstring>","attribute_name":"\u003cstring>","attribute_type":"text","attribute_value":"\u003cstring>","key":"\u003cstring>"}],"category_ids":["\u003cstring>"],"is_featured":true,"on_offer":true,"on_promotion":true,"on_subscription":true,"description":"\u003cstring>","short_description":"\u003cstring>","promotion":{"promotion_type":"discount","starts_at":"\u003cstring>","details":[{"discount_type":"percentage","discount_percent":123,"customer_group_id":"\u003cstring>","minimum_quantity":1,"maximum_quantity":123,"maximum_discount_amount":123}],"id":"\u003cstring>","expires_at":"\u003cstring>"},"subscription":[{"subscription_plan":"\u003cstring>","billing_interval":123,"billing_frequency":"monthly","billing_limit":123,"billing_trial_days":0,"fulfill_separately":true,"subscription_price":[{"suscription_price":123,"minimum_quantity":1,"customer_group_id":"\u003cstring>"}],"subscription_plan_id":"\u003cstring>","order_interval":123,"order_frequency":"monthly","order_limit":123}],"shipping":{"handling_charge":1},"packaging":{"pack_width":123,"pack_height":123,"pack_length":123,"pack_dry_weight":123,"units_per_pack":123,"vertical_rotation":true,"product_id":"\u003cstring>","product_variant_id":"\u003cstring>","product_name":"\u003cstring>","variant_name":"\u003cstring>","shipper_width":123,"shipper_height":123,"shipper_length":123,"shipper_dry_weight":123,"units_per_shipper":123}}],"cross_sell":[{"id":"\u003cstring>","product_id":"\u003cstring>","product_name":"\u003cstring>","product_type":"physical","status":"draft","tags":["\u003cstring>"],"reviews_rating_sum":123,"reviews_count":123,"hsn_code":"\u003cstring>","variant_id":"\u003cstring>","variant_name":"\u003cstring>","slug":"\u003cstring>","sku":"\u003cstring>","associated_options":[{"attribute_id":"\u003cstring>","attribute_value":"\u003cstring>","attribute_name":"\u003cstring>","attribute_type":"single-select","key":"\u003cstring>"}],"active":true,"stock_available":true,"images":[{"title":"\u003cstring>","alternate_text":"\u003cstring>","sort_order":123,"url_tiny":"\u003cstring>","url_thumbnail":"\u003cstring>","url_standard":"\u003cstring>","url_zoom":"\u003cstring>","file_id":"\u003cstring>","file_type":"\u003cstring>"}],"pricing":[{"customer_group_id":"\u003cstring>","cost_price":123,"listing_price":123,"selling_price":123,"tax_rate":123,"min_order_quantity":1,"max_order_quantity":123,"incremental_quantity":1,"tax_type":"GST"}],"metadata":{},"attributes":[{"id":"\u003cstring>","name":"\u003cstring>","type":"text","value":"\u003cstring>","is_visible":true,"is_filterable":true,"attribute_id":"\u003cstring>","attribute_name":"\u003cstring>","attribute_type":"text","attribute_value":"\u003cstring>","key":"\u003cstring>"}],"category_ids":["\u003cstring>"],"is_featured":true,"on_offer":true,"on_promotion":true,"on_subscription":true,"description":"\u003cstring>","short_description":"\u003cstring>","promotion":{"promotion_type":"discount","starts_at":"\u003cstring>","details":[{"discount_type":"percentage","discount_percent":123,"customer_group_id":"\u003cstring>","minimum_quantity":1,"maximum_quantity":123,"maximum_discount_amount":123}],"id":"\u003cstring>","expires_at":"\u003cstring>"},"subscription":[{"subscription_plan":"\u003cstring>","billing_interval":123,"billing_frequency":"monthly","billing_limit":123,"billing_trial_days":0,"fulfill_separately":true,"subscription_price":[{"suscription_price":123,"minimum_quantity":1,"customer_group_id":"\u003cstring>"}],"subscription_plan_id":"\u003cstring>","order_interval":123,"order_frequency":"monthly","order_limit":123}],"shipping":{"handling_charge":1},"packaging":{"pack_width":123,"pack_height":123,"pack_length":123,"pack_dry_weight":123,"units_per_pack":123,"vertical_rotation":true,"product_id":"\u003cstring>","product_variant_id":"\u003cstring>","product_name":"\u003cstring>","variant_name":"\u003cstring>","shipper_width":123,"shipper_height":123,"shipper_length":123,"shipper_dry_weight":123,"units_per_shipper":123}}]},"promotions":{"promotion_type":"discount","starts_at":"\u003cstring>","details":[{"discount_type":"percentage","discount_percent":123,"customer_group_id":"\u003cstring>","minimum_quantity":1,"maximum_quantity":123,"maximum_discount_amount":123}],"id":"\u003cstring>","expires_at":"\u003cstring>"},"subscriptions":[{"subscription_plan":"\u003cstring>","billing_interval":123,"billing_frequency":"monthly","billing_limit":123,"billing_trial_days":0,"fulfill_separately":true,"subscription_price":[{"suscription_price":123,"minimum_quantity":1,"customer_group_id":"\u003cstring>"}],"subscription_plan_id":"\u003cstring>","order_interval":123,"order_frequency":"monthly","order_limit":123}]}]}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"40cf46b8-447c-4ad1-be68-0627685ec9bf":{"Authorization":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"Authorization"}}},"servers":{"506eb153-5ecc-46fb-a8e2-3c415e5074c2":{"url":"https://staging.api.commercengine.io/api/v1/{store_id}/admin","description":"Staging Server","variables":{"store_id":{"default":"store_id","description":"Store ID"}}},"1a1af4af-a5a0-4bb7-8748-eb6bfe80502e":{"url":"https://prod.api.commercengine.io/api/v1/{store_id}/admin","description":"Prod Server","variables":{"store_id":{"default":"store_id","description":"Store ID"}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"Authorization"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"Authorization","name":"Authorization"}],"title":"Authorization"}]},"originalFileLocation":"https://openapi.commercengine.io/ce-admin.json"},"subdomain":"tarkai","siteName":"Commerce Engine Docs","title":"Create variant - Commerce Engine Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-07T06:38:10.120Z","originalFileLocation":"admin/api-reference/catalog/create-variant.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=\"Create variant\">\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 variant - Commerce Engine Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create variant\">\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/admin/api-reference/catalog/create-variant\">\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=Catalog\u0026amp;title=Create+variant\u0026amp;description=Create+variant\u0026amp;theme=76e8f8f14f90cfb8929bc40a\u0026amp;signature=62be403bb7e5bd27568508c9e87c1baf1cd4e4c0e87f074094d2af611a389fd3\">\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 variant - Commerce Engine Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create variant\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://tarkai.mintlify.site/docs/_mintlify/api/og/v2?division=Catalog\u0026amp;title=Create+variant\u0026amp;description=Create+variant\u0026amp;theme=76e8f8f14f90cfb8929bc40a\u0026amp;signature=62be403bb7e5bd27568508c9e87c1baf1cd4e4c0e87f074094d2af611a389fd3\">\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/admin/api-reference/catalog/create-variant\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/admin/api-reference/catalog/create-variant.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/admin/api-reference/catalog/create-variant#webpage\",\"url\":\"https://www.commercengine.io/docs/admin/api-reference/catalog/create-variant\",\"name\":\"Create variant\",\"description\":\"Create variant\",\"dateModified\":\"2026-11-07T06:38:10.120Z\",\"isPartOf\":{\"@id\":\"https://www.commercengine.io/docs#website\"},\"breadcrumb\":{\"@id\":\"https://www.commercengine.io/docs/admin/api-reference/catalog/create-variant#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://www.commercengine.io/docs/admin/api-reference/catalog/create-variant#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Admin\",\"item\":\"https://www.commercengine.io/docs/admin/api-reference/analytics/retrieve-analytics-chart-data\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Catalog\",\"item\":\"https://www.commercengine.io/docs/admin/api-reference/catalog/list-all-attribute-sets\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create variant\",\"item\":\"https://www.commercengine.io/docs/admin/api-reference/catalog/create-variant\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://www.commercengine.io/docs/admin/api-reference/catalog/create-variant#apireference\",\"headline\":\"Create variant\",\"name\":\"Create variant\",\"description\":\"Create variant\",\"url\":\"https://www.commercengine.io/docs/admin/api-reference/catalog/create-variant\",\"mainEntityOfPage\":{\"@id\":\"https://www.commercengine.io/docs/admin/api-reference/catalog/create-variant#webpage\"},\"dateModified\":\"2026-11-07T06:38:10.120Z\",\"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\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","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":"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/getting-started"}]},{"item":"POS API","icon":"cash-register","description":"Point of sale — staff login, device pairing, carts, catalog and order capture on the storefront base URL.","pages":[{"title":"POS API","href":"/api-reference/pos/overview"}]},{"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/overview"}]},{"item":"Admin API","icon":"gear","description":"Back-office operations — catalog management, customers, fulfilment, store settings.","groups":[{"group":"Admin","pages":[{"group":"Analytics","pages":[{"title":"Retrieve analytics chart data","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /analytics/charts","href":"/admin/api-reference/analytics/retrieve-analytics-chart-data"},{"title":"Dynamic query","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /analytics/dynamic-query","href":"/admin/api-reference/analytics/dynamic-query"},{"title":"Retrieve an event detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /analytics/events/{id}","href":"/admin/api-reference/analytics/retrieve-an-event-detail"},{"title":"Raw query","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /analytics/raw-query","href":"/admin/api-reference/analytics/raw-query"},{"title":"List analytics sessions","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /analytics/sessions","href":"/admin/api-reference/analytics/list-analytics-sessions"},{"title":"Retrieve a analytics session","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /analytics/sessions/{id}","href":"/admin/api-reference/analytics/retrieve-a-analytics-session"}]},{"group":"Catalog","pages":[{"title":"List all attribute sets","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /catalog/attribute-sets","href":"/admin/api-reference/catalog/list-all-attribute-sets"},{"title":"Create attribute set","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /catalog/attribute-sets","href":"/admin/api-reference/catalog/create-attribute-set"},{"title":"Retrieve attribute set","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /catalog/attribute-sets/{id}","href":"/admin/api-reference/catalog/retrieve-attribute-set"},{"title":"Update attribute set","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json put /catalog/attribute-sets/{id}","href":"/admin/api-reference/catalog/update-attribute-set"},{"title":"Delete attribute set","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json delete /catalog/attribute-sets/{id}","href":"/admin/api-reference/catalog/delete-attribute-set"},{"title":"List all attributes","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /catalog/attributes","href":"/admin/api-reference/catalog/list-all-attributes"},{"title":"Create attribute","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /catalog/attributes","href":"/admin/api-reference/catalog/create-attribute"},{"title":"Retrieve attribute","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /catalog/attributes/{id}","href":"/admin/api-reference/catalog/retrieve-attribute"},{"title":"Update attribute","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json put /catalog/attributes/{id}","href":"/admin/api-reference/catalog/update-attribute"},{"title":"Delete attribute","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json delete /catalog/attributes/{id}","href":"/admin/api-reference/catalog/delete-attribute"},{"title":"List all categories","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /catalog/categories","href":"/admin/api-reference/catalog/list-all-categories"},{"title":"Create category","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /catalog/categories","href":"/admin/api-reference/catalog/create-category"},{"title":"Retrieve category","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /catalog/categories/{id}","href":"/admin/api-reference/catalog/retrieve-category"},{"title":"Update category","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json put /catalog/categories/{id}","href":"/admin/api-reference/catalog/update-category"},{"title":"Delete category","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json delete /catalog/categories/{id}","href":"/admin/api-reference/catalog/delete-category"},{"title":"Retrieve category attributes","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /catalog/categories/{id}/attributes","href":"/admin/api-reference/catalog/retrieve-category-attributes"},{"title":"Create or update category attributes","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /catalog/categories/{id}/attributes","href":"/admin/api-reference/catalog/create-or-update-category-attributes"},{"title":"Retrive data sync detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /catalog/integration-sync","href":"/admin/api-reference/catalog/retrive-data-sync-detail"},{"title":"Create request for data syncing","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /catalog/integration-sync","href":"/admin/api-reference/catalog/create-request-for-data-syncing"},{"title":"Manually sync a single catalog item","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /catalog/integration-sync/manual","href":"/admin/api-reference/catalog/manually-sync-a-single-catalog-item"},{"title":"Sync integration destination models","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /catalog/integration-sync/models","href":"/admin/api-reference/catalog/sync-integration-destination-models"},{"title":"Retrive item sync detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /catalog/integration-sync/{item_id}","href":"/admin/api-reference/catalog/retrive-item-sync-detail"},{"title":"List all item sync activity","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /catalog/integration-sync/{item_id}/activity","href":"/admin/api-reference/catalog/list-all-item-sync-activity"},{"title":"List catalog jobs","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /catalog/jobs","href":"/admin/api-reference/catalog/list-catalog-jobs"},{"title":"Create catalog job","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /catalog/jobs","href":"/admin/api-reference/catalog/create-catalog-job"},{"title":"Get catalog job","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /catalog/jobs/{job_id}","href":"/admin/api-reference/catalog/get-catalog-job"},{"title":"List all marketplace listings","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /catalog/marketplace-listings","href":"/admin/api-reference/catalog/list-all-marketplace-listings"},{"title":"Create or update marketplace listing","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /catalog/marketplace-listings","href":"/admin/api-reference/catalog/create-or-update-marketplace-listing"},{"title":"List products on marketplace","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /catalog/marketplace-listings/{marketplace_id}/list","href":"/admin/api-reference/catalog/list-products-on-marketplace"},{"title":"Remove marketplace listing","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /catalog/marketplace-listings/{marketplace_id}/remove","href":"/admin/api-reference/catalog/remove-marketplace-listing"},{"title":"Sync product on marketplace","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /catalog/marketplace-listings/{marketplace_id}/sync","href":"/admin/api-reference/catalog/sync-product-on-marketplace"},{"title":"Unlist products on marketplace","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /catalog/marketplace-listings/{marketplace_id}/unlist","href":"/admin/api-reference/catalog/unlist-products-on-marketplace"},{"title":"List all products","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /catalog/products","href":"/admin/api-reference/catalog/list-all-products"},{"title":"Create product","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /catalog/products","href":"/admin/api-reference/catalog/create-product"},{"title":"List all products channels","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /catalog/products-channels","href":"/admin/api-reference/catalog/list-all-products-channels"},{"title":"Add products channels","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /catalog/products-channels","href":"/admin/api-reference/catalog/add-products-channels"},{"title":"Assign a category to products","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /catalog/products/assign-category","href":"/admin/api-reference/catalog/assign-a-category-to-products"},{"title":"Bulk delete products","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /catalog/products/bulk-delete","href":"/admin/api-reference/catalog/bulk-delete-products"},{"title":"Bulk update products","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /catalog/products/bulk-update","href":"/admin/api-reference/catalog/bulk-update-products"},{"title":"Check inventory","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /catalog/products/check-inventory","href":"/admin/api-reference/catalog/check-inventory"},{"title":"Stock in products or variants","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /catalog/products/stock-in","href":"/admin/api-reference/catalog/stock-in-products-or-variants"},{"title":"Stock out products or variants","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /catalog/products/stock-out","href":"/admin/api-reference/catalog/stock-out-products-or-variants"},{"title":"Retrieve product details","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /catalog/products/{id}","href":"/admin/api-reference/catalog/retrieve-product-details"},{"title":"Update product details","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json put /catalog/products/{id}","href":"/admin/api-reference/catalog/update-product-details"},{"title":"Delete product","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json delete /catalog/products/{id}","href":"/admin/api-reference/catalog/delete-product"},{"title":"Retrieve product inventory","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /catalog/products/{id}/inventory","href":"/admin/api-reference/catalog/retrieve-product-inventory"},{"title":"Update Product Inventory","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /catalog/products/{id}/inventory","href":"/admin/api-reference/catalog/update-product-inventory"},{"title":"List all inventory activities","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /catalog/products/{id}/inventory-activity","href":"/admin/api-reference/catalog/list-all-inventory-activities"},{"title":"Create inventory activity","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /catalog/products/{id}/inventory-activity","href":"/admin/api-reference/catalog/create-inventory-activity"},{"title":"List all shipper boxes","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /catalog/products/{id}/shipper-boxes","href":"/admin/api-reference/catalog/list-all-shipper-boxes"},{"title":"List all product variants","description":"List all product variants","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /catalog/products/{id}/variants","href":"/admin/api-reference/catalog/list-all-product-variants"},{"title":"Create variant","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /catalog/products/{id}/variants","href":"/admin/api-reference/catalog/create-variant"},{"title":"Update variants in bulk","description":"Update shipping and packaging details of multiple variants.","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json put /catalog/products/{id}/variants/bulk-update","href":"/admin/api-reference/catalog/update-variants-in-bulk"},{"title":"Update a variant","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json put /catalog/products/{id}/variants/{variant_id}","href":"/admin/api-reference/catalog/update-a-variant"},{"title":"Delete a variant","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json delete /catalog/products/{id}/variants/{variant_id}","href":"/admin/api-reference/catalog/delete-a-variant"},{"title":"List product reviews","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /catalog/products/{product_id}/reviews","href":"/admin/api-reference/catalog/list-product-reviews"},{"title":"Retrieve product review","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /catalog/products/{product_id}/reviews/{id}","href":"/admin/api-reference/catalog/retrieve-product-review"},{"title":"Update product review","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json put /catalog/products/{product_id}/reviews/{id}","href":"/admin/api-reference/catalog/update-product-review"},{"title":"Delete product review","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json delete /catalog/products/{product_id}/reviews/{id}","href":"/admin/api-reference/catalog/delete-product-review"},{"title":"List all SKUs","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /catalog/skus","href":"/admin/api-reference/catalog/list-all-skus"}]},{"group":"Filter Options","pages":[{"title":"List all catalog filter options","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /catalog/filter-options","href":"/admin/api-reference/filter-options/list-all-catalog-filter-options"},{"title":"List all customers filter options","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /customers/filter-options","href":"/admin/api-reference/filter-options/list-all-customers-filter-options"},{"title":"List all marketplace filter options","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /marketplace/filter-options","href":"/admin/api-reference/filter-options/list-all-marketplace-filter-options"},{"title":"List all media filter options","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /media/filter-options","href":"/admin/api-reference/filter-options/list-all-media-filter-options"},{"title":"List all offer filter options","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /offer/filter-options","href":"/admin/api-reference/filter-options/list-all-offer-filter-options"},{"title":"List all orders filter options","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /orders/filter-options","href":"/admin/api-reference/filter-options/list-all-orders-filter-options"},{"title":"List all pos filter options","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /pos/filter-options","href":"/admin/api-reference/filter-options/list-all-pos-filter-options"},{"title":"List all shipping filter options","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /shipping/filter-options","href":"/admin/api-reference/filter-options/list-all-shipping-filter-options"},{"title":"List all store filter options","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /store/filter-options","href":"/admin/api-reference/filter-options/list-all-store-filter-options"},{"title":"List all webhooks filter options","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /webhooks/filter-options","href":"/admin/api-reference/filter-options/list-all-webhooks-filter-options"}]},{"group":"Inventories","pages":[{"title":"List all inventories","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /catalog/inventories","href":"/admin/api-reference/inventories/list-all-inventories"},{"title":"List all inventories activities","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /catalog/inventories/activites","href":"/admin/api-reference/inventories/list-all-inventories-activities"},{"title":"Retrieve inventory detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /catalog/inventories/detail","href":"/admin/api-reference/inventories/retrieve-inventory-detail"}]},{"group":"Marketplace Catalog","pages":[{"title":"List all products","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /catalog/marketplace/products","href":"/admin/api-reference/marketplace-catalog/list-all-products"},{"title":"List all products channels","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /catalog/marketplace/products-channels","href":"/admin/api-reference/marketplace-catalog/list-all-products-channels"},{"title":"Add products channels","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /catalog/marketplace/products-channels","href":"/admin/api-reference/marketplace-catalog/add-products-channels"},{"title":"Check inventory","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /catalog/marketplace/products/check-inventory","href":"/admin/api-reference/marketplace-catalog/check-inventory"},{"title":"Publish products","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /catalog/marketplace/products/publish","href":"/admin/api-reference/marketplace-catalog/publish-products"},{"title":"Stock in products or variants","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /catalog/marketplace/products/stock-in","href":"/admin/api-reference/marketplace-catalog/stock-in-products-or-variants"},{"title":"Stock out products or variants","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /catalog/marketplace/products/stock-out","href":"/admin/api-reference/marketplace-catalog/stock-out-products-or-variants"},{"title":"Unpublish products","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /catalog/marketplace/products/unpublish","href":"/admin/api-reference/marketplace-catalog/unpublish-products"},{"title":"Retrieve product details","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /catalog/marketplace/products/{id}","href":"/admin/api-reference/marketplace-catalog/retrieve-product-details"},{"title":"Retrieve product inventory","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /catalog/marketplace/products/{id}/inventory","href":"/admin/api-reference/marketplace-catalog/retrieve-product-inventory"},{"title":"Update Product Inventory","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /catalog/marketplace/products/{id}/inventory","href":"/admin/api-reference/marketplace-catalog/update-product-inventory"},{"title":"List all inventory activities","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /catalog/marketplace/products/{id}/inventory-activity","href":"/admin/api-reference/marketplace-catalog/list-all-inventory-activities"},{"title":"Create inventory activity","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /catalog/marketplace/products/{id}/inventory-activity","href":"/admin/api-reference/marketplace-catalog/create-inventory-activity"},{"title":"List all product variants","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /catalog/marketplace/products/{id}/variants","href":"/admin/api-reference/marketplace-catalog/list-all-product-variants"},{"title":"List product reviews","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /catalog/marketplace/products/{product_id}/reviews","href":"/admin/api-reference/marketplace-catalog/list-product-reviews"},{"title":"Retrieve product review","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /catalog/marketplace/products/{product_id}/reviews/{id}","href":"/admin/api-reference/marketplace-catalog/retrieve-product-review"},{"title":"Update product review","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json put /catalog/marketplace/products/{product_id}/reviews/{id}","href":"/admin/api-reference/marketplace-catalog/update-product-review"},{"title":"Retrieve a variant details","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /catalog/products/{id}/variants/{variant_id}","href":"/admin/api-reference/marketplace-catalog/retrieve-a-variant-details"}]},{"group":"Metrics","pages":[{"title":"Retrieve product analytics stats","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /catalog/metrics/product-analytics","href":"/admin/api-reference/metrics/retrieve-product-analytics-stats"},{"title":"Retrieve customers stats","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /customers/metrics/stats","href":"/admin/api-reference/metrics/retrieve-customers-stats"},{"title":"Retrieve coupons stats","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /offer/coupons/metrics/stats","href":"/admin/api-reference/metrics/retrieve-coupons-stats"},{"title":"Retrieve orders stats","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /orders/metrics/stats","href":"/admin/api-reference/metrics/retrieve-orders-stats"},{"title":"List all top selling products","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /orders/metrics/top-selling-products","href":"/admin/api-reference/metrics/list-all-top-selling-products"},{"title":"Retrieve payments stats","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /orders/payments/metrics/stats","href":"/admin/api-reference/metrics/retrieve-payments-stats"},{"title":"Retrieve seller payout stats","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /orders/payouts/metrics/stats","href":"/admin/api-reference/metrics/retrieve-seller-payout-stats"},{"title":"Retrieve shipments stats","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /shipping/metrics/stats","href":"/admin/api-reference/metrics/retrieve-shipments-stats"},{"title":"Retrieve webhook stats","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /webhooks/metrics/stats","href":"/admin/api-reference/metrics/retrieve-webhook-stats"}]},{"group":"Customers","pages":[{"title":"List all customers","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /customers","href":"/admin/api-reference/customers/list-all-customers"},{"title":"Create customer","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /customers","href":"/admin/api-reference/customers/create-customer"},{"title":"List all attributes","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /customers/attributes","href":"/admin/api-reference/customers/list-all-attributes"},{"title":"Create an attribute","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /customers/attributes","href":"/admin/api-reference/customers/create-an-attribute"},{"title":"Retrieve attribute detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /customers/attributes/{id}","href":"/admin/api-reference/customers/retrieve-attribute-detail"},{"title":"Update an attribute","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json put /customers/attributes/{id}","href":"/admin/api-reference/customers/update-an-attribute"},{"title":"Delete an attribute","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json delete /customers/attributes/{id}","href":"/admin/api-reference/customers/delete-an-attribute"},{"title":"Set credit line eligibility","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /customers/credit-line-eligibility","href":"/admin/api-reference/customers/set-credit-line-eligibility"},{"title":"List all loyalty members","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /customers/loyalty-members","href":"/admin/api-reference/customers/list-all-loyalty-members"},{"title":"Change loyalty tier","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /customers/loyalty-members/change-tier","href":"/admin/api-reference/customers/change-loyalty-tier"},{"title":"List all loyalty program","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /customers/loyalty-program","href":"/admin/api-reference/customers/list-all-loyalty-program"},{"title":"Create loyalty program","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /customers/loyalty-program","href":"/admin/api-reference/customers/create-loyalty-program"},{"title":"Retrieve loyalty program detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /customers/loyalty-program/{id}","href":"/admin/api-reference/customers/retrieve-loyalty-program-detail"},{"title":"Update loyalty program detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json put /customers/loyalty-program/{id}","href":"/admin/api-reference/customers/update-loyalty-program-detail"},{"title":"Delete loyalty program","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json delete /customers/loyalty-program/{id}","href":"/admin/api-reference/customers/delete-loyalty-program"},{"title":"Activate loyalty program","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json put /customers/loyalty-program/{id}/activate","href":"/admin/api-reference/customers/activate-loyalty-program"},{"title":"Deactivate loyalty program","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json put /customers/loyalty-program/{id}/deactivate","href":"/admin/api-reference/customers/deactivate-loyalty-program"},{"title":"Pause loyalty program","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json put /customers/loyalty-program/{id}/pause","href":"/admin/api-reference/customers/pause-loyalty-program"},{"title":"Resume loyalty program","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json put /customers/loyalty-program/{id}/resume","href":"/admin/api-reference/customers/resume-loyalty-program"},{"title":"List all visitors","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /customers/visitors","href":"/admin/api-reference/customers/list-all-visitors"},{"title":"Retrieve visitor detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /customers/visitors/{id}","href":"/admin/api-reference/customers/retrieve-visitor-detail"},{"title":"List all activities","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /customers/visitors/{id}/activities","href":"/admin/api-reference/customers/list-all-activities"},{"title":"List all visitor attributes","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /customers/visitors/{id}/attributes","href":"/admin/api-reference/customers/list-all-visitor-attributes"},{"title":"Create an attribute","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /customers/visitors/{id}/attributes","href":"/admin/api-reference/customers/create-an-attribute-1"},{"title":"Update visitor attribute","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json put /customers/visitors/{id}/attributes/{attribute_id}","href":"/admin/api-reference/customers/update-visitor-attribute"},{"title":"Delete visitor attribute","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json delete /customers/visitors/{id}/attributes/{attribute_id}","href":"/admin/api-reference/customers/delete-visitor-attribute"},{"title":"Get customer credit balance","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /customers/{customer_id}/credit-balance","href":"/admin/api-reference/customers/get-customer-credit-balance"},{"title":"Get credit line balance","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /customers/{customer_id}/credit-line-balance","href":"/admin/api-reference/customers/get-credit-line-balance"},{"title":"List mandate debit schedules","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /customers/{customer_id}/mandate-debit-schedules","href":"/admin/api-reference/customers/list-mandate-debit-schedules"},{"title":"List all mandates","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /customers/{customer_id}/mandates","href":"/admin/api-reference/customers/list-all-mandates"},{"title":"Get mandate","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /customers/{customer_id}/mandates/{mandate_id}","href":"/admin/api-reference/customers/get-mandate"},{"title":"List mandate activity","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /customers/{customer_id}/mandates/{mandate_id}/activity","href":"/admin/api-reference/customers/list-mandate-activity"},{"title":"List mandate logs","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /customers/{customer_id}/mandates/{mandate_id}/logs","href":"/admin/api-reference/customers/list-mandate-logs"},{"title":"Pause mandate","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /customers/{customer_id}/mandates/{mandate_id}/pause","href":"/admin/api-reference/customers/pause-mandate"},{"title":"Resume mandate","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /customers/{customer_id}/mandates/{mandate_id}/resume","href":"/admin/api-reference/customers/resume-mandate"},{"title":"Revoke mandate","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /customers/{customer_id}/mandates/{mandate_id}/revoke","href":"/admin/api-reference/customers/revoke-mandate"},{"title":"Retrieve customer detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /customers/{id}","href":"/admin/api-reference/customers/retrieve-customer-detail"},{"title":"Update customer","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json put /customers/{id}","href":"/admin/api-reference/customers/update-customer"},{"title":"List all activities","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /customers/{id}/activities","href":"/admin/api-reference/customers/list-all-activities-1"},{"title":"List all addresses","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /customers/{id}/addresses","href":"/admin/api-reference/customers/list-all-addresses"},{"title":"Create address","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /customers/{id}/addresses","href":"/admin/api-reference/customers/create-address"},{"title":"Update address detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json put /customers/{id}/addresses/{address_id}","href":"/admin/api-reference/customers/update-address-detail"},{"title":"Delete address","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json delete /customers/{id}/addresses/{address_id}","href":"/admin/api-reference/customers/delete-address"},{"title":"List all customer attributes","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /customers/{id}/attributes","href":"/admin/api-reference/customers/list-all-customer-attributes"},{"title":"Create an attribute","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /customers/{id}/attributes","href":"/admin/api-reference/customers/create-an-attribute-2"},{"title":"Update customer attribute","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json put /customers/{id}/attributes/{attribute_id}","href":"/admin/api-reference/customers/update-customer-attribute"},{"title":"Delete customer attribute","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json delete /customers/{id}/attributes/{attribute_id}","href":"/admin/api-reference/customers/delete-customer-attribute"},{"title":"Get authorized sellers for customer","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /customers/{id}/authorized-sellers","href":"/admin/api-reference/customers/get-authorized-sellers-for-customer"},{"title":"Authorize a seller for a customer","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /customers/{id}/authorized-sellers/{seller_id}/authorize","href":"/admin/api-reference/customers/authorize-a-seller-for-a-customer"},{"title":"Unauthorize a seller for a customer","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /customers/{id}/authorized-sellers/{seller_id}/unauthorize","href":"/admin/api-reference/customers/unauthorize-a-seller-for-a-customer"},{"title":"List all bank accounts","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /customers/{id}/bank-accounts","href":"/admin/api-reference/customers/list-all-bank-accounts"},{"title":"Create a bank account","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /customers/{id}/bank-accounts","href":"/admin/api-reference/customers/create-a-bank-account"},{"title":"Retrieve bank account detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /customers/{id}/bank-accounts/{bank_account_id}","href":"/admin/api-reference/customers/retrieve-bank-account-detail"},{"title":"Update a bank account","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json put /customers/{id}/bank-accounts/{bank_account_id}","href":"/admin/api-reference/customers/update-a-bank-account"},{"title":"Delete bank account","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json delete /customers/{id}/bank-accounts/{bank_account_id}","href":"/admin/api-reference/customers/delete-bank-account"},{"title":"List all documents","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /customers/{id}/documents","href":"/admin/api-reference/customers/list-all-documents"},{"title":"Create document","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /customers/{id}/documents","href":"/admin/api-reference/customers/create-document"},{"title":"Retrieve document detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /customers/{id}/documents/{document_id}","href":"/admin/api-reference/customers/retrieve-document-detail"},{"title":"Update document detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json put /customers/{id}/documents/{document_id}","href":"/admin/api-reference/customers/update-document-detail"},{"title":"Delete document","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json delete /customers/{id}/documents/{document_id}","href":"/admin/api-reference/customers/delete-document"},{"title":"List all loyalty point activities","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /customers/{id}/loyalty-point-activities","href":"/admin/api-reference/customers/list-all-loyalty-point-activities"},{"title":"Create loyalty point activity","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /customers/{id}/loyalty-point-activities","href":"/admin/api-reference/customers/create-loyalty-point-activity"},{"title":"List all loyalty tier activities","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /customers/{id}/loyalty-tier-activities","href":"/admin/api-reference/customers/list-all-loyalty-tier-activities"},{"title":"Retrieve notification preferences","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /customers/{id}/notification-preferences","href":"/admin/api-reference/customers/retrieve-notification-preferences"},{"title":"Update notification preferences","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json put /customers/{id}/notification-preferences","href":"/admin/api-reference/customers/update-notification-preferences"},{"title":"List customer users","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /customers/{id}/users","href":"/admin/api-reference/customers/list-customer-users"},{"title":"Activate a customer user","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json put /customers/{id}/users/{user_id}/activate","href":"/admin/api-reference/customers/activate-a-customer-user"},{"title":"Deactivate a customer user","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json put /customers/{id}/users/{user_id}/deactivate","href":"/admin/api-reference/customers/deactivate-a-customer-user"}]},{"group":"Segments","pages":[{"title":"List all segments","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /customers/segments","href":"/admin/api-reference/segments/list-all-segments"},{"title":"Create a segment","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /customers/segments","href":"/admin/api-reference/segments/create-a-segment"},{"title":"Retrieve segment detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /customers/segments/{id}","href":"/admin/api-reference/segments/retrieve-segment-detail"},{"title":"Update segment detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /customers/segments/{id}","href":"/admin/api-reference/segments/update-segment-detail"},{"title":"Delete segment","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json delete /customers/segments/{id}","href":"/admin/api-reference/segments/delete-segment"},{"title":"Create ad-audience","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /customers/segments/{id}/ad-audiences","href":"/admin/api-reference/segments/create-ad-audience"},{"title":"Retrieve ad-audience detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /customers/segments/{id}/ad-audiences/{ad_audience_id}","href":"/admin/api-reference/segments/retrieve-ad-audience-detail"},{"title":"Update ad-audience detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json put /customers/segments/{id}/ad-audiences/{ad_audience_id}","href":"/admin/api-reference/segments/update-ad-audience-detail"},{"title":"Delete ad-audience","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json delete /customers/segments/{id}/ad-audiences/{ad_audience_id}","href":"/admin/api-reference/segments/delete-ad-audience"},{"title":"List all ad-audience sync hisory","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /customers/segments/{id}/ad-audiences/{ad_audience_id}/sync-history","href":"/admin/api-reference/segments/list-all-ad-audience-sync-hisory"},{"title":"List all segment members","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /customers/segments/{id}/members","href":"/admin/api-reference/segments/list-all-segment-members"},{"title":"Add segment members","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /customers/segments/{id}/members","href":"/admin/api-reference/segments/add-segment-members"},{"title":"Delete segment members","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json delete /customers/segments/{id}/members","href":"/admin/api-reference/segments/delete-segment-members"},{"title":"Retrieve members metrics","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /customers/segments/{id}/members-metrics","href":"/admin/api-reference/segments/retrieve-members-metrics"}]},{"group":"Marketplace","pages":[{"title":"Get marketplace category attributes","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /marketplace/{marketplace_id}/categories/attributes","href":"/admin/api-reference/marketplace/get-marketplace-category-attributes"},{"title":"Create or update marketplace category attributes","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /marketplace/{marketplace_id}/categories/attributes","href":"/admin/api-reference/marketplace/create-or-update-marketplace-category-attributes"},{"title":"Get marketplace categories schema","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /marketplace/{marketplace_id}/categories/{category_id}/schema","href":"/admin/api-reference/marketplace/get-marketplace-categories-schema"},{"title":"Create or update marketplace categories schema","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /marketplace/{marketplace_id}/categories/{category_id}/schema","href":"/admin/api-reference/marketplace/create-or-update-marketplace-categories-schema"},{"title":"Retrieve marketplace config","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /marketplace/{marketplace_id}/config","href":"/admin/api-reference/marketplace/retrieve-marketplace-config"}]},{"group":"Media Gallery","pages":[{"title":"List all files","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /media/files","href":"/admin/api-reference/media-gallery/list-all-files"},{"title":"Delete multiple files","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /media/files/bulk-delete","href":"/admin/api-reference/media-gallery/delete-multiple-files"},{"title":"Move multiple files","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /media/files/bulk-move","href":"/admin/api-reference/media-gallery/move-multiple-files"},{"title":"Update upload complete status","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /media/files/upload-complete","href":"/admin/api-reference/media-gallery/update-upload-complete-status"},{"title":"Create upload request","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /media/files/upload-request","href":"/admin/api-reference/media-gallery/create-upload-request"},{"title":"Retrieve file detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /media/files/{id}","href":"/admin/api-reference/media-gallery/retrieve-file-detail"},{"title":"Update file detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json put /media/files/{id}","href":"/admin/api-reference/media-gallery/update-file-detail"},{"title":"Delete file","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json delete /media/files/{id}","href":"/admin/api-reference/media-gallery/delete-file"},{"title":"List all folders","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /media/folders","href":"/admin/api-reference/media-gallery/list-all-folders"},{"title":"Create a folder","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /media/folders","href":"/admin/api-reference/media-gallery/create-a-folder"},{"title":"Retrieve folder detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /media/folders/{id}","href":"/admin/api-reference/media-gallery/retrieve-folder-detail"},{"title":"Update folder detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json put /media/folders/{id}","href":"/admin/api-reference/media-gallery/update-folder-detail"},{"title":"Delete folder","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json delete /media/folders/{id}","href":"/admin/api-reference/media-gallery/delete-folder"}]},{"group":"Coupons \u0026 promotions","pages":[{"title":"List all coupons","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /offer/coupons","href":"/admin/api-reference/coupons-\u0026-promotions/list-all-coupons"},{"title":"Create coupon","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /offer/coupons","href":"/admin/api-reference/coupons-\u0026-promotions/create-coupon"},{"title":"Retrieve a coupon","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /offer/coupons/{id}","href":"/admin/api-reference/coupons-\u0026-promotions/retrieve-a-coupon"},{"title":"Update coupon","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json put /offer/coupons/{id}","href":"/admin/api-reference/coupons-\u0026-promotions/update-coupon"},{"title":"Delete a coupon","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json delete /offer/coupons/{id}","href":"/admin/api-reference/coupons-\u0026-promotions/delete-a-coupon"},{"title":"List all coupon codes","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /offer/coupons/{id}/codes","href":"/admin/api-reference/coupons-\u0026-promotions/list-all-coupon-codes"},{"title":"Add coupon code","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /offer/coupons/{id}/codes","href":"/admin/api-reference/coupons-\u0026-promotions/add-coupon-code"},{"title":"Delete coupon codes","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /offer/coupons/{id}/delete-codes","href":"/admin/api-reference/coupons-\u0026-promotions/delete-coupon-codes"},{"title":"List all coupon customers","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /offer/coupons/{id}/usage/customers","href":"/admin/api-reference/coupons-\u0026-promotions/list-all-coupon-customers"},{"title":"List all coupon orders","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /offer/coupons/{id}/usage/orders","href":"/admin/api-reference/coupons-\u0026-promotions/list-all-coupon-orders"},{"title":"List promotions","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /offer/promotions","href":"/admin/api-reference/coupons-\u0026-promotions/list-promotions"},{"title":"Create promotion","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /offer/promotions","href":"/admin/api-reference/coupons-\u0026-promotions/create-promotion"},{"title":"Retrieve a promotion","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /offer/promotions/{id}","href":"/admin/api-reference/coupons-\u0026-promotions/retrieve-a-promotion"},{"title":"Update promotion","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json put /offer/promotions/{id}","href":"/admin/api-reference/coupons-\u0026-promotions/update-promotion"},{"title":"Delete Promotion","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json delete /offer/promotions/{id}","href":"/admin/api-reference/coupons-\u0026-promotions/delete-promotion"},{"title":"List customers who used a promotion","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /offer/promotions/{id}/usage/customers","href":"/admin/api-reference/coupons-\u0026-promotions/list-customers-who-used-a-promotion"}]},{"group":"Orders","pages":[{"title":"List all orders","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /orders","href":"/admin/api-reference/orders/list-all-orders"},{"title":"List all abandoned carts","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /orders/abandoned-carts","href":"/admin/api-reference/orders/list-all-abandoned-carts"},{"title":"List all invoices","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /orders/invoices","href":"/admin/api-reference/orders/list-all-invoices"},{"title":"List all products purchase count","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /orders/products-purchase-count","href":"/admin/api-reference/orders/list-all-products-purchase-count"},{"title":"Estimate refund for a shipment or order","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /orders/refund-estimates","href":"/admin/api-reference/orders/estimate-refund-for-a-shipment-or-order"},{"title":"List return requests","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /orders/returns","href":"/admin/api-reference/orders/list-return-requests"},{"title":"Retrieve a return request","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /orders/returns/{return_number}","href":"/admin/api-reference/orders/retrieve-a-return-request"},{"title":"Approve a return request","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /orders/returns/{return_number}/approve","href":"/admin/api-reference/orders/approve-a-return-request"},{"title":"Reject a return request","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /orders/returns/{return_number}/reject","href":"/admin/api-reference/orders/reject-a-return-request"},{"title":"List all subscriptions","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /orders/subscriptions","href":"/admin/api-reference/orders/list-all-subscriptions"},{"title":"Retrieve a subscription details","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /orders/subscriptions/{subscription_number}","href":"/admin/api-reference/orders/retrieve-a-subscription-details"},{"title":"List all subscription customers","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /orders/subscriptions/{subscription_number}/customers","href":"/admin/api-reference/orders/list-all-subscription-customers"},{"title":"Retrieve order details","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /orders/{order_number}","href":"/admin/api-reference/orders/retrieve-order-details"},{"title":"Update order details","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json put /orders/{order_number}","href":"/admin/api-reference/orders/update-order-details"},{"title":"Accept order","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /orders/{order_number}/accept","href":"/admin/api-reference/orders/accept-order"},{"title":"List all order activity","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /orders/{order_number}/activity","href":"/admin/api-reference/orders/list-all-order-activity"},{"title":"Create order activity","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /orders/{order_number}/activity","href":"/admin/api-reference/orders/create-order-activity"},{"title":"Cancel an order","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /orders/{order_number}/cancel","href":"/admin/api-reference/orders/cancel-an-order"},{"title":"Check inventory","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /orders/{order_number}/check-inventory","href":"/admin/api-reference/orders/check-inventory"},{"title":"Retrieve order invoice","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /orders/{order_number}/invoice","href":"/admin/api-reference/orders/retrieve-order-invoice"},{"title":"Retrieve order receipt","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /orders/{order_number}/receipt","href":"/admin/api-reference/orders/retrieve-order-receipt"},{"title":"Retrieve order shipments","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /orders/{order_number}/shipments","href":"/admin/api-reference/orders/retrieve-order-shipments"},{"title":"Verify order payment","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /orders/{order_number}/verify-payment","href":"/admin/api-reference/orders/verify-order-payment"}]},{"group":"Payments","pages":[{"title":"List all payments","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /orders/payments","href":"/admin/api-reference/payments/list-all-payments"},{"title":"Create Payment","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /orders/payments","href":"/admin/api-reference/payments/create-payment"},{"title":"List payment exceptions","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /orders/payments/payment-exceptions","href":"/admin/api-reference/payments/list-payment-exceptions"},{"title":"Retrieve a payment exception","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /orders/payments/payment-exceptions/{ulid}","href":"/admin/api-reference/payments/retrieve-a-payment-exception"},{"title":"Resolve a payment exception","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /orders/payments/payment-exceptions/{ulid}/resolve","href":"/admin/api-reference/payments/resolve-a-payment-exception"},{"title":"Refund payment","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /orders/payments/refund","href":"/admin/api-reference/payments/refund-payment"},{"title":"Retrieve payment details","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /orders/payments/{request_number}","href":"/admin/api-reference/payments/retrieve-payment-details"},{"title":"Cancel Payment","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /orders/payments/{request_number}/cancel","href":"/admin/api-reference/payments/cancel-payment"}]},{"group":"Payouts","pages":[{"title":"List seller payout config","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /orders/payouts/config","href":"/admin/api-reference/payouts/list-seller-payout-config"},{"title":"Create or update seller payout config","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /orders/payouts/config","href":"/admin/api-reference/payouts/create-or-update-seller-payout-config"},{"title":"Retrieve seller payout config","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /orders/payouts/config/{ulid}","href":"/admin/api-reference/payouts/retrieve-seller-payout-config"},{"title":"List seller payout invoices","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /orders/payouts/invoices","href":"/admin/api-reference/payouts/list-seller-payout-invoices"},{"title":"Create seller payout adjustment","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /orders/payouts/invoices/adjustments","href":"/admin/api-reference/payouts/create-seller-payout-adjustment"},{"title":"List seller payout batches","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /orders/payouts/invoices/batches","href":"/admin/api-reference/payouts/list-seller-payout-batches"},{"title":"Create seller payout batch","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /orders/payouts/invoices/batches","href":"/admin/api-reference/payouts/create-seller-payout-batch"},{"title":"List seller payout batch activities","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /orders/payouts/invoices/batches/activities","href":"/admin/api-reference/payouts/list-seller-payout-batch-activities"},{"title":"Retrieve a seller payout batch","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /orders/payouts/invoices/batches/{id}","href":"/admin/api-reference/payouts/retrieve-a-seller-payout-batch"},{"title":"Update a seller payout batch","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json put /orders/payouts/invoices/batches/{id}","href":"/admin/api-reference/payouts/update-a-seller-payout-batch"},{"title":"Pay a seller payout batch early","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /orders/payouts/invoices/batches/{id}/auto-pay","href":"/admin/api-reference/payouts/pay-a-seller-payout-batch-early"},{"title":"Cancel a seller payout batch","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /orders/payouts/invoices/batches/{id}/cancel","href":"/admin/api-reference/payouts/cancel-a-seller-payout-batch"},{"title":"Hold a seller payout batch","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /orders/payouts/invoices/batches/{id}/hold","href":"/admin/api-reference/payouts/hold-a-seller-payout-batch"},{"title":"Record a manual payment for a payout batch","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json put /orders/payouts/invoices/batches/{id}/manual-payment","href":"/admin/api-reference/payouts/record-a-manual-payment-for-a-payout-batch"},{"title":"Unhold a seller payout batch","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /orders/payouts/invoices/batches/{id}/unhold","href":"/admin/api-reference/payouts/unhold-a-seller-payout-batch"},{"title":"Create seller payout charge","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /orders/payouts/invoices/charges","href":"/admin/api-reference/payouts/create-seller-payout-charge"},{"title":"Hold seller payout invoices","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /orders/payouts/invoices/hold","href":"/admin/api-reference/payouts/hold-seller-payout-invoices"},{"title":"Unhold seller payout invoices","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /orders/payouts/invoices/unhold","href":"/admin/api-reference/payouts/unhold-seller-payout-invoices"}]},{"group":"POS","pages":[{"title":"List all POS devices","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /pos/devices","href":"/admin/api-reference/pos/list-all-pos-devices"},{"title":"Create POS device","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /pos/devices","href":"/admin/api-reference/pos/create-pos-device"},{"title":"Retrieve POS device detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /pos/devices/{id}","href":"/admin/api-reference/pos/retrieve-pos-device-detail"},{"title":"Update POS device","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json put /pos/devices/{id}","href":"/admin/api-reference/pos/update-pos-device"},{"title":"Delete POS device","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json delete /pos/devices/{id}","href":"/admin/api-reference/pos/delete-pos-device"},{"title":"Generate POS device Pairing Code","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /pos/devices/{id}/pairing-code","href":"/admin/api-reference/pos/generate-pos-device-pairing-code"},{"title":"Revoke POS device","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /pos/devices/{id}/revoke","href":"/admin/api-reference/pos/revoke-pos-device"},{"title":"List all POS permissions","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /pos/permissions","href":"/admin/api-reference/pos/list-all-pos-permissions"},{"title":"List all POS roles","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /pos/roles","href":"/admin/api-reference/pos/list-all-pos-roles"},{"title":"Create POS role","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /pos/roles","href":"/admin/api-reference/pos/create-pos-role"},{"title":"Retrieve POS role","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /pos/roles/{id}","href":"/admin/api-reference/pos/retrieve-pos-role"},{"title":"Update POS role","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json put /pos/roles/{id}","href":"/admin/api-reference/pos/update-pos-role"},{"title":"Delete POS role","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json delete /pos/roles/{id}","href":"/admin/api-reference/pos/delete-pos-role"},{"title":"List all POS users","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /pos/users","href":"/admin/api-reference/pos/list-all-pos-users"},{"title":"Create POS user","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /pos/users","href":"/admin/api-reference/pos/create-pos-user"},{"title":"Retrieve POS user","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /pos/users/{id}","href":"/admin/api-reference/pos/retrieve-pos-user"},{"title":"Update POS user","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json put /pos/users/{id}","href":"/admin/api-reference/pos/update-pos-user"},{"title":"Delete POS user","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json delete /pos/users/{id}","href":"/admin/api-reference/pos/delete-pos-user"}]},{"group":"Shipping","pages":[{"title":"Courier Serviceability","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /shipping/serviceability","href":"/admin/api-reference/shipping/courier-serviceability"},{"title":"List all shipments","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /shipping/shipments","href":"/admin/api-reference/shipping/list-all-shipments"},{"title":"Create shipment","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /shipping/shipments","href":"/admin/api-reference/shipping/create-shipment"},{"title":"Update shipments in bulk","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /shipping/shipments/bulk-update","href":"/admin/api-reference/shipping/update-shipments-in-bulk"},{"title":"Merge shipments","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /shipping/shipments/{order_number}/merge","href":"/admin/api-reference/shipping/merge-shipments"},{"title":"Pack items","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /shipping/shipments/{order_number}/pack-items","href":"/admin/api-reference/shipping/pack-items"},{"title":"Refund shortfall","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /shipping/shipments/{order_number}/refund-shortfall","href":"/admin/api-reference/shipping/refund-shortfall"},{"title":"Wait for inventory","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /shipping/shipments/{order_number}/wait-for-inventory","href":"/admin/api-reference/shipping/wait-for-inventory"},{"title":"Retrieve shipment detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /shipping/shipments/{reference_number}","href":"/admin/api-reference/shipping/retrieve-shipment-detail"},{"title":"Retrieve shipment activities","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /shipping/shipments/{reference_number}/activities","href":"/admin/api-reference/shipping/retrieve-shipment-activities"},{"title":"Approve shipment","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /shipping/shipments/{reference_number}/approve","href":"/admin/api-reference/shipping/approve-shipment"},{"title":"Cancel shipment","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /shipping/shipments/{reference_number}/cancel","href":"/admin/api-reference/shipping/cancel-shipment"},{"title":"Download invoice","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /shipping/shipments/{reference_number}/download-invoice","href":"/admin/api-reference/shipping/download-invoice"},{"title":"Download shipping label","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /shipping/shipments/{reference_number}/download-shipping-label","href":"/admin/api-reference/shipping/download-shipping-label"},{"title":"Retrieve shipment invoice","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /shipping/shipments/{reference_number}/invoice","href":"/admin/api-reference/shipping/retrieve-shipment-invoice"},{"title":"Update shipment detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json put /shipping/shipments/{reference_number}/manual-update","href":"/admin/api-reference/shipping/update-shipment-detail"},{"title":"Retrieve packing detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /shipping/shipments/{reference_number}/packing-detail","href":"/admin/api-reference/shipping/retrieve-packing-detail"},{"title":"Reject shipment","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /shipping/shipments/{reference_number}/reject","href":"/admin/api-reference/shipping/reject-shipment"},{"title":"Create a replacement shipment","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /shipping/shipments/{reference_number}/replacement","href":"/admin/api-reference/shipping/create-a-replacement-shipment"},{"title":"Tracking Shipment","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /shipping/shipments/{reference_number}/tracking","href":"/admin/api-reference/shipping/tracking-shipment"}]},{"group":"Store","pages":[{"title":"List available payment options","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /store/available-payment-options","href":"/admin/api-reference/store/list-available-payment-options"},{"title":"List all available shipping options","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /store/available-shipping-options","href":"/admin/api-reference/store/list-all-available-shipping-options"},{"title":"Retrieve store config","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /store/config","href":"/admin/api-reference/store/retrieve-store-config"},{"title":"Update store config","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /store/config","href":"/admin/api-reference/store/update-store-config"},{"title":"List all countries","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /store/countries","href":"/admin/api-reference/store/list-all-countries"},{"title":"List all pincodes","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /store/countries/{country_iso_code}/pincodes","href":"/admin/api-reference/store/list-all-pincodes"},{"title":"List all states","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /store/countries/{country_iso_code}/states","href":"/admin/api-reference/store/list-all-states"},{"title":"List all customer groups","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /store/customer-group","href":"/admin/api-reference/store/list-all-customer-groups"},{"title":"Create customer group","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /store/customer-group","href":"/admin/api-reference/store/create-customer-group"},{"title":"Update customer group","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json put /store/customer-group/{id}","href":"/admin/api-reference/store/update-customer-group"},{"title":"Delete customer group","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json delete /store/customer-group/{id}","href":"/admin/api-reference/store/delete-customer-group"},{"title":"List all download jobs","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /store/downloads","href":"/admin/api-reference/store/list-all-download-jobs"},{"title":"Create download request","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /store/downloads","href":"/admin/api-reference/store/create-download-request"},{"title":"List all kyc documents","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /store/kyc-document","href":"/admin/api-reference/store/list-all-kyc-documents"},{"title":"Create kyc document","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /store/kyc-document","href":"/admin/api-reference/store/create-kyc-document"},{"title":"Update kyc document","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json put /store/kyc-document/{id}","href":"/admin/api-reference/store/update-kyc-document"},{"title":"Delete kyc document","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json delete /store/kyc-document/{id}","href":"/admin/api-reference/store/delete-kyc-document"},{"title":"List all manual payment methods","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /store/manual-payment-methods","href":"/admin/api-reference/store/list-all-manual-payment-methods"},{"title":"Create manual payment method","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /store/manual-payment-methods","href":"/admin/api-reference/store/create-manual-payment-method"},{"title":"Retrieve manual payment method detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /store/manual-payment-methods/{id}","href":"/admin/api-reference/store/retrieve-manual-payment-method-detail"},{"title":"Update manual payment method detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json put /store/manual-payment-methods/{id}","href":"/admin/api-reference/store/update-manual-payment-method-detail"},{"title":"Delete manual payment method","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json delete /store/manual-payment-methods/{id}","href":"/admin/api-reference/store/delete-manual-payment-method"},{"title":"List all manual shipping methods","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /store/manual-shipping-methods","href":"/admin/api-reference/store/list-all-manual-shipping-methods"},{"title":"Create manual shipping method","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /store/manual-shipping-methods","href":"/admin/api-reference/store/create-manual-shipping-method"},{"title":"Retrieve manual shipping method detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /store/manual-shipping-methods/{id}","href":"/admin/api-reference/store/retrieve-manual-shipping-method-detail"},{"title":"Update manual shipping method detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json put /store/manual-shipping-methods/{id}","href":"/admin/api-reference/store/update-manual-shipping-method-detail"},{"title":"Delete manual shipping method","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json delete /store/manual-shipping-methods/{id}","href":"/admin/api-reference/store/delete-manual-shipping-method"},{"title":"Global search across Customers, Orders, and Products","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /store/search","href":"/admin/api-reference/store/global-search-across-customers-orders-and-products"},{"title":"List all service providers","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /store/service-providers","href":"/admin/api-reference/store/list-all-service-providers"},{"title":"Configure a service provider","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /store/service-providers","href":"/admin/api-reference/store/configure-a-service-provider"},{"title":"Update service provider config","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json put /store/service-providers/{id}","href":"/admin/api-reference/store/update-service-provider-config"},{"title":"Delete service provider config","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json delete /store/service-providers/{id}","href":"/admin/api-reference/store/delete-service-provider-config"},{"title":"Test service provider config","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /store/service-providers/{id}/test-connection","href":"/admin/api-reference/store/test-service-provider-config"},{"title":"List all shipping boxes","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /store/shipping-boxes","href":"/admin/api-reference/store/list-all-shipping-boxes"},{"title":"Create shipping box","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /store/shipping-boxes","href":"/admin/api-reference/store/create-shipping-box"},{"title":"Retrieve shipping box detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /store/shipping-boxes/{id}","href":"/admin/api-reference/store/retrieve-shipping-box-detail"},{"title":"Update shipping box detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json put /store/shipping-boxes/{id}","href":"/admin/api-reference/store/update-shipping-box-detail"},{"title":"Delete shipping box","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json delete /store/shipping-boxes/{id}","href":"/admin/api-reference/store/delete-shipping-box"},{"title":"Retrieve shipping cost policy","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /store/shipping-cost-policy","href":"/admin/api-reference/store/retrieve-shipping-cost-policy"},{"title":"Create shipping cost policy","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /store/shipping-cost-policy","href":"/admin/api-reference/store/create-shipping-cost-policy"},{"title":"Add shipping options","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /store/shipping-options/add","href":"/admin/api-reference/store/add-shipping-options"},{"title":"Remove shipping options","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /store/shipping-options/remove","href":"/admin/api-reference/store/remove-shipping-options"},{"title":"List all shipping zones","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /store/shipping-zones","href":"/admin/api-reference/store/list-all-shipping-zones"},{"title":"Create a shipping zone","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /store/shipping-zones","href":"/admin/api-reference/store/create-a-shipping-zone"},{"title":"Retrieve shipping zone detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /store/shipping-zones/{id}","href":"/admin/api-reference/store/retrieve-shipping-zone-detail"},{"title":"Update shipping zone detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json put /store/shipping-zones/{id}","href":"/admin/api-reference/store/update-shipping-zone-detail"},{"title":"Delete shipping zone","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json delete /store/shipping-zones/{id}","href":"/admin/api-reference/store/delete-shipping-zone"},{"title":"List all templates","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /store/templates","href":"/admin/api-reference/store/list-all-templates"},{"title":"Create template","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /store/templates","href":"/admin/api-reference/store/create-template"},{"title":"Retrieve template detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /store/templates/{id}","href":"/admin/api-reference/store/retrieve-template-detail"},{"title":"Update template detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json put /store/templates/{id}","href":"/admin/api-reference/store/update-template-detail"},{"title":"Delete template","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json delete /store/templates/{id}","href":"/admin/api-reference/store/delete-template"},{"title":"List all warehouses","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /store/warehouses","href":"/admin/api-reference/store/list-all-warehouses"},{"title":"Create a warehouse","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /store/warehouses","href":"/admin/api-reference/store/create-a-warehouse"},{"title":"Retrieve warehouse detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /store/warehouses/{id}","href":"/admin/api-reference/store/retrieve-warehouse-detail"},{"title":"Update warehouse detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json put /store/warehouses/{id}","href":"/admin/api-reference/store/update-warehouse-detail"},{"title":"Delete warehouse","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json delete /store/warehouses/{id}","href":"/admin/api-reference/store/delete-warehouse"}]},{"group":"SSE","pages":[{"title":"Retrieve global state","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /store/sse/global-state","href":"/admin/api-reference/sse/retrieve-global-state"},{"title":"Retrieve live events","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /store/sse/live-events","href":"/admin/api-reference/sse/retrieve-live-events"}]},{"group":"Webhooks","pages":[{"title":"List Webhooks","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /webhooks","href":"/admin/api-reference/webhooks/list-webhooks"},{"title":"Create Webhook","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /webhooks","href":"/admin/api-reference/webhooks/create-webhook"},{"title":"List All Deliveries Log","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /webhooks/deliveries","href":"/admin/api-reference/webhooks/list-all-deliveries-log"},{"title":"Get Delivery Log Detail","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /webhooks/deliveries/{delivery_id}","href":"/admin/api-reference/webhooks/get-delivery-log-detail"},{"title":"List all event types","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /webhooks/event-types","href":"/admin/api-reference/webhooks/list-all-event-types"},{"title":"List All Events","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /webhooks/events","href":"/admin/api-reference/webhooks/list-all-events"},{"title":"Get Event Details","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /webhooks/events/{event_id}","href":"/admin/api-reference/webhooks/get-event-details"},{"title":"Get Webhook Details","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /webhooks/{webhook_id}","href":"/admin/api-reference/webhooks/get-webhook-details"},{"title":"Update Webhook","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json put /webhooks/{webhook_id}","href":"/admin/api-reference/webhooks/update-webhook"},{"title":"Delete Webhook","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json delete /webhooks/{webhook_id}","href":"/admin/api-reference/webhooks/delete-webhook"},{"title":"Retry Webhook Delivery","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /webhooks/{webhook_id}/deliveries/{delivery_id}/retry","href":"/admin/api-reference/webhooks/retry-webhook-delivery"},{"title":"Replay Event to Webhook","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /webhooks/{webhook_id}/replay-event/{event_id}","href":"/admin/api-reference/webhooks/replay-event-to-webhook"},{"title":"Rotate Webhook Secret","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /webhooks/{webhook_id}/rotate-secret","href":"/admin/api-reference/webhooks/rotate-webhook-secret"},{"title":"Send Test Webhook","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /webhooks/{webhook_id}/test","href":"/admin/api-reference/webhooks/send-test-webhook"}]}]}]}]}]},"basePath":"","title":"Create variant - Commerce Engine Docs","buildId":"dpl_3pZeXn3XukjzFRgAX73A7GNDfRJ1","deploymentId":"dpl_3pZeXn3XukjzFRgAX73A7GNDfRJ1","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-CW3yP2DK.js","utils-BN0nty2W.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C8_MydSG.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bsl5xDMQ.js","snippetPresets-DYv9OBej.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-CBlOSKZG.js","ApiExamples-9OnYPrVf.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-xr67xWGO.js","shallow-DO1aDdBF.js","getApiPlaygroundDisplay-o7cLzFL-.js","CodeSnippet-CGr2yOA8.js","CodeSnippets-CzBbqPNh.js","getPastedJson-dpi9sn5Y.js","icon-aIWHt8Pn.js","MethodPill-Bv2zLsGY.js","DuplicateIcon-DxFSz0J6.js","createIcon-uDNv6jwj.js","DynamicMarkdown-C91yhnNP.js","SectionHeading-DG_xjOLR.js","axios-vUo_bRtp.js","Markdown-B4M_Eo1P.js","clsx-DShopWo_.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BX6wab7q.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-48h67xm_.js"]}