A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.
x-fabric-channel-id identifies the sales channel where the API request is being made; primarily for multichannel use cases. The channel ids are 12 corresponding to US and 13 corresponding to Canada. The default channel id is 12. This field is required.
{"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":"v3/orders-and-inventory/api-reference/inventory/networks/soft-reserve","slug":"/v3/orders-and-inventory/api-reference/inventory/networks/soft-reserve","pageMetadata":{"openapi":"inventory.openapi post /inventory-networks/actions/soft-reserve","title":"Soft reservation","description":"Soft reserve quantity.","href":"/v3/orders-and-inventory/api-reference/inventory/networks/soft-reserve"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Soft reserve quantity.\"\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":"inventory.openapi post /inventory-networks/actions/soft-reserve","title":"Soft reservation","description":"Soft reserve quantity.","href":"/v3/orders-and-inventory/api-reference/inventory/networks/soft-reserve"}}},"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":{"description":"Soft reserve quantity.","operationId":"reserveQuantity","parameters":["63157252-190b-43b6-ac6f-4a151f7451cb","e9ce4c6a-90c0-4a8e-a008-41b17d6aa2a8","6b1f3aed-0365-46ab-89c7-115c57b62b49"],"requestBody":"4dbf7412-59df-44d7-b238-5958978605fa","responses":{"201":"563e98ed-7ffb-4633-af33-329a75233e44","400":"e1c05014-6d57-49a6-aefb-85dd63650cce","401":"ffb64dd7-4291-411c-b56d-0e13f32b38d5","500":"273cd177-cffa-458a-9048-fd03d05bcaf0"},"summary":"Soft reservation","tags":["ReservedNetwork Endpoints"],"method":"post","type":"path","servers":["d7808a22-73ea-4c2d-9e62-95bed2999023"],"security":["54825ba0-664c-4928-a76e-e8a2ec45a264"],"path":"/inventory-networks/actions/soft-reserve","baseUrlOptions":["https://api.fabric.inc/v3"],"title":"Soft reservation","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"63157252-190b-43b6-ac6f-4a151f7451cb":{"description":"A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from [Copilot](/v3/platform/settings/account-details/getting-the-account-id). This header is required.","example":"5f328bf0b5f328bf0b5f328b","in":"header","name":"x-fabric-tenant-id","required":true,"schema":{"type":"string","isRequired":true,"description":"A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from [Copilot](/v3/platform/settings/account-details/getting-the-account-id). This header is required.","uniqueKey":"","typeLabel":"string"}},"e9ce4c6a-90c0-4a8e-a008-41b17d6aa2a8":{"description":"x-fabric-channel-id identifies the sales channel where the API request is being made; primarily for multichannel use cases. The channel ids are 12 corresponding to US and 13 corresponding to Canada. The default channel id is 12. This field is required.","example":"12","in":"header","name":"x-fabric-channel-id","required":true,"schema":{"type":"string","isRequired":true,"description":"x-fabric-channel-id identifies the sales channel where the API request is being made; primarily for multichannel use cases. The channel ids are 12 corresponding to US and 13 corresponding to Canada. The default channel id is 12. This field is required.","uniqueKey":"","typeLabel":"string"}},"6b1f3aed-0365-46ab-89c7-115c57b62b49":{"description":"Unique request ID","example":"263e731c-45c8-11ed-b878-0242ac120002","in":"header","name":"x-fabric-request-id","required":false,"schema":{"type":"string","isRequired":false,"description":"Unique request ID","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"description":"SoftReserveRequest model","properties":{"items":{"description":"Items which needs to be reserved. Required parameter","items":{"properties":{"channelId":{"description":"ChannelId for the item which needs to be reserved. Required parameter","example":"3","type":"string","isRequired":true,"uniqueKey":"\\items.items.[INDEX].channelId","typeLabel":"string"},"lineItemId":{"description":"lineItemId of product. Required parameter ","example":"2","type":"string","isRequired":true,"uniqueKey":"\\items.items.[INDEX].lineItemId","typeLabel":"string"},"quantity":{"description":"quantity that needs to be reserved. Required parameter","example":5,"format":"int32","type":"integer","isRequired":true,"uniqueKey":"\\items.items.[INDEX].quantity","typeLabel":"integer\u003cint32>"},"sku":{"description":"sku of product. Required parameter","example":"OMSTESTSKU1","type":"string","isRequired":true,"uniqueKey":"\\items.items.[INDEX].sku","typeLabel":"string"},"backorderQuantity":{"description":"Back order quantity that needs to be reserved","example":5,"format":"int32","type":"integer","uniqueKey":"\\items.items.[INDEX].backorderQuantity","typeLabel":"integer\u003cint32>"},"errorMessage":{"type":"string","uniqueKey":"\\items.items.[INDEX].errorMessage","typeLabel":"string"},"itemId":{"description":"itemId of product. Optional parameter","example":"451008962041","type":"string","uniqueKey":"\\items.items.[INDEX].itemId","typeLabel":"string"},"locationNumber":{"description":"LocationNumber for which this item needs to be reserved. Optional parameter","example":999,"format":"int32","type":"integer","uniqueKey":"\\items.items.[INDEX].locationNumber","typeLabel":"integer\u003cint32>"},"networkCode":{"description":"Network for which this item needs to be reserved. Optional parameter","example":"ShipToHome","type":"string","uniqueKey":"\\items.items.[INDEX].networkCode","typeLabel":"string"},"preorderQuantity":{"description":"Pre order quantity that needs to be reserved","example":5,"format":"int32","type":"integer","uniqueKey":"\\items.items.[INDEX].preorderQuantity","typeLabel":"integer\u003cint32>"},"reservedNetworkCodes":{"items":{"type":"string","uniqueKey":"\\items.items.[INDEX].reservedNetworkCodes.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"\\items.items.[INDEX].reservedNetworkCodes","typeLabel":"string[]"},"status":{"type":"string","uniqueKey":"\\items.items.[INDEX].status","typeLabel":"string"},"type":{"description":"Order type, default value is STANDARD. Optional parameter","example":"['STANDARD','PREORDER','BACKORDER']","type":"string","uniqueKey":"\\items.items.[INDEX].type","typeLabel":"string"}},"required":["channelId","lineItemId","quantity","sku"],"type":"object","uniqueKey":"\\items.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"\\items","typeLabel":"object[]"},"cartId":{"description":"CartId for which soft reserve requested, at least one of orderNumber or cartId or OrderId is required","example":"b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569","type":"string","uniqueKey":"cartId","typeLabel":"string"},"createdAt":{"description":"Date when soft reservation was created","example":"2022-08-01T18:03:28.483971941Z","format":"date-time","type":"string","uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"expiresAt":{"description":"Date when soft reservation will expire","example":"2022-08-01T18:03:28.483971941Z","format":"date-time","type":"string","uniqueKey":"expiresAt","typeLabel":"string\u003cdate-time>"},"id":{"description":"ID","example":"\"Infinity\"","type":"string","uniqueKey":"id","typeLabel":"string"},"networkCode":{"description":"Network for which items needs to be reserved. Optional parameter","example":"DCOnly","type":"string","uniqueKey":"networkCode","typeLabel":"string"},"orderId":{"description":"Order ID for which soft reserve requested, at least one of orderNumber or cartId or OrderId is required","example":"62ab7af89ed14510827fe074","type":"string","uniqueKey":"orderId","typeLabel":"string"},"orderNumber":{"deprecated":true,"description":"OrderNumber for which soft reserve requested, at least one of orderNumber or cartId or OrderId is required","example":"order_20220729_883","type":"string","uniqueKey":"orderNumber","typeLabel":"string"},"orderType":{"description":"Order type, default value is STANDARD. Optional parameter","example":"['STANDARD','CSR']","type":"string","uniqueKey":"orderType","typeLabel":"string"},"updatedAt":{"description":"Date when soft reservation was updated","example":"2022-08-01T18:03:28.483971941Z","format":"date-time","type":"string","uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"},"vendorId":{"description":"VendorId for which soft reserve requested. Optional parameter","example":"test_vendor","type":"string","uniqueKey":"vendorId","typeLabel":"string"}},"required":["items"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"items":[{"channelId":"3","lineItemId":"2","quantity":5,"sku":"OMSTESTSKU1","backorderQuantity":5,"errorMessage":"\u003cstring>","itemId":"451008962041","locationNumber":999,"networkCode":"ShipToHome","preorderQuantity":5,"reservedNetworkCodes":["\u003cstring>"],"status":"\u003cstring>","type":"['STANDARD','PREORDER','BACKORDER']"}],"cartId":"b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569","createdAt":"2022-08-01T18:03:28.483971941Z","expiresAt":"2022-08-01T18:03:28.483971941Z","id":"\"Infinity\"","networkCode":"DCOnly","orderId":"62ab7af89ed14510827fe074","orderNumber":"order_20220729_883","orderType":"['STANDARD','CSR']","updatedAt":"2022-08-01T18:03:28.483971941Z","vendorId":"test_vendor"}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"563e98ed-7ffb-4633-af33-329a75233e44":{"content":{"application/json":{"schema":{"description":"AggregatedNetworksResponse model","properties":{"aggregatedNetworks":{"description":"Aggregated networks","items":{"description":"Displays an aggregate representation of the SKU that includes all locations for which the sku is available in that network.","properties":{"backorderLimit":{"description":"The maximum restock inventory quantity.","example":50,"format":"int32","type":"integer","uniqueKey":"aggregatedNetworks.items.[INDEX].backorderLimit","typeLabel":"integer\u003cint32>"},"backorderShipmentAt":{"description":"The timestamp for when a backorder is shipped.","example":"2022-08-01T20:03:28.483Z","format":"date-time","type":"string","uniqueKey":"aggregatedNetworks.items.[INDEX].backorderShipmentAt","typeLabel":"string\u003cdate-time>"},"channelId":{"description":"The sales channel ID; identifies business operations location.","example":"channel_xyz","type":"string","uniqueKey":"aggregatedNetworks.items.[INDEX].channelId","typeLabel":"string"},"counters":{"additionalProperties":{"description":"Merchant-defined inventory counter (also known as inventory position)","format":"int32","type":"integer","uniqueKey":"aggregatedNetworks.items.[INDEX].counters.additionalProperties","typeLabel":"integer\u003cint32>"},"description":"Your defined inventory positions. These can be included in availability calculations.","example":{"allocated":10,"onHand":100,"shipped":20},"type":"object","uniqueKey":"aggregatedNetworks.items.[INDEX].counters","typeLabel":"object"},"createdAt":{"description":"Time of inventory creation","example":"2022-08-01T18:03:28.483Z","format":"date-time","type":"string","uniqueKey":"aggregatedNetworks.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"customAttributes":{"additionalProperties":{"description":"Placeholder for additional info","example":"{\"isBopis\":true}","type":"string","uniqueKey":"aggregatedNetworks.items.[INDEX].customAttributes.additionalProperties","typeLabel":"string"},"description":"Placeholder for additional info","example":{"isBopis":true},"type":"object","uniqueKey":"aggregatedNetworks.items.[INDEX].customAttributes","typeLabel":"object"},"hasInfiniteInventory":{"default":false,"description":"The infinite inventory flag. Setting this to true means inventory can be used any number of times and does not have a consumption limit. Setting this to false means inventory can't be used infinitely, and has a consumption limit.","example":false,"type":"boolean","uniqueKey":"aggregatedNetworks.items.[INDEX].hasInfiniteInventory","typeLabel":"boolean"},"inventoryId":{"description":"The fabric system-generated inventory ID. This ID is generated during inventory creation.","example":"723910d81723","type":"string","uniqueKey":"aggregatedNetworks.items.[INDEX].inventoryId","typeLabel":"string"},"isNoStock":{"description":"An attribute used to indicate that a SKU is out of stock.","example":false,"type":"boolean","uniqueKey":"aggregatedNetworks.items.[INDEX].isNoStock","typeLabel":"boolean"},"itemId":{"description":"Merchant-defined item ID whose inventory is created or updated. If omitted, fabric Inventory service generates the `itemId`. If you choose to use the `itemId` in your environment, you must include it in all inventory *Write* requests.","example":12345,"format":"int32","type":"integer","uniqueKey":"aggregatedNetworks.items.[INDEX].itemId","typeLabel":"integer\u003cint32>"},"leadTime":{"description":"The time between when an order is placed to replenish inventory and when the order is received at warehouse.","example":"5 days","type":"string","uniqueKey":"aggregatedNetworks.items.[INDEX].leadTime","typeLabel":"string"},"locationNumber":{"description":"Represents the warehouse or store location where the inventory is stored. The locationNumber is crucial for inventory management. When creating or updating inventory, you need to include the locationNumber to specify which location the inventory belongs to.","example":12345,"format":"int32","type":"integer","uniqueKey":"aggregatedNetworks.items.[INDEX].locationNumber","typeLabel":"integer\u003cint32>"},"lowStock":{"description":"The lowStock parameter is used to alert low stock at a location when inventory is below a set number.","example":10,"format":"int32","type":"integer","uniqueKey":"aggregatedNetworks.items.[INDEX].lowStock","typeLabel":"integer\u003cint32>"},"networkCode":{"description":"Code of the network to which the inventory belongs","example":"ShipToHome","type":"string","uniqueKey":"aggregatedNetworks.items.[INDEX].networkCode","typeLabel":"string"},"networkCounters":{"additionalProperties":{"description":"Indicates inventory positions at network","format":"int32","type":"integer","uniqueKey":"aggregatedNetworks.items.[INDEX].networkCounters.additionalProperties","typeLabel":"integer\u003cint32>"},"description":"Indicates inventory positions at network","example":{"softReserve":10},"type":"object","uniqueKey":"aggregatedNetworks.items.[INDEX].networkCounters","typeLabel":"object"},"preorderLimit":{"description":"The maximum preorder limit.","example":40,"format":"int32","type":"integer","uniqueKey":"aggregatedNetworks.items.[INDEX].preorderLimit","typeLabel":"integer\u003cint32>"},"preorderShipmentAt":{"description":"Time when preorder is shipped","example":"2022-08-01T20:03:28.483Z","format":"date-time","type":"string","uniqueKey":"aggregatedNetworks.items.[INDEX].preorderShipmentAt","typeLabel":"string\u003cdate-time>"},"region":{"description":"Region where inventory is managed","example":"North America","type":"string","uniqueKey":"aggregatedNetworks.items.[INDEX].region","typeLabel":"string"},"safetyStock":{"description":"Reserved inventory quantity at the location","example":10,"format":"int32","type":"integer","uniqueKey":"aggregatedNetworks.items.[INDEX].safetyStock","typeLabel":"integer\u003cint32>"},"segment":{"description":"Segment of the inventory","example":"Sample Segment","type":"string","uniqueKey":"aggregatedNetworks.items.[INDEX].segment","typeLabel":"string"},"sku":{"description":"Product SKU (Stock Keeping Unit) identifier. It serves as the primary reference key for the inventory and provides uniqueness to the item.","example":"SKU1","type":"string","uniqueKey":"aggregatedNetworks.items.[INDEX].sku","typeLabel":"string"},"status":{"description":"Inventory status IN_STOCK, LOW_STOCK, etc.","enum":["IN_STOCK","LOW_STOCK","OUT_OF_STOCK","BACKORDER_STOCK","PREORDER_STOCK"],"example":" IN_STOCK","type":"string","uniqueKey":"aggregatedNetworks.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"type":{"description":"Inventory type - a classifier attribute that provides flexibility to define inventory types","example":"primary","type":"string","uniqueKey":"aggregatedNetworks.items.[INDEX].type","typeLabel":"string"},"updatedAt":{"description":"Time when inventory was last updated","example":"2022-08-01T20:03:28.483Z","format":"date-time","type":"string","uniqueKey":"aggregatedNetworks.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"},"vendorId":{"description":"ID of the vendor who will replenish the inventory for the retailer","example":"vendor1","type":"string","uniqueKey":"aggregatedNetworks.items.[INDEX].vendorId","typeLabel":"string"},"virtualCounters":{"description":"Virtual counters are calculated at run time from counters","properties":{"availableBackorder":{"type":"string","uniqueKey":"aggregatedNetworks.items.[INDEX].virtualCounters.availableBackorder","typeLabel":"string"},"availablePreorder":{"type":"string","uniqueKey":"aggregatedNetworks.items.[INDEX].virtualCounters.availablePreorder","typeLabel":"string"},"availableToPurchase":{"type":"string","uniqueKey":"aggregatedNetworks.items.[INDEX].virtualCounters.availableToPurchase","typeLabel":"string"}},"type":"object","uniqueKey":"aggregatedNetworks.items.[INDEX].virtualCounters","typeLabel":"object"},"virtualCountersStatus":{"description":"Virtual counters are calculated at run time from counters","properties":{"availableBackorder":{"type":"string","uniqueKey":"aggregatedNetworks.items.[INDEX].virtualCountersStatus.availableBackorder","typeLabel":"string"},"availablePreorder":{"type":"string","uniqueKey":"aggregatedNetworks.items.[INDEX].virtualCountersStatus.availablePreorder","typeLabel":"string"},"availableToPurchase":{"type":"string","uniqueKey":"aggregatedNetworks.items.[INDEX].virtualCountersStatus.availableToPurchase","typeLabel":"string"}},"type":"object","uniqueKey":"aggregatedNetworks.items.[INDEX].virtualCountersStatus","typeLabel":"object"}},"type":"object","uniqueKey":"aggregatedNetworks.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"aggregatedNetworks","typeLabel":"object[]"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"aggregatedNetworks":[{"backorderLimit":50,"backorderShipmentAt":"2022-08-01T20:03:28.483Z","channelId":"channel_xyz","counters":{"allocated":10,"onHand":100,"shipped":20},"createdAt":"2022-08-01T18:03:28.483Z","customAttributes":{"isBopis":true},"hasInfiniteInventory":false,"inventoryId":"723910d81723","isNoStock":false,"itemId":12345,"leadTime":"5 days","locationNumber":12345,"lowStock":10,"networkCode":"ShipToHome","networkCounters":{"softReserve":10},"preorderLimit":40,"preorderShipmentAt":"2022-08-01T20:03:28.483Z","region":"North America","safetyStock":10,"segment":"Sample Segment","sku":"SKU1","status":" IN_STOCK","type":"primary","updatedAt":"2022-08-01T20:03:28.483Z","vendorId":"vendor1","virtualCounters":{"availableBackorder":"\u003cstring>","availablePreorder":"\u003cstring>","availableToPurchase":"\u003cstring>"},"virtualCountersStatus":{"availableBackorder":"\u003cstring>","availablePreorder":"\u003cstring>","availableToPurchase":"\u003cstring>"}}]}}},"exampleType":"generated"}},"description":"Created","headers":{"x-fabric-request-id":{"description":"Unique request ID","example":"263e731c-45c8-11ed-b878-0242ac120002","required":false,"schema":{"type":"string"}}},"exampleType":"generated"},"e1c05014-6d57-49a6-aefb-85dd63650cce":{"content":{"application/json":{"example":{"errors":[{"message":"Invalid request","type":"CLIENT_ERROR"}],"message":"Bad request","type":"CLIENT_ERROR"},"schema":{"description":"Error response","properties":{"errors":{"description":"Errors","items":{"$circularRef":"d44fef35-0ac4-4e35-9dad-e6da9b214928"},"type":"array","uniqueKey":"errors","typeLabel":"array"},"message":{"description":"Error message","example":"Bad request","type":"string","uniqueKey":"message","typeLabel":"string"},"type":{"description":"Error type","example":"CLIENT_ERROR","type":"string","uniqueKey":"type","typeLabel":"string"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"message":"Invalid request","type":"CLIENT_ERROR"}],"message":"Bad request","type":"CLIENT_ERROR"}}},"exampleType":"examples"}},"description":"Bad request","headers":{"x-fabric-request-id":{"description":"Unique request ID","example":"263e731c-45c8-11ed-b878-0242ac120002","required":false,"schema":{"type":"string"}}},"exampleType":"examples"},"ffb64dd7-4291-411c-b56d-0e13f32b38d5":{"content":{"application/json":{"example":{"message":"Unauthorized request","type":"CLIENT_ERROR"},"schema":{"description":"Error response","properties":{"errors":{"description":"Errors","items":{"$circularRef":"d44fef35-0ac4-4e35-9dad-e6da9b214928"},"type":"array","uniqueKey":"errors","typeLabel":"array"},"message":{"description":"Error message","example":"Bad request","type":"string","uniqueKey":"message","typeLabel":"string"},"type":{"description":"Error type","example":"CLIENT_ERROR","type":"string","uniqueKey":"type","typeLabel":"string"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Unauthorized request","type":"CLIENT_ERROR"}}},"exampleType":"examples"}},"description":"Unauthorized","headers":{"x-fabric-request-id":{"description":"Unique request ID","example":"263e731c-45c8-11ed-b878-0242ac120002","required":false,"schema":{"type":"string"}}},"exampleType":"examples"},"273cd177-cffa-458a-9048-fd03d05bcaf0":{"content":{"application/json":{"example":{"message":"Internal server error","type":"SERVER_ERROR"},"schema":{"description":"Error response","properties":{"errors":{"description":"Errors","items":{"$circularRef":"d44fef35-0ac4-4e35-9dad-e6da9b214928"},"type":"array","uniqueKey":"errors","typeLabel":"array"},"message":{"description":"Error message","example":"Bad request","type":"string","uniqueKey":"message","typeLabel":"string"},"type":{"description":"Error type","example":"CLIENT_ERROR","type":"string","uniqueKey":"type","typeLabel":"string"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Internal server error","type":"SERVER_ERROR"}}},"exampleType":"examples"}},"description":"Internal server error","headers":{"x-fabric-request-id":{"description":"Unique request ID","example":"263e731c-45c8-11ed-b878-0242ac120002","required":false,"schema":{"type":"string"}}},"exampleType":"examples"}},"security":{"54825ba0-664c-4928-a76e-e8a2ec45a264":{"authorization":{"bearerFormat":"JWT","scheme":"bearer","type":"http","scopes":[]}}},"servers":{"d7808a22-73ea-4c2d-9e62-95bed2999023":{"description":"Production","url":"https://api.fabric.inc/v3"}},"schemas":{"d44fef35-0ac4-4e35-9dad-e6da9b214928":{"description":"Error response","properties":{"errors":{"description":"Errors","items":{"$circularRef":"d44fef35-0ac4-4e35-9dad-e6da9b214928"},"type":"array"},"message":{"description":"Error message","example":"Bad request","type":"string"},"type":{"description":"Error type","example":"CLIENT_ERROR","type":"string"}},"type":"object"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"bearerFormat":"JWT","scheme":"bearer","type":"http","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":"authorization","name":"Authorization"}],"title":"authorization"}]},"originalFileLocation":"openapi/inventory/v3/inventory.openapi.yaml"},"subdomain":"fabric-demo","siteName":"Fabric","title":"Soft reservation - Fabric","navMaps":{"firstHrefInVersion":{"Product Agent":{"href":"/home","matchLevel":4},"v3":{"href":"/v3/orders-and-inventory/api-reference/inventory/networks/soft-reserve","matchLevel":0},"v2":{"href":"/v2/home","matchLevel":4}},"firstHrefInLanguage":{}},"lastModified":"2026-01-22T21:06:41.290Z","originalFileLocation":"v3/orders-and-inventory/api-reference/inventory/networks/soft-reserve.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=\"Soft reserve quantity.\">\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=\"Soft reservation - Fabric\">\u003cmeta data-mint-head property=\"og:description\" content=\"Soft reserve quantity.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Fabric\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/networks/soft-reserve\">\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=Networks\u0026amp;title=Soft+reservation\u0026amp;description=Soft+reserve+quantity.\u0026amp;theme=d21d2e5604bc479b7e92e42c\u0026amp;signature=e7591312ae3e4c124abbe5680ace55dee9eb4cdcccc2ffbff00de4b621106561\">\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=\"Soft reservation - Fabric\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Soft reserve quantity.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://fabric-demo.mintlify.app/_mintlify/api/og/v2?division=Networks\u0026amp;title=Soft+reservation\u0026amp;description=Soft+reserve+quantity.\u0026amp;theme=d21d2e5604bc479b7e92e42c\u0026amp;signature=e7591312ae3e4c124abbe5680ace55dee9eb4cdcccc2ffbff00de4b621106561\">\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/v3/orders-and-inventory/api-reference/inventory/networks/soft-reserve\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/v3/orders-and-inventory/api-reference/inventory/networks/soft-reserve.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/v3/orders-and-inventory/api-reference/inventory/networks/soft-reserve#webpage\",\"url\":\"https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/networks/soft-reserve\",\"name\":\"Soft reservation\",\"description\":\"Soft reserve quantity.\",\"dateModified\":\"2026-01-22T21:06:41.290Z\",\"isPartOf\":{\"@id\":\"https://developer.fabric.inc#website\"},\"breadcrumb\":{\"@id\":\"https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/networks/soft-reserve#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/networks/soft-reserve#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Inventory API Endpoints\",\"item\":\"https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/inventory--3-0-0\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Networks\",\"item\":\"https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/networks/get-all-networks\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Soft reservation\",\"item\":\"https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/networks/soft-reserve\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/networks/soft-reserve#apireference\",\"headline\":\"Soft reservation\",\"name\":\"Soft reservation\",\"description\":\"Soft reserve quantity.\",\"url\":\"https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/networks/soft-reserve\",\"mainEntityOfPage\":{\"@id\":\"https://developer.fabric.inc/v3/orders-and-inventory/api-reference/inventory/networks/soft-reserve#webpage\"},\"dateModified\":\"2026-01-22T21:06:41.290Z\",\"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","tabs":[{"tab":"Home","pages":[{"title":"Home","href":"/v3/home"}]},{"tab":"Getting Started","pages":[{"title":"Getting Started","href":"/v3/getting-started/overview"}]},{"tab":"Orders \u0026 Inventory","groups":[{"group":"Orders \u0026 Inventory","pages":[{"title":"Overview","href":"/v3/orders-and-inventory/homepage"}]},{"group":"Order User Guides","pages":[{"title":"Overview","href":"/v3/orders-and-inventory/user-guides/orders/overview"},{"group":"Order Management","pages":[{"title":"Overview","href":"/v3/orders-and-inventory/user-guides/orders/order-management/overview"},{"title":"Creating an Order","href":"/v3/orders-and-inventory/user-guides/orders/order-management/creating-an-order"},{"title":"Viewing Orders","href":"/v3/orders-and-inventory/user-guides/orders/order-management/viewing-orders"},{"title":"Filtering Orders","href":"/v3/orders-and-inventory/user-guides/orders/order-management/filtering-orders"},{"title":"Viewing Allocations","href":"/v3/orders-and-inventory/user-guides/orders/order-management/viewing-allocations"},{"title":"Viewing Shipments","href":"/v3/orders-and-inventory/user-guides/orders/order-management/viewing-shipments"},{"title":"Viewing Invoices","href":"/v3/orders-and-inventory/user-guides/orders/order-management/viewing-invoices"},{"title":"Adding Products to an Existing Order","href":"/v3/orders-and-inventory/user-guides/orders/order-management/adding-products-to-existing-order"},{"title":"Updating a Shipping Address","href":"/v3/orders-and-inventory/user-guides/orders/order-management/updating-shipping-address"},{"title":"Processing returns","href":"/v3/orders-and-inventory/user-guides/orders/order-management/returning-orders"},{"title":"Creating Appeasement Refunds","href":"/v3/orders-and-inventory/user-guides/orders/order-management/appeasements"},{"title":"Processing Exchanges","href":"/v3/orders-and-inventory/user-guides/orders/order-management/exchange-orders"},{"title":"Canceling Items in an Order","href":"/v3/orders-and-inventory/user-guides/orders/order-management/cancel-skus"},{"title":"Exporting Orders","href":"/v3/orders-and-inventory/user-guides/orders/order-management/exporting-orders"},{"group":"Viewing Order Details","pages":[{"title":"Viewing Order Basic Details","href":"/v3/orders-and-inventory/user-guides/orders/order-management/viewing-details-of-an-order/basic-details"},{"title":"Viewing Allocation Details","href":"/v3/orders-and-inventory/user-guides/orders/order-management/viewing-details-of-an-order/allocation-details"},{"title":"Viewing Shipment Details","href":"/v3/orders-and-inventory/user-guides/orders/order-management/viewing-details-of-an-order/shipment-details"},{"title":"Viewing Invoice Details","href":"/v3/orders-and-inventory/user-guides/orders/order-management/viewing-details-of-an-order/invoice-details"},{"title":"Viewing an Orders Activity Log","href":"/v3/orders-and-inventory/user-guides/orders/order-management/viewing-details-of-an-order/viewing-activity-log"}]}]},{"group":"Order Fulfillment Logic","pages":[{"title":"Order Fulfillment Logic Overview","sidebarTitle":"Overview","href":"/v3/orders-and-inventory/user-guides/orders/order-fulfillment-logic/order-fulfillment-logic"},{"title":"Creating a Rule Set","href":"/v3/orders-and-inventory/user-guides/orders/order-fulfillment-logic/create-a-new-rule-set-ui"},{"title":"Updating a Rule Set","href":"/v3/orders-and-inventory/user-guides/orders/order-fulfillment-logic/manage-rule-sets"}]},{"group":"Smart Order Routing","pages":[{"title":"Smart Order Routing","sidebarTitle":"Overview","href":"/v3/orders-and-inventory/user-guides/orders/smart-order-routing/overview"},{"title":"Setting Goals and Constraints","href":"/v3/orders-and-inventory/user-guides/orders/smart-order-routing/setting-goals-and-constraints"},{"title":"Viewing Smart Order Routing Rules","sidebarTitle":"Viewing Rules","href":"/v3/orders-and-inventory/user-guides/orders/smart-order-routing/viewing-rules"},{"title":"Testing Suggested Fulfillment Rules","href":"/v3/orders-and-inventory/user-guides/orders/smart-order-routing/testing-rules"},{"title":"Viewing Smart Order Routing Scores","sidebarTitle":"Viewing Scores","href":"/v3/orders-and-inventory/user-guides/orders/smart-order-routing/viewing-scores"},{"title":"Activating Smart Order Routing Rules","sidebarTitle":"Activate a Saved Ruleset","href":"/v3/orders-and-inventory/user-guides/orders/smart-order-routing/activating-rules"},{"title":"Viewing Smart Order Routing History","sidebarTitle":"Viewing History","href":"/v3/orders-and-inventory/user-guides/orders/smart-order-routing/viewing-history"}]},{"title":"Activity Log","href":"/v3/orders-and-inventory/user-guides/orders/activity-log"},{"group":"Configurations","pages":[{"title":"Overview","href":"/v3/orders-and-inventory/user-guides/orders/configurations/overview"},{"title":"Reallocation and Cancellation Rules","href":"/v3/orders-and-inventory/user-guides/orders/configurations/reallocation"},{"title":"Order Attributes","href":"/v3/orders-and-inventory/user-guides/orders/configurations/order-attributes"},{"title":"Shipping Methods","href":"/v3/orders-and-inventory/user-guides/orders/configurations/shipping-methods"},{"title":"Backorder \u0026 Preorder Configurations","href":"/v3/orders-and-inventory/user-guides/orders/configurations/backorder-preorder"},{"title":"Order Policies","href":"/v3/orders-and-inventory/user-guides/orders/configurations/policies"}]}]},{"group":"Inventory User Guides","pages":[{"title":"Overview","href":"/v3/orders-and-inventory/user-guides/inventory/overview"},{"title":"Inventory","href":"/v3/orders-and-inventory/user-guides/inventory/manage-inventory-overview"},{"group":"Locations","pages":[{"title":"Locations Overview","href":"/v3/orders-and-inventory/user-guides/inventory/locations-overview"},{"title":"Creating a Location","href":"/v3/orders-and-inventory/user-guides/inventory/create-location"},{"title":"Configuring Scheduled Closures","href":"/v3/orders-and-inventory/user-guides/inventory/scheduledclosures"},{"title":"Importing Locations","href":"/v3/orders-and-inventory/user-guides/inventory/import-locations"},{"title":"Exporting Locations","href":"/v3/orders-and-inventory/user-guides/inventory/export-locations"}]},{"group":"Networks","pages":[{"title":"Networks Overview","href":"/v3/orders-and-inventory/user-guides/inventory/networks-overview"},{"title":"Create a Network","href":"/v3/orders-and-inventory/user-guides/inventory/create-a-network"}]},{"title":"Zones","href":"/v3/orders-and-inventory/user-guides/inventory/create-a-zone"},{"title":"Geographic Regions","href":"/v3/orders-and-inventory/user-guides/inventory/create-geo"},{"title":"Activity Log","href":"/v3/orders-and-inventory/user-guides/inventory/activity-log"}]},{"group":"Error Codes","pages":[{"title":"Standardized Error Codes in fabric","sidebarTitle":"Overview","href":"/v3/error-codes/overview"},{"title":"Service Error Codes","sidebarTitle":"Service Errors","href":"/v3/error-codes/system-errors"},{"group":"Orders \u0026 Inventory","pages":[{"title":"Order Error Codes","sidebarTitle":"ORDER: 2001-2039","href":"/v3/error-codes/order-errors"},{"title":"Allocation Error Codes","sidebarTitle":"ALLOCATION: 2001-2009","href":"/v3/error-codes/allocation-errors"},{"title":"Shipment Error Codes","sidebarTitle":"SHIPMENT: 2001-2011","href":"/v3/error-codes/shipment-errors"},{"title":"Inventory Error Codes","sidebarTitle":"INVENTORY: 2001-2004","href":"/v3/error-codes/inventory-errors"},{"title":"Invoice Error Codes","sidebarTitle":"INVOICE: 2001-2007","href":"/v3/error-codes/invoice-errors"},{"title":"Location Error Codes","sidebarTitle":"LOCATION: 2001-2012","href":"/v3/error-codes/location-errors"}]}]},{"group":"Orders API Endpoints","pages":[{"title":"Orders (3.0.0)","href":"/v3/orders-and-inventory/api-reference/orders/orders--3-0-0"},{"group":"Developer Guide","pages":[{"title":"Overview","href":"/v3/orders-and-inventory/api-reference/orders/developer-guide/overview"},{"title":"Configuration Template Guide","href":"/v3/orders-and-inventory/api-reference/orders/developer-guide/configuration-template-guide"},{"title":"Importing order and inventory data","href":"/v3/orders-and-inventory/api-reference/orders/developer-guide/order-and-inventory-import"},{"title":"Inventory Setup","href":"/v3/orders-and-inventory/api-reference/orders/developer-guide/inventory-setup"},{"title":"Order Fulfillment","href":"/v3/orders-and-inventory/api-reference/orders/developer-guide/order-fulfillment"},{"title":"Order Exchange","href":"/v3/orders-and-inventory/api-reference/orders/developer-guide/order-exchange"},{"title":"Order Return","href":"/v3/orders-and-inventory/api-reference/orders/developer-guide/order-return"},{"title":"List of Webhook Events","href":"/v3/orders-and-inventory/api-reference/orders/developer-guide/list-of-webhook-events"}]},{"title":"Orders FAQ","href":"/v3/orders-and-inventory/api-reference/orders/orders-faq-s"},{"group":"Shopping Lists","pages":[{"title":"Getting Started with Lists","sidebarTitle":"Overview","href":"/v3/orders-and-inventory/api-reference/orders/shopping-lists/overview"},{"openapi":"lists.openapi delete /lists/{listId}","title":"Delete a shopping list by ID","href":"/v3/orders-and-inventory/api-reference/orders/shopping-lists/delete-a-shopping-list-by-id"},{"openapi":"lists.openapi get /lists/users/{userId}","title":"Get shopping lists of a user","href":"/v3/orders-and-inventory/api-reference/orders/shopping-lists/get-shopping-lists-of-a-user"},{"openapi":"lists.openapi put /lists/{listId}","title":"Update a shopping list by ID","href":"/v3/orders-and-inventory/api-reference/orders/shopping-lists/update-a-shopping-list-by-id"},{"openapi":"lists.openapi post /lists","title":"Create shopping list","href":"/v3/orders-and-inventory/api-reference/orders/shopping-lists/create-shopping-list"},{"openapi":"lists.openapi get /lists/{listId}","title":"Get a shopping list by ID","href":"/v3/orders-and-inventory/api-reference/orders/shopping-lists/get-a-shopping-list-by-id"},{"openapi":"lists.openapi get /lists/{listId}/actions/get-list-details","title":"Get shopping list and its items","href":"/v3/orders-and-inventory/api-reference/orders/shopping-list-items/get-shopping-list-and-its-items"},{"openapi":"lists.openapi get /lists/users/{userId}/actions/get-list-details-with-items","title":"Get shopping lists of a user along with associated items","href":"/v3/orders-and-inventory/api-reference/orders/shopping-list-items/get-shopping-lists-of-a-user-along-with-associated-items"},{"openapi":"lists.openapi get /lists/{listId}/list-items","title":"Get shopping list items by list ID","href":"/v3/orders-and-inventory/api-reference/orders/shopping-list-items/get-shopping-list-items-by-list-id"},{"openapi":"lists.openapi post /lists/{listId}/actions/delete-list-items","title":"Delete items from shopping list","href":"/v3/orders-and-inventory/api-reference/orders/shopping-list-items/delete-items-from-shopping-list"},{"openapi":"lists.openapi post /lists/{listId}/actions/add-or-update-list-items","title":"Add or update items in a shopping list","href":"/v3/orders-and-inventory/api-reference/orders/shopping-list-items/add-or-update-items-in-a-shopping-list"}]},{"group":"Shipping Methods","pages":[{"openapi":"shipping-methods.openapi post /shipping-methods/search","title":"Find shipping methods","href":"/v3/orders-and-inventory/api-reference/orders/shipping-methods/find-shipping-methods"},{"openapi":"shipping-methods.openapi delete /shipping-methods/{shippingMethodId}","title":"Delete shipping method","href":"/v3/orders-and-inventory/api-reference/orders/shipping-methods/delete-shipping-method"},{"openapi":"shipping-methods.openapi post /shipping-methods","title":"Create shipping method","href":"/v3/orders-and-inventory/api-reference/orders/shipping-methods/create-shipping-method"},{"openapi":"shipping-methods.openapi get /shipping-methods/{shippingMethodId}","title":"Get shipping method","href":"/v3/orders-and-inventory/api-reference/orders/shipping-methods/get-shipping-method"},{"openapi":"shipping-methods.openapi put /shipping-methods/{shippingMethodId}","title":"Update shipping method","href":"/v3/orders-and-inventory/api-reference/orders/shipping-methods/update-shipping-method"},{"openapi":"shipping-methods.openapi get /shipping-methods/{shippingMethodId}/items","title":"Get item IDs for given shipping method","href":"/v3/orders-and-inventory/api-reference/orders/shipping-method-items/get-item-ids-for-given-shipping-method"},{"openapi":"shipping-methods.openapi post /shipping-methods/{shippingMethodId}/actions/add-items","title":"Add items to shipping method","href":"/v3/orders-and-inventory/api-reference/orders/shipping-method-items/add-items-to-shipping-method"},{"openapi":"shipping-methods.openapi post /shipping-methods/{shippingMethodId}/actions/delete-items","title":"Delete items from shipping method","href":"/v3/orders-and-inventory/api-reference/orders/shipping-method-items/delete-items-from-shipping-method"},{"openapi":"shipping-methods.openapi post /shipping-methods/actions/filter-by-item-id","title":"Get shipping methods","href":"/v3/orders-and-inventory/api-reference/orders/shipping-method-items/get-shipping-methods"}]},{"group":"Imports","pages":[{"title":"Getting Started with Imports","href":"/v3/orders-and-inventory/api-reference/orders/imports/overview"},{"openapi":"imports.openapi post /oms-imports","title":"Upload bulk file to import data","href":"/v3/orders-and-inventory/api-reference/orders/imports/upload-bulk-file-to-import-data"},{"openapi":"imports.openapi post /oms-imports/search","title":"Get uploaded files that match specified criteria","href":"/v3/orders-and-inventory/api-reference/orders/imports/get-uploaded-files-that-match-specified-criteria"},{"openapi":"imports.openapi get /oms-imports/{importId}","title":"Get uploaded file status and details","href":"/v3/orders-and-inventory/api-reference/orders/imports/get-uploaded-file-status-and-details"}]},{"group":"Exports","pages":[{"title":"Getting Started with Exports","sidebarTitle":"Overview","href":"/v3/orders-and-inventory/api-reference/orders/exports/overview"},{"openapi":"exports.openapi get /oms-exports/{exportId}","title":"Get export job by exportId","href":"/v3/orders-and-inventory/api-reference/orders/exports/get-export-job-by-exportid"},{"openapi":"exports.openapi post /oms-exports/search","title":"Get export jobs by query","href":"/v3/orders-and-inventory/api-reference/orders/exports/get-export-jobs-by-query"},{"openapi":"exports.openapi post /oms-exports","title":"Export data by query","href":"/v3/orders-and-inventory/api-reference/orders/exports/export-data-by-query"},{"openapi":"exports.openapi get /oms-exports/module-headers/{module}","title":"Get file headers by module","href":"/v3/orders-and-inventory/api-reference/orders/exports/get-file-headers-by-module"}]},{"group":"Orders","pages":[{"title":"Getting Started with Orders","sidebarTitle":"Overview","href":"/v3/orders-and-inventory/api-reference/orders/orders/overview"},{"openapi":"orders.openapi post /orders","title":"Create new order","href":"/v3/orders-and-inventory/api-reference/orders/orders/create-new-order"},{"openapi":"orders.openapi get /orders/order-number/{orderNumber}","title":"Get order by order number","href":"/v3/orders-and-inventory/api-reference/orders/orders/get-order-by-order-number"},{"openapi":"orders.openapi get /orders/{orderId}","title":"Get order by order ID","href":"/v3/orders-and-inventory/api-reference/orders/orders/get-order-by-order-id"},{"openapi":"orders.openapi post /orders/search","title":"Search for Orders","href":"/v3/orders-and-inventory/api-reference/orders/orders/find-orders"},{"openapi":"orders.openapi post /orders/order-number/{orderNumber}/actions/update-attributes","title":"Update Shipping information for an existing order by order number","href":"/v3/orders-and-inventory/api-reference/orders/orders/update-attributes"},{"openapi":"orders.openapi post /orders/{orderIdType}/{orderIdValue}/actions/update-attributes","title":"Update order attributes by order identifier","href":"/v3/orders-and-inventory/api-reference/orders/orders/update-attributes-by-order-id-type"},{"openapi":"orders.openapi post /orders/{orderId}/actions/update-attributes","title":"Update Order Attributes","href":"/v3/orders-and-inventory/api-reference/orders/orders/update-attributes-by-id"},{"openapi":"orders.openapi post /orders/actions/update-customer","title":"Update customer details for given order IDs","href":"/v3/orders-and-inventory/api-reference/orders/orders/update-customer-details-for-given-order-ids"},{"openapi":"orders.openapi put /orders/{orderId}/ship-info/{shipToId}/pickup","title":"Updates order pick-up details","href":"/v3/orders-and-inventory/api-reference/orders/orders/updates-order-pick-up-details"},{"openapi":"orders.openapi post /orders/order-number/{orderNumber}/actions/check-credits-eligibility","title":"Check credits eligibility by order number","href":"/v3/orders-and-inventory/api-reference/orders/orders/check-credit-eligibility"},{"openapi":"orders.openapi post /orders/order-number/{orderNumber}/actions/check-exchange-eligibility","title":"Get order exchange eligibility by order number","href":"/v3/orders-and-inventory/api-reference/orders/orders/check-exchange-eligibility"},{"openapi":"orders.openapi post /orders/order-number/{orderNumber}/actions/check-appeasement-eligibility","title":"Check appeasement eligibility by order number","href":"/v3/orders-and-inventory/api-reference/orders/orders/check-appeasement-eligibility"},{"openapi":"orders.openapi post /orders/{orderId}/actions/check-appeasement-eligibility","title":"Check appeasement eligibility by order ID","href":"/v3/orders-and-inventory/api-reference/orders/orders/check-appeasement-eligibility-by-id"},{"openapi":"orders.openapi put /orders/{orderIdentifierType}/{orderIdentifierValue}/payments/{paymentCounter}/payment-logs","title":"Add a payment log entry for a specific payment","href":"/v3/orders-and-inventory/api-reference/orders/orders/add-payment-log-entry"},{"openapi":"orders.openapi put /orders/{orderIdentifierType}/{orderIdentifierValue}/payments/{paymentCounter}/bill-to-address","title":"Update bill-to address for a specific payment","href":"/v3/orders-and-inventory/api-reference/orders/orders/update-bill-to-address"},{"openapi":"orders.openapi put /orders/{orderIdentifierType}/{orderIdentifierValue}/ship-info/{shipToId}/ship-to-address","title":"Update a ship-to address for a specific shipToId","href":"/v3/orders-and-inventory/api-reference/orders/orders/update-order-status-state"},{"openapi":"orders.openapi post /orders/{orderIdentifierType}/{orderIdentifierValue}/actions/update-status","title":"Update an order’s status with state transition","href":"/v3/orders-and-inventory/api-reference/orders/orders/update-ship-to-address"},{"openapi":"orders.openapi post /orders/{orderIdentifierType}/{orderIdentifierValue}/actions/update-fees-and-taxes","title":"Update order fees and taxes","href":"/v3/orders-and-inventory/api-reference/orders/orders/update-fees-and-taxes"}]},{"group":"Frauds","pages":[{"title":"Getting Started with Frauds","sidebarTitle":"Overview","href":"/v3/orders-and-inventory/api-reference/orders/frauds/overview"},{"openapi":"orders.openapi post /orders/order-number/{orderNumber}/actions/fraud-cancel","title":"Cancel fraud order by order number","href":"/v3/orders-and-inventory/api-reference/orders/frauds/cancel-fraud-order-by-order-number"},{"openapi":"orders.openapi post /orders/{orderId}/actions/fraud-cancel","title":"Cancel fraud order by order ID","href":"/v3/orders-and-inventory/api-reference/orders/frauds/cancel-fraud-order-by-order-id"},{"openapi":"orders.openapi post /orders/{orderId}/actions/fraud-release","title":"Release fraud order by order ID","href":"/v3/orders-and-inventory/api-reference/orders/frauds/release-fraud-order-by-order-id"},{"openapi":"orders.openapi post /orders/order-number/{orderNumber}/actions/fraud-release","title":"Release fraud order","href":"/v3/orders-and-inventory/api-reference/orders/frauds/release-fraud-order"}]},{"group":"Notifications","pages":[{"title":"Getting Started with Notifications","sidebarTitle":"Overview","href":"/v3/orders-and-inventory/api-reference/orders/notifications/overview"},{"openapi":"notifications.openapi post /oms-notifications/acknowledge","title":"Get acknowledgment receipt for notification","href":"/v3/orders-and-inventory/api-reference/orders/notifications/get-acknowledgment-receipt-for-notification"},{"openapi":"notifications.openapi post /oms-notifications/actions/resend","title":"Resend notifications","href":"/v3/orders-and-inventory/api-reference/orders/notifications/resend-notifications"}]},{"group":"Backorders Preorders","pages":[{"title":"Getting Started with Backorders \u0026 Preorders","sidebarTitle":"Overview","href":"/v3/orders-and-inventory/api-reference/orders/backorders-preorders/overview"},{"openapi":"backorders-preorders.openapi post /backorders-preorders/search","title":"Search for backorders or preorders by query","href":"/v3/orders-and-inventory/api-reference/orders/backorders-preorders/search-for-backorders-or-preorders-by-query"},{"openapi":"backorders-preorders.openapi post /backorders-preorders/{id}/actions/save-delay-consent","title":"Record customer agreement to delay shipment","href":"/v3/orders-and-inventory/api-reference/orders/backorders-preorders/record-customer-agreement-to-delay-shipment"},{"openapi":"backorders-preorders.openapi get /backorders-preorders/{id}","title":"Get backorder or preorder details by ID","href":"/v3/orders-and-inventory/api-reference/orders/backorders-preorders/get-backorder-or-preorder-details-by-id"}]},{"group":"Cancellations","pages":[{"title":"Getting Started with Cancellations","sidebarTitle":"Overview","href":"/v3/orders-and-inventory/api-reference/orders/cancellations/overview"},{"openapi":"orders.openapi post /orders/order-number/{orderNumber}/actions/cancel","title":"Cancel order by order number","href":"/v3/orders-and-inventory/api-reference/orders/cancellations/cancel-order-by-order-number"},{"openapi":"orders.openapi post /orders/{orderId}/actions/cancel","title":"Cancel order by order ID","href":"/v3/orders-and-inventory/api-reference/orders/cancellations/cancel-order-by-order-id"},{"openapi":"orders.openapi post /orders/{orderIdType}/{orderIdValue}/actions/cancel","title":"Cancel order by order identifier","href":"/v3/orders-and-inventory/api-reference/orders/cancellations/cancel-by-order-id-type"},{"openapi":"orders.openapi post /orders/{orderId}/actions/check-cancel-eligibility","title":"Get order cancellation eligibility by order ID","href":"/v3/orders-and-inventory/api-reference/orders/cancellations/get-order-cancellation-eligibility-by-order-id"},{"openapi":"orders.openapi post /orders/order-number/{orderNumber}/actions/check-cancel-eligibility","title":"Get order cancellation eligibility by order number","href":"/v3/orders-and-inventory/api-reference/orders/cancellations/get-order-cancellation-eligibility-by-order-number"},{"openapi":"orders.openapi post /orders/{orderIdType}/{orderIdValue}/actions/check-cancel-eligibility","title":"Check order cancellation eligibility by order identifier","href":"/v3/orders-and-inventory/api-reference/orders/cancellations/check-by-order-id-type"}]},{"group":"Allocations","pages":[{"title":"Getting Started with Allocations","sidebarTitle":"Overview","href":"/v3/orders-and-inventory/api-reference/orders/allocations/overview"},{"openapi":"allocations.openapi post /allocations/search","title":"Search for allocations by query","href":"/v3/orders-and-inventory/api-reference/orders/allocations/search-for-allocations-by-query"},{"openapi":"allocations.openapi post /allocations/actions/create-allocations","title":"Create allocations","href":"/v3/orders-and-inventory/api-reference/orders/allocations/create-allocation"},{"openapi":"allocations.openapi get /allocations/{allocationIdType}/{allocationIdValue}","title":"Get allocation by ID type and ID value","href":"/v3/orders-and-inventory/api-reference/orders/allocations/get-by-type-and-id"},{"openapi":"allocations.openapi put /allocations/{allocationIdType}/{allocationIdValue}","title":"Update allocation or initiate reallocation","href":"/v3/orders-and-inventory/api-reference/orders/allocations/update-by-type-and-id"},{"openapi":"allocations.openapi get /allocations/{allocationId}","title":"Get allocation by ID","href":"/v3/orders-and-inventory/api-reference/orders/allocations/get-allocation-by-id"},{"openapi":"allocations.openapi post /allocations/{allocationId}/actions/update-attributes","title":"Update allocation attributes","href":"/v3/orders-and-inventory/api-reference/orders/allocations/update-attributes"},{"openapi":"allocations.openapi post /allocations/{allocationIdType}/{allocationIdValue}/actions/update-status","title":"Update allocation status","href":"/v3/orders-and-inventory/api-reference/orders/allocations/update-status"}]},{"group":"Shipments","pages":[{"title":"Getting Started with Shipments","href":"/v3/orders-and-inventory/api-reference/orders/shipments/overview"},{"openapi":"shipments.openapi post /shipments","title":"Create new shipment","href":"/v3/orders-and-inventory/api-reference/orders/shipments/create-new-shipment"},{"openapi":"shipments.openapi post /shipments/create-order-shipment","title":"Create shipment for an existing order","href":"/v3/orders-and-inventory/api-reference/orders/shipments/create-shipment-from-allocation"},{"openapi":"shipments.openapi get /shipments/{shipmentId}","title":"Get shipment by ID","href":"/v3/orders-and-inventory/api-reference/orders/shipments/get-shipment-by-id"},{"openapi":"shipments.openapi get /shipments/{shipmentIdType}/{shipmentIdValue}","title":"Get shipment by shipmentIdType and shipmentIdValue","href":"/v3/orders-and-inventory/api-reference/orders/shipments/get-shipment-by-type-and-id"},{"openapi":"shipments.openapi post /shipments/{shipmentId}/actions/update-gift-cards-status","title":"Update gift card activation status","href":"/v3/orders-and-inventory/api-reference/orders/shipments/update-gift-card-activation-status"},{"openapi":"shipments.openapi post /shipments/{shipmentId}/acknowledge","title":"Acknowledge shipment","href":"/v3/orders-and-inventory/api-reference/orders/shipments/acknowledge-shipment"},{"openapi":"shipments.openapi post /shipments/search","title":"Find shipments","href":"/v3/orders-and-inventory/api-reference/orders/shipments/find-shipments"},{"openapi":"shipments.openapi post /shipments/actions/re-ship","title":"Create re-shipment","href":"/v3/orders-and-inventory/api-reference/orders/shipments/create-re-shipment"},{"openapi":"shipments.openapi post /shipments/actions/update-tracking","title":"Update shipment tracking","href":"/v3/orders-and-inventory/api-reference/orders/shipments/update-shipment-tracking"}]},{"group":"Inventory Transfers","pages":[{"openapi":"shipments.openapi post /shipments/inventory-transfer","title":null,"href":"/v3/orders-and-inventory/api-reference/orders/inventory-transfer/create-inventory-transfer"},{"openapi":"shipments.openapi get /shipments/inventory-transfer/{transferShipmentId}","title":null,"href":"/v3/orders-and-inventory/api-reference/orders/inventory-transfer/get-inventory-transfer-by-transfershipmentid"},{"openapi":"shipments.openapi post /shipments/inventory-transfer/pack-unpack","title":null,"href":"/v3/orders-and-inventory/api-reference/orders/inventory-transfer/packing-and-unpacking"},{"openapi":"shipments.openapi post /shipments/inventory-transfer/query","title":null,"href":"/v3/orders-and-inventory/api-reference/orders/inventory-transfer/inventory-transfer-query"},{"openapi":"shipments.openapi post /shipments/inventory-transfer/search","title":null,"href":"/v3/orders-and-inventory/api-reference/orders/inventory-transfer/inventory-transfer-search"},{"openapi":"shipments.openapi post /shipments/inventory-transfer/actions/update-tracking","title":null,"href":"/v3/orders-and-inventory/api-reference/orders/inventory-transfer/update-tracking-for-an-inventory-transfer"},{"openapi":"shipments.openapi post /shipments/inventory-transfer/{transferShipmentId}/actions/package-tracking-acknowledge","title":null,"href":"/v3/orders-and-inventory/api-reference/orders/inventory-transfer/package-tracking-acknowledge"},{"openapi":"shipments.openapi post /shipments/inventory-transfer/{transferShipmentId}/action/receiving","title":null,"href":"/v3/orders-and-inventory/api-reference/orders/inventory-transfer/receive-inventory-tracking"},{"openapi":"shipments.openapi post /shipments/inventory-transfer/{transferShipmentId}/action/cancel","title":null,"href":"/v3/orders-and-inventory/api-reference/orders/inventory-transfer/cancel-inventory-transfer"}]},{"group":"Tracking","pages":[{"title":"Getting Started with Tracking","sidebarTitle":"Overview","href":"/v3/orders-and-inventory/api-reference/orders/tracking/overview"},{"openapi":"orders.openapi put /orders/order-number/{orderNumber}/actions/package-tracking-acknowledge","title":"Get acknowledgement for package tracking by order number","href":"/v3/orders-and-inventory/api-reference/orders/tracking/get-acknowledgement-for-package-tracking-by-order-number"},{"openapi":"orders.openapi put /orders/{orderId}/actions/package-tracking-acknowledge","title":"Get package tracking acknowledgement by order ID","href":"/v3/orders-and-inventory/api-reference/orders/tracking/get-package-tracking-acknowledgement-by-order-id"}]},{"group":"Invoices","pages":[{"title":"Getting Started with Invoices","sidebarTitle":"Overview","href":"/v3/orders-and-inventory/api-reference/orders/invoices/overview"},{"openapi":"invoices.openapi post /invoices","title":"Create invoice","href":"/v3/orders-and-inventory/api-reference/orders/invoices/create-invoice"},{"openapi":"invoices.openapi post /invoices/search","title":"Search for invoices","href":"/v3/orders-and-inventory/api-reference/orders/invoices/search-for-invoices"},{"openapi":"invoices.openapi post /invoices/{invoiceId}/acknowledge","title":"Acknowledge financial transaction","href":"/v3/orders-and-inventory/api-reference/orders/invoices/acknowledge-financial-transaction"},{"openapi":"invoices.openapi get /invoices/{invoiceId}","title":"Get invoice by ID","href":"/v3/orders-and-inventory/api-reference/orders/invoices/get-invoice-by-id"},{"openapi":"invoices.openapi put /invoices/{invoiceId}","title":"Update invoice by ID","href":"/v3/orders-and-inventory/api-reference/orders/invoices/update-by-id"},{"openapi":"invoices.openapi get /invoices/{invoiceIdType}/{invoiceIdValue}","title":"Get invoice by Identifier Type and value","href":"/v3/orders-and-inventory/api-reference/orders/invoices/get-by-type-and-id"},{"openapi":"invoices.openapi put /invoices/{invoiceIdType}/{invoiceIdValue}","title":"Update invoice by Identifier Type and value","href":"/v3/orders-and-inventory/api-reference/orders/invoices/update-by-type-and-id"},{"openapi":"invoices.openapi post /invoices/{invoiceIdType}/{invoiceIdValue}/actions/update-attributes","title":"Update invoice attributes","href":"/v3/orders-and-inventory/api-reference/orders/invoices/update-attributes"},{"title":"Update attributes by id","href":"/v3/orders-and-inventory/api-reference/orders/invoices/update-attributes-by-id"}]},{"group":"Payments","pages":[{"title":"Getting Started with Order Payments","sidebarTitle":"Overview","href":"/v3/orders-and-inventory/api-reference/orders/payments/overview"},{"openapi":"orders.openapi post /orders/actions/authorize-payments","title":"Authorize order payments","href":"/v3/orders-and-inventory/api-reference/orders/payments/authorize-payments"},{"openapi":"orders.openapi post /orders/order-number/{orderNumber}/actions/update-payment-status","title":"Update status of order payment by order number","href":"/v3/orders-and-inventory/api-reference/orders/payments/update-status-of-order-payment-by-order-number"},{"openapi":"orders.openapi post /orders/{orderId}/actions/update-payment-status","title":"Update order payment status by order ID","href":"/v3/orders-and-inventory/api-reference/orders/payments/update-order-payment-status-by-order-id"}]},{"group":"Credits","pages":[{"openapi":"orders.openapi post /orders/{orderIdType}/{orderIdValue}/actions/create-credits","title":"Create credits by order identifier","href":"/v3/orders-and-inventory/api-reference/orders/credits/create-by-order-id-type"},{"openapi":"orders.openapi post /orders/{orderId}/actions/create-credits","title":"Create credits by order ID","href":"/v3/orders-and-inventory/api-reference/orders/credits/create-credits-by-order-id"},{"openapi":"orders.openapi post /orders/{orderId}/actions/update-credit-status","title":"Update credits by order ID","href":"/v3/orders-and-inventory/api-reference/orders/credits/update-credits-by-order-id"},{"openapi":"orders.openapi post /orders/{orderIdType}/{orderIdValue}/actions/check-credits-eligibility","title":"Check credits eligibility by order identifier","href":"/v3/orders-and-inventory/api-reference/orders/credits/check-by-order-id-type"},{"openapi":"orders.openapi post /orders/{orderId}/actions/check-credits-eligibility","title":"Check credits eligibility by order ID","href":"/v3/orders-and-inventory/api-reference/orders/credits/check-credits-eligibility-by-order-id"},{"openapi":"orders.openapi post /orders/order-number/{orderNumber}/actions/create-credits","title":"Create credits by order number","href":"/v3/orders-and-inventory/api-reference/orders/credits/create-credits-by-order-number"},{"openapi":"orders.openapi post /orders/{orderIdType}/{orderIdValue}/actions/update-credit-status","title":"Update credit status by order identifier","href":"/v3/orders-and-inventory/api-reference/orders/credits/update-by-order-id-type"},{"openapi":"orders.openapi post /orders/order-number/{orderNumber}/actions/update-credit-status","title":"Update credit status by order number","href":"/v3/orders-and-inventory/api-reference/orders/credits/update-credit-status-by-order-number"}]},{"group":"Appeasements","pages":[{"title":"Getting Started with Appeasements","sidebarTitle":"Overview","href":"/v3/orders-and-inventory/api-reference/orders/appeasements/overview"},{"openapi":"orders.openapi post /orders/{orderIdType}/{orderIdValue}/actions/check-appeasement-eligibility","title":"Check appeasement eligibility by order identifier","href":"/v3/orders-and-inventory/api-reference/orders/appeasements/check-by-order-id-type"},{"openapi":"orders.openapi post /orders/{orderId}/actions/check-appeasement-eligibility","title":"Check appeasement eligibility by order ID","href":"/v3/orders-and-inventory/api-reference/orders/appeasements/check-by-order-id"},{"openapi":"orders.openapi post /orders/order-number/{orderNumber}/actions/check-appeasement-eligibility","title":"Check appeasement eligibility by order number","href":"/v3/orders-and-inventory/api-reference/orders/appeasements/check-eligibility-by-order-number"},{"openapi":"orders.openapi post /orders/{orderIdType}/{orderIdValue}/actions/create-appeasement","title":"Create an appeasement by order identifier","href":"/v3/orders-and-inventory/api-reference/orders/appeasements/create-by-order-id-type"},{"openapi":"orders.openapi post /orders/{orderId}/actions/create-appeasement","title":"Create appeasement by order ID","href":"/v3/orders-and-inventory/api-reference/orders/appeasements/create-appeasement-by-order-id"},{"openapi":"orders.openapi post /orders/order-number/{orderNumber}/actions/create-appeasement","title":"Create appeasement by order number","href":"/v3/orders-and-inventory/api-reference/orders/appeasements/create-appeasement-by-order-number"}]},{"group":"Returns","pages":[{"title":"Getting Started with Returns","sidebarTitle":"Overview","href":"/v3/orders-and-inventory/api-reference/orders/returns/overview"},{"openapi":"orders.openapi post /orders/order-number/{orderNumber}/actions/check-return-eligibility","title":"Get return eligibility by order number","href":"/v3/orders-and-inventory/api-reference/orders/returns/get-return-eligibility-by-order-number"},{"openapi":"orders.openapi post /orders/{orderId}/actions/check-exchange-eligibility","title":"Get order exchange eligibility by order ID","href":"/v3/orders-and-inventory/api-reference/orders/returns/get-order-exchange-eligibility-by-order-id"},{"openapi":"orders.openapi post /orders/{orderIdType}/{orderIdValue}/actions/check-exchange-eligibility","title":"Check order exchange eligibility by order identifier","href":"/v3/orders-and-inventory/api-reference/orders/returns/check-exchange-eligibility-by-order-id-type"},{"openapi":"orders.openapi post /orders/{orderIdType}/{orderIdValue}/actions/check-return-eligibility","title":"Check return eligibility by order identifier","href":"/v3/orders-and-inventory/api-reference/orders/returns/check-return-eligibility-by-order-id-type"},{"openapi":"orders.openapi post /orders/{orderIdType}/{orderIdValue}/actions/submit-return-request","title":"Submit return request by order identifier","href":"/v3/orders-and-inventory/api-reference/orders/returns/submit-return-by-order-id-type"},{"openapi":"orders.openapi post /orders/{orderId}/actions/submit-return-request","title":"Order return by order ID","href":"/v3/orders-and-inventory/api-reference/orders/returns/order-return-by-order-id"},{"openapi":"orders.openapi post /orders/{orderId}/actions/check-return-eligibility","title":"Get eligibility of returns for items in an order by order ID","href":"/v3/orders-and-inventory/api-reference/orders/returns/get-eligibility-of-returns-for-items-in-an-order-by-order-id"},{"openapi":"orders.openapi post /orders/order-number/{orderNumber}/actions/submit-return-request","title":"Order return by order number","href":"/v3/orders-and-inventory/api-reference/orders/returns/order-return-by-order-number"},{"openapi":"orders.openapi post /orders/order-number/{orderNumber}/actions/check-exchange-eligibility","title":"Get order exchange eligibility by order number","href":"/v3/orders-and-inventory/api-reference/orders/returns/get-order-exchange-eligibility-by-order-number"}]}]},{"group":"Inventory API Endpoints","pages":[{"title":"Inventory (3.0.0)","href":"/v3/orders-and-inventory/api-reference/inventory/inventory--3-0-0"},{"title":"Inventory FAQ","href":"/v3/orders-and-inventory/api-reference/inventory/inventory-faq-s"},{"group":"Imports","pages":[{"openapi":"inventory.openapi post /inventory-imports","title":"Import inventory data","href":"/v3/orders-and-inventory/api-reference/inventory/imports/import-inventory"},{"openapi":"inventory.openapi post /inventory-imports/search","title":"Get uploaded files that match specified criteria","href":"/v3/orders-and-inventory/api-reference/inventory/imports/get-uploaded-files"},{"openapi":"inventory.openapi get /inventory-imports/{importId}","title":"Get uploaded file status and details","href":"/v3/orders-and-inventory/api-reference/inventory/imports/get-file-status-by-id"},{"openapi":"inventory.openapi post /inventory-imports/{importId}/actions/force-trigger","title":"Force import halt","href":"/v3/orders-and-inventory/api-reference/inventory/imports/force-trigger"},{"openapi":"inventory.openapi post /inventory-import-configs","title":"Create an inventory import file configuration","href":"/v3/orders-and-inventory/api-reference/inventory/imports/create-import-configs"},{"openapi":"inventory.openapi get /inventory-import-configs","title":"Get all file configurations","href":"/v3/orders-and-inventory/api-reference/inventory/imports/get-import-configuration"},{"openapi":"inventory.openapi get /inventory-import-configs/{id}","title":"Get inventory import upload file configuration","href":"/v3/orders-and-inventory/api-reference/inventory/imports/get-import-config-by-id"},{"openapi":"inventory.openapi put /inventory-import-configs/{id}","title":"Update inventory import file configuration","href":"/v3/orders-and-inventory/api-reference/inventory/imports/update-import-config-by-id"},{"openapi":"inventory.openapi delete /inventory-import-configs/{id}","title":"Delete inventory import file config","href":"/v3/orders-and-inventory/api-reference/inventory/imports/delete-an-import-config-by-id"}]},{"group":"Counters","pages":[{"title":"Getting Started with Counters","sidebarTitle":"Overview","href":"/v3/orders-and-inventory/api-reference/inventory/counters/overview"},{"openapi":"inventory.openapi put /inventory-counters/{counterCode}","title":"Update counter by code","href":"/v3/orders-and-inventory/api-reference/inventory/counters/update-counter-by-code"},{"openapi":"inventory.openapi get /inventory-counters/{counterCode}","title":"Get counter by code","href":"/v3/orders-and-inventory/api-reference/inventory/counters/get-counter-by-code"},{"openapi":"inventory.openapi post /inventory-counters","title":"Create counter","href":"/v3/orders-and-inventory/api-reference/inventory/counters/create-counter"},{"openapi":"inventory.openapi get /inventory-counters","title":"Get all counters","href":"/v3/orders-and-inventory/api-reference/inventory/counters/get-all-counters"}]},{"group":"Inventory","pages":[{"title":"Getting Started with Inventory","sidebarTitle":"Overview","href":"/v3/orders-and-inventory/api-reference/inventory/inventory/overview"},{"openapi":"inventory.openapi post /inventories/actions/find-and-update","title":"Update inventory by adding new property","href":"/v3/orders-and-inventory/api-reference/inventory/inventory/update-inventory-by-adding-new-property"},{"openapi":"inventory.openapi post /inventories/actions/find","title":"Find inventories of specific items","href":"/v3/orders-and-inventory/api-reference/inventory/inventory/find-inventories-of-specific-items"},{"openapi":"inventory.openapi post /inventories/search","title":"Search for inventories","href":"/v3/orders-and-inventory/api-reference/inventory/inventory/search-for-inventories"},{"openapi":"inventory.openapi post /inventories/actions/find-and-adjust-inventory-counters","title":"Adjust inventory counters","href":"/v3/orders-and-inventory/api-reference/inventory/inventory/adjust-inventory-counters"},{"openapi":"inventory.openapi post /inventories","title":"Create inventory","href":"/v3/orders-and-inventory/api-reference/inventory/inventory/create-inventory"},{"openapi":"inventory.openapi post /inventories/actions/find-by-geography","title":"Find inventory of specific items in a specific region","href":"/v3/orders-and-inventory/api-reference/inventory/inventory/find-inventory-of-specific-items-in-a-specific-region"}]},{"group":"Locations","pages":[{"title":"Getting Started with Locations","href":"/v3/orders-and-inventory/api-reference/inventory/locations/overview"},{"openapi":"locations.openapi post /locations/geography-search","title":"Search Nearby Locations","href":"/v3/orders-and-inventory/api-reference/inventory/locations/search-for-nearby-locations"},{"openapi":"locations.openapi post /locations","title":"Create a location","href":"/v3/orders-and-inventory/api-reference/inventory/locations/create-a-location"},{"openapi":"locations.openapi put /locations/{locationNumber}","title":"Update a specific location","href":"/v3/orders-and-inventory/api-reference/inventory/locations/update-a-specific-location"},{"openapi":"locations.openapi delete /locations/{locationNumber}","title":"Delete a location","href":"/v3/orders-and-inventory/api-reference/inventory/locations/delete-a-location"},{"openapi":"locations.openapi get /locations/{locationNumber}","title":"Get a specific location","href":"/v3/orders-and-inventory/api-reference/inventory/locations/get-a-specific-location"},{"openapi":"locations.openapi post /locations/search","title":"Get locations by query","href":"/v3/orders-and-inventory/api-reference/inventory/locations/get-locations-by-query"},{"group":"Location Outages","pages":[{"openapi":"locations.openapi post /location-outages","title":"Create Outage","href":"/v3/orders-and-inventory/api-reference/inventory/locations/create-location-outage"},{"openapi":"locations.openapi post /location-outages/search","title":"Get LocationOutages by query","href":"/v3/orders-and-inventory/api-reference/inventory/locations/find-location-outage"},{"openapi":"locations.openapi put /location-outages/outage-number/{outageNumber}","title":"Update a specific location outage","href":"/v3/orders-and-inventory/api-reference/inventory/locations/update-outage-by-outage-number"},{"openapi":"locations.openapi post /location-outages/outage-number/{outageNumber}/actions/cancel","title":"Cancel outage using outageNumber","href":"/v3/orders-and-inventory/api-reference/inventory/locations/cancel-outage-by-outage-number"},{"openapi":"locations.openapi put /location-outages/{outageId}","title":"Update a specific location outage","href":"/v3/orders-and-inventory/api-reference/inventory/locations/update-outage-by-outageid"},{"openapi":"locations.openapi post /location-outages/{outageId}/actions/cancel","title":"Cancel outage","href":"/v3/orders-and-inventory/api-reference/inventory/locations/cancel-outage-by-outageid"}]},{"group":"Location Capacity","pages":[{"openapi":"locations.openapi post /location-capacity/search","title":"Search Overrides","href":"/v3/orders-and-inventory/api-reference/inventory/locations/capacity/search"},{"openapi":"locations.openapi post /location-capacity","title":"Create Override","href":"/v3/orders-and-inventory/api-reference/inventory/locations/capacity/create"},{"openapi":"locations.openapi post /location-capacity/actions/bulk-create","title":"Bulk Create Overrides","href":"/v3/orders-and-inventory/api-reference/inventory/locations/capacity/bulk-create"},{"openapi":"locations.openapi put /location-capacity/{capacityOverrideId}","title":"Update Override","href":"/v3/orders-and-inventory/api-reference/inventory/locations/capacity/update"},{"openapi":"locations.openapi post /location-capacity/{capacityOverrideId}/actions/cancel","title":"Cancel Override","href":"/v3/orders-and-inventory/api-reference/inventory/locations/capacity/cancel"}]},{"group":"Location Geography","pages":[{"openapi":"locations.openapi post /location-geographies","title":"Create Geography","href":"/v3/orders-and-inventory/api-reference/inventory/locations/geography/create"},{"openapi":"locations.openapi get /location-geographies/{geographyId}","title":"Get Geography by ID","href":"/v3/orders-and-inventory/api-reference/inventory/locations/geography/get-by-id"},{"openapi":"locations.openapi get /location-geographies/geography-name/{geographyName}","title":"Get Geography by Name","href":"/v3/orders-and-inventory/api-reference/inventory/locations/geography/get-by-name"},{"openapi":"locations.openapi post /location-geographies/search","title":"Search Geographies","href":"/v3/orders-and-inventory/api-reference/inventory/locations/geography/search"},{"openapi":"locations.openapi post /location-geographies/actions/find-shipping-zone","title":"Find Shipping Zone","href":"/v3/orders-and-inventory/api-reference/inventory/locations/geography/find-zone"},{"openapi":"locations.openapi put /location-geographies/{geographyId}","title":"Update Geography by ID","href":"/v3/orders-and-inventory/api-reference/inventory/locations/geography/update-by-id"},{"openapi":"locations.openapi put /location-geographies/geography-name/{geographyName}","title":"Update Geography by Name","href":"/v3/orders-and-inventory/api-reference/inventory/locations/geography/update-by-name"},{"openapi":"locations.openapi delete /location-geographies/{geographyId}","title":"Delete Geography by ID","href":"/v3/orders-and-inventory/api-reference/inventory/locations/geography/delete-by-id"},{"openapi":"locations.openapi delete /location-geographies/geography-name/{geographyName}","title":"Delete Geography by Name","href":"/v3/orders-and-inventory/api-reference/inventory/locations/geography/delete-by-name"}]},{"group":"Location Zones","pages":[{"openapi":"locations.openapi post /location-zones","title":"Create Zone","href":"/v3/orders-and-inventory/api-reference/inventory/locations/zone/create"},{"openapi":"locations.openapi post /location-zones/search","title":"Search Zones","href":"/v3/orders-and-inventory/api-reference/inventory/locations/zone/get-all-zones"},{"openapi":"locations.openapi get /location-zones/{zoneId}","title":"Get Zone by ID","href":"/v3/orders-and-inventory/api-reference/inventory/locations/zone/get-by-id"},{"openapi":"locations.openapi get /location-zones/zone-name/{zoneName}","title":"Get Zone by Name","href":"/v3/orders-and-inventory/api-reference/inventory/locations/zone/get-by-name"},{"openapi":"locations.openapi put /location-zones/{zoneId}","title":"Update Zone by ID","href":"/v3/orders-and-inventory/api-reference/inventory/locations/zone/update-by-id"},{"openapi":"locations.openapi put /location-zones/zone-name/{zoneName}","title":"Update Zone by Name","href":"/v3/orders-and-inventory/api-reference/inventory/locations/zone/update-by-name"},{"openapi":"locations.openapi delete /location-zones/{zoneId}","title":"Delete Zone by ID","href":"/v3/orders-and-inventory/api-reference/inventory/locations/zone/delete-by-id"},{"openapi":"locations.openapi delete /location-zones/zone-name/{zoneName}","title":"Delete Zone by Name","href":"/v3/orders-and-inventory/api-reference/inventory/locations/zone/delete-by-name"}]}]},{"group":"Networks","pages":[{"openapi":"inventory.openapi get /inventory-networks","title":"Get all networks","href":"/v3/orders-and-inventory/api-reference/inventory/networks/get-all-networks"},{"openapi":"inventory.openapi put /inventory-networks/{networkCode}","title":"Update network by code","href":"/v3/orders-and-inventory/api-reference/inventory/networks/update-network-by-code"},{"openapi":"inventory.openapi get /inventory-networks/{networkCode}","title":"Get network by code","href":"/v3/orders-and-inventory/api-reference/inventory/networks/get-network-by-code"},{"openapi":"inventory.openapi post /inventory-networks","title":"Create inventory network","href":"/v3/orders-and-inventory/api-reference/inventory/networks/create-inventory-network"},{"openapi":"inventory.openapi delete /inventory-networks/{networkCode}","title":"Delete network by code","href":"/v3/orders-and-inventory/api-reference/inventory/networks/delete-network-by-code"},{"openapi":"inventory.openapi post /inventories/actions/hard-reserve-search","title":"Search for inventory hard reservations","href":"/v3/orders-and-inventory/api-reference/inventory/networks/search-hard-reserve"},{"openapi":"inventory.openapi post /inventory-networks/actions/soft-release","title":"Release soft reservation","description":"Release soft reservation.","href":"/v3/orders-and-inventory/api-reference/inventory/networks/soft-release"},{"openapi":"inventory.openapi post /inventory-networks/actions/soft-reserve","title":"Soft reservation","href":"/v3/orders-and-inventory/api-reference/inventory/networks/soft-reserve"}]}]}]},{"tab":"Product Catalog","pages":[{"title":"Product Catalog","href":"/v3/product-catalog/getting-started"}]},{"tab":"Offers","pages":[{"title":"Offers","href":"/v3/offers/user-guides/offers/overview"}]},{"tab":"Dropship","pages":[{"title":"Dropship","href":"/v3/dropship/homepage"}]},{"tab":"Cart \u0026 Checkout","pages":[{"title":"Cart \u0026 Checkout","href":"/v3/cart-and-checkout/api-reference/carts-v3/overview"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/v3/integrations/overview"}]},{"tab":"Platform","pages":[{"title":"Platform","href":"/v3/platform/home/alerts/alerts-overview"}]},{"tab":"Store Fulfillment","pages":[{"title":"Store Fulfillment","href":"/v3/store-fulfillment/updating-store-location"}]},{"tab":"Release Notes","pages":[{"title":"Release Notes","href":"/v3/release-notes/july2025/release-summary"}]}]},{"version":"v2","pages":[{"title":"v2","href":"/v2/home"}]}]},"title":"Soft reservation - 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"]}