This finalizes the return and initiates any necessary workflows.
Once submitted, the draft_return.return_id is populated and the state moves to
submitted.
If no return policy covers the address on the draft return, the response is a 422
with errors[0].code set to returns-unavailable-for-order. The draft return stays
open. Do not retry the submit; ask the shopper for a different address or stop the return.
If the cart still has Shop Now items while a credit item’s excluded outcomes (as returned on its
line item) include Shop Now, the response is a 422 with the message “Shop Now is not available
for the items in this return. Remove the new items to continue.” Remove those cart
items and submit again. In-store (point of sale) returns are unaffected.
The draft return is ready to submit when the submit-draft-return link (HAL-Forms: the
submit-draft-return template) is present. Use it as the single readiness signal rather
than working it out from other actions: Loop only offers it once every required step is
complete.
POST
/
draft-returns
/
{draft_return_id}
/
submit
Submit Draft Return
curl --request POST \ --url https://api.loopreturns.com/api/2026-10/draft-returns/{draft_return_id}/submit \ --header 'X-Authorization: <api-key>'
Optional. Responses use Content-Type: application/prs.hal-forms+json. Ignored on 2026-10
and later. On earlier versions, send it to receive HAL-Forms, and it is required for
GET /draft-returns (List).
The shopper's locale: a two-letter language code with an optional two-letter region,
for example fr or fr-CA.
When the value is valid and product translations are enabled for the shop, the response includes translated
product text in the operation's translated fields. Otherwise those fields are not populated.
Shopper-portal only. The shopper_token from a shopper-portal draft response.
Required on shopper-portal requests that include a draft return id.
A missing, empty, or non-matching value returns 404.
Merchant public API requests ignore this header.
The response uses Content-Type: application/prs.hal-forms+json and includes hypermedia
controls in _links and _templates instead of the standard links array.
_templates object. Each key is a template/action name matching a
relation in _links. Templates describe the method, fields, and constraints
for the action.
Shopper-portal only. Present on shopper-portal draft responses.
Send this value as X-Loop-Shopper-Token on later shopper-portal requests
that include a draft return id.
Merchant public API responses omit this field.
An array of error codes. In the event of a partial failure, the API will return
all possible data as well as any error codes that were thrown.
See Error codes for
a full list of possible errors.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Loop Returns Documentation","colors":{"primary":"#0672FF","light":"#FFFCF7","dark":"#000000"},"logo":{"light":"https://mintcdn.com/loopreturns/mWP1nZGNp75FiB-l/logo/loop-logo-lapis-charcoal.svg?fit=max\u0026auto=format\u0026n=mWP1nZGNp75FiB-l\u0026q=85\u0026s=5113cc3f8f2d70a65c2c774e471a13c4","dark":"https://mintcdn.com/loopreturns/mWP1nZGNp75FiB-l/logo/loop-logo-lapis-newsprint.svg?fit=max\u0026auto=format\u0026n=mWP1nZGNp75FiB-l\u0026q=85\u0026s=c2197689146b468c5df1b8581f091743"},"favicon":"https://mintcdn.com/loopreturns/mWP1nZGNp75FiB-l/favicon.svg?fit=max\u0026auto=format\u0026n=mWP1nZGNp75FiB-l\u0026q=85\u0026s=93b43e224efe823b43c6d1b9c45799f9","navbar":{"links":[{"href":"https://help.loopreturns.com","label":"Support"}],"primary":{"type":"button","label":"Request Demo","href":"https://www.loopreturns.com/book-a-demo-today/"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/loop-returns","instagram":"https://www.instagram.com/loopreturns"}},"fonts":{"heading":{"family":"ABC Ginto","weight":900,"source":"fonts/ABCGinto-Black.woff2","format":"woff2"},"body":{"family":"Matter","weight":400,"source":"fonts/Matter-Regular.woff2","format":"woff2"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"System Status","icon":"radar","href":"https://status.loopreturns.com"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"loopreturns","hasAudioNarration":false,"actualSubdomain":"loopreturns","customDomains":["docs.loopreturns.com"],"gitSource":{"type":"gitlab","owner":"loopreturns/documentation","repo":"public-api-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"projectId":67355043,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adfbc999942d6d486f9a4bb","collectionId":"51e14b64-29f6-4eba-ab27-2f63361e4060","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adfbc999942d6d486f9a4bb"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae390ef8616a449c23c7ec5","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"default","tag":"API Reference","count":172},{"language":"default","tag":"APIs","count":164},{"language":"default","tag":"Commerce Data","count":68},{"language":"default","tag":"Return Create (HAL-Forms)","count":30},{"language":"default","tag":"Guides","count":30},{"language":"default","tag":"Return Create","count":22},{"language":"default","tag":"Products","count":17},{"language":"default","tag":"Webhook Reference","count":13},{"language":"default","tag":"Collections","count":12},{"language":"default","tag":"Orders","count":11}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/2026-10/draft-returns/submit-draft-return","slug":"/api-reference/2026-10/draft-returns/submit-draft-return","pageMetadata":{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/submit","title":"Submit Draft Return","description":"Submits the draft return.\n\nThis finalizes the return and initiates any necessary workflows.\nOnce submitted, the `draft_return.return_id` is populated and the state moves to\n`submitted`.\n\nIf no return policy covers the address on the draft return, the response is a `422`\nwith `errors[0].code` set to `returns-unavailable-for-order`. The draft return stays\nopen. Do not retry the submit; ask the shopper for a different address or stop the return.\n\nIf the cart still has Shop Now items while a credit item's excluded outcomes (as returned on its\nline item) include Shop Now, the response is a `422` with the message \"Shop Now is not available\nfor the items in this return. Remove the new items to continue.\" Remove those cart\nitems and submit again. In-store (point of sale) returns are unaffected.\n\nThe draft return is ready to submit when the `submit-draft-return` link (HAL-Forms: the\n`submit-draft-return` template) is present. Use it as the single readiness signal rather\nthan working it out from other actions: Loop only offers it once every required step is\ncomplete.\n","href":"/api-reference/2026-10/draft-returns/submit-draft-return"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Submits the draft return.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"This finalizes the return and initiates any necessary workflows.\\nOnce submitted, the \", _jsx(_components.code, {\n children: \"draft_return.return_id\"\n }), \" is populated and the state moves to\\n\", _jsx(_components.code, {\n children: \"submitted\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"If no return policy covers the address on the draft return, the response is a \", _jsx(_components.code, {\n children: \"422\"\n }), \"\\nwith \", _jsx(_components.code, {\n children: \"errors[0].code\"\n }), \" set to \", _jsx(_components.code, {\n children: \"returns-unavailable-for-order\"\n }), \". The draft return stays\\nopen. Do not retry the submit; ask the shopper for a different address or stop the return.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"If the cart still has Shop Now items while a credit item’s excluded outcomes (as returned on its\\nline item) include Shop Now, the response is a \", _jsx(_components.code, {\n children: \"422\"\n }), \" with the message “Shop Now is not available\\nfor the items in this return. Remove the new items to continue.” Remove those cart\\nitems and submit again. In-store (point of sale) returns are unaffected.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"The draft return is ready to submit when the \", _jsx(_components.code, {\n children: \"submit-draft-return\"\n }), \" link (HAL-Forms: the\\n\", _jsx(_components.code, {\n children: \"submit-draft-return\"\n }), \" template) is present. Use it as the single readiness signal rather\\nthan working it out from other actions: Loop only offers it once every required step is\\ncomplete.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/submit","title":"Submit Draft Return","description":"Submits the draft return.\n\nThis finalizes the return and initiates any necessary workflows.\nOnce submitted, the `draft_return.return_id` is populated and the state moves to\n`submitted`.\n\nIf no return policy covers the address on the draft return, the response is a `422`\nwith `errors[0].code` set to `returns-unavailable-for-order`. The draft return stays\nopen. Do not retry the submit; ask the shopper for a different address or stop the return.\n\nIf the cart still has Shop Now items while a credit item's excluded outcomes (as returned on its\nline item) include Shop Now, the response is a `422` with the message \"Shop Now is not available\nfor the items in this return. Remove the new items to continue.\" Remove those cart\nitems and submit again. In-store (point of sale) returns are unaffected.\n\nThe draft return is ready to submit when the `submit-draft-return` link (HAL-Forms: the\n`submit-draft-return` template) is present. Use it as the single readiness signal rather\nthan working it out from other actions: Loop only offers it once every required step is\ncomplete.\n","href":"/api-reference/2026-10/draft-returns/submit-draft-return"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/loopreturns/d7dc6883aeaefe8b/scripts/generate-unstable-nav.js","/_mintlify/custom/loopreturns/eb155f0b6d2849a4/scripts/update-openapi-servers.js"],"openApiReferenceData":{"operation":{"summary":"Submit Draft Return","operationId":"submitDraftReturnHalForms","description":"Submits the draft return.\n\nThis finalizes the return and initiates any necessary workflows.\nOnce submitted, the `draft_return.return_id` is populated and the state moves to\n`submitted`.\n\nIf no return policy covers the address on the draft return, the response is a `422`\nwith `errors[0].code` set to `returns-unavailable-for-order`. The draft return stays\nopen. Do not retry the submit; ask the shopper for a different address or stop the return.\n\nIf the cart still has Shop Now items while a credit item's excluded outcomes (as returned on its\nline item) include Shop Now, the response is a `422` with the message \"Shop Now is not available\nfor the items in this return. Remove the new items to continue.\" Remove those cart\nitems and submit again. In-store (point of sale) returns are unaffected.\n\nThe draft return is ready to submit when the `submit-draft-return` link (HAL-Forms: the\n`submit-draft-return` template) is present. Use it as the single readiness signal rather\nthan working it out from other actions: Loop only offers it once every required step is\ncomplete.\n","security":["38107355-44af-46c9-ada8-db21ec0edcd5"],"parameters":["2f43a594-8d20-4e99-825e-655ff8b4d328","2ad895a6-5967-4d7c-ac82-6a02284b2910","052b4ec4-7849-4184-80aa-1323bd892dbe","abd8fb1a-b6d6-4d01-9b44-5d649ea38fd8","675aca9b-61a9-4c45-9317-0c6d007defc2"],"responses":{"200":"f774c0e8-3ef8-4e92-9f89-eadc83e34f61","401":"5513cf49-c95b-4036-ba09-4c5b82714744","404":"b6c55b3b-8e90-43b1-a4dd-8780d38c9c59","422":"17f21fdc-509d-444d-a5de-c542e8b5f58a"},"method":"post","type":"path","servers":["ca00b6b6-cefa-4f39-8b14-4184882c78c6","15ac1724-d46b-4583-8905-2b86690297c1"],"path":"/draft-returns/{draft_return_id}/submit","baseUrlOptions":["https://api.loopreturns.com/api/2026-10","https://api.loopreturns.com/api/unstable"],"title":"Submit Draft Return","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"2f43a594-8d20-4e99-825e-655ff8b4d328":{"name":"draft_return_id","in":"path","description":"The unique identifier of the draft return.","required":true,"schema":{"type":"integer","isRequired":true,"description":"The unique identifier of the draft return.","uniqueKey":"","typeLabel":"integer"}},"2ad895a6-5967-4d7c-ac82-6a02284b2910":{"name":"X-Shop-Id","in":"header","description":"The unique identifier of the shop associated with the draft return.\n\nThis header is not required, as the merchant's shop is identified by the API key present in the request.\n","schema":{"type":"integer","description":"The unique identifier of the shop associated with the draft return.\n\nThis header is not required, as the merchant's shop is identified by the API key present in the request.\n","uniqueKey":"","typeLabel":"integer"}},"052b4ec4-7849-4184-80aa-1323bd892dbe":{"name":"Accept","in":"header","required":false,"description":"Optional. Responses use `Content-Type: application/prs.hal-forms+json`. Ignored on `2026-10`\nand later. On earlier versions, send it to receive HAL-Forms, and it is required for\n`GET /draft-returns` (List).\n","schema":{"type":"string","enum":["application/prs.hal-forms+json"],"isRequired":false,"description":"Optional. Responses use `Content-Type: application/prs.hal-forms+json`. Ignored on `2026-10`\nand later. On earlier versions, send it to receive HAL-Forms, and it is required for\n`GET /draft-returns` (List).\n","uniqueKey":"","typeLabel":"enum\u003cstring>"}},"abd8fb1a-b6d6-4d01-9b44-5d649ea38fd8":{"name":"X-Loop-Locale","in":"header","required":false,"description":"The shopper's locale: a two-letter language code with an optional two-letter region,\nfor example `fr` or `fr-CA`.\n\nWhen the value is valid and product translations are enabled for the shop, the response includes translated\nproduct text in the operation's translated fields. Otherwise those fields are not populated.\n","schema":{"type":"string","example":"fr-CA","isRequired":false,"description":"The shopper's locale: a two-letter language code with an optional two-letter region,\nfor example `fr` or `fr-CA`.\n\nWhen the value is valid and product translations are enabled for the shop, the response includes translated\nproduct text in the operation's translated fields. Otherwise those fields are not populated.\n","uniqueKey":"","typeLabel":"string"}},"675aca9b-61a9-4c45-9317-0c6d007defc2":{"name":"X-Loop-Shopper-Token","in":"header","required":false,"description":"Shopper-portal only. The `shopper_token` from a shopper-portal draft response.\nRequired on shopper-portal requests that include a draft return id.\nA missing, empty, or non-matching value returns `404`.\nMerchant public API requests ignore this header.\n","schema":{"type":"string","isRequired":false,"description":"Shopper-portal only. The `shopper_token` from a shopper-portal draft response.\nRequired on shopper-portal requests that include a draft return id.\nA missing, empty, or non-matching value returns `404`.\nMerchant public API requests ignore this header.\n","uniqueKey":"","typeLabel":"string"}}},"responses":{"f774c0e8-3ef8-4e92-9f89-eadc83e34f61":{"description":"Successful response with draft return data.\n\nThe response uses `Content-Type: application/prs.hal-forms+json` and includes hypermedia\ncontrols in `_links` and `_templates` instead of the standard `links` array.\n","content":{"application/prs.hal-forms+json":{"schema":{"type":"object","properties":{"_links":{"type":"object","description":"HAL `_links` object. Always includes `self`. Other keys are relation names\ncorresponding to available actions for the current draft return state.\n","properties":{"self":{"type":"object","properties":{"href":{"type":"string","description":"The fully-qualified URL for this link relation.","isRequired":true,"uniqueKey":"_links.self.href","typeLabel":"string"}},"required":["href"],"uniqueKey":"_links.self","typeLabel":"object"}},"additionalProperties":{"type":"object","properties":{"href":{"type":"string","description":"The fully-qualified URL for this link relation.","isRequired":true,"uniqueKey":"_links.additionalProperties.href","typeLabel":"string"}},"required":["href"],"uniqueKey":"_links.additionalProperties","typeLabel":"object"},"uniqueKey":"_links","typeLabel":"object"},"_templates":{"type":"object","description":"`_templates` object. Each key is a template/action name matching a\nrelation in `_links`. Templates describe the method, fields, and constraints\nfor the action.\n","additionalProperties":{"type":"object","properties":{"method":{"type":"string","description":"The HTTP method for this action (POST, DELETE, etc.).","uniqueKey":"_templates.additionalProperties.method","typeLabel":"string"},"title":{"type":"string","description":"Human-readable title/description of the action.","uniqueKey":"_templates.additionalProperties.title","typeLabel":"string"},"contentType":{"type":"string","description":"The content type of the request body.","default":"application/json","uniqueKey":"_templates.additionalProperties.contentType","typeLabel":"string"},"required":{"type":"boolean","description":"`true` when this action must be completed before the draft return can progress.\nFor `select-return-method-carrier`, it is `true` while a label format still has to\nbe picked and `false` once one is selected.\n\nThis flag belongs to the template. It is separate from `required` on each entry in\n`properties`, which only says whether that field must be sent in the request body.\n","uniqueKey":"_templates.additionalProperties.required","typeLabel":"boolean"},"properties":{"type":"array","description":"Property descriptors for the action's fields.","items":{"type":"object","properties":{"name":{"type":"string","description":"The property name (snake_case).","uniqueKey":"_templates.additionalProperties.properties.items.[INDEX].name","typeLabel":"string"},"type":{"type":"string","description":"The property type. Common types: `number`, `text`, `boolean`, `hidden`.\n","uniqueKey":"_templates.additionalProperties.properties.items.[INDEX].type","typeLabel":"string"},"required":{"type":"boolean","description":"Whether this property is required.","uniqueKey":"_templates.additionalProperties.properties.items.[INDEX].required","typeLabel":"boolean"},"prompt":{"type":"string","description":"Human-readable prompt/description of the property.","uniqueKey":"_templates.additionalProperties.properties.items.[INDEX].prompt","typeLabel":"string"},"options":{"type":"object","description":"For enum-like fields, an object with `inline` containing the list of valid values.\nSend only a value from this list.\n","properties":{"inline":{"type":"array","description":"Each item is either a value string or an object with `prompt` and `value`.\nWhen it is an object, send its `value`.\n","items":{"oneOf":[{"type":"string","uniqueKey":"_templates.additionalProperties.properties.items.[INDEX].options.inline.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"object","properties":{"prompt":{"type":"string","description":"Human-readable label for the value.","uniqueKey":"_templates.additionalProperties.properties.items.[INDEX].options.inline.items.[INDEX].oneOf.1.prompt","typeLabel":"string"},"value":{"type":"string","description":"The value to send in the request body.","uniqueKey":"_templates.additionalProperties.properties.items.[INDEX].options.inline.items.[INDEX].oneOf.1.value","typeLabel":"string"}},"uniqueKey":"_templates.additionalProperties.properties.items.[INDEX].options.inline.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"_templates.additionalProperties.properties.items.[INDEX].options.inline.items.[INDEX]","typeLabel":"string | object"},"uniqueKey":"_templates.additionalProperties.properties.items.[INDEX].options.inline","typeLabel":"(string | object)[]"}},"uniqueKey":"_templates.additionalProperties.properties.items.[INDEX].options","typeLabel":"object"}},"uniqueKey":"_templates.additionalProperties.properties.items.[INDEX]","typeLabel":"object"},"uniqueKey":"_templates.additionalProperties.properties","typeLabel":"object[]"},"systemMessage":{"type":"string","description":"Only on an unanswered yes/no `add-returning-item-user-input` template. The merchant's\n\"Response if yes\" message in the draft return's language. When that language has no\ntranslation, it is the merchant's first configured message. It may contain HTML.\nOmitted when the merchant has not turned the response on or has no message.\n\nShow this message when the shopper answers `Yes`. If that answer removes the item\nfrom the draft return, the next response no longer has the item or its answered\ninput, so keep this value from the template before you submit the answer.\n","example":"\u003cp>Used cartridges cannot be returned.\u003c/p>","uniqueKey":"_templates.additionalProperties.systemMessage","typeLabel":"string"}},"uniqueKey":"_templates.additionalProperties","typeLabel":"object"},"uniqueKey":"_templates","typeLabel":"object"},"client_application":{"type":"object","description":"Client-application header specification. Describes how the client should\nidentify itself in subsequent requests.\n","uniqueKey":"client_application","typeLabel":"object"},"shopper_token":{"type":"string","description":"Shopper-portal only. Present on shopper-portal draft responses.\nSend this value as `X-Loop-Shopper-Token` on later shopper-portal requests\nthat include a draft return id.\nMerchant public API responses omit this field.\n","uniqueKey":"shopper_token","typeLabel":"string"},"draft_return":{"type":"object","description":"The draft return object.","properties":{"id":{"type":"integer","description":"The unique identifier of the draft return.","example":12345,"uniqueKey":"draft_return.id","typeLabel":"integer"},"return_id":{"oneOf":[{"type":"integer","description":"The unique identifier of the return, if the draft return has been submitted.","example":67890,"uniqueKey":"draft_return.return_id.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The unique identifier of the return, if the draft return has been submitted.","example":67890,"uniqueKey":"draft_return.return_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"draft_return.return_id","typeLabel":"integer | null"},"state":{"type":"string","description":"The current state of the draft return.","enum":["created","items-finalized","submitted","cancelled","expired"],"uniqueKey":"draft_return.state","typeLabel":"enum\u003cstring>"},"currency":{"type":"string","description":"The three-character ISO 4217 currency code.","examples":["USD","EUR"],"uniqueKey":"draft_return.currency","typeLabel":"string"},"language":{"type":"string","description":"The language code for the draft return.","example":"en","uniqueKey":"draft_return.language","typeLabel":"string"},"credit_type":{"oneOf":[{"type":"string","description":"The type of credit for the return.","enum":["refund","gift","exchange",null],"example":null,"uniqueKey":"draft_return.credit_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The type of credit for the return.","enum":["refund","gift","exchange",null],"example":null,"uniqueKey":"draft_return.credit_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"draft_return.credit_type","typeLabel":"enum\u003cstring> | null"},"processing_type":{"type":"string","description":"How the return should be processed. Every draft return starts as `regular`. Change it\nwith the `set-processing-type` template. `_embedded.processing_type_options` shows\nwhich values are available.\n\nWhile the draft is in `items-finalized`, Loop checks on every request whether Instant\nis still available. If it is not, Loop sets `processing_type` to `regular` and removes\nthe payment intent, so `payment_intent` is `null`. Check `processing_type` and\n`payment_intent` again before you submit.\n","enum":["regular","instant"],"example":"regular","uniqueKey":"draft_return.processing_type","typeLabel":"enum\u003cstring>"},"customer":{"type":"object","description":"The customer information associated with the draft return.","properties":{"email":{"type":"string","format":"email","description":"The email address of the customer.","example":"someone@test.com","uniqueKey":"draft_return.customer.email","typeLabel":"string\u003cemail>"}},"uniqueKey":"draft_return.customer","typeLabel":"object"},"shipping_address":{"type":"object","description":"The shipping address for the return.","properties":{"name":{"type":"string","example":"Jane Doe","uniqueKey":"draft_return.shipping_address.name","typeLabel":"string"},"company":{"oneOf":[{"type":"string","example":null,"uniqueKey":"draft_return.shipping_address.company.oneOf.0","typeLabel":"string"},{"type":"null","example":null,"uniqueKey":"draft_return.shipping_address.company.oneOf.1","typeLabel":"null"}],"uniqueKey":"draft_return.shipping_address.company","typeLabel":"string | null"},"address1":{"type":"string","example":"123 Main St","uniqueKey":"draft_return.shipping_address.address1","typeLabel":"string"},"address2":{"oneOf":[{"type":"string","example":"Apt 4","uniqueKey":"draft_return.shipping_address.address2.oneOf.0","typeLabel":"string"},{"type":"null","example":"Apt 4","uniqueKey":"draft_return.shipping_address.address2.oneOf.1","typeLabel":"null"}],"uniqueKey":"draft_return.shipping_address.address2","typeLabel":"string | null"},"city":{"type":"string","example":"Chicago","uniqueKey":"draft_return.shipping_address.city","typeLabel":"string"},"state":{"type":"string","example":"Illinois","uniqueKey":"draft_return.shipping_address.state","typeLabel":"string"},"zip":{"type":"string","example":"60622","uniqueKey":"draft_return.shipping_address.zip","typeLabel":"string"},"country":{"type":"string","example":"United States","uniqueKey":"draft_return.shipping_address.country","typeLabel":"string"},"country_code":{"type":"string","example":"US","uniqueKey":"draft_return.shipping_address.country_code","typeLabel":"string"},"phone":{"oneOf":[{"type":"string","example":"555-555-5555","uniqueKey":"draft_return.shipping_address.phone.oneOf.0","typeLabel":"string"},{"type":"null","example":"555-555-5555","uniqueKey":"draft_return.shipping_address.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"draft_return.shipping_address.phone","typeLabel":"string | null"}},"uniqueKey":"draft_return.shipping_address","typeLabel":"object"},"returning_items":{"type":"array","description":"The items being returned.","items":{"type":"object","properties":{"id":{"type":"integer","description":"The unique identifier of this returning item within the draft return.","example":1,"uniqueKey":"draft_return.returning_items.items.[INDEX].id","typeLabel":"integer"},"order_line_item_id":{"type":"integer","description":"The unique identifier created by Loop of the order line item being returned.","example":12346,"uniqueKey":"draft_return.returning_items.items.[INDEX].order_line_item_id","typeLabel":"integer"},"return_type":{"oneOf":[{"type":"string","enum":["credit","exchange",null],"example":"credit","uniqueKey":"draft_return.returning_items.items.[INDEX].return_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["credit","exchange",null],"example":"credit","uniqueKey":"draft_return.returning_items.items.[INDEX].return_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"draft_return.returning_items.items.[INDEX].return_type","typeLabel":"enum\u003cstring> | null"},"resolution":{"oneOf":[{"type":"string","enum":["return","keep","donate","reject","exchange",null],"example":"return","uniqueKey":"draft_return.returning_items.items.[INDEX].resolution.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["return","keep","donate","reject","exchange",null],"example":"return","uniqueKey":"draft_return.returning_items.items.[INDEX].resolution.oneOf.1","typeLabel":"null"}],"uniqueKey":"draft_return.returning_items.items.[INDEX].resolution","typeLabel":"enum\u003cstring> | null"},"return_reason":{"oneOf":[{"type":"object","properties":{"name":{"type":"string","example":"Item didn't fit","uniqueKey":"draft_return.returning_items.items.[INDEX].return_reason.oneOf.0.name","typeLabel":"string"},"comment":{"oneOf":[{"type":"string","example":null,"uniqueKey":"draft_return.returning_items.items.[INDEX].return_reason.oneOf.0.comment.oneOf.0","typeLabel":"string"},{"type":"null","example":null,"uniqueKey":"draft_return.returning_items.items.[INDEX].return_reason.oneOf.0.comment.oneOf.1","typeLabel":"null"}],"uniqueKey":"draft_return.returning_items.items.[INDEX].return_reason.oneOf.0.comment","typeLabel":"string | null"}},"uniqueKey":"draft_return.returning_items.items.[INDEX].return_reason.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"name":{"type":"string","example":"Item didn't fit"},"comment":{"oneOf":[{"type":"string","example":null},{"type":"null","example":null}]}},"uniqueKey":"draft_return.returning_items.items.[INDEX].return_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"draft_return.returning_items.items.[INDEX].return_reason","typeLabel":"object | null"},"user_inputs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":1,"uniqueKey":"draft_return.returning_items.items.[INDEX].user_inputs.items.[INDEX].id","typeLabel":"integer"},"type":{"type":"string","example":"yes-no","uniqueKey":"draft_return.returning_items.items.[INDEX].user_inputs.items.[INDEX].type","typeLabel":"string"},"prompt":{"type":"string","description":"The merchant's question as HTML.","example":"\u003cp>Is the item still in its original packaging?\u003c/p>","uniqueKey":"draft_return.returning_items.items.[INDEX].user_inputs.items.[INDEX].prompt","typeLabel":"string"},"value":{"oneOf":[{"type":"string","example":true,"uniqueKey":"draft_return.returning_items.items.[INDEX].user_inputs.items.[INDEX].value.oneOf.0","typeLabel":"string"},{"type":"boolean","example":true,"uniqueKey":"draft_return.returning_items.items.[INDEX].user_inputs.items.[INDEX].value.oneOf.1","typeLabel":"boolean"},{"type":"null","example":true,"uniqueKey":"draft_return.returning_items.items.[INDEX].user_inputs.items.[INDEX].value.oneOf.2","typeLabel":"null"}],"uniqueKey":"draft_return.returning_items.items.[INDEX].user_inputs.items.[INDEX].value","typeLabel":"string | boolean | null"}},"uniqueKey":"draft_return.returning_items.items.[INDEX].user_inputs.items.[INDEX]","typeLabel":"object"},"uniqueKey":"draft_return.returning_items.items.[INDEX].user_inputs","typeLabel":"object[]"},"image_uploads":{"type":"array","items":{"type":"string","example":"https://cdn.example.com/return-images/abc123.jpg","uniqueKey":"draft_return.returning_items.items.[INDEX].image_uploads.items.[INDEX]","typeLabel":"string"},"uniqueKey":"draft_return.returning_items.items.[INDEX].image_uploads","typeLabel":"string[]"}},"uniqueKey":"draft_return.returning_items.items.[INDEX]","typeLabel":"object"},"uniqueKey":"draft_return.returning_items","typeLabel":"object[]"},"cart_items":{"type":"array","description":"The items in the cart (exchange items or shop-now items).","items":{"type":"object","properties":{"id":{"type":"integer","example":201,"uniqueKey":"draft_return.cart_items.items.[INDEX].id","typeLabel":"integer"},"variant_id":{"type":"integer","example":501,"uniqueKey":"draft_return.cart_items.items.[INDEX].variant_id","typeLabel":"integer"},"product_id":{"oneOf":[{"type":"integer","example":100,"uniqueKey":"draft_return.cart_items.items.[INDEX].product_id.oneOf.0","typeLabel":"integer"},{"type":"null","example":100,"uniqueKey":"draft_return.cart_items.items.[INDEX].product_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"draft_return.cart_items.items.[INDEX].product_id","typeLabel":"integer | null"},"sku":{"oneOf":[{"type":"string","example":"SHIRT-RED-S","uniqueKey":"draft_return.cart_items.items.[INDEX].sku.oneOf.0","typeLabel":"string"},{"type":"null","example":"SHIRT-RED-S","uniqueKey":"draft_return.cart_items.items.[INDEX].sku.oneOf.1","typeLabel":"null"}],"uniqueKey":"draft_return.cart_items.items.[INDEX].sku","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","example":"Red Shirt","uniqueKey":"draft_return.cart_items.items.[INDEX].title.oneOf.0","typeLabel":"string"},{"type":"null","example":"Red Shirt","uniqueKey":"draft_return.cart_items.items.[INDEX].title.oneOf.1","typeLabel":"null"}],"uniqueKey":"draft_return.cart_items.items.[INDEX].title","typeLabel":"string | null"},"variant_title":{"oneOf":[{"type":"string","example":"Small","uniqueKey":"draft_return.cart_items.items.[INDEX].variant_title.oneOf.0","typeLabel":"string"},{"type":"null","example":"Small","uniqueKey":"draft_return.cart_items.items.[INDEX].variant_title.oneOf.1","typeLabel":"null"}],"uniqueKey":"draft_return.cart_items.items.[INDEX].variant_title","typeLabel":"string | null"},"translated_title":{"oneOf":[{"type":"string","description":"The product title in the shopper's locale, set when the item is added.\n`null` when no locale was sent, product translations are not enabled for the shop,\nor no translation exists.\n","example":"Chemise rouge","uniqueKey":"draft_return.cart_items.items.[INDEX].translated_title.oneOf.0","typeLabel":"string"},{"type":"null","description":"The product title in the shopper's locale, set when the item is added.\n`null` when no locale was sent, product translations are not enabled for the shop,\nor no translation exists.\n","example":"Chemise rouge","uniqueKey":"draft_return.cart_items.items.[INDEX].translated_title.oneOf.1","typeLabel":"null"}],"uniqueKey":"draft_return.cart_items.items.[INDEX].translated_title","typeLabel":"string | null"},"translated_variant_title":{"oneOf":[{"type":"string","description":"The variant title in the shopper's locale, set when the item is added.\n`null` under the same conditions as `translated_title`.\n","example":"Petit","uniqueKey":"draft_return.cart_items.items.[INDEX].translated_variant_title.oneOf.0","typeLabel":"string"},{"type":"null","description":"The variant title in the shopper's locale, set when the item is added.\n`null` under the same conditions as `translated_title`.\n","example":"Petit","uniqueKey":"draft_return.cart_items.items.[INDEX].translated_variant_title.oneOf.1","typeLabel":"null"}],"uniqueKey":"draft_return.cart_items.items.[INDEX].translated_variant_title","typeLabel":"string | null"},"price":{"oneOf":[{"type":"integer","description":"The price in minor units (e.g. cents).","example":2500,"uniqueKey":"draft_return.cart_items.items.[INDEX].price.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The price in minor units (e.g. cents).","example":2500,"uniqueKey":"draft_return.cart_items.items.[INDEX].price.oneOf.1","typeLabel":"null"}],"uniqueKey":"draft_return.cart_items.items.[INDEX].price","typeLabel":"integer | null"},"image":{"oneOf":[{"type":"string","example":"https://cdn.example.com/products/red-shirt.jpg","uniqueKey":"draft_return.cart_items.items.[INDEX].image.oneOf.0","typeLabel":"string"},{"type":"null","example":"https://cdn.example.com/products/red-shirt.jpg","uniqueKey":"draft_return.cart_items.items.[INDEX].image.oneOf.1","typeLabel":"null"}],"uniqueKey":"draft_return.cart_items.items.[INDEX].image","typeLabel":"string | null"},"exchange_type":{"oneOf":[{"type":"string","enum":["storefront","pos-storefront","variant-storefront","advanced-storefront","advanced","exchange","pos-exchange","recommended","recommended-storefront",null],"example":"exchange","uniqueKey":"draft_return.cart_items.items.[INDEX].exchange_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["storefront","pos-storefront","variant-storefront","advanced-storefront","advanced","exchange","pos-exchange","recommended","recommended-storefront",null],"example":"exchange","uniqueKey":"draft_return.cart_items.items.[INDEX].exchange_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"draft_return.cart_items.items.[INDEX].exchange_type","typeLabel":"enum\u003cstring> | null"},"exchange_for_returning_item_id":{"oneOf":[{"type":"integer","example":1,"uniqueKey":"draft_return.cart_items.items.[INDEX].exchange_for_returning_item_id.oneOf.0","typeLabel":"integer"},{"type":"null","example":1,"uniqueKey":"draft_return.cart_items.items.[INDEX].exchange_for_returning_item_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"draft_return.cart_items.items.[INDEX].exchange_for_returning_item_id","typeLabel":"integer | null"}},"uniqueKey":"draft_return.cart_items.items.[INDEX]","typeLabel":"object"},"uniqueKey":"draft_return.cart_items","typeLabel":"object[]"},"selected_return_method":{"oneOf":[{"type":"object","description":"The selected return shipping method.","properties":{"id":{"type":"integer","uniqueKey":"draft_return.selected_return_method.oneOf.0.id","typeLabel":"integer"},"name":{"type":"string","uniqueKey":"draft_return.selected_return_method.oneOf.0.name","typeLabel":"string"},"type":{"type":"string","enum":["box-and-ship","carrier-choice","drop-off","pick-up","in-store"],"uniqueKey":"draft_return.selected_return_method.oneOf.0.type","typeLabel":"enum\u003cstring>"},"title":{"type":"string","uniqueKey":"draft_return.selected_return_method.oneOf.0.title","typeLabel":"string"},"logo_url":{"type":"string","uniqueKey":"draft_return.selected_return_method.oneOf.0.logo_url","typeLabel":"string"},"location_url":{"type":"string","uniqueKey":"draft_return.selected_return_method.oneOf.0.location_url","typeLabel":"string"}},"uniqueKey":"draft_return.selected_return_method.oneOf.0","typeLabel":"object"},{"type":"null","description":"The selected return shipping method.","properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"type":"string","enum":["box-and-ship","carrier-choice","drop-off","pick-up","in-store"]},"title":{"type":"string"},"logo_url":{"type":"string"},"location_url":{"type":"string"}},"uniqueKey":"draft_return.selected_return_method.oneOf.1","typeLabel":"null"}],"uniqueKey":"draft_return.selected_return_method","typeLabel":"object | null"},"payment_intent":{"oneOf":[{"type":"object","description":"The payment intent attached to the draft return, if any.\n\nLoop removes it, and this field becomes `null`, when you set `processing_type` to\n`regular` or when Loop resets Instant to `regular` because Instant is no longer\navailable.\n","properties":{"id":{"type":"integer","uniqueKey":"draft_return.payment_intent.oneOf.0.id","typeLabel":"integer"},"provider":{"type":"string","uniqueKey":"draft_return.payment_intent.oneOf.0.provider","typeLabel":"string"},"provider_intent_id":{"type":"string","uniqueKey":"draft_return.payment_intent.oneOf.0.provider_intent_id","typeLabel":"string"}},"uniqueKey":"draft_return.payment_intent.oneOf.0","typeLabel":"object"},{"type":"null","description":"The payment intent attached to the draft return, if any.\n\nLoop removes it, and this field becomes `null`, when you set `processing_type` to\n`regular` or when Loop resets Instant to `regular` because Instant is no longer\navailable.\n","properties":{"id":{"type":"integer"},"provider":{"type":"string"},"provider_intent_id":{"type":"string"}},"uniqueKey":"draft_return.payment_intent.oneOf.1","typeLabel":"null"}],"uniqueKey":"draft_return.payment_intent","typeLabel":"object | null"},"return_key":{"oneOf":[{"type":"string","description":"The unique key for the resulting return once submitted.","uniqueKey":"draft_return.return_key.oneOf.0","typeLabel":"string"},{"type":"null","description":"The unique key for the resulting return once submitted.","uniqueKey":"draft_return.return_key.oneOf.1","typeLabel":"null"}],"uniqueKey":"draft_return.return_key","typeLabel":"string | null"},"requires_uncollectible_payment":{"type":"boolean","description":"`true` when the draft return requires a payment but the shop has no usable Stripe\nconnection, so Loop cannot collect it. When `true`, the `add-payment-intent` template\nand link are not offered and the draft return cannot be submitted. Change the draft\nso no payment is needed, for example by changing items or the return method.\n","example":false,"uniqueKey":"draft_return.requires_uncollectible_payment","typeLabel":"boolean"}},"uniqueKey":"draft_return","typeLabel":"object"},"context":{"type":"object","description":"Contextual data for building the return UI. Keys are omitted when their value is null.\n","properties":{"languages":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"context.languages.oneOf.0.items.[INDEX].name","typeLabel":"string"},"abbreviation":{"type":"string","uniqueKey":"context.languages.oneOf.0.items.[INDEX].abbreviation","typeLabel":"string"}},"uniqueKey":"context.languages.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"context.languages.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"name":{"type":"string"},"abbreviation":{"type":"string"}}},"uniqueKey":"context.languages.oneOf.1","typeLabel":"null"}],"uniqueKey":"context.languages","typeLabel":"object[] | null"},"order":{"oneOf":[{"type":"object","properties":{"id":{"type":"integer","uniqueKey":"context.order.oneOf.0.id","typeLabel":"integer"},"currency":{"type":"string","uniqueKey":"context.order.oneOf.0.currency","typeLabel":"string"},"original_payment_transactions":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","uniqueKey":"context.order.oneOf.0.original_payment_transactions.items.[INDEX].type","typeLabel":"string"},"gateway":{"oneOf":[{"type":"string","uniqueKey":"context.order.oneOf.0.original_payment_transactions.items.[INDEX].gateway.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"context.order.oneOf.0.original_payment_transactions.items.[INDEX].gateway.oneOf.1","typeLabel":"null"}],"uniqueKey":"context.order.oneOf.0.original_payment_transactions.items.[INDEX].gateway","typeLabel":"string | null"},"amount":{"type":"integer","uniqueKey":"context.order.oneOf.0.original_payment_transactions.items.[INDEX].amount","typeLabel":"integer"},"currency":{"type":"string","uniqueKey":"context.order.oneOf.0.original_payment_transactions.items.[INDEX].currency","typeLabel":"string"},"brand":{"oneOf":[{"type":"string","uniqueKey":"context.order.oneOf.0.original_payment_transactions.items.[INDEX].brand.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"context.order.oneOf.0.original_payment_transactions.items.[INDEX].brand.oneOf.1","typeLabel":"null"}],"uniqueKey":"context.order.oneOf.0.original_payment_transactions.items.[INDEX].brand","typeLabel":"string | null"},"last4":{"oneOf":[{"type":"integer","uniqueKey":"context.order.oneOf.0.original_payment_transactions.items.[INDEX].last4.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"context.order.oneOf.0.original_payment_transactions.items.[INDEX].last4.oneOf.1","typeLabel":"null"}],"uniqueKey":"context.order.oneOf.0.original_payment_transactions.items.[INDEX].last4","typeLabel":"integer | null"}},"uniqueKey":"context.order.oneOf.0.original_payment_transactions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"context.order.oneOf.0.original_payment_transactions","typeLabel":"object[]"},"line_items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","uniqueKey":"context.order.oneOf.0.line_items.items.[INDEX].id","typeLabel":"integer"},"provider_product_id":{"type":"integer","uniqueKey":"context.order.oneOf.0.line_items.items.[INDEX].provider_product_id","typeLabel":"integer"},"provider_variant_id":{"type":"integer","uniqueKey":"context.order.oneOf.0.line_items.items.[INDEX].provider_variant_id","typeLabel":"integer"},"title":{"type":"string","uniqueKey":"context.order.oneOf.0.line_items.items.[INDEX].title","typeLabel":"string"},"variant_title":{"oneOf":[{"type":"string","uniqueKey":"context.order.oneOf.0.line_items.items.[INDEX].variant_title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"context.order.oneOf.0.line_items.items.[INDEX].variant_title.oneOf.1","typeLabel":"null"}],"uniqueKey":"context.order.oneOf.0.line_items.items.[INDEX].variant_title","typeLabel":"string | null"},"sku":{"oneOf":[{"type":"string","uniqueKey":"context.order.oneOf.0.line_items.items.[INDEX].sku.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"context.order.oneOf.0.line_items.items.[INDEX].sku.oneOf.1","typeLabel":"null"}],"uniqueKey":"context.order.oneOf.0.line_items.items.[INDEX].sku","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","uniqueKey":"context.order.oneOf.0.line_items.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"context.order.oneOf.0.line_items.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"context.order.oneOf.0.line_items.items.[INDEX].description","typeLabel":"string | null"},"price":{"oneOf":[{"type":"integer","uniqueKey":"context.order.oneOf.0.line_items.items.[INDEX].price.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"context.order.oneOf.0.line_items.items.[INDEX].price.oneOf.1","typeLabel":"null"}],"uniqueKey":"context.order.oneOf.0.line_items.items.[INDEX].price","typeLabel":"integer | null"},"image":{"oneOf":[{"type":"string","uniqueKey":"context.order.oneOf.0.line_items.items.[INDEX].image.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"context.order.oneOf.0.line_items.items.[INDEX].image.oneOf.1","typeLabel":"null"}],"uniqueKey":"context.order.oneOf.0.line_items.items.[INDEX].image","typeLabel":"string | null"},"parent_line_item_id":{"oneOf":[{"type":"integer","uniqueKey":"context.order.oneOf.0.line_items.items.[INDEX].parent_line_item_id.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"context.order.oneOf.0.line_items.items.[INDEX].parent_line_item_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"context.order.oneOf.0.line_items.items.[INDEX].parent_line_item_id","typeLabel":"integer | null"},"options":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"context.order.oneOf.0.line_items.items.[INDEX].options.items.[INDEX].name","typeLabel":"string"},"value":{"type":"string","uniqueKey":"context.order.oneOf.0.line_items.items.[INDEX].options.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"context.order.oneOf.0.line_items.items.[INDEX].options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"context.order.oneOf.0.line_items.items.[INDEX].options","typeLabel":"object[]"}},"uniqueKey":"context.order.oneOf.0.line_items.items.[INDEX]","typeLabel":"object"},"uniqueKey":"context.order.oneOf.0.line_items","typeLabel":"object[]"}},"uniqueKey":"context.order.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"id":{"type":"integer"},"currency":{"type":"string"},"original_payment_transactions":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"gateway":{"oneOf":[{"type":"string"},{"type":"null"}]},"amount":{"type":"integer"},"currency":{"type":"string"},"brand":{"oneOf":[{"type":"string"},{"type":"null"}]},"last4":{"oneOf":[{"type":"integer"},{"type":"null"}]}}}},"line_items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"provider_product_id":{"type":"integer"},"provider_variant_id":{"type":"integer"},"title":{"type":"string"},"variant_title":{"oneOf":[{"type":"string"},{"type":"null"}]},"sku":{"oneOf":[{"type":"string"},{"type":"null"}]},"description":{"oneOf":[{"type":"string"},{"type":"null"}]},"price":{"oneOf":[{"type":"integer"},{"type":"null"}]},"image":{"oneOf":[{"type":"string"},{"type":"null"}]},"parent_line_item_id":{"oneOf":[{"type":"integer"},{"type":"null"}]},"options":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}}}}}},"uniqueKey":"context.order.oneOf.1","typeLabel":"null"}],"uniqueKey":"context.order","typeLabel":"object | null"},"return_reason_groups":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","uniqueKey":"context.return_reason_groups.oneOf.0.items.[INDEX].id","typeLabel":"integer"},"return_reasons":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","uniqueKey":"context.return_reason_groups.oneOf.0.items.[INDEX].return_reasons.items.[INDEX].id","typeLabel":"integer"},"name":{"type":"string","uniqueKey":"context.return_reason_groups.oneOf.0.items.[INDEX].return_reasons.items.[INDEX].name","typeLabel":"string"},"parent_return_reason_id":{"oneOf":[{"type":"integer","uniqueKey":"context.return_reason_groups.oneOf.0.items.[INDEX].return_reasons.items.[INDEX].parent_return_reason_id.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"context.return_reason_groups.oneOf.0.items.[INDEX].return_reasons.items.[INDEX].parent_return_reason_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"context.return_reason_groups.oneOf.0.items.[INDEX].return_reasons.items.[INDEX].parent_return_reason_id","typeLabel":"integer | null"},"parent_return_reason_name":{"oneOf":[{"type":"string","uniqueKey":"context.return_reason_groups.oneOf.0.items.[INDEX].return_reasons.items.[INDEX].parent_return_reason_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"context.return_reason_groups.oneOf.0.items.[INDEX].return_reasons.items.[INDEX].parent_return_reason_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"context.return_reason_groups.oneOf.0.items.[INDEX].return_reasons.items.[INDEX].parent_return_reason_name","typeLabel":"string | null"},"is_commentable":{"type":"boolean","uniqueKey":"context.return_reason_groups.oneOf.0.items.[INDEX].return_reasons.items.[INDEX].is_commentable","typeLabel":"boolean"},"requires_comments":{"type":"boolean","uniqueKey":"context.return_reason_groups.oneOf.0.items.[INDEX].return_reasons.items.[INDEX].requires_comments","typeLabel":"boolean"}},"uniqueKey":"context.return_reason_groups.oneOf.0.items.[INDEX].return_reasons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"context.return_reason_groups.oneOf.0.items.[INDEX].return_reasons","typeLabel":"object[]"}},"uniqueKey":"context.return_reason_groups.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"context.return_reason_groups.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"id":{"type":"integer"},"return_reasons":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"parent_return_reason_id":{"oneOf":[{"type":"integer"},{"type":"null"}]},"parent_return_reason_name":{"oneOf":[{"type":"string"},{"type":"null"}]},"is_commentable":{"type":"boolean"},"requires_comments":{"type":"boolean"}}}}}},"uniqueKey":"context.return_reason_groups.oneOf.1","typeLabel":"null"}],"uniqueKey":"context.return_reason_groups","typeLabel":"object[] | null"},"items_eligible_to_return":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"order_line_item_id":{"type":"integer","uniqueKey":"context.items_eligible_to_return.oneOf.0.items.[INDEX].order_line_item_id","typeLabel":"integer"},"return_reason_group_id":{"type":"integer","uniqueKey":"context.items_eligible_to_return.oneOf.0.items.[INDEX].return_reason_group_id","typeLabel":"integer"},"expiration":{"oneOf":[{"type":"string","uniqueKey":"context.items_eligible_to_return.oneOf.0.items.[INDEX].expiration.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"context.items_eligible_to_return.oneOf.0.items.[INDEX].expiration.oneOf.1","typeLabel":"null"}],"uniqueKey":"context.items_eligible_to_return.oneOf.0.items.[INDEX].expiration","typeLabel":"string | null"}},"uniqueKey":"context.items_eligible_to_return.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"context.items_eligible_to_return.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"order_line_item_id":{"type":"integer"},"return_reason_group_id":{"type":"integer"},"expiration":{"oneOf":[{"type":"string"},{"type":"null"}]}}},"uniqueKey":"context.items_eligible_to_return.oneOf.1","typeLabel":"null"}],"uniqueKey":"context.items_eligible_to_return","typeLabel":"object[] | null"},"items_not_eligible_to_return":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"order_line_item_id":{"type":"integer","uniqueKey":"context.items_not_eligible_to_return.oneOf.0.items.[INDEX].order_line_item_id","typeLabel":"integer"},"ineligibility_code":{"type":"string","uniqueKey":"context.items_not_eligible_to_return.oneOf.0.items.[INDEX].ineligibility_code","typeLabel":"string"},"expiration":{"oneOf":[{"type":"string","uniqueKey":"context.items_not_eligible_to_return.oneOf.0.items.[INDEX].expiration.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"context.items_not_eligible_to_return.oneOf.0.items.[INDEX].expiration.oneOf.1","typeLabel":"null"}],"uniqueKey":"context.items_not_eligible_to_return.oneOf.0.items.[INDEX].expiration","typeLabel":"string | null"}},"uniqueKey":"context.items_not_eligible_to_return.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"context.items_not_eligible_to_return.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"order_line_item_id":{"type":"integer"},"ineligibility_code":{"type":"string"},"expiration":{"oneOf":[{"type":"string"},{"type":"null"}]}}},"uniqueKey":"context.items_not_eligible_to_return.oneOf.1","typeLabel":"null"}],"uniqueKey":"context.items_not_eligible_to_return","typeLabel":"object[] | null"},"return_reason_options":{"oneOf":[{"type":"array","items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","uniqueKey":"context.return_reason_options.oneOf.0.items.[INDEX].items.[INDEX].id","typeLabel":"integer"},"name":{"type":"string","uniqueKey":"context.return_reason_options.oneOf.0.items.[INDEX].items.[INDEX].name","typeLabel":"string"},"is_commentable":{"type":"boolean","uniqueKey":"context.return_reason_options.oneOf.0.items.[INDEX].items.[INDEX].is_commentable","typeLabel":"boolean"},"requires_comments":{"type":"boolean","uniqueKey":"context.return_reason_options.oneOf.0.items.[INDEX].items.[INDEX].requires_comments","typeLabel":"boolean"}},"uniqueKey":"context.return_reason_options.oneOf.0.items.[INDEX].items.[INDEX]","typeLabel":"object"},"uniqueKey":"context.return_reason_options.oneOf.0.items.[INDEX]","typeLabel":"object[]"},"uniqueKey":"context.return_reason_options.oneOf.0","typeLabel":"object[][]"},{"type":"null","items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"is_commentable":{"type":"boolean"},"requires_comments":{"type":"boolean"}}}},"uniqueKey":"context.return_reason_options.oneOf.1","typeLabel":"null"}],"uniqueKey":"context.return_reason_options","typeLabel":"object[][] | null"},"exchange_options":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"product_options":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"context.exchange_options.oneOf.0.items.[INDEX].product_options.oneOf.0.items.[INDEX].name","typeLabel":"string"},"values":{"type":"array","uniqueKey":"context.exchange_options.oneOf.0.items.[INDEX].product_options.oneOf.0.items.[INDEX].values","typeLabel":"array"},"position":{"oneOf":[{"type":"integer","description":"The 1-based Shopify product option position this dimension maps to.\nClients should read variant option values by this position, not by\narray index, because single-value options may be omitted from this list.\n","uniqueKey":"context.exchange_options.oneOf.0.items.[INDEX].product_options.oneOf.0.items.[INDEX].position.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The 1-based Shopify product option position this dimension maps to.\nClients should read variant option values by this position, not by\narray index, because single-value options may be omitted from this list.\n","uniqueKey":"context.exchange_options.oneOf.0.items.[INDEX].product_options.oneOf.0.items.[INDEX].position.oneOf.1","typeLabel":"null"}],"uniqueKey":"context.exchange_options.oneOf.0.items.[INDEX].product_options.oneOf.0.items.[INDEX].position","typeLabel":"integer | null"}},"uniqueKey":"context.exchange_options.oneOf.0.items.[INDEX].product_options.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"context.exchange_options.oneOf.0.items.[INDEX].product_options.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"name":{"type":"string"},"values":{"type":"array"},"position":{"oneOf":[{"type":"integer","description":"The 1-based Shopify product option position this dimension maps to.\nClients should read variant option values by this position, not by\narray index, because single-value options may be omitted from this list.\n"},{"type":"null","description":"The 1-based Shopify product option position this dimension maps to.\nClients should read variant option values by this position, not by\narray index, because single-value options may be omitted from this list.\n"}]}}},"uniqueKey":"context.exchange_options.oneOf.0.items.[INDEX].product_options.oneOf.1","typeLabel":"null"}],"uniqueKey":"context.exchange_options.oneOf.0.items.[INDEX].product_options","typeLabel":"object[] | null"},"product_variants":{"type":"array","items":{"type":"object","properties":{"product_id":{"oneOf":[{"type":"integer","uniqueKey":"context.exchange_options.oneOf.0.items.[INDEX].product_variants.items.[INDEX].product_id.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"context.exchange_options.oneOf.0.items.[INDEX].product_variants.items.[INDEX].product_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"context.exchange_options.oneOf.0.items.[INDEX].product_variants.items.[INDEX].product_id","typeLabel":"integer | null"},"variant_id":{"type":"integer","uniqueKey":"context.exchange_options.oneOf.0.items.[INDEX].product_variants.items.[INDEX].variant_id","typeLabel":"integer"},"title":{"oneOf":[{"type":"string","uniqueKey":"context.exchange_options.oneOf.0.items.[INDEX].product_variants.items.[INDEX].title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"context.exchange_options.oneOf.0.items.[INDEX].product_variants.items.[INDEX].title.oneOf.1","typeLabel":"null"}],"uniqueKey":"context.exchange_options.oneOf.0.items.[INDEX].product_variants.items.[INDEX].title","typeLabel":"string | null"},"variant_title":{"oneOf":[{"type":"string","uniqueKey":"context.exchange_options.oneOf.0.items.[INDEX].product_variants.items.[INDEX].variant_title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"context.exchange_options.oneOf.0.items.[INDEX].product_variants.items.[INDEX].variant_title.oneOf.1","typeLabel":"null"}],"uniqueKey":"context.exchange_options.oneOf.0.items.[INDEX].product_variants.items.[INDEX].variant_title","typeLabel":"string | null"},"product_type":{"oneOf":[{"type":"string","uniqueKey":"context.exchange_options.oneOf.0.items.[INDEX].product_variants.items.[INDEX].product_type.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"context.exchange_options.oneOf.0.items.[INDEX].product_variants.items.[INDEX].product_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"context.exchange_options.oneOf.0.items.[INDEX].product_variants.items.[INDEX].product_type","typeLabel":"string | null"},"options":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"context.exchange_options.oneOf.0.items.[INDEX].product_variants.items.[INDEX].options.additionalProperties","typeLabel":"string"},"uniqueKey":"context.exchange_options.oneOf.0.items.[INDEX].product_variants.items.[INDEX].options","typeLabel":"object"},"image":{"oneOf":[{"type":"string","uniqueKey":"context.exchange_options.oneOf.0.items.[INDEX].product_variants.items.[INDEX].image.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"context.exchange_options.oneOf.0.items.[INDEX].product_variants.items.[INDEX].image.oneOf.1","typeLabel":"null"}],"uniqueKey":"context.exchange_options.oneOf.0.items.[INDEX].product_variants.items.[INDEX].image","typeLabel":"string | null"},"price":{"oneOf":[{"type":"integer","uniqueKey":"context.exchange_options.oneOf.0.items.[INDEX].product_variants.items.[INDEX].price.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"context.exchange_options.oneOf.0.items.[INDEX].product_variants.items.[INDEX].price.oneOf.1","typeLabel":"null"}],"uniqueKey":"context.exchange_options.oneOf.0.items.[INDEX].product_variants.items.[INDEX].price","typeLabel":"integer | null"},"currency":{"oneOf":[{"type":"string","uniqueKey":"context.exchange_options.oneOf.0.items.[INDEX].product_variants.items.[INDEX].currency.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"context.exchange_options.oneOf.0.items.[INDEX].product_variants.items.[INDEX].currency.oneOf.1","typeLabel":"null"}],"uniqueKey":"context.exchange_options.oneOf.0.items.[INDEX].product_variants.items.[INDEX].currency","typeLabel":"string | null"},"is_available":{"type":"boolean","uniqueKey":"context.exchange_options.oneOf.0.items.[INDEX].product_variants.items.[INDEX].is_available","typeLabel":"boolean"},"translated_title":{"oneOf":[{"type":"string","description":"The product title in the shopper's locale. `null` when no locale was sent,\nproduct translations are not enabled for the shop, or no translation exists.\n`title` always stays in the default language.\n","uniqueKey":"context.exchange_options.oneOf.0.items.[INDEX].product_variants.items.[INDEX].translated_title.oneOf.0","typeLabel":"string"},{"type":"null","description":"The product title in the shopper's locale. `null` when no locale was sent,\nproduct translations are not enabled for the shop, or no translation exists.\n`title` always stays in the default language.\n","uniqueKey":"context.exchange_options.oneOf.0.items.[INDEX].product_variants.items.[INDEX].translated_title.oneOf.1","typeLabel":"null"}],"uniqueKey":"context.exchange_options.oneOf.0.items.[INDEX].product_variants.items.[INDEX].translated_title","typeLabel":"string | null"},"translated_variant_title":{"oneOf":[{"type":"string","description":"The variant title in the shopper's locale. `null` under the same conditions as\n`translated_title`. `variant_title` always stays in the default language.\n","uniqueKey":"context.exchange_options.oneOf.0.items.[INDEX].product_variants.items.[INDEX].translated_variant_title.oneOf.0","typeLabel":"string"},{"type":"null","description":"The variant title in the shopper's locale. `null` under the same conditions as\n`translated_title`. `variant_title` always stays in the default language.\n","uniqueKey":"context.exchange_options.oneOf.0.items.[INDEX].product_variants.items.[INDEX].translated_variant_title.oneOf.1","typeLabel":"null"}],"uniqueKey":"context.exchange_options.oneOf.0.items.[INDEX].product_variants.items.[INDEX].translated_variant_title","typeLabel":"string | null"},"translated_options":{"type":"array","description":"The variant's options in the shopper's locale, one entry per option in\n`product_options` and in the same order. Each name and value falls back to its\ndefault-language text. Empty when no option name or value is translated.\n","items":{"type":"object","properties":{"name":{"type":"string","description":"The option name, for example \"Taille\".","uniqueKey":"context.exchange_options.oneOf.0.items.[INDEX].product_variants.items.[INDEX].translated_options.items.[INDEX].name","typeLabel":"string"},"value":{"type":"string","description":"The value selected for this variant, for example \"Petit\".","uniqueKey":"context.exchange_options.oneOf.0.items.[INDEX].product_variants.items.[INDEX].translated_options.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"context.exchange_options.oneOf.0.items.[INDEX].product_variants.items.[INDEX].translated_options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"context.exchange_options.oneOf.0.items.[INDEX].product_variants.items.[INDEX].translated_options","typeLabel":"object[]"}},"uniqueKey":"context.exchange_options.oneOf.0.items.[INDEX].product_variants.items.[INDEX]","typeLabel":"object"},"uniqueKey":"context.exchange_options.oneOf.0.items.[INDEX].product_variants","typeLabel":"object[]"}},"uniqueKey":"context.exchange_options.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"context.exchange_options.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"product_options":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"values":{"type":"array"},"position":{"oneOf":[{"type":"integer","description":"The 1-based Shopify product option position this dimension maps to.\nClients should read variant option values by this position, not by\narray index, because single-value options may be omitted from this list.\n"},{"type":"null","description":"The 1-based Shopify product option position this dimension maps to.\nClients should read variant option values by this position, not by\narray index, because single-value options may be omitted from this list.\n"}]}}}},{"type":"null","items":{"type":"object","properties":{"name":{"type":"string"},"values":{"type":"array"},"position":{"oneOf":[{"type":"integer","description":"The 1-based Shopify product option position this dimension maps to.\nClients should read variant option values by this position, not by\narray index, because single-value options may be omitted from this list.\n"},{"type":"null","description":"The 1-based Shopify product option position this dimension maps to.\nClients should read variant option values by this position, not by\narray index, because single-value options may be omitted from this list.\n"}]}}}}]},"product_variants":{"type":"array","items":{"type":"object","properties":{"product_id":{"oneOf":[{"type":"integer"},{"type":"null"}]},"variant_id":{"type":"integer"},"title":{"oneOf":[{"type":"string"},{"type":"null"}]},"variant_title":{"oneOf":[{"type":"string"},{"type":"null"}]},"product_type":{"oneOf":[{"type":"string"},{"type":"null"}]},"options":{"type":"object","additionalProperties":{"type":"string"}},"image":{"oneOf":[{"type":"string"},{"type":"null"}]},"price":{"oneOf":[{"type":"integer"},{"type":"null"}]},"currency":{"oneOf":[{"type":"string"},{"type":"null"}]},"is_available":{"type":"boolean"},"translated_title":{"oneOf":[{"type":"string","description":"The product title in the shopper's locale. `null` when no locale was sent,\nproduct translations are not enabled for the shop, or no translation exists.\n`title` always stays in the default language.\n"},{"type":"null","description":"The product title in the shopper's locale. `null` when no locale was sent,\nproduct translations are not enabled for the shop, or no translation exists.\n`title` always stays in the default language.\n"}]},"translated_variant_title":{"oneOf":[{"type":"string","description":"The variant title in the shopper's locale. `null` under the same conditions as\n`translated_title`. `variant_title` always stays in the default language.\n"},{"type":"null","description":"The variant title in the shopper's locale. `null` under the same conditions as\n`translated_title`. `variant_title` always stays in the default language.\n"}]},"translated_options":{"type":"array","description":"The variant's options in the shopper's locale, one entry per option in\n`product_options` and in the same order. Each name and value falls back to its\ndefault-language text. Empty when no option name or value is translated.\n","items":{"type":"object","properties":{"name":{"type":"string","description":"The option name, for example \"Taille\"."},"value":{"type":"string","description":"The value selected for this variant, for example \"Petit\"."}}}}}}}}},"uniqueKey":"context.exchange_options.oneOf.1","typeLabel":"null"}],"uniqueKey":"context.exchange_options","typeLabel":"object[] | null"},"return_method_options":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","uniqueKey":"context.return_method_options.oneOf.0.items.[INDEX].id","typeLabel":"integer"},"name":{"type":"string","uniqueKey":"context.return_method_options.oneOf.0.items.[INDEX].name","typeLabel":"string"},"type":{"type":"string","enum":["box-and-ship","carrier-choice","drop-off","pick-up","in-store"],"uniqueKey":"context.return_method_options.oneOf.0.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"fee":{"type":"integer","uniqueKey":"context.return_method_options.oneOf.0.items.[INDEX].fee","typeLabel":"integer"},"title":{"type":"string","uniqueKey":"context.return_method_options.oneOf.0.items.[INDEX].title","typeLabel":"string"},"logo_url":{"type":"string","uniqueKey":"context.return_method_options.oneOf.0.items.[INDEX].logo_url","typeLabel":"string"},"location_url":{"type":"string","uniqueKey":"context.return_method_options.oneOf.0.items.[INDEX].location_url","typeLabel":"string"}},"uniqueKey":"context.return_method_options.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"context.return_method_options.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"type":"string","enum":["box-and-ship","carrier-choice","drop-off","pick-up","in-store"]},"fee":{"type":"integer"},"title":{"type":"string"},"logo_url":{"type":"string"},"location_url":{"type":"string"}}},"uniqueKey":"context.return_method_options.oneOf.1","typeLabel":"null"}],"uniqueKey":"context.return_method_options","typeLabel":"object[] | null"},"processing_type_options":{"type":"object","description":"Which processing types the draft return can use. In HAL-Forms responses this object is\nat `_embedded.processing_type_options`.\n\nPresent only in the `items-finalized` state. Omitted in other states.\n","properties":{"required":{"type":"boolean","description":"`true` when the return policy requires Instant. In that case the `regular` option has\n`available: false` with `unavailability_reason: instant-required`.\n","example":false,"uniqueKey":"context.processing_type_options.required","typeLabel":"boolean"},"options":{"type":"array","description":"One entry for `regular` and one for `instant`.","items":{"type":"object","properties":{"type":{"type":"string","description":"The processing type this entry describes.","enum":["regular","instant"],"uniqueKey":"context.processing_type_options.options.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"available":{"type":"boolean","description":"Whether you can set this processing type now. Send only an available type to\n`set-processing-type`.\n\nWhen the draft has an exchange item, Instant runs as Instant Exchange and stays\navailable even when the credit type is `refund`.\n","uniqueKey":"context.processing_type_options.options.items.[INDEX].available","typeLabel":"boolean"},"unavailability_reason":{"oneOf":[{"type":"string","description":"Why this type is not available. `null` when `available` is `true`.\n\n- `not-enabled`: Instant is not turned on for this shop or return policy, or the shop\n cannot take the payment.\n- `not-applicable`: Instant does not apply to this draft, for example an in-store\n return, a return where every item is kept, or a return with nothing to charge.\n- `excluded`: An item in the draft is excluded from Instant.\n- `instant-required`: Only on `regular`. The return policy requires Instant.\n","enum":["not-enabled","not-applicable","excluded","instant-required",null],"uniqueKey":"context.processing_type_options.options.items.[INDEX].unavailability_reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Why this type is not available. `null` when `available` is `true`.\n\n- `not-enabled`: Instant is not turned on for this shop or return policy, or the shop\n cannot take the payment.\n- `not-applicable`: Instant does not apply to this draft, for example an in-store\n return, a return where every item is kept, or a return with nothing to charge.\n- `excluded`: An item in the draft is excluded from Instant.\n- `instant-required`: Only on `regular`. The return policy requires Instant.\n","enum":["not-enabled","not-applicable","excluded","instant-required",null],"uniqueKey":"context.processing_type_options.options.items.[INDEX].unavailability_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"context.processing_type_options.options.items.[INDEX].unavailability_reason","typeLabel":"enum\u003cstring> | null"},"authorization_amount":{"oneOf":[{"type":"object","description":"Only on an available `instant` option. The amount Loop holds (authorizes) on the\nshopper's payment method for Instant. `null` otherwise.\n","properties":{"amount":{"type":"integer","description":"The amount in minor units (e.g. cents).","example":5000,"uniqueKey":"context.processing_type_options.options.items.[INDEX].authorization_amount.oneOf.0.amount","typeLabel":"integer"},"currency_code":{"type":"string","description":"The three-character ISO 4217 currency code.","example":"USD","uniqueKey":"context.processing_type_options.options.items.[INDEX].authorization_amount.oneOf.0.currency_code","typeLabel":"string"}},"uniqueKey":"context.processing_type_options.options.items.[INDEX].authorization_amount.oneOf.0","typeLabel":"object"},{"type":"null","description":"Only on an available `instant` option. The amount Loop holds (authorizes) on the\nshopper's payment method for Instant. `null` otherwise.\n","uniqueKey":"context.processing_type_options.options.items.[INDEX].authorization_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"context.processing_type_options.options.items.[INDEX].authorization_amount","typeLabel":"object | null"},"charge_amount":{"oneOf":[{"type":"object","description":"Only on an available `instant` option. The amount Loop charges for Instant. `null`\notherwise.\n","properties":{"amount":{"type":"integer","description":"The amount in minor units (e.g. cents).","example":5000,"uniqueKey":"context.processing_type_options.options.items.[INDEX].charge_amount.oneOf.0.amount","typeLabel":"integer"},"currency_code":{"type":"string","description":"The three-character ISO 4217 currency code.","example":"USD","uniqueKey":"context.processing_type_options.options.items.[INDEX].charge_amount.oneOf.0.currency_code","typeLabel":"string"}},"uniqueKey":"context.processing_type_options.options.items.[INDEX].charge_amount.oneOf.0","typeLabel":"object"},{"type":"null","description":"Only on an available `instant` option. The amount Loop charges for Instant. `null`\notherwise.\n","uniqueKey":"context.processing_type_options.options.items.[INDEX].charge_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"context.processing_type_options.options.items.[INDEX].charge_amount","typeLabel":"object | null"},"window_days":{"oneOf":[{"type":"integer","description":"Only on an available `instant` option. The Instant window, in days, from the return\npolicy. `null` otherwise.\n","example":14,"uniqueKey":"context.processing_type_options.options.items.[INDEX].window_days.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Only on an available `instant` option. The Instant window, in days, from the return\npolicy. `null` otherwise.\n","example":14,"uniqueKey":"context.processing_type_options.options.items.[INDEX].window_days.oneOf.1","typeLabel":"null"}],"uniqueKey":"context.processing_type_options.options.items.[INDEX].window_days","typeLabel":"integer | null"},"hold_window_days":{"oneOf":[{"type":"integer","description":"Only on an available `instant` option when Instant applies to a refund rather than an\nexchange. The hold window, in days, from the return policy. `null` otherwise.\n","example":null,"uniqueKey":"context.processing_type_options.options.items.[INDEX].hold_window_days.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Only on an available `instant` option when Instant applies to a refund rather than an\nexchange. The hold window, in days, from the return policy. `null` otherwise.\n","example":null,"uniqueKey":"context.processing_type_options.options.items.[INDEX].hold_window_days.oneOf.1","typeLabel":"null"}],"uniqueKey":"context.processing_type_options.options.items.[INDEX].hold_window_days","typeLabel":"integer | null"}},"uniqueKey":"context.processing_type_options.options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"context.processing_type_options.options","typeLabel":"object[]"}},"uniqueKey":"context.processing_type_options","typeLabel":"object"}},"uniqueKey":"context","typeLabel":"object"},"errors":{"type":"array","description":"An array of error codes. In the event of a partial failure, the API will return\nall possible data as well as any error codes that were thrown.\n\nSee [Error codes](/api-reference/error-codes#draft-returns-specific-errors) for\na full list of possible errors.\n","items":{"type":"object","properties":{"code":{"type":"string","description":"The error code.","enum":["draft-returns-not-enabled","validation-failed","action-validation-failed","shop-not-found","order-lookup-failed","order-not-found","error-retrieving-order","secondary-input-mismatch","returns-unavailable-for-order","order-has-been-cancelled","order-line-item-get-data-failed","draft-return-not-found","draft-return-version-mismatch","draft-return-not-actionable","items-not-finalizable","totals-calculation-failed","return-creation-failed","terminal-state","context-generation-failed","action-generation-failed","no-eligible-return-methods","invalid-return-method","product-variant-not-found","product-variant-unavailable","return-reason-not-found","currency-mismatch","unsupported-feature","internal-error"],"uniqueKey":"errors.items.[INDEX].code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Optional error message.","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"_links":{"self":{"href":"\u003cstring>"}},"_templates":{},"client_application":{},"shopper_token":"\u003cstring>","draft_return":{"id":12345,"return_id":67890,"state":"created","currency":"USD","language":"en","credit_type":null,"processing_type":"regular","customer":{"email":"someone@test.com"},"shipping_address":{"name":"Jane Doe","company":null,"address1":"123 Main St","address2":"Apt 4","city":"Chicago","state":"Illinois","zip":"60622","country":"United States","country_code":"US","phone":"555-555-5555"},"returning_items":[{"id":1,"order_line_item_id":12346,"return_type":"credit","resolution":"return","return_reason":{"name":"Item didn't fit","comment":null},"user_inputs":[{"id":1,"type":"yes-no","prompt":"\u003cp>Is the item still in its original packaging?\u003c/p>","value":true}],"image_uploads":["https://cdn.example.com/return-images/abc123.jpg"]}],"cart_items":[{"id":201,"variant_id":501,"product_id":100,"sku":"SHIRT-RED-S","title":"Red Shirt","variant_title":"Small","translated_title":"Chemise rouge","translated_variant_title":"Petit","price":2500,"image":"https://cdn.example.com/products/red-shirt.jpg","exchange_type":"exchange","exchange_for_returning_item_id":1}],"selected_return_method":{"id":123,"name":"\u003cstring>","type":"box-and-ship","title":"\u003cstring>","logo_url":"\u003cstring>","location_url":"\u003cstring>"},"payment_intent":{"id":123,"provider":"\u003cstring>","provider_intent_id":"\u003cstring>"},"return_key":"\u003cstring>","requires_uncollectible_payment":false},"context":{"languages":[{"name":"\u003cstring>","abbreviation":"\u003cstring>"}],"order":{"id":123,"currency":"\u003cstring>","original_payment_transactions":[{"type":"\u003cstring>","gateway":"\u003cstring>","amount":123,"currency":"\u003cstring>","brand":"\u003cstring>","last4":123}],"line_items":[{"id":123,"provider_product_id":123,"provider_variant_id":123,"title":"\u003cstring>","variant_title":"\u003cstring>","sku":"\u003cstring>","description":"\u003cstring>","price":123,"image":"\u003cstring>","parent_line_item_id":123,"options":[{"name":"\u003cstring>","value":"\u003cstring>"}]}]},"return_reason_groups":[{"id":123,"return_reasons":[{"id":123,"name":"\u003cstring>","parent_return_reason_id":123,"parent_return_reason_name":"\u003cstring>","is_commentable":true,"requires_comments":true}]}],"items_eligible_to_return":[{"order_line_item_id":123,"return_reason_group_id":123,"expiration":"\u003cstring>"}],"items_not_eligible_to_return":[{"order_line_item_id":123,"ineligibility_code":"\u003cstring>","expiration":"\u003cstring>"}],"return_reason_options":[[{"id":123,"name":"\u003cstring>","is_commentable":true,"requires_comments":true}]],"exchange_options":[{"product_options":[{"name":"\u003cstring>","values":"\u003carray>","position":123}],"product_variants":[{"product_id":123,"variant_id":123,"title":"\u003cstring>","variant_title":"\u003cstring>","product_type":"\u003cstring>","options":{},"image":"\u003cstring>","price":123,"currency":"\u003cstring>","is_available":true,"translated_title":"\u003cstring>","translated_variant_title":"\u003cstring>","translated_options":[{"name":"\u003cstring>","value":"\u003cstring>"}]}]}],"return_method_options":[{"id":123,"name":"\u003cstring>","type":"box-and-ship","fee":123,"title":"\u003cstring>","logo_url":"\u003cstring>","location_url":"\u003cstring>"}],"processing_type_options":{"required":false,"options":[{"type":"regular","available":true,"unavailability_reason":"not-enabled","authorization_amount":{"amount":5000,"currency_code":"USD"},"charge_amount":{"amount":5000,"currency_code":"USD"},"window_days":14,"hold_window_days":null}]}},"errors":[{"code":"draft-returns-not-enabled","message":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"5513cf49-c95b-4036-ba09-4c5b82714744":{"description":"API key is missing or invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["unauthorized"],"uniqueKey":"errors.items.[INDEX].code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","example":"Unauthorized.","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"code":"unauthorized","message":"Unauthorized."}]}}},"exampleType":"generated"}},"exampleType":"generated"},"b6c55b3b-8e90-43b1-a4dd-8780d38c9c59":{"description":"Not found. On shopper-portal draft-id requests, also returned when\n`X-Loop-Shopper-Token` is missing, empty, or does not match the draft.\n","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"17f21fdc-509d-444d-a5de-c542e8b5f58a":{"description":"Validation error occurred.","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["validation-failed"],"uniqueKey":"errors.items.[INDEX].code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","example":"Validation failed.","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"code":"validation-failed","message":"Validation failed."}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"38107355-44af-46c9-ada8-db21ec0edcd5":{"api_key":{"type":"apiKey","in":"header","name":"X-Authorization","scopes":[],"schemeName":"api_key"}}},"servers":{"ca00b6b6-cefa-4f39-8b14-4184882c78c6":{"url":"https://api.loopreturns.com/api/2026-10","description":"2026-10 (Stable)"},"15ac1724-d46b-4583-8905-2b86690297c1":{"url":"https://api.loopreturns.com/api/unstable","description":"Unstable (Preview)"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-Authorization","scopes":[],"schemeName":"api_key"},"schema":{"title":"X-Authorization","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"api_key","name":"X-Authorization"}],"title":"api_key"}]},"originalFileLocation":"openapi/draft-returns-hal-forms.yaml"},"subdomain":"loopreturns","siteName":"Loop Returns Documentation","title":"Submit Draft Return - Loop Returns Documentation","navMaps":{"firstHrefInVersion":{"2026-07":{"href":"/api-reference/latest/draft-returns/submit-draft-return","matchLevel":1},"2026-10":{"href":"/api-reference/2026-10/draft-returns/submit-draft-return","matchLevel":0},"unstable":{"href":"/api-reference/2026-10/draft-returns/submit-draft-return","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-10-29T18:31:28.147Z","originalFileLocation":"api-reference/2026-10/draft-returns/submit-draft-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=\"Submits the draft return. This finalizes the return and initiates any necessary workflows. Once submitted, the draft_return.return_id is populated and the state moves to submitted. If no return policy covers the address on the draft return, the response is a 422 with errors[0].code set to returns-unavailable-for-order. The draft return stays open. Do not retry the submit; ask the shopper for a different address or stop the return. If the cart still has Shop Now items while a credit item\u0026#x27;s excluded outcomes (as returned on its line item) include Shop Now, the response is a 422 with the message \u0026quot;Shop Now is not available for the items in this return. Remove the new items to continue.\u0026quot; Remove those cart items and submit again. In-store (point of sale) returns are unaffected. The draft return is ready to submit when the submit-draft-return link (HAL-Forms: the submit-draft-return template) is present. Use it as the single readiness signal rather than working it out from other actions: Loop only offers it once every required step is complete.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Loop Returns Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/loopreturns/X0rUYkP1UIsEaMhI/_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/loopreturns/X0rUYkP1UIsEaMhI/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/loopreturns/X0rUYkP1UIsEaMhI/_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/loopreturns/X0rUYkP1UIsEaMhI/_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/loopreturns/X0rUYkP1UIsEaMhI/_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/loopreturns/X0rUYkP1UIsEaMhI/_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/loopreturns/X0rUYkP1UIsEaMhI/_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/loopreturns/X0rUYkP1UIsEaMhI/_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/loopreturns/X0rUYkP1UIsEaMhI/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Submit Draft Return - Loop Returns Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Submits the draft return. This finalizes the return and initiates any necessary workflows. Once submitted, the draft_return.return_id is populated and the state moves to submitted. If no return policy covers the address on the draft return, the response is a 422 with errors[0].code set to returns-unavailable-for-order. The draft return stays open. Do not retry the submit; ask the shopper for a different address or stop the return. If the cart still has Shop Now items while a credit item\u0026#x27;s excluded outcomes (as returned on its line item) include Shop Now, the response is a 422 with the message \u0026quot;Shop Now is not available for the items in this return. Remove the new items to continue.\u0026quot; Remove those cart items and submit again. In-store (point of sale) returns are unaffected. The draft return is ready to submit when the submit-draft-return link (HAL-Forms: the submit-draft-return template) is present. Use it as the single readiness signal rather than working it out from other actions: Loop only offers it once every required step is complete.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Loop Returns Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.loopreturns.com/api-reference/2026-10/draft-returns/submit-draft-return\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://loopreturns.mintlify.app/_mintlify/api/og/v2?division=Return+Create+%28HAL-Forms%29\u0026amp;title=Submit+Draft+Return\u0026amp;description=Submits+the+draft+return.%0A%0AThis+finalizes+the+return+and+initiates+any+necessary+workflows.%0AOnce+submitted%2C+the+%60draft_return.return_id%60+is+populated+and+the+st\u0026amp;theme=5ccacdea69e246fe33e6ab29\u0026amp;signature=fe982136cf955135279b37978c5218953bda7f18a601fda537bf6b989373e9b7\">\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=\"Submit Draft Return - Loop Returns Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Submits the draft return. This finalizes the return and initiates any necessary workflows. Once submitted, the draft_return.return_id is populated and the state moves to submitted. If no return policy covers the address on the draft return, the response is a 422 with errors[0].code set to returns-unavailable-for-order. The draft return stays open. Do not retry the submit; ask the shopper for a different address or stop the return. If the cart still has Shop Now items while a credit item\u0026#x27;s excluded outcomes (as returned on its line item) include Shop Now, the response is a 422 with the message \u0026quot;Shop Now is not available for the items in this return. Remove the new items to continue.\u0026quot; Remove those cart items and submit again. In-store (point of sale) returns are unaffected. The draft return is ready to submit when the submit-draft-return link (HAL-Forms: the submit-draft-return template) is present. Use it as the single readiness signal rather than working it out from other actions: Loop only offers it once every required step is complete.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://loopreturns.mintlify.app/_mintlify/api/og/v2?division=Return+Create+%28HAL-Forms%29\u0026amp;title=Submit+Draft+Return\u0026amp;description=Submits+the+draft+return.%0A%0AThis+finalizes+the+return+and+initiates+any+necessary+workflows.%0AOnce+submitted%2C+the+%60draft_return.return_id%60+is+populated+and+the+st\u0026amp;theme=5ccacdea69e246fe33e6ab29\u0026amp;signature=fe982136cf955135279b37978c5218953bda7f18a601fda537bf6b989373e9b7\">\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/loopreturns/X0rUYkP1UIsEaMhI/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Loop Returns Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0672FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.loopreturns.com/api-reference/2026-10/draft-returns/submit-draft-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/2026-10/draft-returns/submit-draft-return.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.loopreturns.com/#organization\",\"name\":\"Loop Returns Documentation\",\"url\":\"https://docs.loopreturns.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/loopreturns/mWP1nZGNp75FiB-l/logo/loop-logo-lapis-charcoal.svg?fit=max\u0026auto=format\u0026n=mWP1nZGNp75FiB-l\u0026q=85\u0026s=5113cc3f8f2d70a65c2c774e471a13c4\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.loopreturns.com#website\",\"name\":\"Loop Returns Documentation\",\"url\":\"https://docs.loopreturns.com\",\"publisher\":{\"@id\":\"https://docs.loopreturns.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.loopreturns.com/api-reference/2026-10/draft-returns/submit-draft-return#webpage\",\"url\":\"https://docs.loopreturns.com/api-reference/2026-10/draft-returns/submit-draft-return\",\"name\":\"Submit Draft Return\",\"description\":\"Submits the draft return. This finalizes the return and initiates any necessary workflows. Once submitted, the draft_return.return_id is populated and the state moves to submitted. If no return policy covers the address on the draft return, the response is a 422 with errors[0].code set to returns-unavailable-for-order. The draft return stays open. Do not retry the submit; ask the shopper for a different address or stop the return. If the cart still has Shop Now items while a credit item's excluded outcomes (as returned on its line item) include Shop Now, the response is a 422 with the message \\\"Shop Now is not available for the items in this return. Remove the new items to continue.\\\" Remove those cart items and submit again. In-store (point of sale) returns are unaffected. The draft return is ready to submit when the submit-draft-return link (HAL-Forms: the submit-draft-return template) is present. Use it as the single readiness signal rather than working it out from other actions: Loop only offers it once every required step is complete.\",\"dateModified\":\"2026-10-29T18:31:28.147Z\",\"isPartOf\":{\"@id\":\"https://docs.loopreturns.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.loopreturns.com/api-reference/2026-10/draft-returns/submit-draft-return#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.loopreturns.com/api-reference/2026-10/draft-returns/submit-draft-return#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"APIs\",\"item\":\"https://docs.loopreturns.com/api-reference/latest/return-actions/process-return\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Return Create (HAL-Forms)\",\"item\":\"https://docs.loopreturns.com/api-reference/2026-10/draft-returns/overview\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Submit Draft Return\",\"item\":\"https://docs.loopreturns.com/api-reference/2026-10/draft-returns/submit-draft-return\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.loopreturns.com/api-reference/2026-10/draft-returns/submit-draft-return#apireference\",\"headline\":\"Submit Draft Return\",\"name\":\"Submit Draft Return\",\"description\":\"Submits the draft return. This finalizes the return and initiates any necessary workflows. Once submitted, the draft_return.return_id is populated and the state moves to submitted. If no return policy covers the address on the draft return, the response is a 422 with errors[0].code set to returns-unavailable-for-order. The draft return stays open. Do not retry the submit; ask the shopper for a different address or stop the return. If the cart still has Shop Now items while a credit item's excluded outcomes (as returned on its line item) include Shop Now, the response is a 422 with the message \\\"Shop Now is not available for the items in this return. Remove the new items to continue.\\\" Remove those cart items and submit again. In-store (point of sale) returns are unaffected. The draft return is ready to submit when the submit-draft-return link (HAL-Forms: the submit-draft-return template) is present. Use it as the single readiness signal rather than working it out from other actions: Loop only offers it once every required step is complete.\",\"url\":\"https://docs.loopreturns.com/api-reference/2026-10/draft-returns/submit-draft-return\",\"mainEntityOfPage\":{\"@id\":\"https://docs.loopreturns.com/api-reference/2026-10/draft-returns/submit-draft-return#webpage\"},\"dateModified\":\"2026-10-29T18:31:28.147Z\",\"publisher\":{\"@id\":\"https://docs.loopreturns.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.loopreturns.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Loop Returns Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Loop Returns Documentation","nav":{"global":{"anchors":[{"anchor":"System Status","icon":"radar","href":"https://status.loopreturns.com"}]},"versions":[{"version":"2026-07","pages":[{"title":"2026-07","href":"/api-reference/latest/draft-returns/submit-draft-return"}]},{"version":"2026-10","default":true,"tabs":[{"tab":"Introduction","pages":[{"title":"Introduction","href":"/welcome"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/integration-guides/overview"}]},{"tab":"MCP Server","pages":[{"title":"MCP Server","href":"/mcp/overview"}]},{"tab":"API Reference","groups":[{"group":"Using the API","pages":[{"title":"Getting Started","icon":"play","href":"/api-reference/getting-started"},{"title":"Authentication","version":"2026-07","icon":"lock","href":"/api-reference/authentication"},{"title":"API Versioning","icon":"clock","href":"/api-reference/versioning"},{"title":"Rate limit","icon":"gauge","href":"/api-reference/rate-limit"},{"title":"Pagination","icon":"page","href":"/api-reference/pagination"},{"title":"Error codes","icon":"circle-exclamation","iconType":"regular","href":"/api-reference/error-codes"},{"title":"Postman Collection","icon":"bolt","href":"/api-reference/postman"}]},{"group":"APIs","pages":[{"group":"Return Actions","pages":[{"openapi":"post /warehouse/return/{id}/process","title":"Process Return","href":"/api-reference/latest/return-actions/process-return"},{"openapi":"post /warehouse/return/{id}/remove","title":"Remove Line Items","href":"/api-reference/latest/return-actions/remove-line-items"},{"openapi":"post /warehouse/return/{id}/cancel","title":"Cancel Return","href":"/api-reference/latest/return-actions/cancel-return"},{"openapi":"post /warehouse/return/{id}/flag","title":"Flag Return","href":"/api-reference/latest/return-actions/flag-return"},{"openapi":"post /warehouse/return/{id}/close","title":"Close Return","href":"/api-reference/latest/return-actions/close-return"},{"openapi":"get /warehouse/return/{id}/notes","title":"Get Return Notes","href":"/api-reference/latest/return-actions/get-return-notes"},{"openapi":"post /warehouse/return/{id}/note","title":"Create Return Note","href":"/api-reference/latest/return-actions/create-return-note"},{"openapi":"post /order/link","title":"Create Return Deep Link","href":"/api-reference/latest/return-actions/create-return-deep-link"},{"openapi":"post /order/qr","title":"Create Return Deep Link with QR Code","href":"/api-reference/latest/return-actions/create-return-deep-link-with-qr-code"}]},{"group":"Return Data","pages":[{"openapi":"get /warehouse/return/list","title":"Detailed Returns List","href":"/api-reference/latest/return-data/detailed-returns-list"},{"openapi":"get /warehouse/return/details","title":"Get Return Details","href":"/api-reference/latest/return-data/get-return-details"},{"openapi":"get /warehouse/reporting/asn","title":"Advanced Shipping Notice","href":"/api-reference/latest/return-data/advanced-shipping-notice"}]},{"group":"Programmatic Webhooks","pages":[{"openapi":"get /webhooks","title":"Get Webhooks","href":"/api-reference/latest/programmatic-webhooks/get-webhooks"},{"openapi":"post /webhooks","title":"Create Webhook","href":"/api-reference/latest/programmatic-webhooks/create-webhook"},{"openapi":"put /webhooks/{id}","title":"Update Webhook","href":"/api-reference/latest/programmatic-webhooks/update-webhook"},{"openapi":"delete /webhooks/{id}","title":"Delete Webhook","href":"/api-reference/latest/programmatic-webhooks/delete-webhook"}]},{"group":"Item Grading and Dispositioning","pages":[{"openapi":"post /dispositioning/grade","title":"Grade Items","href":"/api-reference/latest/item-grading-and-disposition/grade-items"},{"openapi":"post /dispositioning/assess","title":"Assess Dispositions","href":"/api-reference/latest/item-grading-and-disposition/assess-dispositions"}]},{"group":"Cart","pages":[{"openapi":"post /cart","title":"Create Cart","href":"/api-reference/latest/cart/create-cart"},{"openapi":"get /cart/{token}","title":null,"href":"/api-reference/latest/cart/get-cart"},{"openapi":"post /cart/{token}","title":null,"href":"/api-reference/latest/cart/update-cart"},{"openapi":"delete /cart/{token}","title":null,"href":"/api-reference/latest/cart/delete-cart"}]},{"group":"Destinations","pages":[{"openapi":"get /destinations","title":"Get All Destinations","href":"/api-reference/latest/destinations/get-all-destinations"},{"openapi":"post /destinations","title":"Create Destination","href":"/api-reference/latest/destinations/create-destination"},{"openapi":"get /destinations/{id}","title":"Get Destination Details","href":"/api-reference/latest/destinations/get-destination-details"},{"openapi":"put /destinations/{id}","title":"Update Destination","href":"/api-reference/latest/destinations/update-destination"},{"openapi":"delete /destinations/{id}","title":"Delete Destination","href":"/api-reference/latest/destinations/delete-destination"}]},{"group":"Blocklist","pages":[{"openapi":"get /blocklists","title":"List Blocklist Items","href":"/api-reference/latest/blocklist/list-blocklist-items"},{"openapi":"post /blocklists","title":"Create Blocklist Item","href":"/api-reference/latest/blocklist/create-blocklist-item"},{"openapi":"get /blocklists/{id}","title":"Get Blocklist Item","href":"/api-reference/latest/blocklist/get-blocklist-item"},{"openapi":"delete /blocklists/{id}","title":"Delete Blocklist Item","href":"/api-reference/latest/blocklist/delete-blocklist-item"}]},{"group":"Allowlist","pages":[{"openapi":"get /allowlists","title":"List Allowlist Items","href":"/api-reference/latest/allowlist/list-allowlist-items"},{"openapi":"post /allowlists","title":"Create Allowlist Item","href":"/api-reference/latest/allowlist/create-allowlist-item"},{"openapi":"get /allowlists/{id}","title":"Get Allowlist Item","href":"/api-reference/latest/allowlist/get-allowlist-item"},{"openapi":"delete /allowlists/{id}","title":"Delete Allowlist Item","href":"/api-reference/latest/allowlist/delete-allowlist-item"}]},{"group":"Fraud Reports","pages":[{"openapi":"post /returns/{id}/fraud-report","title":"Create Fraud Report","href":"/api-reference/latest/return-actions/create-fraud-report"}]},{"group":"Order Return Eligibility","pages":[{"openapi":"post /orders/return-eligibility","title":"Look Up Order Return Eligibility by Order Name","href":"/api-reference/latest/orders/look-up-order-return-eligibility"}]},{"group":"Happy Returns Shipments","pages":[{"openapi":"get /happy-returns/shipments/{happy_returns_shipment_id}","title":"Get Shipment Information","href":"/api-reference/latest/happy-returns-shipment/get-shipment-information"},{"openapi":"get /happy-returns/shipments","title":"Get Shipments","href":"/api-reference/latest/happy-returns-shipment/get-shipments"},{"openapi":"get /happy-returns/shipments/{id}/items","title":"Get Shipment Items","href":"/api-reference/latest/happy-returns-shipment-items/get-shipment-items"}]},{"group":"Label Requests","pages":[{"openapi":"get /label-requests","title":"List Label Requests","href":"/api-reference/latest/label-requests/list-label-requests"},{"openapi":"get /label-requests/{id}","title":"Get Label Request","href":"/api-reference/latest/label-requests/get-label-request"},{"openapi":"post /label-requests/{id}/errors","title":"Create Label Request Error","href":"/api-reference/latest/label-requests/create-a-label-request-error"},{"openapi":"post /labels","title":"Create Label","href":"/api-reference/latest/label-requests/create-label"},{"openapi":"post /returns/{returnId}/labels","title":"Generate Label","href":"/api-reference/latest/label-requests/generate-label"},{"openapi":"put /labels/{id}","title":"Update Label Status","href":"/api-reference/latest/label-requests/update-label-status"}]},{"group":"Return Create (HAL-Forms)","pages":[{"title":"Draft Returns (HAL Forms)","version":"2026-10","href":"/api-reference/2026-10/draft-returns/overview"},{"openapi":"draft-returns-hal-forms get /draft-returns","title":"List Draft Returns","href":"/api-reference/2026-10/draft-returns/list-draft-returns"},{"openapi":"draft-returns-hal-forms get /draft-returns/{draft_return_id}","title":"Get Draft Return","href":"/api-reference/2026-10/draft-returns/get-draft-return"},{"openapi":"draft-returns-hal-forms get /draft-returns/{draft_return_id}/order/items","title":"List Order Line Items","href":"/api-reference/2026-10/draft-returns/list-order-line-items"},{"openapi":"draft-returns-hal-forms get /draft-returns/{draft_return_id}/totals","title":"Get Draft Return Totals","href":"/api-reference/2026-10/draft-returns/get-draft-return-totals"},{"openapi":"draft-returns-hal-forms post /draft-returns","title":"Initialize Draft Return","href":"/api-reference/2026-10/draft-returns/initialize-draft-return"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/accept-return-policy","title":"Accept Return Policy","href":"/api-reference/2026-10/draft-returns/accept-return-policy"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/cancel","title":"Cancel Draft Return","href":"/api-reference/2026-10/draft-returns/cancel-draft-return"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/customer","title":"Set Customer","href":"/api-reference/2026-10/draft-returns/set-customer"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/address","title":"Set Address","href":"/api-reference/2026-10/draft-returns/set-address"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/returning-items","title":"Add Returning Item","href":"/api-reference/2026-10/draft-returns/add-returning-item"},{"openapi":"draft-returns-hal-forms delete /draft-returns/{draft_return_id}/returning-items/{returning_item_id}","title":"Remove Returning Item","href":"/api-reference/2026-10/draft-returns/remove-returning-item"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/returning-items/{returning_item_id}/return-reason","title":"Set Returning Item Return Reason","href":"/api-reference/2026-10/draft-returns/set-returning-item-return-reason"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/returning-items/{returning_item_id}/user-input/{user_input_id}","title":"Add Returning Item User Input","href":"/api-reference/2026-10/draft-returns/add-returning-item-user-input"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/returning-items/{returning_item_id}/return-type","title":"Set Returning Item Return Type","href":"/api-reference/2026-10/draft-returns/set-returning-item-return-type"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/returning-items/{returning_item_id}/exchange-item","title":"Add Returning Item Exchange Item","href":"/api-reference/2026-10/draft-returns/add-returning-item-exchange-item"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/cart/items","title":"Add Cart Item","href":"/api-reference/2026-10/draft-returns/add-cart-item"},{"openapi":"draft-returns-hal-forms delete /draft-returns/{draft_return_id}/cart/items/{cart_item_id}","title":"Remove Cart Item","href":"/api-reference/2026-10/draft-returns/remove-cart-item"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/credit-type","title":"Set Credit Type","href":"/api-reference/2026-10/draft-returns/set-credit-type"},{"openapi":"draft-returns-hal-forms delete /draft-returns/{draft_return_id}/credit-type","title":"Unset Credit Type","href":"/api-reference/2026-10/draft-returns/unset-credit-type"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/processing-type","title":"Set Processing Type","href":"/api-reference/2026-10/draft-returns/set-processing-type"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/finalize-items","title":"Finalize Items","href":"/api-reference/2026-10/draft-returns/finalize-items"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/unfinalize-items","title":"Unfinalize Items","href":"/api-reference/2026-10/draft-returns/unfinalize-items"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/return-method","title":"Select Return Method","href":"/api-reference/2026-10/draft-returns/select-return-method"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/return-method/carrier","title":"Select Return Method Carrier","href":"/api-reference/2026-10/draft-returns/select-return-method-carrier"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/language","title":"Set Language","href":"/api-reference/2026-10/draft-returns/set-language"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/cart","title":"Set Cart","href":"/api-reference/2026-10/draft-returns/set-cart"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/payment-intent","title":"Create Payment Intent","href":"/api-reference/2026-10/draft-returns/create-payment-intent"},{"openapi":"draft-returns-hal-forms delete /draft-returns/{draft_return_id}/payment-intent/{payment_intent_id}","title":"Remove Payment Intent","description":"Removes a payment intent from the draft return.\n","href":"/api-reference/2026-10/draft-returns/remove-payment-intent"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/submit","title":"Submit Draft Return","href":"/api-reference/2026-10/draft-returns/submit-draft-return"}]},{"group":"Commerce Data","pages":[{"group":"Products","pages":[{"openapi":"get /products","title":"List Products","description":"Retrieve a list of products. The list can be filtered, sorted, and paginated using the body parameters below.","href":"/api-reference/latest/products/list-products"},{"openapi":"post /products","title":"Create Product","href":"/api-reference/latest/products/create-product"},{"openapi":"put /products","title":"Upsert Product","href":"/api-reference/latest/products/upsert-product"},{"openapi":"get /products/{id}","title":"Get Product","href":"/api-reference/latest/products/get-product"},{"openapi":"get /products/external/{externalId}","title":"Get Product by External ID","href":"/api-reference/latest/products/get-product-by-external-id"},{"openapi":"put /products/{id}","title":"Update Product","href":"/api-reference/latest/products/update-product"},{"openapi":"delete /products/{id}","title":"Delete Product","href":"/api-reference/latest/products/delete-product"},{"openapi":"delete /products/external/{externalId}","title":"Delete Product by External ID","href":"/api-reference/latest/products/delete-product-by-external-id"},{"openapi":"get /products/{productId}/product-variants","title":"List Product Variants","href":"/api-reference/latest/products/list-product-variants"},{"openapi":"post /products/{productId}/product-variants","title":"Create Product Variant","href":"/api-reference/latest/products/create-product-variant"},{"openapi":"put /products/{productId}/product-variants","title":"Upsert Product Variant","href":"/api-reference/latest/products/upsert-product-variant"},{"openapi":"put /products/external/{productExternalId}/product-variants","title":"Upsert Product Variant by Product External ID","href":"/api-reference/latest/products/upsert-product-variant-by-product-external-id"},{"openapi":"get /products/{productId}/product-variants/{id}","title":"Get Product Variant","href":"/api-reference/latest/products/get-product-variant"},{"openapi":"get /products/external/{productExternalId}/product-variants/{externalId}","title":"Get Product Variant by External ID","href":"/api-reference/latest/products/get-product-variant-by-external-id"},{"openapi":"patch /products/{productId}/product-variants/{id}","title":"Update Product Variant","href":"/api-reference/latest/products/update-product-variant"},{"openapi":"delete /products/{productId}/product-variants/{id}","title":"Delete Product Variant","href":"/api-reference/latest/products/delete-product-variant"},{"openapi":"delete /products/external/{productExternalId}/product-variants/{externalId}","title":"Delete Product Variant by External ID","href":"/api-reference/latest/products/delete-product-variant-by-external-id"}]},{"group":"Orders","pages":[{"openapi":"get /orders","title":"List Orders","href":"/api-reference/latest/orders/list-orders"},{"openapi":"openapi/orders-api.yaml post /orders","title":"Create Order","href":"/api-reference/latest/orders/create-order"},{"openapi":"openapi/orders-api.yaml put /orders","title":"Upsert Order","href":"/api-reference/latest/orders/upsert-order"},{"openapi":"get /orders/{id}","title":"Get Order","href":"/api-reference/latest/orders/get-order"},{"openapi":"get /orders/external/{externalId}","title":"Get Order by External ID","href":"/api-reference/latest/orders/get-order-by-external-id"},{"openapi":"openapi/orders-api.yaml put /orders/{id}","title":"Update Order","href":"/api-reference/latest/orders/update-order"},{"openapi":"delete /orders/{id}","title":"Delete Order","href":"/api-reference/latest/orders/delete-order"},{"openapi":"delete /orders/external/{externalId}","title":"Delete Order by External ID","href":"/api-reference/latest/orders/delete-order-by-external-id"}]},{"group":"Customers","pages":[{"openapi":"get /customers","title":"List Customers","href":"/api-reference/latest/customers/list-customers"},{"openapi":"post /customers","title":"Create Customer","href":"/api-reference/latest/customers/create-customer"},{"openapi":"put /customers","title":"Upsert Customer","href":"/api-reference/latest/customers/upsert-customer"},{"openapi":"get /customers/{id}","title":"Get Customer","href":"/api-reference/latest/customers/get-customer"},{"openapi":"get /customers/external/{externalId}","title":"Get Customer by External ID","href":"/api-reference/latest/customers/get-customer-by-external-id"},{"openapi":"put /customers/{id}","title":"Update Customer","href":"/api-reference/latest/customers/update-customer"},{"openapi":"delete /customers/{id}","title":"Delete Customer","href":"/api-reference/latest/customers/delete-customer"},{"openapi":"delete /customers/external/{externalId}","title":"Delete Customer by External ID","href":"/api-reference/latest/customers/delete-customer-by-external-id"}]},{"group":"Locations","pages":[{"openapi":"get /locations","title":"List Locations","href":"/api-reference/latest/locations/list-locations"},{"openapi":"post /locations","title":"Create Location","href":"/api-reference/latest/locations/create-location"},{"openapi":"put /locations","title":"Upsert Location","href":"/api-reference/latest/locations/upsert-location"},{"openapi":"get /locations/{id}","title":"Get Location","href":"/api-reference/latest/locations/get-location"},{"openapi":"get /locations/external/{externalId}","title":"Get Location by External ID","href":"/api-reference/latest/locations/get-location-by-external-id"},{"openapi":"put /locations/{id}","title":"Update Location","href":"/api-reference/latest/locations/update-location"},{"openapi":"delete /locations/{id}","title":"Delete Location","href":"/api-reference/latest/locations/delete-location"},{"openapi":"delete /locations/external/{externalId}","title":"Delete Location by External ID","href":"/api-reference/latest/locations/delete-location-by-external-id"}]},{"group":"Inventories","pages":[{"openapi":"get /inventories","title":"List Inventories","href":"/api-reference/latest/inventories/list-inventories"},{"openapi":"post /inventories/{productVariantId}/{locationId}","title":"Upsert Inventory","href":"/api-reference/latest/inventories/create-inventory"},{"openapi":"put /inventories/{productVariantId}/{locationId}","title":"Upsert Inventory","href":"/api-reference/latest/inventories/upsert-inventory"},{"openapi":"put /inventories/external/{variantExternalId}/{locationExternalId}","title":"Upsert Inventory by External IDs","href":"/api-reference/latest/inventories/upsert-inventory-by-external-ids"},{"openapi":"get /inventories/{productVariantId}/{locationId}","title":"Get Inventory","href":"/api-reference/latest/inventories/get-inventory"},{"openapi":"get /inventories/external/{variantExternalId}/{locationExternalId}","title":"Get Inventory by External IDs","href":"/api-reference/latest/inventories/get-inventory-by-external-ids"},{"openapi":"delete /inventories/{productVariantId}/{locationId}","title":"Delete Inventory","href":"/api-reference/latest/inventories/delete-inventory"},{"openapi":"delete /inventories/external/{variantExternalId}/{locationExternalId}","title":"Delete Inventory by External IDs","href":"/api-reference/latest/inventories/delete-inventory-by-external-ids"}]},{"group":"Collections","pages":[{"openapi":"get /collections","title":"List Collections","href":"/api-reference/latest/collections/list-collections"},{"openapi":"post /collections","title":"Create Collection","href":"/api-reference/latest/collections/create-collection"},{"openapi":"put /collections","title":"Upsert Collection","href":"/api-reference/latest/collections/upsert-collection"},{"openapi":"get /collections/{id}","title":"Get Collection","href":"/api-reference/latest/collections/get-collection"},{"openapi":"get /collections/external/{externalId}","title":"Get Collection by External ID","href":"/api-reference/latest/collections/get-collection-by-external-id"},{"openapi":"put /collections/{id}","title":"Update Collection","href":"/api-reference/latest/collections/update-collection"},{"openapi":"delete /collections/{id}","title":"Delete Collection","href":"/api-reference/latest/collections/delete-collection"},{"openapi":"delete /collections/external/{externalId}","title":"Delete Collection by External ID","href":"/api-reference/latest/collections/delete-collection-by-external-id"},{"openapi":"post /collections/{id}/products/{productId}","title":"Add Product to Collection","href":"/api-reference/latest/collections/add-product-to-collection"},{"openapi":"delete /collections/{id}/products/{productId}","title":"Delete Product from Collection","href":"/api-reference/latest/collections/delete-product-from-collection"},{"openapi":"post /collections/external/{collectionExternalId}/products/external/{productExternalId}","title":"Add Product to Collection by External ID","href":"/api-reference/latest/collections/add-product-to-collection-by-external-id"},{"openapi":"delete /collections/external/{collectionExternalId}/products/external/{productExternalId}","title":"Delete Product from Collection by External ID","href":"/api-reference/latest/collections/delete-product-from-collection-by-external-id"}]},{"group":"Bulk Operations","pages":[{"openapi":"post /bulk-operations","title":"Create Bulk Operation","href":"/api-reference/latest/bulk-operations/create-bulk-operation"},{"openapi":"get /bulk-operations","title":"List Bulk Operations","href":"/api-reference/latest/bulk-operations/list-bulk-operations"},{"openapi":"get /bulk-operations/{id}","title":"Get Bulk Operation","href":"/api-reference/latest/bulk-operations/get-bulk-operation"},{"openapi":"get /bulk-operations/{id}/jobs","title":"List Bulk Operation Jobs","href":"/api-reference/latest/bulk-operations/list-bulk-operation-jobs"}]}]}]}]},{"tab":"Webhook Reference","pages":[{"title":"Webhook Reference","href":"/webhook-reference/getting-started"}]}]},{"version":"unstable","tabs":[{"tab":"Introduction","pages":[{"title":"Introduction","href":"/welcome"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/integration-guides/overview"}]},{"tab":"MCP Server","pages":[{"title":"MCP Server","href":"/mcp/overview"}]},{"tab":"API Reference","groups":[{"group":"Unstable","pages":[{"title":"What's different in unstable","sidebarTitle":"What's Changed","href":"/api-reference/unstable/changes"}]},{"group":"Using the API","pages":[{"title":"Getting Started","icon":"play","href":"/api-reference/getting-started"},{"title":"Authentication","version":"2026-07","icon":"lock","href":"/api-reference/authentication"},{"title":"API Versioning","icon":"clock","href":"/api-reference/versioning"},{"title":"Rate limit","icon":"gauge","href":"/api-reference/rate-limit"},{"title":"Pagination","icon":"page","href":"/api-reference/pagination"},{"title":"Error codes","icon":"circle-exclamation","iconType":"regular","href":"/api-reference/error-codes"},{"title":"Postman Collection","icon":"bolt","href":"/api-reference/postman"}]},{"group":"APIs","pages":[{"group":"Return Actions","pages":[{"openapi":"post /warehouse/return/{id}/process","title":"Process Return","href":"/api-reference/latest/return-actions/process-return"},{"openapi":"post /warehouse/return/{id}/remove","title":"Remove Line Items","href":"/api-reference/latest/return-actions/remove-line-items"},{"openapi":"post /warehouse/return/{id}/cancel","title":"Cancel Return","href":"/api-reference/latest/return-actions/cancel-return"},{"openapi":"post /warehouse/return/{id}/flag","title":"Flag Return","href":"/api-reference/latest/return-actions/flag-return"},{"openapi":"post /warehouse/return/{id}/close","title":"Close Return","href":"/api-reference/latest/return-actions/close-return"},{"openapi":"get /warehouse/return/{id}/notes","title":"Get Return Notes","href":"/api-reference/latest/return-actions/get-return-notes"},{"openapi":"post /warehouse/return/{id}/note","title":"Create Return Note","href":"/api-reference/latest/return-actions/create-return-note"},{"openapi":"post /order/link","title":"Create Return Deep Link","href":"/api-reference/latest/return-actions/create-return-deep-link"},{"openapi":"post /order/qr","title":"Create Return Deep Link with QR Code","href":"/api-reference/latest/return-actions/create-return-deep-link-with-qr-code"}]},{"group":"Return Data","pages":[{"openapi":"get /warehouse/return/list","title":"Detailed Returns List","href":"/api-reference/latest/return-data/detailed-returns-list"},{"openapi":"get /warehouse/return/details","title":"Get Return Details","href":"/api-reference/latest/return-data/get-return-details"},{"openapi":"get /warehouse/reporting/asn","title":"Advanced Shipping Notice","href":"/api-reference/latest/return-data/advanced-shipping-notice"}]},{"group":"Programmatic Webhooks","pages":[{"openapi":"get /webhooks","title":"Get Webhooks","href":"/api-reference/latest/programmatic-webhooks/get-webhooks"},{"openapi":"post /webhooks","title":"Create Webhook","href":"/api-reference/latest/programmatic-webhooks/create-webhook"},{"openapi":"put /webhooks/{id}","title":"Update Webhook","href":"/api-reference/latest/programmatic-webhooks/update-webhook"},{"openapi":"delete /webhooks/{id}","title":"Delete Webhook","href":"/api-reference/latest/programmatic-webhooks/delete-webhook"}]},{"group":"Item Grading and Dispositioning","pages":[{"openapi":"post /dispositioning/grade","title":"Grade Items","href":"/api-reference/latest/item-grading-and-disposition/grade-items"},{"openapi":"post /dispositioning/assess","title":"Assess Dispositions","href":"/api-reference/latest/item-grading-and-disposition/assess-dispositions"}]},{"group":"Cart","pages":[{"openapi":"post /cart","title":"Create Cart","href":"/api-reference/latest/cart/create-cart"},{"openapi":"get /cart/{token}","title":null,"href":"/api-reference/latest/cart/get-cart"},{"openapi":"post /cart/{token}","title":null,"href":"/api-reference/latest/cart/update-cart"},{"openapi":"delete /cart/{token}","title":null,"href":"/api-reference/latest/cart/delete-cart"}]},{"group":"Destinations","pages":[{"openapi":"get /destinations","title":"Get All Destinations","href":"/api-reference/latest/destinations/get-all-destinations"},{"openapi":"post /destinations","title":"Create Destination","href":"/api-reference/latest/destinations/create-destination"},{"openapi":"get /destinations/{id}","title":"Get Destination Details","href":"/api-reference/latest/destinations/get-destination-details"},{"openapi":"put /destinations/{id}","title":"Update Destination","href":"/api-reference/latest/destinations/update-destination"},{"openapi":"delete /destinations/{id}","title":"Delete Destination","href":"/api-reference/latest/destinations/delete-destination"}]},{"group":"Blocklist","pages":[{"openapi":"get /blocklists","title":"List Blocklist Items","href":"/api-reference/latest/blocklist/list-blocklist-items"},{"openapi":"post /blocklists","title":"Create Blocklist Item","href":"/api-reference/latest/blocklist/create-blocklist-item"},{"openapi":"get /blocklists/{id}","title":"Get Blocklist Item","href":"/api-reference/latest/blocklist/get-blocklist-item"},{"openapi":"delete /blocklists/{id}","title":"Delete Blocklist Item","href":"/api-reference/latest/blocklist/delete-blocklist-item"}]},{"group":"Allowlist","pages":[{"openapi":"get /allowlists","title":"List Allowlist Items","href":"/api-reference/latest/allowlist/list-allowlist-items"},{"openapi":"post /allowlists","title":"Create Allowlist Item","href":"/api-reference/latest/allowlist/create-allowlist-item"},{"openapi":"get /allowlists/{id}","title":"Get Allowlist Item","href":"/api-reference/latest/allowlist/get-allowlist-item"},{"openapi":"delete /allowlists/{id}","title":"Delete Allowlist Item","href":"/api-reference/latest/allowlist/delete-allowlist-item"}]},{"group":"Fraud Reports","pages":[{"openapi":"post /returns/{id}/fraud-report","title":"Create Fraud Report","href":"/api-reference/latest/return-actions/create-fraud-report"}]},{"group":"Order Return Eligibility","pages":[{"openapi":"post /orders/return-eligibility","title":"Look Up Order Return Eligibility by Order Name","href":"/api-reference/latest/orders/look-up-order-return-eligibility"}]},{"group":"Happy Returns Shipments","pages":[{"openapi":"get /happy-returns/shipments/{happy_returns_shipment_id}","title":"Get Shipment Information","href":"/api-reference/latest/happy-returns-shipment/get-shipment-information"},{"openapi":"get /happy-returns/shipments","title":"Get Shipments","href":"/api-reference/latest/happy-returns-shipment/get-shipments"},{"openapi":"get /happy-returns/shipments/{id}/items","title":"Get Shipment Items","href":"/api-reference/latest/happy-returns-shipment-items/get-shipment-items"}]},{"group":"Label Requests","pages":[{"openapi":"get /label-requests","title":"List Label Requests","href":"/api-reference/latest/label-requests/list-label-requests"},{"openapi":"get /label-requests/{id}","title":"Get Label Request","href":"/api-reference/latest/label-requests/get-label-request"},{"openapi":"post /label-requests/{id}/errors","title":"Create Label Request Error","href":"/api-reference/latest/label-requests/create-a-label-request-error"},{"openapi":"post /labels","title":"Create Label","href":"/api-reference/latest/label-requests/create-label"},{"openapi":"post /returns/{returnId}/labels","title":"Generate Label","href":"/api-reference/latest/label-requests/generate-label"},{"openapi":"put /labels/{id}","title":"Update Label Status","href":"/api-reference/latest/label-requests/update-label-status"}]},{"group":"Return Create (HAL-Forms)","pages":[{"title":"Draft Returns (HAL Forms)","version":"2026-10","href":"/api-reference/2026-10/draft-returns/overview"},{"openapi":"draft-returns-hal-forms get /draft-returns","title":"List Draft Returns","href":"/api-reference/2026-10/draft-returns/list-draft-returns"},{"openapi":"draft-returns-hal-forms get /draft-returns/{draft_return_id}","title":"Get Draft Return","href":"/api-reference/2026-10/draft-returns/get-draft-return"},{"openapi":"draft-returns-hal-forms get /draft-returns/{draft_return_id}/order/items","title":"List Order Line Items","href":"/api-reference/2026-10/draft-returns/list-order-line-items"},{"openapi":"draft-returns-hal-forms get /draft-returns/{draft_return_id}/totals","title":"Get Draft Return Totals","href":"/api-reference/2026-10/draft-returns/get-draft-return-totals"},{"openapi":"draft-returns-hal-forms post /draft-returns","title":"Initialize Draft Return","href":"/api-reference/2026-10/draft-returns/initialize-draft-return"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/accept-return-policy","title":"Accept Return Policy","href":"/api-reference/2026-10/draft-returns/accept-return-policy"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/cancel","title":"Cancel Draft Return","href":"/api-reference/2026-10/draft-returns/cancel-draft-return"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/customer","title":"Set Customer","href":"/api-reference/2026-10/draft-returns/set-customer"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/address","title":"Set Address","href":"/api-reference/2026-10/draft-returns/set-address"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/returning-items","title":"Add Returning Item","href":"/api-reference/2026-10/draft-returns/add-returning-item"},{"openapi":"draft-returns-hal-forms delete /draft-returns/{draft_return_id}/returning-items/{returning_item_id}","title":"Remove Returning Item","href":"/api-reference/2026-10/draft-returns/remove-returning-item"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/returning-items/{returning_item_id}/return-reason","title":"Set Returning Item Return Reason","href":"/api-reference/2026-10/draft-returns/set-returning-item-return-reason"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/returning-items/{returning_item_id}/user-input/{user_input_id}","title":"Add Returning Item User Input","href":"/api-reference/2026-10/draft-returns/add-returning-item-user-input"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/returning-items/{returning_item_id}/return-type","title":"Set Returning Item Return Type","href":"/api-reference/2026-10/draft-returns/set-returning-item-return-type"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/returning-items/{returning_item_id}/exchange-item","title":"Add Returning Item Exchange Item","href":"/api-reference/2026-10/draft-returns/add-returning-item-exchange-item"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/cart/items","title":"Add Cart Item","href":"/api-reference/2026-10/draft-returns/add-cart-item"},{"openapi":"draft-returns-hal-forms delete /draft-returns/{draft_return_id}/cart/items/{cart_item_id}","title":"Remove Cart Item","href":"/api-reference/2026-10/draft-returns/remove-cart-item"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/credit-type","title":"Set Credit Type","href":"/api-reference/2026-10/draft-returns/set-credit-type"},{"openapi":"draft-returns-hal-forms delete /draft-returns/{draft_return_id}/credit-type","title":"Unset Credit Type","href":"/api-reference/2026-10/draft-returns/unset-credit-type"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/processing-type","title":"Set Processing Type","href":"/api-reference/2026-10/draft-returns/set-processing-type"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/finalize-items","title":"Finalize Items","href":"/api-reference/2026-10/draft-returns/finalize-items"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/unfinalize-items","title":"Unfinalize Items","href":"/api-reference/2026-10/draft-returns/unfinalize-items"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/return-method","title":"Select Return Method","href":"/api-reference/2026-10/draft-returns/select-return-method"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/return-method/carrier","title":"Select Return Method Carrier","href":"/api-reference/2026-10/draft-returns/select-return-method-carrier"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/language","title":"Set Language","href":"/api-reference/2026-10/draft-returns/set-language"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/cart","title":"Set Cart","href":"/api-reference/2026-10/draft-returns/set-cart"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/payment-intent","title":"Create Payment Intent","href":"/api-reference/2026-10/draft-returns/create-payment-intent"},{"openapi":"draft-returns-hal-forms delete /draft-returns/{draft_return_id}/payment-intent/{payment_intent_id}","title":"Remove Payment Intent","description":"Removes a payment intent from the draft return.\n","href":"/api-reference/2026-10/draft-returns/remove-payment-intent"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/submit","title":"Submit Draft Return","href":"/api-reference/2026-10/draft-returns/submit-draft-return"}]},{"group":"Commerce Data","pages":[{"group":"Products","pages":[{"openapi":"get /products","title":"List Products","description":"Retrieve a list of products. The list can be filtered, sorted, and paginated using the body parameters below.","href":"/api-reference/latest/products/list-products"},{"openapi":"post /products","title":"Create Product","href":"/api-reference/latest/products/create-product"},{"openapi":"put /products","title":"Upsert Product","href":"/api-reference/latest/products/upsert-product"},{"openapi":"get /products/{id}","title":"Get Product","href":"/api-reference/latest/products/get-product"},{"openapi":"get /products/external/{externalId}","title":"Get Product by External ID","href":"/api-reference/latest/products/get-product-by-external-id"},{"openapi":"put /products/{id}","title":"Update Product","href":"/api-reference/latest/products/update-product"},{"openapi":"delete /products/{id}","title":"Delete Product","href":"/api-reference/latest/products/delete-product"},{"openapi":"delete /products/external/{externalId}","title":"Delete Product by External ID","href":"/api-reference/latest/products/delete-product-by-external-id"},{"openapi":"get /products/{productId}/product-variants","title":"List Product Variants","href":"/api-reference/latest/products/list-product-variants"},{"openapi":"post /products/{productId}/product-variants","title":"Create Product Variant","href":"/api-reference/latest/products/create-product-variant"},{"openapi":"put /products/{productId}/product-variants","title":"Upsert Product Variant","href":"/api-reference/latest/products/upsert-product-variant"},{"openapi":"put /products/external/{productExternalId}/product-variants","title":"Upsert Product Variant by Product External ID","href":"/api-reference/latest/products/upsert-product-variant-by-product-external-id"},{"openapi":"get /products/{productId}/product-variants/{id}","title":"Get Product Variant","href":"/api-reference/latest/products/get-product-variant"},{"openapi":"get /products/external/{productExternalId}/product-variants/{externalId}","title":"Get Product Variant by External ID","href":"/api-reference/latest/products/get-product-variant-by-external-id"},{"openapi":"patch /products/{productId}/product-variants/{id}","title":"Update Product Variant","href":"/api-reference/latest/products/update-product-variant"},{"openapi":"delete /products/{productId}/product-variants/{id}","title":"Delete Product Variant","href":"/api-reference/latest/products/delete-product-variant"},{"openapi":"delete /products/external/{productExternalId}/product-variants/{externalId}","title":"Delete Product Variant by External ID","href":"/api-reference/latest/products/delete-product-variant-by-external-id"}]},{"group":"Orders","pages":[{"openapi":"get /orders","title":"List Orders","href":"/api-reference/latest/orders/list-orders"},{"openapi":"openapi/orders-api.yaml post /orders","title":"Create Order","href":"/api-reference/latest/orders/create-order"},{"openapi":"openapi/orders-api.yaml put /orders","title":"Upsert Order","href":"/api-reference/latest/orders/upsert-order"},{"openapi":"get /orders/{id}","title":"Get Order","href":"/api-reference/latest/orders/get-order"},{"openapi":"get /orders/external/{externalId}","title":"Get Order by External ID","href":"/api-reference/latest/orders/get-order-by-external-id"},{"openapi":"openapi/orders-api.yaml put /orders/{id}","title":"Update Order","href":"/api-reference/latest/orders/update-order"},{"openapi":"delete /orders/{id}","title":"Delete Order","href":"/api-reference/latest/orders/delete-order"},{"openapi":"delete /orders/external/{externalId}","title":"Delete Order by External ID","href":"/api-reference/latest/orders/delete-order-by-external-id"}]},{"group":"Customers","pages":[{"openapi":"get /customers","title":"List Customers","href":"/api-reference/latest/customers/list-customers"},{"openapi":"post /customers","title":"Create Customer","href":"/api-reference/latest/customers/create-customer"},{"openapi":"put /customers","title":"Upsert Customer","href":"/api-reference/latest/customers/upsert-customer"},{"openapi":"get /customers/{id}","title":"Get Customer","href":"/api-reference/latest/customers/get-customer"},{"openapi":"get /customers/external/{externalId}","title":"Get Customer by External ID","href":"/api-reference/latest/customers/get-customer-by-external-id"},{"openapi":"put /customers/{id}","title":"Update Customer","href":"/api-reference/latest/customers/update-customer"},{"openapi":"delete /customers/{id}","title":"Delete Customer","href":"/api-reference/latest/customers/delete-customer"},{"openapi":"delete /customers/external/{externalId}","title":"Delete Customer by External ID","href":"/api-reference/latest/customers/delete-customer-by-external-id"}]},{"group":"Locations","pages":[{"openapi":"get /locations","title":"List Locations","href":"/api-reference/latest/locations/list-locations"},{"openapi":"post /locations","title":"Create Location","href":"/api-reference/latest/locations/create-location"},{"openapi":"put /locations","title":"Upsert Location","href":"/api-reference/latest/locations/upsert-location"},{"openapi":"get /locations/{id}","title":"Get Location","href":"/api-reference/latest/locations/get-location"},{"openapi":"get /locations/external/{externalId}","title":"Get Location by External ID","href":"/api-reference/latest/locations/get-location-by-external-id"},{"openapi":"put /locations/{id}","title":"Update Location","href":"/api-reference/latest/locations/update-location"},{"openapi":"delete /locations/{id}","title":"Delete Location","href":"/api-reference/latest/locations/delete-location"},{"openapi":"delete /locations/external/{externalId}","title":"Delete Location by External ID","href":"/api-reference/latest/locations/delete-location-by-external-id"}]},{"group":"Inventories","pages":[{"openapi":"get /inventories","title":"List Inventories","href":"/api-reference/latest/inventories/list-inventories"},{"openapi":"post /inventories/{productVariantId}/{locationId}","title":"Upsert Inventory","href":"/api-reference/latest/inventories/create-inventory"},{"openapi":"put /inventories/{productVariantId}/{locationId}","title":"Upsert Inventory","href":"/api-reference/latest/inventories/upsert-inventory"},{"openapi":"put /inventories/external/{variantExternalId}/{locationExternalId}","title":"Upsert Inventory by External IDs","href":"/api-reference/latest/inventories/upsert-inventory-by-external-ids"},{"openapi":"get /inventories/{productVariantId}/{locationId}","title":"Get Inventory","href":"/api-reference/latest/inventories/get-inventory"},{"openapi":"get /inventories/external/{variantExternalId}/{locationExternalId}","title":"Get Inventory by External IDs","href":"/api-reference/latest/inventories/get-inventory-by-external-ids"},{"openapi":"delete /inventories/{productVariantId}/{locationId}","title":"Delete Inventory","href":"/api-reference/latest/inventories/delete-inventory"},{"openapi":"delete /inventories/external/{variantExternalId}/{locationExternalId}","title":"Delete Inventory by External IDs","href":"/api-reference/latest/inventories/delete-inventory-by-external-ids"}]},{"group":"Collections","pages":[{"openapi":"get /collections","title":"List Collections","href":"/api-reference/latest/collections/list-collections"},{"openapi":"post /collections","title":"Create Collection","href":"/api-reference/latest/collections/create-collection"},{"openapi":"put /collections","title":"Upsert Collection","href":"/api-reference/latest/collections/upsert-collection"},{"openapi":"get /collections/{id}","title":"Get Collection","href":"/api-reference/latest/collections/get-collection"},{"openapi":"get /collections/external/{externalId}","title":"Get Collection by External ID","href":"/api-reference/latest/collections/get-collection-by-external-id"},{"openapi":"put /collections/{id}","title":"Update Collection","href":"/api-reference/latest/collections/update-collection"},{"openapi":"delete /collections/{id}","title":"Delete Collection","href":"/api-reference/latest/collections/delete-collection"},{"openapi":"delete /collections/external/{externalId}","title":"Delete Collection by External ID","href":"/api-reference/latest/collections/delete-collection-by-external-id"},{"openapi":"post /collections/{id}/products/{productId}","title":"Add Product to Collection","href":"/api-reference/latest/collections/add-product-to-collection"},{"openapi":"delete /collections/{id}/products/{productId}","title":"Delete Product from Collection","href":"/api-reference/latest/collections/delete-product-from-collection"},{"openapi":"post /collections/external/{collectionExternalId}/products/external/{productExternalId}","title":"Add Product to Collection by External ID","href":"/api-reference/latest/collections/add-product-to-collection-by-external-id"},{"openapi":"delete /collections/external/{collectionExternalId}/products/external/{productExternalId}","title":"Delete Product from Collection by External ID","href":"/api-reference/latest/collections/delete-product-from-collection-by-external-id"}]},{"group":"Bulk Operations","pages":[{"openapi":"post /bulk-operations","title":"Create Bulk Operation","href":"/api-reference/latest/bulk-operations/create-bulk-operation"},{"openapi":"get /bulk-operations","title":"List Bulk Operations","href":"/api-reference/latest/bulk-operations/list-bulk-operations"},{"openapi":"get /bulk-operations/{id}","title":"Get Bulk Operation","href":"/api-reference/latest/bulk-operations/get-bulk-operation"},{"openapi":"get /bulk-operations/{id}/jobs","title":"List Bulk Operation Jobs","href":"/api-reference/latest/bulk-operations/list-bulk-operation-jobs"}]}]}]}]},{"tab":"Webhook Reference","pages":[{"title":"Webhook Reference","href":"/webhook-reference/getting-started"}]}]}]},"title":"Submit Draft Return - Loop Returns Documentation","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-26-lDe7V.js","utils-CWQmgYtH.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-4-Aw3rSD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C2zjXYA5.js","snippetPresets-DFmpFA7C.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-FJpQavWq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D_GvPF7k.js","shallow-Bs2ZB0NO.js","getApiPlaygroundDisplay-DCcqJJk-.js","CodeSnippet-DzDxawVe.js","CodeSnippets-aUr7fU-7.js","Page-CT9uE8Ip.js","getPastedJson-Y1fKsj_I.js","icon-DI4zTsDr.js","MethodPill-C0nDlmSQ.js","DuplicateIcon-NUXbx2nQ.js","createIcon-BdTHrPAi.js","DynamicMarkdown-CtpgKJwj.js","SectionHeading-B3x35tOt.js","axios-vUo_bRtp.js","Markdown-3OmurJMP.js","clsx-DMKzROTp.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-1ms6tsT-.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Ke9xIMFx.js"]}