Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
id
string
required
promotion id
Body
application/json
name
string
required
status
enum<string>
required
On create this field is ignored and the status is derived from starts_at: when starts_at is omitted or null the status is draft; a future starts_at makes it scheduled; a starts_at at or before the current time makes it active. Required on update.
Available options:
draft,
scheduled,
active,
inactive
customer_eligibility
enum<string>
required
Available options:
all,
customer,
segment,
customer-group
starts_at
string<date-time>
required
promotion_type
enum<string>
required
Available options:
discount,
free-goods,
free-shipping,
buy-x-get-y,
volume-based
can_be_used_with_other_promotion
boolean
required
description
string
tags
string[] | null
customer_id
string[]
required if customer_eligibility = customer
segment_id
string[]
required if customer_eligibility = segment
customer_group_id
string[]
redemption_limits
object | null
Show child attributes
minimum_order_total
integer | null
default:0
Ignored when coupon_type or promotion_type is tiered-discount. Each slab in details defines its own order_value threshold.
for_first_time_customer_only
boolean
default:false
can_earn_loyalty_points
boolean
default:true
can_redeem_loyalty_points
boolean
default:true
expires_at
string<date-time> | null
priority
integer | null
Required range: 1 <= x <= 5
applies_to_product
enum<string>
seller scopes the promotion to specific marketplace sellers (details.sellers). It is valid only for promotion_type: discount and only on marketplace stores.
{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"Commerce Engine Docs","description":"Official documentation for Commerce Engine - The modern headless commerce platform for building scalable e-commerce solutions.","colors":{"primary":"#00BF6F","light":"#00BF6F","dark":"#029558"},"logo":{"light":"https://mintcdn.com/tarkai/hIY7_H2biaAvOGu7/logo/CE_Developers_black.svg?fit=max\u0026auto=format\u0026n=hIY7_H2biaAvOGu7\u0026q=85\u0026s=d93f21564dfd373c7f2efc88c9d4301e","dark":"https://mintcdn.com/tarkai/hIY7_H2biaAvOGu7/logo/CE_Developers_white.svg?fit=max\u0026auto=format\u0026n=hIY7_H2biaAvOGu7\u0026q=85\u0026s=def973fb06c07f5eae14319cc3303339","href":"/"},"favicon":"https://mintcdn.com/tarkai/QX_fwpRYnT2rH-8q/favicon.png?fit=max\u0026auto=format\u0026n=QX_fwpRYnT2rH-8q\u0026q=85\u0026s=ebc190f98abe52e0e4220c74cea20fa6","api":{"openapi":{"source":"https://openapi.commercengine.io/ce-storefront.json","directory":"api-reference"},"playground":{"display":"interactive","proxy":false}},"appearance":{"default":"system"},"background":{"decoration":"windows","color":{"light":"#ffffff","dark":"#0d1816"}},"navbar":{"primary":{"type":"button","label":"Return to main site","href":"https://www.commercengine.io"}},"footer":{"socials":{"github":"https://github.com/tark-ai","twitter":"https://x.com/CommerceEngine","linkedin":"https://www.linkedin.com/company/commercengine"}},"search":{"prompt":"Search docs..."},"seo":{"metatags":{"canonical":"https://www.commercengine.io/docs","og:site_name":"Commerce Engine Developer Portal","og:locale":"en_US","og:logo":"/logo/CE_logo_whitebg.svg","twitter:site":"@CommerceEngine","og:image:width":"1200","og:image:height":"630","robots":"index, follow"},"indexing":"navigable"},"fonts":{"heading":{"family":"Satoshi","weight":700,"source":"https://images.tarkai.com/Commerce_Engine/Fonts/Satoshi-Variable.woff2","format":"woff2"},"body":{"family":"Satoshi","weight":450,"source":"https://images.tarkai.com/Commerce_Engine/Fonts/Satoshi-Variable.woff2","format":"woff2"}},"styling":{"eyebrows":"section","codeblocks":{"theme":{"light":"github-light","dark":"github-dark"}},"latex":false},"integrations":{"ga4":{"measurementId":"G-6SVW3L2E90"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"tarkai","hasAudioNarration":false,"actualSubdomain":"tarkai","customDomains":["www.commercengine.io"],"gitSource":{"type":"github","owner":"tark-ai","repo":"ce-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6af9711874b4f0f02ee2855a","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"API Reference","count":830},{"language":"default","tag":"Admin API","count":388},{"language":"default","tag":"Customers","count":250},{"language":"default","tag":"Webhooks","count":248},{"language":"default","tag":"Orders","count":156},{"language":"default","tag":"Catalog","count":149},{"language":"default","tag":"Store","count":142},{"language":"default","tag":"Storefront API","count":124},{"language":"default","tag":"Marketplace","count":88},{"language":"default","tag":"Payments","count":80}]},"assistantConfig":{},"basePath":"/docs","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"llms-txt-v2","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/coupons-\u0026-promotions/update-promotion","slug":"/admin/api-reference/coupons-\u0026-promotions/update-promotion","pageMetadata":{"title":"Update promotion","description":null,"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","autogeneratedByOpenApi":true},"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":"Update promotion","description":null,"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","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/tarkai/83faf160ccb5c4ff/header-float.js"],"openApiReferenceData":{"operation":{"tags":["Coupons \u0026 promotions"],"operationId":"update-promotion","summary":"Update promotion","requestBody":"cfed28c2-dae0-47e5-b210-3b3f32b31581","responses":{"200":"45aa4a52-c3a4-4a6a-9118-aa6a925aee7a","400":"0fec9ee3-565f-4a13-b78c-0b2bc27f0dc6"},"method":"put","type":"path","servers":["87850fd8-1faa-4b54-8be4-6c97c953f0a6","bfc441d1-681c-4d0f-b4bf-6ec5868ce7d9"],"security":["429dd998-bf2c-4a43-ba52-45b1a1e5cfec"],"path":"/offer/promotions/{id}","baseUrlOptions":["https://staging.api.commercengine.io/api/v1/{store_id}/admin","https://prod.api.commercengine.io/api/v1/{store_id}/admin"],"title":"Update promotion","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{"641dfd01-90a0-43c8-ba60-dd03ae53ae6e":{"name":"id","in":"path","description":"promotion id","required":true,"schema":{"type":"string","isRequired":true,"description":"promotion id","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"Promotion","required":["promotion_type","can_be_used_with_other_promotion","name","status","customer_eligibility","starts_at"],"x-tags":["Coupons \u0026 promotions"],"properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"status":{"type":"string","title":"CouponPromotionStatus","description":"On create this field is ignored and the status is derived from `starts_at`: when `starts_at` is omitted or null the status is `draft`; a future `starts_at` makes it `scheduled`; a `starts_at` at or before the current time makes it `active`. Required on update.","enum":["draft","scheduled","active","inactive"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"customer_eligibility":{"enum":["all","customer","segment","customer-group"],"type":"string","isRequired":true,"uniqueKey":"customer_eligibility","typeLabel":"enum\u003cstring>"},"starts_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"starts_at","typeLabel":"string\u003cdate-time>"},"promotion_type":{"title":"PromotionType","type":"string","enum":["discount","free-goods","free-shipping","buy-x-get-y","volume-based"],"isRequired":true,"uniqueKey":"promotion_type","typeLabel":"enum\u003cstring>"},"can_be_used_with_other_promotion":{"type":"boolean","isRequired":true,"uniqueKey":"can_be_used_with_other_promotion","typeLabel":"boolean"},"description":{"type":"string","uniqueKey":"description","typeLabel":"string"},"tags":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"tags.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"tags.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"uniqueKey":"tags.oneOf.1","typeLabel":"null"}],"uniqueKey":"tags","typeLabel":"string[] | null"},"customer_id":{"description":"required if customer_eligibility = customer","type":"array","items":{"type":"string","uniqueKey":"customer_id.items.[INDEX]","typeLabel":"string"},"uniqueKey":"customer_id","typeLabel":"string[]"},"segment_id":{"description":"required if customer_eligibility = segment","type":"array","items":{"type":"string","uniqueKey":"segment_id.items.[INDEX]","typeLabel":"string"},"uniqueKey":"segment_id","typeLabel":"string[]"},"customer_group_id":{"type":"array","items":{"type":"string","uniqueKey":"customer_group_id.items.[INDEX]","typeLabel":"string"},"uniqueKey":"customer_group_id","typeLabel":"string[]"},"redemption_limits":{"oneOf":[{"type":"object","properties":{"total_redemptions":{"oneOf":[{"type":"integer","isRequired":true,"uniqueKey":"redemption_limits.oneOf.0.total_redemptions.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"redemption_limits.oneOf.0.total_redemptions.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"redemption_limits.oneOf.0.total_redemptions","typeLabel":"integer | null"},"per_customer_redemptions":{"oneOf":[{"type":"integer","isRequired":true,"uniqueKey":"redemption_limits.oneOf.0.per_customer_redemptions.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"redemption_limits.oneOf.0.per_customer_redemptions.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"redemption_limits.oneOf.0.per_customer_redemptions","typeLabel":"integer | null"},"per_coupon_code_redemptions":{"oneOf":[{"type":"integer","uniqueKey":"redemption_limits.oneOf.0.per_coupon_code_redemptions.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"redemption_limits.oneOf.0.per_coupon_code_redemptions.oneOf.1","typeLabel":"null"}],"uniqueKey":"redemption_limits.oneOf.0.per_coupon_code_redemptions","typeLabel":"integer | null"}},"required":["total_redemptions","per_customer_redemptions"],"uniqueKey":"redemption_limits.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"total_redemptions":{"oneOf":[{"type":"integer"},{"type":"null"}]},"per_customer_redemptions":{"oneOf":[{"type":"integer"},{"type":"null"}]},"per_coupon_code_redemptions":{"oneOf":[{"type":"integer"},{"type":"null"}]}},"required":["total_redemptions","per_customer_redemptions"],"uniqueKey":"redemption_limits.oneOf.1","typeLabel":"null"}],"uniqueKey":"redemption_limits","typeLabel":"object | null"},"minimum_order_total":{"oneOf":[{"description":"Ignored when `coupon_type` or `promotion_type` is `tiered-discount`. Each slab in `details` defines its own `order_value` threshold.","type":"integer","default":0,"uniqueKey":"minimum_order_total.oneOf.0","typeLabel":"integer"},{"description":"Ignored when `coupon_type` or `promotion_type` is `tiered-discount`. Each slab in `details` defines its own `order_value` threshold.","type":"null","default":0,"uniqueKey":"minimum_order_total.oneOf.1","typeLabel":"null"}],"uniqueKey":"minimum_order_total","typeLabel":"integer | null"},"for_first_time_customer_only":{"type":"boolean","default":false,"uniqueKey":"for_first_time_customer_only","typeLabel":"boolean"},"can_earn_loyalty_points":{"type":"boolean","default":true,"uniqueKey":"can_earn_loyalty_points","typeLabel":"boolean"},"can_redeem_loyalty_points":{"type":"boolean","default":true,"uniqueKey":"can_redeem_loyalty_points","typeLabel":"boolean"},"expires_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"expires_at","typeLabel":"string\u003cdate-time> | null"},"priority":{"oneOf":[{"type":"integer","maximum":5,"minimum":1,"uniqueKey":"priority.oneOf.0","typeLabel":"integer"},{"type":"null","maximum":5,"minimum":1,"uniqueKey":"priority.oneOf.1","typeLabel":"null"}],"uniqueKey":"priority","typeLabel":"integer | null"},"applies_to_product":{"description":"`seller` scopes the promotion to specific marketplace sellers (`details.sellers`). It is valid only for `promotion_type: discount` and only on marketplace stores.","enum":["all","product","category","seller"],"type":"string","uniqueKey":"applies_to_product","typeLabel":"enum\u003cstring>"},"details":{"oneOf":[{"type":"object","title":"AutoScaleBasedOnQuantity","description":"Promotion rules; shape depends on `promotion_type`.","required":["spending_criteria_type","products"],"x-tags":["Coupons \u0026 promotions"],"properties":{"spending_criteria_type":{"type":"string","const":"minimum-quantity","isRequired":true,"uniqueKey":"details.oneOf.0.spending_criteria_type","typeLabel":"string"},"products":{"type":"array","items":{"type":"object","required":["product_id","variant_id","auto_scale","slab"],"properties":{"product_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.0.products.items.[INDEX].product_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"details.oneOf.0.products.items.[INDEX].product_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"details.oneOf.0.products.items.[INDEX].product_id","typeLabel":"string | null"},"variant_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.0.products.items.[INDEX].variant_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"details.oneOf.0.products.items.[INDEX].variant_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"details.oneOf.0.products.items.[INDEX].variant_id","typeLabel":"string | null"},"auto_scale":{"type":"boolean","isRequired":true,"uniqueKey":"details.oneOf.0.products.items.[INDEX].auto_scale","typeLabel":"boolean"},"slab":{"type":"object","properties":{"buy_quantity":{"type":"integer","isRequired":true,"uniqueKey":"details.oneOf.0.products.items.[INDEX].slab.buy_quantity","typeLabel":"integer"},"get_quantity":{"type":"integer","isRequired":true,"uniqueKey":"details.oneOf.0.products.items.[INDEX].slab.get_quantity","typeLabel":"integer"},"condition":{"enum":["greater-or-equal"],"type":"string","isRequired":true,"uniqueKey":"details.oneOf.0.products.items.[INDEX].slab.condition","typeLabel":"enum\u003cstring>"}},"required":["buy_quantity","get_quantity","condition"],"isRequired":true,"uniqueKey":"details.oneOf.0.products.items.[INDEX].slab","typeLabel":"object"}},"uniqueKey":"details.oneOf.0.products.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"details.oneOf.0.products","typeLabel":"object[]"}},"uniqueKey":"details.oneOf.0","typeLabel":"AutoScaleBasedOnQuantity · object"},{"type":"object","title":"AutoScaleBasedOnAmount","description":"Promotion rules; shape depends on `promotion_type`.","required":["spending_criteria_type","products"],"x-tags":["Coupons \u0026 promotions"],"properties":{"spending_criteria_type":{"type":"string","const":"minimum-purchase-amount","isRequired":true,"uniqueKey":"details.oneOf.1.spending_criteria_type","typeLabel":"string"},"products":{"type":"array","items":{"type":"object","required":["product_id","variant_id","auto_scale","slab"],"properties":{"product_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.1.products.items.[INDEX].product_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"details.oneOf.1.products.items.[INDEX].product_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"details.oneOf.1.products.items.[INDEX].product_id","typeLabel":"string | null"},"variant_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.1.products.items.[INDEX].variant_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"details.oneOf.1.products.items.[INDEX].variant_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"details.oneOf.1.products.items.[INDEX].variant_id","typeLabel":"string | null"},"auto_scale":{"type":"boolean","isRequired":true,"uniqueKey":"details.oneOf.1.products.items.[INDEX].auto_scale","typeLabel":"boolean"},"slab":{"type":"object","properties":{"minimum_purchase_amount":{"type":"number","isRequired":true,"uniqueKey":"details.oneOf.1.products.items.[INDEX].slab.minimum_purchase_amount","typeLabel":"number"},"get_quantity":{"type":"integer","isRequired":true,"uniqueKey":"details.oneOf.1.products.items.[INDEX].slab.get_quantity","typeLabel":"integer"},"condition":{"enum":["greater-or-equal"],"type":"string","isRequired":true,"uniqueKey":"details.oneOf.1.products.items.[INDEX].slab.condition","typeLabel":"enum\u003cstring>"}},"required":["minimum_purchase_amount","get_quantity","condition"],"isRequired":true,"uniqueKey":"details.oneOf.1.products.items.[INDEX].slab","typeLabel":"object"}},"uniqueKey":"details.oneOf.1.products.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"details.oneOf.1.products","typeLabel":"object[]"}},"uniqueKey":"details.oneOf.1","typeLabel":"AutoScaleBasedOnAmount · object"},{"type":"object","title":"CustomSlabsBasedOnQuantity","description":"Promotion rules; shape depends on `promotion_type`.","required":["spending_criteria_type","products"],"x-tags":["Coupons \u0026 promotions"],"properties":{"spending_criteria_type":{"type":"string","const":"minimum-quantity","isRequired":true,"uniqueKey":"details.oneOf.2.spending_criteria_type","typeLabel":"string"},"products":{"type":"array","items":{"type":"object","required":["product_id","variant_id","slabs"],"properties":{"product_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.2.products.items.[INDEX].product_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"details.oneOf.2.products.items.[INDEX].product_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"details.oneOf.2.products.items.[INDEX].product_id","typeLabel":"string | null"},"variant_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.2.products.items.[INDEX].variant_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"details.oneOf.2.products.items.[INDEX].variant_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"details.oneOf.2.products.items.[INDEX].variant_id","typeLabel":"string | null"},"slabs":{"type":"array","items":{"type":"object","properties":{"buy_quantity":{"type":"integer","isRequired":true,"uniqueKey":"details.oneOf.2.products.items.[INDEX].slabs.items.[INDEX].buy_quantity","typeLabel":"integer"},"get_quantity":{"type":"integer","isRequired":true,"uniqueKey":"details.oneOf.2.products.items.[INDEX].slabs.items.[INDEX].get_quantity","typeLabel":"integer"},"condition":{"enum":["greater-or-equal"],"type":"string","isRequired":true,"uniqueKey":"details.oneOf.2.products.items.[INDEX].slabs.items.[INDEX].condition","typeLabel":"enum\u003cstring>"}},"required":["buy_quantity","get_quantity","condition"],"uniqueKey":"details.oneOf.2.products.items.[INDEX].slabs.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"details.oneOf.2.products.items.[INDEX].slabs","typeLabel":"object[]"}},"uniqueKey":"details.oneOf.2.products.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"details.oneOf.2.products","typeLabel":"object[]"}},"uniqueKey":"details.oneOf.2","typeLabel":"CustomSlabsBasedOnQuantity · object"},{"type":"object","title":"CustomSlabsBasedOnAmount","description":"Promotion rules; shape depends on `promotion_type`.","required":["spending_criteria_type","products"],"x-tags":["Coupons \u0026 promotions"],"properties":{"spending_criteria_type":{"type":"string","const":"minimum-purchase-amount","isRequired":true,"uniqueKey":"details.oneOf.3.spending_criteria_type","typeLabel":"string"},"products":{"type":"array","items":{"type":"object","required":["product_id","variant_id","slabs"],"properties":{"product_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.3.products.items.[INDEX].product_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"details.oneOf.3.products.items.[INDEX].product_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"details.oneOf.3.products.items.[INDEX].product_id","typeLabel":"string | null"},"variant_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.3.products.items.[INDEX].variant_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"details.oneOf.3.products.items.[INDEX].variant_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"details.oneOf.3.products.items.[INDEX].variant_id","typeLabel":"string | null"},"slabs":{"type":"array","items":{"type":"object","properties":{"minimum_purchase_amount":{"type":"number","isRequired":true,"uniqueKey":"details.oneOf.3.products.items.[INDEX].slabs.items.[INDEX].minimum_purchase_amount","typeLabel":"number"},"get_quantity":{"type":"integer","isRequired":true,"uniqueKey":"details.oneOf.3.products.items.[INDEX].slabs.items.[INDEX].get_quantity","typeLabel":"integer"},"condition":{"enum":["greater-or-equal"],"type":"string","isRequired":true,"uniqueKey":"details.oneOf.3.products.items.[INDEX].slabs.items.[INDEX].condition","typeLabel":"enum\u003cstring>"}},"required":["minimum_purchase_amount","get_quantity","condition"],"uniqueKey":"details.oneOf.3.products.items.[INDEX].slabs.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"details.oneOf.3.products.items.[INDEX].slabs","typeLabel":"object[]"}},"uniqueKey":"details.oneOf.3.products.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"details.oneOf.3.products","typeLabel":"object[]"}},"uniqueKey":"details.oneOf.3","typeLabel":"CustomSlabsBasedOnAmount · object"},{"type":"object","title":"BuyXGetYRuleBasedOnQuantity","description":"Promotion rules; shape depends on `promotion_type`.","required":["spending_criteria_type","products","maximum_discount_amount"],"x-tags":["Coupons \u0026 promotions"],"properties":{"spending_criteria_type":{"type":"string","const":"minimum-quantity","isRequired":true,"uniqueKey":"details.oneOf.4.spending_criteria_type","typeLabel":"string"},"products":{"type":"array","items":{"type":"object","required":["minimum_quantity","buy_product_id","buy_variant_id","buy_from_category_id","get_product_id","get_variant_id","get_from_category_id","get_quantity","get_offer_type","get_discount_percent"],"properties":{"minimum_quantity":{"type":"integer","minimum":1,"isRequired":true,"uniqueKey":"details.oneOf.4.products.items.[INDEX].minimum_quantity","typeLabel":"integer"},"buy_product_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.4.products.items.[INDEX].buy_product_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"details.oneOf.4.products.items.[INDEX].buy_product_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"details.oneOf.4.products.items.[INDEX].buy_product_id","typeLabel":"string | null"},"buy_variant_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.4.products.items.[INDEX].buy_variant_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"details.oneOf.4.products.items.[INDEX].buy_variant_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"details.oneOf.4.products.items.[INDEX].buy_variant_id","typeLabel":"string | null"},"buy_from_category_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.4.products.items.[INDEX].buy_from_category_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"details.oneOf.4.products.items.[INDEX].buy_from_category_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"details.oneOf.4.products.items.[INDEX].buy_from_category_id","typeLabel":"string | null"},"get_product_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.4.products.items.[INDEX].get_product_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"details.oneOf.4.products.items.[INDEX].get_product_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"details.oneOf.4.products.items.[INDEX].get_product_id","typeLabel":"string | null"},"get_variant_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.4.products.items.[INDEX].get_variant_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"details.oneOf.4.products.items.[INDEX].get_variant_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"details.oneOf.4.products.items.[INDEX].get_variant_id","typeLabel":"string | null"},"get_from_category_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.4.products.items.[INDEX].get_from_category_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"details.oneOf.4.products.items.[INDEX].get_from_category_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"details.oneOf.4.products.items.[INDEX].get_from_category_id","typeLabel":"string | null"},"get_quantity":{"type":"integer","minimum":1,"isRequired":true,"uniqueKey":"details.oneOf.4.products.items.[INDEX].get_quantity","typeLabel":"integer"},"get_offer_type":{"enum":["discount","free"],"type":"string","isRequired":true,"uniqueKey":"details.oneOf.4.products.items.[INDEX].get_offer_type","typeLabel":"enum\u003cstring>"},"get_discount_percent":{"oneOf":[{"description":"It can be null for get_offer_type = free","type":"number","isRequired":true,"uniqueKey":"details.oneOf.4.products.items.[INDEX].get_discount_percent.oneOf.0","typeLabel":"number"},{"description":"It can be null for get_offer_type = free","type":"null","isRequired":true,"uniqueKey":"details.oneOf.4.products.items.[INDEX].get_discount_percent.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"details.oneOf.4.products.items.[INDEX].get_discount_percent","typeLabel":"number | null"}},"uniqueKey":"details.oneOf.4.products.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"details.oneOf.4.products","typeLabel":"object[]"},"maximum_discount_amount":{"oneOf":[{"description":"It can be null for get_offer_type = free","type":"number","isRequired":true,"uniqueKey":"details.oneOf.4.maximum_discount_amount.oneOf.0","typeLabel":"number"},{"description":"It can be null for get_offer_type = free","type":"null","isRequired":true,"uniqueKey":"details.oneOf.4.maximum_discount_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"details.oneOf.4.maximum_discount_amount","typeLabel":"number | null"}},"uniqueKey":"details.oneOf.4","typeLabel":"BuyXGetYRuleBasedOnQuantity · object"},{"type":"object","title":"BuyXGetYRuleBasedOnAmount","description":"Promotion rules; shape depends on `promotion_type`.","required":["spending_criteria_type","products","maximum_discount_amount"],"x-tags":["Coupons \u0026 promotions"],"properties":{"spending_criteria_type":{"type":"string","const":"minimum-purchase-amount","isRequired":true,"uniqueKey":"details.oneOf.5.spending_criteria_type","typeLabel":"string"},"products":{"type":"array","items":{"type":"object","required":["minimum_purchase_amount","buy_product_id","buy_variant_id","buy_from_category_id","get_product_id","get_variant_id","get_from_category_id","get_quantity","get_offer_type","get_discount_percent"],"properties":{"minimum_purchase_amount":{"type":"number","minimum":1,"isRequired":true,"uniqueKey":"details.oneOf.5.products.items.[INDEX].minimum_purchase_amount","typeLabel":"number"},"buy_product_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.5.products.items.[INDEX].buy_product_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"details.oneOf.5.products.items.[INDEX].buy_product_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"details.oneOf.5.products.items.[INDEX].buy_product_id","typeLabel":"string | null"},"buy_variant_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.5.products.items.[INDEX].buy_variant_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"details.oneOf.5.products.items.[INDEX].buy_variant_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"details.oneOf.5.products.items.[INDEX].buy_variant_id","typeLabel":"string | null"},"buy_from_category_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.5.products.items.[INDEX].buy_from_category_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"details.oneOf.5.products.items.[INDEX].buy_from_category_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"details.oneOf.5.products.items.[INDEX].buy_from_category_id","typeLabel":"string | null"},"get_product_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.5.products.items.[INDEX].get_product_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"details.oneOf.5.products.items.[INDEX].get_product_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"details.oneOf.5.products.items.[INDEX].get_product_id","typeLabel":"string | null"},"get_variant_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.5.products.items.[INDEX].get_variant_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"details.oneOf.5.products.items.[INDEX].get_variant_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"details.oneOf.5.products.items.[INDEX].get_variant_id","typeLabel":"string | null"},"get_from_category_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.5.products.items.[INDEX].get_from_category_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"details.oneOf.5.products.items.[INDEX].get_from_category_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"details.oneOf.5.products.items.[INDEX].get_from_category_id","typeLabel":"string | null"},"get_quantity":{"type":"integer","minimum":1,"isRequired":true,"uniqueKey":"details.oneOf.5.products.items.[INDEX].get_quantity","typeLabel":"integer"},"get_offer_type":{"enum":["discount","free"],"type":"string","isRequired":true,"uniqueKey":"details.oneOf.5.products.items.[INDEX].get_offer_type","typeLabel":"enum\u003cstring>"},"get_discount_percent":{"oneOf":[{"description":"It can be null for get_offer_type = free","type":"number","isRequired":true,"uniqueKey":"details.oneOf.5.products.items.[INDEX].get_discount_percent.oneOf.0","typeLabel":"number"},{"description":"It can be null for get_offer_type = free","type":"null","isRequired":true,"uniqueKey":"details.oneOf.5.products.items.[INDEX].get_discount_percent.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"details.oneOf.5.products.items.[INDEX].get_discount_percent","typeLabel":"number | null"}},"uniqueKey":"details.oneOf.5.products.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"details.oneOf.5.products","typeLabel":"object[]"},"maximum_discount_amount":{"oneOf":[{"description":"It can be null for get_offer_type = free","type":"number","isRequired":true,"uniqueKey":"details.oneOf.5.maximum_discount_amount.oneOf.0","typeLabel":"number"},{"description":"It can be null for get_offer_type = free","type":"null","isRequired":true,"uniqueKey":"details.oneOf.5.maximum_discount_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"details.oneOf.5.maximum_discount_amount","typeLabel":"number | null"}},"uniqueKey":"details.oneOf.5","typeLabel":"BuyXGetYRuleBasedOnAmount · object"},{"type":"object","title":"DiscountRule","description":"Promotion rules; shape depends on `promotion_type`.","required":["discount_type","products","category_id"],"x-tags":["Coupons \u0026 promotions"],"properties":{"discount_type":{"type":"string","enum":["percentage","fixed-amount"],"isRequired":true,"uniqueKey":"details.oneOf.6.discount_type","typeLabel":"enum\u003cstring>"},"products":{"type":"array","items":{"type":"object","properties":{"product_id":{"oneOf":[{"type":"string","uniqueKey":"details.oneOf.6.products.items.[INDEX].product_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"details.oneOf.6.products.items.[INDEX].product_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"details.oneOf.6.products.items.[INDEX].product_id","typeLabel":"string | null"},"variant_id":{"oneOf":[{"type":"string","uniqueKey":"details.oneOf.6.products.items.[INDEX].variant_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"details.oneOf.6.products.items.[INDEX].variant_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"details.oneOf.6.products.items.[INDEX].variant_id","typeLabel":"string | null"},"minimum_quantity":{"oneOf":[{"type":"integer","uniqueKey":"details.oneOf.6.products.items.[INDEX].minimum_quantity.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"details.oneOf.6.products.items.[INDEX].minimum_quantity.oneOf.1","typeLabel":"null"}],"uniqueKey":"details.oneOf.6.products.items.[INDEX].minimum_quantity","typeLabel":"integer | null"},"maximum_quantity":{"oneOf":[{"type":"integer","uniqueKey":"details.oneOf.6.products.items.[INDEX].maximum_quantity.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"details.oneOf.6.products.items.[INDEX].maximum_quantity.oneOf.1","typeLabel":"null"}],"uniqueKey":"details.oneOf.6.products.items.[INDEX].maximum_quantity","typeLabel":"integer | null"},"minimum_value":{"oneOf":[{"type":"number","uniqueKey":"details.oneOf.6.products.items.[INDEX].minimum_value.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"details.oneOf.6.products.items.[INDEX].minimum_value.oneOf.1","typeLabel":"null"}],"uniqueKey":"details.oneOf.6.products.items.[INDEX].minimum_value","typeLabel":"number | null"},"maximum_value":{"oneOf":[{"type":"number","uniqueKey":"details.oneOf.6.products.items.[INDEX].maximum_value.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"details.oneOf.6.products.items.[INDEX].maximum_value.oneOf.1","typeLabel":"null"}],"uniqueKey":"details.oneOf.6.products.items.[INDEX].maximum_value","typeLabel":"number | null"}},"uniqueKey":"details.oneOf.6.products.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"details.oneOf.6.products","typeLabel":"object[]"},"category_id":{"description":"Array of category ids","type":"array","items":{"type":"string","uniqueKey":"details.oneOf.6.category_id.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"details.oneOf.6.category_id","typeLabel":"string[]"},"discount_percent":{"oneOf":[{"type":"number","uniqueKey":"details.oneOf.6.discount_percent.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"details.oneOf.6.discount_percent.oneOf.1","typeLabel":"null"}],"uniqueKey":"details.oneOf.6.discount_percent","typeLabel":"number | null"},"fixed_discount_amount":{"oneOf":[{"type":"number","uniqueKey":"details.oneOf.6.fixed_discount_amount.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"details.oneOf.6.fixed_discount_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"details.oneOf.6.fixed_discount_amount","typeLabel":"number | null"},"maximum_discount_amount":{"oneOf":[{"type":"number","uniqueKey":"details.oneOf.6.maximum_discount_amount.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"details.oneOf.6.maximum_discount_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"details.oneOf.6.maximum_discount_amount","typeLabel":"number | null"},"sellers":{"description":"Marketplace seller ids the discount applies to. Required (at least one) when `applies_to_product` is `seller`, and accepted only on marketplace stores; empty or omitted otherwise.","type":"array","items":{"type":"string","uniqueKey":"details.oneOf.6.sellers.items.[INDEX]","typeLabel":"string"},"uniqueKey":"details.oneOf.6.sellers","typeLabel":"string[]"}},"uniqueKey":"details.oneOf.6","typeLabel":"DiscountRule · object"},{"type":"object","title":"VolumeBasedRule","description":"Promotion rules; shape depends on `promotion_type`.","required":["products","maximum_discount_amount"],"x-tags":["Coupons \u0026 promotions"],"properties":{"products":{"type":"array","items":{"type":"object","required":["product_id","variant_id","slabs"],"properties":{"product_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.7.products.items.[INDEX].product_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"details.oneOf.7.products.items.[INDEX].product_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"details.oneOf.7.products.items.[INDEX].product_id","typeLabel":"string | null"},"variant_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"details.oneOf.7.products.items.[INDEX].variant_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"details.oneOf.7.products.items.[INDEX].variant_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"details.oneOf.7.products.items.[INDEX].variant_id","typeLabel":"string | null"},"slabs":{"type":"array","items":{"type":"object","required":["quantity","condition","discount_percent"],"properties":{"quantity":{"type":"integer","isRequired":true,"uniqueKey":"details.oneOf.7.products.items.[INDEX].slabs.items.[INDEX].quantity","typeLabel":"integer"},"condition":{"enum":["less-or-equal","greater"],"type":"string","isRequired":true,"uniqueKey":"details.oneOf.7.products.items.[INDEX].slabs.items.[INDEX].condition","typeLabel":"enum\u003cstring>"},"discount_percent":{"type":"number","isRequired":true,"uniqueKey":"details.oneOf.7.products.items.[INDEX].slabs.items.[INDEX].discount_percent","typeLabel":"number"}},"uniqueKey":"details.oneOf.7.products.items.[INDEX].slabs.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"details.oneOf.7.products.items.[INDEX].slabs","typeLabel":"object[]"}},"uniqueKey":"details.oneOf.7.products.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"details.oneOf.7.products","typeLabel":"object[]"},"maximum_discount_amount":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"details.oneOf.7.maximum_discount_amount.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"details.oneOf.7.maximum_discount_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"details.oneOf.7.maximum_discount_amount","typeLabel":"number | null"}},"uniqueKey":"details.oneOf.7","typeLabel":"VolumeBasedRule · object"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"details.oneOf.8.items.[INDEX]","typeLabel":"any"},"title":"FreeShippingDetails","description":"Promotion rules; shape depends on `promotion_type`.","default":[],"maxItems":0,"x-tags":["Coupons \u0026 promotions"],"uniqueKey":"details.oneOf.8","typeLabel":"any[]"},{"type":"null","title":"FreeShippingDetails","description":"Promotion rules; shape depends on `promotion_type`.","default":[],"maxItems":0,"x-tags":["Coupons \u0026 promotions"],"uniqueKey":"details.oneOf.9","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"AutoScaleBasedOnQuantity · object | AutoScaleBasedOnAmount · object | CustomSlabsBasedOnQuantity · object | CustomSlabsBasedOnAmount · object | BuyXGetYRuleBasedOnQuantity · object | BuyXGetYRuleBasedOnAmount · object | DiscountRule · object | VolumeBasedRule · object | any[] | null"},"terms_and_conditions":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"terms_and_conditions.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"terms_and_conditions.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"uniqueKey":"terms_and_conditions.oneOf.1","typeLabel":"null"}],"uniqueKey":"terms_and_conditions","typeLabel":"string[] | null"}},"uniqueKey":"","typeLabel":"Promotion · object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","starts_at":"2023-11-07T05:31:56Z","can_be_used_with_other_promotion":true,"description":"\u003cstring>","tags":["\u003cstring>"],"customer_id":["\u003cstring>"],"segment_id":["\u003cstring>"],"customer_group_id":["\u003cstring>"],"redemption_limits":{"total_redemptions":123,"per_customer_redemptions":123,"per_coupon_code_redemptions":123},"minimum_order_total":0,"for_first_time_customer_only":false,"can_earn_loyalty_points":true,"can_redeem_loyalty_points":true,"expires_at":"2023-11-07T05:31:56Z","priority":3,"details":{"spending_criteria_type":"minimum-quantity","products":[{"product_id":"\u003cstring>","variant_id":"\u003cstring>","auto_scale":true,"slab":{"buy_quantity":123,"get_quantity":123,"condition":"greater-or-equal"}}]},"terms_and_conditions":["\u003cstring>"]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"45aa4a52-c3a4-4a6a-9118-aa6a925aee7a":{"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":{"promotion":{"type":"object","title":"PromotionDetail","description":"Full promotion returned on retrieve and update. Same shape as `Promotion`.","required":["promotion_type","can_be_used_with_other_promotion","name","status","customer_eligibility","starts_at"],"x-tags":["Coupons \u0026 promotions"],"properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"content.promotion.name","typeLabel":"string"},"status":{"type":"string","title":"CouponPromotionStatus","description":"On create this field is ignored and the status is derived from `starts_at`: when `starts_at` is omitted or null the status is `draft`; a future `starts_at` makes it `scheduled`; a `starts_at` at or before the current time makes it `active`. Required on update.","enum":["draft","scheduled","active","inactive"],"isRequired":true,"uniqueKey":"content.promotion.status","typeLabel":"enum\u003cstring>"},"customer_eligibility":{"enum":["all","customer","segment","customer-group"],"type":"string","isRequired":true,"uniqueKey":"content.promotion.customer_eligibility","typeLabel":"enum\u003cstring>"},"starts_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"content.promotion.starts_at","typeLabel":"string\u003cdate-time>"},"promotion_type":{"title":"PromotionType","type":"string","enum":["discount","free-goods","free-shipping","buy-x-get-y","volume-based"],"isRequired":true,"uniqueKey":"content.promotion.promotion_type","typeLabel":"enum\u003cstring>"},"can_be_used_with_other_promotion":{"type":"boolean","isRequired":true,"uniqueKey":"content.promotion.can_be_used_with_other_promotion","typeLabel":"boolean"},"id":{"type":"string","readOnly":true,"uniqueKey":"content.promotion.id","typeLabel":"string"},"description":{"type":"string","uniqueKey":"content.promotion.description","typeLabel":"string"},"tags":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"content.promotion.tags.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"content.promotion.tags.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"uniqueKey":"content.promotion.tags.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.promotion.tags","typeLabel":"string[] | null"},"active":{"type":"boolean","readOnly":true,"uniqueKey":"content.promotion.active","typeLabel":"boolean"},"customer_id":{"description":"required if customer_eligibility = customer","type":"array","items":{"type":"string","uniqueKey":"content.promotion.customer_id.items.[INDEX]","typeLabel":"string"},"uniqueKey":"content.promotion.customer_id","typeLabel":"string[]"},"segment_id":{"description":"required if customer_eligibility = segment","type":"array","items":{"type":"string","uniqueKey":"content.promotion.segment_id.items.[INDEX]","typeLabel":"string"},"uniqueKey":"content.promotion.segment_id","typeLabel":"string[]"},"customer_group_id":{"type":"array","items":{"type":"string","uniqueKey":"content.promotion.customer_group_id.items.[INDEX]","typeLabel":"string"},"uniqueKey":"content.promotion.customer_group_id","typeLabel":"string[]"},"redemption_limits":{"oneOf":[{"type":"object","properties":{"total_redemptions":{"oneOf":[{"type":"integer","isRequired":true,"uniqueKey":"content.promotion.redemption_limits.oneOf.0.total_redemptions.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"content.promotion.redemption_limits.oneOf.0.total_redemptions.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.promotion.redemption_limits.oneOf.0.total_redemptions","typeLabel":"integer | null"},"per_customer_redemptions":{"oneOf":[{"type":"integer","isRequired":true,"uniqueKey":"content.promotion.redemption_limits.oneOf.0.per_customer_redemptions.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"content.promotion.redemption_limits.oneOf.0.per_customer_redemptions.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.promotion.redemption_limits.oneOf.0.per_customer_redemptions","typeLabel":"integer | null"},"per_coupon_code_redemptions":{"oneOf":[{"type":"integer","uniqueKey":"content.promotion.redemption_limits.oneOf.0.per_coupon_code_redemptions.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"content.promotion.redemption_limits.oneOf.0.per_coupon_code_redemptions.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.promotion.redemption_limits.oneOf.0.per_coupon_code_redemptions","typeLabel":"integer | null"}},"required":["total_redemptions","per_customer_redemptions"],"uniqueKey":"content.promotion.redemption_limits.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"total_redemptions":{"oneOf":[{"type":"integer"},{"type":"null"}]},"per_customer_redemptions":{"oneOf":[{"type":"integer"},{"type":"null"}]},"per_coupon_code_redemptions":{"oneOf":[{"type":"integer"},{"type":"null"}]}},"required":["total_redemptions","per_customer_redemptions"],"uniqueKey":"content.promotion.redemption_limits.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.promotion.redemption_limits","typeLabel":"object | null"},"redemption_count":{"type":"integer","readOnly":true,"uniqueKey":"content.promotion.redemption_count","typeLabel":"integer"},"minimum_order_total":{"oneOf":[{"description":"Ignored when `coupon_type` or `promotion_type` is `tiered-discount`. Each slab in `details` defines its own `order_value` threshold.","type":"integer","default":0,"uniqueKey":"content.promotion.minimum_order_total.oneOf.0","typeLabel":"integer"},{"description":"Ignored when `coupon_type` or `promotion_type` is `tiered-discount`. Each slab in `details` defines its own `order_value` threshold.","type":"null","default":0,"uniqueKey":"content.promotion.minimum_order_total.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.promotion.minimum_order_total","typeLabel":"integer | null"},"for_first_time_customer_only":{"type":"boolean","default":false,"uniqueKey":"content.promotion.for_first_time_customer_only","typeLabel":"boolean"},"can_earn_loyalty_points":{"type":"boolean","default":true,"uniqueKey":"content.promotion.can_earn_loyalty_points","typeLabel":"boolean"},"can_redeem_loyalty_points":{"type":"boolean","default":true,"uniqueKey":"content.promotion.can_redeem_loyalty_points","typeLabel":"boolean"},"expires_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"content.promotion.expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"content.promotion.expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.promotion.expires_at","typeLabel":"string\u003cdate-time> | null"},"created_at":{"type":"string","format":"date-time","readOnly":true,"uniqueKey":"content.promotion.created_at","typeLabel":"string\u003cdate-time>"},"modified_at":{"type":"string","format":"date-time","readOnly":true,"uniqueKey":"content.promotion.modified_at","typeLabel":"string\u003cdate-time>"},"store_id":{"type":"string","readOnly":true,"uniqueKey":"content.promotion.store_id","typeLabel":"string"},"priority":{"oneOf":[{"type":"integer","maximum":5,"minimum":1,"uniqueKey":"content.promotion.priority.oneOf.0","typeLabel":"integer"},{"type":"null","maximum":5,"minimum":1,"uniqueKey":"content.promotion.priority.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.promotion.priority","typeLabel":"integer | null"},"applies_to_product":{"description":"`seller` scopes the promotion to specific marketplace sellers (`details.sellers`). It is valid only for `promotion_type: discount` and only on marketplace stores.","enum":["all","product","category","seller"],"type":"string","uniqueKey":"content.promotion.applies_to_product","typeLabel":"enum\u003cstring>"},"details":{"oneOf":[{"type":"object","title":"AutoScaleBasedOnQuantity","description":"Promotion rules; shape depends on `promotion_type`.","required":["spending_criteria_type","products"],"x-tags":["Coupons \u0026 promotions"],"properties":{"spending_criteria_type":{"type":"string","const":"minimum-quantity","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.0.spending_criteria_type","typeLabel":"string"},"products":{"type":"array","items":{"type":"object","required":["product_id","variant_id","auto_scale","slab"],"properties":{"product_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.0.products.items.[INDEX].product_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.0.products.items.[INDEX].product_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.promotion.details.oneOf.0.products.items.[INDEX].product_id","typeLabel":"string | null"},"variant_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.0.products.items.[INDEX].variant_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.0.products.items.[INDEX].variant_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.promotion.details.oneOf.0.products.items.[INDEX].variant_id","typeLabel":"string | null"},"auto_scale":{"type":"boolean","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.0.products.items.[INDEX].auto_scale","typeLabel":"boolean"},"slab":{"type":"object","properties":{"buy_quantity":{"type":"integer","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.0.products.items.[INDEX].slab.buy_quantity","typeLabel":"integer"},"get_quantity":{"type":"integer","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.0.products.items.[INDEX].slab.get_quantity","typeLabel":"integer"},"condition":{"enum":["greater-or-equal"],"type":"string","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.0.products.items.[INDEX].slab.condition","typeLabel":"enum\u003cstring>"}},"required":["buy_quantity","get_quantity","condition"],"isRequired":true,"uniqueKey":"content.promotion.details.oneOf.0.products.items.[INDEX].slab","typeLabel":"object"},"sku":{"oneOf":[{"type":"string","readOnly":true,"uniqueKey":"content.promotion.details.oneOf.0.products.items.[INDEX].sku.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"uniqueKey":"content.promotion.details.oneOf.0.products.items.[INDEX].sku.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.promotion.details.oneOf.0.products.items.[INDEX].sku","typeLabel":"string | null"},"product_name":{"type":"string","readOnly":true,"uniqueKey":"content.promotion.details.oneOf.0.products.items.[INDEX].product_name","typeLabel":"string"},"status":{"type":"string","readOnly":true,"uniqueKey":"content.promotion.details.oneOf.0.products.items.[INDEX].status","typeLabel":"string"},"stock_available":{"type":"string","readOnly":true,"uniqueKey":"content.promotion.details.oneOf.0.products.items.[INDEX].stock_available","typeLabel":"string"},"images":{"type":"string","readOnly":true,"uniqueKey":"content.promotion.details.oneOf.0.products.items.[INDEX].images","typeLabel":"string"}},"uniqueKey":"content.promotion.details.oneOf.0.products.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"content.promotion.details.oneOf.0.products","typeLabel":"object[]"}},"uniqueKey":"content.promotion.details.oneOf.0","typeLabel":"AutoScaleBasedOnQuantity · object"},{"type":"object","title":"AutoScaleBasedOnAmount","description":"Promotion rules; shape depends on `promotion_type`.","required":["spending_criteria_type","products"],"x-tags":["Coupons \u0026 promotions"],"properties":{"spending_criteria_type":{"type":"string","const":"minimum-purchase-amount","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.1.spending_criteria_type","typeLabel":"string"},"products":{"type":"array","items":{"type":"object","required":["product_id","variant_id","auto_scale","slab"],"properties":{"product_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.1.products.items.[INDEX].product_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.1.products.items.[INDEX].product_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.promotion.details.oneOf.1.products.items.[INDEX].product_id","typeLabel":"string | null"},"variant_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.1.products.items.[INDEX].variant_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.1.products.items.[INDEX].variant_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.promotion.details.oneOf.1.products.items.[INDEX].variant_id","typeLabel":"string | null"},"auto_scale":{"type":"boolean","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.1.products.items.[INDEX].auto_scale","typeLabel":"boolean"},"slab":{"type":"object","properties":{"minimum_purchase_amount":{"type":"number","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.1.products.items.[INDEX].slab.minimum_purchase_amount","typeLabel":"number"},"get_quantity":{"type":"integer","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.1.products.items.[INDEX].slab.get_quantity","typeLabel":"integer"},"condition":{"enum":["greater-or-equal"],"type":"string","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.1.products.items.[INDEX].slab.condition","typeLabel":"enum\u003cstring>"}},"required":["minimum_purchase_amount","get_quantity","condition"],"isRequired":true,"uniqueKey":"content.promotion.details.oneOf.1.products.items.[INDEX].slab","typeLabel":"object"},"sku":{"oneOf":[{"type":"string","readOnly":true,"uniqueKey":"content.promotion.details.oneOf.1.products.items.[INDEX].sku.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"uniqueKey":"content.promotion.details.oneOf.1.products.items.[INDEX].sku.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.promotion.details.oneOf.1.products.items.[INDEX].sku","typeLabel":"string | null"},"product_name":{"type":"string","readOnly":true,"uniqueKey":"content.promotion.details.oneOf.1.products.items.[INDEX].product_name","typeLabel":"string"},"status":{"type":"string","readOnly":true,"uniqueKey":"content.promotion.details.oneOf.1.products.items.[INDEX].status","typeLabel":"string"},"stock_available":{"type":"string","readOnly":true,"uniqueKey":"content.promotion.details.oneOf.1.products.items.[INDEX].stock_available","typeLabel":"string"},"images":{"type":"string","readOnly":true,"uniqueKey":"content.promotion.details.oneOf.1.products.items.[INDEX].images","typeLabel":"string"}},"uniqueKey":"content.promotion.details.oneOf.1.products.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"content.promotion.details.oneOf.1.products","typeLabel":"object[]"}},"uniqueKey":"content.promotion.details.oneOf.1","typeLabel":"AutoScaleBasedOnAmount · object"},{"type":"object","title":"CustomSlabsBasedOnQuantity","description":"Promotion rules; shape depends on `promotion_type`.","required":["spending_criteria_type","products"],"x-tags":["Coupons \u0026 promotions"],"properties":{"spending_criteria_type":{"type":"string","const":"minimum-quantity","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.2.spending_criteria_type","typeLabel":"string"},"products":{"type":"array","items":{"type":"object","required":["product_id","variant_id","slabs"],"properties":{"product_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.2.products.items.[INDEX].product_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.2.products.items.[INDEX].product_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.promotion.details.oneOf.2.products.items.[INDEX].product_id","typeLabel":"string | null"},"variant_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.2.products.items.[INDEX].variant_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.2.products.items.[INDEX].variant_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.promotion.details.oneOf.2.products.items.[INDEX].variant_id","typeLabel":"string | null"},"slabs":{"type":"array","items":{"type":"object","properties":{"buy_quantity":{"type":"integer","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.2.products.items.[INDEX].slabs.items.[INDEX].buy_quantity","typeLabel":"integer"},"get_quantity":{"type":"integer","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.2.products.items.[INDEX].slabs.items.[INDEX].get_quantity","typeLabel":"integer"},"condition":{"enum":["greater-or-equal"],"type":"string","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.2.products.items.[INDEX].slabs.items.[INDEX].condition","typeLabel":"enum\u003cstring>"}},"required":["buy_quantity","get_quantity","condition"],"uniqueKey":"content.promotion.details.oneOf.2.products.items.[INDEX].slabs.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"content.promotion.details.oneOf.2.products.items.[INDEX].slabs","typeLabel":"object[]"},"sku":{"oneOf":[{"type":"string","readOnly":true,"uniqueKey":"content.promotion.details.oneOf.2.products.items.[INDEX].sku.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"uniqueKey":"content.promotion.details.oneOf.2.products.items.[INDEX].sku.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.promotion.details.oneOf.2.products.items.[INDEX].sku","typeLabel":"string | null"},"product_name":{"type":"string","readOnly":true,"uniqueKey":"content.promotion.details.oneOf.2.products.items.[INDEX].product_name","typeLabel":"string"},"status":{"type":"string","readOnly":true,"uniqueKey":"content.promotion.details.oneOf.2.products.items.[INDEX].status","typeLabel":"string"},"stock_available":{"type":"string","readOnly":true,"uniqueKey":"content.promotion.details.oneOf.2.products.items.[INDEX].stock_available","typeLabel":"string"},"images":{"type":"string","readOnly":true,"uniqueKey":"content.promotion.details.oneOf.2.products.items.[INDEX].images","typeLabel":"string"},"auto_scale":{"type":"boolean","readOnly":true,"uniqueKey":"content.promotion.details.oneOf.2.products.items.[INDEX].auto_scale","typeLabel":"boolean"}},"uniqueKey":"content.promotion.details.oneOf.2.products.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"content.promotion.details.oneOf.2.products","typeLabel":"object[]"}},"uniqueKey":"content.promotion.details.oneOf.2","typeLabel":"CustomSlabsBasedOnQuantity · object"},{"type":"object","title":"CustomSlabsBasedOnAmount","description":"Promotion rules; shape depends on `promotion_type`.","required":["spending_criteria_type","products"],"x-tags":["Coupons \u0026 promotions"],"properties":{"spending_criteria_type":{"type":"string","const":"minimum-purchase-amount","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.3.spending_criteria_type","typeLabel":"string"},"products":{"type":"array","items":{"type":"object","required":["product_id","variant_id","slabs"],"properties":{"product_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.3.products.items.[INDEX].product_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.3.products.items.[INDEX].product_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.promotion.details.oneOf.3.products.items.[INDEX].product_id","typeLabel":"string | null"},"variant_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.3.products.items.[INDEX].variant_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.3.products.items.[INDEX].variant_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.promotion.details.oneOf.3.products.items.[INDEX].variant_id","typeLabel":"string | null"},"slabs":{"type":"array","items":{"type":"object","properties":{"minimum_purchase_amount":{"type":"number","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.3.products.items.[INDEX].slabs.items.[INDEX].minimum_purchase_amount","typeLabel":"number"},"get_quantity":{"type":"integer","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.3.products.items.[INDEX].slabs.items.[INDEX].get_quantity","typeLabel":"integer"},"condition":{"enum":["greater-or-equal"],"type":"string","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.3.products.items.[INDEX].slabs.items.[INDEX].condition","typeLabel":"enum\u003cstring>"}},"required":["minimum_purchase_amount","get_quantity","condition"],"uniqueKey":"content.promotion.details.oneOf.3.products.items.[INDEX].slabs.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"content.promotion.details.oneOf.3.products.items.[INDEX].slabs","typeLabel":"object[]"},"sku":{"oneOf":[{"type":"string","readOnly":true,"uniqueKey":"content.promotion.details.oneOf.3.products.items.[INDEX].sku.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"uniqueKey":"content.promotion.details.oneOf.3.products.items.[INDEX].sku.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.promotion.details.oneOf.3.products.items.[INDEX].sku","typeLabel":"string | null"},"product_name":{"type":"string","readOnly":true,"uniqueKey":"content.promotion.details.oneOf.3.products.items.[INDEX].product_name","typeLabel":"string"},"status":{"type":"string","readOnly":true,"uniqueKey":"content.promotion.details.oneOf.3.products.items.[INDEX].status","typeLabel":"string"},"stock_available":{"type":"string","readOnly":true,"uniqueKey":"content.promotion.details.oneOf.3.products.items.[INDEX].stock_available","typeLabel":"string"},"images":{"type":"string","readOnly":true,"uniqueKey":"content.promotion.details.oneOf.3.products.items.[INDEX].images","typeLabel":"string"},"auto_scale":{"type":"boolean","readOnly":true,"uniqueKey":"content.promotion.details.oneOf.3.products.items.[INDEX].auto_scale","typeLabel":"boolean"}},"uniqueKey":"content.promotion.details.oneOf.3.products.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"content.promotion.details.oneOf.3.products","typeLabel":"object[]"}},"uniqueKey":"content.promotion.details.oneOf.3","typeLabel":"CustomSlabsBasedOnAmount · object"},{"type":"object","title":"BuyXGetYRuleBasedOnQuantity","description":"Promotion rules; shape depends on `promotion_type`.","required":["spending_criteria_type","products","maximum_discount_amount"],"x-tags":["Coupons \u0026 promotions"],"properties":{"spending_criteria_type":{"type":"string","const":"minimum-quantity","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.4.spending_criteria_type","typeLabel":"string"},"products":{"type":"array","items":{"type":"object","required":["minimum_quantity","buy_product_id","buy_variant_id","buy_from_category_id","get_product_id","get_variant_id","get_from_category_id","get_quantity","get_offer_type","get_discount_percent"],"properties":{"minimum_quantity":{"type":"integer","minimum":1,"isRequired":true,"uniqueKey":"content.promotion.details.oneOf.4.products.items.[INDEX].minimum_quantity","typeLabel":"integer"},"buy_product_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.4.products.items.[INDEX].buy_product_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.4.products.items.[INDEX].buy_product_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.promotion.details.oneOf.4.products.items.[INDEX].buy_product_id","typeLabel":"string | null"},"buy_variant_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.4.products.items.[INDEX].buy_variant_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.4.products.items.[INDEX].buy_variant_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.promotion.details.oneOf.4.products.items.[INDEX].buy_variant_id","typeLabel":"string | null"},"buy_from_category_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.4.products.items.[INDEX].buy_from_category_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.4.products.items.[INDEX].buy_from_category_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.promotion.details.oneOf.4.products.items.[INDEX].buy_from_category_id","typeLabel":"string | null"},"get_product_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.4.products.items.[INDEX].get_product_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.4.products.items.[INDEX].get_product_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.promotion.details.oneOf.4.products.items.[INDEX].get_product_id","typeLabel":"string | null"},"get_variant_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.4.products.items.[INDEX].get_variant_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.4.products.items.[INDEX].get_variant_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.promotion.details.oneOf.4.products.items.[INDEX].get_variant_id","typeLabel":"string | null"},"get_from_category_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.4.products.items.[INDEX].get_from_category_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.4.products.items.[INDEX].get_from_category_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.promotion.details.oneOf.4.products.items.[INDEX].get_from_category_id","typeLabel":"string | null"},"get_quantity":{"type":"integer","minimum":1,"isRequired":true,"uniqueKey":"content.promotion.details.oneOf.4.products.items.[INDEX].get_quantity","typeLabel":"integer"},"get_offer_type":{"enum":["discount","free"],"type":"string","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.4.products.items.[INDEX].get_offer_type","typeLabel":"enum\u003cstring>"},"get_discount_percent":{"oneOf":[{"description":"It can be null for get_offer_type = free","type":"number","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.4.products.items.[INDEX].get_discount_percent.oneOf.0","typeLabel":"number"},{"description":"It can be null for get_offer_type = free","type":"null","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.4.products.items.[INDEX].get_discount_percent.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.promotion.details.oneOf.4.products.items.[INDEX].get_discount_percent","typeLabel":"number | null"},"minimum_purchase_amount":{"oneOf":[{"type":"number","readOnly":true,"uniqueKey":"content.promotion.details.oneOf.4.products.items.[INDEX].minimum_purchase_amount.oneOf.0","typeLabel":"number"},{"type":"null","readOnly":true,"uniqueKey":"content.promotion.details.oneOf.4.products.items.[INDEX].minimum_purchase_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.promotion.details.oneOf.4.products.items.[INDEX].minimum_purchase_amount","typeLabel":"number | null"},"auto_scale":{"type":"boolean","readOnly":true,"uniqueKey":"content.promotion.details.oneOf.4.products.items.[INDEX].auto_scale","typeLabel":"boolean"}},"uniqueKey":"content.promotion.details.oneOf.4.products.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"content.promotion.details.oneOf.4.products","typeLabel":"object[]"},"maximum_discount_amount":{"oneOf":[{"description":"It can be null for get_offer_type = free","type":"number","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.4.maximum_discount_amount.oneOf.0","typeLabel":"number"},{"description":"It can be null for get_offer_type = free","type":"null","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.4.maximum_discount_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.promotion.details.oneOf.4.maximum_discount_amount","typeLabel":"number | null"}},"uniqueKey":"content.promotion.details.oneOf.4","typeLabel":"BuyXGetYRuleBasedOnQuantity · object"},{"type":"object","title":"BuyXGetYRuleBasedOnAmount","description":"Promotion rules; shape depends on `promotion_type`.","required":["spending_criteria_type","products","maximum_discount_amount"],"x-tags":["Coupons \u0026 promotions"],"properties":{"spending_criteria_type":{"type":"string","const":"minimum-purchase-amount","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.5.spending_criteria_type","typeLabel":"string"},"products":{"type":"array","items":{"type":"object","required":["minimum_purchase_amount","buy_product_id","buy_variant_id","buy_from_category_id","get_product_id","get_variant_id","get_from_category_id","get_quantity","get_offer_type","get_discount_percent"],"properties":{"minimum_purchase_amount":{"type":"number","minimum":1,"isRequired":true,"uniqueKey":"content.promotion.details.oneOf.5.products.items.[INDEX].minimum_purchase_amount","typeLabel":"number"},"buy_product_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.5.products.items.[INDEX].buy_product_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.5.products.items.[INDEX].buy_product_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.promotion.details.oneOf.5.products.items.[INDEX].buy_product_id","typeLabel":"string | null"},"buy_variant_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.5.products.items.[INDEX].buy_variant_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.5.products.items.[INDEX].buy_variant_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.promotion.details.oneOf.5.products.items.[INDEX].buy_variant_id","typeLabel":"string | null"},"buy_from_category_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.5.products.items.[INDEX].buy_from_category_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.5.products.items.[INDEX].buy_from_category_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.promotion.details.oneOf.5.products.items.[INDEX].buy_from_category_id","typeLabel":"string | null"},"get_product_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.5.products.items.[INDEX].get_product_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.5.products.items.[INDEX].get_product_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.promotion.details.oneOf.5.products.items.[INDEX].get_product_id","typeLabel":"string | null"},"get_variant_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.5.products.items.[INDEX].get_variant_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.5.products.items.[INDEX].get_variant_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.promotion.details.oneOf.5.products.items.[INDEX].get_variant_id","typeLabel":"string | null"},"get_from_category_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.5.products.items.[INDEX].get_from_category_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.5.products.items.[INDEX].get_from_category_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.promotion.details.oneOf.5.products.items.[INDEX].get_from_category_id","typeLabel":"string | null"},"get_quantity":{"type":"integer","minimum":1,"isRequired":true,"uniqueKey":"content.promotion.details.oneOf.5.products.items.[INDEX].get_quantity","typeLabel":"integer"},"get_offer_type":{"enum":["discount","free"],"type":"string","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.5.products.items.[INDEX].get_offer_type","typeLabel":"enum\u003cstring>"},"get_discount_percent":{"oneOf":[{"description":"It can be null for get_offer_type = free","type":"number","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.5.products.items.[INDEX].get_discount_percent.oneOf.0","typeLabel":"number"},{"description":"It can be null for get_offer_type = free","type":"null","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.5.products.items.[INDEX].get_discount_percent.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.promotion.details.oneOf.5.products.items.[INDEX].get_discount_percent","typeLabel":"number | null"},"auto_scale":{"type":"boolean","readOnly":true,"uniqueKey":"content.promotion.details.oneOf.5.products.items.[INDEX].auto_scale","typeLabel":"boolean"}},"uniqueKey":"content.promotion.details.oneOf.5.products.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"content.promotion.details.oneOf.5.products","typeLabel":"object[]"},"maximum_discount_amount":{"oneOf":[{"description":"It can be null for get_offer_type = free","type":"number","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.5.maximum_discount_amount.oneOf.0","typeLabel":"number"},{"description":"It can be null for get_offer_type = free","type":"null","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.5.maximum_discount_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.promotion.details.oneOf.5.maximum_discount_amount","typeLabel":"number | null"}},"uniqueKey":"content.promotion.details.oneOf.5","typeLabel":"BuyXGetYRuleBasedOnAmount · object"},{"type":"object","title":"DiscountRule","description":"Promotion rules; shape depends on `promotion_type`.","required":["discount_type","products","category_id"],"x-tags":["Coupons \u0026 promotions"],"properties":{"discount_type":{"type":"string","enum":["percentage","fixed-amount"],"isRequired":true,"uniqueKey":"content.promotion.details.oneOf.6.discount_type","typeLabel":"enum\u003cstring>"},"products":{"type":"array","items":{"type":"object","properties":{"sku":{"oneOf":[{"type":"string","readOnly":true,"uniqueKey":"content.promotion.details.oneOf.6.products.items.[INDEX].sku.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"uniqueKey":"content.promotion.details.oneOf.6.products.items.[INDEX].sku.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.promotion.details.oneOf.6.products.items.[INDEX].sku","typeLabel":"string | null"},"product_name":{"type":"string","readOnly":true,"uniqueKey":"content.promotion.details.oneOf.6.products.items.[INDEX].product_name","typeLabel":"string"},"status":{"type":"string","readOnly":true,"uniqueKey":"content.promotion.details.oneOf.6.products.items.[INDEX].status","typeLabel":"string"},"stock_available":{"type":"string","readOnly":true,"uniqueKey":"content.promotion.details.oneOf.6.products.items.[INDEX].stock_available","typeLabel":"string"},"images":{"type":"string","readOnly":true,"uniqueKey":"content.promotion.details.oneOf.6.products.items.[INDEX].images","typeLabel":"string"},"product_id":{"oneOf":[{"type":"string","uniqueKey":"content.promotion.details.oneOf.6.products.items.[INDEX].product_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"content.promotion.details.oneOf.6.products.items.[INDEX].product_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.promotion.details.oneOf.6.products.items.[INDEX].product_id","typeLabel":"string | null"},"variant_id":{"oneOf":[{"type":"string","uniqueKey":"content.promotion.details.oneOf.6.products.items.[INDEX].variant_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"content.promotion.details.oneOf.6.products.items.[INDEX].variant_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.promotion.details.oneOf.6.products.items.[INDEX].variant_id","typeLabel":"string | null"},"minimum_quantity":{"oneOf":[{"type":"integer","uniqueKey":"content.promotion.details.oneOf.6.products.items.[INDEX].minimum_quantity.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"content.promotion.details.oneOf.6.products.items.[INDEX].minimum_quantity.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.promotion.details.oneOf.6.products.items.[INDEX].minimum_quantity","typeLabel":"integer | null"},"maximum_quantity":{"oneOf":[{"type":"integer","uniqueKey":"content.promotion.details.oneOf.6.products.items.[INDEX].maximum_quantity.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"content.promotion.details.oneOf.6.products.items.[INDEX].maximum_quantity.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.promotion.details.oneOf.6.products.items.[INDEX].maximum_quantity","typeLabel":"integer | null"},"minimum_value":{"oneOf":[{"type":"number","uniqueKey":"content.promotion.details.oneOf.6.products.items.[INDEX].minimum_value.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"content.promotion.details.oneOf.6.products.items.[INDEX].minimum_value.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.promotion.details.oneOf.6.products.items.[INDEX].minimum_value","typeLabel":"number | null"},"maximum_value":{"oneOf":[{"type":"number","uniqueKey":"content.promotion.details.oneOf.6.products.items.[INDEX].maximum_value.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"content.promotion.details.oneOf.6.products.items.[INDEX].maximum_value.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.promotion.details.oneOf.6.products.items.[INDEX].maximum_value","typeLabel":"number | null"},"minimum_purchase_amount":{"oneOf":[{"type":"number","readOnly":true,"uniqueKey":"content.promotion.details.oneOf.6.products.items.[INDEX].minimum_purchase_amount.oneOf.0","typeLabel":"number"},{"type":"null","readOnly":true,"uniqueKey":"content.promotion.details.oneOf.6.products.items.[INDEX].minimum_purchase_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.promotion.details.oneOf.6.products.items.[INDEX].minimum_purchase_amount","typeLabel":"number | null"},"auto_scale":{"type":"boolean","readOnly":true,"uniqueKey":"content.promotion.details.oneOf.6.products.items.[INDEX].auto_scale","typeLabel":"boolean"}},"uniqueKey":"content.promotion.details.oneOf.6.products.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"content.promotion.details.oneOf.6.products","typeLabel":"object[]"},"category_id":{"description":"Array of category ids","type":"array","items":{"type":"string","uniqueKey":"content.promotion.details.oneOf.6.category_id.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"content.promotion.details.oneOf.6.category_id","typeLabel":"string[]"},"discount_percent":{"oneOf":[{"type":"number","uniqueKey":"content.promotion.details.oneOf.6.discount_percent.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"content.promotion.details.oneOf.6.discount_percent.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.promotion.details.oneOf.6.discount_percent","typeLabel":"number | null"},"fixed_discount_amount":{"oneOf":[{"type":"number","uniqueKey":"content.promotion.details.oneOf.6.fixed_discount_amount.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"content.promotion.details.oneOf.6.fixed_discount_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.promotion.details.oneOf.6.fixed_discount_amount","typeLabel":"number | null"},"maximum_discount_amount":{"oneOf":[{"type":"number","uniqueKey":"content.promotion.details.oneOf.6.maximum_discount_amount.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"content.promotion.details.oneOf.6.maximum_discount_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.promotion.details.oneOf.6.maximum_discount_amount","typeLabel":"number | null"},"sellers":{"description":"Marketplace seller ids the discount applies to. Required (at least one) when `applies_to_product` is `seller`, and accepted only on marketplace stores; empty or omitted otherwise.","type":"array","items":{"type":"string","uniqueKey":"content.promotion.details.oneOf.6.sellers.items.[INDEX]","typeLabel":"string"},"uniqueKey":"content.promotion.details.oneOf.6.sellers","typeLabel":"string[]"}},"uniqueKey":"content.promotion.details.oneOf.6","typeLabel":"DiscountRule · object"},{"type":"object","title":"VolumeBasedRule","description":"Promotion rules; shape depends on `promotion_type`.","required":["products","maximum_discount_amount"],"x-tags":["Coupons \u0026 promotions"],"properties":{"products":{"type":"array","items":{"type":"object","required":["product_id","variant_id","slabs"],"properties":{"product_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.7.products.items.[INDEX].product_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.7.products.items.[INDEX].product_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.promotion.details.oneOf.7.products.items.[INDEX].product_id","typeLabel":"string | null"},"variant_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.7.products.items.[INDEX].variant_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.7.products.items.[INDEX].variant_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.promotion.details.oneOf.7.products.items.[INDEX].variant_id","typeLabel":"string | null"},"slabs":{"type":"array","items":{"type":"object","required":["quantity","condition","discount_percent"],"properties":{"quantity":{"type":"integer","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.7.products.items.[INDEX].slabs.items.[INDEX].quantity","typeLabel":"integer"},"condition":{"enum":["less-or-equal","greater"],"type":"string","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.7.products.items.[INDEX].slabs.items.[INDEX].condition","typeLabel":"enum\u003cstring>"},"discount_percent":{"type":"number","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.7.products.items.[INDEX].slabs.items.[INDEX].discount_percent","typeLabel":"number"}},"uniqueKey":"content.promotion.details.oneOf.7.products.items.[INDEX].slabs.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"content.promotion.details.oneOf.7.products.items.[INDEX].slabs","typeLabel":"object[]"},"sku":{"oneOf":[{"type":"string","readOnly":true,"uniqueKey":"content.promotion.details.oneOf.7.products.items.[INDEX].sku.oneOf.0","typeLabel":"string"},{"type":"null","readOnly":true,"uniqueKey":"content.promotion.details.oneOf.7.products.items.[INDEX].sku.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.promotion.details.oneOf.7.products.items.[INDEX].sku","typeLabel":"string | null"},"product_name":{"type":"string","readOnly":true,"uniqueKey":"content.promotion.details.oneOf.7.products.items.[INDEX].product_name","typeLabel":"string"},"status":{"type":"string","readOnly":true,"uniqueKey":"content.promotion.details.oneOf.7.products.items.[INDEX].status","typeLabel":"string"},"stock_available":{"type":"string","readOnly":true,"uniqueKey":"content.promotion.details.oneOf.7.products.items.[INDEX].stock_available","typeLabel":"string"},"images":{"type":"string","readOnly":true,"uniqueKey":"content.promotion.details.oneOf.7.products.items.[INDEX].images","typeLabel":"string"}},"uniqueKey":"content.promotion.details.oneOf.7.products.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"content.promotion.details.oneOf.7.products","typeLabel":"object[]"},"maximum_discount_amount":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.7.maximum_discount_amount.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"content.promotion.details.oneOf.7.maximum_discount_amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.promotion.details.oneOf.7.maximum_discount_amount","typeLabel":"number | null"}},"uniqueKey":"content.promotion.details.oneOf.7","typeLabel":"VolumeBasedRule · object"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"content.promotion.details.oneOf.8.items.[INDEX]","typeLabel":"any"},"title":"FreeShippingDetails","description":"Promotion rules; shape depends on `promotion_type`.","default":[],"maxItems":0,"x-tags":["Coupons \u0026 promotions"],"uniqueKey":"content.promotion.details.oneOf.8","typeLabel":"any[]"},{"type":"null","title":"FreeShippingDetails","description":"Promotion rules; shape depends on `promotion_type`.","default":[],"maxItems":0,"x-tags":["Coupons \u0026 promotions"],"uniqueKey":"content.promotion.details.oneOf.9","typeLabel":"null"}],"uniqueKey":"content.promotion.details","typeLabel":"AutoScaleBasedOnQuantity · object | AutoScaleBasedOnAmount · object | CustomSlabsBasedOnQuantity · object | CustomSlabsBasedOnAmount · object | BuyXGetYRuleBasedOnQuantity · object | BuyXGetYRuleBasedOnAmount · object | DiscountRule · object | VolumeBasedRule · object | any[] | null"},"terms_and_conditions":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"content.promotion.terms_and_conditions.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"content.promotion.terms_and_conditions.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"uniqueKey":"content.promotion.terms_and_conditions.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.promotion.terms_and_conditions","typeLabel":"string[] | null"}},"uniqueKey":"content.promotion","typeLabel":"PromotionDetail · object"}},"type":"object","uniqueKey":"content","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","success":true,"content":{"promotion":{"name":"\u003cstring>","status":"draft","customer_eligibility":"all","starts_at":"2023-11-07T05:31:56Z","promotion_type":"discount","can_be_used_with_other_promotion":true,"id":"\u003cstring>","description":"\u003cstring>","tags":["\u003cstring>"],"active":true,"customer_id":["\u003cstring>"],"segment_id":["\u003cstring>"],"customer_group_id":["\u003cstring>"],"redemption_limits":{"total_redemptions":123,"per_customer_redemptions":123,"per_coupon_code_redemptions":123},"redemption_count":123,"minimum_order_total":0,"for_first_time_customer_only":false,"can_earn_loyalty_points":true,"can_redeem_loyalty_points":true,"expires_at":"2023-11-07T05:31:56Z","created_at":"2023-11-07T05:31:56Z","modified_at":"2023-11-07T05:31:56Z","store_id":"\u003cstring>","priority":3,"applies_to_product":"all","details":{"spending_criteria_type":"minimum-quantity","products":[{"product_id":"\u003cstring>","variant_id":"\u003cstring>","auto_scale":true,"slab":{"buy_quantity":123,"get_quantity":123,"condition":"greater-or-equal"},"sku":"\u003cstring>","product_name":"\u003cstring>","status":"\u003cstring>","stock_available":"\u003cstring>","images":"\u003cstring>"}]},"terms_and_conditions":["\u003cstring>"]}}}}},"exampleType":"generated"}},"exampleType":"generated"},"0fec9ee3-565f-4a13-b78c-0b2bc27f0dc6":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"success":{"type":"boolean","uniqueKey":"success","typeLabel":"boolean"},"code":{"type":"string","uniqueKey":"code","typeLabel":"string"},"errors":{"description":"Validation details keyed by field; business guards can return strings, while serializer errors commonly return arrays.","type":"object","additionalProperties":true,"uniqueKey":"errors","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","success":true,"code":"\u003cstring>","errors":{}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"429dd998-bf2c-4a43-ba52-45b1a1e5cfec":{"Authorization":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"Authorization"}}},"servers":{"87850fd8-1faa-4b54-8be4-6c97c953f0a6":{"url":"https://staging.api.commercengine.io/api/v1/{store_id}/admin","description":"Staging Server","variables":{"store_id":{"default":"store_id","description":"Store ID"}}},"bfc441d1-681c-4d0f-b4bf-6ec5868ce7d9":{"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":"Update promotion - Commerce Engine Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-15T08:45:38.028Z","originalFileLocation":"admin/api-reference/coupons-\u0026-promotions/update-promotion.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=\"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=\"Update promotion - Commerce Engine Docs\">\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/coupons-\u0026amp;-promotions/update-promotion\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://tarkai.mintlify.site/docs/_mintlify/api/og/v2?division=Coupons+%26+promotions\u0026amp;title=Update+promotion\u0026amp;theme=76e8f8f14f90cfb8929bc40a\u0026amp;signature=85fd2147af2c7c14a3309aa97d63304d31a0fdeffbaf6be85e86e6352bcea072\">\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=\"Update promotion - Commerce Engine Docs\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://tarkai.mintlify.site/docs/_mintlify/api/og/v2?division=Coupons+%26+promotions\u0026amp;title=Update+promotion\u0026amp;theme=76e8f8f14f90cfb8929bc40a\u0026amp;signature=85fd2147af2c7c14a3309aa97d63304d31a0fdeffbaf6be85e86e6352bcea072\">\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/coupons-\u0026amp;-promotions/update-promotion\">\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/coupons-%26-promotions/update-promotion.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/coupons-\u0026-promotions/update-promotion#webpage\",\"url\":\"https://www.commercengine.io/docs/admin/api-reference/coupons-\u0026-promotions/update-promotion\",\"name\":\"Update promotion\",\"dateModified\":\"2026-11-15T08:45:38.028Z\",\"isPartOf\":{\"@id\":\"https://www.commercengine.io/docs#website\"},\"breadcrumb\":{\"@id\":\"https://www.commercengine.io/docs/admin/api-reference/coupons-\u0026-promotions/update-promotion#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://www.commercengine.io/docs/admin/api-reference/coupons-\u0026-promotions/update-promotion#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Shopping\",\"item\":\"https://www.commercengine.io/docs/admin/api-reference/carts/list-all-abandoned-carts\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Coupons \u0026 promotions\",\"item\":\"https://www.commercengine.io/docs/admin/api-reference/coupons-\u0026-promotions/list-all-coupons\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Update promotion\",\"item\":\"https://www.commercengine.io/docs/admin/api-reference/coupons-\u0026-promotions/update-promotion\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://www.commercengine.io/docs/admin/api-reference/coupons-\u0026-promotions/update-promotion#apireference\",\"headline\":\"Update promotion\",\"name\":\"Update promotion\",\"url\":\"https://www.commercengine.io/docs/admin/api-reference/coupons-\u0026-promotions/update-promotion\",\"mainEntityOfPage\":{\"@id\":\"https://www.commercengine.io/docs/admin/api-reference/coupons-\u0026-promotions/update-promotion#webpage\"},\"dateModified\":\"2026-11-15T08:45:38.028Z\",\"publisher\":{\"@id\":\"https://www.commercengine.io/#organization\"},\"isPartOf\":{\"@id\":\"https://www.commercengine.io/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Commerce Engine Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Commerce Engine Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/docs/admin/api-reference/coupons-%26-promotions/update-promotion.md","siteName":"Commerce Engine Docs","nav":{"global":null,"tabs":[{"tab":"Guides","icon":"book-open-cover","menu":[{"item":"Quickstart","icon":"rocket","description":"Get your keys, then make your first API call in under 15 minutes.","pages":[{"title":"Quickstart","href":"/storefront/quickstart"}]},{"item":"Starters","icon":"rocket","description":"Three production storefronts, each cloned across five frameworks.","pages":[{"title":"Starters","href":"/starters/overview"}]},{"item":"AI-assisted development","icon":"wand-magic-sparkles","description":"Skills, prompts and starters for coding agents.","pages":[{"title":"AI-assisted development","href":"/ai/overview"}]},{"item":"AI apps","icon":"plug","description":"Manage your store from Claude, ChatGPT, Codex and other AI apps.","pages":[{"title":"AI apps","href":"/ai/mcp-connector"}]},{"item":"Storefront","icon":"store","description":"Auth, catalog, cart, checkout, account and subscriptions.","pages":[{"title":"Storefront","href":"/storefront/authentication"}]},{"item":"API guides","icon":"code","description":"Authentication, POS setup and webhook delivery.","pages":[{"title":"API guides","href":"/api-reference/getting-started"}]},{"item":"Hosted checkout","icon":"bag-shopping","description":"Drop-in embeddable cart and checkout for any stack.","pages":[{"title":"Hosted checkout","href":"/hosted-checkout/overview"}]},{"item":"SEO \u0026 AEO","icon":"magnifying-glass","description":"Structured data, canonical metadata, sitemaps and llms.txt.","pages":[{"title":"SEO \u0026 AEO","href":"/seo-ai/overview"}]},{"item":"Agent tools","icon":"robot","description":"WebMCP tools that let browser agents shop your store.","pages":[{"title":"Agent tools","href":"/seo-ai/ai"}]}],"pages":[{"title":"Guides","href":"/storefront/quickstart"}]},{"tab":"Hosted Checkout","icon":"bag-shopping","pages":[{"title":"Hosted Checkout","href":"/hosted-checkout/overview"}]},{"tab":"Packages","icon":"cube","menu":[{"item":"storefront","icon":"box","description":"Framework wrappers for React, Next.js, SvelteKit and Astro.","pages":[{"title":"storefront","href":"/sdk/installation"}]},{"item":"ssr-utils","icon":"server","description":"Framework-agnostic cookie-backed SSR session utilities.","pages":[{"title":"ssr-utils","href":"/sdk/ssr-utils"}]},{"item":"checkout","icon":"bag-shopping","description":"Universal checkout SDK — hosted, embedded or headless.","pages":[{"title":"checkout","href":"/hosted-checkout/overview"}]},{"item":"pos","icon":"cash-register","description":"TypeScript SDK for the POS API, for in-store selling.","pages":[{"title":"pos","href":"/pos/overview"}]},{"item":"analytics","icon":"chart-line","description":"Zero-dependency mappers for canonical commerce events.","pages":[{"title":"analytics","href":"/hosted-checkout/analytics"}]},{"item":"seo","icon":"magnifying-glass","description":"Opinionated SEO, AEO, structured data and Markdown output.","pages":[{"title":"seo","href":"/seo-ai/overview"}]},{"item":"ai","icon":"wand-magic-sparkles","description":"Browser-native agent tools (WebMCP) for storefronts.","pages":[{"title":"ai","href":"/seo-ai/ai"}]},{"item":"Browse all packages","icon":"grid-2","description":"Every published Commerce Engine package on npm.","href":"https://www.npmjs.com/org/commercengine"}],"pages":[{"title":"Packages","href":"/sdk/installation"}]},{"tab":"API Reference","icon":"code","menu":[{"item":"Storefront API","icon":"store","description":"Everything a storefront calls — catalog, cart, checkout, auth, orders.","pages":[{"title":"Storefront API","href":"/api-reference/authentication/create-anonymous-session"}]},{"item":"POS API","icon":"cash-register","description":"Point of sale — staff login, device pairing, carts, catalog and order capture on the storefront base URL.","pages":[{"title":"POS API","href":"/api-reference/pos/devices/pair-pos-device"}]},{"item":"Webhooks","icon":"webhook","description":"Events Commerce Engine delivers to your endpoints — orders, payments, shipments, catalog, customers, store and marketplace.","pages":[{"title":"Webhooks","href":"/api-reference/webhooks/orders/checkout-completed"}]},{"item":"Admin API","icon":"gear","description":"Back-office operations — catalog management, customers, fulfilment, store settings.","groups":[{"group":"Catalog","pages":[{"group":"Products","pages":[{"title":"List all products","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /catalog/products","href":"/admin/api-reference/products/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/products/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/products/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/products/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/products/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/products/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/products/bulk-update-products"},{"title":"Retrieve product details","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /catalog/products/{id}","href":"/admin/api-reference/products/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/products/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/products/delete-product"},{"title":"List all SKUs","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /catalog/skus","href":"/admin/api-reference/products/list-all-skus"}]},{"group":"Variants","pages":[{"title":"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/variants/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/variants/create-variant"},{"title":"Update variants in bulk","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json put /catalog/products/{id}/variants/bulk-update","href":"/admin/api-reference/variants/update-variants-in-bulk"},{"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/variants/retrieve-a-variant-details"},{"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/variants/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/variants/delete-a-variant"}]},{"group":"Categories","pages":[{"title":"List all categories","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /catalog/categories","href":"/admin/api-reference/categories/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/categories/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/categories/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/categories/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/categories/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/categories/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/categories/create-or-update-category-attributes"}]},{"group":"Product attributes","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/product-attributes/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/product-attributes/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/product-attributes/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/product-attributes/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/product-attributes/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/product-attributes/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/product-attributes/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/product-attributes/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/product-attributes/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/product-attributes/delete-attribute"}]},{"group":"Inventory","pages":[{"title":"List all inventories","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /catalog/inventories","href":"/admin/api-reference/inventory/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/inventory/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/inventory/retrieve-inventory-detail"},{"title":"Check inventory","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /catalog/products/check-inventory","href":"/admin/api-reference/inventory/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/inventory/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/inventory/stock-out-products-or-variants"},{"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/inventory/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/inventory/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/inventory/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/inventory/create-inventory-activity"}]},{"group":"Reviews","pages":[{"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/reviews/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/reviews/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/reviews/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/reviews/delete-product-review"}]},{"group":"Media","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/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/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/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/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/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/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/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/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/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/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/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/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/delete-folder"}]},{"group":"Catalog jobs","pages":[{"title":"List catalog jobs","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /catalog/jobs","href":"/admin/api-reference/catalog-jobs/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-jobs/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-jobs/get-catalog-job"}]}]},{"group":"Customers","pages":[{"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":"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"},{"title":"Upload customer profile image","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /customers/{id}/profile-image","href":"/admin/api-reference/customers/upload-customer-profile-image"}]},{"group":"Users","pages":[{"title":"List customer users","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /customers/{id}/users","href":"/admin/api-reference/users/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/users/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/users/deactivate-a-customer-user"}]},{"group":"Customer attributes","pages":[{"title":"List all attributes","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /customers/attributes","href":"/admin/api-reference/customer-attributes/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/customer-attributes/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/customer-attributes/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/customer-attributes/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/customer-attributes/delete-an-attribute"},{"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/customer-attributes/list-all-customer-attributes"},{"title":"Set several attribute values","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json put /customers/{id}/attributes","href":"/admin/api-reference/customer-attributes/set-several-attribute-values"},{"title":"Create an attribute","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /customers/{id}/attributes","href":"/admin/api-reference/customer-attributes/create-an-attribute-1"},{"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/customer-attributes/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/customer-attributes/delete-customer-attribute"}]},{"group":"Customer groups","pages":[{"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/customer-groups/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/customer-groups/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/customer-groups/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/customer-groups/delete-customer-group"}]},{"group":"Addresses","pages":[{"title":"List all addresses","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /customers/{id}/addresses","href":"/admin/api-reference/addresses/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/addresses/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/addresses/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/addresses/delete-address"}]},{"group":"Bank accounts","pages":[{"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/bank-accounts/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/bank-accounts/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/bank-accounts/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/bank-accounts/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/bank-accounts/delete-bank-account"}]},{"group":"KYC documents","pages":[{"title":"List all documents","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /customers/{id}/documents","href":"/admin/api-reference/kyc-documents/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/kyc-documents/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/kyc-documents/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/kyc-documents/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/kyc-documents/delete-document"},{"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/kyc-documents/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/kyc-documents/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/kyc-documents/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/kyc-documents/delete-kyc-document"}]},{"group":"Visitors","pages":[{"title":"List all visitors","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /customers/visitors","href":"/admin/api-reference/visitors/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/visitors/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/visitors/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/visitors/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/visitors/create-an-attribute"},{"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/visitors/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/visitors/delete-visitor-attribute"}]},{"group":"Loyalty","pages":[{"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/loyalty/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/loyalty/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/loyalty/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/loyalty/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/loyalty/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/loyalty/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/loyalty/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/loyalty/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/loyalty/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/loyalty/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/loyalty/resume-loyalty-program"},{"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/loyalty/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/loyalty/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/loyalty/list-all-loyalty-tier-activities"}]},{"group":"Credit","pages":[{"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/credit/set-credit-line-eligibility"},{"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/credit/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/credit/get-credit-line-balance"}]},{"group":"Mandates","pages":[{"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/mandates/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/mandates/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/mandates/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/mandates/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/mandates/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/mandates/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/mandates/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/mandates/revoke-mandate"}]},{"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":"Shopping","pages":[{"group":"Carts","pages":[{"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/carts/list-all-abandoned-carts"}]},{"group":"Subscriptions","pages":[{"title":"List all subscriptions","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /orders/subscriptions","href":"/admin/api-reference/subscriptions/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/subscriptions/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/subscriptions/list-all-subscription-customers"}]},{"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","description":"Returns a complete `PromotionDetail` object, including eligibility, redemption limits, and type-specific `details`.","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","description":"Delete specific 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":[{"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 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":"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"}]},{"group":"Invoices","pages":[{"title":"List all invoices","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /orders/invoices","href":"/admin/api-reference/invoices/list-all-invoices"},{"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/invoices/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/invoices/retrieve-order-receipt"}]},{"group":"Returns","pages":[{"title":"List return requests","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /orders/returns","href":"/admin/api-reference/returns/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/returns/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/returns/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/returns/reject-a-return-request"}]},{"group":"Shipments","pages":[{"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/shipments/retrieve-order-shipments"},{"title":"List all shipments","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /shipping/shipments","href":"/admin/api-reference/shipments/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/shipments/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/shipments/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/shipments/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/shipments/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/shipments/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/shipments/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/shipments/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/shipments/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/shipments/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/shipments/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/shipments/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/shipments/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/shipments/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/shipments/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/shipments/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/shipments/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/shipments/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/shipments/tracking-shipment"}]}]},{"group":"Payments","pages":[{"group":"Order 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/order-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/order-payments/create-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/order-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/order-payments/cancel-payment"},{"title":"Cancel an order payment request","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /orders/{order_number}/payments/{request_number}/cancel","href":"/admin/api-reference/order-payments/cancel-an-order-payment-request"},{"title":"Mark an order payment paid","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /orders/{order_number}/payments/{request_number}/mark-paid","href":"/admin/api-reference/order-payments/mark-an-order-payment-paid"},{"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/order-payments/verify-order-payment"}]},{"group":"Refunds","pages":[{"title":"Refund payment","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /orders/payments/refund","href":"/admin/api-reference/refunds/refund-payment"},{"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/refunds/estimate-refund-for-a-shipment-or-order"},{"title":"Forfeit an order refund","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /orders/{order_number}/refunds/{request_number}/cancel","href":"/admin/api-reference/refunds/forfeit-an-order-refund"},{"title":"Mark an order refund paid","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /orders/{order_number}/refunds/{request_number}/mark-paid","href":"/admin/api-reference/refunds/mark-an-order-refund-paid"}]},{"group":"Payment exceptions","pages":[{"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/payment-exceptions/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/payment-exceptions/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/payment-exceptions/resolve-a-payment-exception"}]},{"group":"Payment methods","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/payment-methods/list-available-payment-options"},{"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/payment-methods/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/payment-methods/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/payment-methods/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/payment-methods/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/payment-methods/delete-manual-payment-method"}]},{"group":"Seller 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/seller-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/seller-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/seller-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/seller-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/seller-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/seller-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/seller-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/seller-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/seller-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/seller-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/seller-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/seller-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/seller-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/seller-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/seller-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/seller-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/seller-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/seller-payouts/unhold-seller-payout-invoices"}]}]},{"group":"Marketplace","pages":[{"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"}]},{"group":"Marketplace listings","pages":[{"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/marketplace-listings/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/marketplace-listings/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/marketplace-listings/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/marketplace-listings/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/marketplace-listings/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/marketplace-listings/unlist-products-on-marketplace"}]},{"group":"Marketplace settings","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-settings/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-settings/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-settings/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-settings/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-settings/retrieve-marketplace-config"}]},{"group":"Sellers","pages":[{"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/sellers/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/sellers/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/sellers/unauthorize-a-seller-for-a-customer"}]}]},{"group":"Fulfillment","pages":[{"group":"Shipping methods","pages":[{"title":"Courier Serviceability","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json post /shipping/serviceability","href":"/admin/api-reference/shipping-methods/courier-serviceability"},{"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/shipping-methods/list-all-available-shipping-options"},{"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/shipping-methods/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/shipping-methods/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/shipping-methods/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/shipping-methods/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/shipping-methods/delete-manual-shipping-method"},{"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/shipping-methods/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/shipping-methods/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/shipping-methods/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/shipping-methods/remove-shipping-options"}]},{"group":"Shipping boxes","pages":[{"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/shipping-boxes/list-all-shipper-boxes"},{"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/shipping-boxes/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/shipping-boxes/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/shipping-boxes/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/shipping-boxes/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/shipping-boxes/delete-shipping-box"}]},{"group":"Shipping zones","pages":[{"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/shipping-zones/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/shipping-zones/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/shipping-zones/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/shipping-zones/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/shipping-zones/delete-shipping-zone"}]},{"group":"Warehouses","pages":[{"title":"List all warehouses","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /store/warehouses","href":"/admin/api-reference/warehouses/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/warehouses/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/warehouses/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/warehouses/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/warehouses/delete-warehouse"}]}]},{"group":"Point of sale","pages":[{"group":"Devices","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/devices/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/devices/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/devices/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/devices/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/devices/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/devices/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/devices/revoke-pos-device"}]},{"group":"Staff","pages":[{"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-users/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-users/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-users/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-users/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-users/delete-pos-user"}]},{"group":"Roles \u0026 permissions","pages":[{"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-roles/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-roles/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-roles/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-roles/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-roles/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-roles/delete-pos-role"}]}]},{"group":"Store","pages":[{"group":"Store","pages":[{"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"}]},{"group":"Locations","pages":[{"title":"List all countries","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /store/countries","href":"/admin/api-reference/locations/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/locations/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/locations/list-all-states"}]},{"group":"Notifications","pages":[{"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/notifications/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/notifications/update-notification-preferences"},{"title":"List all templates","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /store/templates","href":"/admin/api-reference/notifications/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/notifications/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/notifications/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/notifications/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/notifications/delete-template"}]},{"group":"Downloads","pages":[{"title":"List all download jobs","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /store/downloads","href":"/admin/api-reference/downloads/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/downloads/create-download-request"}]},{"group":"Search","pages":[{"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/search/global-search-across-customers-orders-and-products"}]},{"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":"Integrations","pages":[{"group":"Catalog integrations","pages":[{"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-integrations/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-integrations/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-integrations/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-integrations/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-integrations/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-integrations/list-all-item-sync-activity"}]},{"group":"Service providers","pages":[{"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/service-providers/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/service-providers/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/service-providers/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/service-providers/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/service-providers/test-service-provider-config"}]},{"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":"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":"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"}]},{"group":"Webhook deliveries","pages":[{"title":"List All Deliveries Log","deprecated":null,"version":null,"openapi":"https://openapi.commercengine.io/ce-admin.json get /webhooks/deliveries","href":"/admin/api-reference/webhook-deliveries/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/webhook-deliveries/get-delivery-log-detail"},{"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/webhook-deliveries/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/webhook-deliveries/replay-event-to-webhook"}]},{"group":"Events","pages":[{"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/events/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/events/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/events/get-event-details"}]},{"group":"Live updates","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/live-updates/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/live-updates/retrieve-live-events"}]}]},{"group":"Analytics","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":"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"}]}]}]}]}]},"basePath":"","title":"Update promotion - Commerce Engine Docs","buildId":"dpl_Aw98ji4XvBsgtZwL1VrkUF9ehFqz","deploymentId":"dpl_Aw98ji4XvBsgtZwL1VrkUF9ehFqz","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-CQGbdtm4.js","utils-D88A1f-Z.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-ChqWdz1A.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-yBrxdh_6.js","snippetPresets-BgqDrFJC.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-C2-BijcO.js","ApiExamples-Duxc2rZw.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C7jidOil.js","shallow-xkjpHm-U.js","getApiPlaygroundDisplay-fE3rVpvL.js","CodeSnippet-LgxljKed.js","CodeSnippets-D-pXWDHq.js","getPastedJson-CLRcu-uo.js","icon-Cxirpjgo.js","MethodPill-D49eqY5e.js","DuplicateIcon-CivCz5Rp.js","createIcon-D71qL3f5.js","DynamicMarkdown-BcGRTrw6.js","SectionHeading-DzaqmmSD.js","axios-vUo_bRtp.js","Markdown-CZqUYmMp.js","clsx-B6IZIRsp.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-B0ZV6X5T.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-MqLyPtsW.js"]}