The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.
A list of coupon codes that are applicable only for coupons. For coupons, the response includes promo codes associated with the coupon. For promotions, the response includes an empty array.
Promotion status. ACTIVE indicates that the promotion is applied to SKUs or items for which it is set as Active. Active promotions cannot be disabled. SCHEDULED indicates that the promotion is scheduled to be applied to SKUs or items based on the defined start date. DISABLED indicates that the promotion is set as disabled and is not in use. Only Disabled promotions can be enabled. EXPIRED indicates that the promotion is stopped by setting the expiration date. That is, the start date and end date as the current date. Only those promotions that are not expired can be enabled.
A flag indicating whether an offer is applied automatically. Set it to true for promotions, which should be applied automatically and false for coupons, which must be applied explicitly.
A flag indicating whether a coupon can be stacked with an existing promotion. Set it to true to prevent the coupon from being applied to items that have promotions and false to allow coupon to be applied with existing promotions.
Promotion type. Product: SKU promotion. Promotion or discount on SKUs based on the value mentioned in discount object CART: Cart promotion. Promotion or discount on cart amount based on the ORDER_VALUE that is set in condition object QUANTITY: Quantity promotion provides discounts based on the quantity requirement set in the promotion BOGO: Buy One Get One promotion provides discounts based on the Buy conditions and Get discounts SHIPPING: Shipping promotion provides discounts on the shipping cost BUYGET: BuyGet promotion specifies the Buy conditions and Get discounts SPEND_GET: SpendGet promotion can specify the requirement of cart order value and the corresponding Get discounts
Defines the rules for how a promotion can be combined with other promotions. This field determines whether a specific promotion can be applied in conjunction with other active promotions during a transaction or if it must be used exclusively. Possible values: - STACKABLE: This promotion can be combined with other stackable promotions, allowing multiple
discounts to be applied together. The order in which stackable promotions are applied
is determined by the level field, with promotions having a higher priority (lower numeric value)
being applied before those with a lower priority.
EXCLUSIVE: This promotion cannot be combined with any other promotions. The level field is
used to determine which exclusive promotion will be evaluated and applied first. Once an exclusive
promotion is applied, no other promotions can be used in the same transaction.
TYPE_EXCLUSIVE: This promotion cannot be combined with other promotions of the same type.
The level field is used to determine which promotion within the same type will be evaluated and
applied first.
UNIVERSAL: This promotion can be combined with any other promotions without restrictions.
Universal promotions will be evaluated last. We don't need to define level for this type.
The promotion execution order. Promotion types are assigned default execution orders. Initial evaluation begins with level 1 promotions. The result of level 1 is used as the base price for level 2. Similarly, the result of level 2 becomes the base price for level 3, and so on.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Fabric","colors":{"primary":"#ff2ec1","light":"#ff2ec1","dark":"#ff2ec1"},"logo":{"light":"https://mintcdn.com/fabric-demo/OzlZxX-hOwze1Aen/logo/darkneon.png?fit=max\u0026auto=format\u0026n=OzlZxX-hOwze1Aen\u0026q=85\u0026s=332d2284d5f41dc42f5b9e0bcd473872","dark":"https://mintcdn.com/fabric-demo/OzlZxX-hOwze1Aen/logo/darkneon.png?fit=max\u0026auto=format\u0026n=OzlZxX-hOwze1Aen\u0026q=85\u0026s=332d2284d5f41dc42f5b9e0bcd473872","href":"https://developer.fabric.inc"},"favicon":"https://mintcdn.com/fabric-demo/ZXHlkaduf1S9hYir/neon-favicon.webp?fit=max\u0026auto=format\u0026n=ZXHlkaduf1S9hYir\u0026q=85\u0026s=fc87341b907a3b0ed573af9c896468b2","navbar":{"primary":{"type":"button","label":"Request Demo","href":"https://fabric.inc/demo-request"}},"footer":{"socials":{"twitter":"https://twitter.com/fabric_commerce?lang=en","linkedin":"https://www.linkedin.com/company/teamfabric"}},"integrations":{"ga4":{"measurementId":"G-5RS60WM116"}},"contextual":{"options":["copy","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"fabric-demo","hasAudioNarration":false,"actualSubdomain":"fabric-demo","customDomains":["developer.fabric.inc"],"gitSource":{"type":"gitlab","owner":"fabric2/docs","repo":"developer-docs","projectId":58049997,"deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a27c05109a51e5ad494d5d6","collectionId":"7afabdbc-2ae6-4c34-9795-efeea513c17c","schemaVersion":"v3"},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6a905beb40741431493de2c3:failure","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"default","tag":"API Reference","count":721},{"language":"default","tag":"Orders \u0026 Inventory","count":276},{"language":"default","tag":"Product Catalog","count":245},{"language":"default","tag":"Dropship","count":242},{"language":"default","tag":"Orders v2 (OMS v2)","count":162},{"language":"default","tag":"Orders API Endpoints","count":145},{"language":"default","tag":"Customer","count":144},{"language":"default","tag":"Offers","count":118},{"language":"default","tag":"Product Catalog API","count":102},{"language":"default","tag":"Orders v1 (OMS v1)","count":100}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"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":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 100;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiAyp8kv8JHgFVrJJLmE0tDMPKzSQ.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 100;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiAyp8kv8JHgFVrJJLmE0tMMPKzSQ.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 100;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiAyp8kv8JHgFVrJJLmE0tCMPI.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 200;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLmv1pVFteOcEg.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 200;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLmv1pVGdeOcEg.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 200;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLmv1pVF9eO.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 300;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLm21lVFteOcEg.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 300;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLm21lVGdeOcEg.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 300;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLm21lVF9eO.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiGyp8kv8JHgFVrJJLucXtAKPY.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiGyp8kv8JHgFVrJJLufntAKPY.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiGyp8kv8JHgFVrJJLucHtA.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLmg1hVFteOcEg.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLmg1hVGdeOcEg.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLmg1hVF9eO.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLmr19VFteOcEg.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLmr19VGdeOcEg.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLmr19VF9eO.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLmy15VFteOcEg.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLmy15VGdeOcEg.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLmy15VF9eO.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 800;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLm111VFteOcEg.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 800;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLm111VGdeOcEg.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 800;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLm111VF9eO.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLm81xVFteOcEg.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLm81xVGdeOcEg.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLm81xVF9eO.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 100;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiGyp8kv8JHgFVrLPTucXtAKPY.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 100;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiGyp8kv8JHgFVrLPTufntAKPY.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 100;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiGyp8kv8JHgFVrLPTucHtA.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 200;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLFj_Z11lFc-K.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 200;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLFj_Z1JlFc-K.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 200;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLFj_Z1xlFQ.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 300;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLDz8Z11lFc-K.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 300;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLDz8Z1JlFc-K.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 300;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLDz8Z1xlFQ.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiEyp8kv8JHgFVrJJbecmNE.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiEyp8kv8JHgFVrJJnecmNE.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiEyp8kv8JHgFVrJJfecg.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLGT9Z11lFc-K.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLGT9Z1JlFc-K.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLGT9Z1xlFQ.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLEj6Z11lFc-K.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLEj6Z1JlFc-K.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLEj6Z1xlFQ.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLCz7Z11lFc-K.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLCz7Z1JlFc-K.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLCz7Z1xlFQ.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 800;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLDD4Z11lFc-K.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 800;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLDD4Z1JlFc-K.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 800;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLDD4Z1xlFQ.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLBT5Z11lFc-K.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLBT5Z1JlFc-K.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLBT5Z1xlFQ.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\na,body,h1,h2,h3,h4,h5,h6,html,p,span{font-family:Poppins}#navbar,#navbar .bg-background-light{background:#000}#navbar #search-bar-entry{background:rgb(var(--background-dark)/var(--tw-bg-opacity))}#navbar [id^=radix].bg-background-light{border-radius:8px;background:#fff;color:rgb(var(--gray-500));border:0}#navbar .dark\\:text-gray-300{color:rgb(var(--gray-300))}#navbar .dark\\:bg-primary-light{--tw-bg-opacity:1;background-color:rgb(var(--primary-light)/var(--tw-bg-opacity))}#navbar .text-gray-800{color:rgb(var(--gray-200))}#navbar .text-gray-600{color:#d4d4d4}#topbar-cta-button .rounded-full,#topbar-cta-button .rounded-full:is(.dark *){border-radius:31px;background:#000;box-shadow:0 7.57px 30.28px 0 rgba(0,0,0,.08);border:0}#topbar-cta-button .dark\\:text-primary-light,#topbar-cta-button .dark\\:text-primary-light:is(.dark *){color:#fff;text-align:center;font-size:14px;font-style:normal;font-weight:500;line-height:20px;letter-spacing:-.084px}.bodyContainer{max-width:63rem;margin:auto;background:0 0}.bodyFull{background:url(images/hero-background-unmasked-1.svg);position:relative;overflow:hidden}.bodyContainer:is(.dark *),.bodyFull:is(.dark *){background-color:transparent}.box-full{border-radius:8px;box-shadow:0 7.57px 30.28px 0 rgba(0,0,0,.08);padding:16px 20px}.box-full:is(.dark *){background-color:#4d354d;border:1px solid rgba(255,255,255,.2)}button p{font-size:18px}button .bg-primary-light{background-color:#121213}.twocol-cntr{width:75%;margin:auto;margin-top:1rem}.gap-x-4{column-gap:1rem;row-gap:1rem}.pink-boxes .card.block{background-color:#fff;border:1px solid #d9acd9;height:161px}.pink-boxes .card.block h2{font-size:28px;font-weight:300}.my-2{margin:0}.pink-boxes.dark\\:bg-background-dark:is(.dark *),.three-col.dark\\:bg-background-dark:is(.dark *),.twocol-cntr.dark\\:bg-background-dark:is(.dark *){background-color:#0c0a0f!important;z-index:-1;border-radius:15px}.pink-boxes.dark\\:bg-background-dark:is(.dark *) .card.block{background-color:transparent;border:1px solid #494949;position:relative}.three-col.dark\\:bg-background-dark:not(.dark *),.twocol-cntr.dark\\:bg-background-dark:not(.dark *){background-color:#fff!important;z-index:-1;border-radius:15px}.bg-primary{background-color:rgb(var(--gray-950)/var(--tw-bg-opacity))}.image-boxes h2{font-size:24px;font-weight:600;line-height:32px;letter-spacing:-.2px}.subtitle{text-align:center;font-size:20px;font-style:normal;font-weight:400;line-height:28px;letter-spacing:.04px;width:70%;margin:auto}.spacer{height:80px}.resource-boxes{text-align:center}.resource-boxes .dark\\:bg-background-dark:is(.dark *){background-color:#121213}.bodyContainer hr{border-color:#e3dfe2}.bodyContainer:is(.dark *) hr{border-color:#27272a}.col-lg-6{width:50%}.footer{padding-bottom:2.5rem;display:flex;background:0 0}.footer .dark\\:bg-background-dark:is(.dark *){background-color:transparent}.footer li,.footer p{font-size:14px;font-style:normal;font-weight:600;line-height:24px;letter-spacing:-.084px;margin-top:12px}.footer li a{color:#ff2ec1}.footer .updated.col-lg-6{display:flex;justify-content:flex-end}.fa-thin.fa-headphones,.fa-thin.fa-list,.fa-thin.fa-question-circle{mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/question.svg);mask-repeat:no-repeat;mask-position:center center}.fa-thin.fa-headphones,.fa-thin.fa-list{mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/headphones.svg)}.fa-thin.fa-list{mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/list.svg)}.fa-thin:is(.dark *){background-color:#fff}.footer.bg-background-light{background-color:transparent}.dark\\:text-gray-400:is(.dark *){color:#fff}#navbar-transition{display:none}.callout{border-color:rgba(255 46 193 .5);background-color:rgba(255 46 193 .3)}"}],"page":{"pagePath":"v2/api-reference/offers-v2/promotion/stop-a-promotion","slug":"/v2/api-reference/offers-v2/promotion/stop-a-promotion","pageMetadata":{"openapi":"offers_v2_combined post /api-offers/promo/{promoId}/kill","title":"Stop a promotion","description":"Lets you stop a specific promotion. This endpoint sets `state` as `EXPIRED`, and expiration date (both start date and end date) to the same current date.","href":"/v2/api-reference/offers-v2/promotion/stop-a-promotion"},"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: [\"Lets you stop a specific promotion. This endpoint sets \", _jsx(_components.code, {\n children: \"state\"\n }), \" as \", _jsx(_components.code, {\n children: \"EXPIRED\"\n }), \", and expiration date (both start date and end date) to the same current date.\"]\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":{"openapi":"offers_v2_combined post /api-offers/promo/{promoId}/kill","title":"Stop a promotion","description":"Lets you stop a specific promotion. This endpoint sets `state` as `EXPIRED`, and expiration date (both start date and end date) to the same current date.","href":"/v2/api-reference/offers-v2/promotion/stop-a-promotion"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/fabric-demo/6a81ae5b5ebc4bb2/theme.js","/_mintlify/custom/fabric-demo/aebbe2ead0ce64f7/top-form.v1.js","/_mintlify/custom/fabric-demo/5b243c7a49e8f495/gtag.js"],"openApiReferenceData":{"operation":{"tags":["Promotion"],"summary":"Stop a promotion","description":"Lets you stop a specific promotion. This endpoint sets `state` as `EXPIRED`, and expiration date (both start date and end date) to the same current date.","parameters":["bbc20891-f081-446c-b6b5-20d4b941a4cf","8d0c057d-cfec-4efe-ac80-047935456040"],"responses":{"200":"6ddcf20f-877f-4e2d-a7a8-57c3d17656fc","404":"9a808aa9-b249-4eb6-b8ad-5a3c0203a3f5","500":"d6f443a7-6a51-44cd-93f5-c4136f27fc89"},"method":"post","type":"path","servers":["0c63f2d9-938c-4c58-95b6-a7f40bb4df2a"],"security":["5180ceff-cce1-4a22-9171-90ae2fe99755"],"path":"/api-offers/promo/{promoId}/kill","baseUrlOptions":["https://live.copilot.fabric.inc"],"title":"Stop a promotion","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"bbc20891-f081-446c-b6b5-20d4b941a4cf":{"name":"x-site-context","in":"header","description":"The `x-site-context` header is a JSON object that contains information about the source you wish to pull from. The mandatory `account` is the 24 character identifier found in Copilot. The `channel` (Sales channel ID), `stage` (environment name), and `date` attributes can be used to further narrow the scope of your data source.","required":true,"schema":{"type":"string","example":"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}","isRequired":true,"description":"The `x-site-context` header is a JSON object that contains information about the source you wish to pull from. The mandatory `account` is the 24 character identifier found in Copilot. The `channel` (Sales channel ID), `stage` (environment name), and `date` attributes can be used to further narrow the scope of your data source.","uniqueKey":"","typeLabel":"string"}},"8d0c057d-cfec-4efe-ac80-047935456040":{"in":"path","name":"promoId","schema":{"type":"string","isRequired":true,"description":"ID of the promotion to be stopped","uniqueKey":"","typeLabel":"string"},"required":true,"description":"ID of the promotion to be stopped"}},"responses":{"6ddcf20f-877f-4e2d-a7a8-57c3d17656fc":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"_id":{"type":"string","description":"A 24-character system-generated promotion ID.","example":"abcdefg1ee7ce20123456789","uniqueKey":"_id","typeLabel":"string"},"promoId":{"type":"number","description":"A unique identifier of the promotion, for external use.","example":100013,"uniqueKey":"promoId","typeLabel":"number"},"promoCodes":{"type":"array","description":"A list of coupon codes that are applicable only for coupons. For coupons, the response includes promo codes associated with the coupon. For promotions, the response includes an empty array.","example":["SUMMER100","SUMMER20"],"items":{"type":"string","uniqueKey":"promoCodes.items.[INDEX]","typeLabel":"string"},"uniqueKey":"promoCodes","typeLabel":"string[]"},"state":{"type":"string","description":"Promotion status. \u003cbr /> `ACTIVE` indicates that the promotion is applied to SKUs or items for which it is set as *Active*. Active promotions cannot be disabled.\u003cbr />`SCHEDULED` indicates that the promotion is scheduled to be applied to SKUs or items based on the defined start date.\u003cbr />`DISABLED` indicates that the promotion is set as *disabled* and is not in use. Only *Disabled* promotions can be enabled.\u003cbr />`EXPIRED` indicates that the promotion is stopped by setting the expiration date. That is, the start date and end date as the current date. Only those promotions that are *not expired* can be enabled.","enum":["ACTIVE","SCHEDULED","DISABLED","EXPIRED"],"example":"EXPIRED","uniqueKey":"state","typeLabel":"enum\u003cstring>"},"isImplicit":{"type":"boolean","description":"A flag indicating whether an offer is applied automatically. Set it to `true` for promotions, which should be applied automatically and `false` for coupons, which must be applied explicitly.","example":true,"uniqueKey":"isImplicit","typeLabel":"boolean"},"title":{"type":"string","description":"Title of the promotion","example":"CREATE PROMO","uniqueKey":"title","typeLabel":"string"},"buyOperator":{"type":"string","description":"It is used to define operator between different *Buy* conditions (different conditions as mentioned in the `condition` object)","default":"OR","enum":["AND","OR"],"example":"OR","uniqueKey":"buyOperator","typeLabel":"enum\u003cstring>"},"promo":{"type":"array","items":{"type":"object","properties":{"discount":{"type":"array","description":"Discount details","items":{"type":"object","required":["unit","value","ON"],"properties":{"unit":{"type":"string","description":"Unit of discount; represents whether the discount is in percentage or by a certain amount","enum":["%OFF","AMOUNT_OFF","FIXED"],"example":"%OFF","isRequired":true,"uniqueKey":"promo.items.[INDEX].discount.items.[INDEX].unit","typeLabel":"enum\u003cstring>"},"value":{"type":"number","description":"Discount value to be applied","example":10,"isRequired":true,"uniqueKey":"promo.items.[INDEX].discount.items.[INDEX].value","typeLabel":"number"},"ON":{"type":"object","description":"Indicates kind of products promotion is applied on.","required":["kind","value"],"properties":{"kind":{"type":"string","description":"SKU if discount is on products\u003cbr /> `SERVICE` if discount is on an SKU shipping cost\u003cbr /> `SERVICE_CART` if discount is on cart shipping cost","enum":["SKU","CART","SERVICE","SERVICE_CART"],"example":"SKU","isRequired":true,"uniqueKey":"promo.items.[INDEX].discount.items.[INDEX].ON.kind","typeLabel":"enum\u003cstring>"},"value":{"oneOf":[{"type":"string","example":"*","isRequired":true,"uniqueKey":"promo.items.[INDEX].discount.items.[INDEX].ON.value.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"object","uniqueKey":"promo.items.[INDEX].discount.items.[INDEX].ON.value.oneOf.1.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"promo.items.[INDEX].discount.items.[INDEX].ON.value.oneOf.1","typeLabel":"object[]"}],"isRequired":true,"uniqueKey":"promo.items.[INDEX].discount.items.[INDEX].ON.value","typeLabel":"string | object[]"},"quantity":{"type":"number","description":"Quantity of items to be sold for the discount to be applied. It is required when `type` is SPEND_GET, BUYGET, BOGO (Buy One Get One)","example":2,"uniqueKey":"promo.items.[INDEX].discount.items.[INDEX].ON.quantity","typeLabel":"number"},"includeOperator":{"type":"string","description":"Select the `AND` or `OR` condition to include products in a promotion. \u003cbr /> Use the `OR` condition to apply a single rule for product inclusion. \u003cbr /> Use the `AND` condition to apply multiple rules for product inclusion.","example":"OR","default":"OR","enum":["AND","OR"],"uniqueKey":"promo.items.[INDEX].discount.items.[INDEX].ON.includeOperator","typeLabel":"enum\u003cstring>"},"excludeOperator":{"type":"string","description":"Select the `AND` or `OR` condition to exclude products from a promotion. \u003cbr /> Use the `OR` condition to apply a single rule for product exclusion. \u003cbr /> Use the `AND` condition to apply multiple rules for product exclusion.","example":"AND","default":"AND","enum":["AND","OR"],"uniqueKey":"promo.items.[INDEX].discount.items.[INDEX].ON.excludeOperator","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"promo.items.[INDEX].discount.items.[INDEX].ON","typeLabel":"object"},"discountId":{"type":"string","description":"Discount ID to link `discount` and `targetProduct`, and is required for BuyGet and SpendGet type promotions","example":1,"uniqueKey":"promo.items.[INDEX].discount.items.[INDEX].discountId","typeLabel":"string"},"autoAdd":{"type":"boolean","description":"To indicate if the evaluation API (from Dynamic Pricing Engine) should suggest free items. Currently used for BuyGet and SpendGet type promotions.","default":false,"example":false,"uniqueKey":"promo.items.[INDEX].discount.items.[INDEX].autoAdd","typeLabel":"boolean"},"set":{"type":"array","description":"It is used to create a group of items in a set so that you can easily apply promotions or coupons to the defined set of items.","items":{"type":"string","enum":["A","B","C","D","E","F","G","H","I","J","K","L","M","N","O","P","Q","R","S","T","U","V","W","X","Y","Z"],"uniqueKey":"promo.items.[INDEX].discount.items.[INDEX].set.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"promo.items.[INDEX].discount.items.[INDEX].set","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"promo.items.[INDEX].discount.items.[INDEX]","typeLabel":"object"},"uniqueKey":"promo.items.[INDEX].discount","typeLabel":"object[]"},"targetProducts":{"type":"array","description":"The products the discount is applied to.","items":{"type":"object","description":"Represents the type or kind of products to which discount is applied","required":["kind","value","operator"],"properties":{"kind":{"type":"string","description":"Selection of product type","enum":["SKU","CATEGORY","ATTRIBUTE","PRICE_KIND","PREVIOUS_DISCOUNT"],"example":"SKU","isRequired":true,"uniqueKey":"promo.items.[INDEX].targetProducts.items.[INDEX].kind","typeLabel":"enum\u003cstring>"},"value":{"oneOf":[{"type":"string","description":"Value for the kind as defined above.\u003cbr /> For `SKU`, value can be array of itemIds or array of SKU descriptions.\u003cbr /> For `Category`, value can be array of category IDs or category descriptions.\u003cbr /> For `Attribute`, value can be array of attribute objects, for example [{name: 'attribute-name', value:'attribute-value'}]","example":"*","isRequired":true,"uniqueKey":"promo.items.[INDEX].targetProducts.items.[INDEX].value.oneOf.0","typeLabel":"string"},{"type":"array","items":{"oneOf":[{"type":"number","description":"SKU ID. [1000000234, 1000000445] could be array of itemIds if you want to apply promotion on selected items","example":1000000234,"uniqueKey":"promo.items.[INDEX].targetProducts.items.[INDEX].value.oneOf.1.items.[INDEX].oneOf.0","typeLabel":"number"},{"type":"string","description":"SKU description","example":"Kitchen items. [Kitchen items, Garden light] could be array of items if you want to apply promotion on selected items","uniqueKey":"promo.items.[INDEX].targetProducts.items.[INDEX].value.oneOf.1.items.[INDEX].oneOf.1","typeLabel":"string"}],"uniqueKey":"promo.items.[INDEX].targetProducts.items.[INDEX].value.oneOf.1.items.[INDEX]","typeLabel":"number | string"},"description":"Value for the kind as defined above.\u003cbr /> For `SKU`, value can be array of itemIds or array of SKU descriptions.\u003cbr /> For `Category`, value can be array of category IDs or category descriptions.\u003cbr /> For `Attribute`, value can be array of attribute objects, for example [{name: 'attribute-name', value:'attribute-value'}]","isRequired":true,"uniqueKey":"promo.items.[INDEX].targetProducts.items.[INDEX].value.oneOf.1","typeLabel":"(number | string)[]"}],"isRequired":true,"uniqueKey":"promo.items.[INDEX].targetProducts.items.[INDEX].value","typeLabel":"string | (number | string)[]"},"operator":{"description":"The type of search operation. You can use multiple values separated by commas for the IN and NOT_IN operations. However, you can use only a single value for the EQUALS and GREATER_THAN operations.","type":"string","enum":["IN","NOT_IN","EQUAL","GREATER_THAN"],"example":"IN","isRequired":true,"uniqueKey":"promo.items.[INDEX].targetProducts.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"discountId":{"type":"string","description":"Discount ID to link discount and targetProduct, and is required for BuyGet and SpendGet promotions","example":1,"uniqueKey":"promo.items.[INDEX].targetProducts.items.[INDEX].discountId","typeLabel":"string"}},"uniqueKey":"promo.items.[INDEX].targetProducts.items.[INDEX]","typeLabel":"object"},"uniqueKey":"promo.items.[INDEX].targetProducts","typeLabel":"object[]"},"condition":{"type":"array","description":"List of linked condition IDs to the promotion","items":{"type":"string","example":"620d84a715f2d00001234567","uniqueKey":"promo.items.[INDEX].condition.items.[INDEX]","typeLabel":"string"},"uniqueKey":"promo.items.[INDEX].condition","typeLabel":"string[]"}},"uniqueKey":"promo.items.[INDEX]","typeLabel":"object"},"uniqueKey":"promo","typeLabel":"object[]"},"startDate":{"type":"string","description":"Start date of the promotion","format":"date-time","example":"2021-10-18T23:45:40.289Z","uniqueKey":"startDate","typeLabel":"string\u003cdate-time>"},"endDate":{"type":"string","description":"End date of the promotion","format":"date-time","example":"2021-10-18T23:45:40.289Z","uniqueKey":"endDate","typeLabel":"string\u003cdate-time>"},"isExclusive":{"type":"boolean","description":"A flag indicating whether a coupon can be stacked with an existing promotion. Set it to `true` to prevent the coupon from being applied to items that have promotions and `false` to allow coupon to be applied with existing promotions.","example":true,"uniqueKey":"isExclusive","typeLabel":"boolean"},"type":{"type":"string","description":"Promotion type.\u003cbr /> **Product:** SKU promotion. Promotion or discount on SKUs based on the value mentioned in *discount* object\u003cbr />**CART:** Cart promotion. Promotion or discount on cart amount based on the *ORDER_VALUE* that is set in *condition* object\u003cbr />**QUANTITY:** Quantity promotion provides discounts based on the quantity requirement set in the promotion\u003cbr />**BOGO:** Buy One Get One promotion provides discounts based on the Buy conditions and Get discounts\u003cbr />**SHIPPING:** Shipping promotion provides discounts on the shipping cost\u003cbr />**BUYGET:** BuyGet promotion specifies the Buy conditions and Get discounts\u003cbr />**SPEND_GET:** SpendGet promotion can specify the requirement of cart order value and the corresponding Get discounts","enum":["PRODUCT","CART","QUANTITY","BOGO","SHIPPING","BUYGET","SPEND_GET"],"example":"PRODUCT","uniqueKey":"type","typeLabel":"enum\u003cstring>"},"stackingType":{"type":"string","description":"Defines the rules for how a promotion can be combined with other promotions. This field determines whether a specific promotion can be applied in conjunction with other active promotions during a transaction or if it must be used exclusively. Possible values: - `STACKABLE`: This promotion can be combined with other stackable promotions, allowing multiple \n discounts to be applied together. The order in which stackable promotions are applied \n is determined by the `level` field, with promotions having a higher priority (lower numeric value)\n being applied before those with a lower priority.\n- `EXCLUSIVE`: This promotion cannot be combined with any other promotions. The `level` field is\n used to determine which exclusive promotion will be evaluated and applied first. Once an exclusive\n promotion is applied, no other promotions can be used in the same transaction.\n- `TYPE_EXCLUSIVE`: This promotion cannot be combined with other promotions of the same type.\n The `level` field is used to determine which promotion within the same type will be evaluated and\n applied first.\n- `UNIVERSAL`: This promotion can be combined with any other promotions without restrictions.\n Universal promotions will be evaluated last. We don't need to define `level` for this type.","enum":["STACKABLE","EXCLUSIVE","TYPE_EXCLUSIVE","UNIVERSAL"],"example":"STACKABLE","uniqueKey":"stackingType","typeLabel":"enum\u003cstring>"},"level":{"type":"integer","format":"int32","description":"The promotion execution order. Promotion types are assigned default execution orders. Initial evaluation begins with level 1 promotions. The result of level 1 is used as the base price for level 2. Similarly, the result of level 2 becomes the base price for level 3, and so on.","example":1,"uniqueKey":"level","typeLabel":"integer\u003cint32>"},"termsAndConditions":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string","description":"Title of the terms and conditions","example":"Terms Applied","uniqueKey":"termsAndConditions.items.[INDEX].title","typeLabel":"string"},"description":{"type":"string","description":"Description of the terms and conditions","example":"Items cannot be exchanged","uniqueKey":"termsAndConditions.items.[INDEX].description","typeLabel":"string"}},"uniqueKey":"termsAndConditions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"termsAndConditions","typeLabel":"object[]"},"promotionMessages":{"type":"array","items":{"type":"object","description":"Message description for the promotion","properties":{"title":{"type":"string","description":"Message name","example":"Buy 1 get 1 free","uniqueKey":"promotionMessages.items.[INDEX].title","typeLabel":"string"},"message":{"type":"string","description":"Message description","example":"Offer valid at participating stores through September 5, 2023.","uniqueKey":"promotionMessages.items.[INDEX].message","typeLabel":"string"},"pages":{"type":"array","description":"Types of web pages where the message will be displayed","items":{"type":"string","description":"Page type","example":"PDP","uniqueKey":"promotionMessages.items.[INDEX].pages.items.[INDEX]","typeLabel":"string"},"example":["PDP","Cart"],"uniqueKey":"promotionMessages.items.[INDEX].pages","typeLabel":"string[]"},"locales":{"type":"array","description":"Locales in which promotion message will be displayed. Locale is a set of language or country-based preferences for user interface.","items":{"type":"string","description":"Locale","example":"en-CA","uniqueKey":"promotionMessages.items.[INDEX].locales.items.[INDEX]","typeLabel":"string"},"example":["en-CA","fr-CA"],"uniqueKey":"promotionMessages.items.[INDEX].locales","typeLabel":"string[]"}},"uniqueKey":"promotionMessages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"promotionMessages","typeLabel":"object[]"},"proximityMessages":{"type":"array","items":{"type":"object","properties":{"threshold":{"type":"integer","minimum":0,"description":"The proximity threshold value.","uniqueKey":"proximityMessages.items.[INDEX].threshold","typeLabel":"integer"},"localizedMessages":{"type":"array","items":{"type":"object","properties":{"locales":{"type":"array","items":{"type":"string","description":"The intended language or target region for the message.","uniqueKey":"proximityMessages.items.[INDEX].localizedMessages.items.[INDEX].locales.items.[INDEX]","typeLabel":"string"},"uniqueKey":"proximityMessages.items.[INDEX].localizedMessages.items.[INDEX].locales","typeLabel":"string[]"},"message":{"type":"string","description":"The localized message for the specified locales.","uniqueKey":"proximityMessages.items.[INDEX].localizedMessages.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"proximityMessages.items.[INDEX].localizedMessages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"proximityMessages.items.[INDEX].localizedMessages","typeLabel":"object[]"}},"uniqueKey":"proximityMessages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"proximityMessages","typeLabel":"object[]"},"shipmentMethodIds":{"type":"array","description":"Required for Shipping type promo to provide eligible shipment Methods","items":{"type":"string","description":"Shipping method IDs of the shipping methods to which promotion is applicable","example":1000001,"uniqueKey":"shipmentMethodIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"shipmentMethodIds","typeLabel":"string[]"},"eligiblePriceList":{"type":"array","description":"IDs of the price lists to which this promotion is applied","items":{"type":"number","example":10000056,"uniqueKey":"eligiblePriceList.items.[INDEX]","typeLabel":"number"},"uniqueKey":"eligiblePriceList","typeLabel":"number[]"},"limits":{"type":"array","description":"Array of limits for the promotion to be applied","items":{"type":"object","properties":{"kind":{"type":"string","description":"Kind of limit for the promotion to be applied","example":"ORDER","uniqueKey":"limits.items.[INDEX].kind","typeLabel":"string"},"value":{"description":"Value of limit for the promotion to be applied","type":"number","example":2,"uniqueKey":"limits.items.[INDEX].value","typeLabel":"number"}},"uniqueKey":"limits.items.[INDEX]","typeLabel":"object"},"uniqueKey":"limits","typeLabel":"object[]"},"note":{"type":"string","example":"Independence day sale!","description":"Promotion note or description","uniqueKey":"note","typeLabel":"string"},"createdAt":{"type":"string","format":"date-time","description":"Creation date of the record","example":"2019-08-20T14:15:22Z","uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"Last updated date of the record","example":"2019-08-20T14:15:22Z","uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"_id":"abcdefg1ee7ce20123456789","promoId":100013,"promoCodes":["SUMMER100","SUMMER20"],"state":"EXPIRED","isImplicit":true,"title":"CREATE PROMO","buyOperator":"OR","promo":[{"discount":[{"unit":"%OFF","value":10,"ON":{"kind":"SKU","value":"*","quantity":2,"includeOperator":"OR","excludeOperator":"AND"},"discountId":1,"autoAdd":false,"set":["A"]}],"targetProducts":[{"kind":"SKU","value":"*","operator":"IN","discountId":1}],"condition":["620d84a715f2d00001234567"]}],"startDate":"2021-10-18T23:45:40.289Z","endDate":"2021-10-18T23:45:40.289Z","isExclusive":true,"type":"PRODUCT","stackingType":"STACKABLE","level":1,"termsAndConditions":[{"title":"Terms Applied","description":"Items cannot be exchanged"}],"promotionMessages":[{"title":"Buy 1 get 1 free","message":"Offer valid at participating stores through September 5, 2023.","pages":["PDP","Cart"],"locales":["en-CA","fr-CA"]}],"proximityMessages":[{"threshold":1,"localizedMessages":[{"locales":["\u003cstring>"],"message":"\u003cstring>"}]}],"shipmentMethodIds":[1000001],"eligiblePriceList":[10000056],"limits":[{"kind":"ORDER","value":2}],"note":"Independence day sale!","createdAt":"2019-08-20T14:15:22Z","updatedAt":"2019-08-20T14:15:22Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"9a808aa9-b249-4eb6-b8ad-5a3c0203a3f5":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"description":"The error code.","type":"string","example":"PROMO_NOT_FOUND","uniqueKey":"code","typeLabel":"string"},"message":{"description":"The error message corresponding to the `code`.","type":"string","example":"The promo code you entered doesn't exist.","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"PROMO_NOT_FOUND","message":"The promo code you entered doesn't exist."}}},"exampleType":"generated"}},"exampleType":"generated"},"d6f443a7-6a51-44cd-93f5-c4136f27fc89":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"description":"The error code.","type":"string","example":"INTERNAL_SERVER_ERROR","uniqueKey":"code","typeLabel":"string"},"message":{"description":"An error message coressponding to the `code`.","type":"string","example":"Internal server error.","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"INTERNAL_SERVER_ERROR","message":"Internal server error."}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"5180ceff-cce1-4a22-9171-90ae2fe99755":{"AuthorizationToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[]}}},"servers":{"0c63f2d9-938c-4c58-95b6-a7f40bb4df2a":{"url":"https://live.copilot.fabric.inc","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"AuthorizationToken","name":"Authorization"}],"title":"AuthorizationToken"}]},"originalFileLocation":"openapi/offers/v2/offers_v2_combined.yaml"},"subdomain":"fabric-demo","siteName":"Fabric","title":"Stop a promotion - Fabric","navMaps":{"firstHrefInVersion":{"Product Agent":{"href":"/home","matchLevel":4},"v3":{"href":"/v3/home","matchLevel":4},"v2":{"href":"/v2/api-reference/offers-v2/promotion/stop-a-promotion","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-01-22T21:06:38.532Z","originalFileLocation":"v2/api-reference/offers-v2/promotion/stop-a-promotion.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Lets you stop a specific promotion. This endpoint sets state as EXPIRED, and expiration date (both start date and end date) to the same current date.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Fabric\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/fabric-demo/4aXl3Y2Jab1lmXrs/_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/fabric-demo/4aXl3Y2Jab1lmXrs/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/fabric-demo/4aXl3Y2Jab1lmXrs/_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/fabric-demo/4aXl3Y2Jab1lmXrs/_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/fabric-demo/4aXl3Y2Jab1lmXrs/_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/fabric-demo/4aXl3Y2Jab1lmXrs/_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/fabric-demo/4aXl3Y2Jab1lmXrs/_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/fabric-demo/4aXl3Y2Jab1lmXrs/_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/fabric-demo/4aXl3Y2Jab1lmXrs/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Stop a promotion - Fabric\">\u003cmeta data-mint-head property=\"og:description\" content=\"Lets you stop a specific promotion. This endpoint sets state as EXPIRED, and expiration date (both start date and end date) to the same current date.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Fabric\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.fabric.inc/v2/api-reference/offers-v2/promotion/stop-a-promotion\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://fabric-demo.mintlify.app/_mintlify/api/og/v2?division=Promotion\u0026amp;title=Stop+a+promotion\u0026amp;description=Lets+you+stop+a+specific+promotion.+This+endpoint+sets+%60state%60+as+%60EXPIRED%60%2C+and+expiration+date+%28both+start+date+and+end+date%29+to+the+same+current+date.\u0026amp;theme=d21d2e5604bc479b7e92e42c\u0026amp;signature=82bbe0c688fed8f6519708e3f59a6deb41ac3eb23405a36aaec43a46043ff9d7\">\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=\"Stop a promotion - Fabric\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Lets you stop a specific promotion. This endpoint sets state as EXPIRED, and expiration date (both start date and end date) to the same current date.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://fabric-demo.mintlify.app/_mintlify/api/og/v2?division=Promotion\u0026amp;title=Stop+a+promotion\u0026amp;description=Lets+you+stop+a+specific+promotion.+This+endpoint+sets+%60state%60+as+%60EXPIRED%60%2C+and+expiration+date+%28both+start+date+and+end+date%29+to+the+same+current+date.\u0026amp;theme=d21d2e5604bc479b7e92e42c\u0026amp;signature=82bbe0c688fed8f6519708e3f59a6deb41ac3eb23405a36aaec43a46043ff9d7\">\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/fabric-demo/4aXl3Y2Jab1lmXrs/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Fabric\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#ff2ec1\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.fabric.inc/v2/api-reference/offers-v2/promotion/stop-a-promotion\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/v2/api-reference/offers-v2/promotion/stop-a-promotion.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.fabric.inc/#organization\",\"name\":\"Fabric\",\"url\":\"https://developer.fabric.inc\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/fabric-demo/OzlZxX-hOwze1Aen/logo/darkneon.png?fit=max\u0026auto=format\u0026n=OzlZxX-hOwze1Aen\u0026q=85\u0026s=332d2284d5f41dc42f5b9e0bcd473872\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.fabric.inc#website\",\"name\":\"Fabric\",\"url\":\"https://developer.fabric.inc\",\"publisher\":{\"@id\":\"https://developer.fabric.inc/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.fabric.inc/v2/api-reference/offers-v2/promotion/stop-a-promotion#webpage\",\"url\":\"https://developer.fabric.inc/v2/api-reference/offers-v2/promotion/stop-a-promotion\",\"name\":\"Stop a promotion\",\"description\":\"Lets you stop a specific promotion. This endpoint sets state as EXPIRED, and expiration date (both start date and end date) to the same current date.\",\"dateModified\":\"2026-01-22T21:06:38.532Z\",\"isPartOf\":{\"@id\":\"https://developer.fabric.inc#website\"},\"breadcrumb\":{\"@id\":\"https://developer.fabric.inc/v2/api-reference/offers-v2/promotion/stop-a-promotion#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.fabric.inc/v2/api-reference/offers-v2/promotion/stop-a-promotion#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Offers v2\",\"item\":\"https://developer.fabric.inc/v2/api-reference/offers-v2/offers\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Promotion\",\"item\":\"https://developer.fabric.inc/v2/api-reference/offers-v2/promotion/overview\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Stop a promotion\",\"item\":\"https://developer.fabric.inc/v2/api-reference/offers-v2/promotion/stop-a-promotion\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.fabric.inc/v2/api-reference/offers-v2/promotion/stop-a-promotion#apireference\",\"headline\":\"Stop a promotion\",\"name\":\"Stop a promotion\",\"description\":\"Lets you stop a specific promotion. This endpoint sets state as EXPIRED, and expiration date (both start date and end date) to the same current date.\",\"url\":\"https://developer.fabric.inc/v2/api-reference/offers-v2/promotion/stop-a-promotion\",\"mainEntityOfPage\":{\"@id\":\"https://developer.fabric.inc/v2/api-reference/offers-v2/promotion/stop-a-promotion#webpage\"},\"dateModified\":\"2026-01-22T21:06:38.532Z\",\"publisher\":{\"@id\":\"https://developer.fabric.inc/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.fabric.inc#website\"}}]}\u003c/script>","siteName":"Fabric","nav":{"global":null,"versions":[{"version":"Product Agent","pages":[{"title":"Product Agent","href":"/home"}]},{"version":"v3","pages":[{"title":"v3","href":"/v3/home"}]},{"version":"v2","tabs":[{"tab":"Home","pages":[{"title":"Home","href":"/v2/home"}]},{"tab":"API Reference","groups":[{"group":"Authentication v1","pages":[{"title":"Identity APIs","href":"/v2/api-reference/authentication-v1/identity-apis"},{"group":"User","pages":[{"title":"User","sidebarTitle":"Overview","href":"/v2/api-reference/authentication-v1/user/overview"},{"openapi":"identity_v1 get /api-commerceIdentity/user/{userId}","title":"Get user","href":"/v2/api-reference/authentication-v1/user/get-user"},{"openapi":"identity_v1 patch /api-commerceIdentity/user/{userId}/username","title":"Update user name","href":"/v2/api-reference/authentication-v1/user/update-user-name"},{"openapi":"identity_v1 post /api-commerceIdentity/user/local","title":"Create local user","href":"/v2/api-reference/authentication-v1/user/create-local-user"},{"openapi":"identity_v1 post /api-commerceIdentity/user/guest","title":"Create guest user","href":"/v2/api-reference/authentication-v1/user/create-guest-user"}]},{"group":"Address","pages":[{"title":"Address","sidebarTitle":"Overview","href":"/v2/api-reference/authentication-v1/address/overview"},{"openapi":"identity_v1 get /api-commerceIdentity/user/{userId}/address","title":"List user's addresses","href":"/v2/api-reference/authentication-v1/address/list-users-addresses"},{"openapi":"identity_v1 post /api-commerceIdentity/user/{userId}/address","title":"Create user address","href":"/v2/api-reference/authentication-v1/address/create-user-address"},{"openapi":"identity_v1 get /api-commerceIdentity/user/{userId}/address/{addressId}","title":"Get specific address","href":"/v2/api-reference/authentication-v1/address/get-specific-address"},{"openapi":"identity_v1 put /api-commerceIdentity/user/{userId}/address/{addressId}","title":"Update specific address","href":"/v2/api-reference/authentication-v1/address/update-specific-address"},{"openapi":"identity_v1 delete /api-commerceIdentity/user/{userId}/address/{addressId}","title":"Delete specific address","href":"/v2/api-reference/authentication-v1/address/delete-specific-address"},{"openapi":"identity_v1 post /api-commerceIdentity/user/{userId}/address/{addressId}/set","title":"Set default address","href":"/v2/api-reference/authentication-v1/address/set-default-address"},{"openapi":"identity_v1 post /api-commerceIdentity/user/{userId}/address/{addressId}/unset","title":"Unset default address","href":"/v2/api-reference/authentication-v1/address/unset-default-address"}]},{"group":"Auth","pages":[{"title":"Auth","sidebarTitle":"Overview","href":"/v2/api-reference/authentication-v1/auth/overview"},{"openapi":"identity_v1 post /api-commerceIdentity/auth/local/login","title":"Log in local user","href":"/v2/api-reference/authentication-v1/auth/log-in-local-user"},{"openapi":"identity_v1 post /api-commerceIdentity/auth/local/refresh","title":"Refresh local user","href":"/v2/api-reference/authentication-v1/auth/refresh-local-user"},{"openapi":"identity_v1 patch /api-commerceIdentity/auth/local/reset","title":"Reset password","href":"/v2/api-reference/authentication-v1/auth/reset-password"},{"openapi":"identity_v1 patch /api-commerceIdentity/auth/password","title":"Update password","href":"/v2/api-reference/authentication-v1/auth/update-password"},{"openapi":"identity_v1 patch /api-commerceIdentity/auth/change-password","title":"Change password","href":"/v2/api-reference/authentication-v1/auth/change-password"},{"openapi":"identity_v1 get /api-commerceIdentity/auth/token/{token}","title":"Verify reset token","href":"/v2/api-reference/authentication-v1/auth/verify-reset-token"}]}]},{"group":"User Self Service APIs","pages":[{"title":"Introduction","href":"/v2/api-reference/user-self-service-apis/introduction"},{"group":"User Self Service APIs","pages":[{"title":"User Self Service APIs","href":"/v2/api-reference/user-self-service-apis/user-self-service-apis/overview"},{"openapi":"identity_v2 get /users/self","title":"Get user details","href":"/v2/api-reference/user-self-service-apis/user-self-service-apis/get-user-details"},{"openapi":"identity_v2 put /users/self","title":"Update user details","href":"/v2/api-reference/user-self-service-apis/user-self-service-apis/update-user-details"},{"openapi":"identity_v2 post /auth/self/password","title":"Change password","href":"/v2/api-reference/user-self-service-apis/user-self-service-apis/change-password"},{"openapi":"identity_v2 post /auth/forgot-password","title":"Forgot password","href":"/v2/api-reference/user-self-service-apis/user-self-service-apis/forgot-password"}]},{"group":"Authentication APIs","pages":[{"title":"Authentication APIs","href":"/v2/api-reference/user-self-service-apis/authentication-apis/overview"},{"openapi":"authentication_v3 get /oauth2/default/v1/authorize","title":"Authorize user apps with and without PKCE","href":"/v2/api-reference/user-self-service-apis/authentication-apis/authorize-user-app-with-and-without-pkce"},{"openapi":"authentication_v3 post /oauth2/{authServerId}/v1/token","title":"Fetch access token","href":"/v2/api-reference/user-self-service-apis/authentication-apis/fetch-access-token"}]}]},{"group":"Experiences v2 (XM v2)","pages":[{"title":"XM","href":"/v2/api-reference/xm-v2/xm"},{"group":"Pages","pages":[{"title":"Pages","sidebarTitle":"Overview","href":"/v2/api-reference/xm-v2/pages/overview"},{"openapi":"xm_v2 get /v2/pages/live","title":"Get Live Pages For Specified Channels","href":"/v2/api-reference/xm-v2/pages/get-live-pages-for-specified-channels"},{"openapi":"xm_v2 get /v2/pages/metadata","title":"Get meta information about live pages","href":"/v2/api-reference/xm-v2/pages/get-meta-information-about-live-pages"},{"openapi":"xm_v2 get /v2/page/live","title":"Get Live Page For A Channel By URL","href":"/v2/api-reference/xm-v2/pages/get-live-page-for-a-channel-by-url"}]},{"group":"Global Components","pages":[{"title":"Global Componenets","sidebarTitle":"Overview","href":"/v2/api-reference/xm-v2/global-components/overview"},{"openapi":"xm_v2 get /v2/global-component/live","title":"Get Live Global Components For A Channel","href":"/v2/api-reference/xm-v2/global-components/get-live-global-components-for-a-channel"}]},{"group":"Menu","pages":[{"title":"Menu","sidebarTitle":"Overview","href":"/v2/api-reference/xm-v2/menu/overview"},{"openapi":"xm_v2 get /v2/menu/live","title":"Get Live Menu For A Channel","href":"/v2/api-reference/xm-v2/menu/get-live-menu-for-a-channel"}]}]},{"group":"Experiences v1 (XM v1)","pages":[{"title":"XM","href":"/v2/api-reference/xm-v1/xm"},{"group":"Pages","pages":[{"title":"Pages","sidebarTitle":"Overview","href":"/v2/api-reference/xm-v1/pages/overview"},{"openapi":"xm_v1 get /pages/live","title":"Retrieves Live Pages","href":"/v2/api-reference/xm-v1/pages/retrieves-live-pages"},{"openapi":"xm_v1 get /page/live","title":"Retrieves Live Page By URL","href":"/v2/api-reference/xm-v1/pages/retrieves-live-page-by-url"}]},{"group":"Global Components","pages":[{"title":"Global Componenets","sidebarTitle":"Overview","href":"/v2/api-reference/xm-v1/global-components/overview"},{"openapi":"xm_v1 get /global-component/live","title":"Retrieves Live Global Components","href":"/v2/api-reference/xm-v1/global-components/retrieves-live-global-components"}]},{"group":"Menu","pages":[{"title":"Menu","sidebarTitle":"Overview","href":"/v2/api-reference/xm-v1/menu/overview"},{"openapi":"xm_v1 get /menu/items","title":"Retrieves All Menu Items","href":"/v2/api-reference/xm-v1/menu/retrieves-all-menu-items"},{"openapi":"xm_v1 get /menu","title":"Retrieves Menu List","href":"/v2/api-reference/xm-v1/menu/retrieves-menu-list"}]}]},{"group":"Product Catalog","pages":[{"title":"Product Catalog","href":"/v2/api-reference/product-catalog/product-information-management"},{"group":"Category","pages":[{"title":"Category","sidebarTitle":"Overview","href":"/v2/api-reference/product-catalog/category/overview"},{"openapi":"pim post /api-category/v1/category","title":"Create category","href":"/v2/api-reference/product-catalog/category/create-category"},{"openapi":"pim get /api-category/v1/category","title":"Get categories","href":"/v2/api-reference/product-catalog/category/get-categories"},{"openapi":"pim put /api-category/v1/category/{nodeId}","title":"Modify category","href":"/v2/api-reference/product-catalog/category/modify-category"},{"openapi":"pim get /api-category/v1/category/search","title":"Find categories","href":"/v2/api-reference/product-catalog/category/find-categories"},{"openapi":"pim get /api-category/v1/category/tree","title":"Get category tree","href":"/v2/api-reference/product-catalog/category/get-category-tree"},{"openapi":"pim get /api-category/v1/category/sku","title":"Get SKUs in a category","href":"/v2/api-reference/product-catalog/category/get-skus-in-a-category"},{"openapi":"pim post /api-category/v1/category/attribute","title":"Assign and unassign category attributes","href":"/v2/api-reference/product-catalog/category/assign-and-unassign-category-attributes"},{"openapi":"pim get /api-category/v1/category/attribute","title":"Get assigned category attributes","href":"/v2/api-reference/product-catalog/category/get-assigned-category-attributes"},{"openapi":"pim post /api-category/v1/category/item-attribute","title":"Assign and unassign item attributes","href":"/v2/api-reference/product-catalog/category/assign-and-unassign-item-attributes"},{"openapi":"pim get /api-category/v1/category/item-attribute","title":"Get assigned item attributes","href":"/v2/api-reference/product-catalog/category/get-assigned-item-attributes"},{"openapi":"pim post /api-category/v1/category/source","title":"Add and remove category source inclusions","href":"/v2/api-reference/product-catalog/category/add-and-remove-category-source-inclusions"},{"openapi":"pim get /api-category/v1/category/source","title":"Get category source inclusions","href":"/v2/api-reference/product-catalog/category/get-category-source-inclusions"},{"openapi":"pim post /api-category/v1/category/source/exclusion","title":"Add and remove category source exclusions","href":"/v2/api-reference/product-catalog/category/add-and-remove-category-source-exclusions"},{"openapi":"pim get /api-category/v1/category/source/exclusion","title":"Get category source exclusions","href":"/v2/api-reference/product-catalog/category/get-category-source-exclusions"},{"openapi":"pim post /api-category/v1/category/item-attribute/condition","title":"Add and remove item attribute conditions","href":"/v2/api-reference/product-catalog/category/add-and-remove-item-attribute-conditions"},{"openapi":"pim get /api-category/v1/category/item-attribute/condition","title":"Get item attribute conditions","href":"/v2/api-reference/product-catalog/category/get-item-attribute-conditions"},{"openapi":"pim post /api-category/v1/category/bulk/upsert","title":"Create or update multiple categories or collections","href":"/v2/api-reference/product-catalog/category/create-or-update-multiple-categories-or-collections"},{"openapi":"pim post /api-category/v1/category/find","title":"Find categories","href":"/v2/api-reference/product-catalog/category/find-categories-1"},{"openapi":"pim post /api-category/v1/category/bulk/category-attribute","title":"Manage category attributes for multiple categories or collections","href":"/v2/api-reference/product-catalog/category/manage-category-attributes-for-multiple-categories-or-collections"},{"openapi":"pim post /api-category/v1/category/bulk/item-attribute","title":"Manage item attributes for multiple categories","href":"/v2/api-reference/product-catalog/category/manage-item-attributes-for-multiple-categories"}]},{"group":"Product","pages":[{"title":"Product","sidebarTitle":"Overview","href":"/v2/api-reference/product-catalog/product/overview"},{"openapi":"pim post /api-product/v1/product/bulk/insert","title":"Create items and bundles","href":"/v2/api-reference/product-catalog/product/create-items-and-bundles"},{"openapi":"pim post /api-product/v1/product/bulk/update","title":"Update items and bundles","href":"/v2/api-reference/product-catalog/product/update-items-and-bundles"},{"openapi":"pim post /api-product/v1/product/bulk/upsert","title":"Upsert items and bundles","href":"/v2/api-reference/product-catalog/product/upsert-items-and-bundles"},{"openapi":"pim post /api-product/v1/product/bundle/update","title":"Update items in bundle","href":"/v2/api-reference/product-catalog/product/update-items-in-bundle"},{"openapi":"pim get /api-product/v1/product","title":"Get items and children items","href":"/v2/api-reference/product-catalog/product/get-items-and-children-items"},{"openapi":"pim get /api-product/v2/product","title":"Get items and limited children items","href":"/v2/api-reference/product-catalog/product/get-items-and-limited-children-items"},{"openapi":"pim get /api-product/v1/product/search","title":"Find items","href":"/v2/api-reference/product-catalog/product/find-items"},{"openapi":"pim get /api-product/v1/product/attribute","title":"Get item attributes","href":"/v2/api-reference/product-catalog/product/get-item-attributes"}]},{"group":"Attributes","pages":[{"title":"Attributes","sidebarTitle":"Overview","href":"/v2/api-reference/product-catalog/attributes/overview"},{"openapi":"pim post /api-category/v1/category/attribute/bulk","title":"Create, update and delete category attributes","href":"/v2/api-reference/product-catalog/attributes/create-update-and-delete-category-attributes"},{"openapi":"pim post /api-product/v1/product/attribute/bulk","title":"Create update and delete item attributes","href":"/v2/api-reference/product-catalog/attributes/create-update-and-delete-item-attributes"},{"openapi":"pim post /api-product/v1/product/attribute-group","title":"Create, update and delete attribute groups","href":"/v2/api-reference/product-catalog/attributes/create-update-and-delete-attribute-groups"},{"openapi":"pim post /api-product/v1/product/attribute-group/search","title":"Find attribute groups","href":"/v2/api-reference/product-catalog/attributes/find-attribute-groups"},{"openapi":"pim post /api-product/v1/product/attribute/mapping/search","title":"Find attribute mapping","href":"/v2/api-reference/product-catalog/attributes/find-attribute-mapping"},{"openapi":"pim post /api-product/v1/product/attribute/mapping","title":"Create and Update attribute mappings","href":"/v2/api-reference/product-catalog/attributes/create-and-update-attribute-mappings"}]},{"group":"Bulk Import","pages":[{"title":"Bulk Import","sidebarTitle":"Overview","href":"/v2/api-reference/product-catalog/bulk-import/overview"},{"openapi":"pim get /api-category/v1/category/bulk/template","title":"Generate CSV template for categories","href":"/v2/api-reference/product-catalog/bulk-import/generate-csv-template-for-categories"},{"openapi":"pim post /api-category/v1/upload-url","title":"Generate S3 bucket URL for categories import","href":"/v2/api-reference/product-catalog/bulk-import/generate-s3-bucket-url-for-categories-import"},{"openapi":"pim post /api-category/v1/category/file/search","title":"Get imported files for categories","href":"/v2/api-reference/product-catalog/bulk-import/get-imported-files-for-categories"},{"openapi":"pim get /api-category/v1/category/bulk/file/{fileId}/status","title":"Get file upload status","href":"/v2/api-reference/product-catalog/bulk-import/get-file-upload-status"},{"openapi":"pim get /api-product/v1/product/bulk/template/{accountId}/{nodeId}","title":"Generate CSV template file for items","href":"/v2/api-reference/product-catalog/bulk-import/generate-csv-template-file-for-items"},{"openapi":"pim post /api-product/v1/upload-url","title":"Generate S3 bucket URL for item import","href":"/v2/api-reference/product-catalog/bulk-import/generate-s3-bucket-url-for-item-import"},{"openapi":"pim post /api-product/v1/product/file/search","title":"Get imported files for items","href":"/v2/api-reference/product-catalog/bulk-import/get-imported-files-for-items"},{"openapi":"pim get /api-product/v1/product/bulk/template/bundle/{accountId}/{nodeId}","title":"Generate CSV template for bundles","href":"/v2/api-reference/product-catalog/bulk-import/generate-csv-template-for-bundles"},{"openapi":"pim post /api-product/v1/upload-url/bundle","title":"Generate S3 bucket URL for bundle import","href":"/v2/api-reference/product-catalog/bulk-import/generate-s3-bucket-url-for-bundle-import"},{"openapi":"pim post /api-product/v1/product/file/bundle/search","title":"Get imported files for bundles","href":"/v2/api-reference/product-catalog/bulk-import/get-imported-files-for-bundles"},{"openapi":"pim get /api-product/v1/product/bulk/template/attribute","title":"Generate CSV template for item attributes","href":"/v2/api-reference/product-catalog/bulk-import/generate-csv-template-for-item-attributes"},{"openapi":"pim post /api-product/v1/upload-url/attribute","title":"Generate S3 bucket URL for item attribute import","href":"/v2/api-reference/product-catalog/bulk-import/generate-s3-bucket-url-for-item-attribute-import"},{"openapi":"pim post /api-product/v1/product/file/attribute/search","title":"Get imported files for item attributes","href":"/v2/api-reference/product-catalog/bulk-import/get-imported-files-for-item-attributes"},{"openapi":"pim get /api-product/v1/product/bulk/file/{fileId}/status","title":"Get file upload status","href":"/v2/api-reference/product-catalog/bulk-import/get-file-upload-status-1"}]}]},{"group":"Orders v2 (OMS v2)","pages":[{"title":"Order Management System","href":"/v2/api-reference/orders-v2/order-management-system"},{"group":"Order","pages":[{"title":"Order","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/order/overview"},{"openapi":"oms_v2_combined post /order/","title":"Create an order","href":"/v2/api-reference/orders-v2/order/create-an-order"},{"openapi":"oms_v2_combined get /order/","title":"Get an order","href":"/v2/api-reference/orders-v2/order/get-an-order"},{"openapi":"oms_v2_combined put /order/{orderNumber}","title":"Update an order","href":"/v2/api-reference/orders-v2/order/update-an-order"},{"openapi":"oms_v2_combined post /order/query","title":"Get orders by query","href":"/v2/api-reference/orders-v2/order/get-orders-by-query"},{"openapi":"oms_v2_combined patch /order/{orderId}/shipto/{shipToId}/pickup","title":"Update pickup information of an order","href":"/v2/api-reference/orders-v2/order/update-pickup-information-of-an-order"},{"openapi":"oms_v2_combined patch /order/{orderId}/customer","title":"Update customer information for an order","href":"/v2/api-reference/orders-v2/order/update-customer-information-for-an-order"},{"openapi":"oms_v2_combined get /order/exchange","title":"Check order-exchange eligibility","href":"/v2/api-reference/orders-v2/order/check-order-exchange-eligibility"}]},{"group":"Order Attribute","pages":[{"title":"Order Attribute","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/order-attribute/overview"},{"openapi":"oms_v2_combined get /order/attribute","title":"Get all attributes","href":"/v2/api-reference/orders-v2/order-attribute/get-all-attributes"},{"openapi":"oms_v2_combined post /order/attribute","title":"Create attribute","href":"/v2/api-reference/orders-v2/order-attribute/create-attribute"},{"openapi":"oms_v2_combined get /order/attribute/{code}","title":"Get a specific attribute","href":"/v2/api-reference/orders-v2/order-attribute/get-a-specific-attribute"},{"openapi":"oms_v2_combined put /order/attribute/{code}","title":"update a specific attribute","href":"/v2/api-reference/orders-v2/order-attribute/update-a-specific-attribute"},{"openapi":"oms_v2_combined delete /order/attribute/{code}","title":"Delete an attribute by code","href":"/v2/api-reference/orders-v2/order-attribute/delete-an-attribute-by-code"}]},{"group":"Order Return","pages":[{"title":"Order Return","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/order-return/overview"},{"openapi":"oms_v2_combined get /order/returns","title":"Check order return eligibility","href":"/v2/api-reference/orders-v2/order-return/check-order-return-eligibility"},{"openapi":"oms_v2_combined post /order/returns","title":"Return order","href":"/v2/api-reference/orders-v2/order-return/return-order"}]},{"group":"Payment Status","pages":[{"openapi":"oms_v2_combined post /order/payment-status/{orderNumber}","title":"Get payment details for a specific order","href":"/v2/api-reference/orders-v2/payment-status/get-payment-details-for-a-specific-order"}]},{"group":"Package Tracking","pages":[{"title":"Package Tracking","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/package-tracking/overview"},{"openapi":"oms_v2_combined post /order/package-tracking/acknowledge","title":"Acknowledge package tracking","href":"/v2/api-reference/orders-v2/package-tracking/acknowledge-package-tracking"}]},{"group":"Cross Border","pages":[{"title":"Cross Border","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/cross-border/overview"},{"openapi":"oms_v2_combined post /order/cross-border/validate-order","title":"Validate order for international shipping","href":"/v2/api-reference/orders-v2/cross-border/validate-order-for-international-shipping"},{"openapi":"oms_v2_combined post /order/cross-border/release-order","title":"Releases order","href":"/v2/api-reference/orders-v2/cross-border/releases-order"}]},{"group":"Order Cancellation","pages":[{"title":"Order Cancellation","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/order-cancellation/overview"},{"openapi":"oms_v2_combined get /order/cancel","title":"Check order-cancellation eligibility","href":"/v2/api-reference/orders-v2/order-cancellation/check-order-cancellation-eligibility"},{"openapi":"oms_v2_combined post /order/cancel","title":"Cancel order","href":"/v2/api-reference/orders-v2/order-cancellation/cancel-order"}]},{"group":"Appeasement","pages":[{"title":"Appeasement","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/appeasement/overview"},{"openapi":"oms_v2_combined post /order/appeasement","title":"Create appeasement","href":"/v2/api-reference/orders-v2/appeasement/create-appeasement"}]},{"group":"Allocation","pages":[{"title":"Allocation","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/allocation/overview"},{"openapi":"oms_v2_combined get /allocation/{allocationId}","title":"Get allocation","href":"/v2/api-reference/orders-v2/allocation/get-allocation"},{"openapi":"oms_v2_combined put /allocation/{allocationId}","title":"Update allocation","href":"/v2/api-reference/orders-v2/allocation/update-allocation"},{"openapi":"oms_v2_combined post /allocation/query","title":"Get allocation by query","href":"/v2/api-reference/orders-v2/allocation/get-allocation-by-query"},{"openapi":"oms_v2_combined put /allocation/reallocate","title":"Reallocate location","href":"/v2/api-reference/orders-v2/allocation/reallocate-location"},{"openapi":"oms_v2_combined put /allocation/cancel/{allocationIds}","title":"Cancel allocation ","href":"/v2/api-reference/orders-v2/allocation/cancel-allocation"}]},{"group":"Configuration","pages":[{"title":"Configuration","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/configuration/overview"},{"openapi":"oms_v2_combined get /configurations/tenant-config","title":"Get All configuration for tenant.","href":"/v2/api-reference/orders-v2/configuration/get-all-configuration-for-tenant"},{"openapi":"oms_v2_combined put /configurations/tenant-config","title":"Replace all tenant configuration for tenant","href":"/v2/api-reference/orders-v2/configuration/replace-all-tenant-configuration-for-tenant"},{"openapi":"oms_v2_combined post /configurations/tenant-config","title":"Create a configuration for tenant.","href":"/v2/api-reference/orders-v2/configuration/create-a-configuration-for-tenant"},{"openapi":"oms_v2_combined patch /configurations/tenant-config","title":"Update All the configuration for tenant.","href":"/v2/api-reference/orders-v2/configuration/update-all-the-configuration-for-tenant"},{"openapi":"oms_v2_combined get /configurations/tenant-config/{configType}/name/{configName}","title":"Get configuration for tenant.","href":"/v2/api-reference/orders-v2/configuration/get-configuration-for-tenant"},{"openapi":"oms_v2_combined put /configurations/tenant-config/{configType}/name/{configName}","title":"Replace the configuration for tenant.","href":"/v2/api-reference/orders-v2/configuration/replace-the-configuration-for-tenant"},{"openapi":"oms_v2_combined delete /configurations/tenant-config/{configType}/name/{configName}","title":"Delete the tenant's configuration.","href":"/v2/api-reference/orders-v2/configuration/delete-the-tenants-configuration"},{"openapi":"oms_v2_combined patch /configurations/tenant-config/{configType}/name/{configName}","title":"Update tenant configuration for tenant.","href":"/v2/api-reference/orders-v2/configuration/update-tenant-configuration-for-tenant"},{"openapi":"oms_v2_combined post /configurations/tenant-config/query","title":"Get configuration for given filters.","href":"/v2/api-reference/orders-v2/configuration/get-configuration-for-given-filters"}]},{"group":"Fraud Configuration","pages":[{"title":null,"sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/fraud-configuration/overview"},{"openapi":"oms_v2_combined get /configurations/fraud-config/{processName}/{serviceName}","title":"Get All Fraud configuration for tenant.","href":"/v2/api-reference/orders-v2/fraud-configuration/get-all-fraud-configuration-for-tenant"},{"openapi":"oms_v2_combined put /configurations/fraud-config/{processName}/{serviceName}","title":"Replace the Fraud configuration for tenant.","href":"/v2/api-reference/orders-v2/fraud-configuration/replace-the-fraud-configuration-for-tenant"},{"openapi":"oms_v2_combined delete /configurations/fraud-config/{processName}/{serviceName}","title":"Delete the Fraud's configuration.","href":"/v2/api-reference/orders-v2/fraud-configuration/delete-the-frauds-configuration"},{"openapi":"oms_v2_combined get /configurations/fraud-config","title":"Get All Fraud configuration for tenant.","href":"/v2/api-reference/orders-v2/fraud-configuration/get-all-fraud-configuration-for-tenant-1"},{"openapi":"oms_v2_combined post /configurations/fraud-config","title":"Create a Fraud configuration for tenant.","href":"/v2/api-reference/orders-v2/fraud-configuration/create-a-fraud-configuration-for-tenant"}]},{"group":"Target Configuration","pages":[{"title":"Target Configuration","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/target-configuration/overview"},{"openapi":"oms_v2_combined get /configurations/target-config","title":"Get All Target configuration for tenant.","href":"/v2/api-reference/orders-v2/target-configuration/get-all-target-configuration-for-tenant"},{"openapi":"oms_v2_combined post /configurations/target-config","title":"Create a Target configuration for tenant.","href":"/v2/api-reference/orders-v2/target-configuration/create-a-target-configuration-for-tenant"},{"openapi":"oms_v2_combined get /configurations/target-config/{serviceName}/{processName}","title":"Get configuration for tenant.","href":"/v2/api-reference/orders-v2/target-configuration/get-configuration-for-tenant"},{"openapi":"oms_v2_combined delete /configurations/target-config/{serviceName}/{processName}","title":"Delete the Target's configuration.","href":"/v2/api-reference/orders-v2/target-configuration/delete-the-targets-configuration"}]},{"group":"Location","pages":[{"title":"Location","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/location/overview"},{"openapi":"oms_v2_combined get /location","title":"Get all locations","href":"/v2/api-reference/orders-v2/location/get-all-locations"},{"openapi":"oms_v2_combined post /location","title":"Create location","href":"/v2/api-reference/orders-v2/location/create-location"},{"openapi":"oms_v2_combined get /location/{locationNum}","title":"Get specific location","href":"/v2/api-reference/orders-v2/location/get-specific-location"},{"openapi":"oms_v2_combined put /location/{locationNum}","title":"Update location by overriding existing details","href":"/v2/api-reference/orders-v2/location/update-location-by-overriding-existing-details"},{"openapi":"oms_v2_combined patch /location/{locationNum}","title":"Update location by adding new property","href":"/v2/api-reference/orders-v2/location/update-location-by-adding-new-property"},{"openapi":"oms_v2_combined delete /location/{locationNum}","title":"Delete specific location","href":"/v2/api-reference/orders-v2/location/delete-specific-location"},{"openapi":"oms_v2_combined post /location/geography/search","title":"Get near by locations within the radius","href":"/v2/api-reference/orders-v2/location/get-near-by-locations-within-the-radius"}]},{"group":"Location Attribute","pages":[{"title":"Location Attribute","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/location-attribute/overview"},{"openapi":"oms_v2_combined post /location/attribute","title":"Create location attribute","href":"/v2/api-reference/orders-v2/location-attribute/create-location-attribute"},{"openapi":"oms_v2_combined get /location/attribute","title":"Get all location attributes","href":"/v2/api-reference/orders-v2/location-attribute/get-all-location-attributes"},{"openapi":"oms_v2_combined get /location/attribute/{code}","title":"Get location attribute by code","href":"/v2/api-reference/orders-v2/location-attribute/get-location-attribute-by-code"},{"openapi":"oms_v2_combined put /location/attribute/{code}","title":"Update location attribute by code","href":"/v2/api-reference/orders-v2/location-attribute/update-location-attribute-by-code"},{"openapi":"oms_v2_combined delete /location/attribute/{code}","title":"Delete location attribute by code","href":"/v2/api-reference/orders-v2/location-attribute/delete-location-attribute-by-code"}]},{"group":"Inventory Network","pages":[{"title":"Inventory Network","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/inventory-network/overview"},{"openapi":"oms_v2_combined get /inventory/network","title":"Get all networks","href":"/v2/api-reference/orders-v2/inventory-network/get-all-networks"},{"openapi":"oms_v2_combined post /inventory/network","title":"Create network","href":"/v2/api-reference/orders-v2/inventory-network/create-network"},{"openapi":"oms_v2_combined get /inventory/network/{networkId}","title":"Get specific network","href":"/v2/api-reference/orders-v2/inventory-network/get-specific-network"},{"openapi":"oms_v2_combined put /inventory/network/{networkId}","title":"Updates specific network","href":"/v2/api-reference/orders-v2/inventory-network/updates-specific-network"},{"openapi":"oms_v2_combined delete /inventory/network/{networkId}","title":"Delete specific network","href":"/v2/api-reference/orders-v2/inventory-network/delete-specific-network"},{"openapi":"oms_v2_combined get /inventory/aggregatedNetwork/query","title":"Get aggregated networks","href":"/v2/api-reference/orders-v2/inventory-network/get-aggregated-networks"}]},{"group":"Inventory","pages":[{"title":"Inventory","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/inventory/overview"},{"openapi":"oms_v2_combined get /inventory","title":"Get inventories","href":"/v2/api-reference/orders-v2/inventory/get-inventories"},{"openapi":"oms_v2_combined post /inventory","title":"Create inventory","href":"/v2/api-reference/orders-v2/inventory/create-inventory"},{"openapi":"oms_v2_combined put /inventory","title":"Update inventory by overriding existing values","href":"/v2/api-reference/orders-v2/inventory/update-inventory-by-overriding-existing-values"},{"openapi":"oms_v2_combined patch /inventory","title":"Update inventory by adding new property","href":"/v2/api-reference/orders-v2/inventory/update-inventory-by-adding-new-property"},{"openapi":"oms_v2_combined put /inventory/adjustment","title":"Update inventory position or create inventory","href":"/v2/api-reference/orders-v2/inventory/update-inventory-position-or-create-inventory"},{"openapi":"oms_v2_combined patch /inventory/adjustment","title":"Update inventory position","href":"/v2/api-reference/orders-v2/inventory/update-inventory-position"},{"openapi":"oms_v2_combined get /inventory/{itemId}","title":"Get inventory of specific item","href":"/v2/api-reference/orders-v2/inventory/get-inventory-of-specific-item"},{"openapi":"oms_v2_combined get /inventory/geography","title":"Get inventories in specific region","href":"/v2/api-reference/orders-v2/inventory/get-inventories-in-specific-region"}]},{"group":"Inventory Counter","pages":[{"title":"Inventory Counter","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/inventory-counter/overview"},{"openapi":"oms_v2_combined post /inventory/counter","title":"Create counter","href":"/v2/api-reference/orders-v2/inventory-counter/create-counter"},{"openapi":"oms_v2_combined get /inventory/counter","title":"Get all counters","href":"/v2/api-reference/orders-v2/inventory-counter/get-all-counters"},{"openapi":"oms_v2_combined get /inventory/counter/{code}","title":"Get specific counter","href":"/v2/api-reference/orders-v2/inventory-counter/get-specific-counter"},{"openapi":"oms_v2_combined put /inventory/counter/{code}","title":"Update specific counter","href":"/v2/api-reference/orders-v2/inventory-counter/update-specific-counter"}]},{"group":"Inventory Bulk Operation","pages":[{"title":"Inventory Bulk Operation","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/inventory-bulk-operation/overview"},{"openapi":"oms_v2_combined post /inventory/aws/upload-url","title":"Create URL to bulk upload inventory","href":"/v2/api-reference/orders-v2/inventory-bulk-operation/create-url-to-bulk-upload-inventory"},{"openapi":"oms_v2_combined post /inventory/aws/download-url","title":"Create URL to download error details for an uploaded file","href":"/v2/api-reference/orders-v2/inventory-bulk-operation/create-url-to-download-error-details-for-an-uploaded-file"}]},{"group":"Inventory Attribute","pages":[{"title":"Inventory Attribute","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/inventory-attribute/overview"},{"openapi":"oms_v2_combined post /inventory/attribute","title":"Create inventory attribute","href":"/v2/api-reference/orders-v2/inventory-attribute/create-inventory-attribute"},{"openapi":"oms_v2_combined get /inventory/attribute/{code}","title":"Get inventory attribute by code","href":"/v2/api-reference/orders-v2/inventory-attribute/get-inventory-attribute-by-code"}]},{"group":"Inventory Upload Log","pages":[{"title":"Inventory Upload Log","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/inventory-upload-log/overview"},{"openapi":"oms_v2_combined get /inventory/upload/log","title":"Get inventory upload status for specific file","href":"/v2/api-reference/orders-v2/inventory-upload-log/get-inventory-upload-status-for-specific-file"},{"openapi":"oms_v2_combined get /inventory/upload/log/all","title":"Get inventory upload record for all files","href":"/v2/api-reference/orders-v2/inventory-upload-log/get-inventory-upload-record-for-all-files"}]},{"group":"Shipment","pages":[{"title":"Shipment","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/shipment/overview"},{"openapi":"oms_v2_combined post /shipment/","title":"Create Shipment","href":"/v2/api-reference/orders-v2/shipment/create-shipment"},{"openapi":"oms_v2_combined get /shipment/{shipmentId}","title":"Get Shipment","href":"/v2/api-reference/orders-v2/shipment/get-shipment"},{"openapi":"oms_v2_combined post /shipment/reship","title":"Create reshipment","href":"/v2/api-reference/orders-v2/shipment/create-reshipment"},{"openapi":"oms_v2_combined put /shipment/{shipmentId}","title":"Update shipment","href":"/v2/api-reference/orders-v2/shipment/update-shipment"},{"openapi":"oms_v2_combined post /shipment/tracking","title":"Update package tracking","href":"/v2/api-reference/orders-v2/shipment/update-package-tracking"},{"openapi":"oms_v2_combined post /shipment/query","title":"Filter shipments","href":"/v2/api-reference/orders-v2/shipment/filter-shipments"},{"openapi":"oms_v2_combined post /shipment/gift-card/activation","title":"Activate gift card","href":"/v2/api-reference/orders-v2/shipment/activate-gift-card"},{"openapi":"oms_v2_combined post /shipment/gift-card/activation-acknowledge","title":"Acknowledge gift card activation","href":"/v2/api-reference/orders-v2/shipment/acknowledge-gift-card-activation"},{"openapi":"oms_v2_combined post /shipment/acknowledge","title":"Acknowledge Shipment","href":"/v2/api-reference/orders-v2/shipment/acknowledge-shipment"}]},{"group":"Shipping Method","pages":[{"title":"Shipping Method","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/shipping-method/overview"},{"openapi":"oms_v2_combined post /shipping/","title":"Create shipping method","href":"/v2/api-reference/orders-v2/shipping-method/create-shipping-method"},{"openapi":"oms_v2_combined get /shipping/{shipmethodId}","title":"Get shipping method","href":"/v2/api-reference/orders-v2/shipping-method/get-shipping-method"},{"openapi":"oms_v2_combined delete /shipping/{shipmethodId}","title":"Delete shipping method","href":"/v2/api-reference/orders-v2/shipping-method/delete-shipping-method"},{"openapi":"oms_v2_combined patch /shipping/{shipmethodId}","title":"Update shipping method","href":"/v2/api-reference/orders-v2/shipping-method/update-shipping-method"},{"openapi":"oms_v2_combined post /shipping/{shipMethodId}/item","title":"Add items to shipping methods","href":"/v2/api-reference/orders-v2/shipping-method/add-items-to-shipping-methods"},{"openapi":"oms_v2_combined post /shipping/query","title":"Filter shipping methods","href":"/v2/api-reference/orders-v2/shipping-method/filter-shipping-methods"},{"openapi":"oms_v2_combined get /shipping/{shipMethodId}/items","title":"Get ItemIds for a shipping method","href":"/v2/api-reference/orders-v2/shipping-method/get-itemids-for-a-shipping-method"},{"openapi":"oms_v2_combined get /shipping/shippingMethods/{itemId}","title":"Get shipping methods for an item","href":"/v2/api-reference/orders-v2/shipping-method/get-shipping-methods-for-an-item"}]},{"group":"Webhook","pages":[{"title":"Webhook","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/webhook/overview"},{"openapi":"oms_v2_combined post /webhook/retry","title":"Retry webhook","href":"/v2/api-reference/orders-v2/webhook/retry-webhook"},{"openapi":"oms_v2_combined post /webhook/event/query","title":"Query webhook event log","href":"/v2/api-reference/orders-v2/webhook/query-webhook-event-log"},{"openapi":"oms_v2_combined get /webhook/","title":"Get all webhook definitions","href":"/v2/api-reference/orders-v2/webhook/get-all-webhook-definitions"},{"openapi":"oms_v2_combined post /webhook/","title":"Create webhook definition","href":"/v2/api-reference/orders-v2/webhook/create-webhook-definition"},{"openapi":"oms_v2_combined get /webhook/{webhookId}","title":"Get webhook definition by ID","href":"/v2/api-reference/orders-v2/webhook/get-webhook-definition-by-id"},{"openapi":"oms_v2_combined delete /webhook/{webhookId}","title":"Delete webhook definition by ID","href":"/v2/api-reference/orders-v2/webhook/delete-webhook-definition-by-id"},{"openapi":"oms_v2_combined patch /webhook/{webhookId}","title":"Update webhook definition by ID","href":"/v2/api-reference/orders-v2/webhook/update-webhook-definition-by-id"}]},{"group":"Notification","pages":[{"openapi":"oms_v2_combined post /notification/send","title":"Listen to user and emit notifications","href":"/v2/api-reference/orders-v2/notification/listen-to-user-and-emit-notifications"},{"openapi":"oms_v2_combined post /notification/acknowledgment","title":"Listen to user and emit acknowledgment","href":"/v2/api-reference/orders-v2/notification/listen-to-user-and-emit-acknowledgment"}]},{"group":"Export","pages":[{"title":"Export","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/export/overview"},{"openapi":"oms_v2_combined post /exports","title":"Export records by query","href":"/v2/api-reference/orders-v2/export/export-records-by-query"},{"openapi":"oms_v2_combined get /exports/headers-list","title":"Get list of headers for given module","href":"/v2/api-reference/orders-v2/export/get-list-of-headers-for-given-module"},{"openapi":"oms_v2_combined post /exports/history","title":"Get OMS export log history by query","href":"/v2/api-reference/orders-v2/export/get-oms-export-log-history-by-query"},{"openapi":"oms_v2_combined get /exports/status","title":"Get record export status for given request","href":"/v2/api-reference/orders-v2/export/get-record-export-status-for-given-request"},{"openapi":"oms_v2_combined get /exports/files-list","title":"Get list of files for given module","href":"/v2/api-reference/orders-v2/export/get-list-of-files-for-given-module"},{"openapi":"oms_v2_combined get /exports/download-url","title":"Get URL for downloading exports","href":"/v2/api-reference/orders-v2/export/get-url-for-downloading-exports"}]},{"group":"Invoice","pages":[{"title":"Invoice","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/invoice/overview"},{"openapi":"oms_v2_combined post /invoice/","title":"Generate invoice","href":"/v2/api-reference/orders-v2/invoice/generate-invoice"},{"openapi":"oms_v2_combined post /invoice/query","title":"Get invoice by query","href":"/v2/api-reference/orders-v2/invoice/get-invoice-by-query"},{"openapi":"oms_v2_combined post /invoice/post","title":"Update invoice for financial posting","href":"/v2/api-reference/orders-v2/invoice/update-invoice-for-financial-posting"},{"openapi":"oms_v2_combined post /invoice/post/acknowledge","title":"Acknowledge financial posting","href":"/v2/api-reference/orders-v2/invoice/acknowledge-financial-posting"},{"openapi":"oms_v2_combined post /invoice/acknowledgement","title":"Acknowledge invoice by ID","href":"/v2/api-reference/orders-v2/invoice/acknowledge-invoice-by-id"},{"openapi":"oms_v2_combined get /invoice/{invoiceId}","title":"Get invoice by invoice ID","href":"/v2/api-reference/orders-v2/invoice/get-invoice-by-invoice-id"}]},{"group":"Fraud","pages":[{"title":"Fraud","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/fraud/overview"},{"openapi":"oms_v2_combined post /fraud/release","title":"Fraud Release Order","href":"/v2/api-reference/orders-v2/fraud/fraud-release-order"},{"openapi":"oms_v2_combined post /fraud/cancel","title":"Fraud Cancel Order","href":"/v2/api-reference/orders-v2/fraud/fraud-cancel-order"}]},{"group":"Backorder Preorder Reservation","pages":[{"title":"Backorder Preorder Reservation","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/backorder-preorder-reservation/overview"},{"openapi":"oms_v2_combined put /backpre-order/backorderpreorder-reserve/{lineItemId}/{orderNumber}","title":"Update BackOrderPreOrderReservation","href":"/v2/api-reference/orders-v2/backorder-preorder-reservation/update-backorderpreorderreservation"},{"openapi":"oms_v2_combined post /backpre-order/order/backorder/consent-to-delay","title":"To receive a consent from customer for the delay on backorder or preorder fulfilment.","href":"/v2/api-reference/orders-v2/backorder-preorder-reservation/to-receive-a-consent-from-customer-for-the-delay-on-backorder-or-preorder-fulfilment"},{"openapi":"oms_v2_combined post /backpre-order/backorderpreorder-update","title":"called when outer service updated any order has back/pre items, Allocation service after release","href":"/v2/api-reference/orders-v2/backorder-preorder-reservation/called-when-outer-service-updated-any-order-has-backpre-items-allocation-service-after-release"},{"openapi":"oms_v2_combined get /backpre-order/backorderpreorder-reserve","title":"Get backOrderPreOrderReservation","href":"/v2/api-reference/orders-v2/backorder-preorder-reservation/get-backorderpreorderreservation"},{"openapi":"oms_v2_combined post /backpre-order/backorderpreorder-reserve","title":"Create backOrderPreOrderReservation","href":"/v2/api-reference/orders-v2/backorder-preorder-reservation/create-backorderpreorderreservation"},{"openapi":"oms_v2_combined get /backpre-order/backorderpreorder-reserve/{identifier}","title":"Get backOrderPreOrderReservation list","href":"/v2/api-reference/orders-v2/backorder-preorder-reservation/get-backorderpreorderreservation-list"},{"openapi":"oms_v2_combined delete /backpre-order/backorderpreorder-reserve/{identifier}","title":"Delete BackOrderPreOrderReservation","href":"/v2/api-reference/orders-v2/backorder-preorder-reservation/delete-backorderpreorderreservation"}]},{"group":"List","pages":[{"title":"List","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/list/overview"},{"openapi":"oms_v2_combined post /list/","title":"Create list","href":"/v2/api-reference/orders-v2/list/create-list"},{"openapi":"oms_v2_combined post /list/{listId}/items","title":"Add items to a specific list","href":"/v2/api-reference/orders-v2/list/add-items-to-a-specific-list"},{"openapi":"oms_v2_combined get /list/{listId}/items","title":"Get items of a specific list","href":"/v2/api-reference/orders-v2/list/get-items-of-a-specific-list"},{"openapi":"oms_v2_combined get /list/{listId}","title":"Get list detail by Id","href":"/v2/api-reference/orders-v2/list/get-list-detail-by-id"},{"openapi":"oms_v2_combined delete /list/{listId}","title":"Delete list by Id","href":"/v2/api-reference/orders-v2/list/delete-list-by-id"},{"openapi":"oms_v2_combined patch /list/{listId}","title":"Update list by Id","href":"/v2/api-reference/orders-v2/list/update-list-by-id"},{"openapi":"oms_v2_combined get /list/user/{userId}","title":"Get lists by userId","href":"/v2/api-reference/orders-v2/list/get-lists-by-userid"}]}]},{"group":"Orders v1 (OMS v1)","pages":[{"title":"Order Management System","href":"/v2/api-reference/orders-v1/order-management-system"},{"group":"Cart","pages":[{"title":"Cart","href":"/v2/api-reference/orders-v1/cart/overview"},{"openapi":"oms_v1 patch /api-cart/cart/{cartId}/status/{updatedStatus}","title":"Update cart status","href":"/v2/api-reference/orders-v1/cart/update-cart-status"},{"openapi":"oms_v1 patch /api-cart/cart/{cartId}/header","title":"Update cart header","href":"/v2/api-reference/orders-v1/cart/update-cart-header"},{"openapi":"oms_v1 patch /api-cart/cart/{cartId}/empty","title":"Empty cart for the given cart ID","href":"/v2/api-reference/orders-v1/cart/empty-cart-for-the-given-cart-id"},{"openapi":"oms_v1 post /api-cart/cart/item","title":"Add item to cart","href":"/v2/api-reference/orders-v1/cart/add-item-to-cart"},{"openapi":"oms_v1 patch /api-cart/cart/{cartId}/item/{lineItemId}","title":"Remove item from cart by line item ID","href":"/v2/api-reference/orders-v1/cart/remove-item-from-cart-by-line-item-id"},{"openapi":"oms_v1 patch /api-cart/cart/merge","title":"Merge user cart and guest cart","href":"/v2/api-reference/orders-v1/cart/merge-user-cart-and-guest-cart"},{"openapi":"oms_v1 patch /api-cart/cart/{cartId}/ship-to","title":"Add shipTo IDs to cart items","href":"/v2/api-reference/orders-v1/cart/add-shipto-ids-to-cart-items"},{"openapi":"oms_v1 post /api-cart/cart/query","title":"Query on carts","href":"/v2/api-reference/orders-v1/cart/query-on-carts"},{"openapi":"oms_v1 delete /api-cart/cart-decoupled/{cartId}","title":"Cart soft delete (cart decoupled)","href":"/v2/api-reference/orders-v1/cart/cart-soft-delete-cart-decoupled"},{"openapi":"oms_v1 get /api-cart/cart","title":"Get cart for the given cart ID or user auth token","href":"/v2/api-reference/orders-v1/cart/get-cart-for-the-given-cart-id-or-user-auth-token"},{"openapi":"oms_v1 patch /api-cart/cart/{cartId}/orderNumber","title":"[Deprecated] Cart soft delete","href":"/v2/api-reference/orders-v1/cart/[deprecated]-cart-soft-delete"},{"openapi":"oms_v1 patch /api-cart/cart/remove-promo","title":"Remove promotion from cart","href":"/v2/api-reference/orders-v1/cart/remove-promotion-from-cart"},{"openapi":"oms_v1 patch /api-cart/cart/apply-promo","title":"Add promotion to cart","href":"/v2/api-reference/orders-v1/cart/add-promotion-to-cart"},{"openapi":"oms_v1 patch /api-cart/cart/{cartId}/items","title":"Update cart","href":"/v2/api-reference/orders-v1/cart/update-cart"},{"openapi":"oms_v1 delete /api-cart/cart/{cartId}","title":"Cart soft delete","href":"/v2/api-reference/orders-v1/cart/cart-soft-delete"},{"openapi":"oms_v1 patch /api-cart/cart/{cartId}/ship-to/v1","title":"Add shipTo IDs to cart items (v1)","href":"/v2/api-reference/orders-v1/cart/add-shipto-ids-to-cart-items-v1"}]},{"group":"Bill To","pages":[{"title":"Bill To","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v1/bill-to/overview"},{"openapi":"oms_v1 get /api-cart/bill-to/{billToId}","title":"Get bill-to by ID [Deprecated]","href":"/v2/api-reference/orders-v1/bill-to/get-bill-to-by-id-[deprecated]"},{"openapi":"oms_v1 patch /api-cart/cart/{cartId}/bill-to/{billToId}","title":"Update billto for a shipment [Deprecated]","href":"/v2/api-reference/orders-v1/bill-to/update-billto-for-a-shipment-[deprecated]"},{"openapi":"oms_v1 get /api-cart/bill-to/ship-to/{shipToId}","title":"Get bill-to by shipToId [Deprecated]","href":"/v2/api-reference/orders-v1/bill-to/get-bill-to-by-shiptoid-[deprecated]"},{"openapi":"oms_v1 post /api-cart/bill-to/cart/{cartId}","title":"Create billto for a shipment [Deprecated]","href":"/v2/api-reference/orders-v1/bill-to/create-billto-for-a-shipment-[deprecated]"}]},{"group":"Ship To","pages":[{"title":"Ship To","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v1/ship-to/overview"},{"openapi":"oms_v1 post /api-cart/ship-to/cart/{cartId}","title":"Create ship-to","href":"/v2/api-reference/orders-v1/ship-to/create-ship-to"},{"openapi":"oms_v1 post /api-cart/ship-to/v1/cart/{cartId}","title":"Create ship-to (v1)","href":"/v2/api-reference/orders-v1/ship-to/create-ship-to-v1"},{"openapi":"oms_v1 get /api-cart/ship-to/{shipTo}","title":"Get ShipTo by ID","href":"/v2/api-reference/orders-v1/ship-to/get-shipto-by-id"},{"openapi":"oms_v1 patch /api-cart/cart/{cartId}/ship-to/{shipToId}","title":"Update ship-to","href":"/v2/api-reference/orders-v1/ship-to/update-ship-to"},{"openapi":"oms_v1 get /api-cart/ship-to/{shipToId}/cart","title":"Get Cart data for the given shipTo ID","href":"/v2/api-reference/orders-v1/ship-to/get-cart-data-for-the-given-shipto-id"},{"openapi":"oms_v1 patch /api-cart/v1/cart/{cartId}/ship-to/{shipToId}","title":"Update ship-to (v1)","href":"/v2/api-reference/orders-v1/ship-to/update-ship-to-v1"}]},{"group":"Wishlist","pages":[{"title":"Wishlist","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v1/wishlist/overview"},{"openapi":"oms_v1 delete /api-cart/wishlist/user/item/{itemId}","title":"Delete from Wishlist","href":"/v2/api-reference/orders-v1/wishlist/delete-from-wishlist"},{"openapi":"oms_v1 get /api-cart/wishlist/user","title":"Get wishlist","href":"/v2/api-reference/orders-v1/wishlist/get-wishlist"},{"openapi":"oms_v1 post /api-cart/wishlist/user","title":"Create/add to wishlist","href":"/v2/api-reference/orders-v1/wishlist/createadd-to-wishlist"}]},{"group":"Cart Decoupled","pages":[{"title":"Cart Decoupled","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v1/cart-decoupled/overview"},{"openapi":"oms_v1 patch /api-cart/cart-decoupled/{cartId}/items","title":"Update Items already in cart (cart decoupled)","href":"/v2/api-reference/orders-v1/cart-decoupled/update-items-already-in-cart-cart-decoupled"},{"openapi":"oms_v1 get /api-cart/cart-decoupled","title":"Get cart for the given cart ID or user auth token (cart decoupled)","href":"/v2/api-reference/orders-v1/cart-decoupled/get-cart-for-the-given-cart-id-or-user-auth-token-cart-decoupled"},{"openapi":"oms_v1 patch /api-cart/cart-decoupled/merge","title":"Merge guest cart with user cart (cart decoupled)","href":"/v2/api-reference/orders-v1/cart-decoupled/merge-guest-cart-with-user-cart-cart-decoupled"},{"openapi":"oms_v1 patch /api-cart/cart-decoupled/{cartId}/empty","title":"Empty cart (cart decoupled)","href":"/v2/api-reference/orders-v1/cart-decoupled/empty-cart-cart-decoupled"},{"openapi":"oms_v1 patch /api-cart/cart-decoupled/{cartId}/item/{lineItemId}","title":"Remove item from cart (cart decoupled)","href":"/v2/api-reference/orders-v1/cart-decoupled/remove-item-from-cart-cart-decoupled"},{"openapi":"oms_v1 patch /api-cart/cart-decoupled/{cartId}/orderNumber","title":"[Deprecated] Remove Cart (cart decoupled)","href":"/v2/api-reference/orders-v1/cart-decoupled/[deprecated]-remove-cart-cart-decoupled"},{"openapi":"oms_v1 post /api-cart/cart-decoupled/item","title":"Add item to cart (cart decoupled)","href":"/v2/api-reference/orders-v1/cart-decoupled/add-item-to-cart-cart-decoupled"}]},{"group":"Warehouse","pages":[{"title":"Warehouse","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v1/warehouse/overview"},{"openapi":"oms_v1 get /api-inventory/warehouse/default","title":"Get default warehouse location","href":"/v2/api-reference/orders-v1/warehouse/get-default-warehouse-location"}]},{"group":"Inventory","pages":[{"title":"Inventory","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v1/inventory/overview"},{"openapi":"oms_v1 get /api-inventory/inventory/generic/{inventoryId}","title":"Get generic inventory","href":"/v2/api-reference/orders-v1/inventory/get-generic-inventory"},{"openapi":"oms_v1 get /api-inventory/inventory/location/{locationId}","title":"Get inventory by location","href":"/v2/api-reference/orders-v1/inventory/get-inventory-by-location"},{"openapi":"oms_v1 get /api-inventory/inventory/pickup-point/{itemId}","title":"Get pickup point","href":"/v2/api-reference/orders-v1/inventory/get-pickup-point"},{"openapi":"oms_v1 post /api-inventory/inventory/bulk-insert","title":"Bulk insert to inventory","href":"/v2/api-reference/orders-v1/inventory/bulk-insert-to-inventory"},{"openapi":"oms_v1 post /api-inventory/inventory","title":"Get inventories","href":"/v2/api-reference/orders-v1/inventory/get-inventories"},{"openapi":"oms_v1 post /api-inventory/inventory/pos","title":"Inventory POS","href":"/v2/api-reference/orders-v1/inventory/inventory-pos"}]},{"group":"Attributes","pages":[{"title":"Attributes","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v1/attributes/overview"},{"openapi":"oms_v1 patch /api-cart/cart/{cartId}/item/attribute","title":"Add attribute to cart item","href":"/v2/api-reference/orders-v1/attributes/add-attribute-to-cart-item"},{"openapi":"oms_v1 patch /api-cart/cart/{cartId}/attribute","title":"Add attribute to cart","href":"/v2/api-reference/orders-v1/attributes/add-attribute-to-cart"},{"openapi":"oms_v1 post /api-configuration/attribute/get-by-item-ids","title":"Get items attributes","href":"/v2/api-reference/orders-v1/attributes/get-items-attributes"},{"openapi":"oms_v1 get /api-configuration/attribute/getAll/order-attributes","title":"Get all order level attributes","href":"/v2/api-reference/orders-v1/attributes/get-all-order-level-attributes"}]},{"group":"List","pages":[{"title":"List","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v1/list/overview"},{"openapi":"oms_v1 get /api-list/list/user/{userId}","title":"Get list by userId","href":"/v2/api-reference/orders-v1/list/get-list-by-userid"},{"openapi":"oms_v1 patch /api-list/list/{listId}/items","title":"Add items to a known list","href":"/v2/api-reference/orders-v1/list/add-items-to-a-known-list"},{"openapi":"oms_v1 delete /api-list/list/{listId}/items","title":"Delete items from list","href":"/v2/api-reference/orders-v1/list/delete-items-from-list"},{"openapi":"oms_v1 post /api-list/list/query","title":"Query Lists","href":"/v2/api-reference/orders-v1/list/query-lists"},{"openapi":"oms_v1 patch /api-list/list/{listId}","title":"Update list","href":"/v2/api-reference/orders-v1/list/update-list"},{"openapi":"oms_v1 delete /api-list/list/{listId}","title":"Delete list","href":"/v2/api-reference/orders-v1/list/delete-list"},{"openapi":"oms_v1 get /api-list/list/{listId}","title":"Get list by listId","href":"/v2/api-reference/orders-v1/list/get-list-by-listid"},{"openapi":"oms_v1 post /api-list/list","title":"Create list","href":"/v2/api-reference/orders-v1/list/create-list"}]},{"group":"Tax/Address Validate","pages":[{"title":"Tax/Address Validate","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v1/taxaddress-validate/overview"},{"openapi":"oms_v1 post /api-tax/tax/create","title":"Create new tax transaction","href":"/v2/api-reference/orders-v1/taxaddress-validate/create-new-tax-transaction"},{"openapi":"oms_v1 post /api-tax/v1/address/validate","title":"Address validation (v1)","href":"/v2/api-reference/orders-v1/taxaddress-validate/address-validation-v1"},{"openapi":"oms_v1 post /api-tax/address/validate","title":"Address validation","href":"/v2/api-reference/orders-v1/taxaddress-validate/address-validation"}]},{"group":"Shipping","pages":[{"title":"Shipping","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v1/shipping/overview"},{"openapi":"oms_v1 get /api-shipping/shipping/items/{itemId}","title":"Get shipping method by item","href":"/v2/api-reference/orders-v1/shipping/get-shipping-method-by-item"},{"openapi":"oms_v1 post /api-shipping/shipping/expectedDelivery","title":"Get expected delivery for items","href":"/v2/api-reference/orders-v1/shipping/get-expected-delivery-for-items"},{"openapi":"oms_v1 get /api-shipping/shipping/all","title":"Get all shipping methods","href":"/v2/api-reference/orders-v1/shipping/get-all-shipping-methods"},{"openapi":"oms_v1 get /api-shipping/shipping/{shippingMethodId}","title":"Get shipping method","href":"/v2/api-reference/orders-v1/shipping/get-shipping-method"}]},{"group":"Payments","pages":[{"title":"Payments","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v1/payments/overview"},{"openapi":"oms_v1 get /api-payment/payment/{cartId}","title":"Get payment by cartId","href":"/v2/api-reference/orders-v1/payments/get-payment-by-cartid"},{"openapi":"oms_v1 post /api-payment/payment","title":"Add payment to cart","href":"/v2/api-reference/orders-v1/payments/add-payment-to-cart"},{"openapi":"oms_v1 post /ext-stripe/payment-intent/confirm/{paymentIntentId}","title":"Confirm Stripe payment intent","href":"/v2/api-reference/orders-v1/payments/confirm-stripe-payment-intent"},{"openapi":"oms_v1 post /ext-stripe/payment-method","title":"Create payment method","href":"/v2/api-reference/orders-v1/payments/create-payment-method"},{"openapi":"oms_v1 delete /api-payment/cart/{cartId}/payment/{paymentId}","title":"Delete payment","href":"/v2/api-reference/orders-v1/payments/delete-payment"},{"openapi":"oms_v1 post /ext-stripe/payment-intent","title":"Create Stripe payment intent","href":"/v2/api-reference/orders-v1/payments/create-stripe-payment-intent"}]},{"group":"Order","pages":[{"title":"Order","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v1/order/overview"},{"openapi":"oms_v1 patch /api-order/orders/cancel","title":"Cancel order","href":"/v2/api-reference/orders-v1/order/cancel-order"},{"openapi":"oms_v1 post /api-order/orders/pos/sync-status","title":"Sync order status","href":"/v2/api-reference/orders-v1/order/sync-order-status"},{"openapi":"oms_v1 patch /api-order/orders/return","title":"Return order","href":"/v2/api-reference/orders-v1/order/return-order"},{"openapi":"oms_v1 get /api-order/orders/user","title":"Get order by user","href":"/v2/api-reference/orders-v1/order/get-order-by-user"},{"openapi":"oms_v1 post /api-order/orders/payment","title":"Return payment by orderId","href":"/v2/api-reference/orders-v1/order/return-payment-by-orderid"},{"openapi":"oms_v1 post /api-order/orders/user/cancel","title":"Cancel order by user","href":"/v2/api-reference/orders-v1/order/cancel-order-by-user"},{"openapi":"oms_v1 post /api-order/orders/shipments-bulk","title":"Add shipment bulk to order","href":"/v2/api-reference/orders-v1/order/add-shipment-bulk-to-order"},{"openapi":"oms_v1 get /api-order/orders/orderNumber/{orderId}","title":"Get order","href":"/v2/api-reference/orders-v1/order/get-order"},{"openapi":"oms_v1 post /api-order/orders/query","title":"Order query","href":"/v2/api-reference/orders-v1/order/order-query"},{"openapi":"oms_v1 post /api-order/orders/bulk-cancel","title":"Bulk cancel orders","href":"/v2/api-reference/orders-v1/order/bulk-cancel-orders"},{"openapi":"oms_v1 post /api-order/orders/bulk-return","title":"Bulk return orders","href":"/v2/api-reference/orders-v1/order/bulk-return-orders"},{"openapi":"oms_v1 post /api-order/pos/orders","title":"Create POS order","href":"/v2/api-reference/orders-v1/order/create-pos-order"},{"openapi":"oms_v1 get /api-order/orders/user/guest","title":"Get order by email","href":"/v2/api-reference/orders-v1/order/get-order-by-email"},{"openapi":"oms_v1 post /api-order/orders/user/return","title":"Return order by user","href":"/v2/api-reference/orders-v1/order/return-order-by-user"},{"openapi":"oms_v1 post /api-order/checkout","title":"Order checkout","href":"/v2/api-reference/orders-v1/order/order-checkout"},{"openapi":"oms_v1 post /api-order/orders/shipments","title":"Add shipment to order","href":"/v2/api-reference/orders-v1/order/add-shipment-to-order"},{"openapi":"oms_v1 post /api-order/subscriptions/orders","title":"Create subscriptions orders","href":"/v2/api-reference/orders-v1/order/create-subscriptions-orders"},{"openapi":"oms_v1 post /api-order/checkout-v4","title":"Order checkout (v4)","href":"/v2/api-reference/orders-v1/order/order-checkout-v4"}]}]},{"group":"Offers v2","pages":[{"title":"Offers","href":"/v2/api-reference/offers-v2/offers"},{"group":"Promotion","pages":[{"title":"Promotion","sidebarTitle":"Overview","href":"/v2/api-reference/offers-v2/promotion/overview"},{"openapi":"offers_v2_combined post /api-offers/promo/search","title":"Search for promotions","description":"Use this endpont to search for promotions using filter conditions.","href":"/v2/api-reference/offers-v2/promotion/search-for-promotions"},{"openapi":"offers_v2_combined post /api-offers/promo/{promoId}/kill","title":"Stop a promotion","href":"/v2/api-reference/offers-v2/promotion/stop-a-promotion"},{"openapi":"offers_v2_combined delete /api-offers/promo/{promoId}","title":"Delete a specific promotion","description":"Deletes a specific promotion by ID. You can delete all promotions except an active promotion that has `state` defined as `ACTIVE`.","href":"/v2/api-reference/offers-v2/promotion/delete-a-specific-promotion"},{"openapi":"offers_v2_combined put /api-offers/promo/update/{promoId}","title":"Update a specific promotion","href":"/v2/api-reference/offers-v2/promotion/update-a-specific-promotion"},{"openapi":"offers_v2_combined put /api-offers/promo/{promoId}/enable-disable","title":"Enable or disable a promotion","href":"/v2/api-reference/offers-v2/promotion/enable-or-disable-a-promotion"},{"openapi":"offers_v2_combined post /api-offers/promo/create","title":"Create promotion","href":"/v2/api-reference/offers-v2/promotion/create-promotion"},{"openapi":"offers_v2_combined get /api-offers/promo/{promoId}","title":"Get a specific promotion","href":"/v2/api-reference/offers-v2/promotion/get-a-specific-promotion"},{"openapi":"offers_v2_combined post /api-offers/promo/list","title":"Get all promotions","href":"/v2/api-reference/offers-v2/promotion/get-all-promotions"}]},{"group":"Price Kind","pages":[{"title":"Price Kind","sidebarTitle":"Overview","href":"/v2/api-reference/offers-v2/price-kind/overview"},{"openapi":"offers_v2_combined post /api-offers/price-kind","title":"Get all price kinds","href":"/v2/api-reference/offers-v2/price-kind/get-all-price-kinds"}]},{"group":"Dynamic Pricing Engine","pages":[{"title":"Dynamic Pricing Strategy","sidebarTitle":"Overview","href":"/v2/api-reference/offers-v2/dynamic-pricing-engine/overview"},{"openapi":"offers_v2_combined post /v1/price/get-by-sku","title":"Get calculated prices","href":"/v2/api-reference/offers-v2/dynamic-pricing-engine/get-calculated-prices"},{"openapi":"offers_v2_combined post /v1/promo/evaluate-promotions","title":"Evaluate promotions","href":"/v2/api-reference/offers-v2/dynamic-pricing-engine/evaluate-promotions"}]},{"group":"Segment","pages":[{"title":"Segment","sidebarTitle":"Overview","href":"/v2/api-reference/offers-v2/segment/overview"},{"openapi":"offers_v2_combined delete /api-offers/segment/{segmentId}","title":"Delete a specific segment","href":"/v2/api-reference/offers-v2/segment/delete-a-specific-segment"},{"openapi":"offers_v2_combined put /api-offers/segment/{segmentId}","title":"Update a specific segment","href":"/v2/api-reference/offers-v2/segment/update-a-specific-segment"},{"openapi":"offers_v2_combined get /api-offers/segment/list","title":"Get list of all segments","href":"/v2/api-reference/offers-v2/segment/get-list-of-all-segments"},{"openapi":"offers_v2_combined get /api-offers/segment/{segmentId}","title":"Get a specific segment","href":"/v2/api-reference/offers-v2/segment/get-a-specific-segment"},{"openapi":"offers_v2_combined post /api-offers/segment","title":"Create segment","href":"/v2/api-reference/offers-v2/segment/create-segment"}]},{"group":"Coupon","pages":[{"title":"Coupon","sidebarTitle":"Overview","href":"/v2/api-reference/offers-v2/coupon/overview"},{"openapi":"offers_v2_combined put /api-offers/coupon/update/{couponId}","title":"Update a coupon","href":"/v2/api-reference/offers-v2/coupon/update-a-coupon"},{"openapi":"offers_v2_combined get /api-offers/coupon/{couponId}","title":"Get a specific coupon","href":"/v2/api-reference/offers-v2/coupon/get-a-specific-coupon"},{"openapi":"offers_v2_combined post /api-offers/coupon/create","title":"Create coupon","href":"/v2/api-reference/offers-v2/coupon/create-coupon"},{"openapi":"offers_v2_combined post /api-offers/coupon/search","title":"Search for coupons","href":"/v2/api-reference/offers-v2/coupon/search-for-coupons"},{"openapi":"offers_v2_combined put /api-offers/coupon/{couponId}/enable-disable","title":"Enable or disable a coupon","href":"/v2/api-reference/offers-v2/coupon/enable-or-disable-a-coupon"},{"openapi":"offers_v2_combined delete /api-offers/coupon/{couponId}","title":"Delete a coupon","href":"/v2/api-reference/offers-v2/coupon/delete-a-coupon"},{"openapi":"offers_v2_combined post /api-offers/coupon/list","title":"Get list of all coupons","href":"/v2/api-reference/offers-v2/coupon/get-list-of-all-coupons"}]},{"group":"Coupon Codes","pages":[{"title":"Coupon Code","sidebarTitle":"Overview","href":"/v2/api-reference/offers-v2/coupon-code/overview"},{"openapi":"offers_v2_combined post /api-offers/coupon/generate-codes","title":"Generate coupon codes","href":"/v2/api-reference/offers-v2/coupon/generate-coupon-codes"},{"openapi":"offers_v2_combined get /api-offers/coupon-codes","title":"Get a list of all coupon codes","href":"/v2/api-reference/offers-v2/coupon-code/list-coupon-codes"}]},{"group":"Product","pages":[{"title":"Product","sidebarTitle":"Overview","href":"/v2/api-reference/offers-v2/product/overview"},{"openapi":"offers_v2_combined get /api-offers/get-product/{sku}","title":"Get product and price by sku","href":"/v2/api-reference/offers-v2/product/get-product-and-price-by-sku"}]},{"group":"Price List","pages":[{"title":"Price List","sidebarTitle":"Overview","href":"/v2/api-reference/offers-v2/price-list/overview"},{"openapi":"offers_v2_combined get /api-offers/price-list/{priceListId}","title":"Get a specific price list","href":"/v2/api-reference/offers-v2/price-list/get-a-specific-price-list"},{"openapi":"offers_v2_combined post /api-offers/price-list","title":"Create price list","href":"/v2/api-reference/offers-v2/price-list/create-price-list"},{"openapi":"offers_v2_combined put /api-offers/price-list/{priceListId}","title":"Update a specific price list","href":"/v2/api-reference/offers-v2/price-list/update-a-specific-price-list"},{"openapi":"offers_v2_combined delete /api-offers/price-list/{priceListId}","title":"Delete a specific price list","href":"/v2/api-reference/offers-v2/price-list/delete-a-specific-price-list"},{"openapi":"offers_v2_combined get /api-offers/price-list","title":"Get all price lists","href":"/v2/api-reference/offers-v2/price-list/get-all-price-lists"}]},{"group":"Attributes","pages":[{"openapi":"offers_v2_combined get /api-offers/attributes","title":"Get list of all attributes","href":"/v2/api-reference/offers-v2/attributes/get-list-of-all-attributes"},{"openapi":"offers_v2_combined put /api-offers/attributes/{attributeId}","title":"Update a specific attribute","href":"/v2/api-reference/offers-v2/attributes/update-a-specific-attribute"},{"openapi":"offers_v2_combined delete /api-offers/attributes/{attributeId}","title":"Delete a specific attribute","href":"/v2/api-reference/offers-v2/attributes/delete-a-specific-attribute"},{"openapi":"offers_v2_combined post /api-offers/attributes","title":"Create attribute","href":"/v2/api-reference/offers-v2/attributes/create-attribute"},{"openapi":"offers_v2_combined get /api-offers/attributes/{attributeId}","title":"Get a specific attribute","href":"/v2/api-reference/offers-v2/attributes/get-a-specific-attribute"}]},{"group":"Item","pages":[{"title":"Item","sidebarTitle":"Overview","href":"/v2/api-reference/offers-v2/item/overview"},{"openapi":"offers_v2_combined post /api-offers/items/search","title":"Search products and assigned prices in a specific price list","href":"/v2/api-reference/offers-v2/item/search-products-and-assigned-prices-in-a-specific-price-list"},{"openapi":"offers_v2_combined get /api-offers/items/priceListId/{priceListId}","title":"Get Skus and itemIds in a specific pricelist","href":"/v2/api-reference/offers-v2/item/get-skus-and-itemids-in-a-specific-pricelist"},{"openapi":"offers_v2_combined get /api-offers/item/{itemId}","title":"Get price of a specific item","href":"/v2/api-reference/offers-v2/item/get-price-of-a-specific-item"}]},{"group":"Price Guard","pages":[{"title":"Price Guard","sidebarTitle":"Overview","href":"/v2/api-reference/offers-v2/price-guard/overview"},{"openapi":"offers_v2_combined delete /api-offers/price-guard/{priceGuardId}","title":"Delete a specific price guard","href":"/v2/api-reference/offers-v2/price-guard/delete-a-specific-price-guard"},{"openapi":"offers_v2_combined post /api-offers/price-guard","title":"Create price guard","href":"/v2/api-reference/offers-v2/price-guard/create-price-guard"},{"openapi":"offers_v2_combined put /api-offers/price-guard/{priceGuardId}","title":"Update a specific price guard","href":"/v2/api-reference/offers-v2/price-guard/update-a-specific-price-guard"},{"openapi":"offers_v2_combined get /api-offers/price-guard","title":"Get all price guards","href":"/v2/api-reference/offers-v2/price-guard/get-all-price-guards"}]},{"group":"Global Exclusion","pages":[{"title":"Global Exclusion","sidebarTitle":"Overview","href":"/v2/api-reference/offers-v2/global-exclusion/overview"},{"openapi":"offers_v2_combined post /api-offers/sku-list/{skuListId}/end-now","title":"End specific sku-list","href":"/v2/api-reference/offers-v2/global-exclusion/end-specific-sku-list"},{"openapi":"offers_v2_combined delete /api-offers/sku-list/{skuListId}","title":"Delete specific SKU-list","href":"/v2/api-reference/offers-v2/global-exclusion/delete-specific-sku-list"},{"openapi":"offers_v2_combined get /api-offers/sku-list/{skuListId}","title":"Get specific sku-list","href":"/v2/api-reference/offers-v2/global-exclusion/get-specific-sku-list"},{"openapi":"offers_v2_combined get /api-offers/sku-list","title":"Get all sku-lists excluded from discounts","href":"/v2/api-reference/offers-v2/global-exclusion/get-all-sku-lists-excluded-from-discounts"},{"openapi":"offers_v2_combined post /api-offers/sku-list","title":"Create sku-list","href":"/v2/api-reference/offers-v2/global-exclusion/create-sku-list"},{"openapi":"offers_v2_combined put /api-offers/sku-list/{skuListId}","title":"Update specific sku-list","href":"/v2/api-reference/offers-v2/global-exclusion/update-specific-sku-list"}]},{"group":"Upload Price CSV","pages":[{"title":"Upload Price CSV","sidebarTitle":"Overview","href":"/v2/api-reference/offers-v2/upload-price-csv/overview"},{"openapi":"offers_v2_combined post /api-pim/item/upload-url","title":"Generate URL to bulk upload price details","href":"/v2/api-reference/offers-v2/upload-price-csv/generate-url-to-bulk-upload-price-details"}]},{"group":"Pricing","pages":[{"title":"Pricing","sidebarTitle":"Overview","href":"/v2/api-reference/offers-v2/pricing/overview"},{"openapi":"offers_v2_combined post /api-offers/price","title":"Create or update price","href":"/v2/api-reference/offers-v2/pricing/create-or-update-price"},{"openapi":"offers_v2_combined get /api-offers/price","title":"Get all prices","href":"/v2/api-reference/offers-v2/pricing/get-all-prices"},{"openapi":"offers_v2_combined get /api-offers/price/{priceId}/priceList/{priceListId}","title":"Get price by priceId","href":"/v2/api-reference/offers-v2/pricing/get-price-by-priceid"},{"openapi":"offers_v2_combined delete /api-offers/price/{priceId}/priceList/{priceListId}","title":"Delete price by priceId","href":"/v2/api-reference/offers-v2/pricing/delete-price-by-priceid"}]},{"group":"Redemption","pages":[{"title":"Redemption","sidebarTitle":"Overview","href":"/v2/api-reference/offers-v2/redemption/overview"},{"openapi":"offers_v2_combined post /api-offers/redemption","title":"Create redemption","href":"/v2/api-reference/offers-v2/redemption/create-redemption"},{"openapi":"offers_v2_combined delete /api-offers/redemption/{redemptionId}","title":"Delete specific redemption record","href":"/v2/api-reference/offers-v2/redemption/delete-specific-redemption-record"}]},{"group":"Exports","pages":[{"openapi":"offers_v2_combined post /api-offers/offers-exports/actions/download-export-file","title":"Download exported CSV file","href":"/v2/api-reference/offers-v2/exports/download-exported-csv-file"},{"openapi":"offers_v2_combined get /api-offers/offers-exports/{exportId}","title":"Get export request by ID","href":"/v2/api-reference/offers-v2/exports/get-export-request-by-id"},{"openapi":"offers_v2_combined post /api-offers/offers-exports","title":"Initiate export request","href":"/v2/api-reference/offers-v2/exports/initiate-export-request"},{"openapi":"offers_v2_combined get /api-offers/offers-exports","title":"Get all export requests","href":"/v2/api-reference/offers-v2/exports/get-all-export-requests"}]}]},{"group":"Offers v1","pages":[{"title":"Offers","href":"/v2/api-reference/offers-v1/offers"},{"group":"Login API","pages":[{"title":"Login API","sidebarTitle":"Overview","href":"/v2/api-reference/offers-v1/login-api/overview"},{"openapi":"offers_v1 post /api-identity/auth/local/login","title":"Generate authorization token for local user","href":"/v2/api-reference/offers-v1/login-api/generate-authorization-token-for-local-user"}]},{"group":"Promotions","pages":[{"title":"Promotions","sidebarTitle":"Overview","href":"/v2/api-reference/offers-v1/promotions/overview"},{"openapi":"offers_v1 get /api-price/promo","title":"Get List of Promotions","href":"/v2/api-reference/offers-v1/promotions/get-list-of-promotions"},{"openapi":"offers_v1 post /api-price/promo/validate","title":"Validate Promotions","href":"/v2/api-reference/offers-v1/promotions/validate-promotions"},{"openapi":"offers_v1 get /api-price/promo/{promoId}","title":"Get Promotions by promotion ID","href":"/v2/api-reference/offers-v1/promotions/get-promotions-by-promotion-id"}]},{"group":"Pricing","pages":[{"sidebarTitle":"Overview","title":null,"href":"/v2/api-reference/offers-v1/pricing/overview"},{"openapi":"offers_v1 post /api-price/price","title":"Create Price","href":"/v2/api-reference/offers-v1/pricing/create-price"},{"openapi":"offers_v1 get /api-price/price","title":"Get Price","href":"/v2/api-reference/offers-v1/pricing/get-price"},{"openapi":"offers_v1 post /api-price/price/bulk-insert","title":"Add or Update Bulk Price","href":"/v2/api-reference/offers-v1/pricing/add-or-update-bulk-price"},{"openapi":"offers_v1 post /api-price/v2/price/get","title":"Get Prices of Items","href":"/v2/api-reference/offers-v1/pricing/get-prices-of-items"},{"openapi":"offers_v1 post /api-price/offer/get-by-itemIds","title":"Get Offers for Items by Item IDs","href":"/v2/api-reference/offers-v1/pricing/get-offers-for-items-by-item-ids"},{"openapi":"offers_v1 delete /api-price/price/{priceId}","title":"Delete price by ID","href":"/v2/api-reference/offers-v1/pricing/delete-price-by-id"},{"openapi":"offers_v1 get /api-price/price/{priceId}","title":"Get Price Details by Price ID","href":"/v2/api-reference/offers-v1/pricing/get-price-details-by-price-id"}]}]},{"group":"Subscriptions (SMT API)","pages":[{"title":"Subscriptions API","href":"/v2/api-reference/subscriptions/subscriptions-api"},{"group":"Cancellation Reasons","pages":[{"title":"Cancellation Reasons","sidebarTitle":"Overview","href":"/v2/api-reference/subscriptions/cancellation-reasons/overview"},{"openapi":"smt get /v1/cancellation-reasons","title":"Get all cancellation reasons","href":"/v2/api-reference/subscriptions/cancellation-reasons/get-all-cancellation-reasons"},{"openapi":"smt post /v1/cancellation-reasons","title":"Create cancellation reasons","href":"/v2/api-reference/subscriptions/cancellation-reasons/create-cancellation-reasons"}]},{"group":"Subscription Discounts","pages":[{"title":"Subscription Discounts","sidebarTitle":"Overview","href":"/v2/api-reference/subscriptions/subscription-discounts/overview"},{"openapi":"smt patch /v1/subscriptionDiscount/deactivate/{id}","title":"Deactivate a subscription discount","href":"/v2/api-reference/subscriptions/subscription-discounts/deactivate-a-subscription-discount"},{"openapi":"smt get /v1/subscriptionDiscount/{offerId}","title":"Get a subscription discount","href":"/v2/api-reference/subscriptions/subscription-discounts/get-a-subscription-discount"},{"openapi":"smt put /v1/subscriptionDiscount/{offerId}","title":"Update a subscription discount","href":"/v2/api-reference/subscriptions/subscription-discounts/update-a-subscription-discount"},{"openapi":"smt post /v1/subscriptionDiscount","title":"Create subscription discounts","href":"/v2/api-reference/subscriptions/subscription-discounts/create-subscription-discounts"}]},{"group":"Subscriptions","pages":[{"title":"Subscriptions","sidebarTitle":"Overview","href":"/v2/api-reference/subscriptions/subscriptions/overview"},{"openapi":"smt put /v1/subscriptions/{id}/reactivate","title":"Reactivate single subscription","href":"/v2/api-reference/subscriptions/subscriptions/reactivate-single-subscription"},{"openapi":"smt get /v1/subscriptions/{id}","title":"Get single subscription","href":"/v2/api-reference/subscriptions/subscriptions/get-single-subscription"},{"openapi":"smt get /v1/subscriptions","title":"Get all subscriptions","href":"/v2/api-reference/subscriptions/subscriptions/get-all-subscriptions"},{"openapi":"smt post /v1/subscriptions/replace-items","title":"Replace a subscription item","href":"/v2/api-reference/subscriptions/subscriptions/replace-a-subscription-item"},{"openapi":"smt put /v1/subscriptions/{id}/inactive","title":"Deactivate single subscription","href":"/v2/api-reference/subscriptions/subscriptions/deactivate-single-subscription"},{"openapi":"smt post /v1/subscriptions/bulk","title":"Create bulk subscriptions","href":"/v2/api-reference/subscriptions/subscriptions/create-bulk-subscriptions"},{"openapi":"smt post /v1/subscriptions/discontinued-items","title":"Discontinue items in subscription","href":"/v2/api-reference/subscriptions/subscriptions/discontinue-items-in-subscription"},{"openapi":"smt patch /v1/subscriptions/{id}","title":"Update single subscription","href":"/v2/api-reference/subscriptions/subscriptions/update-single-subscription"}]},{"group":"Subscribers","pages":[{"title":"Subscribers","sidebarTitle":"Overview","href":"/v2/api-reference/subscriptions/subscribers/overview"},{"openapi":"smt patch /v1/customers/{id}/subscriptions","title":"Update single subscriber's shipping and billing information","href":"/v2/api-reference/subscriptions/subscribers/update-single-subscribers-shipping-and-billing-information"},{"openapi":"smt post /v1/customers","title":"Create subscriber","href":"/v2/api-reference/subscriptions/subscribers/create-subscriber"},{"openapi":"smt put /v1/customers/{id}","title":"Update single subscriber","href":"/v2/api-reference/subscriptions/subscribers/update-single-subscriber"},{"openapi":"smt get /v1/customers/{id}","title":"Get single subscriber's account","href":"/v2/api-reference/subscriptions/subscribers/get-single-subscribers-account"}]},{"group":"Orders","pages":[{"title":"Orders","sidebarTitle":"Overview","href":"/v2/api-reference/subscriptions/orders/overview"},{"openapi":"smt get /v1/orders/{orderId}","title":"Get single order","href":"/v2/api-reference/subscriptions/orders/get-single-order"},{"openapi":"smt get /v1/orders/{orderId}/trigger-now","title":"Trigger single order","href":"/v2/api-reference/subscriptions/orders/trigger-single-order"},{"openapi":"smt post /v1/orders/{id}/remove-items","title":"Remove items from single order","href":"/v2/api-reference/subscriptions/orders/remove-items-from-single-order"},{"openapi":"smt patch /v1/orders/{orderId}","title":"Update single order","href":"/v2/api-reference/subscriptions/orders/update-single-order"},{"openapi":"smt get /v1/customers/{customerId}/orders","title":"Get all orders for a specific customer","href":"/v2/api-reference/subscriptions/orders/get-all-orders-for-a-specific-customer"},{"openapi":"smt put /v1/orders/{orderId}/skip","title":"Skip single order","href":"/v2/api-reference/subscriptions/orders/skip-single-order"},{"openapi":"smt post /v1/orders/{id}/add-items","title":"Add items to single order","href":"/v2/api-reference/subscriptions/orders/add-items-to-single-order"}]}]},{"group":"Loyalty (Member)","pages":[{"title":"Member APIs","href":"/v2/api-reference/loyalty/member-apis"},{"group":"Inquire","pages":[{"openapi":"member get /v1/inquire/redeemable-points","title":"Get Redeemable Points","href":"/v2/api-reference/loyalty/inquire/get-redeemable-points"},{"openapi":"member get /v1/inquire/all-points-expiry/{profileId}","title":"Get Expired Points","href":"/v2/api-reference/loyalty/inquire/get-expired-points"},{"openapi":"member get /v1/inquire/point-type-choices","title":"Get Point Types","href":"/v2/api-reference/loyalty/inquire/get-point-types"},{"openapi":"member get /v1/inquire/get_action_reasons","title":"Get Action Reasons","href":"/v2/api-reference/loyalty/inquire/get-action-reasons"},{"openapi":"member get /v1/inquire/{profileId}/member-points","title":"Get Member Points","href":"/v2/api-reference/loyalty/inquire/get-member-points"},{"openapi":"member get /v1/inquire/points-expiry","title":"Get Points to be Expired","href":"/v2/api-reference/loyalty/inquire/get-points-to-be-expired"}]},{"group":"Discounts","pages":[{"openapi":"member post /v1/discounts","title":"Get Discounts","href":"/v2/api-reference/loyalty/discounts/get-discounts"}]},{"group":"Redeem","pages":[{"openapi":"member get /v1/redeem","title":"Rewards History","href":"/v2/api-reference/loyalty/redeem/rewards-history"},{"openapi":"member post /v1/redeem/reward/issue","title":"Issue Reward","href":"/v2/api-reference/loyalty/redeem/issue-reward"},{"openapi":"member post /v1/redeem/member-reward","title":"Redeem Rewards","href":"/v2/api-reference/loyalty/redeem/redeem-rewards"},{"openapi":"member post /v1/redeem/cancel","title":"Cancel Rewards","href":"/v2/api-reference/loyalty/redeem/cancel-rewards"},{"openapi":"member post /v1/redeem/reverse","title":"Reverse Redeemed Rewards","href":"/v2/api-reference/loyalty/redeem/reverse-redeemed-rewards"}]},{"group":"Earn","pages":[{"openapi":"member post /v2/earn","title":"Earn Points","href":"/v2/api-reference/loyalty/earn/earn-points"},{"openapi":"member post /v2/earn/reverse","title":"Reverse Earned Points","href":"/v2/api-reference/loyalty/earn/reverse-earned-points"},{"openapi":"member get /v2/earn/get-transaction","title":"Get Transactions","href":"/v2/api-reference/loyalty/earn/get-transactions"}]},{"group":"Members","pages":[{"openapi":"member put /v1/members","title":"Update Member","href":"/v2/api-reference/loyalty/members/update-member"},{"openapi":"member get /v1/members","title":"Get Members","href":"/v2/api-reference/loyalty/members/get-members"},{"openapi":"member post /v1/members","title":"Enroll Member","href":"/v2/api-reference/loyalty/members/enroll-member"},{"openapi":"member post /v1/members/points-activate","title":"Activate Points","href":"/v2/api-reference/loyalty/members/activate-points"},{"openapi":"member post /v1/members/points-adjustment","title":"Adjust Points","href":"/v2/api-reference/loyalty/members/adjust-points"}]}]},{"group":"Dropship","pages":[{"title":"Dropship API","href":"/v2/api-reference/dropship/dropship-api"},{"group":"Shipments","pages":[{"openapi":"marketplace get /v1/retailers/{retailer_pk}/shipments/{id}/","title":"Get details of a single shipment.","href":"/v2/api-reference/dropship/shipments/get-details-of-a-single-shipment"},{"openapi":"marketplace get /v1/retailers/{retailer_pk}/shipments/","title":"List fulfillments or shipments from vendors","href":"/v2/api-reference/dropship/shipments/list-fulfillments-or-shipments-from-vendors"},{"openapi":"marketplace put /v1/retailers/{retailer_pk}/shipments/{id}/acknowledge/","title":"Acknowledge shipment receipt","href":"/v2/api-reference/dropship/shipments/acknowledge-shipment-receipt"}]},{"group":"Products","pages":[{"openapi":"marketplace get /v1/retailers/{retailer_pk}/permits/{id}/","title":"Get active permits","href":"/v2/api-reference/dropship/products/get-active-permits"},{"openapi":"marketplace get /v1/retailers/{retailer_pk}/variants/{id}/","title":"Get details of a single variant","href":"/v2/api-reference/dropship/products/get-details-of-a-single-variant"},{"openapi":"marketplace get /v1/retailers/{retailer_pk}/products/","title":"List products","href":"/v2/api-reference/dropship/products/list-products"},{"openapi":"marketplace patch /v1/retailers/{retailer_pk}/variants/{id}/","title":"Update attributes of a variant","href":"/v2/api-reference/dropship/products/update-attributes-of-a-variant"},{"openapi":"marketplace get /v1/retailers/{retailer_pk}/variants/","title":"Get variants","href":"/v2/api-reference/dropship/products/get-variants"},{"openapi":"marketplace put /v1/retailers/{retailer_pk}/permits/{id}/acknowledge/","title":"Acknowledge receipt of a new permit","href":"/v2/api-reference/dropship/products/acknowledge-receipt-of-a-new-permit"},{"openapi":"marketplace get /v1/retailers/{retailer_pk}/products/{id}/","title":"Get single product details","href":"/v2/api-reference/dropship/products/get-single-product-details"}]},{"group":"Invoices","pages":[{"openapi":"marketplace put /v1/retailers/{retailer_pk}/invoices/{id}/acknowledge/","title":"Acknowledge receipt of an invoice.","href":"/v2/api-reference/dropship/invoices/acknowledge-receipt-of-an-invoice"},{"openapi":"marketplace get /v1/retailers/{retailer_pk}/invoices/","title":"List invocies from vendors","href":"/v2/api-reference/dropship/invoices/list-invocies-from-vendors"},{"openapi":"marketplace get /v1/retailers/{retailer_pk}/invoices/{id}/","title":"Get details of a single invoice","href":"/v2/api-reference/dropship/invoices/get-details-of-a-single-invoice"}]},{"group":"Connections","pages":[{"openapi":"marketplace get /v1/retailers/{retailer_pk}/connections/","title":"Get vendor connections","href":"/v2/api-reference/dropship/connections/get-vendor-connections"},{"openapi":"marketplace get /v1/retailers/{retailer_pk}/connections/{id}/","title":"Get connections of a single vendor","href":"/v2/api-reference/dropship/connections/get-connections-of-a-single-vendor"}]},{"group":"Inventory","pages":[{"openapi":"marketplace get /v1/retailers/{retailer_pk}/inventory/{id}/","title":"Get inventory of a single variant","href":"/v2/api-reference/dropship/inventory/get-inventory-of-a-single-variant"},{"openapi":"marketplace get /v1/retailers/{retailer_pk}/inventory/","title":"Get a list of variant inventory positions","href":"/v2/api-reference/dropship/inventory/get-a-list-of-variant-inventory-positions"}]},{"group":"Returns","pages":[{"openapi":"marketplace get /v1/retailers/{retailer_pk}/rmas/","title":"Get a list of returns","href":"/v2/api-reference/dropship/returns/get-a-list-of-returns"},{"openapi":"marketplace post /v1/retailers/{retailer_pk}/rmas/","title":"Register a pending return for a vendor","href":"/v2/api-reference/dropship/returns/register-a-pending-return-for-a-vendor"},{"openapi":"marketplace get /v1/retailers/{retailer_pk}/rmas/{id}/","title":"Get details of a return.","href":"/v2/api-reference/dropship/returns/get-details-of-a-return"},{"openapi":"marketplace put /v1/retailers/{retailer_pk}/rmas/{id}/acknowledge/","title":"Acknowledge return","href":"/v2/api-reference/dropship/returns/acknowledge-return"}]},{"group":"Orders","pages":[{"openapi":"marketplace post /v1/retailers/{retailer_pk}/orders/","title":"Create a new order (for a single vendor)","href":"/v2/api-reference/dropship/orders/create-a-new-order-for-a-single-vendor"},{"openapi":"marketplace get /v1/retailers/{retailer_pk}/orders/","title":"Get orders","href":"/v2/api-reference/dropship/orders/get-orders"},{"openapi":"marketplace post /v1/retailers/{retailer_pk}/sales-orders/","title":"Create a new order (mixed vendors)","href":"/v2/api-reference/dropship/orders/create-a-new-order-mixed-vendors"},{"openapi":"marketplace get /v1/retailers/{retailer_pk}/orders/{id}/","title":"Get single order details","href":"/v2/api-reference/dropship/orders/get-single-order-details"}]}]},{"group":"Cart API","pages":[{"title":"Cart","href":"/v2/api-reference/cart-api/cart"},{"group":"Order Draft","pages":[{"openapi":"cart-service get /v2/order-drafts/order-number/{orderNumber}","title":"Get order draft by order number","href":"/v2/api-reference/cart-api/order-draft/get-order-draft-by-order-number"},{"openapi":"cart-service get /v2/order-drafts/{id}","title":"Get order draft by ID","href":"/v2/api-reference/cart-api/order-draft/get-order-draft-by-id"},{"openapi":"cart-service post /v2/carts/{cartId}/order-drafts","title":"Create order draft","href":"/v2/api-reference/cart-api/order-draft/create-order-draft"},{"openapi":"cart-service get /v2/order-drafts","title":"Get all order drafts by filter parameters","href":"/v2/api-reference/cart-api/order-draft/get-all-order-drafts-by-filter-parameters"}]},{"group":"Attribute","pages":[{"title":"Attribute","sidebarTitle":"Overview","href":"/v2/api-reference/cart-api/attribute/overview"},{"openapi":"cart-service delete /v2/carts/{cartId}/attributes/{attributeId}","title":"Delete specific cart attribute","href":"/v2/api-reference/cart-api/attribute/delete-specific-cart-attribute"},{"openapi":"cart-service patch /v2/carts/{cartId}/item/attribute","title":"Add or update specific item attribute","href":"/v2/api-reference/cart-api/attribute/add-or-update-specific-item-attribute"},{"openapi":"cart-service delete /v2/carts/{cartId}/attributes/fees","title":"Delete specific cart fee","href":"/v2/api-reference/cart-api/attribute/delete-specific-cart-fee"},{"openapi":"cart-service patch /v2/carts/{cartId}/attributes","title":"Add or update cart attributes","href":"/v2/api-reference/cart-api/attribute/add-or-update-cart-attributes"},{"openapi":"cart-service delete /v2/carts/{cartId}/item/attribute/fees/{lineItemId}","title":"Delete item fees","href":"/v2/api-reference/cart-api/attribute/delete-item-fees"},{"openapi":"cart-service delete /v2/carts/{cartId}/item/attribute/{attributeId}/{lineItemId}","title":"Delete a specific item attribute","href":"/v2/api-reference/cart-api/attribute/delete-a-specific-item-attribute"},{"openapi":"cart-service patch /v2/carts/{cartId}/item/{lineItemId}/attribute","title":"Add or update item attributes and fees","href":"/v2/api-reference/cart-api/attribute/add-or-update-item-attributes-and-fees"}]},{"group":"Adjustments","pages":[{"title":"Adjustments","sidebarTitle":"Overview","href":"/v2/api-reference/cart-api/adjustments/overview"},{"openapi":"cart-service post /v2/carts/{cartId}/items/{lineItemId}/adjustments","title":"Adjust prices for a cart item","href":"/v2/api-reference/cart-api/adjustments/adjust-prices-for-a-cart-item"},{"openapi":"cart-service put /v2/carts/{cartId}/adjustments/{adjustmentId}","title":"Update a specific price adjustment information for a given cart","href":"/v2/api-reference/cart-api/adjustments/update-a-specific-price-adjustment-information-for-a-given-cart"},{"openapi":"cart-service post /v2/carts/{cartId}/adjustments","title":"Adjust prices for a specific cart","href":"/v2/api-reference/cart-api/adjustments/adjust-prices-for-a-specific-cart"},{"openapi":"cart-service delete /v2/carts/{cartId}/items/{lineItemId}/adjustments/{adjustmentId}","title":"Delete a specific price adjustment information for a cart item","href":"/v2/api-reference/cart-api/adjustments/delete-a-specific-price-adjustment-information-for-a-cart-item"},{"openapi":"cart-service get /v2/carts/{cartId}/adjustments","title":"Get all price adjustment details for a specific cart","href":"/v2/api-reference/cart-api/adjustments/get-all-price-adjustment-details-for-a-specific-cart"},{"openapi":"cart-service put /v2/carts/{cartId}/items/{lineItemId}/adjustments/{adjustmentId}","title":"Update a specific price adjustment information for a cart item","href":"/v2/api-reference/cart-api/adjustments/update-a-specific-price-adjustment-information-for-a-cart-item"},{"openapi":"cart-service get /v2/carts/{cartId}/items/{lineItemId}/adjustments","title":"Get all price adjustments for a cart item","href":"/v2/api-reference/cart-api/adjustments/get-all-price-adjustments-for-a-cart-item"},{"openapi":"cart-service delete /v2/carts/{cartId}/adjustments/{adjustmentId}","title":"Delete a specific price adjustment information from a given cart","href":"/v2/api-reference/cart-api/adjustments/delete-a-specific-price-adjustment-information-from-a-given-cart"}]},{"group":"Shipping","pages":[{"title":"Shipping","sidebarTitle":"Overview","href":"/v2/api-reference/cart-api/shipping/overview"},{"openapi":"cart-service get /v2/carts/{cartId}/shipping-details/{shippingDetailsId}","title":"Get specific shipping details for a specific cart","href":"/v2/api-reference/cart-api/shipping/get-specific-shipping-details-for-a-specific-cart"},{"openapi":"cart-service post /v2/carts/{cartId}/shipping-details","title":"Create shipping details for all items specific cart","href":"/v2/api-reference/cart-api/shipping/create-shipping-details-for-all-items-specific-cart"},{"openapi":"cart-service delete /v2/carts/{cartId}/items/shipping-details","title":"Remove `shippingDetailsId` from cart items","href":"/v2/api-reference/cart-api/shipping/remove-`shippingdetailsid`-from-cart-items"},{"openapi":"cart-service patch /v2/carts/{cartId}/items/shipping-details","title":"Create shipping details for specific items in specific cart","href":"/v2/api-reference/cart-api/shipping/create-shipping-details-for-specific-items-in-specific-cart"},{"openapi":"cart-service patch /v2/carts/{cartId}/shipping-details","title":"Update shipping details for all items in a specific cart","href":"/v2/api-reference/cart-api/shipping/update-shipping-details-for-all-items-in-a-specific-cart"}]},{"group":"Cart","pages":[{"title":"Cart","sidebarTitle":"Overview","href":"/v2/api-reference/cart-api/cart/overview"},{"openapi":"cart-service patch /v2/carts/{cartId}/items","title":"Update items in specific cart","href":"/v2/api-reference/cart-api/cart/update-items-in-specific-cart"},{"openapi":"cart-service get /v2/carts","title":"Get all carts","href":"/v2/api-reference/cart-api/cart/get-all-carts"},{"openapi":"cart-service post /v2/carts/search","title":"Search for carts","href":"/v2/api-reference/cart-api/cart/search-for-carts"},{"openapi":"cart-service delete /v2/carts/{cartId}/items/{lineItemId}","title":"Remove an item from the cart","href":"/v2/api-reference/cart-api/cart/remove-an-item-from-the-cart"},{"openapi":"cart-service post /v2/carts/{cartId}/lineItems/actions/split","title":"Split the cart item by quantity","href":"/v2/api-reference/cart-api/cart/split-the-cart-item-by-quantity"},{"openapi":"cart-service get /v2/carts/{cartId}","title":"Get specific cart","href":"/v2/api-reference/cart-api/cart/get-specific-cart"},{"openapi":"cart-service delete /v2/carts/{cartId}/promo/{promoCode}","title":"Remove an individual promotion from all items in a specific cart","href":"/v2/api-reference/cart-api/cart/remove-an-individual-promotion-from-all-items-in-a-specific-cart"},{"openapi":"cart-service post /v2/carts","title":"Create an empty cart","href":"/v2/api-reference/cart-api/cart/create-an-empty-cart"},{"openapi":"cart-service put /v2/carts/{cartId}/customer","title":"Replaces customer context in cart","href":"/v2/api-reference/cart-api/cart/replaces-customer-context-in-cart"},{"openapi":"cart-service delete /v2/carts/{cartId}","title":"Delete cart items","href":"/v2/api-reference/cart-api/cart/delete-cart-items"},{"openapi":"cart-service patch /v2/carts/{cartId}/status/{cartStatus}","title":"Update status of specific cart","href":"/v2/api-reference/cart-api/cart/update-status-of-specific-cart"},{"openapi":"cart-service patch /v2/carts/{cartId}/merge","title":"Merge carts","href":"/v2/api-reference/cart-api/cart/merge-carts-1"},{"openapi":"cart-service post /v2/carts/{cartId}/soft-reserve","title":"Soft reserve cart items","href":"/v2/api-reference/cart-api/cart/soft-reserve-cart-items"},{"openapi":"cart-service delete /v2/carts/{cartId}/items","title":"Delete items from specific cart","href":"/v2/api-reference/cart-api/cart/delete-items-from-specific-cart"},{"openapi":"cart-service post /v2/carts/items","title":"Add items to cart","href":"/v2/api-reference/cart-api/cart/add-items-to-cart"},{"openapi":"cart-service post /v2/carts/{cartId}/promos/{promoCode}","title":"Apply a specific promotion to all items in a specific cart","href":"/v2/api-reference/cart-api/cart/apply-a-specific-promotion-to-all-items-in-a-specific-cart"},{"openapi":"cart-service put /v2/carts/{cartId}/merge","title":"Merge Carts","href":"/v2/api-reference/cart-api/cart/merge-carts"}]}]},{"group":"Checkout API","pages":[{"title":"Checkout","href":"/v2/api-reference/checkout-api/checkout"},{"group":"Checkout","pages":[{"title":"Checkout","sidebarTitle":"Overview","href":"/v2/api-reference/checkout-api/checkout/overview"},{"openapi":"checkout post /v2/checkout","title":"Create checkout","href":"/v2/api-reference/checkout-api/checkout/create-checkout"}]}]},{"group":"Customer","pages":[{"title":"Core Concepts","href":"/v2/api-reference/customer/core-concepts"},{"title":"Customer Service","href":"/v2/api-reference/customer/customer-service"},{"group":"Organization","pages":[{"openapi":"customer-openapi get /v1/organizations/{organizationId}","title":null,"href":"/v2/api-reference/customer/organization/get-organization"},{"openapi":"customer-openapi post /v1/organizations","title":null,"href":"/v2/api-reference/customer/organization/create-organization"},{"openapi":"customer-openapi get /v1/organizations","title":null,"href":"/v2/api-reference/customer/organization/list-organizations"},{"openapi":"customer-openapi put /v1/organizations/{organizationId}","title":null,"href":"/v2/api-reference/customer/organization/update-organization"},{"openapi":"customer-openapi post /v1/organizations/{organizationId}/resurrect","title":null,"href":"/v2/api-reference/customer/organization/resurrect-organization"},{"openapi":"customer-openapi delete /v1/organizations/{organizationId}","title":null,"href":"/v2/api-reference/customer/organization/delete-organization"}]},{"group":"User Party","pages":[{"openapi":"customer-openapi get /v1/user-party/user/{userId}/party/{parentPartyId}","title":null,"href":"/v2/api-reference/customer/user-party/get-party-by-user-and-parent-party"},{"openapi":"customer-openapi get /v1/user-party/user/{userId}","title":null,"href":"/v2/api-reference/customer/user-party/list-parties-by-user"},{"openapi":"customer-openapi delete /v1/user-party","title":null,"href":"/v2/api-reference/customer/user-party/unlink-user-from-party"},{"openapi":"customer-openapi get /v1/user-party/party/{partyId}","title":null,"href":"/v2/api-reference/customer/user-party/list-users-in-party"},{"openapi":"customer-openapi post /v1/user-party","title":null,"href":"/v2/api-reference/customer/user-party/link-user-to-party"}]},{"group":"Organization Group Addresses","pages":[{"title":"Organization Group Addresses","sidebarTitle":"Overview","href":"/v2/api-reference/customer/organization-group-addresses/overview"},{"openapi":"customer-openapi get /v1/organizations/{organizationId}/groups/{groupId}/addresses","title":null,"href":"/v2/api-reference/customer/organization-group-addresses/list-orgaization-group-addresses"}]},{"group":"User Internal Party","pages":[{"title":"User Internal Party","sidebarTitle":"Overview","href":"/v2/api-reference/customer/user-internal-party/overview"},{"openapi":"customer-openapi post /v1/user-internal-organization","title":null,"href":"/v2/api-reference/customer/user-internal-party/link-user-and-internal-party"},{"openapi":"customer-openapi delete /v1/user-internal-organization","title":null,"href":"/v2/api-reference/customer/user-internal-party/unlink-user-intenal-party"},{"openapi":"customer-openapi get /v1/user-internal-organization/user/{userId}/internal-organizations","title":null,"href":"/v2/api-reference/customer/user-internal-party/list-internal-parties-by-user"},{"openapi":"customer-openapi get /v1/user-internal-organization/internalparty/{internalPartyId}/users","title":null,"href":"/v2/api-reference/customer/user-internal-party/list-users-by-internal-party"}]},{"group":"Organization Contracts","pages":[{"title":"Organization Contracts","sidebarTitle":"Overview","href":"/v2/api-reference/customer/organization-contracts/overview"},{"openapi":"customer-openapi delete /v1/organizations/{organizationId}/contracts/{contractId}","title":null,"href":"/v2/api-reference/customer/organization-contracts/delete-organization-contract"},{"openapi":"customer-openapi put /v1/organizations/{organizationId}/contracts/{contractId}","title":null,"href":"/v2/api-reference/customer/organization-contracts/update-organization-contract"},{"openapi":"customer-openapi get /v1/organizations/{organizationId}/contracts","title":null,"href":"/v2/api-reference/customer/organization-contracts/list-organization-contracts"},{"openapi":"customer-openapi post /v1/organizations/{organizationId}/contracts","title":null,"href":"/v2/api-reference/customer/organization-contracts/create-organization-contract"},{"openapi":"customer-openapi post /v1/organizations/{organizationId}/contracts/{contractId}/resurrect","title":null,"href":"/v2/api-reference/customer/organization-contracts/resurrect-organization-contract"},{"openapi":"customer-openapi get /v1/organizations/{organizationId}/contracts/{contractId}","title":null,"href":"/v2/api-reference/customer/organization-contracts/get-organization-contract"}]},{"group":"Party","pages":[{"title":"Party","sidebarTitle":"Overview","href":"/v2/api-reference/customer/party/overview"},{"openapi":"customer-openapi delete /v1/parties/{partyId}","title":null,"href":"/v2/api-reference/customer/party/delete-party"},{"openapi":"customer-openapi patch /v1/parties/{partyId}","title":null,"href":"/v2/api-reference/customer/party/update-party"},{"openapi":"customer-openapi get /v1/parties/{globalCustomerId}/{partyType}","title":null,"href":"/v2/api-reference/customer/party/get-party-with-type"},{"openapi":"customer-openapi post /v1/parties","title":null,"href":"/v2/api-reference/customer/party/create-party"},{"openapi":"customer-openapi get /v1/parties","title":null,"href":"/v2/api-reference/customer/party/list-parties"},{"openapi":"customer-openapi get /v1/parties/{partyId}","title":null,"href":"/v2/api-reference/customer/party/get-party"}]},{"group":"Party Contracts","pages":[{"openapi":"customer-openapi get /v1/contracts/contract/{contractId}","title":null,"href":"/v2/api-reference/customer/party-contracts/list-parties-by-contract"},{"openapi":"customer-openapi get /v1/contracts/party/{partyId}","title":null,"href":"/v2/api-reference/customer/party-contracts/list-contracts-by-party"}]},{"group":"Contracts","pages":[{"title":"Contracts","sidebarTitle":"Overview","href":"/v2/api-reference/customer/contracts/overview"},{"openapi":"customer-openapi put /v1/upload/contracts","title":null,"href":"/v2/api-reference/customer/contracts/use-pre-signed-url-to-upload-a-contract"},{"openapi":"customer-openapi post /v1/upload/contracts","title":null,"href":"/v2/api-reference/customer/contracts/bulk-upload-contract"},{"openapi":"customer-openapi get /v1/contracts","title":null,"href":"/v2/api-reference/customer/contracts/list-contracts"},{"openapi":"customer-openapi post /v1/contracts/{contractId}/resurrect","title":null,"href":"/v2/api-reference/customer/contracts/resurrect-contract"},{"openapi":"customer-openapi post /v1/contracts","title":null,"href":"/v2/api-reference/customer/contracts/create-contract"},{"openapi":"customer-openapi patch /v1/contracts/{contractId}","title":null,"href":"/v2/api-reference/customer/contracts/update-contract"},{"openapi":"customer-openapi get /v1/contracts/{contractId}","title":null,"href":"/v2/api-reference/customer/contracts/get-contract"},{"openapi":"customer-openapi delete /v1/contracts/{contractId}","title":null,"href":"/v2/api-reference/customer/contracts/delete-contract"}]},{"group":"User","pages":[{"title":"User","sidebarTitle":"Overview","href":"/v2/api-reference/customer/user/overview"},{"openapi":"customer-openapi post /v1/upload/users","title":null,"href":"/v2/api-reference/customer/user/bulk-upload-user"},{"openapi":"customer-openapi get /v1/users","title":null,"href":"/v2/api-reference/customer/user/list-users"},{"openapi":"customer-openapi patch /v1/users/{userId}","title":null,"href":"/v2/api-reference/customer/user/update-user"},{"openapi":"customer-openapi get /v1/users/{userId}","title":null,"href":"/v2/api-reference/customer/user/get-user"},{"openapi":"customer-openapi put /v1/upload/users","title":null,"href":"/v2/api-reference/customer/user/use-pre-signed-url-to-upload-a-user"},{"openapi":"customer-openapi delete /v1/users/{userId}","title":null,"href":"/v2/api-reference/customer/user/delete-user"},{"openapi":"customer-openapi post /v1/users","title":null,"href":"/v2/api-reference/customer/user/create-user"}]},{"group":"Search","pages":[{"title":"Search","sidebarTitle":"Overview","href":"/v2/api-reference/customer/search/overview"},{"openapi":"customer-openapi post /v1/search/party","title":null,"href":"/v2/api-reference/customer/search/search-party"},{"openapi":"customer-openapi post /v1/search/user","title":null,"href":"/v2/api-reference/customer/search/search-user"}]},{"group":"User Trait","pages":[{"title":"User Trait","sidebarTitle":"Overview","href":"/v2/api-reference/customer/user-trait/overview"},{"openapi":"customer-openapi post /v1/user-trait/bulkDelete","title":null,"href":"/v2/api-reference/customer/user-trait/bulk-delete-user-trait"},{"openapi":"customer-openapi post /v1/user-trait/bulk","title":null,"href":"/v2/api-reference/customer/user-trait/bulk-create-user-trait"}]},{"group":"Organization Users","pages":[{"title":"Organization Users","href":"/v2/api-reference/customer/organization-users/overview"},{"openapi":"customer-openapi get /v1/organizations/{organizationId}/users","title":null,"href":"/v2/api-reference/customer/organization-users/list-organizations-users"},{"openapi":"customer-openapi delete /v1/organizations/{organizationId}/users/{userId}","title":null,"href":"/v2/api-reference/customer/organization-users/delete-organization-user"},{"openapi":"customer-openapi get /v1/organizations/{organizationId}/users/{userId}","title":null,"href":"/v2/api-reference/customer/organization-users/get-organization-user"},{"openapi":"customer-openapi post /v1/organizations/{organizationId}/users","title":null,"href":"/v2/api-reference/customer/organization-users/create-organization-user"},{"openapi":"customer-openapi put /v1/organizations/{organizationId}/users/{userId}","title":null,"href":"/v2/api-reference/customer/organization-users/update-organization-user"}]},{"group":"Address","pages":[{"title":"Address","sidebarTitle":"Overview","href":"/v2/api-reference/customer/address/overview"},{"openapi":"customer-openapi get /v1/addresses","title":null,"href":"/v2/api-reference/customer/address/list-addresses"},{"openapi":"customer-openapi get /v1/addresses/{addressId}","title":null,"href":"/v2/api-reference/customer/address/get-address"},{"openapi":"customer-openapi post /v1/addresses","title":null,"href":"/v2/api-reference/customer/address/create-address"},{"openapi":"customer-openapi delete /v1/addresses/{addressId}","title":null,"href":"/v2/api-reference/customer/address/delete-address"},{"openapi":"customer-openapi patch /v1/addresses/{addressId}","title":null,"href":"/v2/api-reference/customer/address/update-address"}]},{"group":"User Address","pages":[{"title":"User Address","sidebarTitle":"Overview","href":"/v2/api-reference/customer/user-address/overview"},{"openapi":"customer-openapi delete /v1/user-addresses","title":null,"href":"/v2/api-reference/customer/user-address/delete-user-address"},{"openapi":"customer-openapi post /v1/user-addresses","title":null,"href":"/v2/api-reference/customer/user-address/create-user-address"},{"openapi":"customer-openapi get /v1/user-addresses/user/{userId}","title":null,"href":"/v2/api-reference/customer/user-address/list-addresses-for-single-user"}]},{"group":"Trait","pages":[{"title":"Trait","sidebarTitle":"Overview","href":"/v2/api-reference/customer/trait/overview"},{"openapi":"customer-openapi patch /v1/trait/{traitId}","title":null,"href":"/v2/api-reference/customer/trait/update-trait"},{"openapi":"customer-openapi get /v1/trait","title":null,"href":"/v2/api-reference/customer/trait/list-traits"},{"openapi":"customer-openapi post /v1/trait","title":null,"href":"/v2/api-reference/customer/trait/create-trait"},{"openapi":"customer-openapi delete /v1/trait/{traitId}","title":null,"href":"/v2/api-reference/customer/trait/delete-trait"}]},{"group":"Party Address","pages":[{"title":"Party Address","sidebarTitle":"Overview","href":"/v2/api-reference/customer/party-address/overview"},{"openapi":"customer-openapi get /v1/party-addresses/{partyAddressId}","title":null,"href":"/v2/api-reference/customer/party-address/get-party-address"},{"openapi":"customer-openapi post /v1/party-addresses","title":null,"href":"/v2/api-reference/customer/party-address/link-party-and-address"},{"openapi":"customer-openapi get /v1/party-addresses","title":null,"href":"/v2/api-reference/customer/party-address/list-party-addresses"}]},{"group":"Party Trait","pages":[{"title":"Party Trait","sidebarTitle":"Overview","href":"/v2/api-reference/customer/party-trait/overview"},{"openapi":"customer-openapi get /v1/party-trait/getTraits","title":null,"href":"/v2/api-reference/customer/party-trait/get-traits-for-a-party"},{"openapi":"customer-openapi post /v1/party-trait/bulk","title":null,"href":"/v2/api-reference/customer/party-trait/bulk-create-party-trait"},{"openapi":"customer-openapi get /v1/party-trait/getParties","title":null,"href":"/v2/api-reference/customer/party-trait/get-parties-for-a-trait"},{"openapi":"customer-openapi post /v1/party-trait/bulkDelete","title":null,"href":"/v2/api-reference/customer/party-trait/bulk-delete-party-traits"},{"openapi":"customer-openapi post /v1/party-trait/partyTrait","title":null,"href":"/v2/api-reference/customer/party-trait/create-party-trait"},{"openapi":"customer-openapi delete /v1/party-trait/partyTrait","title":null,"href":"/v2/api-reference/customer/party-trait/delete-party-trait"}]},{"group":"Organization Group Users","pages":[{"title":"Organization Group Users","sidebarTitle":"Overview","href":"/v2/api-reference/customer/organization-group-users/overview"},{"openapi":"customer-openapi get /v1/organizations/{organizationId}/groups/{groupId}/users","title":null,"href":"/v2/api-reference/customer/organization-group-users/list-organization-group-users"}]},{"group":"Internal Party","pages":[{"title":"Internal Party","sidebarTitle":"Overview","href":"/v2/api-reference/customer/internal-party/overview"},{"openapi":"customer-openapi delete /v1/internal-parties/{internalPartyId}","title":null,"href":"/v2/api-reference/customer/internal-party/delete-internal-party"},{"openapi":"customer-openapi post /v1/internal-parties","title":null,"href":"/v2/api-reference/customer/internal-party/create-internal-party"},{"openapi":"customer-openapi get /v1/internal-parties","title":null,"href":"/v2/api-reference/customer/internal-party/list-internal-parties"},{"openapi":"customer-openapi post /v1/internal-parties/{internalPartyId}/resurrect","title":null,"href":"/v2/api-reference/customer/internal-party/resurrect-internal-party"},{"openapi":"customer-openapi get /v1/internal-parties/{internalPartyId}","title":null,"href":"/v2/api-reference/customer/internal-party/get-internal-party"},{"openapi":"customer-openapi put /v1/internal-parties/{internalPartyId}","title":null,"href":"/v2/api-reference/customer/internal-party/update-internal-party"}]},{"group":"Contract Pricelist","pages":[{"openapi":"customer-openapi patch /v1/contracts/price-list/bulkUpdate","title":null,"href":"/v2/api-reference/customer/contract-pricelist/bulk-update-contract-pricelist"}]},{"group":"Internal Parties Party","pages":[{"title":"Internal Parties Only","sidebarTitle":"Overview","href":"/v2/api-reference/customer/internal-parties-party/overview"},{"openapi":"customer-openapi delete /v1/internalParties-party/create","title":null,"href":"/v2/api-reference/customer/internal-parties-party/remove-association-between-internal-party-and-party"},{"openapi":"customer-openapi post /v1/internalParties-party/create","title":null,"href":"/v2/api-reference/customer/internal-parties-party/create-association-between-internal-party-and-party"}]},{"group":"Account","pages":[{"title":"Account","sidebarTitle":"Overview","href":"/v2/api-reference/customer/account/overview"},{"openapi":"customer-openapi get /v1/accounts","title":null,"href":"/v2/api-reference/customer/account/list-accounts"},{"openapi":"customer-openapi get /v1/accounts/{accountId}/children","title":null,"href":"/v2/api-reference/customer/account/get-accounts-children"},{"openapi":"customer-openapi get /v1/accounts/{accountId}","title":null,"href":"/v2/api-reference/customer/account/get-account"},{"openapi":"customer-openapi post /v1/accounts","title":null,"href":"/v2/api-reference/customer/account/create-account"},{"openapi":"customer-openapi delete /v1/accounts/{accountId}","title":null,"href":"/v2/api-reference/customer/account/delete-account"},{"openapi":"customer-openapi patch /v1/accounts/{accountId}","title":null,"href":"/v2/api-reference/customer/account/update-account"}]},{"group":"Party Account","pages":[{"title":"Party Account","sidebarTitle":"Overview","href":"/v2/api-reference/customer/party-account/overview"},{"openapi":"customer-openapi get /v1/party-accounts/party/{partyId}","title":null,"href":"/v2/api-reference/customer/party-account/list-accounts-by-party"},{"openapi":"customer-openapi post /v1/party-accounts","title":null,"href":"/v2/api-reference/customer/party-account/link-party-and-account"},{"openapi":"customer-openapi delete /v1/party-accounts","title":null,"href":"/v2/api-reference/customer/party-account/delete-party-account"},{"openapi":"customer-openapi get /v1/party-accounts/account/{accountId}","title":null,"href":"/v2/api-reference/customer/party-account/list-parties-by-account"}]},{"group":"Organization Addresses","pages":[{"title":"Organization Addresses","sidebarTitle":"Overview","href":"/v2/api-reference/customer/organization-addresses/overview"},{"openapi":"customer-openapi put /v1/organizations/{organizationId}/addresses/{addressId}","title":null,"href":"/v2/api-reference/customer/organization-addresses/update-organization-address"},{"openapi":"customer-openapi get /v1/organizations/{organizationId}/addresses","title":null,"href":"/v2/api-reference/customer/organization-addresses/list-organization-addresses"},{"openapi":"customer-openapi delete /v1/organizations/{organizationId}/addresses/{addressId}","title":null,"href":"/v2/api-reference/customer/organization-addresses/delete-organization-address"},{"openapi":"customer-openapi post /v1/organizations/{organizationId}/addresses","title":null,"href":"/v2/api-reference/customer/organization-addresses/create-organization-address"},{"openapi":"customer-openapi get /v1/organizations/{organizationId}/addresses/{addressId}","title":null,"href":"/v2/api-reference/customer/organization-addresses/get-organization-address"}]},{"group":"Organization Groups","pages":[{"title":"Organization Groups","href":"/v2/api-reference/customer/organization-groups/overview"},{"openapi":"customer-openapi post /v1/organizations/{organizationId}/groups","title":null,"href":"/v2/api-reference/customer/organization-groups/create-organization-group"},{"openapi":"customer-openapi put /v1/organizations/{organizationId}/groups/{groupId}","title":null,"href":"/v2/api-reference/customer/organization-groups/updates-organization-group"},{"openapi":"customer-openapi delete /v1/organizations/{organizationId}/groups/{groupId}","title":null,"href":"/v2/api-reference/customer/organization-groups/delete-orgaization-group"},{"openapi":"customer-openapi get /v1/organizations/{organizationId}/groups/{groupId}","title":null,"href":"/v2/api-reference/customer/organization-groups/get-orgaization-group"},{"openapi":"customer-openapi get /v1/organizations/{organizationId}/groups","title":null,"href":"/v2/api-reference/customer/organization-groups/list-organizations-groups"}]},{"group":"Individual Addresses","pages":[{"title":"Individual Addresses","sidebarTitle":"Overview","href":"/v2/api-reference/customer/individual-addresses/overview"},{"openapi":"customer-openapi put /v1/individuals/{individualId}/addresses/{addressId}","title":null,"href":"/v2/api-reference/customer/individual-addresses/update-individuals-address"},{"openapi":"customer-openapi get /v1/individuals/{individualId}/addresses/{addressId}","title":null,"href":"/v2/api-reference/customer/individual-addresses/get-indivudals-address"},{"openapi":"customer-openapi get /v1/individuals/{individualId}/addresses","title":null,"href":"/v2/api-reference/customer/individual-addresses/list-individuals-addresses"},{"openapi":"customer-openapi post /v1/individuals/{individualId}/addresses","title":null,"href":"/v2/api-reference/customer/individual-addresses/create-individuals-address"},{"openapi":"customer-openapi delete /v1/individuals/{individualId}/addresses/{addressId}","title":null,"href":"/v2/api-reference/customer/individual-addresses/delete-individuals-address"}]},{"group":"Users Organization","pages":[{"openapi":"customer-openapi get /v1/users/{userId}/organizations","title":null,"href":"/v2/api-reference/customer/users--organization/get-all-organizations-for-a-single-user"}]},{"group":"Individual","pages":[{"title":"Individual","sidebarTitle":"Overview","href":"/v2/api-reference/customer/individual/overview"},{"openapi":"customer-openapi put /v1/individuals/{individualId}","title":null,"href":"/v2/api-reference/customer/individual/update-individual"},{"openapi":"customer-openapi get /v1/individuals","title":null,"href":"/v2/api-reference/customer/individual/list-individuals"},{"openapi":"customer-openapi post /v1/individuals","title":null,"href":"/v2/api-reference/customer/individual/create-individual"},{"openapi":"customer-openapi delete /v1/individuals/{individualId}","title":null,"href":"/v2/api-reference/customer/individual/delete-individual-customer"},{"openapi":"customer-openapi get /v1/individuals/{individualId}","title":null,"href":"/v2/api-reference/customer/individual/get-individual-customer"}]}]}]},{"tab":"Recipes","pages":[{"title":"Recipes","href":"/v2/recipes/sample"}]}]}]},"title":"Stop a promotion - Fabric","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-26-lDe7V.js","utils-CWQmgYtH.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-4-Aw3rSD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C2zjXYA5.js","snippetPresets-DFmpFA7C.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-FJpQavWq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D_GvPF7k.js","shallow-Bs2ZB0NO.js","getApiPlaygroundDisplay-DCcqJJk-.js","CodeSnippet-DzDxawVe.js","CodeSnippets-aUr7fU-7.js","Page-CT9uE8Ip.js","getPastedJson-Y1fKsj_I.js","icon-DI4zTsDr.js","MethodPill-C0nDlmSQ.js","DuplicateIcon-NUXbx2nQ.js","createIcon-BdTHrPAi.js","DynamicMarkdown-CtpgKJwj.js","SectionHeading-B3x35tOt.js","axios-vUo_bRtp.js","Markdown-3OmurJMP.js","clsx-DMKzROTp.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-1ms6tsT-.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Ke9xIMFx.js"]}