Tags to add or remove. Entries are matched to the return's existing tags by title, so an unmatched title adds a new tag and a matched title with _destroy: true removes it. Removing an unmatched title is a no-op.
{"docsConfig":{"theme":"palm","$schema":"https://mintlify.com/docs.json","name":"Supercycle","colors":{"primary":"#202603","light":"#fdfcf9"},"logo":{"light":"https://mintcdn.com/supercycle/9BH4Gg5JlBQlZw4Y/images/logo/logomark-dark.svg?fit=max\u0026auto=format\u0026n=9BH4Gg5JlBQlZw4Y\u0026q=85\u0026s=d6437ea9f2e8ec9c993ffe8ec5f33e9c","dark":"https://mintcdn.com/supercycle/MQo9aD2E2itRN0QR/images/logo/logomark-light.svg?fit=max\u0026auto=format\u0026n=MQo9aD2E2itRN0QR\u0026q=85\u0026s=f3a3f69852fb3c2046cfa6ac33c0351f","href":"https://supercycle.com"},"favicon":"https://mintcdn.com/supercycle/XbKBsdX_PulItpyX/favicon.svg?fit=max\u0026auto=format\u0026n=XbKBsdX_PulItpyX\u0026q=85\u0026s=bba422965531eadf58aa44de92ecc6f1","background":{"color":{"light":"#fcfaf4","dark":"#12130b"}},"navbar":{"primary":{"type":"button","label":"Book a demo","href":"https://www.supercycle.com/pages/book/"}},"footer":{"socials":{"github":"https://github.com/madesuper","linkedin":"https://www.linkedin.com/company/supercycle-commerce"},"links":[{"items":[{"label":"Status","href":"https://status.supercycle.com/"}]}]},"search":{"prompt":"Ask any question on Supercycle..."},"fonts":{"heading":{"family":"Geist","weight":500},"body":{"family":"Geist","weight":400}},"integrations":{"gtm":{"tagId":"GTM-W9RVXLZV"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"supercycle","hasAudioNarration":false,"actualSubdomain":"supercycle","customDomains":["docs.supercycle.com"],"gitSource":{"type":"github","owner":"madesuper","repo":"supercycle-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae48c7c812f7e980ce5446d","collectionId":"fe5e46f5-2a4d-467e-8f07-4d4548cfc920","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae48c7c812f7e980ce5446d"},"feedback":{"edits":false,"issues":false,"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"}},"buildId":"6ae48c7c812f7e980ce5446d","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"Documentation","count":105},{"language":"default","tag":"Manage","count":54},{"language":"default","tag":"API","count":50},{"language":"default","tag":"Admin API","count":44},{"language":"default","tag":"Configuration","count":24},{"language":"default","tag":"Products","count":16},{"language":"default","tag":"Developers","count":14},{"language":"default","tag":"Agent and MCP","count":13},{"language":"default","tag":"Cycles","count":13},{"language":"default","tag":"Methods","count":13}]},"assistantConfig":{"enableStarterQuestions":true,"enableContextualStarterQuestions":true,"deflection":{"enabled":true,"email":"support@supercycle.com","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":"/* cyrillic-ext */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrodmgPn.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrMdmgPn.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* symbols2 */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFg08vz7ehw.woff2) format('woff2');\n unicode-range: U+2000-2001, U+2004-2008, U+200A, U+23B8-23BD, U+2500-259F;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrgdmgPn.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrkdmgPn.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: 'Geist Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrcdmg.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/* cyrillic-ext */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrodmgPn.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrMdmgPn.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* symbols2 */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFg08vz7ehw.woff2) format('woff2');\n unicode-range: U+2000-2001, U+2004-2008, U+200A, U+23B8-23BD, U+2500-259F;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrgdmgPn.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrkdmgPn.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: 'Geist Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrcdmg.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:root{--brand-dark:#202603;--brand-dark-hover:#303807;--brand-green:#08b27d;--brand-cream:#fcfaf4;--brand-warm:#faf6ef;--brand-warm-dark:#f1ede7;--brand-white:#ffffff;--thread-blush:#fedad9;--thread-sky:#dcebf8;--brand-muted:color-mix(in srgb, var(--brand-dark) 60%, transparent);--brand-tint-5:color-mix(in srgb, var(--brand-dark) 5%, transparent);--brand-tint-10:color-mix(in srgb, var(--brand-dark) 10%, transparent);--brand-tint-25:color-mix(in srgb, var(--brand-dark) 25%, transparent);--font-label:\"Geist Mono\", ui-monospace, monospace;--font-code:ui-monospace, \"SF Mono\", Menlo, Consolas, monospace;--transition-fast:150ms ease;--gray-50:250 246 239;--gray-100:241 237 231;--gray-200:230 225 216;--gray-300:214 208 196;--gray-400:168 163 150;--gray-500:120 123 99;--gray-600:98 102 75;--gray-700:76 80 51;--gray-800:54 59 27;--gray-900:32 38 3;--gray-950:32 38 3}html.dark:root{--brand-dark:#fdfcf9;--brand-dark-hover:#ffffff;--brand-cream:#12130b;--brand-warm:#1c1d15;--brand-warm-dark:#2a2b20;--brand-white:#1c1d15;--thread-blush:#4f2e34;--thread-sky:#243040;--gray-50:253 252 249;--gray-100:241 237 231;--gray-200:217 215 207;--gray-300:189 187 178;--gray-400:154 153 144;--gray-500:120 121 102;--gray-600:90 91 76;--gray-700:61 62 49;--gray-800:42 43 32;--gray-900:28 29 21;--gray-950:18 19 11}html{-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}body{color:var(--brand-dark);background-color:var(--brand-cream)}#content p:not(.not-prose *){line-height:1.6;text-wrap:pretty}#content h2:not(.not-prose *),#content h3:not(.not-prose *),#content h4:not(.not-prose *){font-weight:600;letter-spacing:-.02em;color:var(--brand-dark)}#content a:not(.card):not([class*=rounded]):not(.not-prose *){color:var(--brand-dark);font-weight:500;border-bottom:0;text-decoration:underline;text-underline-offset:.15em;text-decoration-color:var(--brand-tint-25);transition:text-decoration-color var(--transition-fast)}#content a:not(.card):not([class*=rounded]):not(.not-prose *):hover{text-decoration-color:var(--brand-dark)}#content strong:not(.not-prose *){font-weight:500;color:var(--brand-dark)}#content th:not(.not-prose *),#sidebar-title,#table-of-contents>button,.eyebrow{font-family:var(--font-label);font-size:.75rem;font-weight:500;line-height:1rem;letter-spacing:.05em;text-transform:uppercase;color:var(--brand-muted)}#header{padding-top:2.5rem;padding-bottom:2rem;border-bottom:1px solid var(--brand-warm-dark);margin-bottom:.5rem}#header .eyebrow{height:auto;margin-bottom:.75rem}#content-area:has(#content[data-page-href$=\"/index\"]) #header .eyebrow{display:none}#page-title{font-weight:500;font-size:2.35rem;line-height:1.05;letter-spacing:-.05em;color:var(--brand-dark);text-wrap:balance}@media (min-width:768px){#page-title{font-size:3rem}}main#content-container:has(#content[data-page-href$=\"/index\"]),main#content-container:has(#content[data-page-href$=\"/index\"])>*{position:relative}main#content-container:has(#content[data-page-href$=\"/index\"])::before{content:\"\";position:absolute;inset:0 0 auto;height:32rem;pointer-events:none;opacity:.45;background:linear-gradient(to bottom,var(--brand-cream) 10%,var(--thread-blush) 48%,var(--thread-sky) 68%,transparent 100%)}#content-area:has(#content[data-page-href$=\"/index\"]) #header{padding-top:4rem;padding-bottom:3rem;border-bottom:0}@media (min-width:768px){#content-area:has(#content[data-page-href$=\"/index\"]) #page-title{font-size:3.5rem}}#header .prose{font-size:1rem;line-height:1.6;color:var(--brand-muted);margin-top:1rem;text-wrap:pretty}#header #page-context-menu{position:absolute;right:0;top:0}#navbar .bg-gray-950\\/\\[0\\.03\\]{background-color:transparent;border-bottom-color:var(--brand-warm-dark)}#navbar .bg-background-light,#navbar .dark\\:bg-background-dark{background-color:var(--brand-cream)}#navbar #search-bar-entry{border-radius:9999px;background-color:var(--brand-warm);box-shadow:none;border:1px solid var(--brand-warm-dark);color:var(--brand-muted);transition:border-color var(--transition-fast),background-color var(--transition-fast)}#navbar #search-bar-entry:hover{border-color:var(--brand-tint-25);background-color:var(--brand-white)}@media (min-width:1024px){#navbar #topbar-cta-button a,#navbar .navbar-link a{display:inline-flex;align-items:center;justify-content:center;height:2rem;border-radius:9999px;font-weight:500;line-height:1}#navbar .navbar-link a{font-size:.875rem;transition:background-color var(--transition-fast),color var(--transition-fast);color:var(--brand-muted);background-color:transparent;padding:0 .75rem}#navbar #topbar-cta-button a{padding:0 1rem;background-color:var(--brand-dark);color:var(--brand-cream);font-size:.75rem;transition:background-color var(--transition-fast),scale var(--transition-fast)}#navbar .navbar-link a:hover{color:var(--brand-dark);background-color:var(--brand-tint-5)}#navbar #topbar-cta-button a:active{scale:.97}#navbar #topbar-cta-button a:hover{background-color:var(--brand-dark-hover)}#navbar #topbar-cta-button a *,#navbar #topbar-cta-button a span{color:inherit}#navbar #topbar-cta-button a svg,#navbar .navbar-link a svg{display:none}}#sidebar-content{border-right-color:var(--brand-warm-dark)}#sidebar-title{margin-bottom:.5rem}#navigation-items a,#navigation-items button{color:var(--brand-muted);transition:color var(--transition-fast)}#navigation-items a:hover,#navigation-items button:hover{color:var(--brand-dark)}#navigation-items a[class*=text-primary]{color:var(--brand-dark);font-weight:500;text-shadow:none}#navigation-items [class*=border-gray-950]{border-color:var(--brand-warm-dark)}#sidebar-content{scrollbar-color:transparent transparent}#sidebar-content:hover{scrollbar-color:var(--brand-tint-10) transparent}#sidebar-content,#sidebar-content *{scrollbar-width:thin}#sidebar-content ::-webkit-scrollbar,#sidebar-content::-webkit-scrollbar{width:6px;height:6px}#sidebar-content ::-webkit-scrollbar-track,#sidebar-content::-webkit-scrollbar-track{background:0 0}#sidebar-content ::-webkit-scrollbar-thumb,#sidebar-content::-webkit-scrollbar-thumb{background-color:transparent;border-radius:9999px;transition:background-color var(--transition-fast)}#sidebar-content:hover ::-webkit-scrollbar-thumb,#sidebar-content:hover::-webkit-scrollbar-thumb{background-color:var(--brand-tint-10)}#navigation-items ul:has(>li>a.nav-anchor){border-bottom:1px solid var(--brand-warm-dark);margin-bottom:1.25rem}#sidebar-content>#navigation-items+div{border-top-color:var(--brand-warm-dark);position:relative}.group>div:has(>svg[viewBox=\"0 -9 3 24\"]),.group>svg[viewBox=\"0 -9 3 24\"]{order:10}@media (min-width:1024px){#navbar .nav-logo{height:2rem}#navbar a:has(>.nav-logo){padding-right:.75rem;border-right:1px solid var(--brand-warm-dark)}#sidebar-content{z-index:40}.nav-dropdown-trigger{position:fixed;top:1rem;left:6.5rem;width:auto;height:2rem;margin:0;padding:0 .625rem;gap:.375rem;background:0 0;border-radius:9999px;transition:background-color var(--transition-fast)}.nav-dropdown-trigger:hover{background-color:var(--brand-tint-5)}.nav-dropdown-trigger .nav-dropdown-item-icon,.nav-dropdown-trigger .nav-dropdown-item-title~p{display:none}.nav-dropdown-trigger .nav-dropdown-item-text-container{padding:0}.nav-dropdown-trigger .nav-dropdown-item-title{font-size:.875rem;font-weight:500;color:var(--brand-dark)}#sidebar-content div{-webkit-mask-image:none!important;mask-image:none!important}#sidebar-content::before,#sidebar-content>#navigation-items+div::before{content:\"\";position:absolute;left:0;right:0;pointer-events:none}#sidebar-content::before{top:0;height:2rem;background:linear-gradient(to bottom,var(--brand-cream),transparent);z-index:1}#sidebar-content>#navigation-items+div::before{bottom:calc(100% + 1px);height:2.5rem;background:linear-gradient(to top,var(--brand-cream),transparent)}#navigation-items>div>div:first-of-type{margin-top:0}}#navigation-items li[id=\"/ai\"],#navigation-items li[id=\"/api-reference/admin\"],#navigation-items li[id=\"/api-reference/storefront\"],#navigation-items li[id=\"/developers\"],#navigation-items li[id=\"/documentation\"],button.absolute.top-5.right-5.p-1\\.5.rounded-md,footer#footer{display:none}#table-of-contents{color:var(--brand-muted)}#table-of-contents a{font-weight:400;transition:color var(--transition-fast)}#content div.card [data-component-part=card-title],#table-of-contents a:hover,.callout[class*=border-blue]>div,.callout[class*=border-emerald]>div,.callout[class*=border-gray]>div,.callout[class*=border-green]>div,.callout[class*=border-zinc]>div{color:var(--brand-dark)}#table-of-contents a[class*=text-primary]{color:var(--brand-dark);font-weight:500}#content-container{background:var(--brand-cream)}.rounded-2xl,.rounded-xl{border-radius:12px}#pagination a,.card{background-color:var(--brand-white);border:1px solid var(--brand-warm-dark);transition:border-color var(--transition-fast)}#pagination a{background-color:var(--brand-tint-5);border-radius:12px}#pagination a:hover,.card:hover{border-color:var(--brand-tint-25)!important}.card [class*=fill-gray-800],.card [class*=text-gray-800]{color:var(--brand-dark);fill:var(--brand-dark)}#content div.card,.frame{background-color:var(--brand-warm)}#content div.card{cursor:default}#content div.card:hover{border-color:var(--brand-warm-dark)!important}#content div.card [data-component-part=card-icon] svg{background-color:var(--brand-muted)!important;filter:grayscale(1);opacity:.6}.callout[class*=border-blue],.callout[class*=border-emerald],.callout[class*=border-gray],.callout[class*=border-green],.callout[class*=border-zinc]{background-color:var(--brand-warm);border-color:var(--brand-warm-dark)}.callout[class*=border-blue] svg,.callout[class*=border-gray] svg,.callout[class*=border-zinc] svg{color:var(--brand-muted);fill:currentColor}.callout[class*=border-emerald] svg,.callout[class*=border-green] svg{color:var(--brand-green);fill:currentColor}.step>.rounded-full{background-color:var(--brand-tint-10);color:var(--brand-dark);font-family:var(--font-label);font-weight:500}.step>.absolute.w-px{background:var(--brand-warm-dark)}.frame{border:1px solid var(--brand-warm-dark)}.frame img{border-radius:8px}#content [class*=accordion],#content details{border-color:var(--brand-warm-dark)}#content table:not(.not-prose *){border-collapse:collapse}#content th:not(.not-prose *){background-color:var(--brand-warm);padding-top:.625rem;padding-bottom:.625rem;border-bottom:1px solid var(--brand-warm-dark)}#content td:not(.not-prose *){border-bottom:1px solid var(--brand-warm-dark);color:var(--brand-dark)}code,kbd,pre,pre code{font-family:var(--font-code)}#content :not(pre)>code:not(.not-prose *){background-color:var(--brand-tint-5);border:0;border-radius:6px;padding:.125rem .375rem;font-size:.875em;font-weight:500;color:var(--brand-dark)}.code-block{background-color:var(--brand-white);border-color:var(--brand-warm-dark)!important;border-radius:12px}.hover\\:bg-gray-100:hover,html.dark .code-block{background-color:var(--brand-warm)}#content hr:not(.not-prose *){border-color:var(--brand-warm-dark)}@media (max-width:768px){#content-container{padding-left:1rem;padding-right:1rem}#page-title{font-size:2rem}}"}],"page":{"pagePath":"api-reference/admin/returnorders/update-a-return","slug":"/api-reference/admin/returnorders/update-a-return","pageMetadata":{"title":"Update a return","description":"Update the status of a return and its return lines. Allows updating the overall return order status and individual return line statuses.","deprecated":null,"version":null,"openapi":"https://app.supercycle.com/docs/openapi-v1.yml put /return_orders/{returnOrderId}","href":"/api-reference/admin/returnorders/update-a-return","autogeneratedByOpenApi":true},"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: \"Update the status of a return and its return lines. Allows updating the overall return order status and individual return line statuses.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Update a return","description":"Update the status of a return and its return lines. Allows updating the overall return order status and individual return line statuses.","deprecated":null,"version":null,"openapi":"https://app.supercycle.com/docs/openapi-v1.yml put /return_orders/{returnOrderId}","href":"/api-reference/admin/returnorders/update-a-return","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Update a return","description":"Update the status of a return and its return lines. Allows updating the overall return order status and individual return line statuses.","operationId":"putReturn","requestBody":"7e5617fc-65b9-49a7-aa25-7fce28ce6e07","tags":["ReturnOrders"],"responses":{"200":"27c93001-9e53-46f3-9e11-b99fd28d1530","403":"22c084ef-98e4-4bdf-945e-0c6590950bb5","429":"cc7f2bff-fdc2-47a6-bac9-32ea8c2f0d1f"},"method":"put","type":"path","servers":["bea16f65-8c81-485e-8426-ee48f620bac9"],"security":["b68f2153-e837-466d-9cc4-4502917171de"],"path":"/return_orders/{returnOrderId}","baseUrlOptions":["https://app.supercycle.com/api/v1"],"title":"Update a return","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"4fa8381c-7a21-4100-86ee-aa9936db4036":{"in":"path","name":"returnOrderId","schema":{"type":"integer","isRequired":true,"description":"Numeric ID of the return to retrieve.","uniqueKey":"","typeLabel":"integer"},"required":true,"description":"Numeric ID of the return to retrieve."}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["requested","expected","received","in_progress","completed","cancelled"],"description":"The overall status of the return order","uniqueKey":"status","typeLabel":"enum\u003cstring>"},"returnLines":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Numeric ID of the return line to update","isRequired":true,"uniqueKey":"returnLines.items.[INDEX].id","typeLabel":"integer\u003cint64>"},"status":{"type":"string","enum":["awaiting","received","missing"],"description":"Status of the individual return line","uniqueKey":"returnLines.items.[INDEX].status","typeLabel":"enum\u003cstring>"}},"required":["id"],"uniqueKey":"returnLines.items.[INDEX]","typeLabel":"object"},"uniqueKey":"returnLines","typeLabel":"object[]"},"tagsAttributes":{"type":"array","description":"Tags to add or remove. Entries are matched to the return's existing tags by title, so an unmatched title adds a new tag and a matched title with `_destroy: true` removes it. Removing an unmatched title is a no-op.","items":{"type":"object","properties":{"title":{"type":"string","uniqueKey":"tagsAttributes.items.[INDEX].title","typeLabel":"string"},"id":{"type":"integer","format":"int64","uniqueKey":"tagsAttributes.items.[INDEX].id","typeLabel":"integer\u003cint64>"},"_destroy":{"type":"boolean","description":"Set true to remove the tag matched by title (or id).","uniqueKey":"tagsAttributes.items.[INDEX]._destroy","typeLabel":"boolean"}},"uniqueKey":"tagsAttributes.items.[INDEX]","typeLabel":"object"},"uniqueKey":"tagsAttributes","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"returnLines":[{"id":123}],"tagsAttributes":[{"title":"\u003cstring>","id":123,"_destroy":true}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"27c93001-9e53-46f3-9e11-b99fd28d1530":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","required":["id","createdAt","creditStatus","customer","returnLines","sequentialId","status"],"properties":{"id":{"type":"integer","format":"int64","description":"Numeric ID of the return.","isRequired":true,"uniqueKey":"id","typeLabel":"integer\u003cint64>"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"creditStatus":{"type":"string","enum":["uncredited","partially_recredited","recredited"],"isRequired":true,"uniqueKey":"creditStatus","typeLabel":"enum\u003cstring>"},"customer":{"type":"object","unevaluatedProperties":false,"required":["id","createdAt","shopifyId"],"properties":{"id":{"type":"integer","format":"int64","description":"Numeric ID of the customer.","isRequired":true,"uniqueKey":"customer.id","typeLabel":"integer\u003cint64>"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"customer.createdAt","typeLabel":"string\u003cdate-time>"},"shopifyId":{"type":"integer","format":"int64","isRequired":true,"uniqueKey":"customer.shopifyId","typeLabel":"integer\u003cint64>"},"defaultAddress":{"oneOf":[{"type":"null","uniqueKey":"customer.defaultAddress.oneOf.0","typeLabel":"null"},{"type":"object","description":"Default address of the customer.","required":["id","customerId","default"],"properties":{"customerId":{"type":"integer","format":"int64","description":"Numeric ID of the customer.","isRequired":true,"uniqueKey":"customer.defaultAddress.oneOf.1.customerId","typeLabel":"integer\u003cint64>"},"default":{"type":"boolean","isRequired":true,"uniqueKey":"customer.defaultAddress.oneOf.1.default","typeLabel":"boolean"},"firstName":{"type":"string","uniqueKey":"customer.defaultAddress.oneOf.1.firstName","typeLabel":"string"},"lastName":{"type":"string","uniqueKey":"customer.defaultAddress.oneOf.1.lastName","typeLabel":"string"},"company":{"type":"string","uniqueKey":"customer.defaultAddress.oneOf.1.company","typeLabel":"string"},"address1":{"type":"string","uniqueKey":"customer.defaultAddress.oneOf.1.address1","typeLabel":"string"},"address2":{"type":"string","uniqueKey":"customer.defaultAddress.oneOf.1.address2","typeLabel":"string"},"city":{"type":"string","uniqueKey":"customer.defaultAddress.oneOf.1.city","typeLabel":"string"},"province":{"type":"string","uniqueKey":"customer.defaultAddress.oneOf.1.province","typeLabel":"string"},"country":{"type":"string","uniqueKey":"customer.defaultAddress.oneOf.1.country","typeLabel":"string"},"zip":{"type":"string","uniqueKey":"customer.defaultAddress.oneOf.1.zip","typeLabel":"string"},"phone":{"type":"string","uniqueKey":"customer.defaultAddress.oneOf.1.phone","typeLabel":"string"},"name":{"type":"string","uniqueKey":"customer.defaultAddress.oneOf.1.name","typeLabel":"string"},"provinceCode":{"type":"string","uniqueKey":"customer.defaultAddress.oneOf.1.provinceCode","typeLabel":"string"},"countryCode":{"type":"string","uniqueKey":"customer.defaultAddress.oneOf.1.countryCode","typeLabel":"string"},"countryName":{"type":"string","uniqueKey":"customer.defaultAddress.oneOf.1.countryName","typeLabel":"string"}},"uniqueKey":"customer.defaultAddress.oneOf.1","typeLabel":"object"}],"uniqueKey":"customer.defaultAddress","typeLabel":"null | object"},"email":{"oneOf":[{"type":"null","uniqueKey":"customer.email.oneOf.0","typeLabel":"null"},{"type":"string","uniqueKey":"customer.email.oneOf.1","typeLabel":"string"}],"uniqueKey":"customer.email","typeLabel":"null | string"},"firstName":{"oneOf":[{"type":"null","uniqueKey":"customer.firstName.oneOf.0","typeLabel":"null"},{"type":"string","uniqueKey":"customer.firstName.oneOf.1","typeLabel":"string"}],"uniqueKey":"customer.firstName","typeLabel":"null | string"},"lastName":{"oneOf":[{"type":"null","uniqueKey":"customer.lastName.oneOf.0","typeLabel":"null"},{"type":"string","uniqueKey":"customer.lastName.oneOf.1","typeLabel":"string"}],"uniqueKey":"customer.lastName","typeLabel":"null | string"}},"isRequired":true,"uniqueKey":"customer","typeLabel":"object"},"returnLines":{"type":"array","items":{"type":"object","unevaluatedProperties":false,"required":["id","createdAt","rentalId","status"],"properties":{"id":{"type":"integer","format":"int64","description":"Numeric ID of the return line.","isRequired":true,"uniqueKey":"returnLines.items.[INDEX].id","typeLabel":"integer\u003cint64>"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"returnLines.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"rentalId":{"type":"integer","format":"int64","isRequired":true,"uniqueKey":"returnLines.items.[INDEX].rentalId","typeLabel":"integer\u003cint64>"},"status":{"type":"string","enum":["awaiting","received","missing"],"description":"Status of the return line.","isRequired":true,"uniqueKey":"returnLines.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"condition":{"oneOf":[{"type":"null","uniqueKey":"returnLines.items.[INDEX].condition.oneOf.0","typeLabel":"null"},{"type":"object","required":["id","createdAt","severityKey","severityTone","title"],"properties":{"id":{"type":"integer","format":"int64","description":"Numeric ID of the condition.","isRequired":true,"uniqueKey":"returnLines.items.[INDEX].condition.oneOf.1.id","typeLabel":"integer\u003cint64>"},"createdAt":{"type":"string","format":"date-time","description":"Date and time the condition was created.","isRequired":true,"uniqueKey":"returnLines.items.[INDEX].condition.oneOf.1.createdAt","typeLabel":"string\u003cdate-time>"},"severityKey":{"type":"string","description":"Severity key of the condition.","isRequired":true,"uniqueKey":"returnLines.items.[INDEX].condition.oneOf.1.severityKey","typeLabel":"string"},"severityTone":{"type":"string","description":"Tone of the condition.","isRequired":true,"uniqueKey":"returnLines.items.[INDEX].condition.oneOf.1.severityTone","typeLabel":"string"},"title":{"type":"string","description":"Title of the condition.","isRequired":true,"uniqueKey":"returnLines.items.[INDEX].condition.oneOf.1.title","typeLabel":"string"}},"uniqueKey":"returnLines.items.[INDEX].condition.oneOf.1","typeLabel":"object"}],"uniqueKey":"returnLines.items.[INDEX].condition","typeLabel":"null | object"},"item":{"type":"object","required":["id","createdAt","activeRentalId","productTitle","serial","sequentialId","shopifyVariantId","status","tags","variantTitle","visibility"],"properties":{"id":{"type":"integer","format":"int64","description":"Numeric ID of the item.","isRequired":true,"uniqueKey":"returnLines.items.[INDEX].item.id","typeLabel":"integer\u003cint64>"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"returnLines.items.[INDEX].item.createdAt","typeLabel":"string\u003cdate-time>"},"activeRentalId":{"oneOf":[{"type":"null","isRequired":true,"uniqueKey":"returnLines.items.[INDEX].item.activeRentalId.oneOf.0","typeLabel":"null"},{"type":"integer","format":"int64","isRequired":true,"uniqueKey":"returnLines.items.[INDEX].item.activeRentalId.oneOf.1","typeLabel":"integer\u003cint64>"}],"isRequired":true,"uniqueKey":"returnLines.items.[INDEX].item.activeRentalId","typeLabel":"null | integer\u003cint64>"},"productTitle":{"type":"string","isRequired":true,"uniqueKey":"returnLines.items.[INDEX].item.productTitle","typeLabel":"string"},"serial":{"oneOf":[{"type":"null","isRequired":true,"uniqueKey":"returnLines.items.[INDEX].item.serial.oneOf.0","typeLabel":"null"},{"type":"string","isRequired":true,"uniqueKey":"returnLines.items.[INDEX].item.serial.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"returnLines.items.[INDEX].item.serial","typeLabel":"null | string"},"sequentialId":{"type":"integer","format":"int32","isRequired":true,"uniqueKey":"returnLines.items.[INDEX].item.sequentialId","typeLabel":"integer\u003cint32>"},"shopifyVariantId":{"oneOf":[{"type":"null","isRequired":true,"uniqueKey":"returnLines.items.[INDEX].item.shopifyVariantId.oneOf.0","typeLabel":"null"},{"type":"integer","isRequired":true,"uniqueKey":"returnLines.items.[INDEX].item.shopifyVariantId.oneOf.1","typeLabel":"integer"}],"isRequired":true,"uniqueKey":"returnLines.items.[INDEX].item.shopifyVariantId","typeLabel":"null | integer"},"status":{"type":"string","enum":["processed","unprocessed"],"isRequired":true,"uniqueKey":"returnLines.items.[INDEX].item.status","typeLabel":"enum\u003cstring>"},"tags":{"type":"array","items":{"type":"string","uniqueKey":"returnLines.items.[INDEX].item.tags.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"returnLines.items.[INDEX].item.tags","typeLabel":"string[]"},"variantTitle":{"oneOf":[{"type":"null","isRequired":true,"uniqueKey":"returnLines.items.[INDEX].item.variantTitle.oneOf.0","typeLabel":"null"},{"type":"string","isRequired":true,"uniqueKey":"returnLines.items.[INDEX].item.variantTitle.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"returnLines.items.[INDEX].item.variantTitle","typeLabel":"null | string"},"visibility":{"type":"string","enum":["available","unavailable","sold","retired"],"isRequired":true,"uniqueKey":"returnLines.items.[INDEX].item.visibility","typeLabel":"enum\u003cstring>"},"activeReturnId":{"oneOf":[{"type":"null","uniqueKey":"returnLines.items.[INDEX].item.activeReturnId.oneOf.0","typeLabel":"null"},{"type":"integer","format":"int64","uniqueKey":"returnLines.items.[INDEX].item.activeReturnId.oneOf.1","typeLabel":"integer\u003cint64>"}],"uniqueKey":"returnLines.items.[INDEX].item.activeReturnId","typeLabel":"null | integer\u003cint64>"},"condition":{"oneOf":[{"type":"null","uniqueKey":"returnLines.items.[INDEX].item.condition.oneOf.0","typeLabel":"null"},{"type":"object","required":["id","createdAt","severityKey","severityTone","title"],"properties":{"id":{"type":"integer","format":"int64","description":"Numeric ID of the condition.","isRequired":true,"uniqueKey":"returnLines.items.[INDEX].item.condition.oneOf.1.id","typeLabel":"integer\u003cint64>"},"createdAt":{"type":"string","format":"date-time","description":"Date and time the condition was created.","isRequired":true,"uniqueKey":"returnLines.items.[INDEX].item.condition.oneOf.1.createdAt","typeLabel":"string\u003cdate-time>"},"severityKey":{"type":"string","description":"Severity key of the condition.","isRequired":true,"uniqueKey":"returnLines.items.[INDEX].item.condition.oneOf.1.severityKey","typeLabel":"string"},"severityTone":{"type":"string","description":"Tone of the condition.","isRequired":true,"uniqueKey":"returnLines.items.[INDEX].item.condition.oneOf.1.severityTone","typeLabel":"string"},"title":{"type":"string","description":"Title of the condition.","isRequired":true,"uniqueKey":"returnLines.items.[INDEX].item.condition.oneOf.1.title","typeLabel":"string"}},"uniqueKey":"returnLines.items.[INDEX].item.condition.oneOf.1","typeLabel":"object"}],"uniqueKey":"returnLines.items.[INDEX].item.condition","typeLabel":"null | object"},"conditionId":{"oneOf":[{"type":"null","description":"ID of the condition. May be null if no condition is set.","uniqueKey":"returnLines.items.[INDEX].item.conditionId.oneOf.0","typeLabel":"null"},{"type":"integer","description":"ID of the condition. May be null if no condition is set.","uniqueKey":"returnLines.items.[INDEX].item.conditionId.oneOf.1","typeLabel":"integer"}],"uniqueKey":"returnLines.items.[INDEX].item.conditionId","typeLabel":"null | integer"},"imageUrl":{"oneOf":[{"type":"null","uniqueKey":"returnLines.items.[INDEX].item.imageUrl.oneOf.0","typeLabel":"null"},{"type":"string","uniqueKey":"returnLines.items.[INDEX].item.imageUrl.oneOf.1","typeLabel":"string"}],"uniqueKey":"returnLines.items.[INDEX].item.imageUrl","typeLabel":"null | string"},"location":{"oneOf":[{"type":"null","uniqueKey":"returnLines.items.[INDEX].item.location.oneOf.0","typeLabel":"null"},{"type":"object","description":"Location of the item in the warehouse.","required":["shopifyId","name"],"properties":{"shopifyId":{"type":"integer","format":"int64","description":"Numeric ID of the Shopify location.","isRequired":true,"uniqueKey":"returnLines.items.[INDEX].item.location.oneOf.1.shopifyId","typeLabel":"integer\u003cint64>"},"name":{"type":"string","description":"Name of the location.","isRequired":true,"uniqueKey":"returnLines.items.[INDEX].item.location.oneOf.1.name","typeLabel":"string"}},"uniqueKey":"returnLines.items.[INDEX].item.location.oneOf.1","typeLabel":"object"}],"uniqueKey":"returnLines.items.[INDEX].item.location","typeLabel":"null | object"},"pickLocation":{"oneOf":[{"type":"null","description":"Physical location within warehouse using Zone-Aisle-Shelf-Bin format (e.g., \"A1-02-B3\"). May be null if no pick location is set.","uniqueKey":"returnLines.items.[INDEX].item.pickLocation.oneOf.0","typeLabel":"null"},{"type":"string","description":"Physical location within warehouse using Zone-Aisle-Shelf-Bin format (e.g., \"A1-02-B3\"). May be null if no pick location is set.","uniqueKey":"returnLines.items.[INDEX].item.pickLocation.oneOf.1","typeLabel":"string"}],"uniqueKey":"returnLines.items.[INDEX].item.pickLocation","typeLabel":"null | string"},"acquisitionCostCents":{"oneOf":[{"type":"null","description":"Amount paid to acquire this item, in cents. May be null if not set.","uniqueKey":"returnLines.items.[INDEX].item.acquisitionCostCents.oneOf.0","typeLabel":"null"},{"type":"integer","description":"Amount paid to acquire this item, in cents. May be null if not set.","uniqueKey":"returnLines.items.[INDEX].item.acquisitionCostCents.oneOf.1","typeLabel":"integer"}],"uniqueKey":"returnLines.items.[INDEX].item.acquisitionCostCents","typeLabel":"null | integer"},"publishedAt":{"oneOf":[{"type":"null","format":"date-time","description":"When utilization and ROI tracking starts for this item. Null when unset.","uniqueKey":"returnLines.items.[INDEX].item.publishedAt.oneOf.0","typeLabel":"null"},{"type":"string","format":"date-time","description":"When utilization and ROI tracking starts for this item. Null when unset.","uniqueKey":"returnLines.items.[INDEX].item.publishedAt.oneOf.1","typeLabel":"string\u003cdate-time>"}],"uniqueKey":"returnLines.items.[INDEX].item.publishedAt","typeLabel":"null | string\u003cdate-time>"},"roiCents":{"oneOf":[{"type":"null","description":"Computed return on investment (lifecycle revenue minus acquisition cost), in cents. Null when acquisitionCostCents is null.","uniqueKey":"returnLines.items.[INDEX].item.roiCents.oneOf.0","typeLabel":"null"},{"type":"integer","description":"Computed return on investment (lifecycle revenue minus acquisition cost), in cents. Null when acquisitionCostCents is null.","uniqueKey":"returnLines.items.[INDEX].item.roiCents.oneOf.1","typeLabel":"integer"}],"uniqueKey":"returnLines.items.[INDEX].item.roiCents","typeLabel":"null | integer"},"shopifyProductId":{"oneOf":[{"type":"null","uniqueKey":"returnLines.items.[INDEX].item.shopifyProductId.oneOf.0","typeLabel":"null"},{"type":"integer","uniqueKey":"returnLines.items.[INDEX].item.shopifyProductId.oneOf.1","typeLabel":"integer"}],"uniqueKey":"returnLines.items.[INDEX].item.shopifyProductId","typeLabel":"null | integer"},"timelineEvents":{"type":"array","description":"Timeline events for this item","items":{"type":"object","required":["id","eventableId","eventableType","eventType"],"properties":{"id":{"type":"integer","format":"int64","description":"Numeric ID of the timeline event.","isRequired":true,"uniqueKey":"returnLines.items.[INDEX].item.timelineEvents.items.[INDEX].id","typeLabel":"integer\u003cint64>"},"eventableId":{"type":"integer","format":"int64","description":"Numeric ID of the resource associated with the event.","isRequired":true,"uniqueKey":"returnLines.items.[INDEX].item.timelineEvents.items.[INDEX].eventableId","typeLabel":"integer\u003cint64>"},"eventableType":{"type":"string","description":"Type of the resource (e.g., Item, Cycle, ReturnOrder). Cycle rows created before the Rental -> Cycle rename returned `Rental` until the data backfill completed.","isRequired":true,"uniqueKey":"returnLines.items.[INDEX].item.timelineEvents.items.[INDEX].eventableType","typeLabel":"string"},"eventType":{"type":"string","description":"Type of the timeline event.","isRequired":true,"uniqueKey":"returnLines.items.[INDEX].item.timelineEvents.items.[INDEX].eventType","typeLabel":"string"},"metadata":{"type":"object","description":"Additional data associated with the timeline event.","uniqueKey":"returnLines.items.[INDEX].item.timelineEvents.items.[INDEX].metadata","typeLabel":"object"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the event was created.","uniqueKey":"returnLines.items.[INDEX].item.timelineEvents.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp when the event was last updated.","uniqueKey":"returnLines.items.[INDEX].item.timelineEvents.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"},"author":{"oneOf":[{"type":"string","description":"Author of the timeline event.","uniqueKey":"returnLines.items.[INDEX].item.timelineEvents.items.[INDEX].author.oneOf.0","typeLabel":"string"},{"type":"null","description":"Author of the timeline event.","uniqueKey":"returnLines.items.[INDEX].item.timelineEvents.items.[INDEX].author.oneOf.1","typeLabel":"null"}],"uniqueKey":"returnLines.items.[INDEX].item.timelineEvents.items.[INDEX].author","typeLabel":"string | null"}},"uniqueKey":"returnLines.items.[INDEX].item.timelineEvents.items.[INDEX]","typeLabel":"object"},"uniqueKey":"returnLines.items.[INDEX].item.timelineEvents","typeLabel":"object[]"},"customFields":{"type":"array","description":"Custom fields attached to this item","items":{"type":"object","required":["id","ownerId","ownerType","definitionId","key","value"],"properties":{"id":{"type":"integer","format":"int64","description":"Numeric ID of the custom field.","isRequired":true,"uniqueKey":"returnLines.items.[INDEX].item.customFields.items.[INDEX].id","typeLabel":"integer\u003cint64>"},"ownerId":{"type":"integer","format":"int64","description":"ID of the item or rental that owns this custom field.","isRequired":true,"uniqueKey":"returnLines.items.[INDEX].item.customFields.items.[INDEX].ownerId","typeLabel":"integer\u003cint64>"},"ownerType":{"type":"string","enum":["Item","Cycle","Rental"],"description":"Type of the owner resource. `Rental` is the legacy spelling of `Cycle`, returned only for rows created before the Rental -> Cycle data backfill.","isRequired":true,"uniqueKey":"returnLines.items.[INDEX].item.customFields.items.[INDEX].ownerType","typeLabel":"enum\u003cstring>"},"definitionId":{"type":"integer","format":"int64","description":"ID of the custom field definition.","isRequired":true,"uniqueKey":"returnLines.items.[INDEX].item.customFields.items.[INDEX].definitionId","typeLabel":"integer\u003cint64>"},"key":{"type":"string","description":"Key of the custom field definition.","isRequired":true,"uniqueKey":"returnLines.items.[INDEX].item.customFields.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","description":"Raw stored value of the custom field.","isRequired":true,"uniqueKey":"returnLines.items.[INDEX].item.customFields.items.[INDEX].value","typeLabel":"string"},"valueJson":{"description":"Typed JSON value of the custom field (format depends on definition type). An image field gives `{ key, filename, contentType, byteSize, url, thumbnailUrl }` per image (an array when the definition is a list); `url` and `thumbnailUrl` are signed and expire after an hour, and `thumbnailUrl` is null until the thumbnail has been generated. Image fields are in beta (see `CustomFieldDefinition.type`).","uniqueKey":"returnLines.items.[INDEX].item.customFields.items.[INDEX].valueJson","typeLabel":"any"}},"uniqueKey":"returnLines.items.[INDEX].item.customFields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"returnLines.items.[INDEX].item.customFields","typeLabel":"object[]"}},"uniqueKey":"returnLines.items.[INDEX].item","typeLabel":"object"},"requestedAt":{"oneOf":[{"type":"null","format":"date-time","uniqueKey":"returnLines.items.[INDEX].requestedAt.oneOf.0","typeLabel":"null"},{"type":"string","format":"date-time","uniqueKey":"returnLines.items.[INDEX].requestedAt.oneOf.1","typeLabel":"string\u003cdate-time>"}],"uniqueKey":"returnLines.items.[INDEX].requestedAt","typeLabel":"null | string\u003cdate-time>"},"restockedAt":{"oneOf":[{"type":"null","format":"date-time","uniqueKey":"returnLines.items.[INDEX].restockedAt.oneOf.0","typeLabel":"null"},{"type":"string","format":"date-time","uniqueKey":"returnLines.items.[INDEX].restockedAt.oneOf.1","typeLabel":"string\u003cdate-time>"}],"uniqueKey":"returnLines.items.[INDEX].restockedAt","typeLabel":"null | string\u003cdate-time>"}},"uniqueKey":"returnLines.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"returnLines","typeLabel":"object[]"},"sequentialId":{"type":"integer","format":"int32","description":"Sequential ID of the return.","isRequired":true,"uniqueKey":"sequentialId","typeLabel":"integer\u003cint32>"},"status":{"type":"string","enum":["requested","expected","received","in_progress","completed","cancelled"],"description":"Status of the return.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"receivalStatus":{"type":"string","enum":["unreceived","partially_received","received"],"uniqueKey":"receivalStatus","typeLabel":"enum\u003cstring>"},"requestedAt":{"oneOf":[{"type":"null","format":"date-time","uniqueKey":"requestedAt.oneOf.0","typeLabel":"null"},{"type":"string","format":"date-time","uniqueKey":"requestedAt.oneOf.1","typeLabel":"string\u003cdate-time>"}],"uniqueKey":"requestedAt","typeLabel":"null | string\u003cdate-time>"},"returnMethod":{"oneOf":[{"type":"null","description":"Return method information","properties":{"type":{"type":"string","enum":["ReturnMethod::Collection","ReturnMethod::ReturnLabel"],"description":"Type of return method"},"trackingUrl":{"oneOf":[{"type":"null","description":"Tracking URL for return label method"},{"type":"string","description":"Tracking URL for return label method"}]},"addressShopifyId":{"oneOf":[{"type":"null","format":"int64","description":"Shopify address ID for collection method"},{"type":"integer","format":"int64","description":"Shopify address ID for collection method"}]},"collectionDate":{"oneOf":[{"type":"null","format":"date","description":"Collection date for collection method"},{"type":"string","format":"date","description":"Collection date for collection method"}]}},"uniqueKey":"returnMethod.oneOf.0","typeLabel":"null"},{"type":"object","description":"Return method information","properties":{"type":{"type":"string","enum":["ReturnMethod::Collection","ReturnMethod::ReturnLabel"],"description":"Type of return method","uniqueKey":"returnMethod.oneOf.1.type","typeLabel":"enum\u003cstring>"},"trackingUrl":{"oneOf":[{"type":"null","description":"Tracking URL for return label method","uniqueKey":"returnMethod.oneOf.1.trackingUrl.oneOf.0","typeLabel":"null"},{"type":"string","description":"Tracking URL for return label method","uniqueKey":"returnMethod.oneOf.1.trackingUrl.oneOf.1","typeLabel":"string"}],"uniqueKey":"returnMethod.oneOf.1.trackingUrl","typeLabel":"null | string"},"addressShopifyId":{"oneOf":[{"type":"null","format":"int64","description":"Shopify address ID for collection method","uniqueKey":"returnMethod.oneOf.1.addressShopifyId.oneOf.0","typeLabel":"null"},{"type":"integer","format":"int64","description":"Shopify address ID for collection method","uniqueKey":"returnMethod.oneOf.1.addressShopifyId.oneOf.1","typeLabel":"integer\u003cint64>"}],"uniqueKey":"returnMethod.oneOf.1.addressShopifyId","typeLabel":"null | integer\u003cint64>"},"collectionDate":{"oneOf":[{"type":"null","format":"date","description":"Collection date for collection method","uniqueKey":"returnMethod.oneOf.1.collectionDate.oneOf.0","typeLabel":"null"},{"type":"string","format":"date","description":"Collection date for collection method","uniqueKey":"returnMethod.oneOf.1.collectionDate.oneOf.1","typeLabel":"string\u003cdate>"}],"uniqueKey":"returnMethod.oneOf.1.collectionDate","typeLabel":"null | string\u003cdate>"}},"uniqueKey":"returnMethod.oneOf.1","typeLabel":"object"}],"uniqueKey":"returnMethod","typeLabel":"null | object"},"timelineEvents":{"type":"array","description":"Timeline events for this return order","items":{"type":"object","required":["id","eventableId","eventableType","eventType"],"properties":{"id":{"type":"integer","format":"int64","description":"Numeric ID of the timeline event.","isRequired":true,"uniqueKey":"timelineEvents.items.[INDEX].id","typeLabel":"integer\u003cint64>"},"eventableId":{"type":"integer","format":"int64","description":"Numeric ID of the resource associated with the event.","isRequired":true,"uniqueKey":"timelineEvents.items.[INDEX].eventableId","typeLabel":"integer\u003cint64>"},"eventableType":{"type":"string","description":"Type of the resource (e.g., Item, Cycle, ReturnOrder). Cycle rows created before the Rental -> Cycle rename returned `Rental` until the data backfill completed.","isRequired":true,"uniqueKey":"timelineEvents.items.[INDEX].eventableType","typeLabel":"string"},"eventType":{"type":"string","description":"Type of the timeline event.","isRequired":true,"uniqueKey":"timelineEvents.items.[INDEX].eventType","typeLabel":"string"},"metadata":{"type":"object","description":"Additional data associated with the timeline event.","uniqueKey":"timelineEvents.items.[INDEX].metadata","typeLabel":"object"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when the event was created.","uniqueKey":"timelineEvents.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp when the event was last updated.","uniqueKey":"timelineEvents.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"},"author":{"oneOf":[{"type":"string","description":"Author of the timeline event.","uniqueKey":"timelineEvents.items.[INDEX].author.oneOf.0","typeLabel":"string"},{"type":"null","description":"Author of the timeline event.","uniqueKey":"timelineEvents.items.[INDEX].author.oneOf.1","typeLabel":"null"}],"uniqueKey":"timelineEvents.items.[INDEX].author","typeLabel":"string | null"}},"uniqueKey":"timelineEvents.items.[INDEX]","typeLabel":"object"},"uniqueKey":"timelineEvents","typeLabel":"object[]"},"tags":{"type":"array","items":{"type":"string","uniqueKey":"tags.items.[INDEX]","typeLabel":"string"},"uniqueKey":"tags","typeLabel":"string[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":123,"createdAt":"2023-11-07T05:31:56Z","creditStatus":"uncredited","customer":{"id":123,"createdAt":"2023-11-07T05:31:56Z","shopifyId":123,"defaultAddress":{"customerId":123,"default":true,"firstName":"\u003cstring>","lastName":"\u003cstring>","company":"\u003cstring>","address1":"\u003cstring>","address2":"\u003cstring>","city":"\u003cstring>","province":"\u003cstring>","country":"\u003cstring>","zip":"\u003cstring>","phone":"\u003cstring>","name":"\u003cstring>","provinceCode":"\u003cstring>","countryCode":"\u003cstring>","countryName":"\u003cstring>"},"email":"\u003cstring>","firstName":"\u003cstring>","lastName":"\u003cstring>"},"returnLines":[{"id":123,"createdAt":"2023-11-07T05:31:56Z","rentalId":123,"status":"awaiting","condition":{"id":123,"createdAt":"2023-11-07T05:31:56Z","severityKey":"\u003cstring>","severityTone":"\u003cstring>","title":"\u003cstring>"},"item":{"id":123,"createdAt":"2023-11-07T05:31:56Z","activeRentalId":123,"productTitle":"\u003cstring>","serial":"\u003cstring>","sequentialId":123,"shopifyVariantId":123,"status":"processed","tags":["\u003cstring>"],"variantTitle":"\u003cstring>","visibility":"available","activeReturnId":123,"condition":{"id":123,"createdAt":"2023-11-07T05:31:56Z","severityKey":"\u003cstring>","severityTone":"\u003cstring>","title":"\u003cstring>"},"conditionId":123,"imageUrl":"\u003cstring>","location":{"shopifyId":123,"name":"\u003cstring>"},"pickLocation":"\u003cstring>","acquisitionCostCents":123,"publishedAt":"2023-11-07T05:31:56Z","roiCents":123,"shopifyProductId":123,"timelineEvents":[{"id":123,"eventableId":123,"eventableType":"\u003cstring>","eventType":"\u003cstring>","metadata":{},"createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","author":"\u003cstring>"}],"customFields":[{"id":123,"ownerId":123,"ownerType":"Item","definitionId":123,"key":"\u003cstring>","value":"\u003cstring>","valueJson":"\u003cunknown>"}]},"requestedAt":"2023-11-07T05:31:56Z","restockedAt":"2023-11-07T05:31:56Z"}],"sequentialId":123,"status":"requested","receivalStatus":"unreceived","requestedAt":"2023-11-07T05:31:56Z","returnMethod":{"type":"ReturnMethod::Collection","trackingUrl":"\u003cstring>","addressShopifyId":123,"collectionDate":"2023-12-25"},"timelineEvents":[{"id":123,"eventableId":123,"eventableType":"\u003cstring>","eventType":"\u003cstring>","metadata":{},"createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","author":"\u003cstring>"}],"tags":["\u003cstring>"]}}},"exampleType":"generated"}},"exampleType":"generated"},"22c084ef-98e4-4bdf-945e-0c6590950bb5":{"description":"The shop is blocked pending activation. Its API keys work again once Supercycle activates it.","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string","example":"This shop is blocked pending activation","uniqueKey":"errors.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors","typeLabel":"string[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":["This shop is blocked pending activation"]}}},"exampleType":"generated"}},"exampleType":"generated"},"cc7f2bff-fdc2-47a6-bac9-32ea8c2f0d1f":{"description":"Rate limit exceeded","headers":{"Retry-After":{"description":"Seconds until the current throttle window resets.","schema":{"type":"integer","example":42}},"X-RateLimit-Limit":{"description":"Maximum requests allowed in the window that triggered this response.","schema":{"type":"integer","example":120}},"X-RateLimit-Remaining":{"description":"Remaining requests in the window (always 0 when this response is returned).","schema":{"type":"integer","example":0}},"X-RateLimit-Reset":{"description":"ISO 8601 timestamp when the throttle window resets.","schema":{"type":"string","format":"date-time"}}},"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","example":"Rate limit exceeded. Retry after 42 seconds.","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Rate limit exceeded. Retry after 42 seconds."}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"b68f2153-e837-466d-9cc4-4502917171de":{"bearerAuth":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"bea16f65-8c81-485e-8426-ee48f620bac9":{"url":"https://app.supercycle.com/api/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"},"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":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"https://app.supercycle.com/docs/openapi-v1.yml"},"subdomain":"supercycle","siteName":"Supercycle","title":"Update a return - Supercycle","contextualStarterQuestions":[{"_id":"6a4d20d9ce28f70b14debfb0","deploymentId":"65c383cbf682d86e743b0b26","questionText":"Can I update individual line items?","status":"active","generatedBy":"contextual","path":"api-reference/admin/returnorders/update-a-return","createdAt":"2026-07-07T15:52:57.402Z","updatedAt":"2026-07-07T15:52:57.402Z","__v":0},{"_id":"6a4d20d9ce28f70b14debfb1","deploymentId":"65c383cbf682d86e743b0b26","questionText":"What statuses can I set?","status":"active","generatedBy":"contextual","path":"api-reference/admin/returnorders/update-a-return","createdAt":"2026-07-07T15:52:57.402Z","updatedAt":"2026-07-07T15:52:57.402Z","__v":0},{"_id":"6a4d20d9ce28f70b14debfaf","deploymentId":"65c383cbf682d86e743b0b26","questionText":"How do I update return status?","status":"active","generatedBy":"contextual","path":"api-reference/admin/returnorders/update-a-return","createdAt":"2026-07-07T15:52:57.402Z","updatedAt":"2026-07-07T15:52:57.402Z","__v":0}],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-29T15:42:30.148Z","originalFileLocation":"api-reference/admin/returnorders/update-a-return.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=\"Update the status of a return and its return lines. Allows updating the overall return order status and individual return line statuses.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Supercycle\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/supercycle/Wj84PFe2qxzcZgMf/_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/supercycle/Wj84PFe2qxzcZgMf/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/supercycle/Wj84PFe2qxzcZgMf/_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/supercycle/Wj84PFe2qxzcZgMf/_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/supercycle/Wj84PFe2qxzcZgMf/_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/supercycle/Wj84PFe2qxzcZgMf/_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/supercycle/Wj84PFe2qxzcZgMf/_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/supercycle/Wj84PFe2qxzcZgMf/_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/supercycle/Wj84PFe2qxzcZgMf/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update a return - Supercycle\">\u003cmeta data-mint-head property=\"og:description\" content=\"Update the status of a return and its return lines. Allows updating the overall return order status and individual return line statuses.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Supercycle\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.supercycle.com/api-reference/admin/returnorders/update-a-return\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://supercycle.mintlify.app/_mintlify/api/og/v2?division=ReturnOrders\u0026amp;title=Update+a+return\u0026amp;description=Update+the+status+of+a+return+and+its+return+lines.+Allows+updating+the+overall+return+order+status+and+individual+return+line+statuses.\u0026amp;theme=7faca46aff91542c9f0403e9\u0026amp;signature=b3112f3a3cfc79d9fc8ae0b2b787de4d6e820fb840a10010e160ffbe7e44092e\">\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=\"Update a return - Supercycle\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Update the status of a return and its return lines. Allows updating the overall return order status and individual return line statuses.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://supercycle.mintlify.app/_mintlify/api/og/v2?division=ReturnOrders\u0026amp;title=Update+a+return\u0026amp;description=Update+the+status+of+a+return+and+its+return+lines.+Allows+updating+the+overall+return+order+status+and+individual+return+line+statuses.\u0026amp;theme=7faca46aff91542c9f0403e9\u0026amp;signature=b3112f3a3cfc79d9fc8ae0b2b787de4d6e820fb840a10010e160ffbe7e44092e\">\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/supercycle/Wj84PFe2qxzcZgMf/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Supercycle\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#202603\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.supercycle.com/api-reference/admin/returnorders/update-a-return\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/admin/returnorders/update-a-return.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.supercycle.com/#organization\",\"name\":\"Supercycle\",\"url\":\"https://docs.supercycle.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/supercycle/9BH4Gg5JlBQlZw4Y/images/logo/logomark-dark.svg?fit=max\u0026auto=format\u0026n=9BH4Gg5JlBQlZw4Y\u0026q=85\u0026s=d6437ea9f2e8ec9c993ffe8ec5f33e9c\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.supercycle.com#website\",\"name\":\"Supercycle\",\"url\":\"https://docs.supercycle.com\",\"publisher\":{\"@id\":\"https://docs.supercycle.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.supercycle.com/api-reference/admin/returnorders/update-a-return#webpage\",\"url\":\"https://docs.supercycle.com/api-reference/admin/returnorders/update-a-return\",\"name\":\"Update a return\",\"description\":\"Update the status of a return and its return lines. Allows updating the overall return order status and individual return line statuses.\",\"dateModified\":\"2026-10-29T15:42:30.148Z\",\"isPartOf\":{\"@id\":\"https://docs.supercycle.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.supercycle.com/api-reference/admin/returnorders/update-a-return#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.supercycle.com/api-reference/admin/returnorders/update-a-return#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"ReturnOrders\",\"item\":\"https://docs.supercycle.com/api-reference/admin/returnorders/list-all-returns\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Update a return\",\"item\":\"https://docs.supercycle.com/api-reference/admin/returnorders/update-a-return\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.supercycle.com/api-reference/admin/returnorders/update-a-return#apireference\",\"headline\":\"Update a return\",\"name\":\"Update a return\",\"description\":\"Update the status of a return and its return lines. Allows updating the overall return order status and individual return line statuses.\",\"url\":\"https://docs.supercycle.com/api-reference/admin/returnorders/update-a-return\",\"mainEntityOfPage\":{\"@id\":\"https://docs.supercycle.com/api-reference/admin/returnorders/update-a-return#webpage\"},\"dateModified\":\"2026-10-29T15:42:30.148Z\",\"publisher\":{\"@id\":\"https://docs.supercycle.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.supercycle.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Supercycle\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Supercycle","nav":{"global":null,"dropdowns":[{"dropdown":"Documentation","icon":"book-open","description":"Set up and run circular methods","groups":[{"group":"Overview","pages":[{"title":"Supercycle docs","mode":"wide","href":"/documentation"},{"title":"Platform overview","icon":"shopify","href":"/documentation/overview/platform"},{"title":"Methods","icon":"arrows-spin","href":"/documentation/overview/methods"}]},{"group":"Setup","pages":[{"title":"Setup guide","icon":"circle-play","href":"/documentation/setup/setup-guide"},{"title":"Import products","icon":"file-import","href":"/documentation/setup/importing-products"},{"title":"Methods setup","icon":"download","href":"/documentation/setup/methods-setup"},{"title":"Theme setup","icon":"palette","href":"/documentation/setup/theme-setup"},{"title":"Admin setup","icon":"folder-gear","href":"/documentation/setup/admin-setup"}]},{"group":"Methods","pages":[{"group":"Calendar","icon":"calendar","pages":[{"title":"Calendar overview","href":"/documentation/methods/calendar/overview"},{"title":"Product setup","href":"/documentation/methods/calendar/product-setup"},{"title":"Fixed fees","href":"/documentation/methods/calendar/fixed-fees"}]},{"group":"Membership","icon":"id-card","pages":[{"title":"Membership overview","href":"/documentation/methods/membership/overview"},{"title":"Credit systems","href":"/documentation/methods/membership/credit-systems"},{"title":"Product setup","href":"/documentation/methods/membership/product-setup"},{"title":"Plans setup","href":"/documentation/methods/membership/plans-setup"}]},{"group":"Subscription","icon":"repeat","pages":[{"title":"Subscription overview","href":"/documentation/methods/subscription/overview"},{"title":"Subscription settings","href":"/documentation/methods/subscription/subscription-settings"},{"title":"Product setup","href":"/documentation/methods/subscription/product-setup"},{"title":"Add a disclaimer","href":"/documentation/methods/subscription/add-a-disclaimer"}]},{"group":"Resale","icon":"badge-dollar","pages":[{"title":"Resale overview","href":"/documentation/methods/resale/overview"},{"title":"Product setup","href":"/documentation/methods/resale/product-setup"}]}]},{"group":"Manage","pages":[{"group":"Products","icon":"tag","pages":[{"title":"Products overview","href":"/documentation/manage/products/products"},{"title":"Method options","href":"/documentation/manage/products/managing-method-options"},{"title":"Multi-market pricing","href":"/documentation/manage/products/multi-market-pricing"},{"title":"Bundles","href":"/documentation/manage/products/bundles"},{"title":"Add-ons","href":"/documentation/manage/products/add-ons"},{"title":"Product actions","href":"/documentation/manage/products/product-actions"}]},{"group":"Inventory","icon":"warehouse-full","pages":[{"title":"Items overview","href":"/documentation/manage/inventory/items"},{"title":"Item conditions","href":"/documentation/manage/inventory/item-conditions"},{"title":"Serializing items","href":"/documentation/manage/inventory/serializing-items"},{"title":"Overselling items","href":"/documentation/manage/inventory/overselling"},{"title":"Schedule","tag":"Beta","href":"/documentation/manage/inventory/schedule"},{"title":"Blocked dates","href":"/documentation/manage/inventory/blocked-dates"},{"title":"Waitlist","tag":"Beta","href":"/documentation/manage/inventory/waitlist"},{"title":"Item actions","href":"/documentation/manage/inventory/item-actions"},{"title":"Inventory troubleshooting","sidebarTitle":"Troubleshooting","href":"/documentation/manage/inventory/inventory-troubleshooting"}]},{"group":"Cycles","icon":"list-check","pages":[{"title":"Cycles overview","href":"/documentation/manage/cycles/cycles"},{"title":"Create cycle order","href":"/documentation/manage/cycles/create-cycles-order"},{"title":"Cycle fulfillment","href":"/documentation/manage/cycles/fulfil-a-rental"},{"title":"Allocation","href":"/documentation/manage/cycles/allocation"},{"title":"Edit cycles on order","href":"/documentation/manage/cycles/edit-an-order"},{"title":"Convert to purchase","href":"/documentation/manage/cycles/convert-to-purchase"},{"title":"Cycle extensions","href":"/documentation/manage/cycles/extensions"},{"title":"Cycle statuses","href":"/documentation/manage/cycles/cycle-statuses"},{"title":"Cycle actions","href":"/documentation/manage/cycles/cycle-actions"},{"title":"Cycle troubleshooting","sidebarTitle":"Troubleshooting","href":"/documentation/manage/cycles/cycle-troubleshooting"}]},{"group":"Returns","icon":"rotate-left","pages":[{"title":"Returns overview","href":"/documentation/manage/returns/returns"},{"title":"Return actions","href":"/documentation/manage/returns/return-actions"}]},{"group":"Charges","icon":"credit-card","pages":[{"title":"Charges overview","href":"/documentation/manage/charges/charges"},{"title":"Payment attempts","href":"/documentation/manage/charges/payments"},{"title":"Charge types and tax","href":"/documentation/manage/charges/charge-types"},{"title":"Charge actions","href":"/documentation/manage/charges/charge-actions"}]},{"group":"Subscriptions","icon":"repeat","pages":[{"title":"Subscription contracts","href":"/documentation/manage/subscriptions/subscription-contracts"},{"title":"Managing subscriptions","href":"/documentation/manage/subscriptions/managing-subscriptions"},{"title":"Managing memberships","href":"/documentation/manage/subscriptions/managing-memberships"},{"title":"Dunning","href":"/documentation/manage/subscriptions/dunning"},{"title":"Billing statuses","href":"/documentation/manage/subscriptions/billing-statuses"},{"title":"Shopify tags","href":"/documentation/manage/subscriptions/shopify-tags"},{"title":"Subscription actions","sidebarTitle":"Actions","href":"/documentation/manage/subscriptions/subscription-actions"},{"title":"Subscription troubleshooting","sidebarTitle":"Troubleshooting","href":"/documentation/manage/subscriptions/subscription-troubleshooting"}]},{"group":"Automation","icon":"arrow-progress","pages":[{"title":"Automation overview","href":"/documentation/manage/automation/automation"},{"title":"Create a workflow","href":"/documentation/manage/automation/create-workflow"}]},{"group":"Consignment","icon":"handshake","tag":"Beta","pages":[{"title":"Consignment overview","href":"/documentation/manage/consignment/overview"},{"title":"Consignors","href":"/documentation/manage/consignment/consignors"},{"title":"Revenue share formulas","href":"/documentation/manage/consignment/revenue-share-formulas"},{"title":"Assigning items","href":"/documentation/manage/consignment/assigning-items"},{"title":"Payouts","href":"/documentation/manage/consignment/payouts"},{"title":"Consignor customer accounts","sidebarTitle":"Customer accounts","href":"/documentation/manage/consignment/consignor-portal"},{"title":"Consignment actions","href":"/documentation/manage/consignment/consignment-actions"}]},{"group":"Analytics","icon":"chart-scatter","pages":[{"title":"Analytics overview","href":"/documentation/manage/analytics/overview"},{"title":"Analytics dashboards","href":"/documentation/manage/analytics/dashboards"},{"title":"Shopify Analytics","href":"/documentation/manage/analytics/shopify-analytics"},{"title":"Customer segments","href":"/documentation/manage/analytics/segments"}]},{"group":"Scanner","icon":"barcode-scan","pages":[{"title":"Scanner overview","href":"/documentation/manage/scanner/scanner"},{"title":"Scanner actions","href":"/documentation/manage/scanner/scanner-actions"}]}]},{"group":"Sales channels","pages":[{"group":"Online store","icon":"browser","pages":[{"title":"Customer accounts","href":"/documentation/online-store/portal"},{"title":"Availability search","tag":"Beta","href":"/documentation/online-store/search"},{"title":"Cart timer","href":"/documentation/online-store/cart-timer"},{"title":"Date picker blocked dates","sidebarTitle":"Date picker blocks","href":"/documentation/online-store/date-picker-blocks"},{"title":"Languages","href":"/documentation/online-store/languages"}]},{"group":"Point of sale","icon":"cash-register","pages":[{"title":"POS overview","href":"/documentation/point-of-sale/pos-overview"}]}]},{"group":"Configuration","pages":[{"group":"Notifications","icon":"bell","pages":[{"title":"Supercycle notifications","href":"/supercycle-notifications"},{"title":"Shopify notifications","href":"/shopify-notifications"}]},{"group":"Logistics","icon":"stopwatch","pages":[{"title":"Locations","href":"/documentation/configuration/logistics/locations"},{"title":"Logistics buffers","href":"/documentation/configuration/logistics/buffers"},{"title":"Order cutoff time","href":"/documentation/configuration/logistics/order-cutoff-time"},{"title":"Pickup in store","tag":"Beta","href":"/documentation/configuration/logistics/pickup-in-store"},{"title":"Drop-off returns","tag":"Beta","href":"/documentation/configuration/logistics/drop-off-returns"},{"title":"Opening hours","href":"/documentation/configuration/logistics/opening-hours"},{"title":"Logistics troubleshooting","sidebarTitle":"Troubleshooting","href":"/documentation/configuration/logistics/logistics-troubleshooting"}]},{"group":"Risk","icon":"shield-check","pages":[{"title":"Identity verification","href":"/documentation/configuration/risk/identity-verification"},{"title":"Card vaulting","href":"/documentation/configuration/risk/card-vaulting"},{"title":"Deposits","href":"/documentation/configuration/risk/deposits"},{"title":"E-signatures","tag":"Beta","href":"/documentation/configuration/risk/e-signatures"},{"title":"Terms and conditions","tag":"Beta","href":"/documentation/configuration/risk/terms-and-conditions"}]},{"group":"Checkout","icon":"cart-shopping","pages":[{"title":"Payment gateways","href":"/documentation/configuration/checkout/payments"},{"title":"Checkout rules","href":"/documentation/configuration/checkout/checkout-rules"},{"title":"Checkout language","href":"/documentation/configuration/checkout/checkout-language"}]},{"group":"Exceptions","icon":"calendar-days","pages":[{"title":"Exceptions","href":"/documentation/configuration/exceptions/exceptions"}]},{"group":"Custom data","icon":"folder-grid","pages":[{"title":"Custom fields","href":"/documentation/configuration/custom-data/custom-fields"},{"title":"Calculated fields","href":"/documentation/configuration/custom-data/calculated-fields"}]},{"group":"Migrations","icon":"arrow-right-to-arc","pages":[{"title":"Migrations overview","href":"/documentation/configuration/migrations/overview"},{"title":"Migrate subscriptions","href":"/documentation/configuration/migrations/subscriptions"},{"title":"Migrate from Stripe","href":"/documentation/configuration/migrations/stripe"}]},{"group":"Integrations","icon":"circle-nodes","pages":[{"title":"Patchworks integration","sidebarTitle":"Patchworks","href":"/documentation/configuration/integrations/patchworks"}]}]}]},{"dropdown":"Developers","icon":"code","description":"Theme code, app blocks, and metafields","groups":[{"group":"Introduction","pages":[{"title":"Developers","mode":"wide","href":"/developers"},{"title":"Metafields","href":"/developers/metafields"},{"group":"Line items","icon":"list","pages":[{"title":"Cycle line item property","href":"/developers/line-items/cycle-line-item-properties"},{"title":"Validations line item property","sidebarTitle":"Validations property","href":"/developers/line-items/validations-line-item-property"}]}]},{"group":"App blocks","pages":[{"title":"Methods","href":"/developers/app-blocks/methods"},{"title":"Availability search","href":"/developers/app-blocks/availability-search"},{"title":"Membership plans","href":"/developers/app-blocks/membership-plans"}]},{"group":"Code snippets","pages":[{"title":"Display method prices","href":"/developers/code-snippets/display-prices"},{"title":"Show recurring payments in the cart","sidebarTitle":"Recurring payments in cart","href":"/developers/code-snippets/show-recurring-payments"},{"title":"Link new and circular products","sidebarTitle":"New and circular products","href":"/developers/code-snippets/link-new-and-circular"},{"title":"Target method options by name","sidebarTitle":"Target options by name","href":"/developers/code-snippets/target-method-options"}]},{"group":"Guides","pages":[{"title":"Build an hourly booking widget","sidebarTitle":"Hourly booking widget","href":"/developers/guides/build-an-hourly-booking-widget"},{"title":"Rental bundles","href":"/developers/bundles"}]},{"group":"Troubleshooting","pages":[{"title":"Methods app block troubleshooting","sidebarTitle":"Troubleshooting","href":"/developers/troubleshooting/method-app-block"}]}]},{"dropdown":"API","icon":"folder-gear","description":"Admin and Storefront endpoints","anchors":[{"anchor":"Admin API","icon":"folder-gear","groups":[{"group":"Getting started","pages":[{"title":"Supercycle Admin API","mode":"wide","href":"/api-reference/admin"},{"title":"Authentication","href":"/api-reference/admin/authentication"},{"title":"Pagination","href":"/api-reference/admin/pagination"}]},{"group":"Conditions","pages":[{"title":"List all conditions","deprecated":null,"version":null,"openapi":"https://app.supercycle.com/docs/openapi-v1.yml get /conditions","href":"/api-reference/admin/conditions/list-all-conditions"}]},{"group":"Locations","pages":[{"title":"List all locations","deprecated":null,"version":null,"openapi":"https://app.supercycle.com/docs/openapi-v1.yml get /locations","href":"/api-reference/admin/locations/list-all-locations"}]},{"group":"AvailabilityTimelines","pages":[{"title":"Variant availability timeline","deprecated":null,"version":null,"openapi":"https://app.supercycle.com/docs/openapi-v1.yml get /availability_timelines","href":"/api-reference/admin/availabilitytimelines/variant-availability-timeline"}]},{"group":"BlockedDates","pages":[{"title":"List blocked dates","deprecated":null,"version":null,"openapi":"https://app.supercycle.com/docs/openapi-v1.yml get /blocked_dates","href":"/api-reference/admin/blockeddates/list-blocked-dates"},{"title":"Create a blocked date","deprecated":null,"version":null,"openapi":"https://app.supercycle.com/docs/openapi-v1.yml post /blocked_dates","href":"/api-reference/admin/blockeddates/create-a-blocked-date"},{"title":"Get a blocked date","deprecated":null,"version":null,"openapi":"https://app.supercycle.com/docs/openapi-v1.yml get /blocked_dates/{blockedDateId}","href":"/api-reference/admin/blockeddates/get-a-blocked-date"},{"title":"Delete a blocked date","deprecated":null,"version":null,"openapi":"https://app.supercycle.com/docs/openapi-v1.yml delete /blocked_dates/{blockedDateId}","href":"/api-reference/admin/blockeddates/delete-a-blocked-date"}]},{"group":"CustomFieldDefinitions","pages":[{"title":"List custom field definitions","deprecated":null,"version":null,"openapi":"https://app.supercycle.com/docs/openapi-v1.yml get /custom_field_definitions","href":"/api-reference/admin/customfielddefinitions/list-custom-field-definitions"},{"title":"Retrieve a custom field definition","deprecated":null,"version":null,"openapi":"https://app.supercycle.com/docs/openapi-v1.yml get /custom_field_definitions/{id}","href":"/api-reference/admin/customfielddefinitions/retrieve-a-custom-field-definition"}]},{"group":"CustomFields","pages":[{"title":"Create a custom field","deprecated":null,"version":null,"openapi":"https://app.supercycle.com/docs/openapi-v1.yml post /custom_fields","href":"/api-reference/admin/customfields/create-a-custom-field"},{"title":"Update a custom field","deprecated":null,"version":null,"openapi":"https://app.supercycle.com/docs/openapi-v1.yml put /custom_fields/{id}","href":"/api-reference/admin/customfields/update-a-custom-field"},{"title":"Delete a custom field","deprecated":null,"version":null,"openapi":"https://app.supercycle.com/docs/openapi-v1.yml delete /custom_fields/{id}","href":"/api-reference/admin/customfields/delete-a-custom-field"},{"title":"Start a file upload for a custom field","deprecated":null,"version":null,"openapi":"https://app.supercycle.com/docs/openapi-v1.yml post /custom_field_uploads","href":"/api-reference/admin/customfields/start-a-file-upload-for-a-custom-field"}]},{"group":"Items","pages":[{"title":"List all items","deprecated":null,"version":null,"openapi":"https://app.supercycle.com/docs/openapi-v1.yml get /items","href":"/api-reference/admin/items/list-all-items"},{"title":"Create an item","deprecated":null,"version":null,"openapi":"https://app.supercycle.com/docs/openapi-v1.yml post /items","href":"/api-reference/admin/items/create-an-item"},{"title":"Retrieve an item","deprecated":null,"version":null,"openapi":"https://app.supercycle.com/docs/openapi-v1.yml get /items/{itemId}","href":"/api-reference/admin/items/retrieve-an-item"},{"title":"Update an item","deprecated":null,"version":null,"openapi":"https://app.supercycle.com/docs/openapi-v1.yml put /items/{itemId}","href":"/api-reference/admin/items/update-an-item"},{"title":"Delete an item","deprecated":null,"version":null,"openapi":"https://app.supercycle.com/docs/openapi-v1.yml delete /items/{itemId}","href":"/api-reference/admin/items/delete-an-item"}]},{"group":"Products","pages":[{"title":"List all products","deprecated":null,"version":null,"openapi":"https://app.supercycle.com/docs/openapi-v1.yml get /products","href":"/api-reference/admin/products/list-all-products"},{"title":"Import products","deprecated":null,"version":null,"openapi":"https://app.supercycle.com/docs/openapi-v1.yml post /products","href":"/api-reference/admin/products/import-products"},{"title":"Create or update subscription method","deprecated":null,"version":null,"openapi":"https://app.supercycle.com/docs/openapi-v1.yml post /products/{productId}/subscription_method","href":"/api-reference/admin/products/create-or-update-subscription-method"},{"title":"Create subscription method option","deprecated":null,"version":null,"openapi":"https://app.supercycle.com/docs/openapi-v1.yml post /products/{productId}/subscription_method/options","href":"/api-reference/admin/products/create-subscription-method-option"},{"title":"Create or update calendar method","deprecated":null,"version":null,"openapi":"https://app.supercycle.com/docs/openapi-v1.yml post /products/{productId}/calendar_method","href":"/api-reference/admin/products/create-or-update-calendar-method"},{"title":"Create calendar method option","deprecated":null,"version":null,"openapi":"https://app.supercycle.com/docs/openapi-v1.yml post /products/{productId}/calendar_method/options","href":"/api-reference/admin/products/create-calendar-method-option"},{"title":"Create or update membership method","deprecated":null,"version":null,"openapi":"https://app.supercycle.com/docs/openapi-v1.yml post /products/{productId}/membership_method","href":"/api-reference/admin/products/create-or-update-membership-method"},{"title":"Create membership method option","deprecated":null,"version":null,"openapi":"https://app.supercycle.com/docs/openapi-v1.yml post /products/{productId}/membership_method/options","href":"/api-reference/admin/products/create-membership-method-option"},{"title":"Create or update resale method","deprecated":null,"version":null,"openapi":"https://app.supercycle.com/docs/openapi-v1.yml post /products/{productId}/resale_method","href":"/api-reference/admin/products/create-or-update-resale-method"},{"title":"Create resale method option","deprecated":null,"version":null,"openapi":"https://app.supercycle.com/docs/openapi-v1.yml post /products/{productId}/resale_method/options","href":"/api-reference/admin/products/create-resale-method-option"}]},{"group":"Cycles","pages":[{"title":"List all cycles","deprecated":null,"version":null,"openapi":"https://app.supercycle.com/docs/openapi-v1.yml get /cycles","href":"/api-reference/admin/cycles/list-all-cycles"},{"title":"Retrieve a cycle","deprecated":null,"version":null,"openapi":"https://app.supercycle.com/docs/openapi-v1.yml get /cycles/{cycleId}","href":"/api-reference/admin/cycles/retrieve-a-cycle"},{"title":"Update a cycle","deprecated":null,"version":null,"openapi":"https://app.supercycle.com/docs/openapi-v1.yml put /cycles/{cycleId}","href":"/api-reference/admin/cycles/update-a-cycle"}]},{"group":"Rentals","pages":[{"title":"List all rentals (deprecated alias of /cycles)","deprecated":true,"version":null,"openapi":"https://app.supercycle.com/docs/openapi-v1.yml get /rentals","href":"/api-reference/admin/rentals/list-all-rentals-deprecated-alias-of-cycles"},{"title":"Retrieve a rental (deprecated alias of /cycles/{cycleId})","deprecated":true,"version":null,"openapi":"https://app.supercycle.com/docs/openapi-v1.yml get /rentals/{rentalId}","href":"/api-reference/admin/rentals/retrieve-a-rental-deprecated-alias-of-cycles-"},{"title":"Update a rental (deprecated alias of /cycles/{cycleId})","deprecated":true,"version":null,"openapi":"https://app.supercycle.com/docs/openapi-v1.yml put /rentals/{rentalId}","href":"/api-reference/admin/rentals/update-a-rental-deprecated-alias-of-cycles-"},{"title":"Update a membership credit","deprecated":null,"version":null,"openapi":"https://app.supercycle.com/docs/openapi-v1.yml put /membership_credits/{membershipCreditId}","href":"/api-reference/admin/rentals/update-a-membership-credit"}]},{"group":"ReturnOrders","pages":[{"title":"List all returns","deprecated":null,"version":null,"openapi":"https://app.supercycle.com/docs/openapi-v1.yml get /return_orders","href":"/api-reference/admin/returnorders/list-all-returns"},{"title":"Create a return","deprecated":null,"version":null,"openapi":"https://app.supercycle.com/docs/openapi-v1.yml post /return_orders","href":"/api-reference/admin/returnorders/create-a-return"},{"title":"Retrieve a return","description":"View information about a return. Can include timeline events if requested.","deprecated":null,"version":null,"openapi":"https://app.supercycle.com/docs/openapi-v1.yml get /return_orders/{returnOrderId}","href":"/api-reference/admin/returnorders/retrieve-a-return"},{"title":"Update a return","deprecated":null,"version":null,"openapi":"https://app.supercycle.com/docs/openapi-v1.yml put /return_orders/{returnOrderId}","href":"/api-reference/admin/returnorders/update-a-return"}]},{"group":"TimelineComments","pages":[{"title":"Create a timeline comment","description":"Creates a new comment associated with a timeline event for a specific resource in a shop. The resource must belong to the authenticated shop.","deprecated":null,"version":null,"openapi":"https://app.supercycle.com/docs/openapi-v1.yml post /timeline_comments","href":"/api-reference/admin/timelinecomments/create-a-timeline-comment"},{"title":"Delete a timeline comment","deprecated":null,"version":null,"openapi":"https://app.supercycle.com/docs/openapi-v1.yml delete /timeline_comments/{id}","href":"/api-reference/admin/timelinecomments/delete-a-timeline-comment"}]}]},{"anchor":"Storefront API","icon":"pen-ruler","pages":[{"title":"Storefront API","href":"/api-reference/storefront"}]}]},{"dropdown":"Agent and MCP","icon":"robot","description":"Connect AI assistants to Supercycle","groups":[{"group":"Overview","pages":[{"title":"AI at Supercycle","sidebarTitle":"Overview","mode":"wide","href":"/ai"},{"title":"Our approach to AI","href":"/ai/approach"}]},{"group":"Use cases","pages":[{"group":"AI for Support","icon":"message-bot","pages":[{"title":"Overview","href":"/ai/support/overview"}]},{"group":"AI for Operations","icon":"robot","pages":[{"title":"Overview","href":"/ai/operations/overview"}]},{"group":"AI for Building","icon":"code","pages":[{"title":"Overview","href":"/ai/building/overview"},{"title":"Guidance for AI","href":"/ai/building/guidance-for-ai"}]}]},{"group":"MCPs","pages":[{"group":"Operators MCP","icon":"robot","pages":[{"title":"Operators MCP","sidebarTitle":"Overview","href":"/ai/operators-mcp/overview"},{"title":"Setup","href":"/ai/operators-mcp/setup"},{"title":"Tools","href":"/ai/operators-mcp/tools"},{"title":"Security","href":"/ai/operators-mcp/security"}]},{"group":"Builders MCP","icon":"code","pages":[{"title":"Builders MCP","sidebarTitle":"Overview","href":"/ai/builders-mcp/overview"},{"title":"Setup","href":"/ai/builders-mcp/setup"}]}]},{"group":"Shopify","pages":[{"title":"Shopify Sidekick","href":"/ai/sidekick/shopify-sidekick"}]}]},{"dropdown":"Changelogs","icon":"clock-rotate-left","description":"New features and improvements","groups":[{"group":"Releases","pages":[{"title":"Platform changelog","sidebarTitle":"Platform","icon":"layer-group","href":"/changelog/platform"},{"title":"API changelog","sidebarTitle":"API","icon":"folder-gear","href":"/changelog/api"}]}]},{"dropdown":"Style guide","hidden":true,"groups":[{"group":"Style guide","pages":[{"title":"Documentation style guide","sidebarTitle":"Overview","href":"/style-guide/index"}]},{"group":"Writing","pages":[{"title":"Voice and tone","href":"/style-guide/voice-and-tone"},{"title":"Grammar and mechanics","href":"/style-guide/grammar-and-mechanics"},{"title":"Terminology","href":"/style-guide/terminology"},{"title":"Referring to the UI","href":"/style-guide/ui-and-navigation"}]},{"group":"Building pages","pages":[{"title":"Page structure","href":"/style-guide/page-structure"},{"title":"Page types","href":"/style-guide/page-types"},{"title":"Components and snippets","href":"/style-guide/components"},{"title":"Screenshots and video","href":"/style-guide/screenshots-and-media"},{"title":"Changelog","href":"/style-guide/changelog"}]},{"group":"Renders","pages":[{"title":"Creating renders","sidebarTitle":"Overview","href":"/style-guide/renders/overview"},{"title":"Storefront renders","href":"/style-guide/renders/storefront"},{"title":"Shopify POS renders","href":"/style-guide/renders/pos"},{"title":"Supercycle admin renders","href":"/style-guide/renders/admin"},{"title":"Customer accounts renders","href":"/style-guide/renders/customer-accounts"},{"title":"Render audit","sidebarTitle":"Audit","href":"/style-guide/renders/audit"}]}]}]},"basePath":"","title":"Update a return - Supercycle","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}