The status query parameter accepts exactly three values — issued, cancelled, or
fulfilled. There is no separate status for a request that has reported an error: a
label request with one or more entries in its errors array remains issued and will
keep appearing in status=issued results until it is fulfilled or cancelled. An
integration that polls this endpoint should track which ids it has already reported
errors for, since the status alone will not reveal that — though each returned
LabelRequestResponse does carry that errors array, so a poller can also detect an
already-errored request directly from the payload.
Returns label requests after or equal to a minimum date.
A date-time value in ISO 8601 format. What it represents (for example, when a label,
label request, or reported error was created, or a date-range filter bound) depends on
the field or parameter referencing this schema.
Returns label requests before a maximum date.
A date-time value in ISO 8601 format. What it represents (for example, when a label,
label request, or reported error was created, or a date-range filter bound) depends on
the field or parameter referencing this schema.
{"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":"6aeca26621aa22f79f8e3517","collectionId":"dc0f7af0-e5b9-46ae-900e-ed1f575f606c","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aeca26621aa22f79f8e3517"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aee02e9b56b944fc2811a93","clientVersion":"0.0.4074","searchFilterCounts":[{"language":"default","tag":"API Reference","count":177},{"language":"default","tag":"APIs","count":169},{"language":"default","tag":"Commerce Data","count":69},{"language":"default","tag":"Return Create","count":52},{"language":"default","tag":"Guides","count":30},{"language":"default","tag":"Products","count":17},{"language":"default","tag":"Webhook Reference","count":14},{"language":"default","tag":"Collections","count":12},{"language":"default","tag":"Orders","count":11},{"language":"default","tag":"MCP Server","count":10}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/latest/label-requests/list-label-requests","slug":"/api-reference/latest/label-requests/list-label-requests","pageMetadata":{"openapi":"get /label-requests","title":"List Label Requests","description":"Retrieve a list of label requests.\n\nThe `status` query parameter accepts exactly three values — `issued`, `cancelled`, or\n`fulfilled`. There is no separate status for a request that has reported an error: a\nlabel request with one or more entries in its `errors` array remains `issued` and will\nkeep appearing in `status=issued` results until it is fulfilled or cancelled. An\nintegration that polls this endpoint should track which ids it has already reported\nerrors for, since the status alone will not reveal that — though each returned\n`LabelRequestResponse` does carry that `errors` array, so a poller can also detect an\nalready-errored request directly from the payload.\n\n#### Required API key scope\n- Label Requests (Read)\n","href":"/api-reference/latest/label-requests/list-label-requests"},"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 h4: \"h4\",\n li: \"li\",\n p: \"p\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Retrieve a list of label requests.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"The \", _jsx(_components.code, {\n children: \"status\"\n }), \" query parameter accepts exactly three values — \", _jsx(_components.code, {\n children: \"issued\"\n }), \", \", _jsx(_components.code, {\n children: \"cancelled\"\n }), \", or\\n\", _jsx(_components.code, {\n children: \"fulfilled\"\n }), \". There is no separate status for a request that has reported an error: a\\nlabel request with one or more entries in its \", _jsx(_components.code, {\n children: \"errors\"\n }), \" array remains \", _jsx(_components.code, {\n children: \"issued\"\n }), \" and will\\nkeep appearing in \", _jsx(_components.code, {\n children: \"status=issued\"\n }), \" results until it is fulfilled or cancelled. An\\nintegration that polls this endpoint should track which ids it has already reported\\nerrors for, since the status alone will not reveal that — though each returned\\n\", _jsx(_components.code, {\n children: \"LabelRequestResponse\"\n }), \" does carry that \", _jsx(_components.code, {\n children: \"errors\"\n }), \" array, so a poller can also detect an\\nalready-errored request directly from the payload.\"]\n }), \"\\n\", _jsx(_components.h4, {\n children: \"Required API key scope\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Label Requests (Read)\"\n }), \"\\n\"]\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":"get /label-requests","title":"List Label Requests","description":"Retrieve a list of label requests.\n\nThe `status` query parameter accepts exactly three values — `issued`, `cancelled`, or\n`fulfilled`. There is no separate status for a request that has reported an error: a\nlabel request with one or more entries in its `errors` array remains `issued` and will\nkeep appearing in `status=issued` results until it is fulfilled or cancelled. An\nintegration that polls this endpoint should track which ids it has already reported\nerrors for, since the status alone will not reveal that — though each returned\n`LabelRequestResponse` does carry that `errors` array, so a poller can also detect an\nalready-errored request directly from the payload.\n\n#### Required API key scope\n- Label Requests (Read)\n","href":"/api-reference/latest/label-requests/list-label-requests"}}},"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":"List Label Requests","description":"Retrieve a list of label requests.\n\nThe `status` query parameter accepts exactly three values — `issued`, `cancelled`, or\n`fulfilled`. There is no separate status for a request that has reported an error: a\nlabel request with one or more entries in its `errors` array remains `issued` and will\nkeep appearing in `status=issued` results until it is fulfilled or cancelled. An\nintegration that polls this endpoint should track which ids it has already reported\nerrors for, since the status alone will not reveal that — though each returned\n`LabelRequestResponse` does carry that `errors` array, so a poller can also detect an\nalready-errored request directly from the payload.\n\n#### Required API key scope\n- Label Requests (Read)\n","operationId":"list-label-requests","tags":["Label Requests"],"security":["39387ac9-8c4d-4ac9-9358-e677492432cf","c706bb8e-44ae-4c0e-903b-f35c96314be9"],"responses":{"200":"972f5ed5-f4ac-4f1c-94be-dd36bd0112cf","401":"6a398f9b-45bd-4e36-bbb6-20cdda6c1be0","404":"78da3df9-71d3-46bd-9e44-b0b23d70aef0"},"parameters":["71c91253-4f47-4ffd-9af2-7520703b73d0","23a96cb6-6ffe-43ec-a50e-89489634af26","7bd6dc2d-a961-4330-bf26-4cbd6a1f1410","3f6f9485-bea8-4b95-be6e-c63c13281dcd","226773f0-bbb6-458a-b3a8-811703efbf12","f3fc1186-393c-4188-bd37-c5e60d8b71e3"],"method":"get","type":"path","servers":["2c7f2530-dae5-4086-80c8-a042649521e1","a60c1cd7-c364-4c22-aa05-c00426b21f6e","09e01929-e9d1-4397-9158-7a3d793c1ec0"],"path":"/label-requests","baseUrlOptions":["https://api.loopreturns.com/api/2026-10","https://api.loopreturns.com/api/2026-07","https://api.loopreturns.com/api/unstable"],"title":"List Label Requests","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"71c91253-4f47-4ffd-9af2-7520703b73d0":{"in":"query","name":"from","description":"Returns label requests after or equal to a minimum date.","schema":{"type":"string","description":"Returns label requests after or equal to a minimum date.\nA date-time value in ISO 8601 format. What it represents (for example, when a label,\nlabel request, or reported error was created, or a date-range filter bound) depends on\nthe field or parameter referencing this schema.\n","format":"date-time","example":"2023-04-25T13:25:00-05:00","uniqueKey":"","typeLabel":"string\u003cdate-time>"}},"23a96cb6-6ffe-43ec-a50e-89489634af26":{"in":"query","name":"to","description":"Returns label requests before a maximum date.","schema":{"type":"string","description":"Returns label requests before a maximum date.\nA date-time value in ISO 8601 format. What it represents (for example, when a label,\nlabel request, or reported error was created, or a date-range filter bound) depends on\nthe field or parameter referencing this schema.\n","format":"date-time","example":"2023-04-25T13:25:00-05:00","uniqueKey":"","typeLabel":"string\u003cdate-time>"}},"7bd6dc2d-a961-4330-bf26-4cbd6a1f1410":{"in":"query","name":"return_id","description":"Return label requests associated with a specific return_id.","schema":{"type":"integer","example":67329889100573,"description":"Return label requests associated with a specific return_id.","uniqueKey":"","typeLabel":"integer"}},"3f6f9485-bea8-4b95-be6e-c63c13281dcd":{"in":"query","name":"status","schema":{"type":"string","description":"The status of the label request.","enum":["issued","cancelled","fulfilled"],"example":"issued","uniqueKey":"","typeLabel":"enum\u003cstring>"}},"226773f0-bbb6-458a-b3a8-811703efbf12":{"in":"query","name":"limit","description":"The per page limit of label requests to return","schema":{"type":"integer","default":50,"minimum":0,"maximum":250,"description":"The per page limit of label requests to return","uniqueKey":"","typeLabel":"integer"}},"f3fc1186-393c-4188-bd37-c5e60d8b71e3":{"in":"query","name":"offset","description":"The number of label requests to offset.","schema":{"type":"integer","minimum":0,"description":"The number of label requests to offset.","uniqueKey":"","typeLabel":"integer"}}},"responses":{"972f5ed5-f4ac-4f1c-94be-dd36bd0112cf":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","required":["id","addresses","parcel","products","errors","return_id","shop_id","status","created_at"],"properties":{"id":{"type":"string","description":"The unique identifier for the label request, created by Loop. Note that this\nfield is serialized as a string here, while the `id` path parameter (for example\non `GET /label-requests/{id}`) and `CreateLabelRequest.label_request_id` are\nintegers — callers should not assume a single JSON type for this identifier\nacross calls.\n","example":"67329889100573","isRequired":true,"uniqueKey":"data.items.[INDEX].id","typeLabel":"string"},"addresses":{"type":"object","required":["origin","destination"],"properties":{"origin":{"type":"object","properties":{"address1":{"type":"string","maxLength":125,"description":"The recipient's street address.","isRequired":true,"uniqueKey":"data.items.[INDEX].addresses.origin.address1","typeLabel":"string"},"city":{"type":"string","maxLength":100,"description":"The city in which the address is located.","isRequired":true,"uniqueKey":"data.items.[INDEX].addresses.origin.city","typeLabel":"string"},"zip":{"type":"string","maxLength":16,"description":"The postal code associated with the address.","isRequired":true,"uniqueKey":"data.items.[INDEX].addresses.origin.zip","typeLabel":"string"},"country":{"type":"string","maxLength":100,"description":"The country in which the address is located.","isRequired":true,"uniqueKey":"data.items.[INDEX].addresses.origin.country","typeLabel":"string"},"country_code":{"type":"string","maxLength":2,"description":"The two-letter country code associated with the address.","isRequired":true,"uniqueKey":"data.items.[INDEX].addresses.origin.country_code","typeLabel":"string"},"name":{"oneOf":[{"type":"string","maxLength":100,"description":"The recipient's name.","uniqueKey":"data.items.[INDEX].addresses.origin.name.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":100,"description":"The recipient's name.","uniqueKey":"data.items.[INDEX].addresses.origin.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].addresses.origin.name","typeLabel":"string | null"},"company":{"oneOf":[{"type":"string","maxLength":100,"description":"The recipient's company.","uniqueKey":"data.items.[INDEX].addresses.origin.company.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":100,"description":"The recipient's company.","uniqueKey":"data.items.[INDEX].addresses.origin.company.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].addresses.origin.company","typeLabel":"string | null"},"address2":{"oneOf":[{"type":"string","maxLength":125,"description":"The recipient's secondary address details (such as unit number or PO box information).","uniqueKey":"data.items.[INDEX].addresses.origin.address2.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":125,"description":"The recipient's secondary address details (such as unit number or PO box information).","uniqueKey":"data.items.[INDEX].addresses.origin.address2.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].addresses.origin.address2","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","maxLength":100,"description":"The state or region in which the address is located.","uniqueKey":"data.items.[INDEX].addresses.origin.state.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":100,"description":"The state or region in which the address is located.","uniqueKey":"data.items.[INDEX].addresses.origin.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].addresses.origin.state","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","description":"The phone number associated with the address.","uniqueKey":"data.items.[INDEX].addresses.origin.phone.oneOf.0","typeLabel":"string"},{"type":"null","description":"The phone number associated with the address.","uniqueKey":"data.items.[INDEX].addresses.origin.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].addresses.origin.phone","typeLabel":"string | null"}},"required":["address1","city","zip","country","country_code"],"example":{"name":"John Smith","company":"Acme, Co","address1":"123 Example St","address2":"Box 123","city":"Columbus","state":"OH","zip":"12345","country":"United States of America","country_code":"US","phone":"+1 555-555-5555"},"isRequired":true,"uniqueKey":"data.items.[INDEX].addresses.origin","typeLabel":"object"},"destination":{"type":"object","properties":{"address1":{"type":"string","maxLength":125,"description":"The recipient's street address.","isRequired":true,"uniqueKey":"data.items.[INDEX].addresses.destination.address1","typeLabel":"string"},"city":{"type":"string","maxLength":100,"description":"The city in which the address is located.","isRequired":true,"uniqueKey":"data.items.[INDEX].addresses.destination.city","typeLabel":"string"},"zip":{"type":"string","maxLength":16,"description":"The postal code associated with the address.","isRequired":true,"uniqueKey":"data.items.[INDEX].addresses.destination.zip","typeLabel":"string"},"country":{"type":"string","maxLength":100,"description":"The country in which the address is located.","isRequired":true,"uniqueKey":"data.items.[INDEX].addresses.destination.country","typeLabel":"string"},"country_code":{"type":"string","maxLength":2,"description":"The two-letter country code associated with the address.","isRequired":true,"uniqueKey":"data.items.[INDEX].addresses.destination.country_code","typeLabel":"string"},"name":{"oneOf":[{"type":"string","maxLength":100,"description":"The recipient's name.","uniqueKey":"data.items.[INDEX].addresses.destination.name.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":100,"description":"The recipient's name.","uniqueKey":"data.items.[INDEX].addresses.destination.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].addresses.destination.name","typeLabel":"string | null"},"company":{"oneOf":[{"type":"string","maxLength":100,"description":"The recipient's company.","uniqueKey":"data.items.[INDEX].addresses.destination.company.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":100,"description":"The recipient's company.","uniqueKey":"data.items.[INDEX].addresses.destination.company.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].addresses.destination.company","typeLabel":"string | null"},"address2":{"oneOf":[{"type":"string","maxLength":125,"description":"The recipient's secondary address details (such as unit number or PO box information).","uniqueKey":"data.items.[INDEX].addresses.destination.address2.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":125,"description":"The recipient's secondary address details (such as unit number or PO box information).","uniqueKey":"data.items.[INDEX].addresses.destination.address2.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].addresses.destination.address2","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","maxLength":100,"description":"The state or region in which the address is located.","uniqueKey":"data.items.[INDEX].addresses.destination.state.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":100,"description":"The state or region in which the address is located.","uniqueKey":"data.items.[INDEX].addresses.destination.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].addresses.destination.state","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","description":"The phone number associated with the address.","uniqueKey":"data.items.[INDEX].addresses.destination.phone.oneOf.0","typeLabel":"string"},{"type":"null","description":"The phone number associated with the address.","uniqueKey":"data.items.[INDEX].addresses.destination.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].addresses.destination.phone","typeLabel":"string | null"}},"required":["address1","city","zip","country","country_code"],"example":{"name":"John Smith","company":"Acme, Co","address1":"123 Example St","address2":"Box 123","city":"Columbus","state":"OH","zip":"12345","country":"United States of America","country_code":"US","phone":"+1 555-555-5555"},"isRequired":true,"uniqueKey":"data.items.[INDEX].addresses.destination","typeLabel":"object"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].addresses","typeLabel":"object"},"parcel":{"type":"object","required":["height","length","width","weight"],"properties":{"height":{"type":"number","format":"double","description":"The height of the parcel in inches.","example":5,"isRequired":true,"uniqueKey":"data.items.[INDEX].parcel.height","typeLabel":"number\u003cdouble>"},"length":{"type":"number","format":"double","description":"The length of the parcel in inches.","example":20.2,"isRequired":true,"uniqueKey":"data.items.[INDEX].parcel.length","typeLabel":"number\u003cdouble>"},"width":{"type":"number","format":"double","description":"The width of the parcel in inches.","example":10.9,"isRequired":true,"uniqueKey":"data.items.[INDEX].parcel.width","typeLabel":"number\u003cdouble>"},"weight":{"type":"number","format":"double","description":"The weight of the parcel in grams.","example":65.9,"isRequired":true,"uniqueKey":"data.items.[INDEX].parcel.weight","typeLabel":"number\u003cdouble>"}},"isRequired":true,"uniqueKey":"data.items.[INDEX].parcel","typeLabel":"object"},"products":{"type":"array","items":{"type":"object","required":["name","sku","price"],"properties":{"name":{"type":"string","description":"The name of the product.","example":"Product Name","isRequired":true,"uniqueKey":"data.items.[INDEX].products.items.[INDEX].name","typeLabel":"string"},"price":{"type":"object","example":[{"amount":50000,"currency":"USD"},{"amount":25000,"currency":"CAD"},{"amount":1500,"currency":"EUR"}],"properties":{"amount":{"type":"integer","format":"int32","description":"The amount represented in cents.","example":25000,"isRequired":true,"uniqueKey":"data.items.[INDEX].products.items.[INDEX].price.amount","typeLabel":"integer\u003cint32>"},"currency":{"type":"string","default":"USD","example":"EUR","description":"The 3 character (ISO 4217) currency code.","isRequired":true,"uniqueKey":"data.items.[INDEX].products.items.[INDEX].price.currency","typeLabel":"string"}},"required":["amount","currency"],"isRequired":true,"uniqueKey":"data.items.[INDEX].products.items.[INDEX].price","typeLabel":"object"},"sku":{"type":"string","description":"The SKU of the product.","example":"99999999","isRequired":true,"uniqueKey":"data.items.[INDEX].products.items.[INDEX].sku","typeLabel":"string"},"country_of_origin":{"oneOf":[{"type":"string","description":"The country of origin of the product.","example":"USA","uniqueKey":"data.items.[INDEX].products.items.[INDEX].country_of_origin.oneOf.0","typeLabel":"string"},{"type":"null","description":"The country of origin of the product.","example":"USA","uniqueKey":"data.items.[INDEX].products.items.[INDEX].country_of_origin.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].products.items.[INDEX].country_of_origin","typeLabel":"string | null"},"hs_code":{"oneOf":[{"type":"string","description":"The HS (Harmonized System) code of the product.","example":"61051000","uniqueKey":"data.items.[INDEX].products.items.[INDEX].hs_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The HS (Harmonized System) code of the product.","example":"61051000","uniqueKey":"data.items.[INDEX].products.items.[INDEX].hs_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].products.items.[INDEX].hs_code","typeLabel":"string | null"}},"uniqueKey":"data.items.[INDEX].products.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.items.[INDEX].products","typeLabel":"object[]"},"errors":{"type":"array","description":"An append-only history of errors reported for this label request via\n`POST /label-requests/{id}/errors`. Its presence does not close or cancel the\nrequest.\n","items":{"type":"object","required":["reason"],"properties":{"reason":{"type":"string","description":"The reason code associated with the label request error.","enum":["INSUFFICIENT_FUNDS","INVALID_ADDRESS","Other"],"example":"INVALID_ADDRESS","isRequired":true,"uniqueKey":"data.items.[INDEX].errors.items.[INDEX].reason","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","description":"The message associated with the label request error.","example":"Failed to generate a label, the origin address is invalid","uniqueKey":"data.items.[INDEX].errors.items.[INDEX].message.oneOf.0","typeLabel":"string"},{"type":"null","description":"The message associated with the label request error.","example":"Failed to generate a label, the origin address is invalid","uniqueKey":"data.items.[INDEX].errors.items.[INDEX].message.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].errors.items.[INDEX].message","typeLabel":"string | null"},"created_at":{"type":"string","description":"A date-time value in ISO 8601 format. What it represents (for example, when a label,\nlabel request, or reported error was created, or a date-range filter bound) depends on\nthe field or parameter referencing this schema.\n","format":"date-time","example":"2023-04-25T13:25:00-05:00","uniqueKey":"data.items.[INDEX].errors.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"data.items.[INDEX].errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.items.[INDEX].errors","typeLabel":"object[]"},"return_id":{"type":"integer","format":"int64","description":"The return id of the return.","example":1001,"isRequired":true,"uniqueKey":"data.items.[INDEX].return_id","typeLabel":"integer\u003cint64>"},"shop_id":{"type":"integer","format":"int64","description":"The id of the shop belonging to the merchant.","example":50,"isRequired":true,"uniqueKey":"data.items.[INDEX].shop_id","typeLabel":"integer\u003cint64>"},"status":{"type":"string","description":"The status of the label request.","enum":["issued","cancelled","fulfilled"],"example":"issued","isRequired":true,"uniqueKey":"data.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"created_at":{"type":"string","description":"A date-time value in ISO 8601 format. What it represents (for example, when a label,\nlabel request, or reported error was created, or a date-range filter bound) depends on\nthe field or parameter referencing this schema.\n","format":"date-time","example":"2023-04-25T13:25:00-05:00","isRequired":true,"uniqueKey":"data.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"data.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":[{"id":"67329889100573","addresses":{"origin":{"name":"John Smith","company":"Acme, Co","address1":"123 Example St","address2":"Box 123","city":"Columbus","state":"OH","zip":"12345","country":"United States of America","country_code":"US","phone":"+1 555-555-5555"},"destination":{"name":"John Smith","company":"Acme, Co","address1":"123 Example St","address2":"Box 123","city":"Columbus","state":"OH","zip":"12345","country":"United States of America","country_code":"US","phone":"+1 555-555-5555"}},"parcel":{"height":5,"length":20.2,"width":10.9,"weight":65.9},"products":[{"name":"Product Name","price":[{"amount":50000,"currency":"USD"},{"amount":25000,"currency":"CAD"},{"amount":1500,"currency":"EUR"}],"sku":"99999999","country_of_origin":"USA","hs_code":"61051000"}],"errors":[{"reason":"INVALID_ADDRESS","message":"Failed to generate a label, the origin address is invalid","created_at":"2023-04-25T13:25:00-05:00"}],"return_id":1001,"shop_id":50,"status":"issued","created_at":"2023-04-25T13:25:00-05:00"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"6a398f9b-45bd-4e36-bbb6-20cdda6c1be0":{"description":"The request could not be authorized.","content":{"application/json":{"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"string","example":"Unauthorized.","isRequired":true,"uniqueKey":"errors","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":"Unauthorized."}}},"exampleType":"generated"}},"exampleType":"generated"},"78da3df9-71d3-46bd-9e44-b0b23d70aef0":{"description":"The requested entity could not be found.","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","example":"Resource not found.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Resource not found."}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"39387ac9-8c4d-4ac9-9358-e677492432cf":{"oauth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://oauth.loopreturns.com/authorize","tokenUrl":"https://oauth.loopreturns.com/oauth/token","scopes":{"labels:read":"Read access to labels","labels:write":"Create and modify labels","label_requests:read":"Read access to label requests","label_requests:write":"Create and modify label requests","returns":"Access to returns operations"}}},"scopes":["label_requests:read"],"schemeName":"oauth2"}},"c706bb8e-44ae-4c0e-903b-f35c96314be9":{"label-requests-read":{"type":"apiKey","in":"header","name":"X-Authorization","description":"API Scope: \"Label Requests (read)\"","x-scope":"Label Requests (Read)","scopes":[],"schemeName":"label-requests-read"}}},"servers":{"2c7f2530-dae5-4086-80c8-a042649521e1":{"url":"https://api.loopreturns.com/api/2026-10","description":"2026-10 (Stable)"},"a60c1cd7-c364-4c22-aa05-c00426b21f6e":{"url":"https://api.loopreturns.com/api/2026-07","description":"2026-07"},"09e01929-e9d1-4397-9158-7a3d793c1ec0":{"url":"https://api.loopreturns.com/api/unstable","description":"Unstable (Preview)"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://oauth.loopreturns.com/authorize","tokenUrl":"https://oauth.loopreturns.com/oauth/token","scopes":{"labels:read":"Read access to labels","labels:write":"Create and modify labels","label_requests:read":"Read access to label requests","label_requests:write":"Create and modify label requests","returns":"Access to returns operations"}}},"scopes":["label_requests:read"],"schemeName":"oauth2"},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"The access token received from the authorization server in the OAuth 2.0 flow.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"oauth2","name":"Authorization"}],"title":"oauth2"},{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-Authorization","description":"API Scope: \"Label Requests (read)\"","x-scope":"Label Requests (Read)","scopes":[],"schemeName":"label-requests-read"},"schema":{"title":"X-Authorization","type":"string","description":"API Scope: \"Label Requests (read)\"","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"label-requests-read","name":"X-Authorization"}],"title":"label-requests-read"}]},"originalFileLocation":"openapi/labels-api.yaml"},"subdomain":"loopreturns","siteName":"Loop Returns Documentation","title":"List Label Requests - Loop Returns Documentation","navMaps":{"firstHrefInVersion":{"2026-07":{"href":"/api-reference/latest/label-requests/list-label-requests","matchLevel":0},"2026-10":{"href":"/api-reference/latest/label-requests/list-label-requests","matchLevel":0},"unstable":{"href":"/api-reference/latest/label-requests/list-label-requests","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-09-03T14:50:11.296Z","originalFileLocation":"api-reference/latest/label-requests/list-label-requests.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=\"Retrieve a list of label requests. The status query parameter accepts exactly three values — issued, cancelled, or fulfilled. There is no separate status for a request that has reported an error: a label request with one or more entries in its errors array remains issued and will keep appearing in status=issued results until it is fulfilled or cancelled. An integration that polls this endpoint should track which ids it has already reported errors for, since the status alone will not reveal that — though each returned LabelRequestResponse does carry that errors array, so a poller can also detect an already-errored request directly from the payload. #### Required API key scope - Label Requests (Read)\">\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=\"List Label Requests - Loop Returns Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve a list of label requests. The status query parameter accepts exactly three values — issued, cancelled, or fulfilled. There is no separate status for a request that has reported an error: a label request with one or more entries in its errors array remains issued and will keep appearing in status=issued results until it is fulfilled or cancelled. An integration that polls this endpoint should track which ids it has already reported errors for, since the status alone will not reveal that — though each returned LabelRequestResponse does carry that errors array, so a poller can also detect an already-errored request directly from the payload. #### Required API key scope - Label Requests (Read)\">\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/latest/label-requests/list-label-requests\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://loopreturns.mintlify.site/_mintlify/api/og/v2?division=Label+Requests\u0026amp;title=List+Label+Requests\u0026amp;description=Retrieve+a+list+of+label+requests.%0A%0AThe+%60status%60+query+parameter+accepts+exactly+three+values+%E2%80%94+%60issued%60%2C+%60cancelled%60%2C+or%0A%60fulfilled%60.+There+is+no+separate+stat\u0026amp;theme=5ccacdea69e246fe33e6ab29\u0026amp;signature=4f147f2f09e601ce2b9688e9894c7dd786dbc22d5a35acb5dab96af513dd3faf\">\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=\"List Label Requests - Loop Returns Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve a list of label requests. The status query parameter accepts exactly three values — issued, cancelled, or fulfilled. There is no separate status for a request that has reported an error: a label request with one or more entries in its errors array remains issued and will keep appearing in status=issued results until it is fulfilled or cancelled. An integration that polls this endpoint should track which ids it has already reported errors for, since the status alone will not reveal that — though each returned LabelRequestResponse does carry that errors array, so a poller can also detect an already-errored request directly from the payload. #### Required API key scope - Label Requests (Read)\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://loopreturns.mintlify.site/_mintlify/api/og/v2?division=Label+Requests\u0026amp;title=List+Label+Requests\u0026amp;description=Retrieve+a+list+of+label+requests.%0A%0AThe+%60status%60+query+parameter+accepts+exactly+three+values+%E2%80%94+%60issued%60%2C+%60cancelled%60%2C+or%0A%60fulfilled%60.+There+is+no+separate+stat\u0026amp;theme=5ccacdea69e246fe33e6ab29\u0026amp;signature=4f147f2f09e601ce2b9688e9894c7dd786dbc22d5a35acb5dab96af513dd3faf\">\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/latest/label-requests/list-label-requests\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/latest/label-requests/list-label-requests.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/latest/label-requests/list-label-requests#webpage\",\"url\":\"https://docs.loopreturns.com/api-reference/latest/label-requests/list-label-requests\",\"name\":\"List Label Requests\",\"description\":\"Retrieve a list of label requests. The status query parameter accepts exactly three values — issued, cancelled, or fulfilled. There is no separate status for a request that has reported an error: a label request with one or more entries in its errors array remains issued and will keep appearing in status=issued results until it is fulfilled or cancelled. An integration that polls this endpoint should track which ids it has already reported errors for, since the status alone will not reveal that — though each returned LabelRequestResponse does carry that errors array, so a poller can also detect an already-errored request directly from the payload. #### Required API key scope - Label Requests (Read)\",\"dateModified\":\"2026-09-03T14:50:11.296Z\",\"isPartOf\":{\"@id\":\"https://docs.loopreturns.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.loopreturns.com/api-reference/latest/label-requests/list-label-requests#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.loopreturns.com/api-reference/latest/label-requests/list-label-requests#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\":\"List Label Requests\",\"item\":\"https://docs.loopreturns.com/api-reference/latest/label-requests/list-label-requests\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.loopreturns.com/api-reference/latest/label-requests/list-label-requests#apireference\",\"headline\":\"List Label Requests\",\"name\":\"List Label Requests\",\"description\":\"Retrieve a list of label requests. The status query parameter accepts exactly three values — issued, cancelled, or fulfilled. There is no separate status for a request that has reported an error: a label request with one or more entries in its errors array remains issued and will keep appearing in status=issued results until it is fulfilled or cancelled. An integration that polls this endpoint should track which ids it has already reported errors for, since the status alone will not reveal that — though each returned LabelRequestResponse does carry that errors array, so a poller can also detect an already-errored request directly from the payload. #### Required API key scope - Label Requests (Read)\",\"url\":\"https://docs.loopreturns.com/api-reference/latest/label-requests/list-label-requests\",\"mainEntityOfPage\":{\"@id\":\"https://docs.loopreturns.com/api-reference/latest/label-requests/list-label-requests#webpage\"},\"dateModified\":\"2026-09-03T14:50:11.296Z\",\"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","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","description":"Get all items for a Happy Returns shipment.\n\n### Required API key scope\n- Happy Returns Shipments (Read)\n","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","description":"Get details about a single label request.\n\n#### Required API key scope\n- Label Requests (Read)\n","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":"post /returns/{returnId}/labels/regenerate","title":"Regenerate Label","href":"/api-reference/latest/label-requests/regenerate-label"},{"openapi":"put /labels/{id}","title":"Update Label Status","href":"/api-reference/latest/label-requests/update-label-status"}]},{"group":"Return Create","pages":[{"title":"Return Create Overview","href":"/api-reference/latest/draft-returns/overview"},{"openapi":"openapi/draft-returns.yaml get /draft-returns/{draft_return_id}","title":"Get Draft Return","href":"/api-reference/latest/draft-returns/get-draft-return"},{"openapi":"openapi/draft-returns.yaml post /draft-returns","title":"Initialize Draft Return","href":"/api-reference/latest/draft-returns/initialize-draft-return"},{"openapi":"openapi/draft-returns.yaml post /draft-returns/{draft_return_id}/cancel","title":"Cancel Draft Return","href":"/api-reference/latest/draft-returns/cancel-draft-return"},{"openapi":"openapi/draft-returns.yaml post /draft-returns/{draft_return_id}/customer","title":"Set Customer","href":"/api-reference/latest/draft-returns/set-customer"},{"openapi":"openapi/draft-returns.yaml post /draft-returns/{draft_return_id}/address","title":"Set Address","href":"/api-reference/latest/draft-returns/set-address"},{"openapi":"openapi/draft-returns.yaml post /draft-returns/{draft_return_id}/returning-items","title":"Add Returning Item","href":"/api-reference/latest/draft-returns/add-returning-item"},{"openapi":"openapi/draft-returns.yaml delete /draft-returns/{draft_return_id}/returning-items/{returning_item_id}","title":"Remove Returning Item","href":"/api-reference/latest/draft-returns/remove-returning-item"},{"openapi":"openapi/draft-returns.yaml post /draft-returns/{draft_return_id}/returning-items/{returning_item_id}/return-reason","title":"Set Returning Item Return Reason","href":"/api-reference/latest/draft-returns/set-returning-item-return-reason"},{"openapi":"openapi/draft-returns.yaml 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/latest/draft-returns/add-returning-item-user-input"},{"openapi":"openapi/draft-returns.yaml post /draft-returns/{draft_return_id}/returning-items/{returning_item_id}/return-type","title":"Set Returning Item Return Type","href":"/api-reference/latest/draft-returns/set-returning-item-return-type"},{"openapi":"openapi/draft-returns.yaml post /draft-returns/{draft_return_id}/returning-items/{returning_item_id}/exchange-item","title":"Add Returning Item Exchange Item","href":"/api-reference/latest/draft-returns/add-returning-item-exchange-item"},{"openapi":"openapi/draft-returns.yaml post /draft-returns/{draft_return_id}/cart/items","title":"Add Cart Item","href":"/api-reference/latest/draft-returns/add-cart-item"},{"openapi":"openapi/draft-returns.yaml delete /draft-returns/{draft_return_id}/cart/items/{cart_item_id}","title":"Remove Cart Item","href":"/api-reference/latest/draft-returns/remove-cart-item"},{"openapi":"openapi/draft-returns.yaml post /draft-returns/{draft_return_id}/credit-type","title":"Set Credit Type","href":"/api-reference/latest/draft-returns/set-credit-type"},{"openapi":"openapi/draft-returns.yaml post /draft-returns/{draft_return_id}/processing-type","title":"Set Processing Type","href":"/api-reference/latest/draft-returns/set-processing-type"},{"openapi":"openapi/draft-returns.yaml post /draft-returns/{draft_return_id}/finalize-items","title":"Finalize Items","href":"/api-reference/latest/draft-returns/finalize-items"},{"openapi":"openapi/draft-returns.yaml post /draft-returns/{draft_return_id}/unfinalize-items","title":"Unfinalize Items","href":"/api-reference/latest/draft-returns/unfinalize-items"},{"openapi":"openapi/draft-returns.yaml post /draft-returns/{draft_return_id}/return-method","title":"Select Return Method","href":"/api-reference/latest/draft-returns/select-return-method"},{"openapi":"openapi/draft-returns.yaml post /draft-returns/{draft_return_id}/submit","title":"Submit Draft Return","href":"/api-reference/latest/draft-returns/submit-draft-return"}]},{"group":"Commerce Data","pages":[{"group":"Products","pages":[{"openapi":"get /products","title":"List Products","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-2026-07.yaml post /orders","title":"Create Order","href":"/api-reference/2026-07/orders/create-order"},{"openapi":"openapi/orders-api-2026-07.yaml put /orders","title":"Upsert Order","href":"/api-reference/2026-07/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-2026-07.yaml put /orders/{id}","title":"Update Order","href":"/api-reference/2026-07/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"},{"title":"Redact Customer","openapi":"post /privacy/customer/redact","href":"/api-reference/latest/customers/redact-customer"}]},{"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":"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","description":"Get all items for a Happy Returns shipment.\n\n### Required API key scope\n- Happy Returns Shipments (Read)\n","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","description":"Get details about a single label request.\n\n#### Required API key scope\n- Label Requests (Read)\n","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":"Ship by Loop","pages":[{"openapi":"post /ship-by-loop/shipments/{shipmentId}/services","title":"Add available services to a shipment","href":"/api-reference/latest/ship-by-loop/add-available-services-to-a-shipment"},{"openapi":"post /ship-by-loop/shipments/{shipmentId}/orders","title":"Record orders on a shipment","href":"/api-reference/latest/ship-by-loop/record-orders-on-a-shipment"},{"openapi":"post /ship-by-loop/shipments/{shipmentId}/errors","title":"Report errors on a shipment","href":"/api-reference/latest/ship-by-loop/report-errors-on-a-shipment"}]},{"group":"Return Create","pages":[{"title":"Return Create Overview","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","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","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"},{"title":"Redact Customer","openapi":"post /privacy/customer/redact","href":"/api-reference/latest/customers/redact-customer"}]},{"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","description":"Get all items for a Happy Returns shipment.\n\n### Required API key scope\n- Happy Returns Shipments (Read)\n","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","description":"Get details about a single label request.\n\n#### Required API key scope\n- Label Requests (Read)\n","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":"Ship by Loop","pages":[{"openapi":"post /ship-by-loop/shipments/{shipmentId}/services","title":"Add available services to a shipment","href":"/api-reference/latest/ship-by-loop/add-available-services-to-a-shipment"},{"openapi":"post /ship-by-loop/shipments/{shipmentId}/orders","title":"Record orders on a shipment","href":"/api-reference/latest/ship-by-loop/record-orders-on-a-shipment"},{"openapi":"post /ship-by-loop/shipments/{shipmentId}/errors","title":"Report errors on a shipment","href":"/api-reference/latest/ship-by-loop/report-errors-on-a-shipment"}]},{"group":"Return Create","pages":[{"title":"Return Create Overview","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","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","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"},{"title":"Redact Customer","openapi":"post /privacy/customer/redact","href":"/api-reference/latest/customers/redact-customer"}]},{"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"}]}]}]},"basePath":"","title":"List Label Requests - Loop Returns Documentation","buildId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","deploymentId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Myd8dsju.js","utils-C2HkQgW0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-8rSppmTv.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B6MjiCFm.js","snippetPresets-DwrSAONL.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-1-a5UQKQ.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C541m7wZ.js","shallow-CWELCZ77.js","getApiPlaygroundDisplay-CTo5Zn03.js","CodeSnippet-D--dzvnl.js","CodeSnippets-DM3cXEDh.js","Page-CxAy5y67.js","getPastedJson-C-VECgcL.js","icon-BPq2-Mg3.js","MethodPill-D9J5cUHd.js","DuplicateIcon-BqHaxUnD.js","createIcon-CIbcZHp9.js","DynamicMarkdown-BKiHAm_d.js","SectionHeading-DstQXt3H.js","axios-vUo_bRtp.js","Markdown-CpxgzsKA.js","clsx-C5EfhVm0.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CJ9Oly2E.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Mk6P3qvh.js"]}