{"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":"6ae91effb06fa73e673c75b6:success","clientVersion":"0.0.4074","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":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","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}\nhtml,body,h1,h2,h3,h4,h5,h6,p,span,a{font-family:Poppins}#navbar{background:#000000}#navbar .bg-background-light{background:#000000}#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:none}#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:#000000;box-shadow:0px 7.57px 30.28px 0px rgba(0, 0, 0, 0.08);border:none}#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:-0.084px}.bodyContainer{max-width:63rem;margin:auto;background:transparent}.bodyFull{background:url(\"images/hero-background-unmasked-1.svg\");position:relative;overflow:hidden}.bodyFull:is(.dark *),.bodyContainer:is(.dark *){background-color:transparent}.box-full{border-radius:8px;box-shadow:0px 7.57px 30.28px 0px rgba(0, 0, 0, 0.08);padding:16px 20px}.box-full:is(.dark *){background-color:#4d354d;border:1px solid rgba(255, 255, 255, 0.20)}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 *){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:is(.dark *),.twocol-cntr.dark\\:bg-background-dark:is(.dark *){background-color:#0c0a0f!important;z-index:-1;border-radius:15px}.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:-0.2px}.subtitle{text-align:center;font-size:20px;font-style:normal;font-weight:400;line-height:28px;letter-spacing:0.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:rgb(227, 223, 226)}.bodyContainer:is(.dark *) hr{border-color:#27272A}.col-lg-6{width:50%}.footer{padding-bottom:2.5rem;display:flex;background:transparent}.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:-0.084px;margin-top:12px}.footer li a{color:#ff2ec1}.footer .updated.col-lg-6{display:flex;justify-content:flex-end}.fa-thin.fa-question-circle{mask-image:url(\n \"https://mintlify.b-cdn.net/v6.6.0/regular/question.svg\");mask-repeat:no-repeat;mask-position:center center}.fa-thin.fa-headphones{mask-image:url(\n \"https://mintlify.b-cdn.net/v6.6.0/regular/headphones.svg\");mask-repeat:no-repeat;mask-position:center center}.fa-thin.fa-list{mask-image:url(\n \"https://mintlify.b-cdn.net/v6.6.0/regular/list.svg\");mask-repeat:no-repeat;mask-position:center center}.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 0.5);background-color:rgba(255 46 193 0.3)}"}],"page":{"pagePath":"v2/api-reference/dropship/connections/get-connections-of-a-single-vendor","slug":"/v2/api-reference/dropship/connections/get-connections-of-a-single-vendor","pageMetadata":{"openapi":"marketplace get /v1/retailers/{retailer_pk}/connections/{id}/","title":"Get connections of a single vendor","description":"Gets the connection details for a specified vendor","href":"/v2/api-reference/dropship/connections/get-connections-of-a-single-vendor"},"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: \"Gets the connection details for a specified vendor\"\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":"marketplace get /v1/retailers/{retailer_pk}/connections/{id}/","title":"Get connections of a single vendor","description":"Gets the connection details for a specified vendor","href":"/v2/api-reference/dropship/connections/get-connections-of-a-single-vendor"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/fabric-demo/6a81ae5b5ebc4bb2/theme.js","/_mintlify/custom/fabric-demo/aebbe2ead0ce64f7/top-form.v1.js","/_mintlify/custom/fabric-demo/5b243c7a49e8f495/gtag.js"],"openApiReferenceData":{"operation":{"tags":["Connections"],"summary":"Get connections of a single vendor","description":"Gets the connection details for a specified vendor","operationId":"v1_retailers_connections_read","parameters":["9319bf06-b614-496e-a6ef-f2f94c27c244","4a17f671-e06f-45a1-ac64-926df68bee50"],"responses":{"200":"59ca0636-04f2-469e-8554-38a958d2f600"},"method":"get","type":"path","servers":["7287f2df-565c-45a0-aace-9e7362b555ba"],"security":["331444f0-6a57-45ef-b23c-4377664f6c27"],"path":"/v1/retailers/{retailer_pk}/connections/{id}/","baseUrlOptions":["https://marketplace-api.fabric.inc"],"title":"Get connections of a single vendor","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"9319bf06-b614-496e-a6ef-f2f94c27c244":{"name":"id","in":"path","description":"Connection ID","required":true,"schema":{"type":"integer","isRequired":true,"description":"Connection ID","uniqueKey":"","typeLabel":"integer"},"example":11001},"4a17f671-e06f-45a1-ac64-926df68bee50":{"name":"retailer_pk","in":"path","required":true,"description":"Retailer ID","schema":{"type":"number","isRequired":true,"description":"Retailer ID","uniqueKey":"","typeLabel":"number"},"example":1000}},"responses":{"59ca0636-04f2-469e-8554-38a958d2f600":{"description":"OK","content":{"application/json":{"schema":{"required":["brand","connection_credentials"],"type":"object","properties":{"brand":{"required":["code"],"type":"object","properties":{"code":{"description":"Vendor contact code","example":"vendor_abc","maxLength":64,"minLength":1,"pattern":"^[-a-zA-Z0-9_]+$","type":"string","format":"slug","isRequired":true,"uniqueKey":"brand.code","typeLabel":"string\u003cslug>"},"id":{"description":"ID of vendor (or brand) contact","example":5424,"type":"integer","readOnly":true,"uniqueKey":"brand.id","typeLabel":"integer"},"name":{"description":"Vendor contact name","example":"Vendor ABC","maxLength":64,"minLength":1,"type":"string","uniqueKey":"brand.name","typeLabel":"string"},"logo_url":{"description":"URL of vendor logo","example":"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"brand.logo_url","typeLabel":"string\u003curi>"},"cover_url":{"description":"URL of the vendor cover","example":"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"brand.cover_url","typeLabel":"string\u003curi>"},"profile_tile_url":{"description":"URL of the vendor profile image","example":"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"brand.profile_tile_url","typeLabel":"string\u003curi>"},"uuid":{"description":"Universally unique identifier (UUID) ","example":"54a947ea-19db-4563-8447-1bb2f113c127","maxLength":36,"type":"string","uniqueKey":"brand.uuid","typeLabel":"string"},"joined_at":{"description":"Time of vendor joining the platform (UTC format)","example":"2021-09-10T15:24:56Z","type":"string","format":"date-time","readOnly":true,"uniqueKey":"brand.joined_at","typeLabel":"string\u003cdate-time>"},"default_ship_from_location":{"required":["nickname"],"type":"object","properties":{"nickname":{"description":"Location nickname","example":"Sample Location","maxLength":64,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"brand.default_ship_from_location.nickname","typeLabel":"string"},"id":{"description":"Location ID","example":87574,"type":"integer","readOnly":true,"uniqueKey":"brand.default_ship_from_location.id","typeLabel":"integer"},"type":{"description":"Location type","example":"warehouse","type":"string","enum":["warehouse","store","headquarters","billing","return_center","ship_to"],"uniqueKey":"brand.default_ship_from_location.type","typeLabel":"enum\u003cstring>"},"address":{"description":"Location address","example":null,"type":"string","readOnly":true,"uniqueKey":"brand.default_ship_from_location.address","typeLabel":"string"}},"uniqueKey":"brand.default_ship_from_location","typeLabel":"object"},"connections_manager":{"type":"object","properties":{"id":{"description":"User ID","example":355,"type":"integer","readOnly":true,"uniqueKey":"brand.connections_manager.id","typeLabel":"integer"},"first_name":{"oneOf":[{"description":"First name of user","example":"Demo","maxLength":64,"type":"string","uniqueKey":"brand.connections_manager.first_name.oneOf.0","typeLabel":"string"},{"description":"First name of user","example":"Demo","maxLength":64,"type":"null","uniqueKey":"brand.connections_manager.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"brand.connections_manager.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"description":"Last name of user","example":"Sample","maxLength":64,"type":"string","uniqueKey":"brand.connections_manager.last_name.oneOf.0","typeLabel":"string"},{"description":"Last name of user","example":"Sample","maxLength":64,"type":"null","uniqueKey":"brand.connections_manager.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"brand.connections_manager.last_name","typeLabel":"string | null"},"email":{"oneOf":[{"description":"Email address of user","example":"demo.sample@gmail.com","maxLength":128,"type":"string","format":"email","uniqueKey":"brand.connections_manager.email.oneOf.0","typeLabel":"string\u003cemail>"},{"description":"Email address of user","example":"demo.sample@gmail.com","maxLength":128,"type":"null","format":"email","uniqueKey":"brand.connections_manager.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"brand.connections_manager.email","typeLabel":"string\u003cemail> | null"},"title":{"oneOf":[{"description":"Title of the user","example":"Dr","maxLength":64,"type":"string","uniqueKey":"brand.connections_manager.title.oneOf.0","typeLabel":"string"},{"description":"Title of the user","example":"Dr","maxLength":64,"type":"null","uniqueKey":"brand.connections_manager.title.oneOf.1","typeLabel":"null"}],"uniqueKey":"brand.connections_manager.title","typeLabel":"string | null"},"phone":{"oneOf":[{"description":"Contact number of user","example":"1234567890","maxLength":16,"type":"string","uniqueKey":"brand.connections_manager.phone.oneOf.0","typeLabel":"string"},{"description":"Contact number of user","example":"1234567890","maxLength":16,"type":"null","uniqueKey":"brand.connections_manager.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"brand.connections_manager.phone","typeLabel":"string | null"},"status":{"description":"Status of user","example":"active","type":"string","enum":["active","invited","locked"],"uniqueKey":"brand.connections_manager.status","typeLabel":"enum\u003cstring>"},"type":{"description":"User type","example":"standard","type":"string","enum":["standard","api"],"uniqueKey":"brand.connections_manager.type","typeLabel":"enum\u003cstring>"},"photo_url":{"description":"URL of user image","example":"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"brand.connections_manager.photo_url","typeLabel":"string\u003curi>"},"profile_photo":{"description":"URL of profile image","example":"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"brand.connections_manager.profile_photo","typeLabel":"string\u003curi>"},"is_me":{"description":"true: logged in user is me \u003cbr /> logged in user is not me","example":true,"type":"boolean","readOnly":true,"uniqueKey":"brand.connections_manager.is_me","typeLabel":"boolean"}},"uniqueKey":"brand.connections_manager","typeLabel":"object"},"merchandising_manager":{"type":"object","properties":{"id":{"description":"User ID","example":355,"type":"integer","readOnly":true,"uniqueKey":"brand.merchandising_manager.id","typeLabel":"integer"},"first_name":{"oneOf":[{"description":"First name of user","example":"Demo","maxLength":64,"type":"string","uniqueKey":"brand.merchandising_manager.first_name.oneOf.0","typeLabel":"string"},{"description":"First name of user","example":"Demo","maxLength":64,"type":"null","uniqueKey":"brand.merchandising_manager.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"brand.merchandising_manager.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"description":"Last name of user","example":"Sample","maxLength":64,"type":"string","uniqueKey":"brand.merchandising_manager.last_name.oneOf.0","typeLabel":"string"},{"description":"Last name of user","example":"Sample","maxLength":64,"type":"null","uniqueKey":"brand.merchandising_manager.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"brand.merchandising_manager.last_name","typeLabel":"string | null"},"email":{"oneOf":[{"description":"Email address of user","example":"demo.sample@gmail.com","maxLength":128,"type":"string","format":"email","uniqueKey":"brand.merchandising_manager.email.oneOf.0","typeLabel":"string\u003cemail>"},{"description":"Email address of user","example":"demo.sample@gmail.com","maxLength":128,"type":"null","format":"email","uniqueKey":"brand.merchandising_manager.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"brand.merchandising_manager.email","typeLabel":"string\u003cemail> | null"},"title":{"oneOf":[{"description":"Title of the user","example":"Dr","maxLength":64,"type":"string","uniqueKey":"brand.merchandising_manager.title.oneOf.0","typeLabel":"string"},{"description":"Title of the user","example":"Dr","maxLength":64,"type":"null","uniqueKey":"brand.merchandising_manager.title.oneOf.1","typeLabel":"null"}],"uniqueKey":"brand.merchandising_manager.title","typeLabel":"string | null"},"phone":{"oneOf":[{"description":"Contact number of user","example":"1234567890","maxLength":16,"type":"string","uniqueKey":"brand.merchandising_manager.phone.oneOf.0","typeLabel":"string"},{"description":"Contact number of user","example":"1234567890","maxLength":16,"type":"null","uniqueKey":"brand.merchandising_manager.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"brand.merchandising_manager.phone","typeLabel":"string | null"},"status":{"description":"Status of user","example":"active","type":"string","enum":["active","invited","locked"],"uniqueKey":"brand.merchandising_manager.status","typeLabel":"enum\u003cstring>"},"type":{"description":"User type","example":"standard","type":"string","enum":["standard","api"],"uniqueKey":"brand.merchandising_manager.type","typeLabel":"enum\u003cstring>"},"photo_url":{"description":"URL of user image","example":"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"brand.merchandising_manager.photo_url","typeLabel":"string\u003curi>"},"profile_photo":{"description":"URL of profile image","example":"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"brand.merchandising_manager.profile_photo","typeLabel":"string\u003curi>"},"is_me":{"description":"true: logged in user is me \u003cbr /> logged in user is not me","example":true,"type":"boolean","readOnly":true,"uniqueKey":"brand.merchandising_manager.is_me","typeLabel":"boolean"}},"uniqueKey":"brand.merchandising_manager","typeLabel":"object"},"shipping_manager":{"type":"object","properties":{"id":{"description":"User ID who accepted or rejected the invoice","example":542,"type":"integer","readOnly":true,"uniqueKey":"brand.shipping_manager.id","typeLabel":"integer"},"first_name":{"oneOf":[{"description":"First name of user","example":"Sample","maxLength":64,"type":"string","uniqueKey":"brand.shipping_manager.first_name.oneOf.0","typeLabel":"string"},{"description":"First name of user","example":"Sample","maxLength":64,"type":"null","uniqueKey":"brand.shipping_manager.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"brand.shipping_manager.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"description":"Last name of user","example":"Demo","maxLength":64,"type":"string","uniqueKey":"brand.shipping_manager.last_name.oneOf.0","typeLabel":"string"},{"description":"Last name of user","example":"Demo","maxLength":64,"type":"null","uniqueKey":"brand.shipping_manager.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"brand.shipping_manager.last_name","typeLabel":"string | null"},"title":{"oneOf":[{"description":"User title","example":"Demo","maxLength":64,"type":"string","uniqueKey":"brand.shipping_manager.title.oneOf.0","typeLabel":"string"},{"description":"User title","example":"Demo","maxLength":64,"type":"null","uniqueKey":"brand.shipping_manager.title.oneOf.1","typeLabel":"null"}],"uniqueKey":"brand.shipping_manager.title","typeLabel":"string | null"},"status":{"description":"User status","example":"Active","type":"string","enum":["active","invited","locked"],"uniqueKey":"brand.shipping_manager.status","typeLabel":"enum\u003cstring>"},"type":{"description":"User type","example":"standard","type":"string","enum":["standard","api"],"uniqueKey":"brand.shipping_manager.type","typeLabel":"enum\u003cstring>"},"photo_url":{"description":"URL of the user photo","example":"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"brand.shipping_manager.photo_url","typeLabel":"string\u003curi>"},"profile_photo":{"description":"URL of the user's profile photo","example":"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"brand.shipping_manager.profile_photo","typeLabel":"string\u003curi>"},"is_me":{"description":"true: user is me: \u003cbr /> false: user is not me","example":true,"type":"boolean","readOnly":true,"uniqueKey":"brand.shipping_manager.is_me","typeLabel":"boolean"}},"uniqueKey":"brand.shipping_manager","typeLabel":"object"},"preferences":{"type":"array","readOnly":true,"items":{"required":["code","content_type","name","type"],"type":"object","properties":{"name":{"description":"Preference name","example":"Currency","maxLength":64,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"brand.preferences.items.[INDEX].name","typeLabel":"string"},"code":{"description":"Preference code","example":"currency","maxLength":64,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"brand.preferences.items.[INDEX].code","typeLabel":"string"},"type":{"description":"Preference type","example":"freeform","type":"string","enum":["boolean","link","options","freeform","integer","decimal"],"isRequired":true,"uniqueKey":"brand.preferences.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"content_type":{"description":"Content type","example":null,"type":"integer","isRequired":true,"uniqueKey":"brand.preferences.items.[INDEX].content_type","typeLabel":"integer"},"id":{"description":"Preference ID","example":901,"type":"integer","readOnly":true,"uniqueKey":"brand.preferences.items.[INDEX].id","typeLabel":"integer"},"grouping":{"description":"Grouping preference","example":"Orders","type":"string","enum":["locale","misc","onboarding","orders","proposals","products"],"uniqueKey":"brand.preferences.items.[INDEX].grouping","typeLabel":"enum\u003cstring>"},"priority":{"description":"Preference priority","example":5,"maximum":4294967295,"minimum":0,"type":"integer","uniqueKey":"brand.preferences.items.[INDEX].priority","typeLabel":"integer"},"description":{"description":"Preference description","example":"Sample description for demo preference","type":"string","uniqueKey":"brand.preferences.items.[INDEX].description","typeLabel":"string"},"default_option":{"required":["code","name"],"type":"object","properties":{"name":{"description":"Preference option name","example":"Sample Prefs","maxLength":32,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"brand.preferences.items.[INDEX].default_option.name","typeLabel":"string"},"code":{"description":"Preference option code","example":"sample_prefs","maxLength":32,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"brand.preferences.items.[INDEX].default_option.code","typeLabel":"string"},"id":{"description":"Preference option ID","example":234,"type":"integer","readOnly":true,"uniqueKey":"brand.preferences.items.[INDEX].default_option.id","typeLabel":"integer"},"value":{"oneOf":[{"description":"Preference option value","maxLength":256,"type":"string","uniqueKey":"brand.preferences.items.[INDEX].default_option.value.oneOf.0","typeLabel":"string"},{"description":"Preference option value","maxLength":256,"type":"null","uniqueKey":"brand.preferences.items.[INDEX].default_option.value.oneOf.1","typeLabel":"null"}],"uniqueKey":"brand.preferences.items.[INDEX].default_option.value","typeLabel":"string | null"},"currency":{"type":"object","properties":{"id":{"description":"Currency ID","example":1,"type":"integer","readOnly":true,"uniqueKey":"brand.preferences.items.[INDEX].default_option.currency.id","typeLabel":"integer"},"name":{"description":"Currency name","example":"United States Dollar","maxLength":200,"type":"string","uniqueKey":"brand.preferences.items.[INDEX].default_option.currency.name","typeLabel":"string"},"symbol":{"oneOf":[{"description":"Currency symbol","example":"$","maxLength":5,"type":"string","uniqueKey":"brand.preferences.items.[INDEX].default_option.currency.symbol.oneOf.0","typeLabel":"string"},{"description":"Currency symbol","example":"$","maxLength":5,"type":"null","uniqueKey":"brand.preferences.items.[INDEX].default_option.currency.symbol.oneOf.1","typeLabel":"null"}],"uniqueKey":"brand.preferences.items.[INDEX].default_option.currency.symbol","typeLabel":"string | null"},"unit":{"description":"Currency unit","example":"USD","type":"string","readOnly":true,"uniqueKey":"brand.preferences.items.[INDEX].default_option.currency.unit","typeLabel":"string"}},"uniqueKey":"brand.preferences.items.[INDEX].default_option.currency","typeLabel":"object"},"timezone":{"required":["code","name"],"type":"object","properties":{"name":{"description":"Timezone name","example":"Demo","maxLength":32,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"brand.preferences.items.[INDEX].default_option.timezone.name","typeLabel":"string"},"code":{"description":"Timezone code","example":"demo","maxLength":32,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"brand.preferences.items.[INDEX].default_option.timezone.code","typeLabel":"string"},"id":{"description":"Timezone ID","example":7567,"type":"integer","readOnly":true,"uniqueKey":"brand.preferences.items.[INDEX].default_option.timezone.id","typeLabel":"integer"}},"uniqueKey":"brand.preferences.items.[INDEX].default_option.timezone","typeLabel":"object"}},"uniqueKey":"brand.preferences.items.[INDEX].default_option","typeLabel":"object"},"options":{"type":"array","readOnly":true,"items":{"required":["code","name"],"type":"object","properties":{"name":{"description":"Preference option name","example":"Sample Prefs","maxLength":32,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"brand.preferences.items.[INDEX].options.items.[INDEX].name","typeLabel":"string"},"code":{"description":"Preference option code","example":"sample_prefs","maxLength":32,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"brand.preferences.items.[INDEX].options.items.[INDEX].code","typeLabel":"string"},"id":{"description":"Preference option ID","example":234,"type":"integer","readOnly":true,"uniqueKey":"brand.preferences.items.[INDEX].options.items.[INDEX].id","typeLabel":"integer"},"value":{"oneOf":[{"description":"Preference option value","maxLength":256,"type":"string","uniqueKey":"brand.preferences.items.[INDEX].options.items.[INDEX].value.oneOf.0","typeLabel":"string"},{"description":"Preference option value","maxLength":256,"type":"null","uniqueKey":"brand.preferences.items.[INDEX].options.items.[INDEX].value.oneOf.1","typeLabel":"null"}],"uniqueKey":"brand.preferences.items.[INDEX].options.items.[INDEX].value","typeLabel":"string | null"},"currency":{"type":"object","properties":{"id":{"description":"Currency ID","example":1,"type":"integer","readOnly":true,"uniqueKey":"brand.preferences.items.[INDEX].options.items.[INDEX].currency.id","typeLabel":"integer"},"name":{"description":"Currency name","example":"United States Dollar","maxLength":200,"type":"string","uniqueKey":"brand.preferences.items.[INDEX].options.items.[INDEX].currency.name","typeLabel":"string"},"symbol":{"oneOf":[{"description":"Currency symbol","example":"$","maxLength":5,"type":"string","uniqueKey":"brand.preferences.items.[INDEX].options.items.[INDEX].currency.symbol.oneOf.0","typeLabel":"string"},{"description":"Currency symbol","example":"$","maxLength":5,"type":"null","uniqueKey":"brand.preferences.items.[INDEX].options.items.[INDEX].currency.symbol.oneOf.1","typeLabel":"null"}],"uniqueKey":"brand.preferences.items.[INDEX].options.items.[INDEX].currency.symbol","typeLabel":"string | null"},"unit":{"description":"Currency unit","example":"USD","type":"string","readOnly":true,"uniqueKey":"brand.preferences.items.[INDEX].options.items.[INDEX].currency.unit","typeLabel":"string"}},"uniqueKey":"brand.preferences.items.[INDEX].options.items.[INDEX].currency","typeLabel":"object"},"timezone":{"required":["code","name"],"type":"object","properties":{"name":{"description":"Timezone name","example":"Demo","maxLength":32,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"brand.preferences.items.[INDEX].options.items.[INDEX].timezone.name","typeLabel":"string"},"code":{"description":"Timezone code","example":"demo","maxLength":32,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"brand.preferences.items.[INDEX].options.items.[INDEX].timezone.code","typeLabel":"string"},"id":{"description":"Timezone ID","example":7567,"type":"integer","readOnly":true,"uniqueKey":"brand.preferences.items.[INDEX].options.items.[INDEX].timezone.id","typeLabel":"integer"}},"uniqueKey":"brand.preferences.items.[INDEX].options.items.[INDEX].timezone","typeLabel":"object"}},"uniqueKey":"brand.preferences.items.[INDEX].options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"brand.preferences.items.[INDEX].options","typeLabel":"object[]"},"payload_type":{"description":"Payload type. Default type is value.","example":"value","type":"string","readOnly":true,"uniqueKey":"brand.preferences.items.[INDEX].payload_type","typeLabel":"string"},"brand_preference":{"type":"object","properties":{"id":{"description":"Brand preference ID","example":545,"type":"integer","readOnly":true,"uniqueKey":"brand.preferences.items.[INDEX].brand_preference.id","typeLabel":"integer"},"option_id":{"description":"Option ID","example":"656","type":"string","readOnly":true,"uniqueKey":"brand.preferences.items.[INDEX].brand_preference.option_id","typeLabel":"string"},"currency":{"type":"object","properties":{"id":{"description":"Currency ID","example":1,"type":"integer","readOnly":true,"uniqueKey":"brand.preferences.items.[INDEX].brand_preference.currency.id","typeLabel":"integer"},"name":{"description":"Currency name","example":"United States Dollar","maxLength":200,"type":"string","uniqueKey":"brand.preferences.items.[INDEX].brand_preference.currency.name","typeLabel":"string"},"symbol":{"oneOf":[{"description":"Currency symbol","example":"$","maxLength":5,"type":"string","uniqueKey":"brand.preferences.items.[INDEX].brand_preference.currency.symbol.oneOf.0","typeLabel":"string"},{"description":"Currency symbol","example":"$","maxLength":5,"type":"null","uniqueKey":"brand.preferences.items.[INDEX].brand_preference.currency.symbol.oneOf.1","typeLabel":"null"}],"uniqueKey":"brand.preferences.items.[INDEX].brand_preference.currency.symbol","typeLabel":"string | null"},"unit":{"description":"Currency unit","example":"USD","type":"string","readOnly":true,"uniqueKey":"brand.preferences.items.[INDEX].brand_preference.currency.unit","typeLabel":"string"}},"uniqueKey":"brand.preferences.items.[INDEX].brand_preference.currency","typeLabel":"object"},"timezone":{"required":["code","name"],"type":"object","properties":{"name":{"description":"Timezone name","example":"Demo","maxLength":32,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"brand.preferences.items.[INDEX].brand_preference.timezone.name","typeLabel":"string"},"code":{"description":"Timezone code","example":"demo","maxLength":32,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"brand.preferences.items.[INDEX].brand_preference.timezone.code","typeLabel":"string"},"id":{"description":"Timezone ID","example":7567,"type":"integer","readOnly":true,"uniqueKey":"brand.preferences.items.[INDEX].brand_preference.timezone.id","typeLabel":"integer"}},"uniqueKey":"brand.preferences.items.[INDEX].brand_preference.timezone","typeLabel":"object"},"value":{"oneOf":[{"description":"Value based on the preference","maxLength":256,"type":"string","uniqueKey":"brand.preferences.items.[INDEX].brand_preference.value.oneOf.0","typeLabel":"string"},{"description":"Value based on the preference","maxLength":256,"type":"null","uniqueKey":"brand.preferences.items.[INDEX].brand_preference.value.oneOf.1","typeLabel":"null"}],"uniqueKey":"brand.preferences.items.[INDEX].brand_preference.value","typeLabel":"string | null"}},"uniqueKey":"brand.preferences.items.[INDEX].brand_preference","typeLabel":"object"},"retailer_preference":{"type":"object","properties":{"id":{"description":"Retailer preference ID","example":124,"type":"integer","readOnly":true,"uniqueKey":"brand.preferences.items.[INDEX].retailer_preference.id","typeLabel":"integer"},"option_id":{"description":"Option ID","example":"SampleOpt123","type":"string","readOnly":true,"uniqueKey":"brand.preferences.items.[INDEX].retailer_preference.option_id","typeLabel":"string"},"currency":{"type":"object","properties":{"id":{"description":"Currency ID","example":1,"type":"integer","readOnly":true,"uniqueKey":"brand.preferences.items.[INDEX].retailer_preference.currency.id","typeLabel":"integer"},"name":{"description":"Currency name","example":"United States Dollar","maxLength":200,"type":"string","uniqueKey":"brand.preferences.items.[INDEX].retailer_preference.currency.name","typeLabel":"string"},"symbol":{"oneOf":[{"description":"Currency symbol","example":"$","maxLength":5,"type":"string","uniqueKey":"brand.preferences.items.[INDEX].retailer_preference.currency.symbol.oneOf.0","typeLabel":"string"},{"description":"Currency symbol","example":"$","maxLength":5,"type":"null","uniqueKey":"brand.preferences.items.[INDEX].retailer_preference.currency.symbol.oneOf.1","typeLabel":"null"}],"uniqueKey":"brand.preferences.items.[INDEX].retailer_preference.currency.symbol","typeLabel":"string | null"},"unit":{"description":"Currency unit","example":"USD","type":"string","readOnly":true,"uniqueKey":"brand.preferences.items.[INDEX].retailer_preference.currency.unit","typeLabel":"string"}},"uniqueKey":"brand.preferences.items.[INDEX].retailer_preference.currency","typeLabel":"object"},"timezone":{"required":["code","name"],"type":"object","properties":{"name":{"description":"Timezone name","example":"Demo","maxLength":32,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"brand.preferences.items.[INDEX].retailer_preference.timezone.name","typeLabel":"string"},"code":{"description":"Timezone code","example":"demo","maxLength":32,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"brand.preferences.items.[INDEX].retailer_preference.timezone.code","typeLabel":"string"},"id":{"description":"Timezone ID","example":7567,"type":"integer","readOnly":true,"uniqueKey":"brand.preferences.items.[INDEX].retailer_preference.timezone.id","typeLabel":"integer"}},"uniqueKey":"brand.preferences.items.[INDEX].retailer_preference.timezone","typeLabel":"object"},"value":{"oneOf":[{"description":"Value based on the preference","maxLength":256,"type":"string","uniqueKey":"brand.preferences.items.[INDEX].retailer_preference.value.oneOf.0","typeLabel":"string"},{"description":"Value based on the preference","maxLength":256,"type":"null","uniqueKey":"brand.preferences.items.[INDEX].retailer_preference.value.oneOf.1","typeLabel":"null"}],"uniqueKey":"brand.preferences.items.[INDEX].retailer_preference.value","typeLabel":"string | null"}},"uniqueKey":"brand.preferences.items.[INDEX].retailer_preference","typeLabel":"object"},"user_preference":{"type":"object","properties":{"id":{"description":"User preference ID","example":154,"type":"integer","readOnly":true,"uniqueKey":"brand.preferences.items.[INDEX].user_preference.id","typeLabel":"integer"},"option_id":{"description":"Option ID","example":"Sample Option","type":"string","readOnly":true,"uniqueKey":"brand.preferences.items.[INDEX].user_preference.option_id","typeLabel":"string"},"currency":{"type":"object","properties":{"id":{"description":"Currency ID","example":1,"type":"integer","readOnly":true,"uniqueKey":"brand.preferences.items.[INDEX].user_preference.currency.id","typeLabel":"integer"},"name":{"description":"Currency name","example":"United States Dollar","maxLength":200,"type":"string","uniqueKey":"brand.preferences.items.[INDEX].user_preference.currency.name","typeLabel":"string"},"symbol":{"oneOf":[{"description":"Currency symbol","example":"$","maxLength":5,"type":"string","uniqueKey":"brand.preferences.items.[INDEX].user_preference.currency.symbol.oneOf.0","typeLabel":"string"},{"description":"Currency symbol","example":"$","maxLength":5,"type":"null","uniqueKey":"brand.preferences.items.[INDEX].user_preference.currency.symbol.oneOf.1","typeLabel":"null"}],"uniqueKey":"brand.preferences.items.[INDEX].user_preference.currency.symbol","typeLabel":"string | null"},"unit":{"description":"Currency unit","example":"USD","type":"string","readOnly":true,"uniqueKey":"brand.preferences.items.[INDEX].user_preference.currency.unit","typeLabel":"string"}},"uniqueKey":"brand.preferences.items.[INDEX].user_preference.currency","typeLabel":"object"},"timezone":{"required":["code","name"],"type":"object","properties":{"name":{"description":"Timezone name","example":"Demo","maxLength":32,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"brand.preferences.items.[INDEX].user_preference.timezone.name","typeLabel":"string"},"code":{"description":"Timezone code","example":"demo","maxLength":32,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"brand.preferences.items.[INDEX].user_preference.timezone.code","typeLabel":"string"},"id":{"description":"Timezone ID","example":7567,"type":"integer","readOnly":true,"uniqueKey":"brand.preferences.items.[INDEX].user_preference.timezone.id","typeLabel":"integer"}},"uniqueKey":"brand.preferences.items.[INDEX].user_preference.timezone","typeLabel":"object"},"value":{"oneOf":[{"description":"Value based on the preference","maxLength":256,"type":"string","uniqueKey":"brand.preferences.items.[INDEX].user_preference.value.oneOf.0","typeLabel":"string"},{"description":"Value based on the preference","maxLength":256,"type":"null","uniqueKey":"brand.preferences.items.[INDEX].user_preference.value.oneOf.1","typeLabel":"null"}],"uniqueKey":"brand.preferences.items.[INDEX].user_preference.value","typeLabel":"string | null"}},"uniqueKey":"brand.preferences.items.[INDEX].user_preference","typeLabel":"object"}},"uniqueKey":"brand.preferences.items.[INDEX]","typeLabel":"object"},"uniqueKey":"brand.preferences","typeLabel":"object[]"},"verticals":{"type":"array","readOnly":true,"items":{"required":["code","name"],"type":"object","properties":{"name":{"description":"Vertical name","example":"Sample Vertical","maxLength":32,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"brand.verticals.items.[INDEX].name","typeLabel":"string"},"code":{"description":"Vertical code","example":"sample_vertical","maxLength":32,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"brand.verticals.items.[INDEX].code","typeLabel":"string"},"id":{"description":"Vertical ID","example":123,"type":"integer","readOnly":true,"uniqueKey":"brand.verticals.items.[INDEX].id","typeLabel":"integer"},"assets":{"type":"array","items":{"properties":{},"type":"object","uniqueKey":"brand.verticals.items.[INDEX].assets.items.[INDEX]","typeLabel":"object"},"uniqueKey":"brand.verticals.items.[INDEX].assets","typeLabel":"object[]"}},"uniqueKey":"brand.verticals.items.[INDEX]","typeLabel":"object"},"uniqueKey":"brand.verticals","typeLabel":"object[]"},"attachments":{"type":"array","readOnly":true,"items":{"type":"object","properties":{"id":{"description":"Attachment or document ID","example":268,"type":"integer","readOnly":true,"uniqueKey":"brand.attachments.items.[INDEX].id","typeLabel":"integer"},"content_type":{"description":"Content type","example":1,"type":"integer","uniqueKey":"brand.attachments.items.[INDEX].content_type","typeLabel":"integer"},"object_id":{"description":"Attachement object ID","example":666,"type":"integer","uniqueKey":"brand.attachments.items.[INDEX].object_id","typeLabel":"integer"},"file":{"oneOf":[{"description":"File name","example":"Sample file","type":"string","format":"uri","readOnly":true,"uniqueKey":"brand.attachments.items.[INDEX].file.oneOf.0","typeLabel":"string\u003curi>"},{"description":"File name","example":"Sample file","type":"null","format":"uri","readOnly":true,"uniqueKey":"brand.attachments.items.[INDEX].file.oneOf.1","typeLabel":"null"}],"uniqueKey":"brand.attachments.items.[INDEX].file","typeLabel":"string\u003curi> | null"},"uploaded_by":{"oneOf":[{"description":"User ID that uploaded the attachment","example":646,"type":"integer","uniqueKey":"brand.attachments.items.[INDEX].uploaded_by.oneOf.0","typeLabel":"integer"},{"description":"User ID that uploaded the attachment","example":646,"type":"null","uniqueKey":"brand.attachments.items.[INDEX].uploaded_by.oneOf.1","typeLabel":"null"}],"uniqueKey":"brand.attachments.items.[INDEX].uploaded_by","typeLabel":"integer | null"},"visible_by":{"description":"User permission who can view the attachment","example":"connections","type":"string","enum":["me","connections","everyone"],"uniqueKey":"brand.attachments.items.[INDEX].visible_by","typeLabel":"enum\u003cstring>"},"original_filename":{"oneOf":[{"description":"Original file name","example":"Sample1","maxLength":255,"type":"string","uniqueKey":"brand.attachments.items.[INDEX].original_filename.oneOf.0","typeLabel":"string"},{"description":"Original file name","example":"Sample1","maxLength":255,"type":"null","uniqueKey":"brand.attachments.items.[INDEX].original_filename.oneOf.1","typeLabel":"null"}],"uniqueKey":"brand.attachments.items.[INDEX].original_filename","typeLabel":"string | null"},"filename":{"oneOf":[{"description":"File name used for sharing","example":"Sample1","maxLength":255,"type":"string","uniqueKey":"brand.attachments.items.[INDEX].filename.oneOf.0","typeLabel":"string"},{"description":"File name used for sharing","example":"Sample1","maxLength":255,"type":"null","uniqueKey":"brand.attachments.items.[INDEX].filename.oneOf.1","typeLabel":"null"}],"uniqueKey":"brand.attachments.items.[INDEX].filename","typeLabel":"string | null"},"tags":{"type":"array","readOnly":true,"items":{"required":["tag"],"type":"object","properties":{"tag":{"description":"attachment tag","example":"demotag","maxLength":128,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"brand.attachments.items.[INDEX].tags.items.[INDEX].tag","typeLabel":"string"},"id":{"description":"Attachment tag ID","example":432,"type":"integer","readOnly":true,"uniqueKey":"brand.attachments.items.[INDEX].tags.items.[INDEX].id","typeLabel":"integer"}},"uniqueKey":"brand.attachments.items.[INDEX].tags.items.[INDEX]","typeLabel":"object"},"uniqueKey":"brand.attachments.items.[INDEX].tags","typeLabel":"object[]"},"url":{"description":"URL of attachment","example":"https://assets.sample.com/attachments/path_to_attachment/attachment.pdf","minLength":1,"type":"string","format":"uri","uniqueKey":"brand.attachments.items.[INDEX].url","typeLabel":"string\u003curi>"}},"uniqueKey":"brand.attachments.items.[INDEX]","typeLabel":"object"},"uniqueKey":"brand.attachments","typeLabel":"object[]"},"website":{"oneOf":[{"description":"Brand URL","example":"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf","maxLength":100,"type":"string","format":"uri","uniqueKey":"brand.website.oneOf.0","typeLabel":"string\u003curi>"},{"description":"Brand URL","example":"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf","maxLength":100,"type":"null","format":"uri","uniqueKey":"brand.website.oneOf.1","typeLabel":"null"}],"uniqueKey":"brand.website","typeLabel":"string\u003curi> | null"},"is_onboarded":{"description":"true: brand is onboarded \u003cbr /> false: brand is not onboarded","example":true,"type":"boolean","readOnly":true,"uniqueKey":"brand.is_onboarded","typeLabel":"boolean"},"onboarded_at":{"oneOf":[{"description":"Time of vendor onboarding (UTC format)","example":"2021-09-10T15:24:56Z","type":"string","format":"date-time","uniqueKey":"brand.onboarded_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Time of vendor onboarding (UTC format)","example":"2021-09-10T15:24:56Z","type":"null","format":"date-time","uniqueKey":"brand.onboarded_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"brand.onboarded_at","typeLabel":"string\u003cdate-time> | null"},"assigned_onboarding_tasks":{"type":"object","properties":{"id":{"description":"Onboarding task ID (vendor context)","example":125,"type":"integer","readOnly":true,"uniqueKey":"brand.assigned_onboarding_tasks.id","typeLabel":"integer"},"onboarding_task":{"required":["code","name","priority","status","type"],"type":"object","properties":{"name":{"description":"Task name","example":"Task1","maxLength":128,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"brand.assigned_onboarding_tasks.onboarding_task.name","typeLabel":"string"},"code":{"description":"Task code","example":"task1","maxLength":64,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"brand.assigned_onboarding_tasks.onboarding_task.code","typeLabel":"string"},"type":{"description":"Task type","example":"Initial","type":"string","enum":["initial","conditional","network"],"isRequired":true,"uniqueKey":"brand.assigned_onboarding_tasks.onboarding_task.type","typeLabel":"enum\u003cstring>"},"priority":{"description":"Task prority","example":2,"maximum":4294967295,"minimum":0,"type":"integer","isRequired":true,"uniqueKey":"brand.assigned_onboarding_tasks.onboarding_task.priority","typeLabel":"integer"},"status":{"description":"Task status","example":"In Progress","type":"string","enum":["active","inactive"],"isRequired":true,"uniqueKey":"brand.assigned_onboarding_tasks.onboarding_task.status","typeLabel":"enum\u003cstring>"},"id":{"description":"Onboarding task ID","example":345,"type":"integer","readOnly":true,"uniqueKey":"brand.assigned_onboarding_tasks.onboarding_task.id","typeLabel":"integer"},"description":{"oneOf":[{"description":"Task descripton","example":"Onboard sample task 1","maxLength":256,"type":"string","uniqueKey":"brand.assigned_onboarding_tasks.onboarding_task.description.oneOf.0","typeLabel":"string"},{"description":"Task descripton","example":"Onboard sample task 1","maxLength":256,"type":"null","uniqueKey":"brand.assigned_onboarding_tasks.onboarding_task.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"brand.assigned_onboarding_tasks.onboarding_task.description","typeLabel":"string | null"},"content_type":{"description":"Content type","example":"PDF","minLength":1,"type":"string","readOnly":true,"uniqueKey":"brand.assigned_onboarding_tasks.onboarding_task.content_type","typeLabel":"string"},"created_at":{"description":"Time of task creation (UTC format)","example":"2021-09-10T15:24:56Z","type":"string","format":"date-time","readOnly":true,"uniqueKey":"brand.assigned_onboarding_tasks.onboarding_task.created_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"brand.assigned_onboarding_tasks.onboarding_task","typeLabel":"object"},"info":{"description":"JSON object with details, if applicable","type":"object","properties":{},"uniqueKey":"brand.assigned_onboarding_tasks.info","typeLabel":"object"},"completed_at":{"description":"Time of task completion (UTC format)","example":"2021-09-10T15:24:56Z","type":"string","format":"date-time","readOnly":true,"uniqueKey":"brand.assigned_onboarding_tasks.completed_at","typeLabel":"string\u003cdate-time>"},"completed_by":{"type":"object","properties":{"id":{"description":"User ID","example":145,"type":"integer","readOnly":true,"uniqueKey":"brand.assigned_onboarding_tasks.completed_by.id","typeLabel":"integer"},"first_name":{"oneOf":[{"description":"First name of user","example":"Demo","maxLength":64,"type":"string","uniqueKey":"brand.assigned_onboarding_tasks.completed_by.first_name.oneOf.0","typeLabel":"string"},{"description":"First name of user","example":"Demo","maxLength":64,"type":"null","uniqueKey":"brand.assigned_onboarding_tasks.completed_by.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"brand.assigned_onboarding_tasks.completed_by.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"description":"Last name of user","example":"Sample","maxLength":64,"type":"string","uniqueKey":"brand.assigned_onboarding_tasks.completed_by.last_name.oneOf.0","typeLabel":"string"},{"description":"Last name of user","example":"Sample","maxLength":64,"type":"null","uniqueKey":"brand.assigned_onboarding_tasks.completed_by.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"brand.assigned_onboarding_tasks.completed_by.last_name","typeLabel":"string | null"},"name":{"description":"Full name of user","example":"Demo Sample","minLength":1,"type":"string","readOnly":true,"uniqueKey":"brand.assigned_onboarding_tasks.completed_by.name","typeLabel":"string"},"email":{"oneOf":[{"description":"Email address of user","example":"demo@xyz.com","maxLength":128,"type":"string","format":"email","uniqueKey":"brand.assigned_onboarding_tasks.completed_by.email.oneOf.0","typeLabel":"string\u003cemail>"},{"description":"Email address of user","example":"demo@xyz.com","maxLength":128,"type":"null","format":"email","uniqueKey":"brand.assigned_onboarding_tasks.completed_by.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"brand.assigned_onboarding_tasks.completed_by.email","typeLabel":"string\u003cemail> | null"},"title":{"oneOf":[{"description":"Title of user","example":"Mr","maxLength":64,"type":"string","uniqueKey":"brand.assigned_onboarding_tasks.completed_by.title.oneOf.0","typeLabel":"string"},{"description":"Title of user","example":"Mr","maxLength":64,"type":"null","uniqueKey":"brand.assigned_onboarding_tasks.completed_by.title.oneOf.1","typeLabel":"null"}],"uniqueKey":"brand.assigned_onboarding_tasks.completed_by.title","typeLabel":"string | null"},"status":{"description":"User status","example":"active","type":"string","enum":["active","invited","locked"],"uniqueKey":"brand.assigned_onboarding_tasks.completed_by.status","typeLabel":"enum\u003cstring>"},"type":{"description":"User type","example":"standard","type":"string","enum":["standard","api"],"uniqueKey":"brand.assigned_onboarding_tasks.completed_by.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"brand.assigned_onboarding_tasks.completed_by","typeLabel":"object"},"created_at":{"description":"Time of task creation (UTC format)","example":"2021-09-10T15:24:56Z","type":"string","format":"date-time","readOnly":true,"uniqueKey":"brand.assigned_onboarding_tasks.created_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"brand.assigned_onboarding_tasks","typeLabel":"object"},"requires_subscription":{"description":"Represents whether subscription is required","example":"disabled","type":"string","enum":["disabled","enabled","upcoming"],"uniqueKey":"brand.requires_subscription","typeLabel":"enum\u003cstring>"},"inventory_policy":{"description":"Inventory policy","example":"unmanaged","type":"string","enum":["unmanaged","managed","use_variant_policy"],"uniqueKey":"brand.inventory_policy","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"brand","typeLabel":"object"},"connection_credentials":{"type":"array","items":{"required":["code","name","value"],"type":"object","properties":{"name":{"description":"Connection credential name","example":"SampleCred","maxLength":256,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"connection_credentials.items.[INDEX].name","typeLabel":"string"},"value":{"description":"Connection credential value","example":"Sample1","maxLength":2048,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"connection_credentials.items.[INDEX].value","typeLabel":"string"},"code":{"description":"Connection credential code","example":"sample_cred","maxLength":256,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"connection_credentials.items.[INDEX].code","typeLabel":"string"},"id":{"description":"Connection credential ID","example":125,"type":"integer","readOnly":true,"uniqueKey":"connection_credentials.items.[INDEX].id","typeLabel":"integer"},"is_encrypted":{"description":"true: connection is encrypted \u003cbr /> \u003cbr /> connection is not encrypted","example":true,"type":"boolean","uniqueKey":"connection_credentials.items.[INDEX].is_encrypted","typeLabel":"boolean"}},"uniqueKey":"connection_credentials.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"connection_credentials","typeLabel":"object[]"},"id":{"description":"Retailer connection ID","example":1050,"type":"integer","readOnly":true,"uniqueKey":"id","typeLabel":"integer"},"level":{"description":"Retailer connection type","example":"basic","type":"string","enum":["basic","full"],"uniqueKey":"level","typeLabel":"enum\u003cstring>"},"status":{"description":"Retailer connection status","example":"active","type":"string","enum":["active","suspended","pending","onboarding"],"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"suspended_at":{"oneOf":[{"description":"Time of when the retailer connection got suspended (UTC format)","example":null,"type":"string","format":"date-time","uniqueKey":"suspended_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Time of when the retailer connection got suspended (UTC format)","example":null,"type":"null","format":"date-time","uniqueKey":"suspended_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"suspended_at","typeLabel":"string\u003cdate-time> | null"},"created_at":{"description":"Time of retailer connection creation (UTC format)","example":"2021-09-10T15:24:56Z","type":"string","format":"date-time","readOnly":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"description":"Time of retailer connection update (UTC format)","example":"2022-11-10T15:24:56Z","type":"string","format":"date-time","readOnly":true,"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"},"shipping_accounts":{"type":"array","readOnly":true,"items":{"required":["nickname"],"type":"object","properties":{"nickname":{"description":"Short name of shipping account, for easier identification","example":"Sample13","maxLength":64,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"shipping_accounts.items.[INDEX].nickname","typeLabel":"string"},"id":{"description":"Shippping account ID","example":1,"type":"integer","readOnly":true,"uniqueKey":"shipping_accounts.items.[INDEX].id","typeLabel":"integer"},"owner":{"description":"Owner of shipping account","example":"DemoABC","type":"string","readOnly":true,"uniqueKey":"shipping_accounts.items.[INDEX].owner","typeLabel":"string"},"carrier":{"description":"Shipping carrier","example":"ALP Brand","type":"string","readOnly":true,"uniqueKey":"shipping_accounts.items.[INDEX].carrier","typeLabel":"string"},"shipping_methods":{"required":["code","name"],"type":"object","properties":{"name":{"description":"Name of shipping method","example":"White Glove Bronze","maxLength":64,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"shipping_accounts.items.[INDEX].shipping_methods.name","typeLabel":"string"},"code":{"description":"Code of shipping method","example":"cory_white_glove","maxLength":64,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"shipping_accounts.items.[INDEX].shipping_methods.code","typeLabel":"string"},"id":{"description":"ID of shipping method","example":5,"type":"integer","readOnly":true,"uniqueKey":"shipping_accounts.items.[INDEX].shipping_methods.id","typeLabel":"integer"},"type":{"description":"Type of shipping method","example":"ltl (less than truck load)","type":"string","enum":["small_parcel","ltl"],"uniqueKey":"shipping_accounts.items.[INDEX].shipping_methods.type","typeLabel":"enum\u003cstring>"},"carrier":{"type":"object","properties":{"id":{"description":"Carrier ID","example":229,"type":"integer","readOnly":true,"uniqueKey":"shipping_accounts.items.[INDEX].shipping_methods.carrier.id","typeLabel":"integer"},"name":{"description":"Carrier name","example":"Cory Companies","maxLength":64,"minLength":1,"type":"string","uniqueKey":"shipping_accounts.items.[INDEX].shipping_methods.carrier.name","typeLabel":"string"},"code":{"description":"Carrier code","example":"CJCD","maxLength":64,"minLength":1,"type":"string","uniqueKey":"shipping_accounts.items.[INDEX].shipping_methods.carrier.code","typeLabel":"string"}},"uniqueKey":"shipping_accounts.items.[INDEX].shipping_methods.carrier","typeLabel":"object"},"generic_shipping_method":{"required":["description","name"],"type":"object","properties":{"name":{"description":"Name of shipping method","example":"LTL","maxLength":32,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"shipping_accounts.items.[INDEX].shipping_methods.generic_shipping_method.name","typeLabel":"string"},"description":{"description":"Description of shipping method","example":"Less than truckload (LTL)","maxLength":128,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"shipping_accounts.items.[INDEX].shipping_methods.generic_shipping_method.description","typeLabel":"string"},"id":{"description":"ID of shipping method","example":5,"type":"integer","readOnly":true,"uniqueKey":"shipping_accounts.items.[INDEX].shipping_methods.generic_shipping_method.id","typeLabel":"integer"},"type":{"description":"Type of shipping method","example":"ltl","type":"string","enum":["small_parcel","ltl"],"uniqueKey":"shipping_accounts.items.[INDEX].shipping_methods.generic_shipping_method.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"shipping_accounts.items.[INDEX].shipping_methods.generic_shipping_method","typeLabel":"object"}},"uniqueKey":"shipping_accounts.items.[INDEX].shipping_methods","typeLabel":"object"}},"uniqueKey":"shipping_accounts.items.[INDEX]","typeLabel":"object"},"uniqueKey":"shipping_accounts","typeLabel":"object[]"},"connection_contacts":{"type":"array","readOnly":true,"items":{"type":"object","properties":{"id":{"description":"ID of connection contact","example":1546,"type":"integer","readOnly":true,"uniqueKey":"connection_contacts.items.[INDEX].id","typeLabel":"integer"},"contact_type":{"description":"Contact type","example":"merchandising","type":"string","enum":["orders","merchandising","finance","inventory"],"uniqueKey":"connection_contacts.items.[INDEX].contact_type","typeLabel":"enum\u003cstring>"},"brand":{"required":["code"],"type":"object","properties":{"code":{"description":"Vendor code, which is vendor name in lower case and underscore","example":"demo-brand","maxLength":64,"minLength":1,"pattern":"^[-a-zA-Z0-9_]+$","type":"string","format":"slug","isRequired":true,"uniqueKey":"connection_contacts.items.[INDEX].brand.code","typeLabel":"string\u003cslug>"},"id":{"description":"Vendor (brand) ID","example":500,"type":"integer","readOnly":true,"uniqueKey":"connection_contacts.items.[INDEX].brand.id","typeLabel":"integer"},"name":{"description":"Vendor name","example":"Marla Cielo","maxLength":64,"minLength":1,"type":"string","uniqueKey":"connection_contacts.items.[INDEX].brand.name","typeLabel":"string"},"joined_at":{"description":"Time when vendor joined Dropship (UTC format)","example":"2022-09-10T15:24:56Z","type":"string","format":"date-time","readOnly":true,"uniqueKey":"connection_contacts.items.[INDEX].brand.joined_at","typeLabel":"string\u003cdate-time>"},"logo_url":{"description":"URL of the brand logo","example":"https://images.revcascade.com/retailers/defaults/logo-lg.png","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"connection_contacts.items.[INDEX].brand.logo_url","typeLabel":"string\u003curi>"},"cover_url":{"description":"URL of the cover image","example":"https://images.revcascade.com/retailers/defaults/cover.png","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"connection_contacts.items.[INDEX].brand.cover_url","typeLabel":"string\u003curi>"},"profile_tile_url":{"description":"URL of the profile image","example":"https://images.revcascade.com/retailers/defaults/profile-tile.png","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"connection_contacts.items.[INDEX].brand.profile_tile_url","typeLabel":"string\u003curi>"},"website":{"oneOf":[{"description":"URL of brand website","example":null,"maxLength":100,"type":"string","format":"uri","uniqueKey":"connection_contacts.items.[INDEX].brand.website.oneOf.0","typeLabel":"string\u003curi>"},{"description":"URL of brand website","example":null,"maxLength":100,"type":"null","format":"uri","uniqueKey":"connection_contacts.items.[INDEX].brand.website.oneOf.1","typeLabel":"null"}],"uniqueKey":"connection_contacts.items.[INDEX].brand.website","typeLabel":"string\u003curi> | null"},"is_onboarded":{"description":"true: Vendor is onboarded \u003cbr /> false: Vendor is not onboarded","example":false,"type":"boolean","readOnly":true,"uniqueKey":"connection_contacts.items.[INDEX].brand.is_onboarded","typeLabel":"boolean"},"is_on_rcn":{"description":"true: is on Dropship network \u003cbr /> false: not on Dropship network","example":false,"type":"boolean","uniqueKey":"connection_contacts.items.[INDEX].brand.is_on_rcn","typeLabel":"boolean"},"requires_subscription":{"description":"Represents whether subscription is required","example":"enabled","type":"string","enum":["disabled","enabled","upcoming"],"uniqueKey":"connection_contacts.items.[INDEX].brand.requires_subscription","typeLabel":"enum\u003cstring>"},"subscription_expires_at":{"oneOf":[{"description":"Subscription expiry Time (UTC format)","example":"2024-09-19T13:32:10Z","type":"string","format":"date-time","uniqueKey":"connection_contacts.items.[INDEX].brand.subscription_expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Subscription expiry Time (UTC format)","example":"2024-09-19T13:32:10Z","type":"null","format":"date-time","uniqueKey":"connection_contacts.items.[INDEX].brand.subscription_expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"connection_contacts.items.[INDEX].brand.subscription_expires_at","typeLabel":"string\u003cdate-time> | null"},"grace_period_ends_at":{"oneOf":[{"description":"Time of grace period expiration (UTC format)","example":"2024-10-26T13:32:10Z","type":"string","format":"date-time","uniqueKey":"connection_contacts.items.[INDEX].brand.grace_period_ends_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Time of grace period expiration (UTC format)","example":"2024-10-26T13:32:10Z","type":"null","format":"date-time","uniqueKey":"connection_contacts.items.[INDEX].brand.grace_period_ends_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"connection_contacts.items.[INDEX].brand.grace_period_ends_at","typeLabel":"string\u003cdate-time> | null"},"subscription_is_expired":{"description":"true: subscription is expired \u003cbr /> false: subscription is active","example":false,"type":"boolean","readOnly":true,"uniqueKey":"connection_contacts.items.[INDEX].brand.subscription_is_expired","typeLabel":"boolean"},"subscription_is_on_grace_period":{"description":"true: subscription is on grace period \u003cbr /> false: subscription is not on grace period","example":false,"type":"boolean","readOnly":true,"uniqueKey":"connection_contacts.items.[INDEX].brand.subscription_is_on_grace_period","typeLabel":"boolean"},"subscription_is_delinquent":{"description":"true: subscription is overdue \u003cbr /> false: subscription is paid","example":false,"type":"boolean","readOnly":true,"uniqueKey":"connection_contacts.items.[INDEX].brand.subscription_is_delinquent","typeLabel":"boolean"},"inventory_policy":{"description":"Inventory policy","example":"managed","type":"string","enum":["unmanaged","managed","use_variant_policy"],"uniqueKey":"connection_contacts.items.[INDEX].brand.inventory_policy","typeLabel":"enum\u003cstring>"},"status":{"description":"Vendor status","example":"active","type":"string","enum":["active","pending","inactive"],"uniqueKey":"connection_contacts.items.[INDEX].brand.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"connection_contacts.items.[INDEX].brand","typeLabel":"object"},"retailer":{"required":["code","name"],"type":"object","properties":{"name":{"description":"Retailer name","example":"Demo Retailer","maxLength":64,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"connection_contacts.items.[INDEX].retailer.name","typeLabel":"string"},"code":{"description":"Retailer code, which is retailer name in lower case and hyphenated","example":"demo-retailer","maxLength":32,"minLength":1,"pattern":"^[-a-zA-Z0-9_]+$","type":"string","format":"slug","isRequired":true,"uniqueKey":"connection_contacts.items.[INDEX].retailer.code","typeLabel":"string\u003cslug>"},"id":{"description":"Retailer ID","example":500,"type":"integer","readOnly":true,"uniqueKey":"connection_contacts.items.[INDEX].retailer.id","typeLabel":"integer"},"logo_url":{"description":"URL of retailer logo","example":"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"connection_contacts.items.[INDEX].retailer.logo_url","typeLabel":"string\u003curi>"},"cover_url":{"description":"URL of retailer cover image","example":"https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"connection_contacts.items.[INDEX].retailer.cover_url","typeLabel":"string\u003curi>"},"profile_tile_url":{"description":"URL of retailer profile image","example":"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"connection_contacts.items.[INDEX].retailer.profile_tile_url","typeLabel":"string\u003curi>"},"joined_at":{"description":"Time of retailer joining Dropship (UTC format)","example":"2021-08-03T17:24:12Z","type":"string","format":"date-time","readOnly":true,"uniqueKey":"connection_contacts.items.[INDEX].retailer.joined_at","typeLabel":"string\u003cdate-time>"},"is_rcn_retailer":{"description":"true: Retailer is in Dropship network; Retailer is not in Dropship network","example":false,"type":"boolean","uniqueKey":"connection_contacts.items.[INDEX].retailer.is_rcn_retailer","typeLabel":"boolean"},"is_onboarded":{"description":"true: Retailer is onboarded \u003cbr /> false: Retailer is not onboarded","example":false,"type":"boolean","uniqueKey":"connection_contacts.items.[INDEX].retailer.is_onboarded","typeLabel":"boolean"},"platform":{"description":"Platform on which retailer is onboarded","example":"fabric","type":"string","enum":["fabric"],"uniqueKey":"connection_contacts.items.[INDEX].retailer.platform","typeLabel":"enum\u003cstring>"},"requires_subscription":{"description":"Represent whether retailer requires subscription to use the platform","example":"disabled","type":"string","enum":["disabled","enabled","upcoming"],"uniqueKey":"connection_contacts.items.[INDEX].retailer.requires_subscription","typeLabel":"enum\u003cstring>"},"brand_permit_creation_allowed":{"description":"true: Platform allows creation of brand permit \u003cbr /> false: Platform doesn't require creation of brand permit","example":false,"type":"boolean","uniqueKey":"connection_contacts.items.[INDEX].retailer.brand_permit_creation_allowed","typeLabel":"boolean"},"website":{"oneOf":[{"description":"Website URL","example":"https://demoabc.com","maxLength":100,"type":"string","format":"uri","uniqueKey":"connection_contacts.items.[INDEX].retailer.website.oneOf.0","typeLabel":"string\u003curi>"},{"description":"Website URL","example":"https://demoabc.com","maxLength":100,"type":"null","format":"uri","uniqueKey":"connection_contacts.items.[INDEX].retailer.website.oneOf.1","typeLabel":"null"}],"uniqueKey":"connection_contacts.items.[INDEX].retailer.website","typeLabel":"string\u003curi> | null"},"status":{"description":"Retailer status","example":"active","type":"string","enum":["active","setup","ghost"],"uniqueKey":"connection_contacts.items.[INDEX].retailer.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"connection_contacts.items.[INDEX].retailer","typeLabel":"object"},"user_id":{"description":"User ID","example":201,"type":"integer","readOnly":true,"uniqueKey":"connection_contacts.items.[INDEX].user_id","typeLabel":"integer"},"first_name":{"description":"First name of contact","example":"Demo","minLength":1,"type":"string","readOnly":true,"uniqueKey":"connection_contacts.items.[INDEX].first_name","typeLabel":"string"},"last_name":{"description":"Last name of contact","example":"Sample","minLength":1,"type":"string","readOnly":true,"uniqueKey":"connection_contacts.items.[INDEX].last_name","typeLabel":"string"},"email":{"description":"Email ID of contact","example":"demo-sample@anc.com","minLength":1,"type":"string","readOnly":true,"uniqueKey":"connection_contacts.items.[INDEX].email","typeLabel":"string"},"phone":{"description":"Phone number of contact","example":"12456245984","minLength":1,"type":"string","readOnly":true,"uniqueKey":"connection_contacts.items.[INDEX].phone","typeLabel":"string"}},"uniqueKey":"connection_contacts.items.[INDEX]","typeLabel":"object"},"uniqueKey":"connection_contacts","typeLabel":"object[]"},"connection_fees":{"type":"object","properties":{"id":{"description":"Connection fee ID","example":1000,"type":"integer","readOnly":true,"uniqueKey":"connection_fees.id","typeLabel":"integer"},"payment_model":{"oneOf":[{"description":"Payment model","example":"managed","type":"string","enum":["direct","managed"],"uniqueKey":"connection_fees.payment_model.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"Payment model","example":"managed","type":"null","enum":["direct","managed"],"uniqueKey":"connection_fees.payment_model.oneOf.1","typeLabel":"null"}],"uniqueKey":"connection_fees.payment_model","typeLabel":"enum\u003cstring> | null"},"payment_terms":{"oneOf":[{"description":"Payment terms","example":"net60","type":"string","enum":["net15","net30","net45","net60","net90"],"uniqueKey":"connection_fees.payment_terms.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"Payment terms","example":"net60","type":"null","enum":["net15","net30","net45","net60","net90"],"uniqueKey":"connection_fees.payment_terms.oneOf.1","typeLabel":"null"}],"uniqueKey":"connection_fees.payment_terms","typeLabel":"enum\u003cstring> | null"},"net_price_method":{"oneOf":[{"description":"Method used to calculate net price","example":"permit_cost","type":"string","enum":["estimated_commission","product_cost","specified_in_order","revshare","permit_cost"],"uniqueKey":"connection_fees.net_price_method.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"Method used to calculate net price","example":"permit_cost","type":"null","enum":["estimated_commission","product_cost","specified_in_order","revshare","permit_cost"],"uniqueKey":"connection_fees.net_price_method.oneOf.1","typeLabel":"null"}],"uniqueKey":"connection_fees.net_price_method","typeLabel":"enum\u003cstring> | null"},"revshare_fraction":{"oneOf":[{"description":"Internal only","example":"0.4000","type":"string","format":"decimal","uniqueKey":"connection_fees.revshare_fraction.oneOf.0","typeLabel":"string\u003cdecimal>"},{"description":"Internal only","example":"0.4000","type":"null","format":"decimal","uniqueKey":"connection_fees.revshare_fraction.oneOf.1","typeLabel":"null"}],"uniqueKey":"connection_fees.revshare_fraction","typeLabel":"string\u003cdecimal> | null"},"revc_fee_flat":{"description":"Internal only","example":"0.00","minLength":1,"type":"string","uniqueKey":"connection_fees.revc_fee_flat","typeLabel":"string"},"revc_fee_fraction":{"description":"Internal only","example":"0.0300","minLength":1,"type":"string","uniqueKey":"connection_fees.revc_fee_fraction","typeLabel":"string"},"brand_fee_flat":{"description":"Internal only","example":"0.00","minLength":1,"type":"string","uniqueKey":"connection_fees.brand_fee_flat","typeLabel":"string"},"brand_flat_order_fee":{"oneOf":[{"description":"Internal only","example":"0.00","type":"string","format":"decimal","uniqueKey":"connection_fees.brand_flat_order_fee.oneOf.0","typeLabel":"string\u003cdecimal>"},{"description":"Internal only","example":"0.00","type":"null","format":"decimal","uniqueKey":"connection_fees.brand_flat_order_fee.oneOf.1","typeLabel":"null"}],"uniqueKey":"connection_fees.brand_flat_order_fee","typeLabel":"string\u003cdecimal> | null"},"brand_percent_order_fee":{"oneOf":[{"description":"Vendor percentage of order fee","example":"0.0000","type":"string","format":"decimal","uniqueKey":"connection_fees.brand_percent_order_fee.oneOf.0","typeLabel":"string\u003cdecimal>"},{"description":"Vendor percentage of order fee","example":"0.0000","type":"null","format":"decimal","uniqueKey":"connection_fees.brand_percent_order_fee.oneOf.1","typeLabel":"null"}],"uniqueKey":"connection_fees.brand_percent_order_fee","typeLabel":"string\u003cdecimal> | null"},"effective_at":{"description":"Time connection fee became effective (UTC format)","example":"2015-10-10T00:00:00Z","type":"string","format":"date-time","readOnly":true,"uniqueKey":"connection_fees.effective_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"connection_fees","typeLabel":"object"},"connection_slas":{"type":"object","properties":{"id":{"description":"Connection SLA ID","example":1000,"type":"integer","readOnly":true,"uniqueKey":"connection_slas.id","typeLabel":"integer"},"brand_inventory_hours":{"description":"Inventory update SLA (in hours)","example":24,"maximum":4294967295,"minimum":0,"type":"integer","uniqueKey":"connection_slas.brand_inventory_hours","typeLabel":"integer"},"brand_fulfillment_hours":{"description":"Fulfillment hours of brand","example":48,"maximum":4294967295,"minimum":0,"type":"integer","uniqueKey":"connection_slas.brand_fulfillment_hours","typeLabel":"integer"},"brand_cancel_hours":{"description":"Timeframe for vendor to cancel order","example":24,"maximum":4294967295,"minimum":0,"type":"integer","uniqueKey":"connection_slas.brand_cancel_hours","typeLabel":"integer"},"brand_acknowledge_hours":{"description":"Timeframe for vendor to acknowledge order","example":12,"maximum":4294967295,"minimum":0,"type":"integer","uniqueKey":"connection_slas.brand_acknowledge_hours","typeLabel":"integer"},"retailer_cancel_hours":{"description":"Timeframe for retailers to cancel order","example":24,"maximum":4294967295,"minimum":0,"type":"integer","uniqueKey":"connection_slas.retailer_cancel_hours","typeLabel":"integer"},"retailer_return_hours":{"description":"Timeframe for retailers to return order","example":720,"maximum":4294967295,"minimum":0,"type":"integer","uniqueKey":"connection_slas.retailer_return_hours","typeLabel":"integer"}},"uniqueKey":"connection_slas","typeLabel":"object"},"connection_adjustments":{"type":"array","readOnly":true,"items":{"required":["description"],"type":"object","properties":{"description":{"description":"Description of adjustment","example":"Sample description for monetary adjustments","maxLength":256,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"connection_adjustments.items.[INDEX].description","typeLabel":"string"},"id":{"description":"Connection adjustment ID, used for monetary adjustments","example":123442,"type":"integer","readOnly":true,"uniqueKey":"connection_adjustments.items.[INDEX].id","typeLabel":"integer"},"adjustment_code":{"required":["adjustment_type","code","description"],"type":"object","properties":{"adjustment_type":{"description":"Adjustment type","example":"Allowance","type":"string","enum":["allowance","charge"],"isRequired":true,"uniqueKey":"connection_adjustments.items.[INDEX].adjustment_code.adjustment_type","typeLabel":"enum\u003cstring>"},"code":{"description":"Adjustment code","example":"returns_allowance","maxLength":64,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"connection_adjustments.items.[INDEX].adjustment_code.code","typeLabel":"string"},"description":{"description":"Description of adjustment","example":"returns_allowance","maxLength":128,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"connection_adjustments.items.[INDEX].adjustment_code.description","typeLabel":"string"},"id":{"description":"Adjustment ID","example":1,"type":"integer","readOnly":true,"uniqueKey":"connection_adjustments.items.[INDEX].adjustment_code.id","typeLabel":"integer"}},"uniqueKey":"connection_adjustments.items.[INDEX].adjustment_code","typeLabel":"object"},"adjustment_type":{"description":"Adjustment type","example":"Discount","type":"string","readOnly":true,"uniqueKey":"connection_adjustments.items.[INDEX].adjustment_type","typeLabel":"string"},"adjustment_amount_type":{"description":"Adjustment type - dollar amount or percentage","example":"flat","type":"string","enum":["percent","flat"],"uniqueKey":"connection_adjustments.items.[INDEX].adjustment_amount_type","typeLabel":"enum\u003cstring>"},"adjustment_amount":{"description":"Adjustment amount","example":"12","type":"string","format":"decimal","uniqueKey":"connection_adjustments.items.[INDEX].adjustment_amount","typeLabel":"string\u003cdecimal>"},"content_type":{"description":"Content type","example":"PDF","minLength":1,"type":"string","readOnly":true,"uniqueKey":"connection_adjustments.items.[INDEX].content_type","typeLabel":"string"},"object_id":{"oneOf":[{"description":"Object ID","example":45646,"maximum":4294967295,"minimum":0,"type":"integer","uniqueKey":"connection_adjustments.items.[INDEX].object_id.oneOf.0","typeLabel":"integer"},{"description":"Object ID","example":45646,"maximum":4294967295,"minimum":0,"type":"null","uniqueKey":"connection_adjustments.items.[INDEX].object_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"connection_adjustments.items.[INDEX].object_id","typeLabel":"integer | null"}},"uniqueKey":"connection_adjustments.items.[INDEX]","typeLabel":"object"},"uniqueKey":"connection_adjustments","typeLabel":"object[]"},"options":{"required":["code","name"],"type":"object","properties":{"name":{"description":"Option name","example":"Sample Option","maxLength":64,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"options.name","typeLabel":"string"},"code":{"description":"Option code","example":"Sample_Option","maxLength":64,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"options.code","typeLabel":"string"},"id":{"description":"Option ID","example":8753,"type":"integer","readOnly":true,"uniqueKey":"options.id","typeLabel":"integer"},"description":{"oneOf":[{"description":"Connection description","example":"Sample description for connection","type":"string","uniqueKey":"options.description.oneOf.0","typeLabel":"string"},{"description":"Connection description","example":"Sample description for connection","type":"null","uniqueKey":"options.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"options.description","typeLabel":"string | null"},"viewable_by":{"oneOf":[{"description":"User who can view the connection details","example":"All","type":"string","enum":["retailer","brand","all","none"],"uniqueKey":"options.viewable_by.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"User who can view the connection details","example":"All","type":"null","enum":["retailer","brand","all","none"],"uniqueKey":"options.viewable_by.oneOf.1","typeLabel":"null"}],"uniqueKey":"options.viewable_by","typeLabel":"enum\u003cstring> | null"},"editable_by":{"oneOf":[{"description":"User who can edit connection","example":"Staff","type":"string","enum":["retailer","brand","staff"],"uniqueKey":"options.editable_by.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"User who can edit connection","example":"Staff","type":"null","enum":["retailer","brand","staff"],"uniqueKey":"options.editable_by.oneOf.1","typeLabel":"null"}],"uniqueKey":"options.editable_by","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"options","typeLabel":"object"},"approved_items_count":{"description":"Count of approved items","example":2,"type":"integer","readOnly":true,"uniqueKey":"approved_items_count","typeLabel":"integer"},"orders_last_7_days_count":{"description":"Count of orders in the last 7 days","example":8,"type":"integer","readOnly":true,"uniqueKey":"orders_last_7_days_count","typeLabel":"integer"},"proposals_received_last_7_days_count":{"description":"Count of proposals received in the last 7 days","example":8,"type":"integer","readOnly":true,"uniqueKey":"proposals_received_last_7_days_count","typeLabel":"integer"},"metadata":{"description":"Additional information, if any","type":"string","readOnly":true,"uniqueKey":"metadata","typeLabel":"string"},"attachments":{"type":"array","readOnly":true,"items":{"type":"object","properties":{"id":{"description":"Attachment or document ID","example":268,"type":"integer","readOnly":true,"uniqueKey":"attachments.items.[INDEX].id","typeLabel":"integer"},"content_type":{"description":"Content type","example":1,"type":"integer","uniqueKey":"attachments.items.[INDEX].content_type","typeLabel":"integer"},"object_id":{"description":"Attachement object ID","example":666,"type":"integer","uniqueKey":"attachments.items.[INDEX].object_id","typeLabel":"integer"},"file":{"oneOf":[{"description":"File name","example":"Sample file","type":"string","format":"uri","readOnly":true,"uniqueKey":"attachments.items.[INDEX].file.oneOf.0","typeLabel":"string\u003curi>"},{"description":"File name","example":"Sample file","type":"null","format":"uri","readOnly":true,"uniqueKey":"attachments.items.[INDEX].file.oneOf.1","typeLabel":"null"}],"uniqueKey":"attachments.items.[INDEX].file","typeLabel":"string\u003curi> | null"},"uploaded_by":{"oneOf":[{"description":"User ID that uploaded the attachment","example":646,"type":"integer","uniqueKey":"attachments.items.[INDEX].uploaded_by.oneOf.0","typeLabel":"integer"},{"description":"User ID that uploaded the attachment","example":646,"type":"null","uniqueKey":"attachments.items.[INDEX].uploaded_by.oneOf.1","typeLabel":"null"}],"uniqueKey":"attachments.items.[INDEX].uploaded_by","typeLabel":"integer | null"},"visible_by":{"description":"User permission who can view the attachment","example":"connections","type":"string","enum":["me","connections","everyone"],"uniqueKey":"attachments.items.[INDEX].visible_by","typeLabel":"enum\u003cstring>"},"original_filename":{"oneOf":[{"description":"Original file name","example":"Sample1","maxLength":255,"type":"string","uniqueKey":"attachments.items.[INDEX].original_filename.oneOf.0","typeLabel":"string"},{"description":"Original file name","example":"Sample1","maxLength":255,"type":"null","uniqueKey":"attachments.items.[INDEX].original_filename.oneOf.1","typeLabel":"null"}],"uniqueKey":"attachments.items.[INDEX].original_filename","typeLabel":"string | null"},"filename":{"oneOf":[{"description":"File name used for sharing","example":"Sample1","maxLength":255,"type":"string","uniqueKey":"attachments.items.[INDEX].filename.oneOf.0","typeLabel":"string"},{"description":"File name used for sharing","example":"Sample1","maxLength":255,"type":"null","uniqueKey":"attachments.items.[INDEX].filename.oneOf.1","typeLabel":"null"}],"uniqueKey":"attachments.items.[INDEX].filename","typeLabel":"string | null"},"tags":{"type":"array","readOnly":true,"items":{"required":["tag"],"type":"object","properties":{"tag":{"description":"attachment tag","example":"demotag","maxLength":128,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"attachments.items.[INDEX].tags.items.[INDEX].tag","typeLabel":"string"},"id":{"description":"Attachment tag ID","example":432,"type":"integer","readOnly":true,"uniqueKey":"attachments.items.[INDEX].tags.items.[INDEX].id","typeLabel":"integer"}},"uniqueKey":"attachments.items.[INDEX].tags.items.[INDEX]","typeLabel":"object"},"uniqueKey":"attachments.items.[INDEX].tags","typeLabel":"object[]"},"url":{"description":"URL of attachment","example":"https://assets.sample.com/attachments/path_to_attachment/attachment.pdf","minLength":1,"type":"string","format":"uri","uniqueKey":"attachments.items.[INDEX].url","typeLabel":"string\u003curi>"}},"uniqueKey":"attachments.items.[INDEX]","typeLabel":"object"},"uniqueKey":"attachments","typeLabel":"object[]"},"memos":{"type":"array","readOnly":true,"items":{"type":"object","properties":{"id":{"description":"Memo ID","example":1234,"type":"integer","readOnly":true,"uniqueKey":"memos.items.[INDEX].id","typeLabel":"integer"},"text":{"description":"Memo text","example":"Immediate requirement","type":"string","uniqueKey":"memos.items.[INDEX].text","typeLabel":"string"},"visibility":{"description":"Memo visibility","example":"any","type":"string","enum":["any","retailer","brand"],"uniqueKey":"memos.items.[INDEX].visibility","typeLabel":"enum\u003cstring>"},"acknowledged_at":{"description":"Time memo acknowledgement (UTC format)","example":"2022-01-10T15:24:56Z","type":"string","readOnly":true,"uniqueKey":"memos.items.[INDEX].acknowledged_at","typeLabel":"string"},"notify_people":{"description":"true: notify stakeholders \u003cbr /> false: do not notify","example":true,"type":"boolean","uniqueKey":"memos.items.[INDEX].notify_people","typeLabel":"boolean"},"created_by":{"type":"object","properties":{"id":{"description":"User ID who accepted or rejected the invoice","example":542,"type":"integer","readOnly":true,"uniqueKey":"memos.items.[INDEX].created_by.id","typeLabel":"integer"},"first_name":{"oneOf":[{"description":"First name of user","example":"Sample","maxLength":64,"type":"string","uniqueKey":"memos.items.[INDEX].created_by.first_name.oneOf.0","typeLabel":"string"},{"description":"First name of user","example":"Sample","maxLength":64,"type":"null","uniqueKey":"memos.items.[INDEX].created_by.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"memos.items.[INDEX].created_by.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"description":"Last name of user","example":"Demo","maxLength":64,"type":"string","uniqueKey":"memos.items.[INDEX].created_by.last_name.oneOf.0","typeLabel":"string"},{"description":"Last name of user","example":"Demo","maxLength":64,"type":"null","uniqueKey":"memos.items.[INDEX].created_by.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"memos.items.[INDEX].created_by.last_name","typeLabel":"string | null"},"title":{"oneOf":[{"description":"User title","example":"Demo","maxLength":64,"type":"string","uniqueKey":"memos.items.[INDEX].created_by.title.oneOf.0","typeLabel":"string"},{"description":"User title","example":"Demo","maxLength":64,"type":"null","uniqueKey":"memos.items.[INDEX].created_by.title.oneOf.1","typeLabel":"null"}],"uniqueKey":"memos.items.[INDEX].created_by.title","typeLabel":"string | null"},"status":{"description":"User status","example":"Active","type":"string","enum":["active","invited","locked"],"uniqueKey":"memos.items.[INDEX].created_by.status","typeLabel":"enum\u003cstring>"},"type":{"description":"User type","example":"standard","type":"string","enum":["standard","api"],"uniqueKey":"memos.items.[INDEX].created_by.type","typeLabel":"enum\u003cstring>"},"photo_url":{"description":"URL of the user photo","example":"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"memos.items.[INDEX].created_by.photo_url","typeLabel":"string\u003curi>"},"profile_photo":{"description":"URL of the user's profile photo","example":"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf","minLength":1,"type":"string","format":"uri","readOnly":true,"uniqueKey":"memos.items.[INDEX].created_by.profile_photo","typeLabel":"string\u003curi>"},"is_me":{"description":"true: user is me: \u003cbr /> false: user is not me","example":true,"type":"boolean","readOnly":true,"uniqueKey":"memos.items.[INDEX].created_by.is_me","typeLabel":"boolean"}},"uniqueKey":"memos.items.[INDEX].created_by","typeLabel":"object"},"created_by_context":{"oneOf":[{"description":"Represents whether memo is created by retailer or brand?","example":"retailer","type":"string","enum":["retailer","brand"],"uniqueKey":"memos.items.[INDEX].created_by_context.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"Represents whether memo is created by retailer or brand?","example":"retailer","type":"null","enum":["retailer","brand"],"uniqueKey":"memos.items.[INDEX].created_by_context.oneOf.1","typeLabel":"null"}],"uniqueKey":"memos.items.[INDEX].created_by_context","typeLabel":"enum\u003cstring> | null"},"created_at":{"description":"Time of memo creation (UTC format)","example":"2021-09-10T15:24:56Z","type":"string","format":"date-time","readOnly":true,"uniqueKey":"memos.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"description":"Time of memo update (UTC format)","example":"2022-09-10T15:24:56Z","type":"string","format":"date-time","readOnly":true,"uniqueKey":"memos.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"memos.items.[INDEX]","typeLabel":"object"},"uniqueKey":"memos","typeLabel":"object[]"},"referral":{"type":"object","properties":{"id":{"description":"ID of connection referral","example":125,"type":"integer","readOnly":true,"uniqueKey":"referral.id","typeLabel":"integer"},"referrer":{"required":["code","name"],"type":"object","properties":{"code":{"description":"Retailer or Vendor (Brand) code","example":"retailer_abc","maxLength":32,"minLength":1,"pattern":"^[-a-zA-Z0-9_]+$","type":"string","format":"slug","isRequired":true,"uniqueKey":"referral.referrer.code","typeLabel":"string\u003cslug>"},"name":{"description":"Retailer or Vendor (Brand) name","example":"Retailer ABC","maxLength":64,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"referral.referrer.name","typeLabel":"string"},"id":{"description":"Retailer or Vendor (Brand) ID","example":675,"type":"integer","readOnly":true,"uniqueKey":"referral.referrer.id","typeLabel":"integer"}},"uniqueKey":"referral.referrer","typeLabel":"object"},"referee":{"required":["code","name"],"type":"object","properties":{"code":{"description":"Retailer or Vendor (Brand) code","example":"retailer_abc","maxLength":32,"minLength":1,"pattern":"^[-a-zA-Z0-9_]+$","type":"string","format":"slug","isRequired":true,"uniqueKey":"referral.referee.code","typeLabel":"string\u003cslug>"},"name":{"description":"Retailer or Vendor (Brand) name","example":"Retailer ABC","maxLength":64,"minLength":1,"type":"string","isRequired":true,"uniqueKey":"referral.referee.name","typeLabel":"string"},"id":{"description":"Retailer or Vendor (Brand) ID","example":675,"type":"integer","readOnly":true,"uniqueKey":"referral.referee.id","typeLabel":"integer"}},"uniqueKey":"referral.referee","typeLabel":"object"},"is_brand_first_connection":{"description":"true: brand is first connection \u003cbr /> false: brand is not the first connection","example":"false\"","type":"boolean","uniqueKey":"referral.is_brand_first_connection","typeLabel":"boolean"},"is_retailer_first_connection":{"description":"true: retailer is first connection \u003cbr /> false: brand is not the first connection","example":true,"type":"boolean","uniqueKey":"referral.is_retailer_first_connection","typeLabel":"boolean"}},"uniqueKey":"referral","typeLabel":"object"},"packing_slip_template":{"oneOf":[{"description":"Template of the packing slip","maxLength":64,"type":"string","uniqueKey":"packing_slip_template.oneOf.0","typeLabel":"string"},{"description":"Template of the packing slip","maxLength":64,"type":"null","uniqueKey":"packing_slip_template.oneOf.1","typeLabel":"null"}],"uniqueKey":"packing_slip_template","typeLabel":"string | null"},"integration_type":{"oneOf":[{"description":"Integration type","example":"API","type":"string","enum":["console","edi","api","storefront","console-print-labels","console-register-tracking-numbers","shopify","bigcommerce","shipstation"],"uniqueKey":"integration_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"Integration type","example":"API","type":"null","enum":["console","edi","api","storefront","console-print-labels","console-register-tracking-numbers","shopify","bigcommerce","shipstation"],"uniqueKey":"integration_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"integration_type","typeLabel":"enum\u003cstring> | null"},"retailer_identifier":{"oneOf":[{"description":"Retailer identifier","example":"Retailer 877","maxLength":32,"type":"string","uniqueKey":"retailer_identifier.oneOf.0","typeLabel":"string"},{"description":"Retailer identifier","example":"Retailer 877","maxLength":32,"type":"null","uniqueKey":"retailer_identifier.oneOf.1","typeLabel":"null"}],"uniqueKey":"retailer_identifier","typeLabel":"string | null"},"onboarding_status":{"oneOf":[{"description":"Status of retailer onboarding","example":"Completed","type":"string","enum":["pending","complete"],"uniqueKey":"onboarding_status.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"Status of retailer onboarding","example":"Completed","type":"null","enum":["pending","complete"],"uniqueKey":"onboarding_status.oneOf.1","typeLabel":"null"}],"uniqueKey":"onboarding_status","typeLabel":"enum\u003cstring> | null"},"onboarding_target_date":{"oneOf":[{"description":"Target date for retailer onboarding (UTC format)","example":"2021-09-10T15:24:56Z","type":"string","format":"date-time","uniqueKey":"onboarding_target_date.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Target date for retailer onboarding (UTC format)","example":"2021-09-10T15:24:56Z","type":"null","format":"date-time","uniqueKey":"onboarding_target_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"onboarding_target_date","typeLabel":"string\u003cdate-time> | null"},"onboarded_at":{"oneOf":[{"description":"Time of retailer onboarding (UTC format)","example":"2021-09-10T15:24:56Z","type":"string","format":"date-time","uniqueKey":"onboarded_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"Time of retailer onboarding (UTC format)","example":"2021-09-10T15:24:56Z","type":"null","format":"date-time","uniqueKey":"onboarded_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"onboarded_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"brand":{"code":"vendor_abc","id":5424,"name":"Vendor ABC","logo_url":"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf","cover_url":"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf","profile_tile_url":"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf","uuid":"54a947ea-19db-4563-8447-1bb2f113c127","joined_at":"2021-09-10T15:24:56Z","default_ship_from_location":{"nickname":"Sample Location","id":87574,"type":"warehouse","address":null},"connections_manager":{"id":355,"first_name":"Demo","last_name":"Sample","email":"demo.sample@gmail.com","title":"Dr","phone":"1234567890","status":"active","type":"standard","photo_url":"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf","profile_photo":"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf","is_me":true},"merchandising_manager":{"id":355,"first_name":"Demo","last_name":"Sample","email":"demo.sample@gmail.com","title":"Dr","phone":"1234567890","status":"active","type":"standard","photo_url":"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf","profile_photo":"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf","is_me":true},"shipping_manager":{"id":542,"first_name":"Sample","last_name":"Demo","title":"Demo","status":"Active","type":"standard","photo_url":"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf","profile_photo":"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf","is_me":true},"preferences":[{"name":"Currency","code":"currency","type":"freeform","content_type":null,"id":901,"grouping":"Orders","priority":5,"description":"Sample description for demo preference","default_option":{"name":"Sample Prefs","code":"sample_prefs","id":234,"value":"\u003cstring>","currency":{"id":1,"name":"United States Dollar","symbol":"$","unit":"USD"},"timezone":{"name":"Demo","code":"demo","id":7567}},"options":[{"name":"Sample Prefs","code":"sample_prefs","id":234,"value":"\u003cstring>","currency":{"id":1,"name":"United States Dollar","symbol":"$","unit":"USD"},"timezone":{"name":"Demo","code":"demo","id":7567}}],"payload_type":"value","brand_preference":{"id":545,"option_id":"656","currency":{"id":1,"name":"United States Dollar","symbol":"$","unit":"USD"},"timezone":{"name":"Demo","code":"demo","id":7567},"value":"\u003cstring>"},"retailer_preference":{"id":124,"option_id":"SampleOpt123","currency":{"id":1,"name":"United States Dollar","symbol":"$","unit":"USD"},"timezone":{"name":"Demo","code":"demo","id":7567},"value":"\u003cstring>"},"user_preference":{"id":154,"option_id":"Sample Option","currency":{"id":1,"name":"United States Dollar","symbol":"$","unit":"USD"},"timezone":{"name":"Demo","code":"demo","id":7567},"value":"\u003cstring>"}}],"verticals":[{"name":"Sample Vertical","code":"sample_vertical","id":123,"assets":[{}]}],"attachments":[{"id":268,"content_type":1,"object_id":666,"file":"Sample file","uploaded_by":646,"visible_by":"connections","original_filename":"Sample1","filename":"Sample1","tags":[{"tag":"demotag","id":432}],"url":"https://assets.sample.com/attachments/path_to_attachment/attachment.pdf"}],"website":"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf","is_onboarded":true,"onboarded_at":"2021-09-10T15:24:56Z","assigned_onboarding_tasks":{"id":125,"onboarding_task":{"name":"Task1","code":"task1","type":"Initial","priority":2,"status":"In Progress","id":345,"description":"Onboard sample task 1","content_type":"PDF","created_at":"2021-09-10T15:24:56Z"},"info":{},"completed_at":"2021-09-10T15:24:56Z","completed_by":{"id":145,"first_name":"Demo","last_name":"Sample","name":"Demo Sample","email":"demo@xyz.com","title":"Mr","status":"active","type":"standard"},"created_at":"2021-09-10T15:24:56Z"},"requires_subscription":"disabled","inventory_policy":"unmanaged"},"connection_credentials":[{"name":"SampleCred","value":"Sample1","code":"sample_cred","id":125,"is_encrypted":true}],"id":1050,"level":"basic","status":"active","suspended_at":null,"created_at":"2021-09-10T15:24:56Z","updated_at":"2022-11-10T15:24:56Z","shipping_accounts":[{"nickname":"Sample13","id":1,"owner":"DemoABC","carrier":"ALP Brand","shipping_methods":{"name":"White Glove Bronze","code":"cory_white_glove","id":5,"type":"ltl (less than truck load)","carrier":{"id":229,"name":"Cory Companies","code":"CJCD"},"generic_shipping_method":{"name":"LTL","description":"Less than truckload (LTL)","id":5,"type":"ltl"}}}],"connection_contacts":[{"id":1546,"contact_type":"merchandising","brand":{"code":"demo-brand","id":500,"name":"Marla Cielo","joined_at":"2022-09-10T15:24:56Z","logo_url":"https://images.revcascade.com/retailers/defaults/logo-lg.png","cover_url":"https://images.revcascade.com/retailers/defaults/cover.png","profile_tile_url":"https://images.revcascade.com/retailers/defaults/profile-tile.png","website":null,"is_onboarded":false,"is_on_rcn":false,"requires_subscription":"enabled","subscription_expires_at":"2024-09-19T13:32:10Z","grace_period_ends_at":"2024-10-26T13:32:10Z","subscription_is_expired":false,"subscription_is_on_grace_period":false,"subscription_is_delinquent":false,"inventory_policy":"managed","status":"active"},"retailer":{"name":"Demo Retailer","code":"demo-retailer","id":500,"logo_url":"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/logo-lg.png","cover_url":"https://images.sampke.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/cover.jpg","profile_tile_url":"https://images.demo.com/retailers/5ef41f6c-3361-40b7-86ce-ecd79c52e9a2/store/profile-tile.jpg","joined_at":"2021-08-03T17:24:12Z","is_rcn_retailer":false,"is_onboarded":false,"platform":"fabric","requires_subscription":"disabled","brand_permit_creation_allowed":false,"website":"https://demoabc.com","status":"active"},"user_id":201,"first_name":"Demo","last_name":"Sample","email":"demo-sample@anc.com","phone":"12456245984"}],"connection_fees":{"id":1000,"payment_model":"managed","payment_terms":"net60","net_price_method":"permit_cost","revshare_fraction":"0.4000","revc_fee_flat":"0.00","revc_fee_fraction":"0.0300","brand_fee_flat":"0.00","brand_flat_order_fee":"0.00","brand_percent_order_fee":"0.0000","effective_at":"2015-10-10T00:00:00Z"},"connection_slas":{"id":1000,"brand_inventory_hours":24,"brand_fulfillment_hours":48,"brand_cancel_hours":24,"brand_acknowledge_hours":12,"retailer_cancel_hours":24,"retailer_return_hours":720},"connection_adjustments":[{"description":"Sample description for monetary adjustments","id":123442,"adjustment_code":{"adjustment_type":"Allowance","code":"returns_allowance","description":"returns_allowance","id":1},"adjustment_type":"Discount","adjustment_amount_type":"flat","adjustment_amount":"12","content_type":"PDF","object_id":45646}],"options":{"name":"Sample Option","code":"Sample_Option","id":8753,"description":"Sample description for connection","viewable_by":"All","editable_by":"Staff"},"approved_items_count":2,"orders_last_7_days_count":8,"proposals_received_last_7_days_count":8,"metadata":"\u003cstring>","attachments":[{"id":268,"content_type":1,"object_id":666,"file":"Sample file","uploaded_by":646,"visible_by":"connections","original_filename":"Sample1","filename":"Sample1","tags":[{"tag":"demotag","id":432}],"url":"https://assets.sample.com/attachments/path_to_attachment/attachment.pdf"}],"memos":[{"id":1234,"text":"Immediate requirement","visibility":"any","acknowledged_at":"2022-01-10T15:24:56Z","notify_people":true,"created_by":{"id":542,"first_name":"Sample","last_name":"Demo","title":"Demo","status":"Active","type":"standard","photo_url":"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf","profile_photo":"https://assets.demo.com/attachments/path_to_attachment/attachment.pdf","is_me":true},"created_by_context":"retailer","created_at":"2021-09-10T15:24:56Z","updated_at":"2022-09-10T15:24:56Z"}],"referral":{"id":125,"referrer":{"code":"retailer_abc","name":"Retailer ABC","id":675},"referee":{"code":"retailer_abc","name":"Retailer ABC","id":675},"is_brand_first_connection":"false\"","is_retailer_first_connection":true},"packing_slip_template":"\u003cstring>","integration_type":"API","retailer_identifier":"Retailer 877","onboarding_status":"Completed","onboarding_target_date":"2021-09-10T15:24:56Z","onboarded_at":"2021-09-10T15:24:56Z"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"331444f0-6a57-45ef-b23c-4377664f6c27":{"Bearer":{"type":"http","scheme":"bearer","scopes":[]}}},"servers":{"7287f2df-565c-45a0-aace-9e7362b555ba":{"url":"https://marketplace-api.fabric.inc"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","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":"Bearer","name":"Authorization"}],"title":"Bearer"}]},"originalFileLocation":"openapi/marketplace/v1/marketplace.yaml"},"subdomain":"fabric-demo","siteName":"Fabric","title":"Get connections of a single vendor - Fabric","navMaps":{"firstHrefInVersion":{"Product Agent":{"href":"/home","matchLevel":4},"v3":{"href":"/v3/dropship/homepage","matchLevel":2},"v2":{"href":"/v2/api-reference/dropship/connections/get-connections-of-a-single-vendor","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-01-22T21:06:38.241Z","originalFileLocation":"v2/api-reference/dropship/connections/get-connections-of-a-single-vendor.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=\"Gets the connection details for a specified vendor\">\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=\"Get connections of a single vendor - Fabric\">\u003cmeta data-mint-head property=\"og:description\" content=\"Gets the connection details for a specified vendor\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Fabric\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.fabric.inc/v2/api-reference/dropship/connections/get-connections-of-a-single-vendor\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://fabric-demo.mintlify.site/_mintlify/api/og/v2?division=Connections\u0026amp;title=Get+connections+of+a+single+vendor\u0026amp;description=Gets+the+connection+details+for+a+specified+vendor\u0026amp;theme=d21d2e5604bc479b7e92e42c\u0026amp;signature=ca56f42024942b2f8f685b5c7ef0ba8e6a0027d067f4d7a3aab3fce2cf17421e\">\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=\"Get connections of a single vendor - Fabric\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Gets the connection details for a specified vendor\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://fabric-demo.mintlify.site/_mintlify/api/og/v2?division=Connections\u0026amp;title=Get+connections+of+a+single+vendor\u0026amp;description=Gets+the+connection+details+for+a+specified+vendor\u0026amp;theme=d21d2e5604bc479b7e92e42c\u0026amp;signature=ca56f42024942b2f8f685b5c7ef0ba8e6a0027d067f4d7a3aab3fce2cf17421e\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/fabric-demo/4aXl3Y2Jab1lmXrs/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Fabric\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#ff2ec1\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.fabric.inc/v2/api-reference/dropship/connections/get-connections-of-a-single-vendor\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/v2/api-reference/dropship/connections/get-connections-of-a-single-vendor.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.fabric.inc/#organization\",\"name\":\"Fabric\",\"url\":\"https://developer.fabric.inc\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/fabric-demo/OzlZxX-hOwze1Aen/logo/darkneon.png?fit=max\u0026auto=format\u0026n=OzlZxX-hOwze1Aen\u0026q=85\u0026s=332d2284d5f41dc42f5b9e0bcd473872\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.fabric.inc#website\",\"name\":\"Fabric\",\"url\":\"https://developer.fabric.inc\",\"publisher\":{\"@id\":\"https://developer.fabric.inc/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.fabric.inc/v2/api-reference/dropship/connections/get-connections-of-a-single-vendor#webpage\",\"url\":\"https://developer.fabric.inc/v2/api-reference/dropship/connections/get-connections-of-a-single-vendor\",\"name\":\"Get connections of a single vendor\",\"description\":\"Gets the connection details for a specified vendor\",\"dateModified\":\"2026-01-22T21:06:38.241Z\",\"isPartOf\":{\"@id\":\"https://developer.fabric.inc#website\"},\"breadcrumb\":{\"@id\":\"https://developer.fabric.inc/v2/api-reference/dropship/connections/get-connections-of-a-single-vendor#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.fabric.inc/v2/api-reference/dropship/connections/get-connections-of-a-single-vendor#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Dropship\",\"item\":\"https://developer.fabric.inc/v2/api-reference/dropship/dropship-api\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Connections\",\"item\":\"https://developer.fabric.inc/v2/api-reference/dropship/connections/get-vendor-connections\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get connections of a single vendor\",\"item\":\"https://developer.fabric.inc/v2/api-reference/dropship/connections/get-connections-of-a-single-vendor\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.fabric.inc/v2/api-reference/dropship/connections/get-connections-of-a-single-vendor#apireference\",\"headline\":\"Get connections of a single vendor\",\"name\":\"Get connections of a single vendor\",\"description\":\"Gets the connection details for a specified vendor\",\"url\":\"https://developer.fabric.inc/v2/api-reference/dropship/connections/get-connections-of-a-single-vendor\",\"mainEntityOfPage\":{\"@id\":\"https://developer.fabric.inc/v2/api-reference/dropship/connections/get-connections-of-a-single-vendor#webpage\"},\"dateModified\":\"2026-01-22T21:06:38.241Z\",\"publisher\":{\"@id\":\"https://developer.fabric.inc/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.fabric.inc#website\"}}]}\u003c/script>","siteName":"Fabric","nav":{"global":null,"versions":[{"version":"Product Agent","pages":[{"title":"Product Agent","href":"/home"}]},{"version":"v3","pages":[{"title":"v3","href":"/v3/dropship/homepage"}]},{"version":"v2","tabs":[{"tab":"Home","pages":[{"title":"Home","href":"/v2/home"}]},{"tab":"API Reference","groups":[{"group":"Authentication v1","pages":[{"title":"Identity APIs","href":"/v2/api-reference/authentication-v1/identity-apis"},{"group":"User","pages":[{"title":"User","sidebarTitle":"Overview","href":"/v2/api-reference/authentication-v1/user/overview"},{"openapi":"identity_v1 get /api-commerceIdentity/user/{userId}","title":"Get user","href":"/v2/api-reference/authentication-v1/user/get-user"},{"openapi":"identity_v1 patch /api-commerceIdentity/user/{userId}/username","title":"Update user name","href":"/v2/api-reference/authentication-v1/user/update-user-name"},{"openapi":"identity_v1 post /api-commerceIdentity/user/local","title":"Create local user","href":"/v2/api-reference/authentication-v1/user/create-local-user"},{"openapi":"identity_v1 post /api-commerceIdentity/user/guest","title":"Create guest user","href":"/v2/api-reference/authentication-v1/user/create-guest-user"}]},{"group":"Address","pages":[{"title":"Address","sidebarTitle":"Overview","href":"/v2/api-reference/authentication-v1/address/overview"},{"openapi":"identity_v1 get /api-commerceIdentity/user/{userId}/address","title":"List user's addresses","href":"/v2/api-reference/authentication-v1/address/list-users-addresses"},{"openapi":"identity_v1 post /api-commerceIdentity/user/{userId}/address","title":"Create user address","href":"/v2/api-reference/authentication-v1/address/create-user-address"},{"openapi":"identity_v1 get /api-commerceIdentity/user/{userId}/address/{addressId}","title":"Get specific address","href":"/v2/api-reference/authentication-v1/address/get-specific-address"},{"openapi":"identity_v1 put /api-commerceIdentity/user/{userId}/address/{addressId}","title":"Update specific address","href":"/v2/api-reference/authentication-v1/address/update-specific-address"},{"openapi":"identity_v1 delete /api-commerceIdentity/user/{userId}/address/{addressId}","title":"Delete specific address","href":"/v2/api-reference/authentication-v1/address/delete-specific-address"},{"openapi":"identity_v1 post /api-commerceIdentity/user/{userId}/address/{addressId}/set","title":"Set default address","href":"/v2/api-reference/authentication-v1/address/set-default-address"},{"openapi":"identity_v1 post /api-commerceIdentity/user/{userId}/address/{addressId}/unset","title":"Unset default address","href":"/v2/api-reference/authentication-v1/address/unset-default-address"}]},{"group":"Auth","pages":[{"title":"Auth","sidebarTitle":"Overview","href":"/v2/api-reference/authentication-v1/auth/overview"},{"openapi":"identity_v1 post /api-commerceIdentity/auth/local/login","title":"Log in local user","href":"/v2/api-reference/authentication-v1/auth/log-in-local-user"},{"openapi":"identity_v1 post /api-commerceIdentity/auth/local/refresh","title":"Refresh local user","href":"/v2/api-reference/authentication-v1/auth/refresh-local-user"},{"openapi":"identity_v1 patch /api-commerceIdentity/auth/local/reset","title":"Reset password","href":"/v2/api-reference/authentication-v1/auth/reset-password"},{"openapi":"identity_v1 patch /api-commerceIdentity/auth/password","title":"Update password","href":"/v2/api-reference/authentication-v1/auth/update-password"},{"openapi":"identity_v1 patch /api-commerceIdentity/auth/change-password","title":"Change password","href":"/v2/api-reference/authentication-v1/auth/change-password"},{"openapi":"identity_v1 get /api-commerceIdentity/auth/token/{token}","title":"Verify reset token","href":"/v2/api-reference/authentication-v1/auth/verify-reset-token"}]}]},{"group":"User Self Service APIs","pages":[{"title":"Introduction","href":"/v2/api-reference/user-self-service-apis/introduction"},{"group":"User Self Service APIs","pages":[{"title":"User Self Service APIs","href":"/v2/api-reference/user-self-service-apis/user-self-service-apis/overview"},{"openapi":"identity_v2 get /users/self","title":"Get user details","href":"/v2/api-reference/user-self-service-apis/user-self-service-apis/get-user-details"},{"openapi":"identity_v2 put /users/self","title":"Update user details","href":"/v2/api-reference/user-self-service-apis/user-self-service-apis/update-user-details"},{"openapi":"identity_v2 post /auth/self/password","title":"Change password","href":"/v2/api-reference/user-self-service-apis/user-self-service-apis/change-password"},{"openapi":"identity_v2 post /auth/forgot-password","title":"Forgot password","href":"/v2/api-reference/user-self-service-apis/user-self-service-apis/forgot-password"}]},{"group":"Authentication APIs","pages":[{"title":"Authentication APIs","href":"/v2/api-reference/user-self-service-apis/authentication-apis/overview"},{"openapi":"authentication_v3 get /oauth2/default/v1/authorize","title":"Authorize user apps with and without PKCE","href":"/v2/api-reference/user-self-service-apis/authentication-apis/authorize-user-app-with-and-without-pkce"},{"openapi":"authentication_v3 post /oauth2/{authServerId}/v1/token","title":"Fetch access token","href":"/v2/api-reference/user-self-service-apis/authentication-apis/fetch-access-token"}]}]},{"group":"Experiences v2 (XM v2)","pages":[{"title":"XM","href":"/v2/api-reference/xm-v2/xm"},{"group":"Pages","pages":[{"title":"Pages","sidebarTitle":"Overview","href":"/v2/api-reference/xm-v2/pages/overview"},{"openapi":"xm_v2 get /v2/pages/live","title":"Get Live Pages For Specified Channels","href":"/v2/api-reference/xm-v2/pages/get-live-pages-for-specified-channels"},{"openapi":"xm_v2 get /v2/pages/metadata","title":"Get meta information about live pages","href":"/v2/api-reference/xm-v2/pages/get-meta-information-about-live-pages"},{"openapi":"xm_v2 get /v2/page/live","title":"Get Live Page For A Channel By URL","href":"/v2/api-reference/xm-v2/pages/get-live-page-for-a-channel-by-url"}]},{"group":"Global Components","pages":[{"title":"Global Componenets","sidebarTitle":"Overview","href":"/v2/api-reference/xm-v2/global-components/overview"},{"openapi":"xm_v2 get /v2/global-component/live","title":"Get Live Global Components For A Channel","href":"/v2/api-reference/xm-v2/global-components/get-live-global-components-for-a-channel"}]},{"group":"Menu","pages":[{"title":"Menu","sidebarTitle":"Overview","href":"/v2/api-reference/xm-v2/menu/overview"},{"openapi":"xm_v2 get /v2/menu/live","title":"Get Live Menu For A Channel","href":"/v2/api-reference/xm-v2/menu/get-live-menu-for-a-channel"}]}]},{"group":"Experiences v1 (XM v1)","pages":[{"title":"XM","href":"/v2/api-reference/xm-v1/xm"},{"group":"Pages","pages":[{"title":"Pages","sidebarTitle":"Overview","href":"/v2/api-reference/xm-v1/pages/overview"},{"openapi":"xm_v1 get /pages/live","title":"Retrieves Live Pages","href":"/v2/api-reference/xm-v1/pages/retrieves-live-pages"},{"openapi":"xm_v1 get /page/live","title":"Retrieves Live Page By URL","href":"/v2/api-reference/xm-v1/pages/retrieves-live-page-by-url"}]},{"group":"Global Components","pages":[{"title":"Global Componenets","sidebarTitle":"Overview","href":"/v2/api-reference/xm-v1/global-components/overview"},{"openapi":"xm_v1 get /global-component/live","title":"Retrieves Live Global Components","href":"/v2/api-reference/xm-v1/global-components/retrieves-live-global-components"}]},{"group":"Menu","pages":[{"title":"Menu","sidebarTitle":"Overview","href":"/v2/api-reference/xm-v1/menu/overview"},{"openapi":"xm_v1 get /menu/items","title":"Retrieves All Menu Items","href":"/v2/api-reference/xm-v1/menu/retrieves-all-menu-items"},{"openapi":"xm_v1 get /menu","title":"Retrieves Menu List","href":"/v2/api-reference/xm-v1/menu/retrieves-menu-list"}]}]},{"group":"Product Catalog","pages":[{"title":"Product Catalog","href":"/v2/api-reference/product-catalog/product-information-management"},{"group":"Category","pages":[{"title":"Category","sidebarTitle":"Overview","href":"/v2/api-reference/product-catalog/category/overview"},{"openapi":"pim post /api-category/v1/category","title":"Create category","href":"/v2/api-reference/product-catalog/category/create-category"},{"openapi":"pim get /api-category/v1/category","title":"Get categories","href":"/v2/api-reference/product-catalog/category/get-categories"},{"openapi":"pim put /api-category/v1/category/{nodeId}","title":"Modify category","href":"/v2/api-reference/product-catalog/category/modify-category"},{"openapi":"pim get /api-category/v1/category/search","title":"Find categories","href":"/v2/api-reference/product-catalog/category/find-categories"},{"openapi":"pim get /api-category/v1/category/tree","title":"Get category tree","href":"/v2/api-reference/product-catalog/category/get-category-tree"},{"openapi":"pim get /api-category/v1/category/sku","title":"Get SKUs in a category","href":"/v2/api-reference/product-catalog/category/get-skus-in-a-category"},{"openapi":"pim post /api-category/v1/category/attribute","title":"Assign and unassign category attributes","href":"/v2/api-reference/product-catalog/category/assign-and-unassign-category-attributes"},{"openapi":"pim get /api-category/v1/category/attribute","title":"Get assigned category attributes","href":"/v2/api-reference/product-catalog/category/get-assigned-category-attributes"},{"openapi":"pim post /api-category/v1/category/item-attribute","title":"Assign and unassign item attributes","href":"/v2/api-reference/product-catalog/category/assign-and-unassign-item-attributes"},{"openapi":"pim get /api-category/v1/category/item-attribute","title":"Get assigned item attributes","href":"/v2/api-reference/product-catalog/category/get-assigned-item-attributes"},{"openapi":"pim post /api-category/v1/category/source","title":"Add and remove category source inclusions","href":"/v2/api-reference/product-catalog/category/add-and-remove-category-source-inclusions"},{"openapi":"pim get /api-category/v1/category/source","title":"Get category source inclusions","href":"/v2/api-reference/product-catalog/category/get-category-source-inclusions"},{"openapi":"pim post /api-category/v1/category/source/exclusion","title":"Add and remove category source exclusions","href":"/v2/api-reference/product-catalog/category/add-and-remove-category-source-exclusions"},{"openapi":"pim get /api-category/v1/category/source/exclusion","title":"Get category source exclusions","href":"/v2/api-reference/product-catalog/category/get-category-source-exclusions"},{"openapi":"pim post /api-category/v1/category/item-attribute/condition","title":"Add and remove item attribute conditions","href":"/v2/api-reference/product-catalog/category/add-and-remove-item-attribute-conditions"},{"openapi":"pim get /api-category/v1/category/item-attribute/condition","title":"Get item attribute conditions","href":"/v2/api-reference/product-catalog/category/get-item-attribute-conditions"},{"openapi":"pim post /api-category/v1/category/bulk/upsert","title":"Create or update multiple categories or collections","href":"/v2/api-reference/product-catalog/category/create-or-update-multiple-categories-or-collections"},{"openapi":"pim post /api-category/v1/category/find","title":"Find categories","href":"/v2/api-reference/product-catalog/category/find-categories-1"},{"openapi":"pim post /api-category/v1/category/bulk/category-attribute","title":"Manage category attributes for multiple categories or collections","href":"/v2/api-reference/product-catalog/category/manage-category-attributes-for-multiple-categories-or-collections"},{"openapi":"pim post /api-category/v1/category/bulk/item-attribute","title":"Manage item attributes for multiple categories","href":"/v2/api-reference/product-catalog/category/manage-item-attributes-for-multiple-categories"}]},{"group":"Product","pages":[{"title":"Product","sidebarTitle":"Overview","href":"/v2/api-reference/product-catalog/product/overview"},{"openapi":"pim post /api-product/v1/product/bulk/insert","title":"Create items and bundles","href":"/v2/api-reference/product-catalog/product/create-items-and-bundles"},{"openapi":"pim post /api-product/v1/product/bulk/update","title":"Update items and bundles","href":"/v2/api-reference/product-catalog/product/update-items-and-bundles"},{"openapi":"pim post /api-product/v1/product/bulk/upsert","title":"Upsert items and bundles","href":"/v2/api-reference/product-catalog/product/upsert-items-and-bundles"},{"openapi":"pim post /api-product/v1/product/bundle/update","title":"Update items in bundle","href":"/v2/api-reference/product-catalog/product/update-items-in-bundle"},{"openapi":"pim get /api-product/v1/product","title":"Get items and children items","href":"/v2/api-reference/product-catalog/product/get-items-and-children-items"},{"openapi":"pim get /api-product/v2/product","title":"Get items and limited children items","href":"/v2/api-reference/product-catalog/product/get-items-and-limited-children-items"},{"openapi":"pim get /api-product/v1/product/search","title":"Find items","href":"/v2/api-reference/product-catalog/product/find-items"},{"openapi":"pim get /api-product/v1/product/attribute","title":"Get item attributes","href":"/v2/api-reference/product-catalog/product/get-item-attributes"}]},{"group":"Attributes","pages":[{"title":"Attributes","sidebarTitle":"Overview","href":"/v2/api-reference/product-catalog/attributes/overview"},{"openapi":"pim post /api-category/v1/category/attribute/bulk","title":"Create, update and delete category attributes","href":"/v2/api-reference/product-catalog/attributes/create-update-and-delete-category-attributes"},{"openapi":"pim post /api-product/v1/product/attribute/bulk","title":"Create update and delete item attributes","href":"/v2/api-reference/product-catalog/attributes/create-update-and-delete-item-attributes"},{"openapi":"pim post /api-product/v1/product/attribute-group","title":"Create, update and delete attribute groups","href":"/v2/api-reference/product-catalog/attributes/create-update-and-delete-attribute-groups"},{"openapi":"pim post /api-product/v1/product/attribute-group/search","title":"Find attribute groups","href":"/v2/api-reference/product-catalog/attributes/find-attribute-groups"},{"openapi":"pim post /api-product/v1/product/attribute/mapping/search","title":"Find attribute mapping","href":"/v2/api-reference/product-catalog/attributes/find-attribute-mapping"},{"openapi":"pim post /api-product/v1/product/attribute/mapping","title":"Create and Update attribute mappings","href":"/v2/api-reference/product-catalog/attributes/create-and-update-attribute-mappings"}]},{"group":"Bulk Import","pages":[{"title":"Bulk Import","sidebarTitle":"Overview","href":"/v2/api-reference/product-catalog/bulk-import/overview"},{"openapi":"pim get /api-category/v1/category/bulk/template","title":"Generate CSV template for categories","href":"/v2/api-reference/product-catalog/bulk-import/generate-csv-template-for-categories"},{"openapi":"pim post /api-category/v1/upload-url","title":"Generate S3 bucket URL for categories import","href":"/v2/api-reference/product-catalog/bulk-import/generate-s3-bucket-url-for-categories-import"},{"openapi":"pim post /api-category/v1/category/file/search","title":"Get imported files for categories","href":"/v2/api-reference/product-catalog/bulk-import/get-imported-files-for-categories"},{"openapi":"pim get /api-category/v1/category/bulk/file/{fileId}/status","title":"Get file upload status","href":"/v2/api-reference/product-catalog/bulk-import/get-file-upload-status"},{"openapi":"pim get /api-product/v1/product/bulk/template/{accountId}/{nodeId}","title":"Generate CSV template file for items","href":"/v2/api-reference/product-catalog/bulk-import/generate-csv-template-file-for-items"},{"openapi":"pim post /api-product/v1/upload-url","title":"Generate S3 bucket URL for item import","href":"/v2/api-reference/product-catalog/bulk-import/generate-s3-bucket-url-for-item-import"},{"openapi":"pim post /api-product/v1/product/file/search","title":"Get imported files for items","href":"/v2/api-reference/product-catalog/bulk-import/get-imported-files-for-items"},{"openapi":"pim get /api-product/v1/product/bulk/template/bundle/{accountId}/{nodeId}","title":"Generate CSV template for bundles","href":"/v2/api-reference/product-catalog/bulk-import/generate-csv-template-for-bundles"},{"openapi":"pim post /api-product/v1/upload-url/bundle","title":"Generate S3 bucket URL for bundle import","href":"/v2/api-reference/product-catalog/bulk-import/generate-s3-bucket-url-for-bundle-import"},{"openapi":"pim post /api-product/v1/product/file/bundle/search","title":"Get imported files for bundles","href":"/v2/api-reference/product-catalog/bulk-import/get-imported-files-for-bundles"},{"openapi":"pim get /api-product/v1/product/bulk/template/attribute","title":"Generate CSV template for item attributes","href":"/v2/api-reference/product-catalog/bulk-import/generate-csv-template-for-item-attributes"},{"openapi":"pim post /api-product/v1/upload-url/attribute","title":"Generate S3 bucket URL for item attribute import","href":"/v2/api-reference/product-catalog/bulk-import/generate-s3-bucket-url-for-item-attribute-import"},{"openapi":"pim post /api-product/v1/product/file/attribute/search","title":"Get imported files for item attributes","href":"/v2/api-reference/product-catalog/bulk-import/get-imported-files-for-item-attributes"},{"openapi":"pim get /api-product/v1/product/bulk/file/{fileId}/status","title":"Get file upload status","href":"/v2/api-reference/product-catalog/bulk-import/get-file-upload-status-1"}]}]},{"group":"Orders v2 (OMS v2)","pages":[{"title":"Order Management System","href":"/v2/api-reference/orders-v2/order-management-system"},{"group":"Order","pages":[{"title":"Order","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/order/overview"},{"openapi":"oms_v2_combined post /order/","title":"Create an order","href":"/v2/api-reference/orders-v2/order/create-an-order"},{"openapi":"oms_v2_combined get /order/","title":"Get an order","href":"/v2/api-reference/orders-v2/order/get-an-order"},{"openapi":"oms_v2_combined put /order/{orderNumber}","title":"Update an order","href":"/v2/api-reference/orders-v2/order/update-an-order"},{"openapi":"oms_v2_combined post /order/query","title":"Get orders by query","href":"/v2/api-reference/orders-v2/order/get-orders-by-query"},{"openapi":"oms_v2_combined patch /order/{orderId}/shipto/{shipToId}/pickup","title":"Update pickup information of an order","href":"/v2/api-reference/orders-v2/order/update-pickup-information-of-an-order"},{"openapi":"oms_v2_combined patch /order/{orderId}/customer","title":"Update customer information for an order","href":"/v2/api-reference/orders-v2/order/update-customer-information-for-an-order"},{"openapi":"oms_v2_combined get /order/exchange","title":"Check order-exchange eligibility","href":"/v2/api-reference/orders-v2/order/check-order-exchange-eligibility"}]},{"group":"Order Attribute","pages":[{"title":"Order Attribute","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/order-attribute/overview"},{"openapi":"oms_v2_combined get /order/attribute","title":"Get all attributes","href":"/v2/api-reference/orders-v2/order-attribute/get-all-attributes"},{"openapi":"oms_v2_combined post /order/attribute","title":"Create attribute","href":"/v2/api-reference/orders-v2/order-attribute/create-attribute"},{"openapi":"oms_v2_combined get /order/attribute/{code}","title":"Get a specific attribute","href":"/v2/api-reference/orders-v2/order-attribute/get-a-specific-attribute"},{"openapi":"oms_v2_combined put /order/attribute/{code}","title":"update a specific attribute","href":"/v2/api-reference/orders-v2/order-attribute/update-a-specific-attribute"},{"openapi":"oms_v2_combined delete /order/attribute/{code}","title":"Delete an attribute by code","href":"/v2/api-reference/orders-v2/order-attribute/delete-an-attribute-by-code"}]},{"group":"Order Return","pages":[{"title":"Order Return","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/order-return/overview"},{"openapi":"oms_v2_combined get /order/returns","title":"Check order return eligibility","href":"/v2/api-reference/orders-v2/order-return/check-order-return-eligibility"},{"openapi":"oms_v2_combined post /order/returns","title":"Return order","href":"/v2/api-reference/orders-v2/order-return/return-order"}]},{"group":"Payment Status","pages":[{"openapi":"oms_v2_combined post /order/payment-status/{orderNumber}","title":"Get payment details for a specific order","href":"/v2/api-reference/orders-v2/payment-status/get-payment-details-for-a-specific-order"}]},{"group":"Package Tracking","pages":[{"title":"Package Tracking","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/package-tracking/overview"},{"openapi":"oms_v2_combined post /order/package-tracking/acknowledge","title":"Acknowledge package tracking","href":"/v2/api-reference/orders-v2/package-tracking/acknowledge-package-tracking"}]},{"group":"Cross Border","pages":[{"title":"Cross Border","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/cross-border/overview"},{"openapi":"oms_v2_combined post /order/cross-border/validate-order","title":"Validate order for international shipping","href":"/v2/api-reference/orders-v2/cross-border/validate-order-for-international-shipping"},{"openapi":"oms_v2_combined post /order/cross-border/release-order","title":"Releases order","href":"/v2/api-reference/orders-v2/cross-border/releases-order"}]},{"group":"Order Cancellation","pages":[{"title":"Order Cancellation","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/order-cancellation/overview"},{"openapi":"oms_v2_combined get /order/cancel","title":"Check order-cancellation eligibility","href":"/v2/api-reference/orders-v2/order-cancellation/check-order-cancellation-eligibility"},{"openapi":"oms_v2_combined post /order/cancel","title":"Cancel order","href":"/v2/api-reference/orders-v2/order-cancellation/cancel-order"}]},{"group":"Appeasement","pages":[{"title":"Appeasement","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/appeasement/overview"},{"openapi":"oms_v2_combined post /order/appeasement","title":"Create appeasement","href":"/v2/api-reference/orders-v2/appeasement/create-appeasement"}]},{"group":"Allocation","pages":[{"title":"Allocation","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/allocation/overview"},{"openapi":"oms_v2_combined get /allocation/{allocationId}","title":"Get allocation","href":"/v2/api-reference/orders-v2/allocation/get-allocation"},{"openapi":"oms_v2_combined put /allocation/{allocationId}","title":"Update allocation","href":"/v2/api-reference/orders-v2/allocation/update-allocation"},{"openapi":"oms_v2_combined post /allocation/query","title":"Get allocation by query","href":"/v2/api-reference/orders-v2/allocation/get-allocation-by-query"},{"openapi":"oms_v2_combined put /allocation/reallocate","title":"Reallocate location","href":"/v2/api-reference/orders-v2/allocation/reallocate-location"},{"openapi":"oms_v2_combined put /allocation/cancel/{allocationIds}","title":"Cancel allocation ","href":"/v2/api-reference/orders-v2/allocation/cancel-allocation"}]},{"group":"Configuration","pages":[{"title":"Configuration","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/configuration/overview"},{"openapi":"oms_v2_combined get /configurations/tenant-config","title":"Get All configuration for tenant.","href":"/v2/api-reference/orders-v2/configuration/get-all-configuration-for-tenant"},{"openapi":"oms_v2_combined put /configurations/tenant-config","title":"Replace all tenant configuration for tenant","href":"/v2/api-reference/orders-v2/configuration/replace-all-tenant-configuration-for-tenant"},{"openapi":"oms_v2_combined post /configurations/tenant-config","title":"Create a configuration for tenant.","href":"/v2/api-reference/orders-v2/configuration/create-a-configuration-for-tenant"},{"openapi":"oms_v2_combined patch /configurations/tenant-config","title":"Update All the configuration for tenant.","href":"/v2/api-reference/orders-v2/configuration/update-all-the-configuration-for-tenant"},{"openapi":"oms_v2_combined get /configurations/tenant-config/{configType}/name/{configName}","title":"Get configuration for tenant.","href":"/v2/api-reference/orders-v2/configuration/get-configuration-for-tenant"},{"openapi":"oms_v2_combined put /configurations/tenant-config/{configType}/name/{configName}","title":"Replace the configuration for tenant.","href":"/v2/api-reference/orders-v2/configuration/replace-the-configuration-for-tenant"},{"openapi":"oms_v2_combined delete /configurations/tenant-config/{configType}/name/{configName}","title":"Delete the tenant's configuration.","href":"/v2/api-reference/orders-v2/configuration/delete-the-tenants-configuration"},{"openapi":"oms_v2_combined patch /configurations/tenant-config/{configType}/name/{configName}","title":"Update tenant configuration for tenant.","href":"/v2/api-reference/orders-v2/configuration/update-tenant-configuration-for-tenant"},{"openapi":"oms_v2_combined post /configurations/tenant-config/query","title":"Get configuration for given filters.","href":"/v2/api-reference/orders-v2/configuration/get-configuration-for-given-filters"}]},{"group":"Fraud Configuration","pages":[{"title":null,"sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/fraud-configuration/overview"},{"openapi":"oms_v2_combined get /configurations/fraud-config/{processName}/{serviceName}","title":"Get All Fraud configuration for tenant.","href":"/v2/api-reference/orders-v2/fraud-configuration/get-all-fraud-configuration-for-tenant"},{"openapi":"oms_v2_combined put /configurations/fraud-config/{processName}/{serviceName}","title":"Replace the Fraud configuration for tenant.","href":"/v2/api-reference/orders-v2/fraud-configuration/replace-the-fraud-configuration-for-tenant"},{"openapi":"oms_v2_combined delete /configurations/fraud-config/{processName}/{serviceName}","title":"Delete the Fraud's configuration.","href":"/v2/api-reference/orders-v2/fraud-configuration/delete-the-frauds-configuration"},{"openapi":"oms_v2_combined get /configurations/fraud-config","title":"Get All Fraud configuration for tenant.","href":"/v2/api-reference/orders-v2/fraud-configuration/get-all-fraud-configuration-for-tenant-1"},{"openapi":"oms_v2_combined post /configurations/fraud-config","title":"Create a Fraud configuration for tenant.","href":"/v2/api-reference/orders-v2/fraud-configuration/create-a-fraud-configuration-for-tenant"}]},{"group":"Target Configuration","pages":[{"title":"Target Configuration","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/target-configuration/overview"},{"openapi":"oms_v2_combined get /configurations/target-config","title":"Get All Target configuration for tenant.","href":"/v2/api-reference/orders-v2/target-configuration/get-all-target-configuration-for-tenant"},{"openapi":"oms_v2_combined post /configurations/target-config","title":"Create a Target configuration for tenant.","href":"/v2/api-reference/orders-v2/target-configuration/create-a-target-configuration-for-tenant"},{"openapi":"oms_v2_combined get /configurations/target-config/{serviceName}/{processName}","title":"Get configuration for tenant.","href":"/v2/api-reference/orders-v2/target-configuration/get-configuration-for-tenant"},{"openapi":"oms_v2_combined delete /configurations/target-config/{serviceName}/{processName}","title":"Delete the Target's configuration.","href":"/v2/api-reference/orders-v2/target-configuration/delete-the-targets-configuration"}]},{"group":"Location","pages":[{"title":"Location","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/location/overview"},{"openapi":"oms_v2_combined get /location","title":"Get all locations","href":"/v2/api-reference/orders-v2/location/get-all-locations"},{"openapi":"oms_v2_combined post /location","title":"Create location","href":"/v2/api-reference/orders-v2/location/create-location"},{"openapi":"oms_v2_combined get /location/{locationNum}","title":"Get specific location","href":"/v2/api-reference/orders-v2/location/get-specific-location"},{"openapi":"oms_v2_combined put /location/{locationNum}","title":"Update location by overriding existing details","href":"/v2/api-reference/orders-v2/location/update-location-by-overriding-existing-details"},{"openapi":"oms_v2_combined patch /location/{locationNum}","title":"Update location by adding new property","href":"/v2/api-reference/orders-v2/location/update-location-by-adding-new-property"},{"openapi":"oms_v2_combined delete /location/{locationNum}","title":"Delete specific location","href":"/v2/api-reference/orders-v2/location/delete-specific-location"},{"openapi":"oms_v2_combined post /location/geography/search","title":"Get near by locations within the radius","href":"/v2/api-reference/orders-v2/location/get-near-by-locations-within-the-radius"}]},{"group":"Location Attribute","pages":[{"title":"Location Attribute","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/location-attribute/overview"},{"openapi":"oms_v2_combined post /location/attribute","title":"Create location attribute","href":"/v2/api-reference/orders-v2/location-attribute/create-location-attribute"},{"openapi":"oms_v2_combined get /location/attribute","title":"Get all location attributes","href":"/v2/api-reference/orders-v2/location-attribute/get-all-location-attributes"},{"openapi":"oms_v2_combined get /location/attribute/{code}","title":"Get location attribute by code","href":"/v2/api-reference/orders-v2/location-attribute/get-location-attribute-by-code"},{"openapi":"oms_v2_combined put /location/attribute/{code}","title":"Update location attribute by code","href":"/v2/api-reference/orders-v2/location-attribute/update-location-attribute-by-code"},{"openapi":"oms_v2_combined delete /location/attribute/{code}","title":"Delete location attribute by code","href":"/v2/api-reference/orders-v2/location-attribute/delete-location-attribute-by-code"}]},{"group":"Inventory Network","pages":[{"title":"Inventory Network","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/inventory-network/overview"},{"openapi":"oms_v2_combined get /inventory/network","title":"Get all networks","href":"/v2/api-reference/orders-v2/inventory-network/get-all-networks"},{"openapi":"oms_v2_combined post /inventory/network","title":"Create network","href":"/v2/api-reference/orders-v2/inventory-network/create-network"},{"openapi":"oms_v2_combined get /inventory/network/{networkId}","title":"Get specific network","href":"/v2/api-reference/orders-v2/inventory-network/get-specific-network"},{"openapi":"oms_v2_combined put /inventory/network/{networkId}","title":"Updates specific network","href":"/v2/api-reference/orders-v2/inventory-network/updates-specific-network"},{"openapi":"oms_v2_combined delete /inventory/network/{networkId}","title":"Delete specific network","href":"/v2/api-reference/orders-v2/inventory-network/delete-specific-network"},{"openapi":"oms_v2_combined get /inventory/aggregatedNetwork/query","title":"Get aggregated networks","href":"/v2/api-reference/orders-v2/inventory-network/get-aggregated-networks"}]},{"group":"Inventory","pages":[{"title":"Inventory","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/inventory/overview"},{"openapi":"oms_v2_combined get /inventory","title":"Get inventories","href":"/v2/api-reference/orders-v2/inventory/get-inventories"},{"openapi":"oms_v2_combined post /inventory","title":"Create inventory","href":"/v2/api-reference/orders-v2/inventory/create-inventory"},{"openapi":"oms_v2_combined put /inventory","title":"Update inventory by overriding existing values","href":"/v2/api-reference/orders-v2/inventory/update-inventory-by-overriding-existing-values"},{"openapi":"oms_v2_combined patch /inventory","title":"Update inventory by adding new property","href":"/v2/api-reference/orders-v2/inventory/update-inventory-by-adding-new-property"},{"openapi":"oms_v2_combined put /inventory/adjustment","title":"Update inventory position or create inventory","href":"/v2/api-reference/orders-v2/inventory/update-inventory-position-or-create-inventory"},{"openapi":"oms_v2_combined patch /inventory/adjustment","title":"Update inventory position","href":"/v2/api-reference/orders-v2/inventory/update-inventory-position"},{"openapi":"oms_v2_combined get /inventory/{itemId}","title":"Get inventory of specific item","href":"/v2/api-reference/orders-v2/inventory/get-inventory-of-specific-item"},{"openapi":"oms_v2_combined get /inventory/geography","title":"Get inventories in specific region","href":"/v2/api-reference/orders-v2/inventory/get-inventories-in-specific-region"}]},{"group":"Inventory Counter","pages":[{"title":"Inventory Counter","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/inventory-counter/overview"},{"openapi":"oms_v2_combined post /inventory/counter","title":"Create counter","href":"/v2/api-reference/orders-v2/inventory-counter/create-counter"},{"openapi":"oms_v2_combined get /inventory/counter","title":"Get all counters","href":"/v2/api-reference/orders-v2/inventory-counter/get-all-counters"},{"openapi":"oms_v2_combined get /inventory/counter/{code}","title":"Get specific counter","href":"/v2/api-reference/orders-v2/inventory-counter/get-specific-counter"},{"openapi":"oms_v2_combined put /inventory/counter/{code}","title":"Update specific counter","href":"/v2/api-reference/orders-v2/inventory-counter/update-specific-counter"}]},{"group":"Inventory Bulk Operation","pages":[{"title":"Inventory Bulk Operation","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/inventory-bulk-operation/overview"},{"openapi":"oms_v2_combined post /inventory/aws/upload-url","title":"Create URL to bulk upload inventory","href":"/v2/api-reference/orders-v2/inventory-bulk-operation/create-url-to-bulk-upload-inventory"},{"openapi":"oms_v2_combined post /inventory/aws/download-url","title":"Create URL to download error details for an uploaded file","href":"/v2/api-reference/orders-v2/inventory-bulk-operation/create-url-to-download-error-details-for-an-uploaded-file"}]},{"group":"Inventory Attribute","pages":[{"title":"Inventory Attribute","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/inventory-attribute/overview"},{"openapi":"oms_v2_combined post /inventory/attribute","title":"Create inventory attribute","href":"/v2/api-reference/orders-v2/inventory-attribute/create-inventory-attribute"},{"openapi":"oms_v2_combined get /inventory/attribute/{code}","title":"Get inventory attribute by code","href":"/v2/api-reference/orders-v2/inventory-attribute/get-inventory-attribute-by-code"}]},{"group":"Inventory Upload Log","pages":[{"title":"Inventory Upload Log","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/inventory-upload-log/overview"},{"openapi":"oms_v2_combined get /inventory/upload/log","title":"Get inventory upload status for specific file","href":"/v2/api-reference/orders-v2/inventory-upload-log/get-inventory-upload-status-for-specific-file"},{"openapi":"oms_v2_combined get /inventory/upload/log/all","title":"Get inventory upload record for all files","href":"/v2/api-reference/orders-v2/inventory-upload-log/get-inventory-upload-record-for-all-files"}]},{"group":"Shipment","pages":[{"title":"Shipment","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/shipment/overview"},{"openapi":"oms_v2_combined post /shipment/","title":"Create Shipment","href":"/v2/api-reference/orders-v2/shipment/create-shipment"},{"openapi":"oms_v2_combined get /shipment/{shipmentId}","title":"Get Shipment","href":"/v2/api-reference/orders-v2/shipment/get-shipment"},{"openapi":"oms_v2_combined post /shipment/reship","title":"Create reshipment","href":"/v2/api-reference/orders-v2/shipment/create-reshipment"},{"openapi":"oms_v2_combined put /shipment/{shipmentId}","title":"Update shipment","href":"/v2/api-reference/orders-v2/shipment/update-shipment"},{"openapi":"oms_v2_combined post /shipment/tracking","title":"Update package tracking","href":"/v2/api-reference/orders-v2/shipment/update-package-tracking"},{"openapi":"oms_v2_combined post /shipment/query","title":"Filter shipments","href":"/v2/api-reference/orders-v2/shipment/filter-shipments"},{"openapi":"oms_v2_combined post /shipment/gift-card/activation","title":"Activate gift card","href":"/v2/api-reference/orders-v2/shipment/activate-gift-card"},{"openapi":"oms_v2_combined post /shipment/gift-card/activation-acknowledge","title":"Acknowledge gift card activation","href":"/v2/api-reference/orders-v2/shipment/acknowledge-gift-card-activation"},{"openapi":"oms_v2_combined post /shipment/acknowledge","title":"Acknowledge Shipment","href":"/v2/api-reference/orders-v2/shipment/acknowledge-shipment"}]},{"group":"Shipping Method","pages":[{"title":"Shipping Method","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/shipping-method/overview"},{"openapi":"oms_v2_combined post /shipping/","title":"Create shipping method","href":"/v2/api-reference/orders-v2/shipping-method/create-shipping-method"},{"openapi":"oms_v2_combined get /shipping/{shipmethodId}","title":"Get shipping method","href":"/v2/api-reference/orders-v2/shipping-method/get-shipping-method"},{"openapi":"oms_v2_combined delete /shipping/{shipmethodId}","title":"Delete shipping method","href":"/v2/api-reference/orders-v2/shipping-method/delete-shipping-method"},{"openapi":"oms_v2_combined patch /shipping/{shipmethodId}","title":"Update shipping method","href":"/v2/api-reference/orders-v2/shipping-method/update-shipping-method"},{"openapi":"oms_v2_combined post /shipping/{shipMethodId}/item","title":"Add items to shipping methods","href":"/v2/api-reference/orders-v2/shipping-method/add-items-to-shipping-methods"},{"openapi":"oms_v2_combined post /shipping/query","title":"Filter shipping methods","href":"/v2/api-reference/orders-v2/shipping-method/filter-shipping-methods"},{"openapi":"oms_v2_combined get /shipping/{shipMethodId}/items","title":"Get ItemIds for a shipping method","href":"/v2/api-reference/orders-v2/shipping-method/get-itemids-for-a-shipping-method"},{"openapi":"oms_v2_combined get /shipping/shippingMethods/{itemId}","title":"Get shipping methods for an item","href":"/v2/api-reference/orders-v2/shipping-method/get-shipping-methods-for-an-item"}]},{"group":"Webhook","pages":[{"title":"Webhook","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/webhook/overview"},{"openapi":"oms_v2_combined post /webhook/retry","title":"Retry webhook","href":"/v2/api-reference/orders-v2/webhook/retry-webhook"},{"openapi":"oms_v2_combined post /webhook/event/query","title":"Query webhook event log","href":"/v2/api-reference/orders-v2/webhook/query-webhook-event-log"},{"openapi":"oms_v2_combined get /webhook/","title":"Get all webhook definitions","href":"/v2/api-reference/orders-v2/webhook/get-all-webhook-definitions"},{"openapi":"oms_v2_combined post /webhook/","title":"Create webhook definition","href":"/v2/api-reference/orders-v2/webhook/create-webhook-definition"},{"openapi":"oms_v2_combined get /webhook/{webhookId}","title":"Get webhook definition by ID","href":"/v2/api-reference/orders-v2/webhook/get-webhook-definition-by-id"},{"openapi":"oms_v2_combined delete /webhook/{webhookId}","title":"Delete webhook definition by ID","href":"/v2/api-reference/orders-v2/webhook/delete-webhook-definition-by-id"},{"openapi":"oms_v2_combined patch /webhook/{webhookId}","title":"Update webhook definition by ID","href":"/v2/api-reference/orders-v2/webhook/update-webhook-definition-by-id"}]},{"group":"Notification","pages":[{"openapi":"oms_v2_combined post /notification/send","title":"Listen to user and emit notifications","href":"/v2/api-reference/orders-v2/notification/listen-to-user-and-emit-notifications"},{"openapi":"oms_v2_combined post /notification/acknowledgment","title":"Listen to user and emit acknowledgment","href":"/v2/api-reference/orders-v2/notification/listen-to-user-and-emit-acknowledgment"}]},{"group":"Export","pages":[{"title":"Export","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/export/overview"},{"openapi":"oms_v2_combined post /exports","title":"Export records by query","href":"/v2/api-reference/orders-v2/export/export-records-by-query"},{"openapi":"oms_v2_combined get /exports/headers-list","title":"Get list of headers for given module","href":"/v2/api-reference/orders-v2/export/get-list-of-headers-for-given-module"},{"openapi":"oms_v2_combined post /exports/history","title":"Get OMS export log history by query","href":"/v2/api-reference/orders-v2/export/get-oms-export-log-history-by-query"},{"openapi":"oms_v2_combined get /exports/status","title":"Get record export status for given request","href":"/v2/api-reference/orders-v2/export/get-record-export-status-for-given-request"},{"openapi":"oms_v2_combined get /exports/files-list","title":"Get list of files for given module","href":"/v2/api-reference/orders-v2/export/get-list-of-files-for-given-module"},{"openapi":"oms_v2_combined get /exports/download-url","title":"Get URL for downloading exports","href":"/v2/api-reference/orders-v2/export/get-url-for-downloading-exports"}]},{"group":"Invoice","pages":[{"title":"Invoice","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/invoice/overview"},{"openapi":"oms_v2_combined post /invoice/","title":"Generate invoice","href":"/v2/api-reference/orders-v2/invoice/generate-invoice"},{"openapi":"oms_v2_combined post /invoice/query","title":"Get invoice by query","href":"/v2/api-reference/orders-v2/invoice/get-invoice-by-query"},{"openapi":"oms_v2_combined post /invoice/post","title":"Update invoice for financial posting","href":"/v2/api-reference/orders-v2/invoice/update-invoice-for-financial-posting"},{"openapi":"oms_v2_combined post /invoice/post/acknowledge","title":"Acknowledge financial posting","href":"/v2/api-reference/orders-v2/invoice/acknowledge-financial-posting"},{"openapi":"oms_v2_combined post /invoice/acknowledgement","title":"Acknowledge invoice by ID","href":"/v2/api-reference/orders-v2/invoice/acknowledge-invoice-by-id"},{"openapi":"oms_v2_combined get /invoice/{invoiceId}","title":"Get invoice by invoice ID","href":"/v2/api-reference/orders-v2/invoice/get-invoice-by-invoice-id"}]},{"group":"Fraud","pages":[{"title":"Fraud","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/fraud/overview"},{"openapi":"oms_v2_combined post /fraud/release","title":"Fraud Release Order","href":"/v2/api-reference/orders-v2/fraud/fraud-release-order"},{"openapi":"oms_v2_combined post /fraud/cancel","title":"Fraud Cancel Order","href":"/v2/api-reference/orders-v2/fraud/fraud-cancel-order"}]},{"group":"Backorder Preorder Reservation","pages":[{"title":"Backorder Preorder Reservation","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/backorder-preorder-reservation/overview"},{"openapi":"oms_v2_combined put /backpre-order/backorderpreorder-reserve/{lineItemId}/{orderNumber}","title":"Update BackOrderPreOrderReservation","href":"/v2/api-reference/orders-v2/backorder-preorder-reservation/update-backorderpreorderreservation"},{"openapi":"oms_v2_combined post /backpre-order/order/backorder/consent-to-delay","title":"To receive a consent from customer for the delay on backorder or preorder fulfilment.","href":"/v2/api-reference/orders-v2/backorder-preorder-reservation/to-receive-a-consent-from-customer-for-the-delay-on-backorder-or-preorder-fulfilment"},{"openapi":"oms_v2_combined post /backpre-order/backorderpreorder-update","title":"called when outer service updated any order has back/pre items, Allocation service after release","href":"/v2/api-reference/orders-v2/backorder-preorder-reservation/called-when-outer-service-updated-any-order-has-backpre-items-allocation-service-after-release"},{"openapi":"oms_v2_combined get /backpre-order/backorderpreorder-reserve","title":"Get backOrderPreOrderReservation","href":"/v2/api-reference/orders-v2/backorder-preorder-reservation/get-backorderpreorderreservation"},{"openapi":"oms_v2_combined post /backpre-order/backorderpreorder-reserve","title":"Create backOrderPreOrderReservation","href":"/v2/api-reference/orders-v2/backorder-preorder-reservation/create-backorderpreorderreservation"},{"openapi":"oms_v2_combined get /backpre-order/backorderpreorder-reserve/{identifier}","title":"Get backOrderPreOrderReservation list","href":"/v2/api-reference/orders-v2/backorder-preorder-reservation/get-backorderpreorderreservation-list"},{"openapi":"oms_v2_combined delete /backpre-order/backorderpreorder-reserve/{identifier}","title":"Delete BackOrderPreOrderReservation","href":"/v2/api-reference/orders-v2/backorder-preorder-reservation/delete-backorderpreorderreservation"}]},{"group":"List","pages":[{"title":"List","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v2/list/overview"},{"openapi":"oms_v2_combined post /list/","title":"Create list","href":"/v2/api-reference/orders-v2/list/create-list"},{"openapi":"oms_v2_combined post /list/{listId}/items","title":"Add items to a specific list","href":"/v2/api-reference/orders-v2/list/add-items-to-a-specific-list"},{"openapi":"oms_v2_combined get /list/{listId}/items","title":"Get items of a specific list","href":"/v2/api-reference/orders-v2/list/get-items-of-a-specific-list"},{"openapi":"oms_v2_combined get /list/{listId}","title":"Get list detail by Id","href":"/v2/api-reference/orders-v2/list/get-list-detail-by-id"},{"openapi":"oms_v2_combined delete /list/{listId}","title":"Delete list by Id","href":"/v2/api-reference/orders-v2/list/delete-list-by-id"},{"openapi":"oms_v2_combined patch /list/{listId}","title":"Update list by Id","href":"/v2/api-reference/orders-v2/list/update-list-by-id"},{"openapi":"oms_v2_combined get /list/user/{userId}","title":"Get lists by userId","href":"/v2/api-reference/orders-v2/list/get-lists-by-userid"}]}]},{"group":"Orders v1 (OMS v1)","pages":[{"title":"Order Management System","href":"/v2/api-reference/orders-v1/order-management-system"},{"group":"Cart","pages":[{"title":"Cart","href":"/v2/api-reference/orders-v1/cart/overview"},{"openapi":"oms_v1 patch /api-cart/cart/{cartId}/status/{updatedStatus}","title":"Update cart status","href":"/v2/api-reference/orders-v1/cart/update-cart-status"},{"openapi":"oms_v1 patch /api-cart/cart/{cartId}/header","title":"Update cart header","href":"/v2/api-reference/orders-v1/cart/update-cart-header"},{"openapi":"oms_v1 patch /api-cart/cart/{cartId}/empty","title":"Empty cart for the given cart ID","href":"/v2/api-reference/orders-v1/cart/empty-cart-for-the-given-cart-id"},{"openapi":"oms_v1 post /api-cart/cart/item","title":"Add item to cart","href":"/v2/api-reference/orders-v1/cart/add-item-to-cart"},{"openapi":"oms_v1 patch /api-cart/cart/{cartId}/item/{lineItemId}","title":"Remove item from cart by line item ID","href":"/v2/api-reference/orders-v1/cart/remove-item-from-cart-by-line-item-id"},{"openapi":"oms_v1 patch /api-cart/cart/merge","title":"Merge user cart and guest cart","href":"/v2/api-reference/orders-v1/cart/merge-user-cart-and-guest-cart"},{"openapi":"oms_v1 patch /api-cart/cart/{cartId}/ship-to","title":"Add shipTo IDs to cart items","href":"/v2/api-reference/orders-v1/cart/add-shipto-ids-to-cart-items"},{"openapi":"oms_v1 post /api-cart/cart/query","title":"Query on carts","href":"/v2/api-reference/orders-v1/cart/query-on-carts"},{"openapi":"oms_v1 delete /api-cart/cart-decoupled/{cartId}","title":"Cart soft delete (cart decoupled)","href":"/v2/api-reference/orders-v1/cart/cart-soft-delete-cart-decoupled"},{"openapi":"oms_v1 get /api-cart/cart","title":"Get cart for the given cart ID or user auth token","href":"/v2/api-reference/orders-v1/cart/get-cart-for-the-given-cart-id-or-user-auth-token"},{"openapi":"oms_v1 patch /api-cart/cart/{cartId}/orderNumber","title":"[Deprecated] Cart soft delete","href":"/v2/api-reference/orders-v1/cart/[deprecated]-cart-soft-delete"},{"openapi":"oms_v1 patch /api-cart/cart/remove-promo","title":"Remove promotion from cart","href":"/v2/api-reference/orders-v1/cart/remove-promotion-from-cart"},{"openapi":"oms_v1 patch /api-cart/cart/apply-promo","title":"Add promotion to cart","href":"/v2/api-reference/orders-v1/cart/add-promotion-to-cart"},{"openapi":"oms_v1 patch /api-cart/cart/{cartId}/items","title":"Update cart","href":"/v2/api-reference/orders-v1/cart/update-cart"},{"openapi":"oms_v1 delete /api-cart/cart/{cartId}","title":"Cart soft delete","href":"/v2/api-reference/orders-v1/cart/cart-soft-delete"},{"openapi":"oms_v1 patch /api-cart/cart/{cartId}/ship-to/v1","title":"Add shipTo IDs to cart items (v1)","href":"/v2/api-reference/orders-v1/cart/add-shipto-ids-to-cart-items-v1"}]},{"group":"Bill To","pages":[{"title":"Bill To","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v1/bill-to/overview"},{"openapi":"oms_v1 get /api-cart/bill-to/{billToId}","title":"Get bill-to by ID [Deprecated]","href":"/v2/api-reference/orders-v1/bill-to/get-bill-to-by-id-[deprecated]"},{"openapi":"oms_v1 patch /api-cart/cart/{cartId}/bill-to/{billToId}","title":"Update billto for a shipment [Deprecated]","href":"/v2/api-reference/orders-v1/bill-to/update-billto-for-a-shipment-[deprecated]"},{"openapi":"oms_v1 get /api-cart/bill-to/ship-to/{shipToId}","title":"Get bill-to by shipToId [Deprecated]","href":"/v2/api-reference/orders-v1/bill-to/get-bill-to-by-shiptoid-[deprecated]"},{"openapi":"oms_v1 post /api-cart/bill-to/cart/{cartId}","title":"Create billto for a shipment [Deprecated]","href":"/v2/api-reference/orders-v1/bill-to/create-billto-for-a-shipment-[deprecated]"}]},{"group":"Ship To","pages":[{"title":"Ship To","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v1/ship-to/overview"},{"openapi":"oms_v1 post /api-cart/ship-to/cart/{cartId}","title":"Create ship-to","href":"/v2/api-reference/orders-v1/ship-to/create-ship-to"},{"openapi":"oms_v1 post /api-cart/ship-to/v1/cart/{cartId}","title":"Create ship-to (v1)","href":"/v2/api-reference/orders-v1/ship-to/create-ship-to-v1"},{"openapi":"oms_v1 get /api-cart/ship-to/{shipTo}","title":"Get ShipTo by ID","href":"/v2/api-reference/orders-v1/ship-to/get-shipto-by-id"},{"openapi":"oms_v1 patch /api-cart/cart/{cartId}/ship-to/{shipToId}","title":"Update ship-to","href":"/v2/api-reference/orders-v1/ship-to/update-ship-to"},{"openapi":"oms_v1 get /api-cart/ship-to/{shipToId}/cart","title":"Get Cart data for the given shipTo ID","href":"/v2/api-reference/orders-v1/ship-to/get-cart-data-for-the-given-shipto-id"},{"openapi":"oms_v1 patch /api-cart/v1/cart/{cartId}/ship-to/{shipToId}","title":"Update ship-to (v1)","href":"/v2/api-reference/orders-v1/ship-to/update-ship-to-v1"}]},{"group":"Wishlist","pages":[{"title":"Wishlist","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v1/wishlist/overview"},{"openapi":"oms_v1 delete /api-cart/wishlist/user/item/{itemId}","title":"Delete from Wishlist","href":"/v2/api-reference/orders-v1/wishlist/delete-from-wishlist"},{"openapi":"oms_v1 get /api-cart/wishlist/user","title":"Get wishlist","href":"/v2/api-reference/orders-v1/wishlist/get-wishlist"},{"openapi":"oms_v1 post /api-cart/wishlist/user","title":"Create/add to wishlist","href":"/v2/api-reference/orders-v1/wishlist/createadd-to-wishlist"}]},{"group":"Cart Decoupled","pages":[{"title":"Cart Decoupled","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v1/cart-decoupled/overview"},{"openapi":"oms_v1 patch /api-cart/cart-decoupled/{cartId}/items","title":"Update Items already in cart (cart decoupled)","href":"/v2/api-reference/orders-v1/cart-decoupled/update-items-already-in-cart-cart-decoupled"},{"openapi":"oms_v1 get /api-cart/cart-decoupled","title":"Get cart for the given cart ID or user auth token (cart decoupled)","href":"/v2/api-reference/orders-v1/cart-decoupled/get-cart-for-the-given-cart-id-or-user-auth-token-cart-decoupled"},{"openapi":"oms_v1 patch /api-cart/cart-decoupled/merge","title":"Merge guest cart with user cart (cart decoupled)","href":"/v2/api-reference/orders-v1/cart-decoupled/merge-guest-cart-with-user-cart-cart-decoupled"},{"openapi":"oms_v1 patch /api-cart/cart-decoupled/{cartId}/empty","title":"Empty cart (cart decoupled)","href":"/v2/api-reference/orders-v1/cart-decoupled/empty-cart-cart-decoupled"},{"openapi":"oms_v1 patch /api-cart/cart-decoupled/{cartId}/item/{lineItemId}","title":"Remove item from cart (cart decoupled)","href":"/v2/api-reference/orders-v1/cart-decoupled/remove-item-from-cart-cart-decoupled"},{"openapi":"oms_v1 patch /api-cart/cart-decoupled/{cartId}/orderNumber","title":"[Deprecated] Remove Cart (cart decoupled)","href":"/v2/api-reference/orders-v1/cart-decoupled/[deprecated]-remove-cart-cart-decoupled"},{"openapi":"oms_v1 post /api-cart/cart-decoupled/item","title":"Add item to cart (cart decoupled)","href":"/v2/api-reference/orders-v1/cart-decoupled/add-item-to-cart-cart-decoupled"}]},{"group":"Warehouse","pages":[{"title":"Warehouse","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v1/warehouse/overview"},{"openapi":"oms_v1 get /api-inventory/warehouse/default","title":"Get default warehouse location","href":"/v2/api-reference/orders-v1/warehouse/get-default-warehouse-location"}]},{"group":"Inventory","pages":[{"title":"Inventory","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v1/inventory/overview"},{"openapi":"oms_v1 get /api-inventory/inventory/generic/{inventoryId}","title":"Get generic inventory","href":"/v2/api-reference/orders-v1/inventory/get-generic-inventory"},{"openapi":"oms_v1 get /api-inventory/inventory/location/{locationId}","title":"Get inventory by location","href":"/v2/api-reference/orders-v1/inventory/get-inventory-by-location"},{"openapi":"oms_v1 get /api-inventory/inventory/pickup-point/{itemId}","title":"Get pickup point","href":"/v2/api-reference/orders-v1/inventory/get-pickup-point"},{"openapi":"oms_v1 post /api-inventory/inventory/bulk-insert","title":"Bulk insert to inventory","href":"/v2/api-reference/orders-v1/inventory/bulk-insert-to-inventory"},{"openapi":"oms_v1 post /api-inventory/inventory","title":"Get inventories","href":"/v2/api-reference/orders-v1/inventory/get-inventories"},{"openapi":"oms_v1 post /api-inventory/inventory/pos","title":"Inventory POS","href":"/v2/api-reference/orders-v1/inventory/inventory-pos"}]},{"group":"Attributes","pages":[{"title":"Attributes","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v1/attributes/overview"},{"openapi":"oms_v1 patch /api-cart/cart/{cartId}/item/attribute","title":"Add attribute to cart item","href":"/v2/api-reference/orders-v1/attributes/add-attribute-to-cart-item"},{"openapi":"oms_v1 patch /api-cart/cart/{cartId}/attribute","title":"Add attribute to cart","href":"/v2/api-reference/orders-v1/attributes/add-attribute-to-cart"},{"openapi":"oms_v1 post /api-configuration/attribute/get-by-item-ids","title":"Get items attributes","href":"/v2/api-reference/orders-v1/attributes/get-items-attributes"},{"openapi":"oms_v1 get /api-configuration/attribute/getAll/order-attributes","title":"Get all order level attributes","href":"/v2/api-reference/orders-v1/attributes/get-all-order-level-attributes"}]},{"group":"List","pages":[{"title":"List","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v1/list/overview"},{"openapi":"oms_v1 get /api-list/list/user/{userId}","title":"Get list by userId","href":"/v2/api-reference/orders-v1/list/get-list-by-userid"},{"openapi":"oms_v1 patch /api-list/list/{listId}/items","title":"Add items to a known list","href":"/v2/api-reference/orders-v1/list/add-items-to-a-known-list"},{"openapi":"oms_v1 delete /api-list/list/{listId}/items","title":"Delete items from list","href":"/v2/api-reference/orders-v1/list/delete-items-from-list"},{"openapi":"oms_v1 post /api-list/list/query","title":"Query Lists","href":"/v2/api-reference/orders-v1/list/query-lists"},{"openapi":"oms_v1 patch /api-list/list/{listId}","title":"Update list","href":"/v2/api-reference/orders-v1/list/update-list"},{"openapi":"oms_v1 delete /api-list/list/{listId}","title":"Delete list","href":"/v2/api-reference/orders-v1/list/delete-list"},{"openapi":"oms_v1 get /api-list/list/{listId}","title":"Get list by listId","href":"/v2/api-reference/orders-v1/list/get-list-by-listid"},{"openapi":"oms_v1 post /api-list/list","title":"Create list","href":"/v2/api-reference/orders-v1/list/create-list"}]},{"group":"Tax/Address Validate","pages":[{"title":"Tax/Address Validate","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v1/taxaddress-validate/overview"},{"openapi":"oms_v1 post /api-tax/tax/create","title":"Create new tax transaction","href":"/v2/api-reference/orders-v1/taxaddress-validate/create-new-tax-transaction"},{"openapi":"oms_v1 post /api-tax/v1/address/validate","title":"Address validation (v1)","href":"/v2/api-reference/orders-v1/taxaddress-validate/address-validation-v1"},{"openapi":"oms_v1 post /api-tax/address/validate","title":"Address validation","href":"/v2/api-reference/orders-v1/taxaddress-validate/address-validation"}]},{"group":"Shipping","pages":[{"title":"Shipping","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v1/shipping/overview"},{"openapi":"oms_v1 get /api-shipping/shipping/items/{itemId}","title":"Get shipping method by item","href":"/v2/api-reference/orders-v1/shipping/get-shipping-method-by-item"},{"openapi":"oms_v1 post /api-shipping/shipping/expectedDelivery","title":"Get expected delivery for items","href":"/v2/api-reference/orders-v1/shipping/get-expected-delivery-for-items"},{"openapi":"oms_v1 get /api-shipping/shipping/all","title":"Get all shipping methods","href":"/v2/api-reference/orders-v1/shipping/get-all-shipping-methods"},{"openapi":"oms_v1 get /api-shipping/shipping/{shippingMethodId}","title":"Get shipping method","href":"/v2/api-reference/orders-v1/shipping/get-shipping-method"}]},{"group":"Payments","pages":[{"title":"Payments","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v1/payments/overview"},{"openapi":"oms_v1 get /api-payment/payment/{cartId}","title":"Get payment by cartId","href":"/v2/api-reference/orders-v1/payments/get-payment-by-cartid"},{"openapi":"oms_v1 post /api-payment/payment","title":"Add payment to cart","href":"/v2/api-reference/orders-v1/payments/add-payment-to-cart"},{"openapi":"oms_v1 post /ext-stripe/payment-intent/confirm/{paymentIntentId}","title":"Confirm Stripe payment intent","href":"/v2/api-reference/orders-v1/payments/confirm-stripe-payment-intent"},{"openapi":"oms_v1 post /ext-stripe/payment-method","title":"Create payment method","href":"/v2/api-reference/orders-v1/payments/create-payment-method"},{"openapi":"oms_v1 delete /api-payment/cart/{cartId}/payment/{paymentId}","title":"Delete payment","href":"/v2/api-reference/orders-v1/payments/delete-payment"},{"openapi":"oms_v1 post /ext-stripe/payment-intent","title":"Create Stripe payment intent","href":"/v2/api-reference/orders-v1/payments/create-stripe-payment-intent"}]},{"group":"Order","pages":[{"title":"Order","sidebarTitle":"Overview","href":"/v2/api-reference/orders-v1/order/overview"},{"openapi":"oms_v1 patch /api-order/orders/cancel","title":"Cancel order","href":"/v2/api-reference/orders-v1/order/cancel-order"},{"openapi":"oms_v1 post /api-order/orders/pos/sync-status","title":"Sync order status","href":"/v2/api-reference/orders-v1/order/sync-order-status"},{"openapi":"oms_v1 patch /api-order/orders/return","title":"Return order","href":"/v2/api-reference/orders-v1/order/return-order"},{"openapi":"oms_v1 get /api-order/orders/user","title":"Get order by user","href":"/v2/api-reference/orders-v1/order/get-order-by-user"},{"openapi":"oms_v1 post /api-order/orders/payment","title":"Return payment by orderId","href":"/v2/api-reference/orders-v1/order/return-payment-by-orderid"},{"openapi":"oms_v1 post /api-order/orders/user/cancel","title":"Cancel order by user","href":"/v2/api-reference/orders-v1/order/cancel-order-by-user"},{"openapi":"oms_v1 post /api-order/orders/shipments-bulk","title":"Add shipment bulk to order","href":"/v2/api-reference/orders-v1/order/add-shipment-bulk-to-order"},{"openapi":"oms_v1 get /api-order/orders/orderNumber/{orderId}","title":"Get order","href":"/v2/api-reference/orders-v1/order/get-order"},{"openapi":"oms_v1 post /api-order/orders/query","title":"Order query","href":"/v2/api-reference/orders-v1/order/order-query"},{"openapi":"oms_v1 post /api-order/orders/bulk-cancel","title":"Bulk cancel orders","href":"/v2/api-reference/orders-v1/order/bulk-cancel-orders"},{"openapi":"oms_v1 post /api-order/orders/bulk-return","title":"Bulk return orders","href":"/v2/api-reference/orders-v1/order/bulk-return-orders"},{"openapi":"oms_v1 post /api-order/pos/orders","title":"Create POS order","href":"/v2/api-reference/orders-v1/order/create-pos-order"},{"openapi":"oms_v1 get /api-order/orders/user/guest","title":"Get order by email","href":"/v2/api-reference/orders-v1/order/get-order-by-email"},{"openapi":"oms_v1 post /api-order/orders/user/return","title":"Return order by user","href":"/v2/api-reference/orders-v1/order/return-order-by-user"},{"openapi":"oms_v1 post /api-order/checkout","title":"Order checkout","href":"/v2/api-reference/orders-v1/order/order-checkout"},{"openapi":"oms_v1 post /api-order/orders/shipments","title":"Add shipment to order","href":"/v2/api-reference/orders-v1/order/add-shipment-to-order"},{"openapi":"oms_v1 post /api-order/subscriptions/orders","title":"Create subscriptions orders","href":"/v2/api-reference/orders-v1/order/create-subscriptions-orders"},{"openapi":"oms_v1 post /api-order/checkout-v4","title":"Order checkout (v4)","href":"/v2/api-reference/orders-v1/order/order-checkout-v4"}]}]},{"group":"Offers v2","pages":[{"title":"Offers","href":"/v2/api-reference/offers-v2/offers"},{"group":"Promotion","pages":[{"title":"Promotion","sidebarTitle":"Overview","href":"/v2/api-reference/offers-v2/promotion/overview"},{"openapi":"offers_v2_combined post /api-offers/promo/search","title":"Search for promotions","href":"/v2/api-reference/offers-v2/promotion/search-for-promotions"},{"openapi":"offers_v2_combined post /api-offers/promo/{promoId}/kill","title":"Stop a promotion","href":"/v2/api-reference/offers-v2/promotion/stop-a-promotion"},{"openapi":"offers_v2_combined delete /api-offers/promo/{promoId}","title":"Delete a specific promotion","href":"/v2/api-reference/offers-v2/promotion/delete-a-specific-promotion"},{"openapi":"offers_v2_combined put /api-offers/promo/update/{promoId}","title":"Update a specific promotion","href":"/v2/api-reference/offers-v2/promotion/update-a-specific-promotion"},{"openapi":"offers_v2_combined put /api-offers/promo/{promoId}/enable-disable","title":"Enable or disable a promotion","href":"/v2/api-reference/offers-v2/promotion/enable-or-disable-a-promotion"},{"openapi":"offers_v2_combined post /api-offers/promo/create","title":"Create promotion","href":"/v2/api-reference/offers-v2/promotion/create-promotion"},{"openapi":"offers_v2_combined get /api-offers/promo/{promoId}","title":"Get a specific promotion","href":"/v2/api-reference/offers-v2/promotion/get-a-specific-promotion"},{"openapi":"offers_v2_combined post /api-offers/promo/list","title":"Get all promotions","href":"/v2/api-reference/offers-v2/promotion/get-all-promotions"}]},{"group":"Price Kind","pages":[{"title":"Price Kind","sidebarTitle":"Overview","href":"/v2/api-reference/offers-v2/price-kind/overview"},{"openapi":"offers_v2_combined post /api-offers/price-kind","title":"Get all price kinds","href":"/v2/api-reference/offers-v2/price-kind/get-all-price-kinds"}]},{"group":"Dynamic Pricing Engine","pages":[{"title":"Dynamic Pricing Strategy","sidebarTitle":"Overview","href":"/v2/api-reference/offers-v2/dynamic-pricing-engine/overview"},{"openapi":"offers_v2_combined post /v1/price/get-by-sku","title":"Get calculated prices","href":"/v2/api-reference/offers-v2/dynamic-pricing-engine/get-calculated-prices"},{"openapi":"offers_v2_combined post /v1/promo/evaluate-promotions","title":"Evaluate promotions","href":"/v2/api-reference/offers-v2/dynamic-pricing-engine/evaluate-promotions"}]},{"group":"Segment","pages":[{"title":"Segment","sidebarTitle":"Overview","href":"/v2/api-reference/offers-v2/segment/overview"},{"openapi":"offers_v2_combined delete /api-offers/segment/{segmentId}","title":"Delete a specific segment","href":"/v2/api-reference/offers-v2/segment/delete-a-specific-segment"},{"openapi":"offers_v2_combined put /api-offers/segment/{segmentId}","title":"Update a specific segment","href":"/v2/api-reference/offers-v2/segment/update-a-specific-segment"},{"openapi":"offers_v2_combined get /api-offers/segment/list","title":"Get list of all segments","href":"/v2/api-reference/offers-v2/segment/get-list-of-all-segments"},{"openapi":"offers_v2_combined get /api-offers/segment/{segmentId}","title":"Get a specific segment","href":"/v2/api-reference/offers-v2/segment/get-a-specific-segment"},{"openapi":"offers_v2_combined post /api-offers/segment","title":"Create segment","href":"/v2/api-reference/offers-v2/segment/create-segment"}]},{"group":"Coupon","pages":[{"title":"Coupon","sidebarTitle":"Overview","href":"/v2/api-reference/offers-v2/coupon/overview"},{"openapi":"offers_v2_combined put /api-offers/coupon/update/{couponId}","title":"Update a coupon","href":"/v2/api-reference/offers-v2/coupon/update-a-coupon"},{"openapi":"offers_v2_combined get /api-offers/coupon/{couponId}","title":"Get a specific coupon","href":"/v2/api-reference/offers-v2/coupon/get-a-specific-coupon"},{"openapi":"offers_v2_combined post /api-offers/coupon/create","title":"Create coupon","href":"/v2/api-reference/offers-v2/coupon/create-coupon"},{"openapi":"offers_v2_combined post /api-offers/coupon/search","title":"Search for coupons","href":"/v2/api-reference/offers-v2/coupon/search-for-coupons"},{"openapi":"offers_v2_combined put /api-offers/coupon/{couponId}/enable-disable","title":"Enable or disable a coupon","href":"/v2/api-reference/offers-v2/coupon/enable-or-disable-a-coupon"},{"openapi":"offers_v2_combined delete /api-offers/coupon/{couponId}","title":"Delete a coupon","href":"/v2/api-reference/offers-v2/coupon/delete-a-coupon"},{"openapi":"offers_v2_combined post /api-offers/coupon/list","title":"Get list of all coupons","href":"/v2/api-reference/offers-v2/coupon/get-list-of-all-coupons"}]},{"group":"Coupon Codes","pages":[{"title":"Coupon Code","sidebarTitle":"Overview","href":"/v2/api-reference/offers-v2/coupon-code/overview"},{"openapi":"offers_v2_combined post /api-offers/coupon/generate-codes","title":"Generate coupon codes","href":"/v2/api-reference/offers-v2/coupon/generate-coupon-codes"},{"openapi":"offers_v2_combined get /api-offers/coupon-codes","title":"Get a list of all coupon codes","href":"/v2/api-reference/offers-v2/coupon-code/list-coupon-codes"}]},{"group":"Product","pages":[{"title":"Product","sidebarTitle":"Overview","href":"/v2/api-reference/offers-v2/product/overview"},{"openapi":"offers_v2_combined get /api-offers/get-product/{sku}","title":"Get product and price by sku","href":"/v2/api-reference/offers-v2/product/get-product-and-price-by-sku"}]},{"group":"Price List","pages":[{"title":"Price List","sidebarTitle":"Overview","href":"/v2/api-reference/offers-v2/price-list/overview"},{"openapi":"offers_v2_combined get /api-offers/price-list/{priceListId}","title":"Get a specific price list","href":"/v2/api-reference/offers-v2/price-list/get-a-specific-price-list"},{"openapi":"offers_v2_combined post /api-offers/price-list","title":"Create price list","href":"/v2/api-reference/offers-v2/price-list/create-price-list"},{"openapi":"offers_v2_combined put /api-offers/price-list/{priceListId}","title":"Update a specific price list","href":"/v2/api-reference/offers-v2/price-list/update-a-specific-price-list"},{"openapi":"offers_v2_combined delete /api-offers/price-list/{priceListId}","title":"Delete a specific price list","href":"/v2/api-reference/offers-v2/price-list/delete-a-specific-price-list"},{"openapi":"offers_v2_combined get /api-offers/price-list","title":"Get all price lists","href":"/v2/api-reference/offers-v2/price-list/get-all-price-lists"}]},{"group":"Attributes","pages":[{"openapi":"offers_v2_combined get /api-offers/attributes","title":"Get list of all attributes","href":"/v2/api-reference/offers-v2/attributes/get-list-of-all-attributes"},{"openapi":"offers_v2_combined put /api-offers/attributes/{attributeId}","title":"Update a specific attribute","href":"/v2/api-reference/offers-v2/attributes/update-a-specific-attribute"},{"openapi":"offers_v2_combined delete /api-offers/attributes/{attributeId}","title":"Delete a specific attribute","href":"/v2/api-reference/offers-v2/attributes/delete-a-specific-attribute"},{"openapi":"offers_v2_combined post /api-offers/attributes","title":"Create attribute","href":"/v2/api-reference/offers-v2/attributes/create-attribute"},{"openapi":"offers_v2_combined get /api-offers/attributes/{attributeId}","title":"Get a specific attribute","href":"/v2/api-reference/offers-v2/attributes/get-a-specific-attribute"}]},{"group":"Item","pages":[{"title":"Item","sidebarTitle":"Overview","href":"/v2/api-reference/offers-v2/item/overview"},{"openapi":"offers_v2_combined post /api-offers/items/search","title":"Search products and assigned prices in a specific price list","href":"/v2/api-reference/offers-v2/item/search-products-and-assigned-prices-in-a-specific-price-list"},{"openapi":"offers_v2_combined get /api-offers/items/priceListId/{priceListId}","title":"Get Skus and itemIds in a specific pricelist","href":"/v2/api-reference/offers-v2/item/get-skus-and-itemids-in-a-specific-pricelist"},{"openapi":"offers_v2_combined get /api-offers/item/{itemId}","title":"Get price of a specific item","href":"/v2/api-reference/offers-v2/item/get-price-of-a-specific-item"}]},{"group":"Price Guard","pages":[{"title":"Price Guard","sidebarTitle":"Overview","href":"/v2/api-reference/offers-v2/price-guard/overview"},{"openapi":"offers_v2_combined delete /api-offers/price-guard/{priceGuardId}","title":"Delete a specific price guard","href":"/v2/api-reference/offers-v2/price-guard/delete-a-specific-price-guard"},{"openapi":"offers_v2_combined post /api-offers/price-guard","title":"Create price guard","href":"/v2/api-reference/offers-v2/price-guard/create-price-guard"},{"openapi":"offers_v2_combined put /api-offers/price-guard/{priceGuardId}","title":"Update a specific price guard","href":"/v2/api-reference/offers-v2/price-guard/update-a-specific-price-guard"},{"openapi":"offers_v2_combined get /api-offers/price-guard","title":"Get all price guards","href":"/v2/api-reference/offers-v2/price-guard/get-all-price-guards"}]},{"group":"Global Exclusion","pages":[{"title":"Global Exclusion","sidebarTitle":"Overview","href":"/v2/api-reference/offers-v2/global-exclusion/overview"},{"openapi":"offers_v2_combined post /api-offers/sku-list/{skuListId}/end-now","title":"End specific sku-list","href":"/v2/api-reference/offers-v2/global-exclusion/end-specific-sku-list"},{"openapi":"offers_v2_combined delete /api-offers/sku-list/{skuListId}","title":"Delete specific SKU-list","href":"/v2/api-reference/offers-v2/global-exclusion/delete-specific-sku-list"},{"openapi":"offers_v2_combined get /api-offers/sku-list/{skuListId}","title":"Get specific sku-list","href":"/v2/api-reference/offers-v2/global-exclusion/get-specific-sku-list"},{"openapi":"offers_v2_combined get /api-offers/sku-list","title":"Get all sku-lists excluded from discounts","href":"/v2/api-reference/offers-v2/global-exclusion/get-all-sku-lists-excluded-from-discounts"},{"openapi":"offers_v2_combined post /api-offers/sku-list","title":"Create sku-list","href":"/v2/api-reference/offers-v2/global-exclusion/create-sku-list"},{"openapi":"offers_v2_combined put /api-offers/sku-list/{skuListId}","title":"Update specific sku-list","href":"/v2/api-reference/offers-v2/global-exclusion/update-specific-sku-list"}]},{"group":"Upload Price CSV","pages":[{"title":"Upload Price CSV","sidebarTitle":"Overview","href":"/v2/api-reference/offers-v2/upload-price-csv/overview"},{"openapi":"offers_v2_combined post /api-pim/item/upload-url","title":"Generate URL to bulk upload price details","href":"/v2/api-reference/offers-v2/upload-price-csv/generate-url-to-bulk-upload-price-details"}]},{"group":"Pricing","pages":[{"title":"Pricing","sidebarTitle":"Overview","href":"/v2/api-reference/offers-v2/pricing/overview"},{"openapi":"offers_v2_combined post /api-offers/price","title":"Create or update price","href":"/v2/api-reference/offers-v2/pricing/create-or-update-price"},{"openapi":"offers_v2_combined get /api-offers/price","title":"Get all prices","href":"/v2/api-reference/offers-v2/pricing/get-all-prices"},{"openapi":"offers_v2_combined get /api-offers/price/{priceId}/priceList/{priceListId}","title":"Get price by priceId","href":"/v2/api-reference/offers-v2/pricing/get-price-by-priceid"},{"openapi":"offers_v2_combined delete /api-offers/price/{priceId}/priceList/{priceListId}","title":"Delete price by priceId","href":"/v2/api-reference/offers-v2/pricing/delete-price-by-priceid"}]},{"group":"Redemption","pages":[{"title":"Redemption","sidebarTitle":"Overview","href":"/v2/api-reference/offers-v2/redemption/overview"},{"openapi":"offers_v2_combined post /api-offers/redemption","title":"Create redemption","href":"/v2/api-reference/offers-v2/redemption/create-redemption"},{"openapi":"offers_v2_combined delete /api-offers/redemption/{redemptionId}","title":"Delete specific redemption record","href":"/v2/api-reference/offers-v2/redemption/delete-specific-redemption-record"}]},{"group":"Exports","pages":[{"openapi":"offers_v2_combined post /api-offers/offers-exports/actions/download-export-file","title":"Download exported CSV file","href":"/v2/api-reference/offers-v2/exports/download-exported-csv-file"},{"openapi":"offers_v2_combined get /api-offers/offers-exports/{exportId}","title":"Get export request by ID","href":"/v2/api-reference/offers-v2/exports/get-export-request-by-id"},{"openapi":"offers_v2_combined post /api-offers/offers-exports","title":"Initiate export request","href":"/v2/api-reference/offers-v2/exports/initiate-export-request"},{"openapi":"offers_v2_combined get /api-offers/offers-exports","title":"Get all export requests","href":"/v2/api-reference/offers-v2/exports/get-all-export-requests"}]}]},{"group":"Offers v1","pages":[{"title":"Offers","href":"/v2/api-reference/offers-v1/offers"},{"group":"Login API","pages":[{"title":"Login API","sidebarTitle":"Overview","href":"/v2/api-reference/offers-v1/login-api/overview"},{"openapi":"offers_v1 post /api-identity/auth/local/login","title":"Generate authorization token for local user","href":"/v2/api-reference/offers-v1/login-api/generate-authorization-token-for-local-user"}]},{"group":"Promotions","pages":[{"title":"Promotions","sidebarTitle":"Overview","href":"/v2/api-reference/offers-v1/promotions/overview"},{"openapi":"offers_v1 get /api-price/promo","title":"Get List of Promotions","href":"/v2/api-reference/offers-v1/promotions/get-list-of-promotions"},{"openapi":"offers_v1 post /api-price/promo/validate","title":"Validate Promotions","href":"/v2/api-reference/offers-v1/promotions/validate-promotions"},{"openapi":"offers_v1 get /api-price/promo/{promoId}","title":"Get Promotions by promotion ID","href":"/v2/api-reference/offers-v1/promotions/get-promotions-by-promotion-id"}]},{"group":"Pricing","pages":[{"sidebarTitle":"Overview","title":null,"href":"/v2/api-reference/offers-v1/pricing/overview"},{"openapi":"offers_v1 post /api-price/price","title":"Create Price","href":"/v2/api-reference/offers-v1/pricing/create-price"},{"openapi":"offers_v1 get /api-price/price","title":"Get Price","href":"/v2/api-reference/offers-v1/pricing/get-price"},{"openapi":"offers_v1 post /api-price/price/bulk-insert","title":"Add or Update Bulk Price","href":"/v2/api-reference/offers-v1/pricing/add-or-update-bulk-price"},{"openapi":"offers_v1 post /api-price/v2/price/get","title":"Get Prices of Items","href":"/v2/api-reference/offers-v1/pricing/get-prices-of-items"},{"openapi":"offers_v1 post /api-price/offer/get-by-itemIds","title":"Get Offers for Items by Item IDs","href":"/v2/api-reference/offers-v1/pricing/get-offers-for-items-by-item-ids"},{"openapi":"offers_v1 delete /api-price/price/{priceId}","title":"Delete price by ID","href":"/v2/api-reference/offers-v1/pricing/delete-price-by-id"},{"openapi":"offers_v1 get /api-price/price/{priceId}","title":"Get Price Details by Price ID","href":"/v2/api-reference/offers-v1/pricing/get-price-details-by-price-id"}]}]},{"group":"Subscriptions (SMT API)","pages":[{"title":"Subscriptions API","href":"/v2/api-reference/subscriptions/subscriptions-api"},{"group":"Cancellation Reasons","pages":[{"title":"Cancellation Reasons","sidebarTitle":"Overview","href":"/v2/api-reference/subscriptions/cancellation-reasons/overview"},{"openapi":"smt get /v1/cancellation-reasons","title":"Get all cancellation reasons","href":"/v2/api-reference/subscriptions/cancellation-reasons/get-all-cancellation-reasons"},{"openapi":"smt post /v1/cancellation-reasons","title":"Create cancellation reasons","href":"/v2/api-reference/subscriptions/cancellation-reasons/create-cancellation-reasons"}]},{"group":"Subscription Discounts","pages":[{"title":"Subscription Discounts","sidebarTitle":"Overview","href":"/v2/api-reference/subscriptions/subscription-discounts/overview"},{"openapi":"smt patch /v1/subscriptionDiscount/deactivate/{id}","title":"Deactivate a subscription discount","href":"/v2/api-reference/subscriptions/subscription-discounts/deactivate-a-subscription-discount"},{"openapi":"smt get /v1/subscriptionDiscount/{offerId}","title":"Get a subscription discount","href":"/v2/api-reference/subscriptions/subscription-discounts/get-a-subscription-discount"},{"openapi":"smt put /v1/subscriptionDiscount/{offerId}","title":"Update a subscription discount","href":"/v2/api-reference/subscriptions/subscription-discounts/update-a-subscription-discount"},{"openapi":"smt post /v1/subscriptionDiscount","title":"Create subscription discounts","href":"/v2/api-reference/subscriptions/subscription-discounts/create-subscription-discounts"}]},{"group":"Subscriptions","pages":[{"title":"Subscriptions","sidebarTitle":"Overview","href":"/v2/api-reference/subscriptions/subscriptions/overview"},{"openapi":"smt put /v1/subscriptions/{id}/reactivate","title":"Reactivate single subscription","href":"/v2/api-reference/subscriptions/subscriptions/reactivate-single-subscription"},{"openapi":"smt get /v1/subscriptions/{id}","title":"Get single subscription","href":"/v2/api-reference/subscriptions/subscriptions/get-single-subscription"},{"openapi":"smt get /v1/subscriptions","title":"Get all subscriptions","href":"/v2/api-reference/subscriptions/subscriptions/get-all-subscriptions"},{"openapi":"smt post /v1/subscriptions/replace-items","title":"Replace a subscription item","href":"/v2/api-reference/subscriptions/subscriptions/replace-a-subscription-item"},{"openapi":"smt put /v1/subscriptions/{id}/inactive","title":"Deactivate single subscription","href":"/v2/api-reference/subscriptions/subscriptions/deactivate-single-subscription"},{"openapi":"smt post /v1/subscriptions/bulk","title":"Create bulk subscriptions","href":"/v2/api-reference/subscriptions/subscriptions/create-bulk-subscriptions"},{"openapi":"smt post /v1/subscriptions/discontinued-items","title":"Discontinue items in subscription","href":"/v2/api-reference/subscriptions/subscriptions/discontinue-items-in-subscription"},{"openapi":"smt patch /v1/subscriptions/{id}","title":"Update single subscription","href":"/v2/api-reference/subscriptions/subscriptions/update-single-subscription"}]},{"group":"Subscribers","pages":[{"title":"Subscribers","sidebarTitle":"Overview","href":"/v2/api-reference/subscriptions/subscribers/overview"},{"openapi":"smt patch /v1/customers/{id}/subscriptions","title":"Update single subscriber's shipping and billing information","href":"/v2/api-reference/subscriptions/subscribers/update-single-subscribers-shipping-and-billing-information"},{"openapi":"smt post /v1/customers","title":"Create subscriber","href":"/v2/api-reference/subscriptions/subscribers/create-subscriber"},{"openapi":"smt put /v1/customers/{id}","title":"Update single subscriber","href":"/v2/api-reference/subscriptions/subscribers/update-single-subscriber"},{"openapi":"smt get /v1/customers/{id}","title":"Get single subscriber's account","href":"/v2/api-reference/subscriptions/subscribers/get-single-subscribers-account"}]},{"group":"Orders","pages":[{"title":"Orders","sidebarTitle":"Overview","href":"/v2/api-reference/subscriptions/orders/overview"},{"openapi":"smt get /v1/orders/{orderId}","title":"Get single order","href":"/v2/api-reference/subscriptions/orders/get-single-order"},{"openapi":"smt get /v1/orders/{orderId}/trigger-now","title":"Trigger single order","href":"/v2/api-reference/subscriptions/orders/trigger-single-order"},{"openapi":"smt post /v1/orders/{id}/remove-items","title":"Remove items from single order","href":"/v2/api-reference/subscriptions/orders/remove-items-from-single-order"},{"openapi":"smt patch /v1/orders/{orderId}","title":"Update single order","href":"/v2/api-reference/subscriptions/orders/update-single-order"},{"openapi":"smt get /v1/customers/{customerId}/orders","title":"Get all orders for a specific customer","href":"/v2/api-reference/subscriptions/orders/get-all-orders-for-a-specific-customer"},{"openapi":"smt put /v1/orders/{orderId}/skip","title":"Skip single order","href":"/v2/api-reference/subscriptions/orders/skip-single-order"},{"openapi":"smt post /v1/orders/{id}/add-items","title":"Add items to single order","href":"/v2/api-reference/subscriptions/orders/add-items-to-single-order"}]}]},{"group":"Loyalty (Member)","pages":[{"title":"Member APIs","href":"/v2/api-reference/loyalty/member-apis"},{"group":"Inquire","pages":[{"openapi":"member get /v1/inquire/redeemable-points","title":"Get Redeemable Points","href":"/v2/api-reference/loyalty/inquire/get-redeemable-points"},{"openapi":"member get /v1/inquire/all-points-expiry/{profileId}","title":"Get Expired Points","href":"/v2/api-reference/loyalty/inquire/get-expired-points"},{"openapi":"member get /v1/inquire/point-type-choices","title":"Get Point Types","href":"/v2/api-reference/loyalty/inquire/get-point-types"},{"openapi":"member get /v1/inquire/get_action_reasons","title":"Get Action Reasons","href":"/v2/api-reference/loyalty/inquire/get-action-reasons"},{"openapi":"member get /v1/inquire/{profileId}/member-points","title":"Get Member Points","href":"/v2/api-reference/loyalty/inquire/get-member-points"},{"openapi":"member get /v1/inquire/points-expiry","title":"Get Points to be Expired","href":"/v2/api-reference/loyalty/inquire/get-points-to-be-expired"}]},{"group":"Discounts","pages":[{"openapi":"member post /v1/discounts","title":"Get Discounts","href":"/v2/api-reference/loyalty/discounts/get-discounts"}]},{"group":"Redeem","pages":[{"openapi":"member get /v1/redeem","title":"Rewards History","href":"/v2/api-reference/loyalty/redeem/rewards-history"},{"openapi":"member post /v1/redeem/reward/issue","title":"Issue Reward","href":"/v2/api-reference/loyalty/redeem/issue-reward"},{"openapi":"member post /v1/redeem/member-reward","title":"Redeem Rewards","href":"/v2/api-reference/loyalty/redeem/redeem-rewards"},{"openapi":"member post /v1/redeem/cancel","title":"Cancel Rewards","href":"/v2/api-reference/loyalty/redeem/cancel-rewards"},{"openapi":"member post /v1/redeem/reverse","title":"Reverse Redeemed Rewards","href":"/v2/api-reference/loyalty/redeem/reverse-redeemed-rewards"}]},{"group":"Earn","pages":[{"openapi":"member post /v2/earn","title":"Earn Points","href":"/v2/api-reference/loyalty/earn/earn-points"},{"openapi":"member post /v2/earn/reverse","title":"Reverse Earned Points","href":"/v2/api-reference/loyalty/earn/reverse-earned-points"},{"openapi":"member get /v2/earn/get-transaction","title":"Get Transactions","href":"/v2/api-reference/loyalty/earn/get-transactions"}]},{"group":"Members","pages":[{"openapi":"member put /v1/members","title":"Update Member","href":"/v2/api-reference/loyalty/members/update-member"},{"openapi":"member get /v1/members","title":"Get Members","href":"/v2/api-reference/loyalty/members/get-members"},{"openapi":"member post /v1/members","title":"Enroll Member","href":"/v2/api-reference/loyalty/members/enroll-member"},{"openapi":"member post /v1/members/points-activate","title":"Activate Points","href":"/v2/api-reference/loyalty/members/activate-points"},{"openapi":"member post /v1/members/points-adjustment","title":"Adjust Points","href":"/v2/api-reference/loyalty/members/adjust-points"}]}]},{"group":"Dropship","pages":[{"title":"Dropship API","href":"/v2/api-reference/dropship/dropship-api"},{"group":"Shipments","pages":[{"openapi":"marketplace get /v1/retailers/{retailer_pk}/shipments/{id}/","title":"Get details of a single shipment.","href":"/v2/api-reference/dropship/shipments/get-details-of-a-single-shipment"},{"openapi":"marketplace get /v1/retailers/{retailer_pk}/shipments/","title":"List fulfillments or shipments from vendors","href":"/v2/api-reference/dropship/shipments/list-fulfillments-or-shipments-from-vendors"},{"openapi":"marketplace put /v1/retailers/{retailer_pk}/shipments/{id}/acknowledge/","title":"Acknowledge shipment receipt","href":"/v2/api-reference/dropship/shipments/acknowledge-shipment-receipt"}]},{"group":"Products","pages":[{"openapi":"marketplace get /v1/retailers/{retailer_pk}/permits/{id}/","title":"Get active permits","href":"/v2/api-reference/dropship/products/get-active-permits"},{"openapi":"marketplace get /v1/retailers/{retailer_pk}/variants/{id}/","title":"Get details of a single variant","href":"/v2/api-reference/dropship/products/get-details-of-a-single-variant"},{"openapi":"marketplace get /v1/retailers/{retailer_pk}/products/","title":"List products","href":"/v2/api-reference/dropship/products/list-products"},{"openapi":"marketplace patch /v1/retailers/{retailer_pk}/variants/{id}/","title":"Update attributes of a variant","href":"/v2/api-reference/dropship/products/update-attributes-of-a-variant"},{"openapi":"marketplace get /v1/retailers/{retailer_pk}/variants/","title":"Get variants","href":"/v2/api-reference/dropship/products/get-variants"},{"openapi":"marketplace put /v1/retailers/{retailer_pk}/permits/{id}/acknowledge/","title":"Acknowledge receipt of a new permit","href":"/v2/api-reference/dropship/products/acknowledge-receipt-of-a-new-permit"},{"openapi":"marketplace get /v1/retailers/{retailer_pk}/products/{id}/","title":"Get single product details","href":"/v2/api-reference/dropship/products/get-single-product-details"}]},{"group":"Invoices","pages":[{"openapi":"marketplace put /v1/retailers/{retailer_pk}/invoices/{id}/acknowledge/","title":"Acknowledge receipt of an invoice.","href":"/v2/api-reference/dropship/invoices/acknowledge-receipt-of-an-invoice"},{"openapi":"marketplace get /v1/retailers/{retailer_pk}/invoices/","title":"List invocies from vendors","href":"/v2/api-reference/dropship/invoices/list-invocies-from-vendors"},{"openapi":"marketplace get /v1/retailers/{retailer_pk}/invoices/{id}/","title":"Get details of a single invoice","href":"/v2/api-reference/dropship/invoices/get-details-of-a-single-invoice"}]},{"group":"Connections","pages":[{"openapi":"marketplace get /v1/retailers/{retailer_pk}/connections/","title":"Get vendor connections","description":"Gets a list of vendor connections.","href":"/v2/api-reference/dropship/connections/get-vendor-connections"},{"openapi":"marketplace get /v1/retailers/{retailer_pk}/connections/{id}/","title":"Get connections of a single vendor","href":"/v2/api-reference/dropship/connections/get-connections-of-a-single-vendor"}]},{"group":"Inventory","pages":[{"openapi":"marketplace get /v1/retailers/{retailer_pk}/inventory/{id}/","title":"Get inventory of a single variant","description":"Gets the inventory position for a single variant.","href":"/v2/api-reference/dropship/inventory/get-inventory-of-a-single-variant"},{"openapi":"marketplace get /v1/retailers/{retailer_pk}/inventory/","title":"Get a list of variant inventory positions","href":"/v2/api-reference/dropship/inventory/get-a-list-of-variant-inventory-positions"}]},{"group":"Returns","pages":[{"openapi":"marketplace get /v1/retailers/{retailer_pk}/rmas/","title":"Get a list of returns","href":"/v2/api-reference/dropship/returns/get-a-list-of-returns"},{"openapi":"marketplace post /v1/retailers/{retailer_pk}/rmas/","title":"Register a pending return for a vendor","href":"/v2/api-reference/dropship/returns/register-a-pending-return-for-a-vendor"},{"openapi":"marketplace get /v1/retailers/{retailer_pk}/rmas/{id}/","title":"Get details of a return.","href":"/v2/api-reference/dropship/returns/get-details-of-a-return"},{"openapi":"marketplace put /v1/retailers/{retailer_pk}/rmas/{id}/acknowledge/","title":"Acknowledge return","href":"/v2/api-reference/dropship/returns/acknowledge-return"}]},{"group":"Orders","pages":[{"openapi":"marketplace post /v1/retailers/{retailer_pk}/orders/","title":"Create a new order (for a single vendor)","href":"/v2/api-reference/dropship/orders/create-a-new-order-for-a-single-vendor"},{"openapi":"marketplace get /v1/retailers/{retailer_pk}/orders/","title":"Get orders","href":"/v2/api-reference/dropship/orders/get-orders"},{"openapi":"marketplace post /v1/retailers/{retailer_pk}/sales-orders/","title":"Create a new order (mixed vendors)","href":"/v2/api-reference/dropship/orders/create-a-new-order-mixed-vendors"},{"openapi":"marketplace get /v1/retailers/{retailer_pk}/orders/{id}/","title":"Get single order details","href":"/v2/api-reference/dropship/orders/get-single-order-details"}]}]},{"group":"Cart API","pages":[{"title":"Cart","href":"/v2/api-reference/cart-api/cart"},{"group":"Order Draft","pages":[{"openapi":"cart-service get /v2/order-drafts/order-number/{orderNumber}","title":"Get order draft by order number","href":"/v2/api-reference/cart-api/order-draft/get-order-draft-by-order-number"},{"openapi":"cart-service get /v2/order-drafts/{id}","title":"Get order draft by ID","href":"/v2/api-reference/cart-api/order-draft/get-order-draft-by-id"},{"openapi":"cart-service post /v2/carts/{cartId}/order-drafts","title":"Create order draft","href":"/v2/api-reference/cart-api/order-draft/create-order-draft"},{"openapi":"cart-service get /v2/order-drafts","title":"Get all order drafts by filter parameters","href":"/v2/api-reference/cart-api/order-draft/get-all-order-drafts-by-filter-parameters"}]},{"group":"Attribute","pages":[{"title":"Attribute","sidebarTitle":"Overview","href":"/v2/api-reference/cart-api/attribute/overview"},{"openapi":"cart-service delete /v2/carts/{cartId}/attributes/{attributeId}","title":"Delete specific cart attribute","href":"/v2/api-reference/cart-api/attribute/delete-specific-cart-attribute"},{"openapi":"cart-service patch /v2/carts/{cartId}/item/attribute","title":"Add or update specific item attribute","href":"/v2/api-reference/cart-api/attribute/add-or-update-specific-item-attribute"},{"openapi":"cart-service delete /v2/carts/{cartId}/attributes/fees","title":"Delete specific cart fee","href":"/v2/api-reference/cart-api/attribute/delete-specific-cart-fee"},{"openapi":"cart-service patch /v2/carts/{cartId}/attributes","title":"Add or update cart attributes","href":"/v2/api-reference/cart-api/attribute/add-or-update-cart-attributes"},{"openapi":"cart-service delete /v2/carts/{cartId}/item/attribute/fees/{lineItemId}","title":"Delete item fees","href":"/v2/api-reference/cart-api/attribute/delete-item-fees"},{"openapi":"cart-service delete /v2/carts/{cartId}/item/attribute/{attributeId}/{lineItemId}","title":"Delete a specific item attribute","href":"/v2/api-reference/cart-api/attribute/delete-a-specific-item-attribute"},{"openapi":"cart-service patch /v2/carts/{cartId}/item/{lineItemId}/attribute","title":"Add or update item attributes and fees","href":"/v2/api-reference/cart-api/attribute/add-or-update-item-attributes-and-fees"}]},{"group":"Adjustments","pages":[{"title":"Adjustments","sidebarTitle":"Overview","href":"/v2/api-reference/cart-api/adjustments/overview"},{"openapi":"cart-service post /v2/carts/{cartId}/items/{lineItemId}/adjustments","title":"Adjust prices for a cart item","href":"/v2/api-reference/cart-api/adjustments/adjust-prices-for-a-cart-item"},{"openapi":"cart-service put /v2/carts/{cartId}/adjustments/{adjustmentId}","title":"Update a specific price adjustment information for a given cart","href":"/v2/api-reference/cart-api/adjustments/update-a-specific-price-adjustment-information-for-a-given-cart"},{"openapi":"cart-service post /v2/carts/{cartId}/adjustments","title":"Adjust prices for a specific cart","href":"/v2/api-reference/cart-api/adjustments/adjust-prices-for-a-specific-cart"},{"openapi":"cart-service delete /v2/carts/{cartId}/items/{lineItemId}/adjustments/{adjustmentId}","title":"Delete a specific price adjustment information for a cart item","href":"/v2/api-reference/cart-api/adjustments/delete-a-specific-price-adjustment-information-for-a-cart-item"},{"openapi":"cart-service get /v2/carts/{cartId}/adjustments","title":"Get all price adjustment details for a specific cart","href":"/v2/api-reference/cart-api/adjustments/get-all-price-adjustment-details-for-a-specific-cart"},{"openapi":"cart-service put /v2/carts/{cartId}/items/{lineItemId}/adjustments/{adjustmentId}","title":"Update a specific price adjustment information for a cart item","href":"/v2/api-reference/cart-api/adjustments/update-a-specific-price-adjustment-information-for-a-cart-item"},{"openapi":"cart-service get /v2/carts/{cartId}/items/{lineItemId}/adjustments","title":"Get all price adjustments for a cart item","href":"/v2/api-reference/cart-api/adjustments/get-all-price-adjustments-for-a-cart-item"},{"openapi":"cart-service delete /v2/carts/{cartId}/adjustments/{adjustmentId}","title":"Delete a specific price adjustment information from a given cart","href":"/v2/api-reference/cart-api/adjustments/delete-a-specific-price-adjustment-information-from-a-given-cart"}]},{"group":"Shipping","pages":[{"title":"Shipping","sidebarTitle":"Overview","href":"/v2/api-reference/cart-api/shipping/overview"},{"openapi":"cart-service get /v2/carts/{cartId}/shipping-details/{shippingDetailsId}","title":"Get specific shipping details for a specific cart","href":"/v2/api-reference/cart-api/shipping/get-specific-shipping-details-for-a-specific-cart"},{"openapi":"cart-service post /v2/carts/{cartId}/shipping-details","title":"Create shipping details for all items specific cart","href":"/v2/api-reference/cart-api/shipping/create-shipping-details-for-all-items-specific-cart"},{"openapi":"cart-service delete /v2/carts/{cartId}/items/shipping-details","title":"Remove `shippingDetailsId` from cart items","href":"/v2/api-reference/cart-api/shipping/remove-`shippingdetailsid`-from-cart-items"},{"openapi":"cart-service patch /v2/carts/{cartId}/items/shipping-details","title":"Create shipping details for specific items in specific cart","href":"/v2/api-reference/cart-api/shipping/create-shipping-details-for-specific-items-in-specific-cart"},{"openapi":"cart-service patch /v2/carts/{cartId}/shipping-details","title":"Update shipping details for all items in a specific cart","href":"/v2/api-reference/cart-api/shipping/update-shipping-details-for-all-items-in-a-specific-cart"}]},{"group":"Cart","pages":[{"title":"Cart","sidebarTitle":"Overview","href":"/v2/api-reference/cart-api/cart/overview"},{"openapi":"cart-service patch /v2/carts/{cartId}/items","title":"Update items in specific cart","href":"/v2/api-reference/cart-api/cart/update-items-in-specific-cart"},{"openapi":"cart-service get /v2/carts","title":"Get all carts","href":"/v2/api-reference/cart-api/cart/get-all-carts"},{"openapi":"cart-service post /v2/carts/search","title":"Search for carts","href":"/v2/api-reference/cart-api/cart/search-for-carts"},{"openapi":"cart-service delete /v2/carts/{cartId}/items/{lineItemId}","title":"Remove an item from the cart","href":"/v2/api-reference/cart-api/cart/remove-an-item-from-the-cart"},{"openapi":"cart-service post /v2/carts/{cartId}/lineItems/actions/split","title":"Split the cart item by quantity","href":"/v2/api-reference/cart-api/cart/split-the-cart-item-by-quantity"},{"openapi":"cart-service get /v2/carts/{cartId}","title":"Get specific cart","href":"/v2/api-reference/cart-api/cart/get-specific-cart"},{"openapi":"cart-service delete /v2/carts/{cartId}/promo/{promoCode}","title":"Remove an individual promotion from all items in a specific cart","href":"/v2/api-reference/cart-api/cart/remove-an-individual-promotion-from-all-items-in-a-specific-cart"},{"openapi":"cart-service post /v2/carts","title":"Create an empty cart","href":"/v2/api-reference/cart-api/cart/create-an-empty-cart"},{"openapi":"cart-service put /v2/carts/{cartId}/customer","title":"Replaces customer context in cart","href":"/v2/api-reference/cart-api/cart/replaces-customer-context-in-cart"},{"openapi":"cart-service delete /v2/carts/{cartId}","title":"Delete cart items","href":"/v2/api-reference/cart-api/cart/delete-cart-items"},{"openapi":"cart-service patch /v2/carts/{cartId}/status/{cartStatus}","title":"Update status of specific cart","href":"/v2/api-reference/cart-api/cart/update-status-of-specific-cart"},{"openapi":"cart-service patch /v2/carts/{cartId}/merge","title":"Merge carts","href":"/v2/api-reference/cart-api/cart/merge-carts-1"},{"openapi":"cart-service post /v2/carts/{cartId}/soft-reserve","title":"Soft reserve cart items","href":"/v2/api-reference/cart-api/cart/soft-reserve-cart-items"},{"openapi":"cart-service delete /v2/carts/{cartId}/items","title":"Delete items from specific cart","href":"/v2/api-reference/cart-api/cart/delete-items-from-specific-cart"},{"openapi":"cart-service post /v2/carts/items","title":"Add items to cart","href":"/v2/api-reference/cart-api/cart/add-items-to-cart"},{"openapi":"cart-service post /v2/carts/{cartId}/promos/{promoCode}","title":"Apply a specific promotion to all items in a specific cart","href":"/v2/api-reference/cart-api/cart/apply-a-specific-promotion-to-all-items-in-a-specific-cart"},{"openapi":"cart-service put /v2/carts/{cartId}/merge","title":"Merge Carts","href":"/v2/api-reference/cart-api/cart/merge-carts"}]}]},{"group":"Checkout API","pages":[{"title":"Checkout","href":"/v2/api-reference/checkout-api/checkout"},{"group":"Checkout","pages":[{"title":"Checkout","sidebarTitle":"Overview","href":"/v2/api-reference/checkout-api/checkout/overview"},{"openapi":"checkout post /v2/checkout","title":"Create checkout","href":"/v2/api-reference/checkout-api/checkout/create-checkout"}]}]},{"group":"Customer","pages":[{"title":"Core Concepts","href":"/v2/api-reference/customer/core-concepts"},{"title":"Customer Service","href":"/v2/api-reference/customer/customer-service"},{"group":"Organization","pages":[{"openapi":"customer-openapi get /v1/organizations/{organizationId}","title":null,"href":"/v2/api-reference/customer/organization/get-organization"},{"openapi":"customer-openapi post /v1/organizations","title":null,"href":"/v2/api-reference/customer/organization/create-organization"},{"openapi":"customer-openapi get /v1/organizations","title":null,"href":"/v2/api-reference/customer/organization/list-organizations"},{"openapi":"customer-openapi put /v1/organizations/{organizationId}","title":null,"href":"/v2/api-reference/customer/organization/update-organization"},{"openapi":"customer-openapi post /v1/organizations/{organizationId}/resurrect","title":null,"href":"/v2/api-reference/customer/organization/resurrect-organization"},{"openapi":"customer-openapi delete /v1/organizations/{organizationId}","title":null,"href":"/v2/api-reference/customer/organization/delete-organization"}]},{"group":"User Party","pages":[{"openapi":"customer-openapi get /v1/user-party/user/{userId}/party/{parentPartyId}","title":null,"href":"/v2/api-reference/customer/user-party/get-party-by-user-and-parent-party"},{"openapi":"customer-openapi get /v1/user-party/user/{userId}","title":null,"href":"/v2/api-reference/customer/user-party/list-parties-by-user"},{"openapi":"customer-openapi delete /v1/user-party","title":null,"href":"/v2/api-reference/customer/user-party/unlink-user-from-party"},{"openapi":"customer-openapi get /v1/user-party/party/{partyId}","title":null,"href":"/v2/api-reference/customer/user-party/list-users-in-party"},{"openapi":"customer-openapi post /v1/user-party","title":null,"href":"/v2/api-reference/customer/user-party/link-user-to-party"}]},{"group":"Organization Group Addresses","pages":[{"title":"Organization Group Addresses","sidebarTitle":"Overview","href":"/v2/api-reference/customer/organization-group-addresses/overview"},{"openapi":"customer-openapi get /v1/organizations/{organizationId}/groups/{groupId}/addresses","title":null,"href":"/v2/api-reference/customer/organization-group-addresses/list-orgaization-group-addresses"}]},{"group":"User Internal Party","pages":[{"title":"User Internal Party","sidebarTitle":"Overview","href":"/v2/api-reference/customer/user-internal-party/overview"},{"openapi":"customer-openapi post /v1/user-internal-organization","title":null,"href":"/v2/api-reference/customer/user-internal-party/link-user-and-internal-party"},{"openapi":"customer-openapi delete /v1/user-internal-organization","title":null,"href":"/v2/api-reference/customer/user-internal-party/unlink-user-intenal-party"},{"openapi":"customer-openapi get /v1/user-internal-organization/user/{userId}/internal-organizations","title":null,"href":"/v2/api-reference/customer/user-internal-party/list-internal-parties-by-user"},{"openapi":"customer-openapi get /v1/user-internal-organization/internalparty/{internalPartyId}/users","title":null,"href":"/v2/api-reference/customer/user-internal-party/list-users-by-internal-party"}]},{"group":"Organization Contracts","pages":[{"title":"Organization Contracts","sidebarTitle":"Overview","href":"/v2/api-reference/customer/organization-contracts/overview"},{"openapi":"customer-openapi delete /v1/organizations/{organizationId}/contracts/{contractId}","title":null,"href":"/v2/api-reference/customer/organization-contracts/delete-organization-contract"},{"openapi":"customer-openapi put /v1/organizations/{organizationId}/contracts/{contractId}","title":null,"href":"/v2/api-reference/customer/organization-contracts/update-organization-contract"},{"openapi":"customer-openapi get /v1/organizations/{organizationId}/contracts","title":null,"href":"/v2/api-reference/customer/organization-contracts/list-organization-contracts"},{"openapi":"customer-openapi post /v1/organizations/{organizationId}/contracts","title":null,"href":"/v2/api-reference/customer/organization-contracts/create-organization-contract"},{"openapi":"customer-openapi post /v1/organizations/{organizationId}/contracts/{contractId}/resurrect","title":null,"href":"/v2/api-reference/customer/organization-contracts/resurrect-organization-contract"},{"openapi":"customer-openapi get /v1/organizations/{organizationId}/contracts/{contractId}","title":null,"href":"/v2/api-reference/customer/organization-contracts/get-organization-contract"}]},{"group":"Party","pages":[{"title":"Party","sidebarTitle":"Overview","href":"/v2/api-reference/customer/party/overview"},{"openapi":"customer-openapi delete /v1/parties/{partyId}","title":null,"href":"/v2/api-reference/customer/party/delete-party"},{"openapi":"customer-openapi patch /v1/parties/{partyId}","title":null,"href":"/v2/api-reference/customer/party/update-party"},{"openapi":"customer-openapi get /v1/parties/{globalCustomerId}/{partyType}","title":null,"href":"/v2/api-reference/customer/party/get-party-with-type"},{"openapi":"customer-openapi post /v1/parties","title":null,"href":"/v2/api-reference/customer/party/create-party"},{"openapi":"customer-openapi get /v1/parties","title":null,"href":"/v2/api-reference/customer/party/list-parties"},{"openapi":"customer-openapi get /v1/parties/{partyId}","title":null,"href":"/v2/api-reference/customer/party/get-party"}]},{"group":"Party Contracts","pages":[{"openapi":"customer-openapi get /v1/contracts/contract/{contractId}","title":null,"href":"/v2/api-reference/customer/party-contracts/list-parties-by-contract"},{"openapi":"customer-openapi get /v1/contracts/party/{partyId}","title":null,"href":"/v2/api-reference/customer/party-contracts/list-contracts-by-party"}]},{"group":"Contracts","pages":[{"title":"Contracts","sidebarTitle":"Overview","href":"/v2/api-reference/customer/contracts/overview"},{"openapi":"customer-openapi put /v1/upload/contracts","title":null,"href":"/v2/api-reference/customer/contracts/use-pre-signed-url-to-upload-a-contract"},{"openapi":"customer-openapi post /v1/upload/contracts","title":null,"href":"/v2/api-reference/customer/contracts/bulk-upload-contract"},{"openapi":"customer-openapi get /v1/contracts","title":null,"href":"/v2/api-reference/customer/contracts/list-contracts"},{"openapi":"customer-openapi post /v1/contracts/{contractId}/resurrect","title":null,"href":"/v2/api-reference/customer/contracts/resurrect-contract"},{"openapi":"customer-openapi post /v1/contracts","title":null,"href":"/v2/api-reference/customer/contracts/create-contract"},{"openapi":"customer-openapi patch /v1/contracts/{contractId}","title":null,"href":"/v2/api-reference/customer/contracts/update-contract"},{"openapi":"customer-openapi get /v1/contracts/{contractId}","title":null,"href":"/v2/api-reference/customer/contracts/get-contract"},{"openapi":"customer-openapi delete /v1/contracts/{contractId}","title":null,"href":"/v2/api-reference/customer/contracts/delete-contract"}]},{"group":"User","pages":[{"title":"User","sidebarTitle":"Overview","href":"/v2/api-reference/customer/user/overview"},{"openapi":"customer-openapi post /v1/upload/users","title":null,"href":"/v2/api-reference/customer/user/bulk-upload-user"},{"openapi":"customer-openapi get /v1/users","title":null,"href":"/v2/api-reference/customer/user/list-users"},{"openapi":"customer-openapi patch /v1/users/{userId}","title":null,"href":"/v2/api-reference/customer/user/update-user"},{"openapi":"customer-openapi get /v1/users/{userId}","title":null,"href":"/v2/api-reference/customer/user/get-user"},{"openapi":"customer-openapi put /v1/upload/users","title":null,"href":"/v2/api-reference/customer/user/use-pre-signed-url-to-upload-a-user"},{"openapi":"customer-openapi delete /v1/users/{userId}","title":null,"href":"/v2/api-reference/customer/user/delete-user"},{"openapi":"customer-openapi post /v1/users","title":null,"href":"/v2/api-reference/customer/user/create-user"}]},{"group":"Search","pages":[{"title":"Search","sidebarTitle":"Overview","href":"/v2/api-reference/customer/search/overview"},{"openapi":"customer-openapi post /v1/search/party","title":null,"href":"/v2/api-reference/customer/search/search-party"},{"openapi":"customer-openapi post /v1/search/user","title":null,"href":"/v2/api-reference/customer/search/search-user"}]},{"group":"User Trait","pages":[{"title":"User Trait","sidebarTitle":"Overview","href":"/v2/api-reference/customer/user-trait/overview"},{"openapi":"customer-openapi post /v1/user-trait/bulkDelete","title":null,"href":"/v2/api-reference/customer/user-trait/bulk-delete-user-trait"},{"openapi":"customer-openapi post /v1/user-trait/bulk","title":null,"href":"/v2/api-reference/customer/user-trait/bulk-create-user-trait"}]},{"group":"Organization Users","pages":[{"title":"Organization Users","href":"/v2/api-reference/customer/organization-users/overview"},{"openapi":"customer-openapi get /v1/organizations/{organizationId}/users","title":null,"href":"/v2/api-reference/customer/organization-users/list-organizations-users"},{"openapi":"customer-openapi delete /v1/organizations/{organizationId}/users/{userId}","title":null,"href":"/v2/api-reference/customer/organization-users/delete-organization-user"},{"openapi":"customer-openapi get /v1/organizations/{organizationId}/users/{userId}","title":null,"href":"/v2/api-reference/customer/organization-users/get-organization-user"},{"openapi":"customer-openapi post /v1/organizations/{organizationId}/users","title":null,"href":"/v2/api-reference/customer/organization-users/create-organization-user"},{"openapi":"customer-openapi put /v1/organizations/{organizationId}/users/{userId}","title":null,"href":"/v2/api-reference/customer/organization-users/update-organization-user"}]},{"group":"Address","pages":[{"title":"Address","sidebarTitle":"Overview","href":"/v2/api-reference/customer/address/overview"},{"openapi":"customer-openapi get /v1/addresses","title":null,"href":"/v2/api-reference/customer/address/list-addresses"},{"openapi":"customer-openapi get /v1/addresses/{addressId}","title":null,"href":"/v2/api-reference/customer/address/get-address"},{"openapi":"customer-openapi post /v1/addresses","title":null,"href":"/v2/api-reference/customer/address/create-address"},{"openapi":"customer-openapi delete /v1/addresses/{addressId}","title":null,"href":"/v2/api-reference/customer/address/delete-address"},{"openapi":"customer-openapi patch /v1/addresses/{addressId}","title":null,"href":"/v2/api-reference/customer/address/update-address"}]},{"group":"User Address","pages":[{"title":"User Address","sidebarTitle":"Overview","href":"/v2/api-reference/customer/user-address/overview"},{"openapi":"customer-openapi delete /v1/user-addresses","title":null,"href":"/v2/api-reference/customer/user-address/delete-user-address"},{"openapi":"customer-openapi post /v1/user-addresses","title":null,"href":"/v2/api-reference/customer/user-address/create-user-address"},{"openapi":"customer-openapi get /v1/user-addresses/user/{userId}","title":null,"href":"/v2/api-reference/customer/user-address/list-addresses-for-single-user"}]},{"group":"Trait","pages":[{"title":"Trait","sidebarTitle":"Overview","href":"/v2/api-reference/customer/trait/overview"},{"openapi":"customer-openapi patch /v1/trait/{traitId}","title":null,"href":"/v2/api-reference/customer/trait/update-trait"},{"openapi":"customer-openapi get /v1/trait","title":null,"href":"/v2/api-reference/customer/trait/list-traits"},{"openapi":"customer-openapi post /v1/trait","title":null,"href":"/v2/api-reference/customer/trait/create-trait"},{"openapi":"customer-openapi delete /v1/trait/{traitId}","title":null,"href":"/v2/api-reference/customer/trait/delete-trait"}]},{"group":"Party Address","pages":[{"title":"Party Address","sidebarTitle":"Overview","href":"/v2/api-reference/customer/party-address/overview"},{"openapi":"customer-openapi get /v1/party-addresses/{partyAddressId}","title":null,"href":"/v2/api-reference/customer/party-address/get-party-address"},{"openapi":"customer-openapi post /v1/party-addresses","title":null,"href":"/v2/api-reference/customer/party-address/link-party-and-address"},{"openapi":"customer-openapi get /v1/party-addresses","title":null,"href":"/v2/api-reference/customer/party-address/list-party-addresses"}]},{"group":"Party Trait","pages":[{"title":"Party Trait","sidebarTitle":"Overview","href":"/v2/api-reference/customer/party-trait/overview"},{"openapi":"customer-openapi get /v1/party-trait/getTraits","title":null,"href":"/v2/api-reference/customer/party-trait/get-traits-for-a-party"},{"openapi":"customer-openapi post /v1/party-trait/bulk","title":null,"href":"/v2/api-reference/customer/party-trait/bulk-create-party-trait"},{"openapi":"customer-openapi get /v1/party-trait/getParties","title":null,"href":"/v2/api-reference/customer/party-trait/get-parties-for-a-trait"},{"openapi":"customer-openapi post /v1/party-trait/bulkDelete","title":null,"href":"/v2/api-reference/customer/party-trait/bulk-delete-party-traits"},{"openapi":"customer-openapi post /v1/party-trait/partyTrait","title":null,"href":"/v2/api-reference/customer/party-trait/create-party-trait"},{"openapi":"customer-openapi delete /v1/party-trait/partyTrait","title":null,"href":"/v2/api-reference/customer/party-trait/delete-party-trait"}]},{"group":"Organization Group Users","pages":[{"title":"Organization Group Users","sidebarTitle":"Overview","href":"/v2/api-reference/customer/organization-group-users/overview"},{"openapi":"customer-openapi get /v1/organizations/{organizationId}/groups/{groupId}/users","title":null,"href":"/v2/api-reference/customer/organization-group-users/list-organization-group-users"}]},{"group":"Internal Party","pages":[{"title":"Internal Party","sidebarTitle":"Overview","href":"/v2/api-reference/customer/internal-party/overview"},{"openapi":"customer-openapi delete /v1/internal-parties/{internalPartyId}","title":null,"href":"/v2/api-reference/customer/internal-party/delete-internal-party"},{"openapi":"customer-openapi post /v1/internal-parties","title":null,"href":"/v2/api-reference/customer/internal-party/create-internal-party"},{"openapi":"customer-openapi get /v1/internal-parties","title":null,"href":"/v2/api-reference/customer/internal-party/list-internal-parties"},{"openapi":"customer-openapi post /v1/internal-parties/{internalPartyId}/resurrect","title":null,"href":"/v2/api-reference/customer/internal-party/resurrect-internal-party"},{"openapi":"customer-openapi get /v1/internal-parties/{internalPartyId}","title":null,"href":"/v2/api-reference/customer/internal-party/get-internal-party"},{"openapi":"customer-openapi put /v1/internal-parties/{internalPartyId}","title":null,"href":"/v2/api-reference/customer/internal-party/update-internal-party"}]},{"group":"Contract Pricelist","pages":[{"openapi":"customer-openapi patch /v1/contracts/price-list/bulkUpdate","title":null,"href":"/v2/api-reference/customer/contract-pricelist/bulk-update-contract-pricelist"}]},{"group":"Internal Parties Party","pages":[{"title":"Internal Parties Only","sidebarTitle":"Overview","href":"/v2/api-reference/customer/internal-parties-party/overview"},{"openapi":"customer-openapi delete /v1/internalParties-party/create","title":null,"href":"/v2/api-reference/customer/internal-parties-party/remove-association-between-internal-party-and-party"},{"openapi":"customer-openapi post /v1/internalParties-party/create","title":null,"href":"/v2/api-reference/customer/internal-parties-party/create-association-between-internal-party-and-party"}]},{"group":"Account","pages":[{"title":"Account","sidebarTitle":"Overview","href":"/v2/api-reference/customer/account/overview"},{"openapi":"customer-openapi get /v1/accounts","title":null,"href":"/v2/api-reference/customer/account/list-accounts"},{"openapi":"customer-openapi get /v1/accounts/{accountId}/children","title":null,"href":"/v2/api-reference/customer/account/get-accounts-children"},{"openapi":"customer-openapi get /v1/accounts/{accountId}","title":null,"href":"/v2/api-reference/customer/account/get-account"},{"openapi":"customer-openapi post /v1/accounts","title":null,"href":"/v2/api-reference/customer/account/create-account"},{"openapi":"customer-openapi delete /v1/accounts/{accountId}","title":null,"href":"/v2/api-reference/customer/account/delete-account"},{"openapi":"customer-openapi patch /v1/accounts/{accountId}","title":null,"href":"/v2/api-reference/customer/account/update-account"}]},{"group":"Party Account","pages":[{"title":"Party Account","sidebarTitle":"Overview","href":"/v2/api-reference/customer/party-account/overview"},{"openapi":"customer-openapi get /v1/party-accounts/party/{partyId}","title":null,"href":"/v2/api-reference/customer/party-account/list-accounts-by-party"},{"openapi":"customer-openapi post /v1/party-accounts","title":null,"href":"/v2/api-reference/customer/party-account/link-party-and-account"},{"openapi":"customer-openapi delete /v1/party-accounts","title":null,"href":"/v2/api-reference/customer/party-account/delete-party-account"},{"openapi":"customer-openapi get /v1/party-accounts/account/{accountId}","title":null,"href":"/v2/api-reference/customer/party-account/list-parties-by-account"}]},{"group":"Organization Addresses","pages":[{"title":"Organization Addresses","sidebarTitle":"Overview","href":"/v2/api-reference/customer/organization-addresses/overview"},{"openapi":"customer-openapi put /v1/organizations/{organizationId}/addresses/{addressId}","title":null,"href":"/v2/api-reference/customer/organization-addresses/update-organization-address"},{"openapi":"customer-openapi get /v1/organizations/{organizationId}/addresses","title":null,"href":"/v2/api-reference/customer/organization-addresses/list-organization-addresses"},{"openapi":"customer-openapi delete /v1/organizations/{organizationId}/addresses/{addressId}","title":null,"href":"/v2/api-reference/customer/organization-addresses/delete-organization-address"},{"openapi":"customer-openapi post /v1/organizations/{organizationId}/addresses","title":null,"href":"/v2/api-reference/customer/organization-addresses/create-organization-address"},{"openapi":"customer-openapi get /v1/organizations/{organizationId}/addresses/{addressId}","title":null,"href":"/v2/api-reference/customer/organization-addresses/get-organization-address"}]},{"group":"Organization Groups","pages":[{"title":"Organization Groups","href":"/v2/api-reference/customer/organization-groups/overview"},{"openapi":"customer-openapi post /v1/organizations/{organizationId}/groups","title":null,"href":"/v2/api-reference/customer/organization-groups/create-organization-group"},{"openapi":"customer-openapi put /v1/organizations/{organizationId}/groups/{groupId}","title":null,"href":"/v2/api-reference/customer/organization-groups/updates-organization-group"},{"openapi":"customer-openapi delete /v1/organizations/{organizationId}/groups/{groupId}","title":null,"href":"/v2/api-reference/customer/organization-groups/delete-orgaization-group"},{"openapi":"customer-openapi get /v1/organizations/{organizationId}/groups/{groupId}","title":null,"href":"/v2/api-reference/customer/organization-groups/get-orgaization-group"},{"openapi":"customer-openapi get /v1/organizations/{organizationId}/groups","title":null,"href":"/v2/api-reference/customer/organization-groups/list-organizations-groups"}]},{"group":"Individual Addresses","pages":[{"title":"Individual Addresses","sidebarTitle":"Overview","href":"/v2/api-reference/customer/individual-addresses/overview"},{"openapi":"customer-openapi put /v1/individuals/{individualId}/addresses/{addressId}","title":null,"href":"/v2/api-reference/customer/individual-addresses/update-individuals-address"},{"openapi":"customer-openapi get /v1/individuals/{individualId}/addresses/{addressId}","title":null,"href":"/v2/api-reference/customer/individual-addresses/get-indivudals-address"},{"openapi":"customer-openapi get /v1/individuals/{individualId}/addresses","title":null,"href":"/v2/api-reference/customer/individual-addresses/list-individuals-addresses"},{"openapi":"customer-openapi post /v1/individuals/{individualId}/addresses","title":null,"href":"/v2/api-reference/customer/individual-addresses/create-individuals-address"},{"openapi":"customer-openapi delete /v1/individuals/{individualId}/addresses/{addressId}","title":null,"href":"/v2/api-reference/customer/individual-addresses/delete-individuals-address"}]},{"group":"Users Organization","pages":[{"openapi":"customer-openapi get /v1/users/{userId}/organizations","title":null,"href":"/v2/api-reference/customer/users--organization/get-all-organizations-for-a-single-user"}]},{"group":"Individual","pages":[{"title":"Individual","sidebarTitle":"Overview","href":"/v2/api-reference/customer/individual/overview"},{"openapi":"customer-openapi put /v1/individuals/{individualId}","title":null,"href":"/v2/api-reference/customer/individual/update-individual"},{"openapi":"customer-openapi get /v1/individuals","title":null,"href":"/v2/api-reference/customer/individual/list-individuals"},{"openapi":"customer-openapi post /v1/individuals","title":null,"href":"/v2/api-reference/customer/individual/create-individual"},{"openapi":"customer-openapi delete /v1/individuals/{individualId}","title":null,"href":"/v2/api-reference/customer/individual/delete-individual-customer"},{"openapi":"customer-openapi get /v1/individuals/{individualId}","title":null,"href":"/v2/api-reference/customer/individual/get-individual-customer"}]}]}]},{"tab":"Recipes","pages":[{"title":"Recipes","href":"/v2/recipes/sample"}]}]}]},"basePath":"","title":"Get connections of a single vendor - Fabric","buildId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","deploymentId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Myd8dsju.js","utils-C2HkQgW0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-8rSppmTv.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B6MjiCFm.js","snippetPresets-DwrSAONL.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-1-a5UQKQ.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C541m7wZ.js","shallow-CWELCZ77.js","getApiPlaygroundDisplay-CTo5Zn03.js","CodeSnippet-D--dzvnl.js","CodeSnippets-DM3cXEDh.js","Page-CxAy5y67.js","getPastedJson-C-VECgcL.js","icon-BPq2-Mg3.js","MethodPill-D9J5cUHd.js","DuplicateIcon-BqHaxUnD.js","createIcon-CIbcZHp9.js","DynamicMarkdown-BKiHAm_d.js","SectionHeading-DstQXt3H.js","axios-vUo_bRtp.js","Markdown-CpxgzsKA.js","clsx-C5EfhVm0.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CJ9Oly2E.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Mk6P3qvh.js"]}