Create a central promotion targeting connected stores. Requires promotions:write. Fixed-amount discounts resolve currency from the selected store countries.
{"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/promotions/create-promotion","slug":"/api-reference/promotions/create-promotion","pageMetadata":{"title":"Create Promotion","description":"Create a central promotion targeting connected stores. Requires `promotions:write`. Fixed-amount discounts resolve currency from the selected store countries.","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/promotions","href":"/api-reference/promotions/create-promotion","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 central promotion targeting connected stores. Requires \", _jsx(_components.code, {\n children: \"promotions:write\"\n }), \". Fixed-amount discounts resolve currency from the selected store countries.\"]\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 Promotion","description":"Create a central promotion targeting connected stores. Requires `promotions:write`. Fixed-amount discounts resolve currency from the selected store countries.","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/promotions","href":"/api-reference/promotions/create-promotion","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"post_v1_promotions","summary":"Create Promotion","description":"Create a central promotion targeting connected stores. Requires `promotions:write`. Fixed-amount discounts resolve currency from the selected store countries.","tags":["promotions"],"security":["fa0b8745-f7ef-465e-ae90-84323f52f73b"],"requestBody":"87603832-b4c3-463e-9f4e-7615d12b4b7c","responses":{"201":"157e4fb7-ce74-4c57-814a-96054a514299","400":"e92ab494-0d5c-427b-aafe-237351724010","401":"3a756d17-0749-405f-8fd0-ceae200896c6","403":"2ca007cd-095a-4173-8f8c-575b367f09f9","429":"eefd107f-0691-4197-8d0e-c804fed7a9d6","500":"190f64a7-3542-4acf-996b-ae7525e7fef9"},"method":"post","type":"path","servers":["39970a03-ff72-4559-a542-364a55d2e30f","1047c457-3777-4869-be4f-4e086fafbbca"],"path":"/api/v1/promotions","baseUrlOptions":["https://omnicommerce.sg","http://localhost:3000"],"title":"Create Promotion","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["name","discountType","discountValue","targetStores"],"properties":{"name":{"type":"string","maxLength":200,"isRequired":true,"uniqueKey":"name","typeLabel":"string"},"discountType":{"type":"string","enum":["percentage","fixed_amount"],"isRequired":true,"uniqueKey":"discountType","typeLabel":"enum\u003cstring>"},"discountValue":{"type":"number","minimum":0,"description":"Discount amount or percentage. Use 0 for gift/sample-only and free Buy-X-Get-Y mechanics.","isRequired":true,"uniqueKey":"discountValue","typeLabel":"number"},"targetStores":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"object","additionalProperties":false,"required":["marketplace","country","storeId"],"properties":{"marketplace":{"type":"string","enum":["lazada","shopee","tiktok","shopify","amazon","zalora","ebay"],"isRequired":true,"uniqueKey":"targetStores.items.[INDEX].marketplace","typeLabel":"enum\u003cstring>"},"country":{"type":"string","isRequired":true,"uniqueKey":"targetStores.items.[INDEX].country","typeLabel":"string"},"storeId":{"type":"string","isRequired":true,"uniqueKey":"targetStores.items.[INDEX].storeId","typeLabel":"string"}},"uniqueKey":"targetStores.items.[INDEX]","typeLabel":"object"},"description":"Connected stores as `{ marketplace, country, storeId }`. Copy from existing promotion targetStores or product marketplaceDetails.","isRequired":true,"uniqueKey":"targetStores","typeLabel":"object[]"},"organizationId":{"type":"string","maxLength":120,"description":"Required for session auth across multiple organizations. Optional for OAuth/API keys bound to one organization.","uniqueKey":"organizationId","typeLabel":"string"},"description":{"oneOf":[{"type":"string","maxLength":2000,"uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":2000,"uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"kind":{"type":"string","enum":["product_discount","flash_sale","voucher","gift_with_purchase","buy_x_get_y","bundle_deal","free_shipping","early_bird_price"],"uniqueKey":"kind","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["draft","scheduled","active","paused","ended","archived"],"default":"active","description":"Defaults to active. Future start dates display as scheduled. Use draft to save without activation; explicit inactive lifecycle states are preserved.","uniqueKey":"status","typeLabel":"enum\u003cstring>"},"startsAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"startsAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"startsAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"startsAt","typeLabel":"string\u003cdate-time> | null"},"endsAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"endsAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"endsAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"endsAt","typeLabel":"string\u003cdate-time> | null"},"minSalePrice":{"oneOf":[{"type":"number","minimum":0,"uniqueKey":"minSalePrice.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"uniqueKey":"minSalePrice.oneOf.1","typeLabel":"null"}],"uniqueKey":"minSalePrice","typeLabel":"number | null"},"maxDiscountAmount":{"oneOf":[{"type":"number","minimum":0,"uniqueKey":"maxDiscountAmount.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"uniqueKey":"maxDiscountAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"maxDiscountAmount","typeLabel":"number | null"},"minSpend":{"oneOf":[{"type":"number","minimum":0,"description":"Lazada voucher minimum spend. Defaults to 1 when unset.","uniqueKey":"minSpend.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"description":"Lazada voucher minimum spend. Defaults to 1 when unset.","uniqueKey":"minSpend.oneOf.1","typeLabel":"null"}],"uniqueKey":"minSpend","typeLabel":"number | null"},"totalUsageLimit":{"oneOf":[{"type":"integer","minimum":1,"description":"Total redemption/order limit, or per-SKU promotional quantity for flash sales.","uniqueKey":"totalUsageLimit.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"description":"Total redemption/order limit, or per-SKU promotional quantity for flash sales.","uniqueKey":"totalUsageLimit.oneOf.1","typeLabel":"null"}],"uniqueKey":"totalUsageLimit","typeLabel":"integer | null"},"mechanicConfig":{"type":"object","additionalProperties":false,"properties":{"voucherCampaign":{"type":"object","additionalProperties":false,"required":["campaignId","sessionId","termsAccepted"],"description":"Exact Shopee campaign/session for Campaign Voucher Nomination, with reviewed participation obligations. Nomination remains a draft until Shopee approval.","properties":{"campaignId":{"type":"string","minLength":1,"maxLength":40,"pattern":"^[1-9][0-9]{0,39}$","isRequired":true,"uniqueKey":"mechanicConfig.voucherCampaign.campaignId","typeLabel":"string"},"sessionId":{"type":"string","minLength":1,"maxLength":40,"pattern":"^[1-9][0-9]{0,39}$","isRequired":true,"uniqueKey":"mechanicConfig.voucherCampaign.sessionId","typeLabel":"string"},"termsAccepted":{"type":"boolean","isRequired":true,"uniqueKey":"mechanicConfig.voucherCampaign.termsAccepted","typeLabel":"boolean"}},"uniqueKey":"mechanicConfig.voucherCampaign","typeLabel":"object"},"voucherType":{"oneOf":[{"type":"string","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",null],"description":"Exact marketplace voucher subtype. Native types use APIs; Seller Center-only types use a browser AOP with per-store eligibility checks.","uniqueKey":"mechanicConfig.voucherType.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","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",null],"description":"Exact marketplace voucher subtype. Native types use APIs; Seller Center-only types use a browser AOP with per-store eligibility checks.","uniqueKey":"mechanicConfig.voucherType.oneOf.1","typeLabel":"null"}],"uniqueKey":"mechanicConfig.voucherType","typeLabel":"enum\u003cstring> | null"},"browserAutomation":{"oneOf":[{"type":"object","additionalProperties":false,"properties":{"variableValues":{"type":"object","maxProperties":100,"additionalProperties":{"type":"string","maxLength":8000,"uniqueKey":"mechanicConfig.browserAutomation.oneOf.0.variableValues.additionalProperties","typeLabel":"string"},"description":"Optional overrides for the selected AOP's declared variables. promotionId, action, and storeId are supplied automatically; the AOP loads the campaign with get_promotions.","uniqueKey":"mechanicConfig.browserAutomation.oneOf.0.variableValues","typeLabel":"object"},"aopId":{"type":"string","minLength":1,"maxLength":160,"description":"Optional organization AOP override. Omit to select the built-in marketplace AOP.","uniqueKey":"mechanicConfig.browserAutomation.oneOf.0.aopId","typeLabel":"string"},"instructions":{"type":"string","maxLength":8000,"uniqueKey":"mechanicConfig.browserAutomation.oneOf.0.instructions","typeLabel":"string"}},"uniqueKey":"mechanicConfig.browserAutomation.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":false,"properties":{"variableValues":{"type":"object","maxProperties":100,"additionalProperties":{"type":"string","maxLength":8000},"description":"Optional overrides for the selected AOP's declared variables. promotionId, action, and storeId are supplied automatically; the AOP loads the campaign with get_promotions."},"aopId":{"type":"string","minLength":1,"maxLength":160,"description":"Optional organization AOP override. Omit to select the built-in marketplace AOP."},"instructions":{"type":"string","maxLength":8000}},"uniqueKey":"mechanicConfig.browserAutomation.oneOf.1","typeLabel":"null"}],"uniqueKey":"mechanicConfig.browserAutomation","typeLabel":"object | null"},"voucherScope":{"type":"string","enum":["products","shop"],"uniqueKey":"mechanicConfig.voucherScope","typeLabel":"enum\u003cstring>"},"voucherReward":{"type":"string","enum":["discount","coins_cashback"],"uniqueKey":"mechanicConfig.voucherReward","typeLabel":"enum\u003cstring>"},"exclusiveStreamerUsernames":{"type":"array","maxItems":15,"items":{"type":"string","minLength":1,"maxLength":64,"uniqueKey":"mechanicConfig.exclusiveStreamerUsernames.items.[INDEX]","typeLabel":"string"},"description":"Approved Shopee usernames targeted by an Exclusive Streamer voucher. The Seller Centre API resolves eligible streamer identities; user IDs must not be supplied here.","uniqueKey":"mechanicConfig.exclusiveStreamerUsernames","typeLabel":"string[]"},"voucherAudience":{"type":"string","enum":["general","shop_follow"],"uniqueKey":"mechanicConfig.voucherAudience","typeLabel":"enum\u003cstring>"},"voucherDisplayChannels":{"type":"array","maxItems":4,"description":"Shopee supports all, feed, live, order_page (update only), or [] for hidden. Lazada requires exactly one of all, live, followers, offline; followers requires voucherScope=shop.","items":{"type":"string","enum":["all","feed","live","order_page","followers","offline"],"uniqueKey":"mechanicConfig.voucherDisplayChannels.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"mechanicConfig.voucherDisplayChannels","typeLabel":"enum\u003cstring>[]"},"bundlePriceType":{"type":"string","enum":["discount","fixed_price"],"uniqueKey":"mechanicConfig.bundlePriceType","typeLabel":"enum\u003cstring>"},"bundleTiers":{"maxItems":2,"type":"array","items":{"type":"object","properties":{"minimumQuantity":{"type":"integer","minimum":2,"maximum":3000,"isRequired":true,"uniqueKey":"mechanicConfig.bundleTiers.items.[INDEX].minimumQuantity","typeLabel":"integer"},"discountValue":{"type":"number","exclusiveMinimum":0,"isRequired":true,"uniqueKey":"mechanicConfig.bundleTiers.items.[INDEX].discountValue","typeLabel":"number"}},"required":["minimumQuantity","discountValue"],"uniqueKey":"mechanicConfig.bundleTiers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"mechanicConfig.bundleTiers","typeLabel":"object[]"},"thresholdType":{"type":"string","enum":["item_quantity","order_amount"],"uniqueKey":"mechanicConfig.thresholdType","typeLabel":"enum\u003cstring>"},"thresholdValue":{"type":"number","exclusiveMinimum":0,"uniqueKey":"mechanicConfig.thresholdValue","typeLabel":"number"},"giftType":{"type":"string","enum":["gift","sample"],"uniqueKey":"mechanicConfig.giftType","typeLabel":"enum\u003cstring>"},"giftQuantity":{"type":"integer","minimum":1,"maximum":999,"uniqueKey":"mechanicConfig.giftQuantity","typeLabel":"integer"},"gifts":{"type":"array","minItems":1,"maxItems":20,"items":{"type":"object","additionalProperties":false,"required":["productId","totalClaimLimit"],"properties":{"productId":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"mechanicConfig.gifts.items.[INDEX].productId","typeLabel":"string\u003cuuid>"},"totalClaimLimit":{"type":"integer","minimum":1,"maximum":99999,"isRequired":true,"uniqueKey":"mechanicConfig.gifts.items.[INDEX].totalClaimLimit","typeLabel":"integer"},"variantId":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"mechanicConfig.gifts.items.[INDEX].variantId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"mechanicConfig.gifts.items.[INDEX].variantId.oneOf.1","typeLabel":"null"}],"uniqueKey":"mechanicConfig.gifts.items.[INDEX].variantId","typeLabel":"string\u003cuuid> | null"}},"uniqueKey":"mechanicConfig.gifts.items.[INDEX]","typeLabel":"object"},"uniqueKey":"mechanicConfig.gifts","typeLabel":"object[]"},"buyQuantity":{"type":"integer","minimum":1,"maximum":999,"uniqueKey":"mechanicConfig.buyQuantity","typeLabel":"integer"},"getQuantity":{"type":"integer","minimum":1,"maximum":999,"uniqueKey":"mechanicConfig.getQuantity","typeLabel":"integer"},"benefitProductIds":{"type":"array","minItems":1,"maxItems":200,"items":{"type":"string","format":"uuid","uniqueKey":"mechanicConfig.benefitProductIds.items.[INDEX]","typeLabel":"string\u003cuuid>"},"uniqueKey":"mechanicConfig.benefitProductIds","typeLabel":"string\u003cuuid>[]"},"benefitType":{"type":"string","enum":["free","percentage","fixed_amount"],"uniqueKey":"mechanicConfig.benefitType","typeLabel":"enum\u003cstring>"},"benefitValue":{"type":"number","minimum":0,"uniqueKey":"mechanicConfig.benefitValue","typeLabel":"number"},"maxApplicationsPerOrder":{"type":"integer","minimum":1,"maximum":999,"uniqueKey":"mechanicConfig.maxApplicationsPerOrder","typeLabel":"integer"},"bundleMinimumQuantity":{"type":"integer","minimum":2,"maximum":3000,"uniqueKey":"mechanicConfig.bundleMinimumQuantity","typeLabel":"integer"},"shippingDeliveryOption":{"type":"string","pattern":"^[A-Z0-9_]{1,40}$","description":"Free shipping delivery option offered by the Lazada store; defaults to STANDARD.","uniqueKey":"mechanicConfig.shippingDeliveryOption","typeLabel":"string"},"shippingBudget":{"type":"number","exclusiveMinimum":0,"description":"Free shipping subsidy budget in the store currency. Omit for an unlimited budget.","uniqueKey":"mechanicConfig.shippingBudget","typeLabel":"number"}},"uniqueKey":"mechanicConfig","typeLabel":"object"},"storeDiscounts":{"type":"array","maxItems":100,"description":"Patch discount overrides by exact target store key. Other stores retain their terms. Null discountValue restores shared terms for that store.","items":{"type":"object","additionalProperties":false,"required":["storeKey","discountType","discountValue"],"properties":{"storeKey":{"type":"string","minLength":1,"maxLength":255,"isRequired":true,"uniqueKey":"storeDiscounts.items.[INDEX].storeKey","typeLabel":"string"},"discountType":{"type":"string","enum":["percentage","fixed_amount"],"isRequired":true,"uniqueKey":"storeDiscounts.items.[INDEX].discountType","typeLabel":"enum\u003cstring>"},"discountValue":{"oneOf":[{"type":"number","minimum":0,"description":"Percentage must not exceed 100.","isRequired":true,"uniqueKey":"storeDiscounts.items.[INDEX].discountValue.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"description":"Percentage must not exceed 100.","isRequired":true,"uniqueKey":"storeDiscounts.items.[INDEX].discountValue.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"storeDiscounts.items.[INDEX].discountValue","typeLabel":"number | null"}},"uniqueKey":"storeDiscounts.items.[INDEX]","typeLabel":"object"},"uniqueKey":"storeDiscounts","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"name":"Christmas","discountType":"fixed_amount","discountValue":12,"targetStores":[{"marketplace":"shopee","country":"singapore","storeId":"115085776"}],"startsAt":"2026-07-06T17:00:00.000Z","endsAt":"2026-08-02T03:59:00.000Z"},"examples":{"Example":{"title":"Example","value":{"name":"Christmas","discountType":"fixed_amount","discountValue":12,"targetStores":[{"marketplace":"shopee","country":"singapore","storeId":"115085776"}],"startsAt":"2026-07-06T17:00:00.000Z","endsAt":"2026-08-02T03:59:00.000Z"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"157e4fb7-ce74-4c57-814a-96054a514299":{"description":"Promotion created.","content":{"application/json":{"schema":{"type":"object","required":["promotion"],"properties":{"promotion":{"type":"object","isRequired":true,"uniqueKey":"promotion","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"promotion":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"e92ab494-0d5c-427b-aafe-237351724010":{"description":"Bad Request","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"3a756d17-0749-405f-8fd0-ceae200896c6":{"description":"Unauthorized","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"2ca007cd-095a-4173-8f8c-575b367f09f9":{"description":"Forbidden or missing `promotions:write` scope","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"eefd107f-0691-4197-8d0e-c804fed7a9d6":{"description":"Rate limit exceeded","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"190f64a7-3542-4acf-996b-ae7525e7fef9":{"description":"Internal Server Error","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"fa0b8745-f7ef-465e-ae90-84323f52f73b":{"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 Promotion - OmniCommerce","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-23T07:13:58.099Z","originalFileLocation":"api-reference/promotions/create-promotion.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"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 central promotion targeting connected stores. Requires promotions:write. Fixed-amount discounts resolve currency from the selected store countries.\">\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 Promotion - OmniCommerce\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a central promotion targeting connected stores. Requires promotions:write. Fixed-amount discounts resolve currency from the selected store countries.\">\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/promotions/create-promotion\">\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=Promotions\u0026amp;title=Create+Promotion\u0026amp;description=Create+a+central+promotion+targeting+connected+stores.+Requires+%60promotions%3Awrite%60.+Fixed-amount+discounts+resolve+currency+from+the+selected+store+countries.\u0026amp;theme=1a59a306fe3109e355163fa6\u0026amp;signature=a0b0fa61c28365b40b133257ee46981f0e6a2e5e4acad388026e1c29f22d4998\">\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 Promotion - OmniCommerce\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a central promotion targeting connected stores. Requires promotions:write. Fixed-amount discounts resolve currency from the selected store countries.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://omnicommerce.mintlify.app/_mintlify/api/og/v2?division=Promotions\u0026amp;title=Create+Promotion\u0026amp;description=Create+a+central+promotion+targeting+connected+stores.+Requires+%60promotions%3Awrite%60.+Fixed-amount+discounts+resolve+currency+from+the+selected+store+countries.\u0026amp;theme=1a59a306fe3109e355163fa6\u0026amp;signature=a0b0fa61c28365b40b133257ee46981f0e6a2e5e4acad388026e1c29f22d4998\">\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/promotions/create-promotion\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/promotions/create-promotion.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/promotions/create-promotion#webpage\",\"url\":\"https://docs.omnicommerce.sg/api-reference/promotions/create-promotion\",\"name\":\"Create Promotion\",\"description\":\"Create a central promotion targeting connected stores. Requires promotions:write. Fixed-amount discounts resolve currency from the selected store countries.\",\"dateModified\":\"2026-10-23T07:13:58.099Z\",\"isPartOf\":{\"@id\":\"https://docs.omnicommerce.sg#website\"},\"breadcrumb\":{\"@id\":\"https://docs.omnicommerce.sg/api-reference/promotions/create-promotion#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.omnicommerce.sg/api-reference/promotions/create-promotion#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\":\"Promotions\",\"item\":\"https://docs.omnicommerce.sg/api-reference/promotions/list-promotions\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create Promotion\",\"item\":\"https://docs.omnicommerce.sg/api-reference/promotions/create-promotion\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.omnicommerce.sg/api-reference/promotions/create-promotion#apireference\",\"headline\":\"Create Promotion\",\"name\":\"Create Promotion\",\"description\":\"Create a central promotion targeting connected stores. Requires promotions:write. Fixed-amount discounts resolve currency from the selected store countries.\",\"url\":\"https://docs.omnicommerce.sg/api-reference/promotions/create-promotion\",\"mainEntityOfPage\":{\"@id\":\"https://docs.omnicommerce.sg/api-reference/promotions/create-promotion#webpage\"},\"dateModified\":\"2026-10-23T07:13:58.099Z\",\"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","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","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","description":"List central promotions for the authenticated organization with filters and offset pagination matching the workspace Promotions listing. Requires `promotions:read`.","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","description":"Fetch one promotion by ID, including effective status. Requires `promotions:read`.","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 Promotion - 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"]}