Create a draft campaign. ownerId and approverId must be members of the organization, and every store must already be connected. Requires promotions:write.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"OmniCommerce","description":"Developer documentation for OmniCommerce REST APIs, MCP tools, and agent integrations.","colors":{"primary":"#0F766E","light":"#2DD4BF","dark":"#115E59"},"logo":{"light":"https://mintcdn.com/omnicommerce/B2cjFTJ7Zt2npdeV/logo/light.svg?fit=max\u0026auto=format\u0026n=B2cjFTJ7Zt2npdeV\u0026q=85\u0026s=e012509da06089923275e6b0415addf9","dark":"https://mintcdn.com/omnicommerce/B2cjFTJ7Zt2npdeV/logo/dark.svg?fit=max\u0026auto=format\u0026n=B2cjFTJ7Zt2npdeV\u0026q=85\u0026s=547bdf6cb0b483a43238304bc7679fa1","href":"https://omnicommerce.sg"},"favicon":"https://mintcdn.com/omnicommerce/B2cjFTJ7Zt2npdeV/favicon.svg?fit=max\u0026auto=format\u0026n=B2cjFTJ7Zt2npdeV\u0026q=85\u0026s=2951c661b72ccdfa6777f7594193113c","api":{"params":{"expanded":"closed"},"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","javascript","python"],"prefill":false}},"appearance":{"default":"dark"},"navbar":{"links":[{"href":"https://omnicommerce.sg","label":"App"},{"href":"https://omnicommerce.sg/login","label":"Log In"}],"primary":{"type":"button","label":"API Dashboard","href":"https://omnicommerce.sg/app"}},"footer":{"socials":{"website":"https://omnicommerce.sg"}},"seo":{"metatags":{"og:site_name":"OmniCommerce Docs","twitter:card":"summary_large_image"}},"contextual":{"options":["copy","view","chatgpt","claude","download-spec"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"omnicommerce","hasAudioNarration":false,"actualSubdomain":"omnicommerce","customDomains":["docs.omnicommerce.sg"],"gitSource":{"type":"github","owner":"rmdort","repo":"omnicommerce","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6adbd0b266dc5112c9cd1db7","collectionId":"5a8b52fa-144a-4ed2-99bb-c7d4439f5f99","liveDeploymentHistoryId":"6adbd0b266dc5112c9cd1db7","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6adbd0b266dc5112c9cd1db7","clientVersion":"0.0.3965","searchFilterCounts":[{"language":"default","tag":"API Reference","count":141},{"language":"default","tag":"Endpoints","count":119},{"language":"default","tag":"Documentation","count":39},{"language":"default","tag":"Webhooks","count":31},{"language":"default","tag":"Guides","count":18},{"language":"default","tag":"Products","count":18},{"language":"default","tag":"Developer Platform","count":14},{"language":"default","tag":"Orders","count":11},{"language":"default","tag":"Analytics","count":11},{"language":"default","tag":"Promotions","count":9}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","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":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":":root{--docs-radius:6px;--docs-content-max:60rem;--docs-example-width:28rem}#navbar img[src*=logo],header img[src$=\"/logo/dark.svg\"],header img[src$=\"/logo/light.svg\"],header nav-logo img{height:32px!important;max-height:32px!important;width:auto!important}article p:not(.callout-title):not(.callout-body),main p:not(.callout-title):not(.callout-body){font-size:calc(1em - 1pt)}"}],"page":{"pagePath":"api-reference/campaigns/create-campaign","slug":"/api-reference/campaigns/create-campaign","pageMetadata":{"title":"Create Campaign","description":"Create a draft campaign. `ownerId` and `approverId` must be members of the organization, and every store must already be connected. Requires `promotions:write`.","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/campaigns","href":"/api-reference/campaigns/create-campaign","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Create a draft campaign. \", _jsx(_components.code, {\n children: \"ownerId\"\n }), \" and \", _jsx(_components.code, {\n children: \"approverId\"\n }), \" must be members of the organization, and every store must already be connected. Requires \", _jsx(_components.code, {\n children: \"promotions:write\"\n }), \".\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create Campaign","description":"Create a draft campaign. `ownerId` and `approverId` must be members of the organization, and every store must already be connected. Requires `promotions:write`.","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/campaigns","href":"/api-reference/campaigns/create-campaign","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"post_v1_campaigns","summary":"Create Campaign","description":"Create a draft campaign. `ownerId` and `approverId` must be members of the organization, and every store must already be connected. Requires `promotions:write`.","tags":["campaigns"],"security":["f364c120-6d02-4a67-a31f-b94924bdcd7e"],"requestBody":"57ac0541-ce6d-4492-a34e-981e6eea7516","responses":{"201":"62c69b89-212f-4a40-948f-ba662be65b9f","400":"619bbe95-7f9e-47c8-a084-cdcf1818f383","401":"d6fccc0a-e32a-4b2f-89da-637553144dce","403":"ee1c1d19-bd62-42bc-ae10-da166956a418","429":"3a50729c-592c-431d-8267-e34365d6ead5","500":"0ff18cb6-c896-4383-8cec-eb9145dfb751"},"method":"post","type":"path","servers":["39970a03-ff72-4559-a542-364a55d2e30f","1047c457-3777-4869-be4f-4e086fafbbca"],"path":"/api/v1/campaigns","baseUrlOptions":["https://omnicommerce.sg","http://localhost:3000"],"title":"Create Campaign","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"plan":{"type":"object","properties":{"brief":{"type":"object","properties":{"name":{"type":"string","minLength":2,"maxLength":160,"isRequired":true,"uniqueKey":"plan.brief.name","typeLabel":"string"},"ownerId":{"type":"string","minLength":1,"maxLength":160,"isRequired":true,"uniqueKey":"plan.brief.ownerId","typeLabel":"string"},"approverId":{"type":"string","minLength":1,"maxLength":160,"isRequired":true,"uniqueKey":"plan.brief.approverId","typeLabel":"string"},"timezone":{"type":"string","isRequired":true,"uniqueKey":"plan.brief.timezone","typeLabel":"string"},"objective":{"default":"","type":"string","maxLength":8000,"uniqueKey":"plan.brief.objective","typeLabel":"string"},"brand":{"default":"","type":"string","maxLength":160,"uniqueKey":"plan.brief.brand","typeLabel":"string"},"stores":{"default":[],"maxItems":100,"type":"array","items":{"type":"object","properties":{"marketplace":{"type":"string","enum":["shopee","lazada","tiktok","shopify","whatsapp","zalora","amazon","ebay"],"isRequired":true,"uniqueKey":"plan.brief.stores.items.[INDEX].marketplace","typeLabel":"enum\u003cstring>"},"country":{"type":"string","minLength":1,"maxLength":80,"isRequired":true,"uniqueKey":"plan.brief.stores.items.[INDEX].country","typeLabel":"string"},"storeId":{"type":"string","minLength":1,"maxLength":160,"isRequired":true,"uniqueKey":"plan.brief.stores.items.[INDEX].storeId","typeLabel":"string"}},"required":["marketplace","country","storeId"],"additionalProperties":false,"uniqueKey":"plan.brief.stores.items.[INDEX]","typeLabel":"object"},"uniqueKey":"plan.brief.stores","typeLabel":"object[]"},"serviceRequest":{"default":"","type":"string","maxLength":300,"uniqueKey":"plan.brief.serviceRequest","typeLabel":"string"},"priority":{"default":"standard","type":"string","enum":["standard","priority","super_priority"],"uniqueKey":"plan.brief.priority","typeLabel":"enum\u003cstring>"},"documentIds":{"default":[],"maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":160,"uniqueKey":"plan.brief.documentIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"plan.brief.documentIds","typeLabel":"string[]"},"reviewDueAt":{"oneOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$","uniqueKey":"plan.brief.reviewDueAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","uniqueKey":"plan.brief.reviewDueAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"plan.brief.reviewDueAt","typeLabel":"string\u003cdate-time> | null"},"sourceCurrency":{"type":"string","pattern":"^[A-Z]{3}$","uniqueKey":"plan.brief.sourceCurrency","typeLabel":"string"},"sourceMarketplace":{"type":"string","enum":["shopee","lazada","tiktok","shopify","whatsapp","zalora","amazon","ebay"],"uniqueKey":"plan.brief.sourceMarketplace","typeLabel":"enum\u003cstring>"},"sourceCountry":{"type":"string","maxLength":80,"uniqueKey":"plan.brief.sourceCountry","typeLabel":"string"},"cleanupNotes":{"default":"","type":"string","maxLength":8000,"uniqueKey":"plan.brief.cleanupNotes","typeLabel":"string"}},"required":["name","ownerId","approverId","timezone"],"additionalProperties":false,"isRequired":true,"uniqueKey":"plan.brief","typeLabel":"object"},"windows":{"default":[],"maxItems":100,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":160,"isRequired":true,"uniqueKey":"plan.windows.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","minLength":1,"maxLength":160,"isRequired":true,"uniqueKey":"plan.windows.items.[INDEX].name","typeLabel":"string"},"startsAt":{"oneOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$","isRequired":true,"uniqueKey":"plan.windows.items.[INDEX].startsAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","isRequired":true,"uniqueKey":"plan.windows.items.[INDEX].startsAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"plan.windows.items.[INDEX].startsAt","typeLabel":"string\u003cdate-time> | null"},"endsAt":{"oneOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$","isRequired":true,"uniqueKey":"plan.windows.items.[INDEX].endsAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","isRequired":true,"uniqueKey":"plan.windows.items.[INDEX].endsAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"plan.windows.items.[INDEX].endsAt","typeLabel":"string\u003cdate-time> | null"},"preparesAt":{"oneOf":[{"type":"string","description":"Preparation time: publish promotions with the future live start/end. Must be at or before startsAt.","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$","uniqueKey":"plan.windows.items.[INDEX].preparesAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Preparation time: publish promotions with the future live start/end. Must be at or before startsAt.","uniqueKey":"plan.windows.items.[INDEX].preparesAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"plan.windows.items.[INDEX].preparesAt","typeLabel":"string\u003cdate-time> | null"},"reviewNotes":{"default":"","type":"string","maxLength":8000,"uniqueKey":"plan.windows.items.[INDEX].reviewNotes","typeLabel":"string"}},"required":["id","name","startsAt","endsAt"],"additionalProperties":false,"uniqueKey":"plan.windows.items.[INDEX]","typeLabel":"object"},"uniqueKey":"plan.windows","typeLabel":"object[]"},"offers":{"maxItems":500,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":160,"isRequired":true,"uniqueKey":"plan.offers.items.[INDEX].id","typeLabel":"string"},"windowId":{"type":"string","minLength":1,"maxLength":160,"isRequired":true,"uniqueKey":"plan.offers.items.[INDEX].windowId","typeLabel":"string"},"promotion":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200,"uniqueKey":"plan.offers.items.[INDEX].promotion.name","typeLabel":"string"},"description":{"oneOf":[{"type":"string","maxLength":2000,"uniqueKey":"plan.offers.items.[INDEX].promotion.description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"plan.offers.items.[INDEX].promotion.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"plan.offers.items.[INDEX].promotion.description","typeLabel":"string | null"},"kind":{"description":"Canonical OmniCommerce promotion mechanic: product discount, flash sale, voucher, gift with purchase, Buy-X-Get-Y, bundle deal, or Lazada-only free shipping and early bird price.","type":"string","enum":["product_discount","flash_sale","voucher","gift_with_purchase","buy_x_get_y","bundle_deal","free_shipping","early_bird_price"],"uniqueKey":"plan.offers.items.[INDEX].promotion.kind","typeLabel":"enum\u003cstring>"},"salesChannels":{"minItems":1,"type":"array","items":{"type":"string","enum":["pdp","live"],"uniqueKey":"plan.offers.items.[INDEX].promotion.salesChannels.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"plan.offers.items.[INDEX].promotion.salesChannels","typeLabel":"enum\u003cstring>[]"},"discountType":{"type":"string","enum":["percentage","fixed_amount"],"uniqueKey":"plan.offers.items.[INDEX].promotion.discountType","typeLabel":"enum\u003cstring>"},"discountValue":{"type":"number","minimum":0,"uniqueKey":"plan.offers.items.[INDEX].promotion.discountValue","typeLabel":"number"},"storeDiscounts":{"description":"Patch discount terms for exact target store keys; unnamed stores remain unchanged. Null discountValue restores shared campaign terms for that store.","maxItems":100,"type":"array","items":{"type":"object","properties":{"storeKey":{"type":"string","minLength":1,"maxLength":255,"isRequired":true,"uniqueKey":"plan.offers.items.[INDEX].promotion.storeDiscounts.items.[INDEX].storeKey","typeLabel":"string"},"discountType":{"type":"string","enum":["percentage","fixed_amount"],"isRequired":true,"uniqueKey":"plan.offers.items.[INDEX].promotion.storeDiscounts.items.[INDEX].discountType","typeLabel":"enum\u003cstring>"},"discountValue":{"oneOf":[{"type":"number","minimum":0,"isRequired":true,"uniqueKey":"plan.offers.items.[INDEX].promotion.storeDiscounts.items.[INDEX].discountValue.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"plan.offers.items.[INDEX].promotion.storeDiscounts.items.[INDEX].discountValue.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"plan.offers.items.[INDEX].promotion.storeDiscounts.items.[INDEX].discountValue","typeLabel":"number | null"}},"required":["storeKey","discountType","discountValue"],"additionalProperties":false,"uniqueKey":"plan.offers.items.[INDEX].promotion.storeDiscounts.items.[INDEX]","typeLabel":"object"},"uniqueKey":"plan.offers.items.[INDEX].promotion.storeDiscounts","typeLabel":"object[]"},"targetStores":{"description":"Up to 100 connected stores for create (required) or update. Copy marketplace, country, and storeId from get_promotions targetStores or find_products marketplaceDetails. Do not concatenate a storeKeys string.","minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"marketplace":{"type":"string","enum":["lazada","shopee","tiktok","shopify","amazon","zalora","ebay"],"isRequired":true,"uniqueKey":"plan.offers.items.[INDEX].promotion.targetStores.items.[INDEX].marketplace","typeLabel":"enum\u003cstring>"},"country":{"type":"string","minLength":1,"maxLength":80,"isRequired":true,"uniqueKey":"plan.offers.items.[INDEX].promotion.targetStores.items.[INDEX].country","typeLabel":"string"},"storeId":{"type":"string","minLength":1,"maxLength":120,"isRequired":true,"uniqueKey":"plan.offers.items.[INDEX].promotion.targetStores.items.[INDEX].storeId","typeLabel":"string"}},"required":["marketplace","country","storeId"],"additionalProperties":false,"uniqueKey":"plan.offers.items.[INDEX].promotion.targetStores.items.[INDEX]","typeLabel":"object"},"uniqueKey":"plan.offers.items.[INDEX].promotion.targetStores","typeLabel":"object[]"},"minSalePrice":{"oneOf":[{"type":"number","minimum":0,"uniqueKey":"plan.offers.items.[INDEX].promotion.minSalePrice.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"plan.offers.items.[INDEX].promotion.minSalePrice.oneOf.1","typeLabel":"null"}],"uniqueKey":"plan.offers.items.[INDEX].promotion.minSalePrice","typeLabel":"number | null"},"maxDiscountAmount":{"oneOf":[{"type":"number","minimum":0,"uniqueKey":"plan.offers.items.[INDEX].promotion.maxDiscountAmount.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"plan.offers.items.[INDEX].promotion.maxDiscountAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"plan.offers.items.[INDEX].promotion.maxDiscountAmount","typeLabel":"number | null"},"minSpend":{"oneOf":[{"type":"number","minimum":0,"uniqueKey":"plan.offers.items.[INDEX].promotion.minSpend.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"plan.offers.items.[INDEX].promotion.minSpend.oneOf.1","typeLabel":"null"}],"uniqueKey":"plan.offers.items.[INDEX].promotion.minSpend","typeLabel":"number | null"},"voucherCode":{"oneOf":[{"type":"string","maxLength":100,"minLength":1,"uniqueKey":"plan.offers.items.[INDEX].promotion.voucherCode.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"plan.offers.items.[INDEX].promotion.voucherCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"plan.offers.items.[INDEX].promotion.voucherCode","typeLabel":"string | null"},"claimStartsAt":{"oneOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$","uniqueKey":"plan.offers.items.[INDEX].promotion.claimStartsAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","uniqueKey":"plan.offers.items.[INDEX].promotion.claimStartsAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"plan.offers.items.[INDEX].promotion.claimStartsAt","typeLabel":"string\u003cdate-time> | null"},"totalUsageLimit":{"oneOf":[{"type":"integer","maximum":9007199254740991,"minimum":0,"exclusiveMinimum":true,"uniqueKey":"plan.offers.items.[INDEX].promotion.totalUsageLimit.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"plan.offers.items.[INDEX].promotion.totalUsageLimit.oneOf.1","typeLabel":"null"}],"uniqueKey":"plan.offers.items.[INDEX].promotion.totalUsageLimit","typeLabel":"integer | null"},"perBuyerLimit":{"oneOf":[{"type":"integer","maximum":9007199254740991,"minimum":0,"exclusiveMinimum":true,"uniqueKey":"plan.offers.items.[INDEX].promotion.perBuyerLimit.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"plan.offers.items.[INDEX].promotion.perBuyerLimit.oneOf.1","typeLabel":"null"}],"uniqueKey":"plan.offers.items.[INDEX].promotion.perBuyerLimit","typeLabel":"integer | null"},"mechanicConfig":{"type":"object","properties":{"voucherType":{"oneOf":[{"type":"string","description":"Voucher subtype from get_promotions capabilities.voucherTypes. Browser AOP types (delivery=browser_aop) are writable Seller Center vouchers. Omit browserAutomation.aopId to use the built-in marketplace AOP.","enum":["shopee_shop","shopee_product","shopee_private","shopee_live","shopee_video","shopee_new_buyer","shopee_repeat_buyer","shopee_campaign","shopee_follow_prize","shopee_exclusive_streamer","shopee_welcome","shopee_member_repeat_buyer","shopee_exclusive","shopee_redemption","shopee_exclusive_creator","lazada_store_follower","lazada_regular","lazada_store_new_buyer","lazada_live","lazada_offline","lazada_co_funded","lazada_welcome","lazada_linked_member","lazada_new_member","lazada_member_exclusive","lazada_points_redeemable","tiktok_seller_coupon","shopify_discount_code","amazon_promotion_code","zalora_seller_voucher","ebay_coded_coupon"],"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.voucherType.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Voucher subtype from get_promotions capabilities.voucherTypes. Browser AOP types (delivery=browser_aop) are writable Seller Center vouchers. Omit browserAutomation.aopId to use the built-in marketplace AOP.","uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.voucherType.oneOf.1","typeLabel":"null"}],"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.voucherType","typeLabel":"enum\u003cstring> | null"},"voucherCampaign":{"description":"Campaign voucher targeting: exact campaignId/sessionId from Seller Center and termsAccepted only after the seller reviewed participation obligations. Required for shopee_campaign; nomination creates a draft awaiting marketplace review.","type":"object","properties":{"campaignId":{"type":"string","pattern":"^[1-9]\\d{0,39}$","isRequired":true,"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.voucherCampaign.campaignId","typeLabel":"string"},"sessionId":{"type":"string","pattern":"^[1-9]\\d{0,39}$","isRequired":true,"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.voucherCampaign.sessionId","typeLabel":"string"},"termsAccepted":{"type":"boolean","isRequired":true,"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.voucherCampaign.termsAccepted","typeLabel":"boolean"}},"required":["campaignId","sessionId","termsAccepted"],"additionalProperties":false,"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.voucherCampaign","typeLabel":"object"},"browserAutomation":{"oneOf":[{"type":"object","properties":{"aopId":{"type":"string","minLength":1,"maxLength":160,"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.browserAutomation.oneOf.0.aopId","typeLabel":"string"},"variableValues":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":160},"additionalProperties":{"type":"string","maxLength":8000,"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.browserAutomation.oneOf.0.variableValues.additionalProperties","typeLabel":"string"},"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.browserAutomation.oneOf.0.variableValues","typeLabel":"object"},"instructions":{"type":"string","maxLength":8000,"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.browserAutomation.oneOf.0.instructions","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.browserAutomation.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.browserAutomation.oneOf.1","typeLabel":"null"}],"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.browserAutomation","typeLabel":"object | null"},"voucherScope":{"description":"shop = all products, products = selected assigned products. Repeat Buyer defaults to shop.","type":"string","enum":["products","shop"],"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.voucherScope","typeLabel":"enum\u003cstring>"},"voucherReward":{"description":"Seller Center reward type. coins_cashback is a percentage greater than 3 and does not reduce salePrice.","type":"string","enum":["discount","coins_cashback"],"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.voucherReward","typeLabel":"enum\u003cstring>"},"voucherAudience":{"type":"string","enum":["general","shop_follow"],"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.voucherAudience","typeLabel":"enum\u003cstring>"},"repeatPurchaseMinCount":{"description":"Shopee Repeat Buyer: minimum completed shop orders, 1 or 2. Required for shopee_repeat_buyer.","type":"integer","minimum":1,"maximum":999,"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.repeatPurchaseMinCount","typeLabel":"integer"},"repeatPurchaseLookbackDays":{"description":"Shopee Repeat Buyer: lookback window in days, one of 30, 90, 180 or 365. Required for shopee_repeat_buyer.","type":"integer","minimum":1,"maximum":365,"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.repeatPurchaseLookbackDays","typeLabel":"integer"},"smartVoucher":{"description":"Shopee Smart Voucher toggle. Used by New Buyer and similar portal types.","type":"boolean","uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.smartVoucher","typeLabel":"boolean"},"followPrizeExpiryDays":{"description":"Shopee Follow Prize: days after claim until expiry. Seller Center is 7.","type":"integer","minimum":1,"maximum":30,"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.followPrizeExpiryDays","typeLabel":"integer"},"videoDisplayMode":{"description":"Shopee Video display: shopee_video = all Shopee Video; creator_video = targeted creator videos only.","type":"string","enum":["shopee_video","creator_video"],"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.videoDisplayMode","typeLabel":"enum\u003cstring>"},"exclusiveCreatorUsernames":{"description":"Exclusive Creator Voucher: up to 15 Shopee usernames.","maxItems":15,"type":"array","items":{"type":"string","minLength":1,"maxLength":64,"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.exclusiveCreatorUsernames.items.[INDEX]","typeLabel":"string"},"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.exclusiveCreatorUsernames","typeLabel":"string[]"},"exclusiveStreamerUsernames":{"description":"Exclusive Streamer Voucher: up to 15 Shopee usernames.","maxItems":15,"type":"array","items":{"type":"string","minLength":1,"maxLength":64,"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.exclusiveStreamerUsernames.items.[INDEX]","typeLabel":"string"},"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.exclusiveStreamerUsernames","typeLabel":"string[]"},"voucherDisplayChannels":{"description":"Shopee display setting. [\"all\"] = display on all pages; [] = hidden/share by code.","maxItems":4,"type":"array","items":{"type":"string","enum":["all","feed","live","order_page","followers","offline"],"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.voucherDisplayChannels.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.voucherDisplayChannels","typeLabel":"enum\u003cstring>[]"},"bundlePriceType":{"type":"string","enum":["discount","fixed_price"],"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.bundlePriceType","typeLabel":"enum\u003cstring>"},"bundleTiers":{"maxItems":2,"type":"array","items":{"type":"object","properties":{"minimumQuantity":{"type":"integer","minimum":2,"maximum":3000,"isRequired":true,"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.bundleTiers.items.[INDEX].minimumQuantity","typeLabel":"integer"},"discountValue":{"type":"number","exclusiveMinimum":0,"isRequired":true,"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.bundleTiers.items.[INDEX].discountValue","typeLabel":"number"}},"required":["minimumQuantity","discountValue"],"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.bundleTiers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.bundleTiers","typeLabel":"object[]"},"thresholdType":{"type":"string","enum":["item_quantity","order_amount"],"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.thresholdType","typeLabel":"enum\u003cstring>"},"thresholdValue":{"type":"number","exclusiveMinimum":0,"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.thresholdValue","typeLabel":"number"},"giftType":{"type":"string","enum":["gift","sample"],"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.giftType","typeLabel":"enum\u003cstring>"},"giftQuantity":{"type":"integer","exclusiveMinimum":0,"maximum":999,"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.giftQuantity","typeLabel":"integer"},"gifts":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"object","properties":{"productId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","isRequired":true,"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.gifts.items.[INDEX].productId","typeLabel":"string\u003cuuid>"},"totalClaimLimit":{"type":"integer","minimum":1,"maximum":99999,"isRequired":true,"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.gifts.items.[INDEX].totalClaimLimit","typeLabel":"integer"},"variantId":{"oneOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.gifts.items.[INDEX].variantId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.gifts.items.[INDEX].variantId.oneOf.1","typeLabel":"null"}],"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.gifts.items.[INDEX].variantId","typeLabel":"string\u003cuuid> | null"}},"required":["productId","totalClaimLimit"],"additionalProperties":false,"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.gifts.items.[INDEX]","typeLabel":"object"},"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.gifts","typeLabel":"object[]"},"buyQuantity":{"type":"integer","exclusiveMinimum":0,"maximum":999,"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.buyQuantity","typeLabel":"integer"},"getQuantity":{"type":"integer","exclusiveMinimum":0,"maximum":999,"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.getQuantity","typeLabel":"integer"},"benefitProductIds":{"minItems":1,"maxItems":200,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.benefitProductIds.items.[INDEX]","typeLabel":"string\u003cuuid>"},"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.benefitProductIds","typeLabel":"string\u003cuuid>[]"},"benefitType":{"type":"string","enum":["free","percentage","fixed_amount"],"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.benefitType","typeLabel":"enum\u003cstring>"},"benefitValue":{"type":"number","minimum":0,"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.benefitValue","typeLabel":"number"},"maxApplicationsPerOrder":{"type":"integer","exclusiveMinimum":0,"maximum":999,"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.maxApplicationsPerOrder","typeLabel":"integer"},"bundleMinimumQuantity":{"type":"integer","minimum":2,"maximum":3000,"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.bundleMinimumQuantity","typeLabel":"integer"},"shippingDeliveryOption":{"description":"Free shipping delivery option. Lazada: STANDARD (default), ECONOMY, EXPRESS, SELLER_OWN_FLEET or P2P, as offered by the store.","type":"string","pattern":"^[A-Z0-9_]{1,40}$","uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.shippingDeliveryOption","typeLabel":"string"},"shippingBudget":{"description":"Free shipping: total shipping subsidy budget in the store currency. Omit for an unlimited budget.","type":"number","exclusiveMinimum":0,"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig.shippingBudget","typeLabel":"number"}},"additionalProperties":false,"uniqueKey":"plan.offers.items.[INDEX].promotion.mechanicConfig","typeLabel":"object"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"plan.offers.items.[INDEX].promotion","typeLabel":"object"},"promotionId":{"description":"Existing draft promotion attached to this window; the campaign controls its live dates.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","uniqueKey":"plan.offers.items.[INDEX].promotionId","typeLabel":"string\u003cuuid>"},"productIds":{"default":[],"maxItems":200,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","uniqueKey":"plan.offers.items.[INDEX].productIds.items.[INDEX]","typeLabel":"string\u003cuuid>"},"uniqueKey":"plan.offers.items.[INDEX].productIds","typeLabel":"string\u003cuuid>[]"},"reviewNotes":{"default":"","type":"string","maxLength":8000,"uniqueKey":"plan.offers.items.[INDEX].reviewNotes","typeLabel":"string"},"excludedReason":{"default":"","type":"string","maxLength":2000,"uniqueKey":"plan.offers.items.[INDEX].excludedReason","typeLabel":"string"},"source":{"type":"object","properties":{"sheet":{"type":"string","maxLength":160,"isRequired":true,"uniqueKey":"plan.offers.items.[INDEX].source.sheet","typeLabel":"string"},"rows":{"maxItems":10000,"type":"array","items":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"uniqueKey":"plan.offers.items.[INDEX].source.rows.items.[INDEX]","typeLabel":"integer"},"isRequired":true,"uniqueKey":"plan.offers.items.[INDEX].source.rows","typeLabel":"integer[]"},"headers":{"maxItems":100,"type":"array","items":{"type":"string","maxLength":300,"uniqueKey":"plan.offers.items.[INDEX].source.headers.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"plan.offers.items.[INDEX].source.headers","typeLabel":"string[]"},"values":{"maxItems":10000,"type":"array","items":{"maxItems":100,"type":"array","items":{"type":"string","maxLength":16000,"uniqueKey":"plan.offers.items.[INDEX].source.values.items.[INDEX].items.[INDEX]","typeLabel":"string"},"uniqueKey":"plan.offers.items.[INDEX].source.values.items.[INDEX]","typeLabel":"string[]"},"isRequired":true,"uniqueKey":"plan.offers.items.[INDEX].source.values","typeLabel":"string[][]"}},"required":["sheet","rows","headers","values"],"additionalProperties":false,"uniqueKey":"plan.offers.items.[INDEX].source","typeLabel":"object"}},"required":["id","windowId","promotion"],"additionalProperties":false,"uniqueKey":"plan.offers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"plan.offers","typeLabel":"object[]"}},"required":["brief"],"additionalProperties":false,"isRequired":true,"uniqueKey":"plan","typeLabel":"object"},"organizationId":{"description":"Required for session auth. Optional for an API key, which already identifies the organization.","type":"string","minLength":1,"maxLength":120,"uniqueKey":"organizationId","typeLabel":"string"}},"required":["plan"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"plan":{"brief":{"name":"\u003cstring>","ownerId":"\u003cstring>","approverId":"\u003cstring>","timezone":"\u003cstring>","objective":"","brand":"","stores":[],"serviceRequest":"","priority":"standard","documentIds":[],"reviewDueAt":"2023-11-07T05:31:56Z","sourceCurrency":"\u003cstring>","sourceCountry":"\u003cstring>","cleanupNotes":""},"windows":[],"offers":[{"id":"\u003cstring>","windowId":"\u003cstring>","promotion":{"name":"\u003cstring>","description":"\u003cstring>","salesChannels":[],"discountValue":1,"storeDiscounts":[{"storeKey":"\u003cstring>","discountValue":1}],"targetStores":[{"country":"\u003cstring>","storeId":"\u003cstring>"}],"minSalePrice":1,"maxDiscountAmount":1,"minSpend":1,"voucherCode":"\u003cstring>","claimStartsAt":"2023-11-07T05:31:56Z","totalUsageLimit":4503599627370495,"perBuyerLimit":4503599627370495,"mechanicConfig":{"browserAutomation":{"aopId":"\u003cstring>","variableValues":{},"instructions":"\u003cstring>"},"repeatPurchaseMinCount":500,"repeatPurchaseLookbackDays":183,"smartVoucher":true,"followPrizeExpiryDays":15,"exclusiveCreatorUsernames":["\u003cstring>"],"exclusiveStreamerUsernames":["\u003cstring>"],"voucherDisplayChannels":[],"bundleTiers":[{"minimumQuantity":1501,"discountValue":123}],"thresholdValue":123,"giftQuantity":123,"gifts":[{"productId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","totalClaimLimit":50000,"variantId":"3c90c3cc-0d44-4b50-8888-8dd25736052a"}],"buyQuantity":123,"getQuantity":123,"benefitProductIds":["3c90c3cc-0d44-4b50-8888-8dd25736052a"],"benefitValue":1,"maxApplicationsPerOrder":123,"bundleMinimumQuantity":1501,"shippingDeliveryOption":"\u003cstring>","shippingBudget":123}},"promotionId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","productIds":[],"reviewNotes":"","excludedReason":""}]},"organizationId":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"62c69b89-212f-4a40-948f-ba662be65b9f":{"description":"Campaign detail: plan, revision, executions, audit, schedule, and progress.","content":{"application/json":{"schema":{"type":"object","properties":{"campaign":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"campaign.id","typeLabel":"string"},"organizationId":{"type":"string","isRequired":true,"uniqueKey":"campaign.organizationId","typeLabel":"string"},"revision":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"campaign.revision","typeLabel":"integer"},"stage":{"type":"string","enum":["draft","approved","running","ending","completed","archived"],"isRequired":true,"uniqueKey":"campaign.stage","typeLabel":"enum\u003cstring>"},"approval":{"oneOf":[{"type":"object","required":["revision","userId","approvedAt"],"properties":{"revision":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"campaign.approval.oneOf.0.revision","typeLabel":"integer"},"userId":{"type":"string","isRequired":true,"uniqueKey":"campaign.approval.oneOf.0.userId","typeLabel":"string"},"approvedAt":{"type":"string","isRequired":true,"uniqueKey":"campaign.approval.oneOf.0.approvedAt","typeLabel":"string"}},"isRequired":true,"uniqueKey":"campaign.approval.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"campaign.approval.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"campaign.approval","typeLabel":"object | null"},"runId":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"campaign.runId.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"campaign.runId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"campaign.runId","typeLabel":"string | null"},"startedAt":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"campaign.startedAt.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"campaign.startedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"campaign.startedAt","typeLabel":"string | null"},"endedAt":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"campaign.endedAt.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"campaign.endedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"campaign.endedAt","typeLabel":"string | null"},"createdAt":{"type":"string","isRequired":true,"uniqueKey":"campaign.createdAt","typeLabel":"string"},"updatedAt":{"type":"string","isRequired":true,"uniqueKey":"campaign.updatedAt","typeLabel":"string"},"plan":{"type":"object","properties":{"brief":{"type":"object","properties":{"name":{"type":"string","minLength":2,"maxLength":160,"isRequired":true,"uniqueKey":"campaign.plan.brief.name","typeLabel":"string"},"ownerId":{"type":"string","minLength":1,"maxLength":160,"isRequired":true,"uniqueKey":"campaign.plan.brief.ownerId","typeLabel":"string"},"approverId":{"type":"string","minLength":1,"maxLength":160,"isRequired":true,"uniqueKey":"campaign.plan.brief.approverId","typeLabel":"string"},"timezone":{"type":"string","isRequired":true,"uniqueKey":"campaign.plan.brief.timezone","typeLabel":"string"},"objective":{"default":"","type":"string","maxLength":8000,"uniqueKey":"campaign.plan.brief.objective","typeLabel":"string"},"brand":{"default":"","type":"string","maxLength":160,"uniqueKey":"campaign.plan.brief.brand","typeLabel":"string"},"stores":{"default":[],"maxItems":100,"type":"array","items":{"type":"object","properties":{"marketplace":{"type":"string","enum":["shopee","lazada","tiktok","shopify","whatsapp","zalora","amazon","ebay"],"isRequired":true,"uniqueKey":"campaign.plan.brief.stores.items.[INDEX].marketplace","typeLabel":"enum\u003cstring>"},"country":{"type":"string","minLength":1,"maxLength":80,"isRequired":true,"uniqueKey":"campaign.plan.brief.stores.items.[INDEX].country","typeLabel":"string"},"storeId":{"type":"string","minLength":1,"maxLength":160,"isRequired":true,"uniqueKey":"campaign.plan.brief.stores.items.[INDEX].storeId","typeLabel":"string"}},"required":["marketplace","country","storeId"],"additionalProperties":false,"uniqueKey":"campaign.plan.brief.stores.items.[INDEX]","typeLabel":"object"},"uniqueKey":"campaign.plan.brief.stores","typeLabel":"object[]"},"serviceRequest":{"default":"","type":"string","maxLength":300,"uniqueKey":"campaign.plan.brief.serviceRequest","typeLabel":"string"},"priority":{"default":"standard","type":"string","enum":["standard","priority","super_priority"],"uniqueKey":"campaign.plan.brief.priority","typeLabel":"enum\u003cstring>"},"documentIds":{"default":[],"maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":160,"uniqueKey":"campaign.plan.brief.documentIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"campaign.plan.brief.documentIds","typeLabel":"string[]"},"reviewDueAt":{"oneOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$","uniqueKey":"campaign.plan.brief.reviewDueAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","uniqueKey":"campaign.plan.brief.reviewDueAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaign.plan.brief.reviewDueAt","typeLabel":"string\u003cdate-time> | null"},"sourceCurrency":{"type":"string","pattern":"^[A-Z]{3}$","uniqueKey":"campaign.plan.brief.sourceCurrency","typeLabel":"string"},"sourceMarketplace":{"type":"string","enum":["shopee","lazada","tiktok","shopify","whatsapp","zalora","amazon","ebay"],"uniqueKey":"campaign.plan.brief.sourceMarketplace","typeLabel":"enum\u003cstring>"},"sourceCountry":{"type":"string","maxLength":80,"uniqueKey":"campaign.plan.brief.sourceCountry","typeLabel":"string"},"cleanupNotes":{"default":"","type":"string","maxLength":8000,"uniqueKey":"campaign.plan.brief.cleanupNotes","typeLabel":"string"}},"required":["name","ownerId","approverId","timezone"],"additionalProperties":false,"isRequired":true,"uniqueKey":"campaign.plan.brief","typeLabel":"object"},"windows":{"default":[],"maxItems":100,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":160,"isRequired":true,"uniqueKey":"campaign.plan.windows.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","minLength":1,"maxLength":160,"isRequired":true,"uniqueKey":"campaign.plan.windows.items.[INDEX].name","typeLabel":"string"},"startsAt":{"oneOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$","isRequired":true,"uniqueKey":"campaign.plan.windows.items.[INDEX].startsAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","isRequired":true,"uniqueKey":"campaign.plan.windows.items.[INDEX].startsAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"campaign.plan.windows.items.[INDEX].startsAt","typeLabel":"string\u003cdate-time> | null"},"endsAt":{"oneOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$","isRequired":true,"uniqueKey":"campaign.plan.windows.items.[INDEX].endsAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","isRequired":true,"uniqueKey":"campaign.plan.windows.items.[INDEX].endsAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"campaign.plan.windows.items.[INDEX].endsAt","typeLabel":"string\u003cdate-time> | null"},"preparesAt":{"oneOf":[{"type":"string","description":"Preparation time: publish promotions with the future live start/end. Must be at or before startsAt.","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$","uniqueKey":"campaign.plan.windows.items.[INDEX].preparesAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Preparation time: publish promotions with the future live start/end. Must be at or before startsAt.","uniqueKey":"campaign.plan.windows.items.[INDEX].preparesAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaign.plan.windows.items.[INDEX].preparesAt","typeLabel":"string\u003cdate-time> | null"},"reviewNotes":{"default":"","type":"string","maxLength":8000,"uniqueKey":"campaign.plan.windows.items.[INDEX].reviewNotes","typeLabel":"string"}},"required":["id","name","startsAt","endsAt"],"additionalProperties":false,"uniqueKey":"campaign.plan.windows.items.[INDEX]","typeLabel":"object"},"uniqueKey":"campaign.plan.windows","typeLabel":"object[]"},"offers":{"maxItems":500,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":160,"isRequired":true,"uniqueKey":"campaign.plan.offers.items.[INDEX].id","typeLabel":"string"},"windowId":{"type":"string","minLength":1,"maxLength":160,"isRequired":true,"uniqueKey":"campaign.plan.offers.items.[INDEX].windowId","typeLabel":"string"},"promotion":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200,"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.name","typeLabel":"string"},"description":{"oneOf":[{"type":"string","maxLength":2000,"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.description","typeLabel":"string | null"},"kind":{"description":"Canonical OmniCommerce promotion mechanic: product discount, flash sale, voucher, gift with purchase, Buy-X-Get-Y, bundle deal, or Lazada-only free shipping and early bird price.","type":"string","enum":["product_discount","flash_sale","voucher","gift_with_purchase","buy_x_get_y","bundle_deal","free_shipping","early_bird_price"],"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.kind","typeLabel":"enum\u003cstring>"},"salesChannels":{"minItems":1,"type":"array","items":{"type":"string","enum":["pdp","live"],"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.salesChannels.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.salesChannels","typeLabel":"enum\u003cstring>[]"},"discountType":{"type":"string","enum":["percentage","fixed_amount"],"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.discountType","typeLabel":"enum\u003cstring>"},"discountValue":{"type":"number","minimum":0,"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.discountValue","typeLabel":"number"},"storeDiscounts":{"description":"Patch discount terms for exact target store keys; unnamed stores remain unchanged. Null discountValue restores shared campaign terms for that store.","maxItems":100,"type":"array","items":{"type":"object","properties":{"storeKey":{"type":"string","minLength":1,"maxLength":255,"isRequired":true,"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.storeDiscounts.items.[INDEX].storeKey","typeLabel":"string"},"discountType":{"type":"string","enum":["percentage","fixed_amount"],"isRequired":true,"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.storeDiscounts.items.[INDEX].discountType","typeLabel":"enum\u003cstring>"},"discountValue":{"oneOf":[{"type":"number","minimum":0,"isRequired":true,"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.storeDiscounts.items.[INDEX].discountValue.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.storeDiscounts.items.[INDEX].discountValue.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.storeDiscounts.items.[INDEX].discountValue","typeLabel":"number | null"}},"required":["storeKey","discountType","discountValue"],"additionalProperties":false,"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.storeDiscounts.items.[INDEX]","typeLabel":"object"},"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.storeDiscounts","typeLabel":"object[]"},"targetStores":{"description":"Up to 100 connected stores for create (required) or update. Copy marketplace, country, and storeId from get_promotions targetStores or find_products marketplaceDetails. Do not concatenate a storeKeys string.","minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"marketplace":{"type":"string","enum":["lazada","shopee","tiktok","shopify","amazon","zalora","ebay"],"isRequired":true,"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.targetStores.items.[INDEX].marketplace","typeLabel":"enum\u003cstring>"},"country":{"type":"string","minLength":1,"maxLength":80,"isRequired":true,"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.targetStores.items.[INDEX].country","typeLabel":"string"},"storeId":{"type":"string","minLength":1,"maxLength":120,"isRequired":true,"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.targetStores.items.[INDEX].storeId","typeLabel":"string"}},"required":["marketplace","country","storeId"],"additionalProperties":false,"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.targetStores.items.[INDEX]","typeLabel":"object"},"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.targetStores","typeLabel":"object[]"},"minSalePrice":{"oneOf":[{"type":"number","minimum":0,"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.minSalePrice.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.minSalePrice.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.minSalePrice","typeLabel":"number | null"},"maxDiscountAmount":{"oneOf":[{"type":"number","minimum":0,"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.maxDiscountAmount.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.maxDiscountAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.maxDiscountAmount","typeLabel":"number | null"},"minSpend":{"oneOf":[{"type":"number","minimum":0,"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.minSpend.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.minSpend.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.minSpend","typeLabel":"number | null"},"voucherCode":{"oneOf":[{"type":"string","maxLength":100,"minLength":1,"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.voucherCode.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.voucherCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.voucherCode","typeLabel":"string | null"},"claimStartsAt":{"oneOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$","uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.claimStartsAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.claimStartsAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.claimStartsAt","typeLabel":"string\u003cdate-time> | null"},"totalUsageLimit":{"oneOf":[{"type":"integer","maximum":9007199254740991,"minimum":0,"exclusiveMinimum":true,"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.totalUsageLimit.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.totalUsageLimit.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.totalUsageLimit","typeLabel":"integer | null"},"perBuyerLimit":{"oneOf":[{"type":"integer","maximum":9007199254740991,"minimum":0,"exclusiveMinimum":true,"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.perBuyerLimit.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.perBuyerLimit.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.perBuyerLimit","typeLabel":"integer | null"},"mechanicConfig":{"type":"object","properties":{"voucherType":{"oneOf":[{"type":"string","description":"Voucher subtype from get_promotions capabilities.voucherTypes. Browser AOP types (delivery=browser_aop) are writable Seller Center vouchers. Omit browserAutomation.aopId to use the built-in marketplace AOP.","enum":["shopee_shop","shopee_product","shopee_private","shopee_live","shopee_video","shopee_new_buyer","shopee_repeat_buyer","shopee_campaign","shopee_follow_prize","shopee_exclusive_streamer","shopee_welcome","shopee_member_repeat_buyer","shopee_exclusive","shopee_redemption","shopee_exclusive_creator","lazada_store_follower","lazada_regular","lazada_store_new_buyer","lazada_live","lazada_offline","lazada_co_funded","lazada_welcome","lazada_linked_member","lazada_new_member","lazada_member_exclusive","lazada_points_redeemable","tiktok_seller_coupon","shopify_discount_code","amazon_promotion_code","zalora_seller_voucher","ebay_coded_coupon"],"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.voucherType.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Voucher subtype from get_promotions capabilities.voucherTypes. Browser AOP types (delivery=browser_aop) are writable Seller Center vouchers. Omit browserAutomation.aopId to use the built-in marketplace AOP.","uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.voucherType.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.voucherType","typeLabel":"enum\u003cstring> | null"},"voucherCampaign":{"description":"Campaign voucher targeting: exact campaignId/sessionId from Seller Center and termsAccepted only after the seller reviewed participation obligations. Required for shopee_campaign; nomination creates a draft awaiting marketplace review.","type":"object","properties":{"campaignId":{"type":"string","pattern":"^[1-9]\\d{0,39}$","isRequired":true,"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.voucherCampaign.campaignId","typeLabel":"string"},"sessionId":{"type":"string","pattern":"^[1-9]\\d{0,39}$","isRequired":true,"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.voucherCampaign.sessionId","typeLabel":"string"},"termsAccepted":{"type":"boolean","isRequired":true,"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.voucherCampaign.termsAccepted","typeLabel":"boolean"}},"required":["campaignId","sessionId","termsAccepted"],"additionalProperties":false,"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.voucherCampaign","typeLabel":"object"},"browserAutomation":{"oneOf":[{"type":"object","properties":{"aopId":{"type":"string","minLength":1,"maxLength":160,"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.browserAutomation.oneOf.0.aopId","typeLabel":"string"},"variableValues":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":160},"additionalProperties":{"type":"string","maxLength":8000,"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.browserAutomation.oneOf.0.variableValues.additionalProperties","typeLabel":"string"},"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.browserAutomation.oneOf.0.variableValues","typeLabel":"object"},"instructions":{"type":"string","maxLength":8000,"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.browserAutomation.oneOf.0.instructions","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.browserAutomation.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.browserAutomation.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.browserAutomation","typeLabel":"object | null"},"voucherScope":{"description":"shop = all products, products = selected assigned products. Repeat Buyer defaults to shop.","type":"string","enum":["products","shop"],"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.voucherScope","typeLabel":"enum\u003cstring>"},"voucherReward":{"description":"Seller Center reward type. coins_cashback is a percentage greater than 3 and does not reduce salePrice.","type":"string","enum":["discount","coins_cashback"],"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.voucherReward","typeLabel":"enum\u003cstring>"},"voucherAudience":{"type":"string","enum":["general","shop_follow"],"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.voucherAudience","typeLabel":"enum\u003cstring>"},"repeatPurchaseMinCount":{"description":"Shopee Repeat Buyer: minimum completed shop orders, 1 or 2. Required for shopee_repeat_buyer.","type":"integer","minimum":1,"maximum":999,"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.repeatPurchaseMinCount","typeLabel":"integer"},"repeatPurchaseLookbackDays":{"description":"Shopee Repeat Buyer: lookback window in days, one of 30, 90, 180 or 365. Required for shopee_repeat_buyer.","type":"integer","minimum":1,"maximum":365,"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.repeatPurchaseLookbackDays","typeLabel":"integer"},"smartVoucher":{"description":"Shopee Smart Voucher toggle. Used by New Buyer and similar portal types.","type":"boolean","uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.smartVoucher","typeLabel":"boolean"},"followPrizeExpiryDays":{"description":"Shopee Follow Prize: days after claim until expiry. Seller Center is 7.","type":"integer","minimum":1,"maximum":30,"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.followPrizeExpiryDays","typeLabel":"integer"},"videoDisplayMode":{"description":"Shopee Video display: shopee_video = all Shopee Video; creator_video = targeted creator videos only.","type":"string","enum":["shopee_video","creator_video"],"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.videoDisplayMode","typeLabel":"enum\u003cstring>"},"exclusiveCreatorUsernames":{"description":"Exclusive Creator Voucher: up to 15 Shopee usernames.","maxItems":15,"type":"array","items":{"type":"string","minLength":1,"maxLength":64,"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.exclusiveCreatorUsernames.items.[INDEX]","typeLabel":"string"},"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.exclusiveCreatorUsernames","typeLabel":"string[]"},"exclusiveStreamerUsernames":{"description":"Exclusive Streamer Voucher: up to 15 Shopee usernames.","maxItems":15,"type":"array","items":{"type":"string","minLength":1,"maxLength":64,"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.exclusiveStreamerUsernames.items.[INDEX]","typeLabel":"string"},"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.exclusiveStreamerUsernames","typeLabel":"string[]"},"voucherDisplayChannels":{"description":"Shopee display setting. [\"all\"] = display on all pages; [] = hidden/share by code.","maxItems":4,"type":"array","items":{"type":"string","enum":["all","feed","live","order_page","followers","offline"],"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.voucherDisplayChannels.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.voucherDisplayChannels","typeLabel":"enum\u003cstring>[]"},"bundlePriceType":{"type":"string","enum":["discount","fixed_price"],"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.bundlePriceType","typeLabel":"enum\u003cstring>"},"bundleTiers":{"maxItems":2,"type":"array","items":{"type":"object","properties":{"minimumQuantity":{"type":"integer","minimum":2,"maximum":3000,"isRequired":true,"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.bundleTiers.items.[INDEX].minimumQuantity","typeLabel":"integer"},"discountValue":{"type":"number","exclusiveMinimum":0,"isRequired":true,"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.bundleTiers.items.[INDEX].discountValue","typeLabel":"number"}},"required":["minimumQuantity","discountValue"],"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.bundleTiers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.bundleTiers","typeLabel":"object[]"},"thresholdType":{"type":"string","enum":["item_quantity","order_amount"],"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.thresholdType","typeLabel":"enum\u003cstring>"},"thresholdValue":{"type":"number","exclusiveMinimum":0,"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.thresholdValue","typeLabel":"number"},"giftType":{"type":"string","enum":["gift","sample"],"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.giftType","typeLabel":"enum\u003cstring>"},"giftQuantity":{"type":"integer","exclusiveMinimum":0,"maximum":999,"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.giftQuantity","typeLabel":"integer"},"gifts":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"object","properties":{"productId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","isRequired":true,"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.gifts.items.[INDEX].productId","typeLabel":"string\u003cuuid>"},"totalClaimLimit":{"type":"integer","minimum":1,"maximum":99999,"isRequired":true,"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.gifts.items.[INDEX].totalClaimLimit","typeLabel":"integer"},"variantId":{"oneOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.gifts.items.[INDEX].variantId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.gifts.items.[INDEX].variantId.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.gifts.items.[INDEX].variantId","typeLabel":"string\u003cuuid> | null"}},"required":["productId","totalClaimLimit"],"additionalProperties":false,"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.gifts.items.[INDEX]","typeLabel":"object"},"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.gifts","typeLabel":"object[]"},"buyQuantity":{"type":"integer","exclusiveMinimum":0,"maximum":999,"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.buyQuantity","typeLabel":"integer"},"getQuantity":{"type":"integer","exclusiveMinimum":0,"maximum":999,"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.getQuantity","typeLabel":"integer"},"benefitProductIds":{"minItems":1,"maxItems":200,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.benefitProductIds.items.[INDEX]","typeLabel":"string\u003cuuid>"},"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.benefitProductIds","typeLabel":"string\u003cuuid>[]"},"benefitType":{"type":"string","enum":["free","percentage","fixed_amount"],"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.benefitType","typeLabel":"enum\u003cstring>"},"benefitValue":{"type":"number","minimum":0,"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.benefitValue","typeLabel":"number"},"maxApplicationsPerOrder":{"type":"integer","exclusiveMinimum":0,"maximum":999,"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.maxApplicationsPerOrder","typeLabel":"integer"},"bundleMinimumQuantity":{"type":"integer","minimum":2,"maximum":3000,"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.bundleMinimumQuantity","typeLabel":"integer"},"shippingDeliveryOption":{"description":"Free shipping delivery option. Lazada: STANDARD (default), ECONOMY, EXPRESS, SELLER_OWN_FLEET or P2P, as offered by the store.","type":"string","pattern":"^[A-Z0-9_]{1,40}$","uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.shippingDeliveryOption","typeLabel":"string"},"shippingBudget":{"description":"Free shipping: total shipping subsidy budget in the store currency. Omit for an unlimited budget.","type":"number","exclusiveMinimum":0,"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig.shippingBudget","typeLabel":"number"}},"additionalProperties":false,"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion.mechanicConfig","typeLabel":"object"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"campaign.plan.offers.items.[INDEX].promotion","typeLabel":"object"},"promotionId":{"description":"Existing draft promotion attached to this window; the campaign controls its live dates.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","uniqueKey":"campaign.plan.offers.items.[INDEX].promotionId","typeLabel":"string\u003cuuid>"},"productIds":{"default":[],"maxItems":200,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","uniqueKey":"campaign.plan.offers.items.[INDEX].productIds.items.[INDEX]","typeLabel":"string\u003cuuid>"},"uniqueKey":"campaign.plan.offers.items.[INDEX].productIds","typeLabel":"string\u003cuuid>[]"},"reviewNotes":{"default":"","type":"string","maxLength":8000,"uniqueKey":"campaign.plan.offers.items.[INDEX].reviewNotes","typeLabel":"string"},"excludedReason":{"default":"","type":"string","maxLength":2000,"uniqueKey":"campaign.plan.offers.items.[INDEX].excludedReason","typeLabel":"string"},"source":{"type":"object","properties":{"sheet":{"type":"string","maxLength":160,"isRequired":true,"uniqueKey":"campaign.plan.offers.items.[INDEX].source.sheet","typeLabel":"string"},"rows":{"maxItems":10000,"type":"array","items":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"uniqueKey":"campaign.plan.offers.items.[INDEX].source.rows.items.[INDEX]","typeLabel":"integer"},"isRequired":true,"uniqueKey":"campaign.plan.offers.items.[INDEX].source.rows","typeLabel":"integer[]"},"headers":{"maxItems":100,"type":"array","items":{"type":"string","maxLength":300,"uniqueKey":"campaign.plan.offers.items.[INDEX].source.headers.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"campaign.plan.offers.items.[INDEX].source.headers","typeLabel":"string[]"},"values":{"maxItems":10000,"type":"array","items":{"maxItems":100,"type":"array","items":{"type":"string","maxLength":16000,"uniqueKey":"campaign.plan.offers.items.[INDEX].source.values.items.[INDEX].items.[INDEX]","typeLabel":"string"},"uniqueKey":"campaign.plan.offers.items.[INDEX].source.values.items.[INDEX]","typeLabel":"string[]"},"isRequired":true,"uniqueKey":"campaign.plan.offers.items.[INDEX].source.values","typeLabel":"string[][]"}},"required":["sheet","rows","headers","values"],"additionalProperties":false,"uniqueKey":"campaign.plan.offers.items.[INDEX].source","typeLabel":"object"}},"required":["id","windowId","promotion"],"additionalProperties":false,"uniqueKey":"campaign.plan.offers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"campaign.plan.offers","typeLabel":"object[]"}},"required":["brief"],"additionalProperties":false,"isRequired":true,"uniqueKey":"campaign.plan","typeLabel":"object"},"pendingChange":{"oneOf":[{"type":"object","description":"A running campaign's proposed plan, applied only when the approver approves it.","required":["version","plan","proposedBy","proposedAt"],"properties":{"version":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"campaign.pendingChange.oneOf.0.version","typeLabel":"integer"},"plan":{"type":"object","properties":{"brief":{"type":"object","properties":{"name":{"type":"string","minLength":2,"maxLength":160,"isRequired":true,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.brief.name","typeLabel":"string"},"ownerId":{"type":"string","minLength":1,"maxLength":160,"isRequired":true,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.brief.ownerId","typeLabel":"string"},"approverId":{"type":"string","minLength":1,"maxLength":160,"isRequired":true,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.brief.approverId","typeLabel":"string"},"timezone":{"type":"string","isRequired":true,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.brief.timezone","typeLabel":"string"},"objective":{"default":"","type":"string","maxLength":8000,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.brief.objective","typeLabel":"string"},"brand":{"default":"","type":"string","maxLength":160,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.brief.brand","typeLabel":"string"},"stores":{"default":[],"maxItems":100,"type":"array","items":{"type":"object","properties":{"marketplace":{"type":"string","enum":["shopee","lazada","tiktok","shopify","whatsapp","zalora","amazon","ebay"],"isRequired":true,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.brief.stores.items.[INDEX].marketplace","typeLabel":"enum\u003cstring>"},"country":{"type":"string","minLength":1,"maxLength":80,"isRequired":true,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.brief.stores.items.[INDEX].country","typeLabel":"string"},"storeId":{"type":"string","minLength":1,"maxLength":160,"isRequired":true,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.brief.stores.items.[INDEX].storeId","typeLabel":"string"}},"required":["marketplace","country","storeId"],"additionalProperties":false,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.brief.stores.items.[INDEX]","typeLabel":"object"},"uniqueKey":"campaign.pendingChange.oneOf.0.plan.brief.stores","typeLabel":"object[]"},"serviceRequest":{"default":"","type":"string","maxLength":300,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.brief.serviceRequest","typeLabel":"string"},"priority":{"default":"standard","type":"string","enum":["standard","priority","super_priority"],"uniqueKey":"campaign.pendingChange.oneOf.0.plan.brief.priority","typeLabel":"enum\u003cstring>"},"documentIds":{"default":[],"maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":160,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.brief.documentIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"campaign.pendingChange.oneOf.0.plan.brief.documentIds","typeLabel":"string[]"},"reviewDueAt":{"oneOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$","uniqueKey":"campaign.pendingChange.oneOf.0.plan.brief.reviewDueAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","uniqueKey":"campaign.pendingChange.oneOf.0.plan.brief.reviewDueAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaign.pendingChange.oneOf.0.plan.brief.reviewDueAt","typeLabel":"string\u003cdate-time> | null"},"sourceCurrency":{"type":"string","pattern":"^[A-Z]{3}$","uniqueKey":"campaign.pendingChange.oneOf.0.plan.brief.sourceCurrency","typeLabel":"string"},"sourceMarketplace":{"type":"string","enum":["shopee","lazada","tiktok","shopify","whatsapp","zalora","amazon","ebay"],"uniqueKey":"campaign.pendingChange.oneOf.0.plan.brief.sourceMarketplace","typeLabel":"enum\u003cstring>"},"sourceCountry":{"type":"string","maxLength":80,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.brief.sourceCountry","typeLabel":"string"},"cleanupNotes":{"default":"","type":"string","maxLength":8000,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.brief.cleanupNotes","typeLabel":"string"}},"required":["name","ownerId","approverId","timezone"],"additionalProperties":false,"isRequired":true,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.brief","typeLabel":"object"},"windows":{"default":[],"maxItems":100,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":160,"isRequired":true,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.windows.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","minLength":1,"maxLength":160,"isRequired":true,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.windows.items.[INDEX].name","typeLabel":"string"},"startsAt":{"oneOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$","isRequired":true,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.windows.items.[INDEX].startsAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","isRequired":true,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.windows.items.[INDEX].startsAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.windows.items.[INDEX].startsAt","typeLabel":"string\u003cdate-time> | null"},"endsAt":{"oneOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$","isRequired":true,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.windows.items.[INDEX].endsAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","isRequired":true,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.windows.items.[INDEX].endsAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.windows.items.[INDEX].endsAt","typeLabel":"string\u003cdate-time> | null"},"preparesAt":{"oneOf":[{"type":"string","description":"Preparation time: publish promotions with the future live start/end. Must be at or before startsAt.","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$","uniqueKey":"campaign.pendingChange.oneOf.0.plan.windows.items.[INDEX].preparesAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Preparation time: publish promotions with the future live start/end. Must be at or before startsAt.","uniqueKey":"campaign.pendingChange.oneOf.0.plan.windows.items.[INDEX].preparesAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaign.pendingChange.oneOf.0.plan.windows.items.[INDEX].preparesAt","typeLabel":"string\u003cdate-time> | null"},"reviewNotes":{"default":"","type":"string","maxLength":8000,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.windows.items.[INDEX].reviewNotes","typeLabel":"string"}},"required":["id","name","startsAt","endsAt"],"additionalProperties":false,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.windows.items.[INDEX]","typeLabel":"object"},"uniqueKey":"campaign.pendingChange.oneOf.0.plan.windows","typeLabel":"object[]"},"offers":{"maxItems":500,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":160,"isRequired":true,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].id","typeLabel":"string"},"windowId":{"type":"string","minLength":1,"maxLength":160,"isRequired":true,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].windowId","typeLabel":"string"},"promotion":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.name","typeLabel":"string"},"description":{"oneOf":[{"type":"string","maxLength":2000,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.description","typeLabel":"string | null"},"kind":{"description":"Canonical OmniCommerce promotion mechanic: product discount, flash sale, voucher, gift with purchase, Buy-X-Get-Y, bundle deal, or Lazada-only free shipping and early bird price.","type":"string","enum":["product_discount","flash_sale","voucher","gift_with_purchase","buy_x_get_y","bundle_deal","free_shipping","early_bird_price"],"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.kind","typeLabel":"enum\u003cstring>"},"salesChannels":{"minItems":1,"type":"array","items":{"type":"string","enum":["pdp","live"],"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.salesChannels.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.salesChannels","typeLabel":"enum\u003cstring>[]"},"discountType":{"type":"string","enum":["percentage","fixed_amount"],"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.discountType","typeLabel":"enum\u003cstring>"},"discountValue":{"type":"number","minimum":0,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.discountValue","typeLabel":"number"},"storeDiscounts":{"description":"Patch discount terms for exact target store keys; unnamed stores remain unchanged. Null discountValue restores shared campaign terms for that store.","maxItems":100,"type":"array","items":{"type":"object","properties":{"storeKey":{"type":"string","minLength":1,"maxLength":255,"isRequired":true,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.storeDiscounts.items.[INDEX].storeKey","typeLabel":"string"},"discountType":{"type":"string","enum":["percentage","fixed_amount"],"isRequired":true,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.storeDiscounts.items.[INDEX].discountType","typeLabel":"enum\u003cstring>"},"discountValue":{"oneOf":[{"type":"number","minimum":0,"isRequired":true,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.storeDiscounts.items.[INDEX].discountValue.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.storeDiscounts.items.[INDEX].discountValue.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.storeDiscounts.items.[INDEX].discountValue","typeLabel":"number | null"}},"required":["storeKey","discountType","discountValue"],"additionalProperties":false,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.storeDiscounts.items.[INDEX]","typeLabel":"object"},"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.storeDiscounts","typeLabel":"object[]"},"targetStores":{"description":"Up to 100 connected stores for create (required) or update. Copy marketplace, country, and storeId from get_promotions targetStores or find_products marketplaceDetails. Do not concatenate a storeKeys string.","minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"marketplace":{"type":"string","enum":["lazada","shopee","tiktok","shopify","amazon","zalora","ebay"],"isRequired":true,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.targetStores.items.[INDEX].marketplace","typeLabel":"enum\u003cstring>"},"country":{"type":"string","minLength":1,"maxLength":80,"isRequired":true,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.targetStores.items.[INDEX].country","typeLabel":"string"},"storeId":{"type":"string","minLength":1,"maxLength":120,"isRequired":true,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.targetStores.items.[INDEX].storeId","typeLabel":"string"}},"required":["marketplace","country","storeId"],"additionalProperties":false,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.targetStores.items.[INDEX]","typeLabel":"object"},"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.targetStores","typeLabel":"object[]"},"minSalePrice":{"oneOf":[{"type":"number","minimum":0,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.minSalePrice.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.minSalePrice.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.minSalePrice","typeLabel":"number | null"},"maxDiscountAmount":{"oneOf":[{"type":"number","minimum":0,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.maxDiscountAmount.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.maxDiscountAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.maxDiscountAmount","typeLabel":"number | null"},"minSpend":{"oneOf":[{"type":"number","minimum":0,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.minSpend.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.minSpend.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.minSpend","typeLabel":"number | null"},"voucherCode":{"oneOf":[{"type":"string","maxLength":100,"minLength":1,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.voucherCode.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.voucherCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.voucherCode","typeLabel":"string | null"},"claimStartsAt":{"oneOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$","uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.claimStartsAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.claimStartsAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.claimStartsAt","typeLabel":"string\u003cdate-time> | null"},"totalUsageLimit":{"oneOf":[{"type":"integer","maximum":9007199254740991,"minimum":0,"exclusiveMinimum":true,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.totalUsageLimit.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.totalUsageLimit.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.totalUsageLimit","typeLabel":"integer | null"},"perBuyerLimit":{"oneOf":[{"type":"integer","maximum":9007199254740991,"minimum":0,"exclusiveMinimum":true,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.perBuyerLimit.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.perBuyerLimit.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.perBuyerLimit","typeLabel":"integer | null"},"mechanicConfig":{"type":"object","properties":{"voucherType":{"oneOf":[{"type":"string","description":"Voucher subtype from get_promotions capabilities.voucherTypes. Browser AOP types (delivery=browser_aop) are writable Seller Center vouchers. Omit browserAutomation.aopId to use the built-in marketplace AOP.","enum":["shopee_shop","shopee_product","shopee_private","shopee_live","shopee_video","shopee_new_buyer","shopee_repeat_buyer","shopee_campaign","shopee_follow_prize","shopee_exclusive_streamer","shopee_welcome","shopee_member_repeat_buyer","shopee_exclusive","shopee_redemption","shopee_exclusive_creator","lazada_store_follower","lazada_regular","lazada_store_new_buyer","lazada_live","lazada_offline","lazada_co_funded","lazada_welcome","lazada_linked_member","lazada_new_member","lazada_member_exclusive","lazada_points_redeemable","tiktok_seller_coupon","shopify_discount_code","amazon_promotion_code","zalora_seller_voucher","ebay_coded_coupon"],"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.voucherType.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Voucher subtype from get_promotions capabilities.voucherTypes. Browser AOP types (delivery=browser_aop) are writable Seller Center vouchers. Omit browserAutomation.aopId to use the built-in marketplace AOP.","uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.voucherType.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.voucherType","typeLabel":"enum\u003cstring> | null"},"voucherCampaign":{"description":"Campaign voucher targeting: exact campaignId/sessionId from Seller Center and termsAccepted only after the seller reviewed participation obligations. Required for shopee_campaign; nomination creates a draft awaiting marketplace review.","type":"object","properties":{"campaignId":{"type":"string","pattern":"^[1-9]\\d{0,39}$","isRequired":true,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.voucherCampaign.campaignId","typeLabel":"string"},"sessionId":{"type":"string","pattern":"^[1-9]\\d{0,39}$","isRequired":true,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.voucherCampaign.sessionId","typeLabel":"string"},"termsAccepted":{"type":"boolean","isRequired":true,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.voucherCampaign.termsAccepted","typeLabel":"boolean"}},"required":["campaignId","sessionId","termsAccepted"],"additionalProperties":false,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.voucherCampaign","typeLabel":"object"},"browserAutomation":{"oneOf":[{"type":"object","properties":{"aopId":{"type":"string","minLength":1,"maxLength":160,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.browserAutomation.oneOf.0.aopId","typeLabel":"string"},"variableValues":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":160},"additionalProperties":{"type":"string","maxLength":8000,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.browserAutomation.oneOf.0.variableValues.additionalProperties","typeLabel":"string"},"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.browserAutomation.oneOf.0.variableValues","typeLabel":"object"},"instructions":{"type":"string","maxLength":8000,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.browserAutomation.oneOf.0.instructions","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.browserAutomation.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.browserAutomation.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.browserAutomation","typeLabel":"object | null"},"voucherScope":{"description":"shop = all products, products = selected assigned products. Repeat Buyer defaults to shop.","type":"string","enum":["products","shop"],"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.voucherScope","typeLabel":"enum\u003cstring>"},"voucherReward":{"description":"Seller Center reward type. coins_cashback is a percentage greater than 3 and does not reduce salePrice.","type":"string","enum":["discount","coins_cashback"],"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.voucherReward","typeLabel":"enum\u003cstring>"},"voucherAudience":{"type":"string","enum":["general","shop_follow"],"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.voucherAudience","typeLabel":"enum\u003cstring>"},"repeatPurchaseMinCount":{"description":"Shopee Repeat Buyer: minimum completed shop orders, 1 or 2. Required for shopee_repeat_buyer.","type":"integer","minimum":1,"maximum":999,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.repeatPurchaseMinCount","typeLabel":"integer"},"repeatPurchaseLookbackDays":{"description":"Shopee Repeat Buyer: lookback window in days, one of 30, 90, 180 or 365. Required for shopee_repeat_buyer.","type":"integer","minimum":1,"maximum":365,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.repeatPurchaseLookbackDays","typeLabel":"integer"},"smartVoucher":{"description":"Shopee Smart Voucher toggle. Used by New Buyer and similar portal types.","type":"boolean","uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.smartVoucher","typeLabel":"boolean"},"followPrizeExpiryDays":{"description":"Shopee Follow Prize: days after claim until expiry. Seller Center is 7.","type":"integer","minimum":1,"maximum":30,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.followPrizeExpiryDays","typeLabel":"integer"},"videoDisplayMode":{"description":"Shopee Video display: shopee_video = all Shopee Video; creator_video = targeted creator videos only.","type":"string","enum":["shopee_video","creator_video"],"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.videoDisplayMode","typeLabel":"enum\u003cstring>"},"exclusiveCreatorUsernames":{"description":"Exclusive Creator Voucher: up to 15 Shopee usernames.","maxItems":15,"type":"array","items":{"type":"string","minLength":1,"maxLength":64,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.exclusiveCreatorUsernames.items.[INDEX]","typeLabel":"string"},"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.exclusiveCreatorUsernames","typeLabel":"string[]"},"exclusiveStreamerUsernames":{"description":"Exclusive Streamer Voucher: up to 15 Shopee usernames.","maxItems":15,"type":"array","items":{"type":"string","minLength":1,"maxLength":64,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.exclusiveStreamerUsernames.items.[INDEX]","typeLabel":"string"},"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.exclusiveStreamerUsernames","typeLabel":"string[]"},"voucherDisplayChannels":{"description":"Shopee display setting. [\"all\"] = display on all pages; [] = hidden/share by code.","maxItems":4,"type":"array","items":{"type":"string","enum":["all","feed","live","order_page","followers","offline"],"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.voucherDisplayChannels.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.voucherDisplayChannels","typeLabel":"enum\u003cstring>[]"},"bundlePriceType":{"type":"string","enum":["discount","fixed_price"],"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.bundlePriceType","typeLabel":"enum\u003cstring>"},"bundleTiers":{"maxItems":2,"type":"array","items":{"type":"object","properties":{"minimumQuantity":{"type":"integer","minimum":2,"maximum":3000,"isRequired":true,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.bundleTiers.items.[INDEX].minimumQuantity","typeLabel":"integer"},"discountValue":{"type":"number","exclusiveMinimum":0,"isRequired":true,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.bundleTiers.items.[INDEX].discountValue","typeLabel":"number"}},"required":["minimumQuantity","discountValue"],"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.bundleTiers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.bundleTiers","typeLabel":"object[]"},"thresholdType":{"type":"string","enum":["item_quantity","order_amount"],"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.thresholdType","typeLabel":"enum\u003cstring>"},"thresholdValue":{"type":"number","exclusiveMinimum":0,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.thresholdValue","typeLabel":"number"},"giftType":{"type":"string","enum":["gift","sample"],"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.giftType","typeLabel":"enum\u003cstring>"},"giftQuantity":{"type":"integer","exclusiveMinimum":0,"maximum":999,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.giftQuantity","typeLabel":"integer"},"gifts":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"object","properties":{"productId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","isRequired":true,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.gifts.items.[INDEX].productId","typeLabel":"string\u003cuuid>"},"totalClaimLimit":{"type":"integer","minimum":1,"maximum":99999,"isRequired":true,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.gifts.items.[INDEX].totalClaimLimit","typeLabel":"integer"},"variantId":{"oneOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.gifts.items.[INDEX].variantId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.gifts.items.[INDEX].variantId.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.gifts.items.[INDEX].variantId","typeLabel":"string\u003cuuid> | null"}},"required":["productId","totalClaimLimit"],"additionalProperties":false,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.gifts.items.[INDEX]","typeLabel":"object"},"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.gifts","typeLabel":"object[]"},"buyQuantity":{"type":"integer","exclusiveMinimum":0,"maximum":999,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.buyQuantity","typeLabel":"integer"},"getQuantity":{"type":"integer","exclusiveMinimum":0,"maximum":999,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.getQuantity","typeLabel":"integer"},"benefitProductIds":{"minItems":1,"maxItems":200,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.benefitProductIds.items.[INDEX]","typeLabel":"string\u003cuuid>"},"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.benefitProductIds","typeLabel":"string\u003cuuid>[]"},"benefitType":{"type":"string","enum":["free","percentage","fixed_amount"],"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.benefitType","typeLabel":"enum\u003cstring>"},"benefitValue":{"type":"number","minimum":0,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.benefitValue","typeLabel":"number"},"maxApplicationsPerOrder":{"type":"integer","exclusiveMinimum":0,"maximum":999,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.maxApplicationsPerOrder","typeLabel":"integer"},"bundleMinimumQuantity":{"type":"integer","minimum":2,"maximum":3000,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.bundleMinimumQuantity","typeLabel":"integer"},"shippingDeliveryOption":{"description":"Free shipping delivery option. Lazada: STANDARD (default), ECONOMY, EXPRESS, SELLER_OWN_FLEET or P2P, as offered by the store.","type":"string","pattern":"^[A-Z0-9_]{1,40}$","uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.shippingDeliveryOption","typeLabel":"string"},"shippingBudget":{"description":"Free shipping: total shipping subsidy budget in the store currency. Omit for an unlimited budget.","type":"number","exclusiveMinimum":0,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig.shippingBudget","typeLabel":"number"}},"additionalProperties":false,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion.mechanicConfig","typeLabel":"object"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotion","typeLabel":"object"},"promotionId":{"description":"Existing draft promotion attached to this window; the campaign controls its live dates.","type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].promotionId","typeLabel":"string\u003cuuid>"},"productIds":{"default":[],"maxItems":200,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$","uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].productIds.items.[INDEX]","typeLabel":"string\u003cuuid>"},"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].productIds","typeLabel":"string\u003cuuid>[]"},"reviewNotes":{"default":"","type":"string","maxLength":8000,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].reviewNotes","typeLabel":"string"},"excludedReason":{"default":"","type":"string","maxLength":2000,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].excludedReason","typeLabel":"string"},"source":{"type":"object","properties":{"sheet":{"type":"string","maxLength":160,"isRequired":true,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].source.sheet","typeLabel":"string"},"rows":{"maxItems":10000,"type":"array","items":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].source.rows.items.[INDEX]","typeLabel":"integer"},"isRequired":true,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].source.rows","typeLabel":"integer[]"},"headers":{"maxItems":100,"type":"array","items":{"type":"string","maxLength":300,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].source.headers.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].source.headers","typeLabel":"string[]"},"values":{"maxItems":10000,"type":"array","items":{"maxItems":100,"type":"array","items":{"type":"string","maxLength":16000,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].source.values.items.[INDEX].items.[INDEX]","typeLabel":"string"},"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].source.values.items.[INDEX]","typeLabel":"string[]"},"isRequired":true,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].source.values","typeLabel":"string[][]"}},"required":["sheet","rows","headers","values"],"additionalProperties":false,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX].source","typeLabel":"object"}},"required":["id","windowId","promotion"],"additionalProperties":false,"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"campaign.pendingChange.oneOf.0.plan.offers","typeLabel":"object[]"}},"required":["brief"],"additionalProperties":false,"isRequired":true,"uniqueKey":"campaign.pendingChange.oneOf.0.plan","typeLabel":"object"},"proposedBy":{"type":"string","isRequired":true,"uniqueKey":"campaign.pendingChange.oneOf.0.proposedBy","typeLabel":"string"},"proposedAt":{"type":"string","isRequired":true,"uniqueKey":"campaign.pendingChange.oneOf.0.proposedAt","typeLabel":"string"}},"isRequired":true,"uniqueKey":"campaign.pendingChange.oneOf.0","typeLabel":"object"},{"type":"null","description":"A running campaign's proposed plan, applied only when the approver approves it.","isRequired":true,"uniqueKey":"campaign.pendingChange.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"campaign.pendingChange","typeLabel":"object | null"}},"required":["id","organizationId","revision","stage","approval","runId","startedAt","endedAt","createdAt","updatedAt","plan","pendingChange"],"isRequired":true,"uniqueKey":"campaign","typeLabel":"object"},"executions":{"type":"array","items":{"type":"object","properties":{"offerId":{"type":"string","isRequired":true,"uniqueKey":"executions.items.[INDEX].offerId","typeLabel":"string"},"windowId":{"type":"string","isRequired":true,"uniqueKey":"executions.items.[INDEX].windowId","typeLabel":"string"},"promotionId":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"executions.items.[INDEX].promotionId.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"executions.items.[INDEX].promotionId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"executions.items.[INDEX].promotionId","typeLabel":"string | null"},"state":{"type":"string","enum":["draft","activating","prepared","active","ending","ended","failed"],"isRequired":true,"uniqueKey":"executions.items.[INDEX].state","typeLabel":"enum\u003cstring>"},"error":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"executions.items.[INDEX].error.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"executions.items.[INDEX].error.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"executions.items.[INDEX].error","typeLabel":"string | null"},"evidence":{"oneOf":[{"isRequired":true}],"isRequired":true,"uniqueKey":"executions.items.[INDEX].evidence","typeLabel":"any"},"termsRevision":{"oneOf":[{"type":"integer","maximum":9007199254740991,"minimum":-9007199254740991,"isRequired":true,"uniqueKey":"executions.items.[INDEX].termsRevision.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"executions.items.[INDEX].termsRevision.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"executions.items.[INDEX].termsRevision","typeLabel":"integer | null"}},"required":["offerId","windowId","promotionId","state","error","evidence","termsRevision"],"uniqueKey":"executions.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"executions","typeLabel":"object[]"},"audit":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"audit.items.[INDEX].id","typeLabel":"string"},"action":{"type":"string","isRequired":true,"uniqueKey":"audit.items.[INDEX].action","typeLabel":"string"},"actorId":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"audit.items.[INDEX].actorId.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"audit.items.[INDEX].actorId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"audit.items.[INDEX].actorId","typeLabel":"string | null"},"actorName":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"audit.items.[INDEX].actorName.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"audit.items.[INDEX].actorName.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"audit.items.[INDEX].actorName","typeLabel":"string | null"},"createdAt":{"type":"string","isRequired":true,"uniqueKey":"audit.items.[INDEX].createdAt","typeLabel":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"audit.items.[INDEX].details.additionalProperties","typeLabel":"any"},"isRequired":true,"uniqueKey":"audit.items.[INDEX].details","typeLabel":"object"},"summary":{"type":"string","uniqueKey":"audit.items.[INDEX].summary","typeLabel":"string"},"items":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["brief","window","offer"],"isRequired":true,"uniqueKey":"audit.items.[INDEX].\\items.items.[INDEX].kind","typeLabel":"enum\u003cstring>"},"action":{"type":"string","enum":["add","update","remove"],"isRequired":true,"uniqueKey":"audit.items.[INDEX].\\items.items.[INDEX].action","typeLabel":"enum\u003cstring>"},"id":{"type":"string","isRequired":true,"uniqueKey":"audit.items.[INDEX].\\items.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"audit.items.[INDEX].\\items.items.[INDEX].name","typeLabel":"string"},"changes":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"audit.items.[INDEX].\\items.items.[INDEX].changes.items.[INDEX].field","typeLabel":"string"},"label":{"type":"string","isRequired":true,"uniqueKey":"audit.items.[INDEX].\\items.items.[INDEX].changes.items.[INDEX].label","typeLabel":"string"},"from":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"audit.items.[INDEX].\\items.items.[INDEX].changes.items.[INDEX].from.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"audit.items.[INDEX].\\items.items.[INDEX].changes.items.[INDEX].from.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"audit.items.[INDEX].\\items.items.[INDEX].changes.items.[INDEX].from","typeLabel":"string | null"},"to":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"audit.items.[INDEX].\\items.items.[INDEX].changes.items.[INDEX].to.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"audit.items.[INDEX].\\items.items.[INDEX].changes.items.[INDEX].to.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"audit.items.[INDEX].\\items.items.[INDEX].changes.items.[INDEX].to","typeLabel":"string | null"}},"required":["field","label","from","to"],"uniqueKey":"audit.items.[INDEX].\\items.items.[INDEX].changes.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"audit.items.[INDEX].\\items.items.[INDEX].changes","typeLabel":"object[]"}},"required":["kind","action","id","name","changes"],"uniqueKey":"audit.items.[INDEX].\\items.items.[INDEX]","typeLabel":"object"},"uniqueKey":"audit.items.[INDEX].\\items","typeLabel":"object[]"},"hiddenCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"uniqueKey":"audit.items.[INDEX].hiddenCount","typeLabel":"integer"}},"required":["id","action","actorId","actorName","createdAt","details"],"uniqueKey":"audit.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"audit","typeLabel":"object[]"},"readiness":{"type":"array","items":{"type":"string","uniqueKey":"readiness.items.[INDEX]","typeLabel":"string"},"description":"Issues that block approving or running the current plan.","isRequired":true,"uniqueKey":"readiness","typeLabel":"string[]"},"pendingChangeIssues":{"type":"array","items":{"type":"string","uniqueKey":"pendingChangeIssues.items.[INDEX]","typeLabel":"string"},"description":"Issues that block approving the proposed live change.","isRequired":true,"uniqueKey":"pendingChangeIssues","typeLabel":"string[]"},"pendingScheduleCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"pendingScheduleCount","typeLabel":"integer"},"failedScheduleCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"failedScheduleCount","typeLabel":"integer"},"waitingBrowserJobCount":{"type":"integer","minimum":0,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"waitingBrowserJobCount","typeLabel":"integer"},"scheduleIssues":{"type":"array","items":{"type":"object","properties":{"windowId":{"type":"string","isRequired":true,"uniqueKey":"scheduleIssues.items.[INDEX].windowId","typeLabel":"string"},"phase":{"type":"string","enum":["prepare","live"],"isRequired":true,"uniqueKey":"scheduleIssues.items.[INDEX].phase","typeLabel":"enum\u003cstring>"},"kind":{"type":"string","enum":["overdue","missed"],"isRequired":true,"uniqueKey":"scheduleIssues.items.[INDEX].kind","typeLabel":"enum\u003cstring>"}},"required":["windowId","phase","kind"],"uniqueKey":"scheduleIssues.items.[INDEX]","typeLabel":"object"},"uniqueKey":"scheduleIssues","typeLabel":"object[]"},"recovery":{"type":"array","items":{"type":"object","properties":{"windowId":{"type":"string","isRequired":true,"uniqueKey":"recovery.items.[INDEX].windowId","typeLabel":"string"},"phase":{"type":"string","enum":["prepare","live","start","end","revise"],"isRequired":true,"uniqueKey":"recovery.items.[INDEX].phase","typeLabel":"enum\u003cstring>"},"state":{"type":"string","isRequired":true,"uniqueKey":"recovery.items.[INDEX].state","typeLabel":"string"},"attempt":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"recovery.items.[INDEX].attempt","typeLabel":"integer"},"nextRetryAt":{"type":"string","isRequired":true,"uniqueKey":"recovery.items.[INDEX].nextRetryAt","typeLabel":"string"},"error":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"recovery.items.[INDEX].error.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"recovery.items.[INDEX].error.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"recovery.items.[INDEX].error","typeLabel":"string | null"}},"required":["windowId","phase","state","attempt","nextRetryAt","error"],"uniqueKey":"recovery.items.[INDEX]","typeLabel":"object"},"uniqueKey":"recovery","typeLabel":"object[]"},"cleanupFailed":{"type":"boolean","uniqueKey":"cleanupFailed","typeLabel":"boolean"},"progress":{"type":"object","properties":{"asOf":{"type":"string","isRequired":true,"uniqueKey":"progress.asOf","typeLabel":"string"},"title":{"type":"string","isRequired":true,"uniqueKey":"progress.title","typeLabel":"string"},"description":{"type":"string","isRequired":true,"uniqueKey":"progress.description","typeLabel":"string"},"total":{"type":"integer","minimum":0,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"progress.total","typeLabel":"integer"},"counts":{"type":"object","properties":{"waiting":{"type":"integer","minimum":0,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"progress.counts.waiting","typeLabel":"integer"},"preparing":{"type":"integer","minimum":0,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"progress.counts.preparing","typeLabel":"integer"},"prepared":{"type":"integer","minimum":0,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"progress.counts.prepared","typeLabel":"integer"},"live":{"type":"integer","minimum":0,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"progress.counts.live","typeLabel":"integer"},"ending":{"type":"integer","minimum":0,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"progress.counts.ending","typeLabel":"integer"},"ended":{"type":"integer","minimum":0,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"progress.counts.ended","typeLabel":"integer"},"cancelled":{"type":"integer","minimum":0,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"progress.counts.cancelled","typeLabel":"integer"},"failed":{"type":"integer","minimum":0,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"progress.counts.failed","typeLabel":"integer"}},"required":["waiting","preparing","prepared","live","ending","ended","cancelled","failed"],"isRequired":true,"uniqueKey":"progress.counts","typeLabel":"object"},"issues":{"type":"array","items":{"type":"object","properties":{"offerId":{"type":"string","isRequired":true,"uniqueKey":"progress.issues.items.[INDEX].offerId","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"progress.issues.items.[INDEX].name","typeLabel":"string"},"error":{"type":"string","isRequired":true,"uniqueKey":"progress.issues.items.[INDEX].error","typeLabel":"string"}},"required":["offerId","name","error"],"uniqueKey":"progress.issues.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"progress.issues","typeLabel":"object[]"},"scheduleIssues":{"type":"array","items":{"type":"object","properties":{"windowId":{"type":"string","isRequired":true,"uniqueKey":"progress.scheduleIssues.items.[INDEX].windowId","typeLabel":"string"},"phase":{"type":"string","enum":["prepare","live"],"isRequired":true,"uniqueKey":"progress.scheduleIssues.items.[INDEX].phase","typeLabel":"enum\u003cstring>"},"kind":{"type":"string","enum":["overdue","missed"],"isRequired":true,"uniqueKey":"progress.scheduleIssues.items.[INDEX].kind","typeLabel":"enum\u003cstring>"},"name":{"type":"string","isRequired":true,"uniqueKey":"progress.scheduleIssues.items.[INDEX].name","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"progress.scheduleIssues.items.[INDEX].message","typeLabel":"string"}},"required":["windowId","phase","kind","name","message"],"uniqueKey":"progress.scheduleIssues.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"progress.scheduleIssues","typeLabel":"object[]"},"blockers":{"type":"array","items":{"type":"string","uniqueKey":"progress.blockers.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"progress.blockers","typeLabel":"string[]"},"nextWindow":{"oneOf":[{"type":"object","required":["id","name","preparesAt","startsAt","endsAt"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"progress.nextWindow.oneOf.0.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"progress.nextWindow.oneOf.0.name","typeLabel":"string"},"preparesAt":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"progress.nextWindow.oneOf.0.preparesAt.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"progress.nextWindow.oneOf.0.preparesAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"progress.nextWindow.oneOf.0.preparesAt","typeLabel":"string | null"},"startsAt":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"progress.nextWindow.oneOf.0.startsAt.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"progress.nextWindow.oneOf.0.startsAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"progress.nextWindow.oneOf.0.startsAt","typeLabel":"string | null"},"endsAt":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"progress.nextWindow.oneOf.0.endsAt.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"progress.nextWindow.oneOf.0.endsAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"progress.nextWindow.oneOf.0.endsAt","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"progress.nextWindow.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"progress.nextWindow.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"progress.nextWindow","typeLabel":"object | null"}},"required":["asOf","title","description","total","counts","issues","scheduleIssues","blockers","nextWindow"],"uniqueKey":"progress","typeLabel":"object"}},"required":["campaign","executions","audit","readiness","pendingChangeIssues","pendingScheduleCount","failedScheduleCount","waitingBrowserJobCount"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"campaign":{"id":"\u003cstring>","organizationId":"\u003cstring>","revision":0,"stage":"draft","approval":{"revision":0,"userId":"\u003cstring>","approvedAt":"\u003cstring>"},"runId":"\u003cstring>","startedAt":"\u003cstring>","endedAt":"\u003cstring>","createdAt":"\u003cstring>","updatedAt":"\u003cstring>","plan":{"brief":{"name":"\u003cstring>","ownerId":"\u003cstring>","approverId":"\u003cstring>","timezone":"\u003cstring>","objective":"","brand":"","stores":[],"serviceRequest":"","priority":"standard","documentIds":[],"reviewDueAt":"2023-11-07T05:31:56Z","sourceCurrency":"\u003cstring>","sourceMarketplace":"shopee","sourceCountry":"\u003cstring>","cleanupNotes":""},"windows":[],"offers":[{"id":"\u003cstring>","windowId":"\u003cstring>","promotion":{"name":"\u003cstring>","description":"\u003cstring>","kind":"product_discount","salesChannels":["pdp"],"discountType":"percentage","discountValue":1,"storeDiscounts":[{"storeKey":"\u003cstring>","discountType":"percentage","discountValue":1}],"targetStores":[{"marketplace":"lazada","country":"\u003cstring>","storeId":"\u003cstring>"}],"minSalePrice":1,"maxDiscountAmount":1,"minSpend":1,"voucherCode":"\u003cstring>","claimStartsAt":"2023-11-07T05:31:56Z","totalUsageLimit":4503599627370495,"perBuyerLimit":4503599627370495,"mechanicConfig":{"voucherType":"shopee_shop","voucherCampaign":{"campaignId":"\u003cstring>","sessionId":"\u003cstring>","termsAccepted":true},"browserAutomation":{"aopId":"\u003cstring>","variableValues":{},"instructions":"\u003cstring>"},"voucherScope":"products","voucherReward":"discount","voucherAudience":"general","repeatPurchaseMinCount":500,"repeatPurchaseLookbackDays":183,"smartVoucher":true,"followPrizeExpiryDays":15,"videoDisplayMode":"shopee_video","exclusiveCreatorUsernames":["\u003cstring>"],"exclusiveStreamerUsernames":["\u003cstring>"],"voucherDisplayChannels":["all"],"bundlePriceType":"discount","bundleTiers":[{"minimumQuantity":1501,"discountValue":123}],"thresholdType":"item_quantity","thresholdValue":123,"giftType":"gift","giftQuantity":123,"gifts":[{"productId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","totalClaimLimit":50000,"variantId":"3c90c3cc-0d44-4b50-8888-8dd25736052a"}],"buyQuantity":123,"getQuantity":123,"benefitProductIds":["3c90c3cc-0d44-4b50-8888-8dd25736052a"],"benefitType":"free","benefitValue":1,"maxApplicationsPerOrder":123,"bundleMinimumQuantity":1501,"shippingDeliveryOption":"\u003cstring>","shippingBudget":123}},"promotionId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","productIds":[],"reviewNotes":"","excludedReason":"","source":{"sheet":"\u003cstring>","rows":[123],"headers":["\u003cstring>"],"values":[["\u003cstring>"]]}}]},"pendingChange":{"version":0,"plan":{"brief":{"name":"\u003cstring>","ownerId":"\u003cstring>","approverId":"\u003cstring>","timezone":"\u003cstring>","objective":"","brand":"","stores":[],"serviceRequest":"","priority":"standard","documentIds":[],"reviewDueAt":"2023-11-07T05:31:56Z","sourceCurrency":"\u003cstring>","sourceMarketplace":"shopee","sourceCountry":"\u003cstring>","cleanupNotes":""},"windows":[],"offers":[{"id":"\u003cstring>","windowId":"\u003cstring>","promotion":{"name":"\u003cstring>","description":"\u003cstring>","kind":"product_discount","salesChannels":["pdp"],"discountType":"percentage","discountValue":1,"storeDiscounts":[{"storeKey":"\u003cstring>","discountType":"percentage","discountValue":1}],"targetStores":[{"marketplace":"lazada","country":"\u003cstring>","storeId":"\u003cstring>"}],"minSalePrice":1,"maxDiscountAmount":1,"minSpend":1,"voucherCode":"\u003cstring>","claimStartsAt":"2023-11-07T05:31:56Z","totalUsageLimit":4503599627370495,"perBuyerLimit":4503599627370495,"mechanicConfig":{"voucherType":"shopee_shop","voucherCampaign":{"campaignId":"\u003cstring>","sessionId":"\u003cstring>","termsAccepted":true},"browserAutomation":{"aopId":"\u003cstring>","variableValues":{},"instructions":"\u003cstring>"},"voucherScope":"products","voucherReward":"discount","voucherAudience":"general","repeatPurchaseMinCount":500,"repeatPurchaseLookbackDays":183,"smartVoucher":true,"followPrizeExpiryDays":15,"videoDisplayMode":"shopee_video","exclusiveCreatorUsernames":["\u003cstring>"],"exclusiveStreamerUsernames":["\u003cstring>"],"voucherDisplayChannels":["all"],"bundlePriceType":"discount","bundleTiers":[{"minimumQuantity":1501,"discountValue":123}],"thresholdType":"item_quantity","thresholdValue":123,"giftType":"gift","giftQuantity":123,"gifts":[{"productId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","totalClaimLimit":50000,"variantId":"3c90c3cc-0d44-4b50-8888-8dd25736052a"}],"buyQuantity":123,"getQuantity":123,"benefitProductIds":["3c90c3cc-0d44-4b50-8888-8dd25736052a"],"benefitType":"free","benefitValue":1,"maxApplicationsPerOrder":123,"bundleMinimumQuantity":1501,"shippingDeliveryOption":"\u003cstring>","shippingBudget":123}},"promotionId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","productIds":[],"reviewNotes":"","excludedReason":"","source":{"sheet":"\u003cstring>","rows":[123],"headers":["\u003cstring>"],"values":[["\u003cstring>"]]}}]},"proposedBy":"\u003cstring>","proposedAt":"\u003cstring>"}},"executions":[{"offerId":"\u003cstring>","windowId":"\u003cstring>","promotionId":"\u003cstring>","state":"draft","error":"\u003cstring>","evidence":"\u003cunknown>","termsRevision":0}],"audit":[{"id":"\u003cstring>","action":"\u003cstring>","actorId":"\u003cstring>","actorName":"\u003cstring>","createdAt":"\u003cstring>","details":{},"summary":"\u003cstring>","items":[{"kind":"brief","action":"add","id":"\u003cstring>","name":"\u003cstring>","changes":[{"field":"\u003cstring>","label":"\u003cstring>","from":"\u003cstring>","to":"\u003cstring>"}]}],"hiddenCount":4503599627370495}],"readiness":["\u003cstring>"],"pendingChangeIssues":["\u003cstring>"],"pendingScheduleCount":4503599627370495,"failedScheduleCount":4503599627370495,"waitingBrowserJobCount":4503599627370495,"scheduleIssues":[{"windowId":"\u003cstring>","phase":"prepare","kind":"overdue"}],"recovery":[{"windowId":"\u003cstring>","phase":"prepare","state":"\u003cstring>","attempt":0,"nextRetryAt":"\u003cstring>","error":"\u003cstring>"}],"cleanupFailed":true,"progress":{"asOf":"\u003cstring>","title":"\u003cstring>","description":"\u003cstring>","total":4503599627370495,"counts":{"waiting":4503599627370495,"preparing":4503599627370495,"prepared":4503599627370495,"live":4503599627370495,"ending":4503599627370495,"ended":4503599627370495,"cancelled":4503599627370495,"failed":4503599627370495},"issues":[{"offerId":"\u003cstring>","name":"\u003cstring>","error":"\u003cstring>"}],"scheduleIssues":[{"windowId":"\u003cstring>","phase":"prepare","kind":"overdue","name":"\u003cstring>","message":"\u003cstring>"}],"blockers":["\u003cstring>"],"nextWindow":{"id":"\u003cstring>","name":"\u003cstring>","preparesAt":"\u003cstring>","startsAt":"\u003cstring>","endsAt":"\u003cstring>"}}}}},"exampleType":"generated"}},"exampleType":"generated"},"619bbe95-7f9e-47c8-a084-cdcf1818f383":{"description":"Invalid campaign payload or plan state.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"d6fccc0a-e32a-4b2f-89da-637553144dce":{"description":"Unauthorized","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"ee1c1d19-bd62-42bc-ae10-da166956a418":{"description":"Forbidden: missing `promotions:write` scope, or a session member without organization-wide access","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"3a50729c-592c-431d-8267-e34365d6ead5":{"description":"Rate limit exceeded","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"0ff18cb6-c896-4383-8cec-eb9145dfb751":{"description":"Internal Server Error","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"f364c120-6d02-4a67-a31f-b94924bdcd7e":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"39970a03-ff72-4559-a542-364a55d2e30f":{"url":"https://omnicommerce.sg","description":"Production"},"1047c457-3777-4869-be4f-4e086fafbbca":{"url":"http://localhost:3000","description":"Local development"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"omnicommerce","siteName":"OmniCommerce","title":"Create Campaign - OmniCommerce","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-23T07:13:57.416Z","originalFileLocation":"api-reference/campaigns/create-campaign.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=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Create a draft campaign. ownerId and approverId must be members of the organization, and every store must already be connected. Requires promotions:write.\">\u003cmeta data-mint-head name=\"application-name\" content=\"OmniCommerce\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/omnicommerce/20sPCJ3GohzNbY_P/_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=\"/mintlify-assets/_mintlify/favicons/omnicommerce/20sPCJ3GohzNbY_P/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/omnicommerce/20sPCJ3GohzNbY_P/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/omnicommerce/20sPCJ3GohzNbY_P/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/omnicommerce/20sPCJ3GohzNbY_P/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/omnicommerce/20sPCJ3GohzNbY_P/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/omnicommerce/20sPCJ3GohzNbY_P/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/omnicommerce/20sPCJ3GohzNbY_P/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/omnicommerce/20sPCJ3GohzNbY_P/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create Campaign - OmniCommerce\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a draft campaign. ownerId and approverId must be members of the organization, and every store must already be connected. Requires promotions:write.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"OmniCommerce Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.omnicommerce.sg/api-reference/campaigns/create-campaign\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://omnicommerce.mintlify.app/_mintlify/api/og/v2?division=Campaigns\u0026amp;title=Create+Campaign\u0026amp;description=Create+a+draft+campaign.+%60ownerId%60+and+%60approverId%60+must+be+members+of+the+organization%2C+and+every+store+must+already+be+connected.+Requires+%60promotions%3Awrite%60.\u0026amp;theme=1a59a306fe3109e355163fa6\u0026amp;signature=68ebe7922a52ff6a6ea44ff757d4e0cfb259d3e88fddfae1f3ca342af2f5cf71\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create Campaign - OmniCommerce\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a draft campaign. ownerId and approverId must be members of the organization, and every store must already be connected. Requires promotions:write.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://omnicommerce.mintlify.app/_mintlify/api/og/v2?division=Campaigns\u0026amp;title=Create+Campaign\u0026amp;description=Create+a+draft+campaign.+%60ownerId%60+and+%60approverId%60+must+be+members+of+the+organization%2C+and+every+store+must+already+be+connected.+Requires+%60promotions%3Awrite%60.\u0026amp;theme=1a59a306fe3109e355163fa6\u0026amp;signature=68ebe7922a52ff6a6ea44ff757d4e0cfb259d3e88fddfae1f3ca342af2f5cf71\">\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=\"/mintlify-assets/_mintlify/favicons/omnicommerce/20sPCJ3GohzNbY_P/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"OmniCommerce\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0F766E\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.omnicommerce.sg/api-reference/campaigns/create-campaign\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/campaigns/create-campaign.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.omnicommerce.sg/#organization\",\"name\":\"OmniCommerce\",\"url\":\"https://docs.omnicommerce.sg\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/omnicommerce/B2cjFTJ7Zt2npdeV/logo/light.svg?fit=max\u0026auto=format\u0026n=B2cjFTJ7Zt2npdeV\u0026q=85\u0026s=e012509da06089923275e6b0415addf9\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.omnicommerce.sg#website\",\"name\":\"OmniCommerce\",\"url\":\"https://docs.omnicommerce.sg\",\"publisher\":{\"@id\":\"https://docs.omnicommerce.sg/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.omnicommerce.sg/api-reference/campaigns/create-campaign#webpage\",\"url\":\"https://docs.omnicommerce.sg/api-reference/campaigns/create-campaign\",\"name\":\"Create Campaign\",\"description\":\"Create a draft campaign. ownerId and approverId must be members of the organization, and every store must already be connected. Requires promotions:write.\",\"dateModified\":\"2026-10-23T07:13:57.416Z\",\"isPartOf\":{\"@id\":\"https://docs.omnicommerce.sg#website\"},\"breadcrumb\":{\"@id\":\"https://docs.omnicommerce.sg/api-reference/campaigns/create-campaign#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.omnicommerce.sg/api-reference/campaigns/create-campaign#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.omnicommerce.sg/api-reference/agents/invoke-the-omni-agent\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Campaigns\",\"item\":\"https://docs.omnicommerce.sg/api-reference/campaigns/list-campaigns\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create Campaign\",\"item\":\"https://docs.omnicommerce.sg/api-reference/campaigns/create-campaign\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.omnicommerce.sg/api-reference/campaigns/create-campaign#apireference\",\"headline\":\"Create Campaign\",\"name\":\"Create Campaign\",\"description\":\"Create a draft campaign. ownerId and approverId must be members of the organization, and every store must already be connected. Requires promotions:write.\",\"url\":\"https://docs.omnicommerce.sg/api-reference/campaigns/create-campaign\",\"mainEntityOfPage\":{\"@id\":\"https://docs.omnicommerce.sg/api-reference/campaigns/create-campaign#webpage\"},\"dateModified\":\"2026-10-23T07:13:57.416Z\",\"publisher\":{\"@id\":\"https://docs.omnicommerce.sg/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.omnicommerce.sg#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"OmniCommerce\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"OmniCommerce","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API Reference","href":"/api-reference"}]},{"group":"Endpoints","pages":[{"group":"Agents","pages":[{"title":"Invoke the Omni agent","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/agents/general/invoke","href":"/api-reference/agents/invoke-the-omni-agent"},{"title":"Start an Omni agent run","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/agents/general/runs","href":"/api-reference/agents/start-an-omni-agent-run"},{"title":"Get an Omni agent run","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/agents/general/runs/{runId}","href":"/api-reference/agents/get-an-omni-agent-run"}]},{"group":"Analytics","pages":[{"title":"Get Ads Analytics","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/analytics/ads","href":"/api-reference/analytics/get-ads-analytics"},{"title":"Get AI Traffic Analytics","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/analytics/ai-traffic","href":"/api-reference/analytics/get-ai-traffic-analytics"},{"title":"Get Video and LIVE Analytics","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/analytics/content","href":"/api-reference/analytics/get-video-and-live-analytics"},{"title":"Get Order Analytics","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/analytics/orders","href":"/api-reference/analytics/get-order-analytics"},{"title":"Get Growth Overview","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/analytics/overview","href":"/api-reference/analytics/get-growth-overview"},{"title":"Get Pricing Analytics","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/analytics/pricing","href":"/api-reference/analytics/get-pricing-analytics"},{"title":"Get Product Analytics","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/analytics/products","href":"/api-reference/analytics/get-product-analytics"},{"title":"Get Profit Analytics","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/analytics/profit","href":"/api-reference/analytics/get-profit-analytics"},{"title":"Get Business Report","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/analytics/reports","href":"/api-reference/analytics/get-business-report"},{"title":"Get Store Analytics","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/analytics/stores","href":"/api-reference/analytics/get-store-analytics"},{"title":"Get Traffic Analytics","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/analytics/traffic","href":"/api-reference/analytics/get-traffic-analytics"}]},{"group":"AOPs","pages":[{"title":"Get AOP configuration","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/aop/{aopId}/config","href":"/api-reference/aops/get-aop-configuration"},{"title":"Overwrite AOP configuration","deprecated":null,"version":null,"openapi":"/openapi.json put /api/v1/aop/{aopId}/config","href":"/api-reference/aops/overwrite-aop-configuration"},{"title":"Execute an AOP","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/aop/{aopId}/execute","href":"/api-reference/aops/execute-an-aop"},{"title":"Create AOP","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/aop/create","href":"/api-reference/aops/create-aop"},{"title":"Retry a failed AOP execution","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/aop/retry","href":"/api-reference/aops/retry-a-failed-aop-execution"},{"title":"Get Thread Status","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/threads/{thread_id}/status","href":"/api-reference/aops/get-thread-status"}]},{"group":"Developer Platform","pages":[{"title":"Import BrandsGateway Products","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/brandsgateway/import","href":"/api-reference/developer-platform/import-brandsgateway-products"},{"title":"Evaluate SKU Readiness","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/evaluate","href":"/api-reference/developer-platform/evaluate-sku-readiness"},{"title":"Generate Ghost Mannequin Image","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/images/ghost-mannequin","href":"/api-reference/developer-platform/generate-ghost-mannequin-image"},{"title":"Get Developer Job Status","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/jobs/{jobId}","href":"/api-reference/developer-platform/get-developer-job-status"},{"title":"Cancel Developer Job","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/jobs/{jobId}/cancel","href":"/api-reference/developer-platform/cancel-developer-job"},{"title":"Recommend Marketplace Product Categories","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/manage-product-category/recommend","href":"/api-reference/developer-platform/recommend-marketplace-product-categories"},{"title":"List Connected Marketplaces","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/marketplaces/connected","href":"/api-reference/developer-platform/list-connected-marketplaces"},{"title":"Run AI Shelf Share Monitor","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/monitor","href":"/api-reference/developer-platform/run-ai-shelf-share-monitor"},{"title":"Sync Product Commercial Fields","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/sync","href":"/api-reference/developer-platform/sync-product-commercial-fields"},{"title":"List Webhook Events","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/webhook-events","href":"/api-reference/developer-platform/list-webhook-events"},{"title":"List Developer Webhooks","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/webhooks","href":"/api-reference/developer-platform/list-developer-webhooks"},{"title":"Create Developer Webhook","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/webhooks","href":"/api-reference/developer-platform/create-developer-webhook"},{"title":"Get Selected Zalora Import Status","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/zalora/import","href":"/api-reference/developer-platform/get-selected-zalora-import-status"},{"title":"Import Selected Zalora Products","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/zalora/import","href":"/api-reference/developer-platform/import-selected-zalora-products"}]},{"group":"Campaigns","pages":[{"title":"List Campaigns","description":"List campaigns for the authenticated organization. `stage=all` is the workspace working set: draft and running. Requires `promotions:read`.","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/campaigns","href":"/api-reference/campaigns/list-campaigns"},{"title":"Create Campaign","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/campaigns","href":"/api-reference/campaigns/create-campaign"},{"title":"Get Campaign","description":"Read one campaign, including its plan, executions, audit, schedule, and progress. Requires `promotions:read`.","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/campaigns/{campaignId}","href":"/api-reference/campaigns/get-campaign"},{"title":"Update Campaign","deprecated":null,"version":null,"openapi":"/openapi.json put /api/v1/campaigns/{campaignId}","href":"/api-reference/campaigns/update-campaign"},{"title":"Act on Campaign","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/campaigns/{campaignId}/actions","href":"/api-reference/campaigns/act-on-campaign"},{"title":"Archive Campaigns","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/campaigns/archive","href":"/api-reference/campaigns/archive-campaigns"},{"title":"Delete Campaigns","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/campaigns/delete","href":"/api-reference/campaigns/delete-campaigns"},{"title":"Get Campaign Options","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/campaigns/options","href":"/api-reference/campaigns/get-campaign-options"}]},{"group":"Products","pages":[{"title":"Export Catalog Items","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/catalog/items","href":"/api-reference/products/export-catalog-items"},{"title":"List Products","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/products","href":"/api-reference/products/list-products"},{"title":"Create Product","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/products","href":"/api-reference/products/create-product"},{"title":"Get Product","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/products/{productId}","href":"/api-reference/products/get-product"},{"title":"Delete Product","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/products/{productId}","href":"/api-reference/products/delete-product"},{"title":"Update Product","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/products/{productId}","href":"/api-reference/products/update-product"},{"title":"Update Product Cost","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/products/{productId}/cost","href":"/api-reference/products/update-product-cost"},{"title":"Delist Product","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/products/{productId}/delist","href":"/api-reference/products/delist-product"},{"title":"Upload Product Image","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/products/{productId}/images","href":"/api-reference/products/upload-product-image"},{"title":"Update Product Inventory","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/products/{productId}/inventory","href":"/api-reference/products/update-product-inventory"},{"title":"Get Product Listings","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/products/{productId}/listings","href":"/api-reference/products/get-product-listings"},{"title":"Update Product Price","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/products/{productId}/price","href":"/api-reference/products/update-product-price"},{"title":"Publish Product","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/products/{productId}/publish","href":"/api-reference/products/publish-product"},{"title":"Bulk Import Products from JSON or CSV","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/products/bulk-import","href":"/api-reference/products/bulk-import-products-from-json-or-csv"},{"title":"Compare Product Market Prices","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/products/compare-prices","href":"/api-reference/products/compare-product-market-prices"},{"title":"Get Product Price Comparison","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/products/compare-prices/jobs/{jobId}","href":"/api-reference/products/get-product-price-comparison"},{"title":"Batch Update Product Cost","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/products/cost","href":"/api-reference/products/batch-update-product-cost"},{"title":"Queue Product Enrichment","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/products/enrich","href":"/api-reference/products/queue-product-enrichment"}]},{"group":"Agentic Checkout","pages":[{"title":"Create Agentic Checkout Session","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/checkout-sessions","href":"/api-reference/agentic-checkout/create-agentic-checkout-session"},{"title":"Get Agentic Checkout Session","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/checkout-sessions/{sessionId}","href":"/api-reference/agentic-checkout/get-agentic-checkout-session"},{"title":"Replace Agentic Checkout Session Fields","deprecated":null,"version":null,"openapi":"/openapi.json put /api/v1/checkout-sessions/{sessionId}","href":"/api-reference/agentic-checkout/replace-agentic-checkout-session-fields"},{"title":"Update Agentic Checkout Session","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/checkout-sessions/{sessionId}","href":"/api-reference/agentic-checkout/update-agentic-checkout-session"},{"title":"Cancel Agentic Checkout Session","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/checkout-sessions/{sessionId}/cancel","href":"/api-reference/agentic-checkout/cancel-agentic-checkout-session"},{"title":"Complete Agentic Checkout Session","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/checkout-sessions/{sessionId}/complete","href":"/api-reference/agentic-checkout/complete-agentic-checkout-session"}]},{"group":"Public Agent","pages":[{"title":"Compare Public Products","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/compare","href":"/api-reference/public-agent/compare-public-products"},{"title":"List Public Merchants","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/directory","href":"/api-reference/public-agent/list-public-merchants"},{"title":"Get Merchant LLM Feed","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/feed/{domain}/llms.txt","href":"/api-reference/public-agent/get-merchant-llm-feed"},{"title":"Get Public Merchant Manifest","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/merchants/{merchantId}/manifest","href":"/api-reference/public-agent/get-public-merchant-manifest"},{"title":"List Public Merchant Products","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/merchants/{merchantId}/products","href":"/api-reference/public-agent/list-public-merchant-products"},{"title":"Search Within Public Merchant Catalog","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/merchants/{merchantId}/search","href":"/api-reference/public-agent/search-within-public-merchant-catalog"},{"title":"Search Public Merchant Products","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/search","href":"/api-reference/public-agent/search-public-merchant-products"},{"title":"Search Public Merchant Products","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/search","href":"/api-reference/public-agent/search-public-merchant-products-1"}]},{"group":"Knowledge Base","pages":[{"title":"Upload Document","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/documents","href":"/api-reference/documents/upload-document"},{"title":"Get Document","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/documents/{documentId}","href":"/api-reference/documents/get-document"}]},{"group":"Looks","pages":[{"title":"List Looks","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/looks","href":"/api-reference/looks/list-looks"},{"title":"Create Look","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/looks","href":"/api-reference/looks/create-look"},{"title":"Get Look","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/looks/{lookId}","href":"/api-reference/looks/get-look"}]},{"group":"OAuth","pages":[{"title":"Revoke Access Token","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/oauth/revoke","href":"/api-reference/oauth/revoke-access-token"},{"title":"Get Access Token","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/oauth/token","href":"/api-reference/oauth/get-access-token"}]},{"group":"Orders","pages":[{"title":"List Orders","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/orders","href":"/api-reference/orders/list-orders"},{"title":"Create Order","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/orders","href":"/api-reference/orders/create-order"},{"title":"Get Order","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/orders/{orderId}","href":"/api-reference/orders/get-order"},{"title":"Update Order","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/orders/{orderId}","href":"/api-reference/orders/update-order"},{"title":"Get Order Action Options","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/orders/{orderId}/action-options","href":"/api-reference/orders/get-order-action-options"},{"title":"List Order Actions","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/orders/{orderId}/actions","href":"/api-reference/orders/list-order-actions"},{"title":"Queue Order Action","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/orders/{orderId}/actions","href":"/api-reference/orders/queue-order-action"}]},{"group":"Organizations","pages":[{"title":"Create Organization","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/organizations","href":"/api-reference/organizations/create-organization"}]},{"group":"Price Books","pages":[{"title":"List Price Book Rules","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/price-books","href":"/api-reference/price-books/list-price-book-rules"},{"title":"Create Price Book Rule","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/price-books","href":"/api-reference/price-books/create-price-book-rule"},{"title":"Get Price Book Rule","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/price-books/{ruleId}","href":"/api-reference/price-books/get-price-book-rule"},{"title":"Delete Price Book Rule","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/price-books/{ruleId}","href":"/api-reference/price-books/delete-price-book-rule"},{"title":"Update Price Book Rule","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/price-books/{ruleId}","href":"/api-reference/price-books/update-price-book-rule"},{"title":"Preview Channel List Price","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/price-books/preview","href":"/api-reference/price-books/preview-channel-list-price"}]},{"group":"Promotions","pages":[{"title":"List Promotions","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/promotions","href":"/api-reference/promotions/list-promotions"},{"title":"Create Promotion","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/promotions","href":"/api-reference/promotions/create-promotion"},{"title":"Get Promotion","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/promotions/{promotionId}","href":"/api-reference/promotions/get-promotion"},{"title":"Delete Promotion","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/promotions/{promotionId}","href":"/api-reference/promotions/delete-promotion"},{"title":"Update Promotion","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/v1/promotions/{promotionId}","href":"/api-reference/promotions/update-promotion"},{"title":"List Promotion Assignments","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/promotions/{promotionId}/products","href":"/api-reference/promotions/list-promotion-assignments"},{"title":"Assign Products to Promotion","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/promotions/{promotionId}/products","href":"/api-reference/promotions/assign-products-to-promotion"},{"title":"Unassign Products from Promotion","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/v1/promotions/{promotionId}/products","href":"/api-reference/promotions/unassign-products-from-promotion"},{"title":"Retry Marketplace Delivery","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/promotions/{promotionId}/retry","href":"/api-reference/promotions/retry-marketplace-delivery"}]},{"group":"Returns","pages":[{"title":"List Returns","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/returns","href":"/api-reference/returns/list-returns"},{"title":"Get Return","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/returns/{returnId}","href":"/api-reference/returns/get-return"}]},{"group":"Reviews","pages":[{"title":"List Reviews","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/reviews","href":"/api-reference/reviews/list-reviews"},{"title":"Get Review","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/reviews/{reviewId}","href":"/api-reference/reviews/get-review"},{"title":"Reply to Review","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/reviews/{reviewId}/reply","href":"/api-reference/reviews/reply-to-review"}]},{"group":"Settlements","pages":[{"title":"List Settlements","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/settlements","href":"/api-reference/settlements/list-settlements"},{"title":"Apply Settlements","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/settlements","href":"/api-reference/settlements/apply-settlements"},{"title":"Get Settlement","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/settlements/{settlementId}","href":"/api-reference/settlements/get-settlement"}]},{"group":"UCP","pages":[{"title":"Create UCP Checkout Session","deprecated":null,"version":null,"openapi":"/openapi.json post /ucp/v1/checkout-sessions","href":"/api-reference/ucp/create-ucp-checkout-session"},{"title":"Get UCP Checkout Session","deprecated":null,"version":null,"openapi":"/openapi.json get /ucp/v1/checkout-sessions/{sessionId}","href":"/api-reference/ucp/get-ucp-checkout-session"},{"title":"Replace UCP Checkout Session Fields","deprecated":null,"version":null,"openapi":"/openapi.json put /ucp/v1/checkout-sessions/{sessionId}","href":"/api-reference/ucp/replace-ucp-checkout-session-fields"},{"title":"Update UCP Checkout Session","deprecated":null,"version":null,"openapi":"/openapi.json patch /ucp/v1/checkout-sessions/{sessionId}","href":"/api-reference/ucp/update-ucp-checkout-session"},{"title":"Cancel UCP Checkout Session","deprecated":null,"version":null,"openapi":"/openapi.json post /ucp/v1/checkout-sessions/{sessionId}/cancel","href":"/api-reference/ucp/cancel-ucp-checkout-session"},{"title":"Complete UCP Checkout Session","deprecated":null,"version":null,"openapi":"/openapi.json post /ucp/v1/checkout-sessions/{sessionId}/complete","href":"/api-reference/ucp/complete-ucp-checkout-session"},{"title":"Get UCP Order","deprecated":null,"version":null,"openapi":"/openapi.json get /ucp/v1/orders/{orderId}","href":"/api-reference/ucp/get-ucp-order"}]},{"group":"product webhooks","pages":[]},{"group":"enrichment webhooks","pages":[]},{"group":"look webhooks","pages":[]},{"group":"review webhooks","pages":[]},{"group":"order webhooks","pages":[]},{"group":"settlement webhooks","pages":[]},{"group":"return webhooks","pages":[]},{"group":"account statement webhooks","pages":[]}]},{"group":"Webhooks","pages":[{"group":"Product","pages":[{"title":"Product created","openapi":"openapi.json webhook productCreated","href":"/webhooks/reference/product-created"},{"title":"Product updated","openapi":"openapi.json webhook productUpdated","href":"/webhooks/reference/product-updated"},{"title":"Product deleted","openapi":"openapi.json webhook productDeleted","href":"/webhooks/reference/product-deleted"},{"title":"Product delisted","openapi":"openapi.json webhook productDelisted","href":"/webhooks/reference/product-delisted"},{"title":"Product price changed","openapi":"openapi.json webhook productPriceChanged","href":"/webhooks/reference/product-price-changed"},{"title":"Product inventory changed","openapi":"openapi.json webhook productInventoryChanged","href":"/webhooks/reference/product-inventory-changed"}]},{"group":"Orders","pages":[{"title":"Order created","openapi":"openapi.json webhook orderCreated","href":"/webhooks/reference/order-created"},{"title":"Order updated","openapi":"openapi.json webhook orderUpdated","href":"/webhooks/reference/order-updated"},{"title":"Order status changed","openapi":"openapi.json webhook orderStatusChanged","href":"/webhooks/reference/order-status-changed"},{"title":"Order deleted","openapi":"openapi.json webhook orderDeleted","href":"/webhooks/reference/order-deleted"}]},{"group":"Looks","pages":[{"title":"Look created","openapi":"openapi.json webhook lookCreated","href":"/webhooks/reference/look-created"},{"title":"Look deleted","openapi":"openapi.json webhook lookDeleted","href":"/webhooks/reference/look-deleted"}]},{"group":"Review","pages":[{"title":"Review created","openapi":"openapi.json webhook reviewCreated","href":"/webhooks/reference/review-created"},{"title":"Review updated","openapi":"openapi.json webhook reviewUpdated","href":"/webhooks/reference/review-updated"},{"title":"Review status changed","openapi":"openapi.json webhook reviewStatusChanged","href":"/webhooks/reference/review-status-changed"}]},{"group":"Settlements","pages":[{"title":"Settlement created","openapi":"openapi.json webhook settlementCreated","href":"/webhooks/reference/settlement-created"},{"title":"Settlement updated","openapi":"openapi.json webhook settlementUpdated","href":"/webhooks/reference/settlement-updated"},{"title":"Settlement status changed","openapi":"openapi.json webhook settlementStatusChanged","href":"/webhooks/reference/settlement-status-changed"}]},{"group":"Returns","pages":[{"title":"Return created","openapi":"openapi.json webhook returnCreated","href":"/webhooks/reference/return-created"},{"title":"Return updated","openapi":"openapi.json webhook returnUpdated","href":"/webhooks/reference/return-updated"},{"title":"Return status changed","openapi":"openapi.json webhook returnStatusChanged","href":"/webhooks/reference/return-status-changed"}]}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"title":"Create Campaign - OmniCommerce","buildId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","deploymentId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Bbp7I60D.js","utils-C3RIvJha.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DqD-vLt8.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B31Loprg.js","snippetPresets-DKpk-b8t.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Cj65AhOR.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BXtn5gcC.js","shallow-RY2b03Cp.js","getApiPlaygroundDisplay-B0jeiPk3.js","CodeSnippet-CYgBjjwn.js","CodeSnippets-DOngDrYB.js","Page-n7I5XbKb.js","getPastedJson-DRQbJx-T.js","icon-CQiQCicY.js","MethodPill-BKTLdNtu.js","DuplicateIcon-B9jpAdat.js","createIcon-DCddRrXv.js","DynamicMarkdown-a8hUKrw6.js","SectionHeading-eECVV2eH.js","axios-vUo_bRtp.js","Markdown--GF7ZIpf.js","clsx-DZLdJUrt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-2LoAhjKH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Zwc0ZncM.js"]}