{
"message": "The `from attribute has an invalid date format.",
"errors": {
"from": [
"The `from` attribute has an invalid date format."
]
}
}
Return Data
Detailed Returns List
Pull a detailed list of returns created within a given timeframe.
This endpoint supports pagination. We highly
encourage using pagination
for this endpoint. Read the guide on
paginating requests
for details.
Note: If neither from nor to is passed,
the response defaults to only contain returns from the previous 24
hours. See from and to below for more information.
Note: The maximum number of days in the range of the from and to properties is 120 days.
If the number of days
in this range exceeds 120 days, a validation error will be returned.
Note: If no state is passed, the response defaults to only contain open, closed, and expired returns. See
state below for more information.
Required API key scope
Returns
GET
/
warehouse
/
return
/
list
Detailed Returns List
curl --request GET \ --url https://api.loopreturns.com/api/2026-10/warehouse/return/list \ --header 'X-Authorization: <api-key>'
When present, enables cursor-based pagination. The response is then wrapped in an object
containing returns plus nextPageUrl/previousPageUrl, rather than a bare array.
Return totals in the order's presentment (customer) currency, sourced from the stored, provider-authoritative amounts rather than converted from the shop currency. Use this block to reconcile multi-currency returns to the cent; the amounts satisfy refund + return_credit_total + handling_fee == return_total + return_shipping_total + credit_shipping_total.
{"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":"6ae4ca2de9bd8b42e55fc8cc","collectionId":"07592d87-410d-45be-9292-bab2557b7a91","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae4ca2de9bd8b42e55fc8cc"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae4ca2de9bd8b42e55fc8cc","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"API Reference","count":173},{"language":"default","tag":"APIs","count":165},{"language":"default","tag":"Commerce Data","count":68},{"language":"default","tag":"Return Create (HAL-Forms)","count":30},{"language":"default","tag":"Guides","count":30},{"language":"default","tag":"Return Create","count":22},{"language":"default","tag":"Products","count":17},{"language":"default","tag":"Webhook Reference","count":13},{"language":"default","tag":"Collections","count":12},{"language":"default","tag":"Orders","count":11}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/latest/return-data/detailed-returns-list","slug":"/api-reference/latest/return-data/detailed-returns-list","pageMetadata":{"openapi":"get /warehouse/return/list","title":"Detailed Returns List","description":"Pull a detailed list of returns created within a given timeframe.\n\nThis endpoint supports pagination. We _highly_\nencourage using [pagination](https://docs.loopreturns.com/reference/paginated-requests)\nfor this endpoint. Read the guide on\n[paginating requests](https://docs.loopreturns.com/reference/paginated-requests)\nfor details.\n\n**Note**: If neither `from` nor `to` is passed,\nthe response defaults to only contain returns from the previous 24\nhours. See [`from`](#parameter-from) and [`to`](#parameter-to) below for more information.\n\n**Note**: The maximum number of days in the range of the from and to properties is 120 days.\nIf the number of days\nin this range exceeds 120 days, a validation error will be returned.\n\n**Note**: If no `state` is passed, the response defaults to only contain open, closed, and expired returns. See\n[`state`](#parameter-state) below for more information.\n\n### Required API key scope\n- Returns\n","href":"/api-reference/latest/return-data/detailed-returns-list"},"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 a: \"a\",\n code: \"code\",\n em: \"em\",\n h3: \"h3\",\n li: \"li\",\n p: \"p\",\n strong: \"strong\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Pull a detailed list of returns created within a given timeframe.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"This endpoint supports pagination. We \", _jsx(_components.em, {\n children: \"highly\"\n }), \"\\nencourage using \", _jsx(_components.a, {\n href: \"https://docs.loopreturns.com/reference/paginated-requests\",\n children: \"pagination\"\n }), \"\\nfor this endpoint. Read the guide on\\n\", _jsx(_components.a, {\n href: \"https://docs.loopreturns.com/reference/paginated-requests\",\n children: \"paginating requests\"\n }), \"\\nfor details.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Note\"\n }), \": If neither \", _jsx(_components.code, {\n children: \"from\"\n }), \" nor \", _jsx(_components.code, {\n children: \"to\"\n }), \" is passed,\\nthe response defaults to only contain returns from the previous 24\\nhours. See \", _jsx(_components.a, {\n href: \"#parameter-from\",\n children: _jsx(_components.code, {\n children: \"from\"\n })\n }), \" and \", _jsx(_components.a, {\n href: \"#parameter-to\",\n children: _jsx(_components.code, {\n children: \"to\"\n })\n }), \" below for more information.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Note\"\n }), \": The maximum number of days in the range of the from and to properties is 120 days.\\nIf the number of days\\nin this range exceeds 120 days, a validation error will be returned.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Note\"\n }), \": If no \", _jsx(_components.code, {\n children: \"state\"\n }), \" is passed, the response defaults to only contain open, closed, and expired returns. See\\n\", _jsx(_components.a, {\n href: \"#parameter-state\",\n children: _jsx(_components.code, {\n children: \"state\"\n })\n }), \" below for more information.\"]\n }), \"\\n\", _jsx(_components.h3, {\n children: \"Required API key scope\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"Returns\"\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 /warehouse/return/list","title":"Detailed Returns List","description":"Pull a detailed list of returns created within a given timeframe.\n\nThis endpoint supports pagination. We _highly_\nencourage using [pagination](https://docs.loopreturns.com/reference/paginated-requests)\nfor this endpoint. Read the guide on\n[paginating requests](https://docs.loopreturns.com/reference/paginated-requests)\nfor details.\n\n**Note**: If neither `from` nor `to` is passed,\nthe response defaults to only contain returns from the previous 24\nhours. See [`from`](#parameter-from) and [`to`](#parameter-to) below for more information.\n\n**Note**: The maximum number of days in the range of the from and to properties is 120 days.\nIf the number of days\nin this range exceeds 120 days, a validation error will be returned.\n\n**Note**: If no `state` is passed, the response defaults to only contain open, closed, and expired returns. See\n[`state`](#parameter-state) below for more information.\n\n### Required API key scope\n- Returns\n","href":"/api-reference/latest/return-data/detailed-returns-list"}}},"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":{"tags":["Return Data"],"security":["849cf651-0fbb-4f2a-9e64-be11c086bca4"],"summary":"Detailed Returns List","operationId":"getDetailedReturnsList","description":"Pull a detailed list of returns created within a given timeframe.\n\nThis endpoint supports pagination. We _highly_\nencourage using [pagination](https://docs.loopreturns.com/reference/paginated-requests)\nfor this endpoint. Read the guide on\n[paginating requests](https://docs.loopreturns.com/reference/paginated-requests)\nfor details.\n\n**Note**: If neither `from` nor `to` is passed,\nthe response defaults to only contain returns from the previous 24\nhours. See [`from`](#parameter-from) and [`to`](#parameter-to) below for more information.\n\n**Note**: The maximum number of days in the range of the from and to properties is 120 days.\nIf the number of days\nin this range exceeds 120 days, a validation error will be returned.\n\n**Note**: If no `state` is passed, the response defaults to only contain open, closed, and expired returns. See\n[`state`](#parameter-state) below for more information.\n\n### Required API key scope\n- Returns\n","parameters":["fc05342c-eef6-4edd-a7ef-737d9f6ba7d1","a7c26826-593c-4abb-aefd-872caee88c3e","92463525-406b-48e7-ae2e-76f59aa04c0e","cb5858c0-4d95-4d05-ab28-fdde85b9457e","a3b0d866-cccc-4cd1-b025-2fd62d45bfba","048573ef-ed21-4b12-92e6-fe8a8a87204f","cc239153-511d-4f7d-9312-2a7ee39fe21b"],"responses":{"200":"520bf51c-20bc-454c-8f60-1d97ae279473","401":"30f469d8-9270-4889-9564-c79756e6ad61","422":"b59c16ca-73c3-4b5a-95bb-65665398f202"},"method":"get","type":"path","servers":["35001b8b-d6cc-40f7-876b-79dcf40cbe57","6192e428-fa8f-4bee-b9d8-3b60739b3dad","a8efd23a-faac-4d13-b274-d31db9cb356a"],"path":"/warehouse/return/list","baseUrlOptions":["https://api.loopreturns.com/api/2026-10","https://api.loopreturns.com/api/2026-07","https://api.loopreturns.com/api/unstable"],"title":"Detailed Returns List","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"fc05342c-eef6-4edd-a7ef-737d9f6ba7d1":{"name":"from","example":"yyyy-mm-dd hh:mm:ss","in":"query","description":"The start date and time for the returns list. If `from` is passed without `to`, returns created in the 24 hours after `from` are returned.\n","schema":{"type":"string","examples":["2022-01-01T00:00:00.000Z"],"description":"The start date and time for the returns list. If `from` is passed without `to`, returns created in the 24 hours after `from` are returned.\n","uniqueKey":"","typeLabel":"string"}},"a7c26826-593c-4abb-aefd-872caee88c3e":{"name":"to","example":"yyyy-mm-dd hh:mm:ss","in":"query","description":"The end date and time for the returns list. If `to` is provided without `from`, the parameter is ignored and returns from the last 24 hours are returned.\n","schema":{"type":"string","examples":["2022-03-31T23:59:59.000Z"],"description":"The end date and time for the returns list. If `to` is provided without `from`, the parameter is ignored and returns from the last 24 hours are returned.\n","uniqueKey":"","typeLabel":"string"}},"92463525-406b-48e7-ae2e-76f59aa04c0e":{"name":"filter","in":"query","description":"The date used to filter results.\n","schema":{"type":"string","enum":["created_at","updated_at"],"default":"created_at","description":"The date used to filter results.\n","uniqueKey":"","typeLabel":"enum\u003cstring>"}},"cb5858c0-4d95-4d05-ab28-fdde85b9457e":{"name":"state","example":"open","in":"query","description":"The keywords used to filter the list to only include returns in a particular state.\nDefaults to only contain open, closed, and expired returns.\n","schema":{"type":"string","enum":["open","closed","cancelled","expired","review"],"description":"The keywords used to filter the list to only include returns in a particular state.\nDefaults to only contain open, closed, and expired returns.\n","uniqueKey":"","typeLabel":"enum\u003cstring>"}},"a3b0d866-cccc-4cd1-b025-2fd62d45bfba":{"name":"paginate","in":"query","description":"When present, enables cursor-based pagination. The response is then wrapped in an object\ncontaining `returns` plus `nextPageUrl`/`previousPageUrl`, rather than a bare array.\n","schema":{"type":"boolean","description":"When present, enables cursor-based pagination. The response is then wrapped in an object\ncontaining `returns` plus `nextPageUrl`/`previousPageUrl`, rather than a bare array.\n","uniqueKey":"","typeLabel":"boolean"}},"048573ef-ed21-4b12-92e6-fe8a8a87204f":{"name":"pageSize","in":"query","description":"The number of returns to return per page when paginating.","schema":{"type":"integer","description":"The number of returns to return per page when paginating.","uniqueKey":"","typeLabel":"integer"}},"cc239153-511d-4f7d-9312-2a7ee39fe21b":{"name":"cursor","in":"query","description":"The cursor identifying the page to return when paginating.","schema":{"type":"string","description":"The cursor identifying the page to return when paginating.","uniqueKey":"","typeLabel":"string"}}},"responses":{"520bf51c-20bc-454c-8f60-1d97ae279473":{"description":"Success","content":{"application/json":{"schema":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","examples":["12345678"],"description":"The unique identifier associated with the return.","uniqueKey":"oneOf.0.items.[INDEX].id","typeLabel":"string"},"state":{"type":"string","examples":["open"],"description":"The current state of the return.","uniqueKey":"oneOf.0.items.[INDEX].state","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","examples":["2023-01-01T22:27:15.000Z"],"description":"The date and time at which the return was created, using the ISO 8601 date format.","uniqueKey":"oneOf.0.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","examples":["2023-01-01T22:27:18.000Z"],"description":"The date and time at which the return was last updated, using the ISO 8601 date format.","uniqueKey":"oneOf.0.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"},"edited_at":{"type":"string","format":"date-time","examples":["2023-01-03T22:34:17.000Z"],"description":"The date and time at which the return was last edited, using the ISO 8601 date format.","uniqueKey":"oneOf.0.items.[INDEX].edited_at","typeLabel":"string\u003cdate-time>"},"total":{"type":"string","examples":["63.30"],"description":"The total cost of the return.","uniqueKey":"oneOf.0.items.[INDEX].total","typeLabel":"string"},"outcome":{"type":"string","enum":["exchange","upsell","refund","credit","exchange+refund","exchange+credit"],"description":"The outcome of the return as limited by the merchant and as selected by the customer.","uniqueKey":"oneOf.0.items.[INDEX].outcome","typeLabel":"enum\u003cstring>"},"order_id":{"type":"string","examples":["98766312"],"description":"The Loop order identifier associated with the return.","uniqueKey":"oneOf.0.items.[INDEX].order_id","typeLabel":"string"},"order_name":{"type":"string","examples":["#7382018"],"description":"The order name.","uniqueKey":"oneOf.0.items.[INDEX].order_name","typeLabel":"string"},"provider_order_id":{"type":"string","examples":["3248923479283"],"description":"The order ID from the commerce provider (e.g. Shopify).","uniqueKey":"oneOf.0.items.[INDEX].provider_order_id","typeLabel":"string"},"order_number":{"type":"string","examples":["7381018"],"description":"The order number.","uniqueKey":"oneOf.0.items.[INDEX].order_number","typeLabel":"string"},"provider_order_number":{"type":"string","examples":["7382018"],"description":"The order number from the commerce provider (e.g. Shopify).","uniqueKey":"oneOf.0.items.[INDEX].provider_order_number","typeLabel":"string"},"customer":{"oneOf":[{"type":"string","examples":["example@example.com"],"description":"The customer's email address.","uniqueKey":"oneOf.0.items.[INDEX].customer.oneOf.0","typeLabel":"string"},{"type":"null","examples":["example@example.com"],"description":"The customer's email address.","uniqueKey":"oneOf.0.items.[INDEX].customer.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.items.[INDEX].customer","typeLabel":"string | null"},"origin_country":{"oneOf":[{"type":"string","examples":["United States"],"description":"The country of the customer's shipping address.","uniqueKey":"oneOf.0.items.[INDEX].origin_country.oneOf.0","typeLabel":"string"},{"type":"null","examples":["United States"],"description":"The country of the customer's shipping address.","uniqueKey":"oneOf.0.items.[INDEX].origin_country.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.items.[INDEX].origin_country","typeLabel":"string | null"},"origin_country_code":{"oneOf":[{"type":"string","examples":["US"],"description":"The ISO 3166-1 alpha-2 country code of the customer's shipping address.","uniqueKey":"oneOf.0.items.[INDEX].origin_country_code.oneOf.0","typeLabel":"string"},{"type":"null","examples":["US"],"description":"The ISO 3166-1 alpha-2 country code of the customer's shipping address.","uniqueKey":"oneOf.0.items.[INDEX].origin_country_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.items.[INDEX].origin_country_code","typeLabel":"string | null"},"multi_currency":{"examples":[false],"description":"Whether the order was placed through Shopify Payments in some currency other than the default store\ncurrency.\n","uniqueKey":"oneOf.0.items.[INDEX].multi_currency","typeLabel":"any"},"currency":{"type":"string","examples":["USD"],"description":"The currency code of the store's default currency.","uniqueKey":"oneOf.0.items.[INDEX].currency","typeLabel":"string"},"return_product_total":{"type":"string","examples":["156.00"],"description":"The gross value of the returning items before discounts and tax.","uniqueKey":"oneOf.0.items.[INDEX].return_product_total","typeLabel":"string"},"return_discount_total":{"type":"string","examples":["0.00"],"description":"The total value of the discounts on the returning items.","uniqueKey":"oneOf.0.items.[INDEX].return_discount_total","typeLabel":"string"},"return_tax_total":{"type":"string","examples":["8.58"],"description":"The total value of the taxes on the returning items.","uniqueKey":"oneOf.0.items.[INDEX].return_tax_total","typeLabel":"string"},"return_total":{"type":"string","examples":["164.58"],"description":"The net value of the returning items after discounts and tax.","uniqueKey":"oneOf.0.items.[INDEX].return_total","typeLabel":"string"},"refund_shipping_total":{"type":"string","examples":["4.00"],"description":"Total original-order shipping reimbursement folded into the refund (the sum of each line item's `refund_shipping`).","uniqueKey":"oneOf.0.items.[INDEX].refund_shipping_total","typeLabel":"string"},"refund_shipping_tax_total":{"type":"string","examples":["0.40"],"description":"The tax portion of the reimbursed shipping folded into the refund (the sum of each line item's `refund_shipping_tax`).","uniqueKey":"oneOf.0.items.[INDEX].refund_shipping_tax_total","typeLabel":"string"},"return_credit_total":{"type":"string","examples":["101.28"],"description":"The value of the returning items credited to the shopper after the refund has been issued.","uniqueKey":"oneOf.0.items.[INDEX].return_credit_total","typeLabel":"string"},"exchange_product_total":{"type":"string","examples":["96.00"],"description":"The gross value of the exchange before discounts and tax.","uniqueKey":"oneOf.0.items.[INDEX].exchange_product_total","typeLabel":"string"},"exchange_discount_total":{"type":"string","examples":["0.00"],"description":"The total value of discounts on the exchange.","uniqueKey":"oneOf.0.items.[INDEX].exchange_discount_total","typeLabel":"string"},"exchange_tax_total":{"type":"string","examples":["5.28"],"description":"The total value of the taxes on the exchange.","uniqueKey":"oneOf.0.items.[INDEX].exchange_tax_total","typeLabel":"string"},"exchange_total":{"type":"string","examples":["101.28"],"description":"The net value of the exchanges after discounts and tax.","uniqueKey":"oneOf.0.items.[INDEX].exchange_total","typeLabel":"string"},"exchange_credit_total":{"type":"string","examples":["101.28"],"description":"The value of the return credit used by the shopper.","uniqueKey":"oneOf.0.items.[INDEX].exchange_credit_total","typeLabel":"string"},"gift_card":{"type":"string","examples":["0.00"],"description":"The value of the gift card issued in the return.","uniqueKey":"oneOf.0.items.[INDEX].gift_card","typeLabel":"string"},"gift_card_order_name":{"oneOf":[{"type":"string","examples":["Gift Card Name"],"description":"The name of the gift card order issued in the return.","uniqueKey":"oneOf.0.items.[INDEX].gift_card_order_name.oneOf.0","typeLabel":"string"},{"type":"null","examples":["Gift Card Name"],"description":"The name of the gift card order issued in the return.","uniqueKey":"oneOf.0.items.[INDEX].gift_card_order_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.items.[INDEX].gift_card_order_name","typeLabel":"string | null"},"gift_card_order_id":{"oneOf":[{"type":"string","examples":["23141001200513"],"description":"The unique identifier of the gift card issued in the return.","uniqueKey":"oneOf.0.items.[INDEX].gift_card_order_id.oneOf.0","typeLabel":"string"},{"type":"null","examples":["23141001200513"],"description":"The unique identifier of the gift card issued in the return.","uniqueKey":"oneOf.0.items.[INDEX].gift_card_order_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.items.[INDEX].gift_card_order_id","typeLabel":"string | null"},"gift_card_presentment":{"type":"object","description":"The gift card credit issued in the return, in the currency the gift card was issued in (the order's presentment currency when available).","properties":{"value":{"type":"string","examples":["0.00"],"description":"The total value of the gift card credit issued in the return.","uniqueKey":"oneOf.0.items.[INDEX].gift_card_presentment.value","typeLabel":"string"},"currency":{"oneOf":[{"type":"string","examples":["CAD"],"description":"The ISO 4217 currency code of `value`.","uniqueKey":"oneOf.0.items.[INDEX].gift_card_presentment.currency.oneOf.0","typeLabel":"string"},{"type":"null","examples":["CAD"],"description":"The ISO 4217 currency code of `value`.","uniqueKey":"oneOf.0.items.[INDEX].gift_card_presentment.currency.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.items.[INDEX].gift_card_presentment.currency","typeLabel":"string | null"}},"uniqueKey":"oneOf.0.items.[INDEX].gift_card_presentment","typeLabel":"object"},"handling_fee":{"type":"string","examples":["0.00"],"description":"The handling fee charged by the merchant.","uniqueKey":"oneOf.0.items.[INDEX].handling_fee","typeLabel":"string"},"refund":{"type":"string","examples":["63.30"],"description":"The amount refunded in the return.","uniqueKey":"oneOf.0.items.[INDEX].refund","typeLabel":"string"},"upsell":{"type":"string","examples":["0.00"],"description":"The upsell amount associated with the return.","uniqueKey":"oneOf.0.items.[INDEX].upsell","typeLabel":"string"},"line_items":{"type":"array","items":{"type":"object","properties":{"line_item_id":{"type":"string","examples":["293482039"],"description":"The unique identifier associated with the line item.","uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].line_item_id","typeLabel":"string"},"provider_line_item_id":{"type":"string","examples":["23984238720"],"description":"The identifier from the commerce provider (e.g. Shopify) associated with the line item.","uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].provider_line_item_id","typeLabel":"string"},"provider_line_item_external_id":{"oneOf":[{"type":"string","description":"Always present on each `line_items` entry (never omitted). The merchant-supplied external identifier for the order line item, as set via the Commerce Data Orders API (`line_items[].external_id`). Resolved from the Commerce Data order line item linked by `provider_line_item_id`. `null` for non-Commerce Data shops (including Shopify), when the line item has no external identifier, when no Commerce Data line item matches, or when the Commerce Data lookup cannot be completed (the request still returns HTTP 200). When a single Commerce Data order line with quantity greater than one is split into multiple returning units, each unit shares this value but has a distinct `line_item_id`.\n","examples":["merchant-line-item-abc-123",null],"uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].provider_line_item_external_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Always present on each `line_items` entry (never omitted). The merchant-supplied external identifier for the order line item, as set via the Commerce Data Orders API (`line_items[].external_id`). Resolved from the Commerce Data order line item linked by `provider_line_item_id`. `null` for non-Commerce Data shops (including Shopify), when the line item has no external identifier, when no Commerce Data line item matches, or when the Commerce Data lookup cannot be completed (the request still returns HTTP 200). When a single Commerce Data order line with quantity greater than one is split into multiple returning units, each unit shares this value but has a distinct `line_item_id`.\n","examples":["merchant-line-item-abc-123",null],"uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].provider_line_item_external_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].provider_line_item_external_id","typeLabel":"string | null"},"product_id":{"type":"string","examples":["29871298310292"],"description":"The unique identifier associated with the product.","uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].product_id","typeLabel":"string"},"variant_id":{"type":"string","examples":["23498287203948"],"description":"The unique identifier associated with the product variant.","uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].variant_id","typeLabel":"string"},"sku":{"type":"string","examples":["2039473-Y"],"description":"The SKU associated with the product.","uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].sku","typeLabel":"string"},"title":{"type":"string","examples":["Black Striped Shirt"],"description":"The product's name.","uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].title","typeLabel":"string"},"price":{"type":"string","examples":["78.00"],"description":"The product's price.","uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].price","typeLabel":"string"},"discount":{"type":"string","examples":["0.00"],"description":"The discount amount associated with the line item.","uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].discount","typeLabel":"string"},"tax":{"type":"string","examples":["4.29"],"description":"The tax amount associated with the line item.","uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].tax","typeLabel":"string"},"refund":{"type":"string","examples":["31.65"],"description":"The refund amount associated with the line item.","uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].refund","typeLabel":"string"},"refund_item":{"type":"string","examples":["27.36"],"description":"The refund amount minus the tax amount.","uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].refund_item","typeLabel":"string"},"refund_tax":{"type":"string","examples":["4.29"],"description":"Equal to the refund.","uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].refund_tax","typeLabel":"string"},"refund_shipping":{"type":"string","examples":["4.00"],"description":"This line's share of the original-order shipping reimbursement folded into `refund`.","uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].refund_shipping","typeLabel":"string"},"refund_excluding_shipping":{"type":"string","examples":["27.65"],"description":"This line's `refund` with shipping removed (`refund` minus `refund_shipping`).","uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].refund_excluding_shipping","typeLabel":"string"},"refund_shipping_tax":{"type":"string","examples":["0.40"],"description":"The tax portion of `refund_shipping`.","uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].refund_shipping_tax","typeLabel":"string"},"refund_excluding_shipping_tax":{"type":"string","examples":["4.29"],"description":"The tax on the items excluding shipping. The existing `refund_tax` already excludes shipping tax, so this value equals `refund_tax`; the corrected total refund tax is `refund_tax` plus `refund_shipping_tax`.","uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].refund_excluding_shipping_tax","typeLabel":"string"},"returned_at":{"type":"string","format":"date-time","examples":["2023-01-01T22:27:16.000Z"],"description":"The date and time at which the item was returned, using the ISO 8601 date format.","uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].returned_at","typeLabel":"string\u003cdate-time>"},"exchange_variant":{"type":"string","examples":[""],"description":"The product variant selected by the customer for exchange (if applicable).","uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].exchange_variant","typeLabel":"string"},"return_reason":{"type":"string","examples":["I like another style more"],"description":"The specific reason for return given by the customer.","uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].return_reason","typeLabel":"string"},"parent_return_reason":{"type":"string","examples":["Didn't like it"],"description":"The general return reason category given by the customer.","uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].parent_return_reason","typeLabel":"string"},"return_comment":{"type":"string","examples":["N/A"],"description":"The optional comment left by the customer when returning the product.","uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].return_comment","typeLabel":"string"},"barcode":{"type":"string","examples":["290832428347"],"description":"The barcode of the product.","uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].barcode","typeLabel":"string"},"outcome":{"type":"string","enum":["reject","donate","review","default","keep"],"examples":["default"],"description":"The return outcome, as permitted by the merchant's return policy.","uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].outcome","typeLabel":"enum\u003cstring>"},"provider_restock_location_id":{"oneOf":[{"type":"string","description":"The restock location for the return.","uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].provider_restock_location_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The restock location for the return.","uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].provider_restock_location_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].provider_restock_location_id","typeLabel":"string | null"},"consolidation_tracking":{"type":"string","examples":["MS6681181"],"description":"If a line item is part of a consolidated shipment of many return items,\nthis value holds the tracking value for the consolidated shipment\nthat contains this item such as the Happy Returns Outbound Shipment tracking number.\n","uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].consolidation_tracking","typeLabel":"string"},"consolidation_destination_id":{"oneOf":[{"type":"string","examples":["357"],"description":"If a line item is part of a consolidated shipment of many return items,\nthis value holds the destination id for the consolidated shipment that\ncontains this item such as the Happy Returns Outbound Shipment\ndestination address id.\n","uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].consolidation_destination_id.oneOf.0","typeLabel":"string"},{"type":"null","examples":["357"],"description":"If a line item is part of a consolidated shipment of many return items,\nthis value holds the destination id for the consolidated shipment that\ncontains this item such as the Happy Returns Outbound Shipment\ndestination address id.\n","uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].consolidation_destination_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].consolidation_destination_id","typeLabel":"string | null"},"condition":{"oneOf":[{"type":"object","properties":{"description":{"type":"string","examples":["Grade A: No refurbishment needed"],"uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].condition.oneOf.0.description","typeLabel":"string"},"condition_category":{"oneOf":[{"type":"string","enum":["grade_a","grade_b","grade_c","grade_d","incorrect_item","missing","junk"],"examples":["grade_c"],"uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].condition.oneOf.0.condition_category.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["grade_a","grade_b","grade_c","grade_d","incorrect_item","missing","junk"],"examples":["grade_c"],"uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].condition.oneOf.0.condition_category.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].condition.oneOf.0.condition_category","typeLabel":"enum\u003cstring> | null"},"return_processor":{"oneOf":[{"type":"string","examples":["warehouse-operator@example.com"],"uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].condition.oneOf.0.return_processor.oneOf.0","typeLabel":"string"},{"type":"null","examples":["warehouse-operator@example.com"],"uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].condition.oneOf.0.return_processor.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].condition.oneOf.0.return_processor","typeLabel":"string | null"},"note":{"oneOf":[{"type":"string","examples":["This item is missing the original packaging. Light refurbishment required. Scuff marks on the back of the item."],"uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].condition.oneOf.0.note.oneOf.0","typeLabel":"string"},{"type":"null","examples":["This item is missing the original packaging. Light refurbishment required. Scuff marks on the back of the item."],"uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].condition.oneOf.0.note.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].condition.oneOf.0.note","typeLabel":"string | null"},"inspected_at":{"type":"string","format":"date-time","examples":["2023-07-19T15:11:32+00:00"],"uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].condition.oneOf.0.inspected_at","typeLabel":"string\u003cdate-time>"},"images":{"type":"array","items":{"type":"string","format":"uri","examples":["https://example.com/image.jpg"],"uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].condition.oneOf.0.images.items.[INDEX]","typeLabel":"string\u003curi>"},"uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].condition.oneOf.0.images","typeLabel":"string\u003curi>[]"}},"uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].condition.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"description":{"type":"string","examples":["Grade A: No refurbishment needed"]},"condition_category":{"oneOf":[{"type":"string","enum":["grade_a","grade_b","grade_c","grade_d","incorrect_item","missing","junk"],"examples":["grade_c"]},{"type":"null","enum":["grade_a","grade_b","grade_c","grade_d","incorrect_item","missing","junk"],"examples":["grade_c"]}]},"return_processor":{"oneOf":[{"type":"string","examples":["warehouse-operator@example.com"]},{"type":"null","examples":["warehouse-operator@example.com"]}]},"note":{"oneOf":[{"type":"string","examples":["This item is missing the original packaging. Light refurbishment required. Scuff marks on the back of the item."]},{"type":"null","examples":["This item is missing the original packaging. Light refurbishment required. Scuff marks on the back of the item."]}]},"inspected_at":{"type":"string","format":"date-time","examples":["2023-07-19T15:11:32+00:00"]},"images":{"type":"array","items":{"type":"string","format":"uri","examples":["https://example.com/image.jpg"]}}},"uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].condition.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].condition","typeLabel":"object | null"},"disposition":{"oneOf":[{"type":"object","properties":{"disposition_outcome":{"type":"string","enum":["back_to_stock","resale_hold","recycle","donate","missing"],"uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].disposition.oneOf.0.disposition_outcome","typeLabel":"enum\u003cstring>"},"return_processor":{"oneOf":[{"type":"string","examples":["warehouse-operator@example.com"],"uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].disposition.oneOf.0.return_processor.oneOf.0","typeLabel":"string"},{"type":"null","examples":["warehouse-operator@example.com"],"uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].disposition.oneOf.0.return_processor.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].disposition.oneOf.0.return_processor","typeLabel":"string | null"},"note":{"oneOf":[{"type":"string","examples":["This item will be returned to stock after bagging and tagging"],"uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].disposition.oneOf.0.note.oneOf.0","typeLabel":"string"},{"type":"null","examples":["This item will be returned to stock after bagging and tagging"],"uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].disposition.oneOf.0.note.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].disposition.oneOf.0.note","typeLabel":"string | null"},"inspected_at":{"type":"string","format":"date-time","examples":["2023-07-19T15:11:32+00:00"],"uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].disposition.oneOf.0.inspected_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].disposition.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"disposition_outcome":{"type":"string","enum":["back_to_stock","resale_hold","recycle","donate","missing"]},"return_processor":{"oneOf":[{"type":"string","examples":["warehouse-operator@example.com"]},{"type":"null","examples":["warehouse-operator@example.com"]}]},"note":{"oneOf":[{"type":"string","examples":["This item will be returned to stock after bagging and tagging"]},{"type":"null","examples":["This item will be returned to stock after bagging and tagging"]}]},"inspected_at":{"type":"string","format":"date-time","examples":["2023-07-19T15:11:32+00:00"]}},"uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].disposition.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX].disposition","typeLabel":"object | null"}},"uniqueKey":"oneOf.0.items.[INDEX].line_items.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.items.[INDEX].line_items","typeLabel":"object[]"},"presentment":{"type":"object","description":"Return totals in the order's presentment (customer) currency, sourced from the stored, provider-authoritative amounts rather than converted from the shop currency. Use this block to reconcile multi-currency returns to the cent; the amounts satisfy `refund + return_credit_total + handling_fee == return_total + return_shipping_total + credit_shipping_total`.","properties":{"currency":{"oneOf":[{"type":"string","examples":["CAD"],"description":"The ISO 4217 code of the order's presentment (customer) currency.","uniqueKey":"oneOf.0.items.[INDEX].presentment.currency.oneOf.0","typeLabel":"string"},{"type":"null","examples":["CAD"],"description":"The ISO 4217 code of the order's presentment (customer) currency.","uniqueKey":"oneOf.0.items.[INDEX].presentment.currency.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.items.[INDEX].presentment.currency","typeLabel":"string | null"},"return_product_total":{"type":"string","examples":["156.00"],"description":"The gross value of the returning items before discounts and tax.","uniqueKey":"oneOf.0.items.[INDEX].presentment.return_product_total","typeLabel":"string"},"return_discount_total":{"type":"string","examples":["0.00"],"description":"The total value of the discounts on the returning items.","uniqueKey":"oneOf.0.items.[INDEX].presentment.return_discount_total","typeLabel":"string"},"return_tax_total":{"type":"string","examples":["8.58"],"description":"The total value of the taxes on the returning items.","uniqueKey":"oneOf.0.items.[INDEX].presentment.return_tax_total","typeLabel":"string"},"return_total":{"type":"string","examples":["164.58"],"description":"The net value of the returning items after discounts and tax (`return_product_total - return_discount_total + return_tax_total`). Items only — excludes reimbursed shipping.","uniqueKey":"oneOf.0.items.[INDEX].presentment.return_total","typeLabel":"string"},"return_shipping_total":{"type":"string","examples":["4.00"],"description":"Reimbursed original-order shipping folded into the refund, tax inclusive.","uniqueKey":"oneOf.0.items.[INDEX].presentment.return_shipping_total","typeLabel":"string"},"return_shipping_tax_total":{"type":"string","examples":["0.40"],"description":"The tax portion already included in `return_shipping_total`. Informational — not an additional amount.","uniqueKey":"oneOf.0.items.[INDEX].presentment.return_shipping_tax_total","typeLabel":"string"},"credit_shipping_total":{"type":"string","examples":["0.00"],"description":"Reimbursed original-order shipping folded into the store credit instead of the refund.","uniqueKey":"oneOf.0.items.[INDEX].presentment.credit_shipping_total","typeLabel":"string"},"handling_fee":{"type":"string","examples":["0.00"],"description":"The handling fee withheld by the merchant (`0.00` when waived).","uniqueKey":"oneOf.0.items.[INDEX].presentment.handling_fee","typeLabel":"string"},"return_credit_total":{"type":"string","examples":["0.00"],"description":"The store credit issued to the shopper. Equal to `gift_card`.","uniqueKey":"oneOf.0.items.[INDEX].presentment.return_credit_total","typeLabel":"string"},"gift_card":{"type":"string","examples":["0.00"],"description":"The value of the gift card issued in the return. Equal to `return_credit_total`.","uniqueKey":"oneOf.0.items.[INDEX].presentment.gift_card","typeLabel":"string"},"refund":{"type":"string","examples":["168.58"],"description":"The total amount refunded to the original payment tender(s).","uniqueKey":"oneOf.0.items.[INDEX].presentment.refund","typeLabel":"string"},"refund_breakdown":{"type":"array","description":"The per-tender split of `refund` — one entry per original payment tender (for example a gift card tender alongside a card).","items":{"type":"object","properties":{"gateway":{"type":"string","examples":["shopify_payments"],"description":"The payment gateway of the original tender (for example `shopify_payments` or `gift_card`).","uniqueKey":"oneOf.0.items.[INDEX].presentment.refund_breakdown.items.[INDEX].gateway","typeLabel":"string"},"provider":{"type":"string","examples":["shopify"],"description":"The commerce provider that processed the refund.","uniqueKey":"oneOf.0.items.[INDEX].presentment.refund_breakdown.items.[INDEX].provider","typeLabel":"string"},"amount":{"type":"string","examples":["168.58"],"description":"The amount refunded to this tender, in the presentment currency.","uniqueKey":"oneOf.0.items.[INDEX].presentment.refund_breakdown.items.[INDEX].amount","typeLabel":"string"},"currency":{"type":"string","examples":["CAD"],"description":"The ISO 4217 currency code of `amount` (the presentment currency).","uniqueKey":"oneOf.0.items.[INDEX].presentment.refund_breakdown.items.[INDEX].currency","typeLabel":"string"}},"uniqueKey":"oneOf.0.items.[INDEX].presentment.refund_breakdown.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.items.[INDEX].presentment.refund_breakdown","typeLabel":"object[]"},"line_items":{"type":"array","description":"Presentment amounts for each returning line item.","items":{"type":"object","properties":{"line_item_id":{"type":"string","examples":["59989689"],"description":"The unique identifier of the returning line item (matches the top-level `line_items` entries).","uniqueKey":"oneOf.0.items.[INDEX].presentment.line_items.items.[INDEX].line_item_id","typeLabel":"string"},"price":{"type":"string","examples":["156.00"],"description":"The price of the line item before discounts and tax.","uniqueKey":"oneOf.0.items.[INDEX].presentment.line_items.items.[INDEX].price","typeLabel":"string"},"discount":{"type":"string","examples":["0.00"],"description":"The discount on the line item.","uniqueKey":"oneOf.0.items.[INDEX].presentment.line_items.items.[INDEX].discount","typeLabel":"string"},"tax":{"type":"string","examples":["8.58"],"description":"The tax on the line item.","uniqueKey":"oneOf.0.items.[INDEX].presentment.line_items.items.[INDEX].tax","typeLabel":"string"}},"uniqueKey":"oneOf.0.items.[INDEX].presentment.line_items.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.items.[INDEX].presentment.line_items","typeLabel":"object[]"}},"uniqueKey":"oneOf.0.items.[INDEX].presentment","typeLabel":"object"},"exchanges":{"type":"array","items":{"type":"object","properties":{"exchange_id":{"type":"string","examples":["23423423"],"description":"The unique identifier associated with the exchange.","uniqueKey":"oneOf.0.items.[INDEX].exchanges.items.[INDEX].exchange_id","typeLabel":"string"},"exchange_order_id":{"type":"integer","format":"int64","examples":[2342352463453],"description":"The unique identifier associated with the exchange order.","uniqueKey":"oneOf.0.items.[INDEX].exchanges.items.[INDEX].exchange_order_id","typeLabel":"integer\u003cint64>"},"exchange_order_name":{"type":"string","examples":["EXC-4736272-1"],"description":"The name of the exchange order.","uniqueKey":"oneOf.0.items.[INDEX].exchanges.items.[INDEX].exchange_order_name","typeLabel":"string"},"product_id":{"type":"string","examples":["2342342342344"],"description":"The unique identifier associated with the product.","uniqueKey":"oneOf.0.items.[INDEX].exchanges.items.[INDEX].product_id","typeLabel":"string"},"variant_id":{"type":"string","examples":["49483943473899"],"description":"The unique identifier associated with the product variant.","uniqueKey":"oneOf.0.items.[INDEX].exchanges.items.[INDEX].variant_id","typeLabel":"string"},"sku":{"type":"string","examples":["2833928-Y"],"description":"The SKU associated with the product.","uniqueKey":"oneOf.0.items.[INDEX].exchanges.items.[INDEX].sku","typeLabel":"string"},"type":{"type":"string","examples":["storefront"],"description":"The order type.","uniqueKey":"oneOf.0.items.[INDEX].exchanges.items.[INDEX].type","typeLabel":"string"},"title":{"type":"string","examples":["Grey Striped Shirt"],"description":"The product's name.","uniqueKey":"oneOf.0.items.[INDEX].exchanges.items.[INDEX].title","typeLabel":"string"},"price":{"type":"string","examples":["48.00"],"description":"The product's price.","uniqueKey":"oneOf.0.items.[INDEX].exchanges.items.[INDEX].price","typeLabel":"string"},"discount":{"type":"string","examples":["0.00"],"description":"The discount amount associated with the exchange.","uniqueKey":"oneOf.0.items.[INDEX].exchanges.items.[INDEX].discount","typeLabel":"string"},"tax":{"type":"string","examples":["2.64"],"description":"The tax amount associated with the line item.","uniqueKey":"oneOf.0.items.[INDEX].exchanges.items.[INDEX].tax","typeLabel":"string"},"total":{"type":"string","examples":["50.64"],"description":"The sum of the product's price and any tax, minus any discount applied.","uniqueKey":"oneOf.0.items.[INDEX].exchanges.items.[INDEX].total","typeLabel":"string"},"out_of_stock":{"type":"boolean","examples":[false],"description":"Whether the product is in or out of stock.","uniqueKey":"oneOf.0.items.[INDEX].exchanges.items.[INDEX].out_of_stock","typeLabel":"boolean"},"out_of_stock_resolution":{"oneOf":[{"type":"string","uniqueKey":"oneOf.0.items.[INDEX].exchanges.items.[INDEX].out_of_stock_resolution.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"oneOf.0.items.[INDEX].exchanges.items.[INDEX].out_of_stock_resolution.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.items.[INDEX].exchanges.items.[INDEX].out_of_stock_resolution","typeLabel":"string | null"},"consolidation_tracking":{"oneOf":[{"type":"string","description":"If a line item is part of a consolidated shipment of many return items,\nthis value holds the tracking value for the consolidated shipment that\ncontains this item such as the Happy Returns Outbound Shipment tracking number.\n","uniqueKey":"oneOf.0.items.[INDEX].exchanges.items.[INDEX].consolidation_tracking.oneOf.0","typeLabel":"string"},{"type":"null","description":"If a line item is part of a consolidated shipment of many return items,\nthis value holds the tracking value for the consolidated shipment that\ncontains this item such as the Happy Returns Outbound Shipment tracking number.\n","uniqueKey":"oneOf.0.items.[INDEX].exchanges.items.[INDEX].consolidation_tracking.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.items.[INDEX].exchanges.items.[INDEX].consolidation_tracking","typeLabel":"string | null"}},"uniqueKey":"oneOf.0.items.[INDEX].exchanges.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.items.[INDEX].exchanges","typeLabel":"object[]"},"carrier":{"type":"string","examples":["N/A"],"description":"The carrier associated with the return.","uniqueKey":"oneOf.0.items.[INDEX].carrier","typeLabel":"string"},"tracking_number":{"type":"string","examples":["N/A"],"description":"The return's tracking number.","uniqueKey":"oneOf.0.items.[INDEX].tracking_number","typeLabel":"string"},"label_status":{"type":"string","examples":["N/A"],"description":"The status of the return shipping label.","uniqueKey":"oneOf.0.items.[INDEX].label_status","typeLabel":"string"},"label_url":{"oneOf":[{"type":"string","examples":["http://example.label.url"],"description":"The link to the shipping label details.","uniqueKey":"oneOf.0.items.[INDEX].label_url.oneOf.0","typeLabel":"string"},{"type":"null","examples":["http://example.label.url"],"description":"The link to the shipping label details.","uniqueKey":"oneOf.0.items.[INDEX].label_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.items.[INDEX].label_url","typeLabel":"string | null"},"label_rate":{"oneOf":[{"type":"string","description":"The shipping rate paid for the return label.","uniqueKey":"oneOf.0.items.[INDEX].label_rate.oneOf.0","typeLabel":"string"},{"type":"null","description":"The shipping rate paid for the return label.","uniqueKey":"oneOf.0.items.[INDEX].label_rate.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.items.[INDEX].label_rate","typeLabel":"string | null"},"status_page_url":{"type":"string","examples":["https://example.loopreturns.com/#/return/{uuid}"],"description":"The link to the Loop return tracking status page associated with the return.","uniqueKey":"oneOf.0.items.[INDEX].status_page_url","typeLabel":"string"},"label_updated_at":{"type":"string","format":"date-time","examples":["N/A"],"description":"The date and time at which the label was last updated, using the ISO 8601 date format.","uniqueKey":"oneOf.0.items.[INDEX].label_updated_at","typeLabel":"string\u003cdate-time>"},"destination_id":{"oneOf":[{"type":"string","examples":["67896541368765"],"description":"The unique identifier associated with the shipping destination of the return.","uniqueKey":"oneOf.0.items.[INDEX].destination_id.oneOf.0","typeLabel":"string"},{"type":"null","examples":["67896541368765"],"description":"The unique identifier associated with the shipping destination of the return.","uniqueKey":"oneOf.0.items.[INDEX].destination_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.items.[INDEX].destination_id","typeLabel":"string | null"},"return_method":{"type":"object","properties":{"provider":{"type":"string","examples":["happy-returns"],"description":"The provider behind the return.","uniqueKey":"oneOf.0.items.[INDEX].return_method.provider","typeLabel":"string"},"method_type":{"type":"string","examples":["drop-off"],"description":"The method in which the return was physically initiated by the customer.","uniqueKey":"oneOf.0.items.[INDEX].return_method.method_type","typeLabel":"string"},"address":{"type":"object","properties":{"id":{"type":"integer","format":"int32","examples":[23432434],"uniqueKey":"oneOf.0.items.[INDEX].return_method.address.id","typeLabel":"integer\u003cint32>"},"hash":{"type":"string","examples":["dd93hf99d83hdops9d8fhh38fhd03hh3"],"uniqueKey":"oneOf.0.items.[INDEX].return_method.address.hash","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","examples":["2021-10-01T03:30:15.000Z"],"uniqueKey":"oneOf.0.items.[INDEX].return_method.address.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","examples":["2021-10-01T03:30:15.000Z"],"uniqueKey":"oneOf.0.items.[INDEX].return_method.address.updated_at","typeLabel":"string\u003cdate-time>"},"name":{"type":"string","examples":["Staples"],"uniqueKey":"oneOf.0.items.[INDEX].return_method.address.name","typeLabel":"string"},"company":{"oneOf":[{"type":"string","examples":["Example Company"],"uniqueKey":"oneOf.0.items.[INDEX].return_method.address.company.oneOf.0","typeLabel":"string"},{"type":"null","examples":["Example Company"],"uniqueKey":"oneOf.0.items.[INDEX].return_method.address.company.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.items.[INDEX].return_method.address.company","typeLabel":"string | null"},"address1":{"type":"string","examples":["1747 Olentangy River Rd"],"uniqueKey":"oneOf.0.items.[INDEX].return_method.address.address1","typeLabel":"string"},"address2":{"type":"string","examples":[""],"uniqueKey":"oneOf.0.items.[INDEX].return_method.address.address2","typeLabel":"string"},"city":{"type":"string","examples":["Columbus"],"uniqueKey":"oneOf.0.items.[INDEX].return_method.address.city","typeLabel":"string"},"state":{"type":"string","examples":["OH"],"uniqueKey":"oneOf.0.items.[INDEX].return_method.address.state","typeLabel":"string"},"zip":{"type":"string","examples":["43212"],"uniqueKey":"oneOf.0.items.[INDEX].return_method.address.zip","typeLabel":"string"},"country":{"type":"string","examples":["United States of America"],"uniqueKey":"oneOf.0.items.[INDEX].return_method.address.country","typeLabel":"string"},"country_code":{"type":"string","examples":["US"],"uniqueKey":"oneOf.0.items.[INDEX].return_method.address.country_code","typeLabel":"string"},"phone":{"type":"string","examples":[""],"uniqueKey":"oneOf.0.items.[INDEX].return_method.address.phone","typeLabel":"string"},"latitude":{"type":"number","examples":[39.995329],"uniqueKey":"oneOf.0.items.[INDEX].return_method.address.latitude","typeLabel":"number"},"longitude":{"type":"number","examples":[-83.026838],"uniqueKey":"oneOf.0.items.[INDEX].return_method.address.longitude","typeLabel":"number"}},"uniqueKey":"oneOf.0.items.[INDEX].return_method.address","typeLabel":"object"},"state":{"type":"string","enum":["new","canceled","pre_transit","in_transit","out_for_delivery","delivered","needs_scheduled","skipped","pickup_failed"],"uniqueKey":"oneOf.0.items.[INDEX].return_method.state","typeLabel":"enum\u003cstring>"},"rma_id":{"type":"string","examples":["HR12345"],"uniqueKey":"oneOf.0.items.[INDEX].return_method.rma_id","typeLabel":"string"},"qr_code_url":{"type":"string","examples":["https://partner.happyreturns.com/barcode/qr?code=HR12345"],"uniqueKey":"oneOf.0.items.[INDEX].return_method.qr_code_url","typeLabel":"string"},"updated_at":{"type":"object","properties":{"date":{"type":"string","uniqueKey":"oneOf.0.items.[INDEX].return_method.updated_at.date","typeLabel":"string"},"timezone_type":{"type":"integer","format":"int32","uniqueKey":"oneOf.0.items.[INDEX].return_method.updated_at.timezone_type","typeLabel":"integer\u003cint32>"},"timezone":{"type":"string","uniqueKey":"oneOf.0.items.[INDEX].return_method.updated_at.timezone","typeLabel":"string"}},"uniqueKey":"oneOf.0.items.[INDEX].return_method.updated_at","typeLabel":"object"},"scheduled_at":{"type":"string","format":"date-time","uniqueKey":"oneOf.0.items.[INDEX].return_method.scheduled_at","typeLabel":"string\u003cdate-time>"},"scannable_id":{"oneOf":[{"type":"string","description":"The data used to scan and lookup return_method data in WMS software","uniqueKey":"oneOf.0.items.[INDEX].return_method.scannable_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The data used to scan and lookup return_method data in WMS software","uniqueKey":"oneOf.0.items.[INDEX].return_method.scannable_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.items.[INDEX].return_method.scannable_id","typeLabel":"string | null"}},"uniqueKey":"oneOf.0.items.[INDEX].return_method","typeLabel":"object"},"package_reference":{"oneOf":[{"type":"string","description":"The data used to look up package data in WMS software.","uniqueKey":"oneOf.0.items.[INDEX].package_reference.oneOf.0","typeLabel":"string"},{"type":"null","description":"The data used to look up package data in WMS software.","uniqueKey":"oneOf.0.items.[INDEX].package_reference.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.items.[INDEX].package_reference","typeLabel":"string | null"},"type":{"type":"string","enum":["standard","warranty"],"description":"The type of return submission.","uniqueKey":"oneOf.0.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"labels":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","examples":["N/A"],"description":"The status of the return shipping label.","uniqueKey":"oneOf.0.items.[INDEX].labels.items.[INDEX].status","typeLabel":"string"},"updated_at":{"type":"string","format":"date-time","examples":["2023-01-01T22:27:18.000Z"],"description":"The date and time at which the label was last updated, using the ISO 8601 date format.","uniqueKey":"oneOf.0.items.[INDEX].labels.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"},"url":{"type":"string","format":"url","examples":["http://example.label.url"],"description":"The link to the shipping label details.","uniqueKey":"oneOf.0.items.[INDEX].labels.items.[INDEX].url","typeLabel":"string\u003curl>"},"rate":{"oneOf":[{"type":"integer","description":"The shipping rate paid for the return label.","uniqueKey":"oneOf.0.items.[INDEX].labels.items.[INDEX].rate.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The shipping rate paid for the return label.","uniqueKey":"oneOf.0.items.[INDEX].labels.items.[INDEX].rate.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.items.[INDEX].labels.items.[INDEX].rate","typeLabel":"integer | null"},"carrier":{"type":"string","examples":["USPS"],"description":"The carrier associated with the return.","uniqueKey":"oneOf.0.items.[INDEX].labels.items.[INDEX].carrier","typeLabel":"string"},"tracking_number":{"type":"string","examples":["9999999999999999999999"],"description":"The tracking number associated with the return.","uniqueKey":"oneOf.0.items.[INDEX].labels.items.[INDEX].tracking_number","typeLabel":"string"},"line_items":{"type":"array","items":{"type":"integer","uniqueKey":"oneOf.0.items.[INDEX].labels.items.[INDEX].line_items.items.[INDEX]","typeLabel":"integer"},"description":"A list of line item ids associated with the label.","examples":[[1001,1002]],"uniqueKey":"oneOf.0.items.[INDEX].labels.items.[INDEX].line_items","typeLabel":"integer[]"}},"uniqueKey":"oneOf.0.items.[INDEX].labels.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.items.[INDEX].labels","typeLabel":"object[]"}},"uniqueKey":"oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0","typeLabel":"object[]"},{"type":"object","description":"Returned when the `paginate` query parameter is present.","properties":{"returns":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","examples":["12345678"],"description":"The unique identifier associated with the return.","uniqueKey":"oneOf.1.returns.items.[INDEX].id","typeLabel":"string"},"state":{"type":"string","examples":["open"],"description":"The current state of the return.","uniqueKey":"oneOf.1.returns.items.[INDEX].state","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","examples":["2023-01-01T22:27:15.000Z"],"description":"The date and time at which the return was created, using the ISO 8601 date format.","uniqueKey":"oneOf.1.returns.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","examples":["2023-01-01T22:27:18.000Z"],"description":"The date and time at which the return was last updated, using the ISO 8601 date format.","uniqueKey":"oneOf.1.returns.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"},"edited_at":{"type":"string","format":"date-time","examples":["2023-01-03T22:34:17.000Z"],"description":"The date and time at which the return was last edited, using the ISO 8601 date format.","uniqueKey":"oneOf.1.returns.items.[INDEX].edited_at","typeLabel":"string\u003cdate-time>"},"total":{"type":"string","examples":["63.30"],"description":"The total cost of the return.","uniqueKey":"oneOf.1.returns.items.[INDEX].total","typeLabel":"string"},"outcome":{"type":"string","enum":["exchange","upsell","refund","credit","exchange+refund","exchange+credit"],"description":"The outcome of the return as limited by the merchant and as selected by the customer.","uniqueKey":"oneOf.1.returns.items.[INDEX].outcome","typeLabel":"enum\u003cstring>"},"order_id":{"type":"string","examples":["98766312"],"description":"The Loop order identifier associated with the return.","uniqueKey":"oneOf.1.returns.items.[INDEX].order_id","typeLabel":"string"},"order_name":{"type":"string","examples":["#7382018"],"description":"The order name.","uniqueKey":"oneOf.1.returns.items.[INDEX].order_name","typeLabel":"string"},"provider_order_id":{"type":"string","examples":["3248923479283"],"description":"The order ID from the commerce provider (e.g. Shopify).","uniqueKey":"oneOf.1.returns.items.[INDEX].provider_order_id","typeLabel":"string"},"order_number":{"type":"string","examples":["7381018"],"description":"The order number.","uniqueKey":"oneOf.1.returns.items.[INDEX].order_number","typeLabel":"string"},"provider_order_number":{"type":"string","examples":["7382018"],"description":"The order number from the commerce provider (e.g. Shopify).","uniqueKey":"oneOf.1.returns.items.[INDEX].provider_order_number","typeLabel":"string"},"customer":{"oneOf":[{"type":"string","examples":["example@example.com"],"description":"The customer's email address.","uniqueKey":"oneOf.1.returns.items.[INDEX].customer.oneOf.0","typeLabel":"string"},{"type":"null","examples":["example@example.com"],"description":"The customer's email address.","uniqueKey":"oneOf.1.returns.items.[INDEX].customer.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.returns.items.[INDEX].customer","typeLabel":"string | null"},"origin_country":{"oneOf":[{"type":"string","examples":["United States"],"description":"The country of the customer's shipping address.","uniqueKey":"oneOf.1.returns.items.[INDEX].origin_country.oneOf.0","typeLabel":"string"},{"type":"null","examples":["United States"],"description":"The country of the customer's shipping address.","uniqueKey":"oneOf.1.returns.items.[INDEX].origin_country.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.returns.items.[INDEX].origin_country","typeLabel":"string | null"},"origin_country_code":{"oneOf":[{"type":"string","examples":["US"],"description":"The ISO 3166-1 alpha-2 country code of the customer's shipping address.","uniqueKey":"oneOf.1.returns.items.[INDEX].origin_country_code.oneOf.0","typeLabel":"string"},{"type":"null","examples":["US"],"description":"The ISO 3166-1 alpha-2 country code of the customer's shipping address.","uniqueKey":"oneOf.1.returns.items.[INDEX].origin_country_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.returns.items.[INDEX].origin_country_code","typeLabel":"string | null"},"multi_currency":{"examples":[false],"description":"Whether the order was placed through Shopify Payments in some currency other than the default store\ncurrency.\n","uniqueKey":"oneOf.1.returns.items.[INDEX].multi_currency","typeLabel":"any"},"currency":{"type":"string","examples":["USD"],"description":"The currency code of the store's default currency.","uniqueKey":"oneOf.1.returns.items.[INDEX].currency","typeLabel":"string"},"return_product_total":{"type":"string","examples":["156.00"],"description":"The gross value of the returning items before discounts and tax.","uniqueKey":"oneOf.1.returns.items.[INDEX].return_product_total","typeLabel":"string"},"return_discount_total":{"type":"string","examples":["0.00"],"description":"The total value of the discounts on the returning items.","uniqueKey":"oneOf.1.returns.items.[INDEX].return_discount_total","typeLabel":"string"},"return_tax_total":{"type":"string","examples":["8.58"],"description":"The total value of the taxes on the returning items.","uniqueKey":"oneOf.1.returns.items.[INDEX].return_tax_total","typeLabel":"string"},"return_total":{"type":"string","examples":["164.58"],"description":"The net value of the returning items after discounts and tax.","uniqueKey":"oneOf.1.returns.items.[INDEX].return_total","typeLabel":"string"},"refund_shipping_total":{"type":"string","examples":["4.00"],"description":"Total original-order shipping reimbursement folded into the refund (the sum of each line item's `refund_shipping`).","uniqueKey":"oneOf.1.returns.items.[INDEX].refund_shipping_total","typeLabel":"string"},"refund_shipping_tax_total":{"type":"string","examples":["0.40"],"description":"The tax portion of the reimbursed shipping folded into the refund (the sum of each line item's `refund_shipping_tax`).","uniqueKey":"oneOf.1.returns.items.[INDEX].refund_shipping_tax_total","typeLabel":"string"},"return_credit_total":{"type":"string","examples":["101.28"],"description":"The value of the returning items credited to the shopper after the refund has been issued.","uniqueKey":"oneOf.1.returns.items.[INDEX].return_credit_total","typeLabel":"string"},"exchange_product_total":{"type":"string","examples":["96.00"],"description":"The gross value of the exchange before discounts and tax.","uniqueKey":"oneOf.1.returns.items.[INDEX].exchange_product_total","typeLabel":"string"},"exchange_discount_total":{"type":"string","examples":["0.00"],"description":"The total value of discounts on the exchange.","uniqueKey":"oneOf.1.returns.items.[INDEX].exchange_discount_total","typeLabel":"string"},"exchange_tax_total":{"type":"string","examples":["5.28"],"description":"The total value of the taxes on the exchange.","uniqueKey":"oneOf.1.returns.items.[INDEX].exchange_tax_total","typeLabel":"string"},"exchange_total":{"type":"string","examples":["101.28"],"description":"The net value of the exchanges after discounts and tax.","uniqueKey":"oneOf.1.returns.items.[INDEX].exchange_total","typeLabel":"string"},"exchange_credit_total":{"type":"string","examples":["101.28"],"description":"The value of the return credit used by the shopper.","uniqueKey":"oneOf.1.returns.items.[INDEX].exchange_credit_total","typeLabel":"string"},"gift_card":{"type":"string","examples":["0.00"],"description":"The value of the gift card issued in the return.","uniqueKey":"oneOf.1.returns.items.[INDEX].gift_card","typeLabel":"string"},"gift_card_order_name":{"oneOf":[{"type":"string","examples":["Gift Card Name"],"description":"The name of the gift card order issued in the return.","uniqueKey":"oneOf.1.returns.items.[INDEX].gift_card_order_name.oneOf.0","typeLabel":"string"},{"type":"null","examples":["Gift Card Name"],"description":"The name of the gift card order issued in the return.","uniqueKey":"oneOf.1.returns.items.[INDEX].gift_card_order_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.returns.items.[INDEX].gift_card_order_name","typeLabel":"string | null"},"gift_card_order_id":{"oneOf":[{"type":"string","examples":["23141001200513"],"description":"The unique identifier of the gift card issued in the return.","uniqueKey":"oneOf.1.returns.items.[INDEX].gift_card_order_id.oneOf.0","typeLabel":"string"},{"type":"null","examples":["23141001200513"],"description":"The unique identifier of the gift card issued in the return.","uniqueKey":"oneOf.1.returns.items.[INDEX].gift_card_order_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.returns.items.[INDEX].gift_card_order_id","typeLabel":"string | null"},"gift_card_presentment":{"type":"object","description":"The gift card credit issued in the return, in the currency the gift card was issued in (the order's presentment currency when available).","properties":{"value":{"type":"string","examples":["0.00"],"description":"The total value of the gift card credit issued in the return.","uniqueKey":"oneOf.1.returns.items.[INDEX].gift_card_presentment.value","typeLabel":"string"},"currency":{"oneOf":[{"type":"string","examples":["CAD"],"description":"The ISO 4217 currency code of `value`.","uniqueKey":"oneOf.1.returns.items.[INDEX].gift_card_presentment.currency.oneOf.0","typeLabel":"string"},{"type":"null","examples":["CAD"],"description":"The ISO 4217 currency code of `value`.","uniqueKey":"oneOf.1.returns.items.[INDEX].gift_card_presentment.currency.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.returns.items.[INDEX].gift_card_presentment.currency","typeLabel":"string | null"}},"uniqueKey":"oneOf.1.returns.items.[INDEX].gift_card_presentment","typeLabel":"object"},"handling_fee":{"type":"string","examples":["0.00"],"description":"The handling fee charged by the merchant.","uniqueKey":"oneOf.1.returns.items.[INDEX].handling_fee","typeLabel":"string"},"refund":{"type":"string","examples":["63.30"],"description":"The amount refunded in the return.","uniqueKey":"oneOf.1.returns.items.[INDEX].refund","typeLabel":"string"},"upsell":{"type":"string","examples":["0.00"],"description":"The upsell amount associated with the return.","uniqueKey":"oneOf.1.returns.items.[INDEX].upsell","typeLabel":"string"},"line_items":{"type":"array","items":{"type":"object","properties":{"line_item_id":{"type":"string","examples":["293482039"],"description":"The unique identifier associated with the line item.","uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].line_item_id","typeLabel":"string"},"provider_line_item_id":{"type":"string","examples":["23984238720"],"description":"The identifier from the commerce provider (e.g. Shopify) associated with the line item.","uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].provider_line_item_id","typeLabel":"string"},"provider_line_item_external_id":{"oneOf":[{"type":"string","description":"Always present on each `line_items` entry (never omitted). The merchant-supplied external identifier for the order line item, as set via the Commerce Data Orders API (`line_items[].external_id`). Resolved from the Commerce Data order line item linked by `provider_line_item_id`. `null` for non-Commerce Data shops (including Shopify), when the line item has no external identifier, when no Commerce Data line item matches, or when the Commerce Data lookup cannot be completed (the request still returns HTTP 200). When a single Commerce Data order line with quantity greater than one is split into multiple returning units, each unit shares this value but has a distinct `line_item_id`.\n","examples":["merchant-line-item-abc-123",null],"uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].provider_line_item_external_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Always present on each `line_items` entry (never omitted). The merchant-supplied external identifier for the order line item, as set via the Commerce Data Orders API (`line_items[].external_id`). Resolved from the Commerce Data order line item linked by `provider_line_item_id`. `null` for non-Commerce Data shops (including Shopify), when the line item has no external identifier, when no Commerce Data line item matches, or when the Commerce Data lookup cannot be completed (the request still returns HTTP 200). When a single Commerce Data order line with quantity greater than one is split into multiple returning units, each unit shares this value but has a distinct `line_item_id`.\n","examples":["merchant-line-item-abc-123",null],"uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].provider_line_item_external_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].provider_line_item_external_id","typeLabel":"string | null"},"product_id":{"type":"string","examples":["29871298310292"],"description":"The unique identifier associated with the product.","uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].product_id","typeLabel":"string"},"variant_id":{"type":"string","examples":["23498287203948"],"description":"The unique identifier associated with the product variant.","uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].variant_id","typeLabel":"string"},"sku":{"type":"string","examples":["2039473-Y"],"description":"The SKU associated with the product.","uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].sku","typeLabel":"string"},"title":{"type":"string","examples":["Black Striped Shirt"],"description":"The product's name.","uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].title","typeLabel":"string"},"price":{"type":"string","examples":["78.00"],"description":"The product's price.","uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].price","typeLabel":"string"},"discount":{"type":"string","examples":["0.00"],"description":"The discount amount associated with the line item.","uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].discount","typeLabel":"string"},"tax":{"type":"string","examples":["4.29"],"description":"The tax amount associated with the line item.","uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].tax","typeLabel":"string"},"refund":{"type":"string","examples":["31.65"],"description":"The refund amount associated with the line item.","uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].refund","typeLabel":"string"},"refund_item":{"type":"string","examples":["27.36"],"description":"The refund amount minus the tax amount.","uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].refund_item","typeLabel":"string"},"refund_tax":{"type":"string","examples":["4.29"],"description":"Equal to the refund.","uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].refund_tax","typeLabel":"string"},"refund_shipping":{"type":"string","examples":["4.00"],"description":"This line's share of the original-order shipping reimbursement folded into `refund`.","uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].refund_shipping","typeLabel":"string"},"refund_excluding_shipping":{"type":"string","examples":["27.65"],"description":"This line's `refund` with shipping removed (`refund` minus `refund_shipping`).","uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].refund_excluding_shipping","typeLabel":"string"},"refund_shipping_tax":{"type":"string","examples":["0.40"],"description":"The tax portion of `refund_shipping`.","uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].refund_shipping_tax","typeLabel":"string"},"refund_excluding_shipping_tax":{"type":"string","examples":["4.29"],"description":"The tax on the items excluding shipping. The existing `refund_tax` already excludes shipping tax, so this value equals `refund_tax`; the corrected total refund tax is `refund_tax` plus `refund_shipping_tax`.","uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].refund_excluding_shipping_tax","typeLabel":"string"},"returned_at":{"type":"string","format":"date-time","examples":["2023-01-01T22:27:16.000Z"],"description":"The date and time at which the item was returned, using the ISO 8601 date format.","uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].returned_at","typeLabel":"string\u003cdate-time>"},"exchange_variant":{"type":"string","examples":[""],"description":"The product variant selected by the customer for exchange (if applicable).","uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].exchange_variant","typeLabel":"string"},"return_reason":{"type":"string","examples":["I like another style more"],"description":"The specific reason for return given by the customer.","uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].return_reason","typeLabel":"string"},"parent_return_reason":{"type":"string","examples":["Didn't like it"],"description":"The general return reason category given by the customer.","uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].parent_return_reason","typeLabel":"string"},"return_comment":{"type":"string","examples":["N/A"],"description":"The optional comment left by the customer when returning the product.","uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].return_comment","typeLabel":"string"},"barcode":{"type":"string","examples":["290832428347"],"description":"The barcode of the product.","uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].barcode","typeLabel":"string"},"outcome":{"type":"string","enum":["reject","donate","review","default","keep"],"examples":["default"],"description":"The return outcome, as permitted by the merchant's return policy.","uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].outcome","typeLabel":"enum\u003cstring>"},"provider_restock_location_id":{"oneOf":[{"type":"string","description":"The restock location for the return.","uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].provider_restock_location_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The restock location for the return.","uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].provider_restock_location_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].provider_restock_location_id","typeLabel":"string | null"},"consolidation_tracking":{"type":"string","examples":["MS6681181"],"description":"If a line item is part of a consolidated shipment of many return items,\nthis value holds the tracking value for the consolidated shipment\nthat contains this item such as the Happy Returns Outbound Shipment tracking number.\n","uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].consolidation_tracking","typeLabel":"string"},"consolidation_destination_id":{"oneOf":[{"type":"string","examples":["357"],"description":"If a line item is part of a consolidated shipment of many return items,\nthis value holds the destination id for the consolidated shipment that\ncontains this item such as the Happy Returns Outbound Shipment\ndestination address id.\n","uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].consolidation_destination_id.oneOf.0","typeLabel":"string"},{"type":"null","examples":["357"],"description":"If a line item is part of a consolidated shipment of many return items,\nthis value holds the destination id for the consolidated shipment that\ncontains this item such as the Happy Returns Outbound Shipment\ndestination address id.\n","uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].consolidation_destination_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].consolidation_destination_id","typeLabel":"string | null"},"condition":{"oneOf":[{"type":"object","properties":{"description":{"type":"string","examples":["Grade A: No refurbishment needed"],"uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].condition.oneOf.0.description","typeLabel":"string"},"condition_category":{"oneOf":[{"type":"string","enum":["grade_a","grade_b","grade_c","grade_d","incorrect_item","missing","junk"],"examples":["grade_c"],"uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].condition.oneOf.0.condition_category.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["grade_a","grade_b","grade_c","grade_d","incorrect_item","missing","junk"],"examples":["grade_c"],"uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].condition.oneOf.0.condition_category.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].condition.oneOf.0.condition_category","typeLabel":"enum\u003cstring> | null"},"return_processor":{"oneOf":[{"type":"string","examples":["warehouse-operator@example.com"],"uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].condition.oneOf.0.return_processor.oneOf.0","typeLabel":"string"},{"type":"null","examples":["warehouse-operator@example.com"],"uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].condition.oneOf.0.return_processor.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].condition.oneOf.0.return_processor","typeLabel":"string | null"},"note":{"oneOf":[{"type":"string","examples":["This item is missing the original packaging. Light refurbishment required. Scuff marks on the back of the item."],"uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].condition.oneOf.0.note.oneOf.0","typeLabel":"string"},{"type":"null","examples":["This item is missing the original packaging. Light refurbishment required. Scuff marks on the back of the item."],"uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].condition.oneOf.0.note.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].condition.oneOf.0.note","typeLabel":"string | null"},"inspected_at":{"type":"string","format":"date-time","examples":["2023-07-19T15:11:32+00:00"],"uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].condition.oneOf.0.inspected_at","typeLabel":"string\u003cdate-time>"},"images":{"type":"array","items":{"type":"string","format":"uri","examples":["https://example.com/image.jpg"],"uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].condition.oneOf.0.images.items.[INDEX]","typeLabel":"string\u003curi>"},"uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].condition.oneOf.0.images","typeLabel":"string\u003curi>[]"}},"uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].condition.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"description":{"type":"string","examples":["Grade A: No refurbishment needed"]},"condition_category":{"oneOf":[{"type":"string","enum":["grade_a","grade_b","grade_c","grade_d","incorrect_item","missing","junk"],"examples":["grade_c"]},{"type":"null","enum":["grade_a","grade_b","grade_c","grade_d","incorrect_item","missing","junk"],"examples":["grade_c"]}]},"return_processor":{"oneOf":[{"type":"string","examples":["warehouse-operator@example.com"]},{"type":"null","examples":["warehouse-operator@example.com"]}]},"note":{"oneOf":[{"type":"string","examples":["This item is missing the original packaging. Light refurbishment required. Scuff marks on the back of the item."]},{"type":"null","examples":["This item is missing the original packaging. Light refurbishment required. Scuff marks on the back of the item."]}]},"inspected_at":{"type":"string","format":"date-time","examples":["2023-07-19T15:11:32+00:00"]},"images":{"type":"array","items":{"type":"string","format":"uri","examples":["https://example.com/image.jpg"]}}},"uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].condition.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].condition","typeLabel":"object | null"},"disposition":{"oneOf":[{"type":"object","properties":{"disposition_outcome":{"type":"string","enum":["back_to_stock","resale_hold","recycle","donate","missing"],"uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].disposition.oneOf.0.disposition_outcome","typeLabel":"enum\u003cstring>"},"return_processor":{"oneOf":[{"type":"string","examples":["warehouse-operator@example.com"],"uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].disposition.oneOf.0.return_processor.oneOf.0","typeLabel":"string"},{"type":"null","examples":["warehouse-operator@example.com"],"uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].disposition.oneOf.0.return_processor.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].disposition.oneOf.0.return_processor","typeLabel":"string | null"},"note":{"oneOf":[{"type":"string","examples":["This item will be returned to stock after bagging and tagging"],"uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].disposition.oneOf.0.note.oneOf.0","typeLabel":"string"},{"type":"null","examples":["This item will be returned to stock after bagging and tagging"],"uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].disposition.oneOf.0.note.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].disposition.oneOf.0.note","typeLabel":"string | null"},"inspected_at":{"type":"string","format":"date-time","examples":["2023-07-19T15:11:32+00:00"],"uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].disposition.oneOf.0.inspected_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].disposition.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"disposition_outcome":{"type":"string","enum":["back_to_stock","resale_hold","recycle","donate","missing"]},"return_processor":{"oneOf":[{"type":"string","examples":["warehouse-operator@example.com"]},{"type":"null","examples":["warehouse-operator@example.com"]}]},"note":{"oneOf":[{"type":"string","examples":["This item will be returned to stock after bagging and tagging"]},{"type":"null","examples":["This item will be returned to stock after bagging and tagging"]}]},"inspected_at":{"type":"string","format":"date-time","examples":["2023-07-19T15:11:32+00:00"]}},"uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].disposition.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX].disposition","typeLabel":"object | null"}},"uniqueKey":"oneOf.1.returns.items.[INDEX].line_items.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.returns.items.[INDEX].line_items","typeLabel":"object[]"},"presentment":{"type":"object","description":"Return totals in the order's presentment (customer) currency, sourced from the stored, provider-authoritative amounts rather than converted from the shop currency. Use this block to reconcile multi-currency returns to the cent; the amounts satisfy `refund + return_credit_total + handling_fee == return_total + return_shipping_total + credit_shipping_total`.","properties":{"currency":{"oneOf":[{"type":"string","examples":["CAD"],"description":"The ISO 4217 code of the order's presentment (customer) currency.","uniqueKey":"oneOf.1.returns.items.[INDEX].presentment.currency.oneOf.0","typeLabel":"string"},{"type":"null","examples":["CAD"],"description":"The ISO 4217 code of the order's presentment (customer) currency.","uniqueKey":"oneOf.1.returns.items.[INDEX].presentment.currency.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.returns.items.[INDEX].presentment.currency","typeLabel":"string | null"},"return_product_total":{"type":"string","examples":["156.00"],"description":"The gross value of the returning items before discounts and tax.","uniqueKey":"oneOf.1.returns.items.[INDEX].presentment.return_product_total","typeLabel":"string"},"return_discount_total":{"type":"string","examples":["0.00"],"description":"The total value of the discounts on the returning items.","uniqueKey":"oneOf.1.returns.items.[INDEX].presentment.return_discount_total","typeLabel":"string"},"return_tax_total":{"type":"string","examples":["8.58"],"description":"The total value of the taxes on the returning items.","uniqueKey":"oneOf.1.returns.items.[INDEX].presentment.return_tax_total","typeLabel":"string"},"return_total":{"type":"string","examples":["164.58"],"description":"The net value of the returning items after discounts and tax (`return_product_total - return_discount_total + return_tax_total`). Items only — excludes reimbursed shipping.","uniqueKey":"oneOf.1.returns.items.[INDEX].presentment.return_total","typeLabel":"string"},"return_shipping_total":{"type":"string","examples":["4.00"],"description":"Reimbursed original-order shipping folded into the refund, tax inclusive.","uniqueKey":"oneOf.1.returns.items.[INDEX].presentment.return_shipping_total","typeLabel":"string"},"return_shipping_tax_total":{"type":"string","examples":["0.40"],"description":"The tax portion already included in `return_shipping_total`. Informational — not an additional amount.","uniqueKey":"oneOf.1.returns.items.[INDEX].presentment.return_shipping_tax_total","typeLabel":"string"},"credit_shipping_total":{"type":"string","examples":["0.00"],"description":"Reimbursed original-order shipping folded into the store credit instead of the refund.","uniqueKey":"oneOf.1.returns.items.[INDEX].presentment.credit_shipping_total","typeLabel":"string"},"handling_fee":{"type":"string","examples":["0.00"],"description":"The handling fee withheld by the merchant (`0.00` when waived).","uniqueKey":"oneOf.1.returns.items.[INDEX].presentment.handling_fee","typeLabel":"string"},"return_credit_total":{"type":"string","examples":["0.00"],"description":"The store credit issued to the shopper. Equal to `gift_card`.","uniqueKey":"oneOf.1.returns.items.[INDEX].presentment.return_credit_total","typeLabel":"string"},"gift_card":{"type":"string","examples":["0.00"],"description":"The value of the gift card issued in the return. Equal to `return_credit_total`.","uniqueKey":"oneOf.1.returns.items.[INDEX].presentment.gift_card","typeLabel":"string"},"refund":{"type":"string","examples":["168.58"],"description":"The total amount refunded to the original payment tender(s).","uniqueKey":"oneOf.1.returns.items.[INDEX].presentment.refund","typeLabel":"string"},"refund_breakdown":{"type":"array","description":"The per-tender split of `refund` — one entry per original payment tender (for example a gift card tender alongside a card).","items":{"type":"object","properties":{"gateway":{"type":"string","examples":["shopify_payments"],"description":"The payment gateway of the original tender (for example `shopify_payments` or `gift_card`).","uniqueKey":"oneOf.1.returns.items.[INDEX].presentment.refund_breakdown.items.[INDEX].gateway","typeLabel":"string"},"provider":{"type":"string","examples":["shopify"],"description":"The commerce provider that processed the refund.","uniqueKey":"oneOf.1.returns.items.[INDEX].presentment.refund_breakdown.items.[INDEX].provider","typeLabel":"string"},"amount":{"type":"string","examples":["168.58"],"description":"The amount refunded to this tender, in the presentment currency.","uniqueKey":"oneOf.1.returns.items.[INDEX].presentment.refund_breakdown.items.[INDEX].amount","typeLabel":"string"},"currency":{"type":"string","examples":["CAD"],"description":"The ISO 4217 currency code of `amount` (the presentment currency).","uniqueKey":"oneOf.1.returns.items.[INDEX].presentment.refund_breakdown.items.[INDEX].currency","typeLabel":"string"}},"uniqueKey":"oneOf.1.returns.items.[INDEX].presentment.refund_breakdown.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.returns.items.[INDEX].presentment.refund_breakdown","typeLabel":"object[]"},"line_items":{"type":"array","description":"Presentment amounts for each returning line item.","items":{"type":"object","properties":{"line_item_id":{"type":"string","examples":["59989689"],"description":"The unique identifier of the returning line item (matches the top-level `line_items` entries).","uniqueKey":"oneOf.1.returns.items.[INDEX].presentment.line_items.items.[INDEX].line_item_id","typeLabel":"string"},"price":{"type":"string","examples":["156.00"],"description":"The price of the line item before discounts and tax.","uniqueKey":"oneOf.1.returns.items.[INDEX].presentment.line_items.items.[INDEX].price","typeLabel":"string"},"discount":{"type":"string","examples":["0.00"],"description":"The discount on the line item.","uniqueKey":"oneOf.1.returns.items.[INDEX].presentment.line_items.items.[INDEX].discount","typeLabel":"string"},"tax":{"type":"string","examples":["8.58"],"description":"The tax on the line item.","uniqueKey":"oneOf.1.returns.items.[INDEX].presentment.line_items.items.[INDEX].tax","typeLabel":"string"}},"uniqueKey":"oneOf.1.returns.items.[INDEX].presentment.line_items.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.returns.items.[INDEX].presentment.line_items","typeLabel":"object[]"}},"uniqueKey":"oneOf.1.returns.items.[INDEX].presentment","typeLabel":"object"},"exchanges":{"type":"array","items":{"type":"object","properties":{"exchange_id":{"type":"string","examples":["23423423"],"description":"The unique identifier associated with the exchange.","uniqueKey":"oneOf.1.returns.items.[INDEX].exchanges.items.[INDEX].exchange_id","typeLabel":"string"},"exchange_order_id":{"type":"integer","format":"int64","examples":[2342352463453],"description":"The unique identifier associated with the exchange order.","uniqueKey":"oneOf.1.returns.items.[INDEX].exchanges.items.[INDEX].exchange_order_id","typeLabel":"integer\u003cint64>"},"exchange_order_name":{"type":"string","examples":["EXC-4736272-1"],"description":"The name of the exchange order.","uniqueKey":"oneOf.1.returns.items.[INDEX].exchanges.items.[INDEX].exchange_order_name","typeLabel":"string"},"product_id":{"type":"string","examples":["2342342342344"],"description":"The unique identifier associated with the product.","uniqueKey":"oneOf.1.returns.items.[INDEX].exchanges.items.[INDEX].product_id","typeLabel":"string"},"variant_id":{"type":"string","examples":["49483943473899"],"description":"The unique identifier associated with the product variant.","uniqueKey":"oneOf.1.returns.items.[INDEX].exchanges.items.[INDEX].variant_id","typeLabel":"string"},"sku":{"type":"string","examples":["2833928-Y"],"description":"The SKU associated with the product.","uniqueKey":"oneOf.1.returns.items.[INDEX].exchanges.items.[INDEX].sku","typeLabel":"string"},"type":{"type":"string","examples":["storefront"],"description":"The order type.","uniqueKey":"oneOf.1.returns.items.[INDEX].exchanges.items.[INDEX].type","typeLabel":"string"},"title":{"type":"string","examples":["Grey Striped Shirt"],"description":"The product's name.","uniqueKey":"oneOf.1.returns.items.[INDEX].exchanges.items.[INDEX].title","typeLabel":"string"},"price":{"type":"string","examples":["48.00"],"description":"The product's price.","uniqueKey":"oneOf.1.returns.items.[INDEX].exchanges.items.[INDEX].price","typeLabel":"string"},"discount":{"type":"string","examples":["0.00"],"description":"The discount amount associated with the exchange.","uniqueKey":"oneOf.1.returns.items.[INDEX].exchanges.items.[INDEX].discount","typeLabel":"string"},"tax":{"type":"string","examples":["2.64"],"description":"The tax amount associated with the line item.","uniqueKey":"oneOf.1.returns.items.[INDEX].exchanges.items.[INDEX].tax","typeLabel":"string"},"total":{"type":"string","examples":["50.64"],"description":"The sum of the product's price and any tax, minus any discount applied.","uniqueKey":"oneOf.1.returns.items.[INDEX].exchanges.items.[INDEX].total","typeLabel":"string"},"out_of_stock":{"type":"boolean","examples":[false],"description":"Whether the product is in or out of stock.","uniqueKey":"oneOf.1.returns.items.[INDEX].exchanges.items.[INDEX].out_of_stock","typeLabel":"boolean"},"out_of_stock_resolution":{"oneOf":[{"type":"string","uniqueKey":"oneOf.1.returns.items.[INDEX].exchanges.items.[INDEX].out_of_stock_resolution.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"oneOf.1.returns.items.[INDEX].exchanges.items.[INDEX].out_of_stock_resolution.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.returns.items.[INDEX].exchanges.items.[INDEX].out_of_stock_resolution","typeLabel":"string | null"},"consolidation_tracking":{"oneOf":[{"type":"string","description":"If a line item is part of a consolidated shipment of many return items,\nthis value holds the tracking value for the consolidated shipment that\ncontains this item such as the Happy Returns Outbound Shipment tracking number.\n","uniqueKey":"oneOf.1.returns.items.[INDEX].exchanges.items.[INDEX].consolidation_tracking.oneOf.0","typeLabel":"string"},{"type":"null","description":"If a line item is part of a consolidated shipment of many return items,\nthis value holds the tracking value for the consolidated shipment that\ncontains this item such as the Happy Returns Outbound Shipment tracking number.\n","uniqueKey":"oneOf.1.returns.items.[INDEX].exchanges.items.[INDEX].consolidation_tracking.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.returns.items.[INDEX].exchanges.items.[INDEX].consolidation_tracking","typeLabel":"string | null"}},"uniqueKey":"oneOf.1.returns.items.[INDEX].exchanges.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.returns.items.[INDEX].exchanges","typeLabel":"object[]"},"carrier":{"type":"string","examples":["N/A"],"description":"The carrier associated with the return.","uniqueKey":"oneOf.1.returns.items.[INDEX].carrier","typeLabel":"string"},"tracking_number":{"type":"string","examples":["N/A"],"description":"The return's tracking number.","uniqueKey":"oneOf.1.returns.items.[INDEX].tracking_number","typeLabel":"string"},"label_status":{"type":"string","examples":["N/A"],"description":"The status of the return shipping label.","uniqueKey":"oneOf.1.returns.items.[INDEX].label_status","typeLabel":"string"},"label_url":{"oneOf":[{"type":"string","examples":["http://example.label.url"],"description":"The link to the shipping label details.","uniqueKey":"oneOf.1.returns.items.[INDEX].label_url.oneOf.0","typeLabel":"string"},{"type":"null","examples":["http://example.label.url"],"description":"The link to the shipping label details.","uniqueKey":"oneOf.1.returns.items.[INDEX].label_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.returns.items.[INDEX].label_url","typeLabel":"string | null"},"label_rate":{"oneOf":[{"type":"string","description":"The shipping rate paid for the return label.","uniqueKey":"oneOf.1.returns.items.[INDEX].label_rate.oneOf.0","typeLabel":"string"},{"type":"null","description":"The shipping rate paid for the return label.","uniqueKey":"oneOf.1.returns.items.[INDEX].label_rate.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.returns.items.[INDEX].label_rate","typeLabel":"string | null"},"status_page_url":{"type":"string","examples":["https://example.loopreturns.com/#/return/{uuid}"],"description":"The link to the Loop return tracking status page associated with the return.","uniqueKey":"oneOf.1.returns.items.[INDEX].status_page_url","typeLabel":"string"},"label_updated_at":{"type":"string","format":"date-time","examples":["N/A"],"description":"The date and time at which the label was last updated, using the ISO 8601 date format.","uniqueKey":"oneOf.1.returns.items.[INDEX].label_updated_at","typeLabel":"string\u003cdate-time>"},"destination_id":{"oneOf":[{"type":"string","examples":["67896541368765"],"description":"The unique identifier associated with the shipping destination of the return.","uniqueKey":"oneOf.1.returns.items.[INDEX].destination_id.oneOf.0","typeLabel":"string"},{"type":"null","examples":["67896541368765"],"description":"The unique identifier associated with the shipping destination of the return.","uniqueKey":"oneOf.1.returns.items.[INDEX].destination_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.returns.items.[INDEX].destination_id","typeLabel":"string | null"},"return_method":{"type":"object","properties":{"provider":{"type":"string","examples":["happy-returns"],"description":"The provider behind the return.","uniqueKey":"oneOf.1.returns.items.[INDEX].return_method.provider","typeLabel":"string"},"method_type":{"type":"string","examples":["drop-off"],"description":"The method in which the return was physically initiated by the customer.","uniqueKey":"oneOf.1.returns.items.[INDEX].return_method.method_type","typeLabel":"string"},"address":{"type":"object","properties":{"id":{"type":"integer","format":"int32","examples":[23432434],"uniqueKey":"oneOf.1.returns.items.[INDEX].return_method.address.id","typeLabel":"integer\u003cint32>"},"hash":{"type":"string","examples":["dd93hf99d83hdops9d8fhh38fhd03hh3"],"uniqueKey":"oneOf.1.returns.items.[INDEX].return_method.address.hash","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","examples":["2021-10-01T03:30:15.000Z"],"uniqueKey":"oneOf.1.returns.items.[INDEX].return_method.address.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","examples":["2021-10-01T03:30:15.000Z"],"uniqueKey":"oneOf.1.returns.items.[INDEX].return_method.address.updated_at","typeLabel":"string\u003cdate-time>"},"name":{"type":"string","examples":["Staples"],"uniqueKey":"oneOf.1.returns.items.[INDEX].return_method.address.name","typeLabel":"string"},"company":{"oneOf":[{"type":"string","examples":["Example Company"],"uniqueKey":"oneOf.1.returns.items.[INDEX].return_method.address.company.oneOf.0","typeLabel":"string"},{"type":"null","examples":["Example Company"],"uniqueKey":"oneOf.1.returns.items.[INDEX].return_method.address.company.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.returns.items.[INDEX].return_method.address.company","typeLabel":"string | null"},"address1":{"type":"string","examples":["1747 Olentangy River Rd"],"uniqueKey":"oneOf.1.returns.items.[INDEX].return_method.address.address1","typeLabel":"string"},"address2":{"type":"string","examples":[""],"uniqueKey":"oneOf.1.returns.items.[INDEX].return_method.address.address2","typeLabel":"string"},"city":{"type":"string","examples":["Columbus"],"uniqueKey":"oneOf.1.returns.items.[INDEX].return_method.address.city","typeLabel":"string"},"state":{"type":"string","examples":["OH"],"uniqueKey":"oneOf.1.returns.items.[INDEX].return_method.address.state","typeLabel":"string"},"zip":{"type":"string","examples":["43212"],"uniqueKey":"oneOf.1.returns.items.[INDEX].return_method.address.zip","typeLabel":"string"},"country":{"type":"string","examples":["United States of America"],"uniqueKey":"oneOf.1.returns.items.[INDEX].return_method.address.country","typeLabel":"string"},"country_code":{"type":"string","examples":["US"],"uniqueKey":"oneOf.1.returns.items.[INDEX].return_method.address.country_code","typeLabel":"string"},"phone":{"type":"string","examples":[""],"uniqueKey":"oneOf.1.returns.items.[INDEX].return_method.address.phone","typeLabel":"string"},"latitude":{"type":"number","examples":[39.995329],"uniqueKey":"oneOf.1.returns.items.[INDEX].return_method.address.latitude","typeLabel":"number"},"longitude":{"type":"number","examples":[-83.026838],"uniqueKey":"oneOf.1.returns.items.[INDEX].return_method.address.longitude","typeLabel":"number"}},"uniqueKey":"oneOf.1.returns.items.[INDEX].return_method.address","typeLabel":"object"},"state":{"type":"string","enum":["new","canceled","pre_transit","in_transit","out_for_delivery","delivered","needs_scheduled","skipped","pickup_failed"],"uniqueKey":"oneOf.1.returns.items.[INDEX].return_method.state","typeLabel":"enum\u003cstring>"},"rma_id":{"type":"string","examples":["HR12345"],"uniqueKey":"oneOf.1.returns.items.[INDEX].return_method.rma_id","typeLabel":"string"},"qr_code_url":{"type":"string","examples":["https://partner.happyreturns.com/barcode/qr?code=HR12345"],"uniqueKey":"oneOf.1.returns.items.[INDEX].return_method.qr_code_url","typeLabel":"string"},"updated_at":{"type":"object","properties":{"date":{"type":"string","uniqueKey":"oneOf.1.returns.items.[INDEX].return_method.updated_at.date","typeLabel":"string"},"timezone_type":{"type":"integer","format":"int32","uniqueKey":"oneOf.1.returns.items.[INDEX].return_method.updated_at.timezone_type","typeLabel":"integer\u003cint32>"},"timezone":{"type":"string","uniqueKey":"oneOf.1.returns.items.[INDEX].return_method.updated_at.timezone","typeLabel":"string"}},"uniqueKey":"oneOf.1.returns.items.[INDEX].return_method.updated_at","typeLabel":"object"},"scheduled_at":{"type":"string","format":"date-time","uniqueKey":"oneOf.1.returns.items.[INDEX].return_method.scheduled_at","typeLabel":"string\u003cdate-time>"},"scannable_id":{"oneOf":[{"type":"string","description":"The data used to scan and lookup return_method data in WMS software","uniqueKey":"oneOf.1.returns.items.[INDEX].return_method.scannable_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The data used to scan and lookup return_method data in WMS software","uniqueKey":"oneOf.1.returns.items.[INDEX].return_method.scannable_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.returns.items.[INDEX].return_method.scannable_id","typeLabel":"string | null"}},"uniqueKey":"oneOf.1.returns.items.[INDEX].return_method","typeLabel":"object"},"package_reference":{"oneOf":[{"type":"string","description":"The data used to look up package data in WMS software.","uniqueKey":"oneOf.1.returns.items.[INDEX].package_reference.oneOf.0","typeLabel":"string"},{"type":"null","description":"The data used to look up package data in WMS software.","uniqueKey":"oneOf.1.returns.items.[INDEX].package_reference.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.returns.items.[INDEX].package_reference","typeLabel":"string | null"},"type":{"type":"string","enum":["standard","warranty"],"description":"The type of return submission.","uniqueKey":"oneOf.1.returns.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"labels":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","examples":["N/A"],"description":"The status of the return shipping label.","uniqueKey":"oneOf.1.returns.items.[INDEX].labels.items.[INDEX].status","typeLabel":"string"},"updated_at":{"type":"string","format":"date-time","examples":["2023-01-01T22:27:18.000Z"],"description":"The date and time at which the label was last updated, using the ISO 8601 date format.","uniqueKey":"oneOf.1.returns.items.[INDEX].labels.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"},"url":{"type":"string","format":"url","examples":["http://example.label.url"],"description":"The link to the shipping label details.","uniqueKey":"oneOf.1.returns.items.[INDEX].labels.items.[INDEX].url","typeLabel":"string\u003curl>"},"rate":{"oneOf":[{"type":"integer","description":"The shipping rate paid for the return label.","uniqueKey":"oneOf.1.returns.items.[INDEX].labels.items.[INDEX].rate.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The shipping rate paid for the return label.","uniqueKey":"oneOf.1.returns.items.[INDEX].labels.items.[INDEX].rate.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.returns.items.[INDEX].labels.items.[INDEX].rate","typeLabel":"integer | null"},"carrier":{"type":"string","examples":["USPS"],"description":"The carrier associated with the return.","uniqueKey":"oneOf.1.returns.items.[INDEX].labels.items.[INDEX].carrier","typeLabel":"string"},"tracking_number":{"type":"string","examples":["9999999999999999999999"],"description":"The tracking number associated with the return.","uniqueKey":"oneOf.1.returns.items.[INDEX].labels.items.[INDEX].tracking_number","typeLabel":"string"},"line_items":{"type":"array","items":{"type":"integer","uniqueKey":"oneOf.1.returns.items.[INDEX].labels.items.[INDEX].line_items.items.[INDEX]","typeLabel":"integer"},"description":"A list of line item ids associated with the label.","examples":[[1001,1002]],"uniqueKey":"oneOf.1.returns.items.[INDEX].labels.items.[INDEX].line_items","typeLabel":"integer[]"}},"uniqueKey":"oneOf.1.returns.items.[INDEX].labels.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.returns.items.[INDEX].labels","typeLabel":"object[]"}},"uniqueKey":"oneOf.1.returns.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.returns","typeLabel":"object[]"},"nextPageUrl":{"oneOf":[{"type":"string","uniqueKey":"oneOf.1.nextPageUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"oneOf.1.nextPageUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.nextPageUrl","typeLabel":"string | null"},"previousPageUrl":{"oneOf":[{"type":"string","uniqueKey":"oneOf.1.previousPageUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"oneOf.1.previousPageUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.previousPageUrl","typeLabel":"string | null"}},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object[] | object"},"examples":{"Example":{"title":"Example","value":[{"id":"12345678","state":"open","created_at":"2023-01-01T22:27:15.000Z","updated_at":"2023-01-01T22:27:18.000Z","edited_at":"2023-01-03T22:34:17.000Z","total":"63.30","outcome":"exchange","order_id":"98766312","order_name":"#7382018","provider_order_id":"3248923479283","order_number":"7381018","provider_order_number":"7382018","customer":"example@example.com","origin_country":"United States","origin_country_code":"US","multi_currency":false,"currency":"USD","return_product_total":"156.00","return_discount_total":"0.00","return_tax_total":"8.58","return_total":"164.58","refund_shipping_total":"4.00","refund_shipping_tax_total":"0.40","return_credit_total":"101.28","exchange_product_total":"96.00","exchange_discount_total":"0.00","exchange_tax_total":"5.28","exchange_total":"101.28","exchange_credit_total":"101.28","gift_card":"0.00","gift_card_order_name":"Gift Card Name","gift_card_order_id":"23141001200513","gift_card_presentment":{"value":"0.00","currency":"CAD"},"handling_fee":"0.00","refund":"63.30","upsell":"0.00","line_items":[{"line_item_id":"293482039","provider_line_item_id":"23984238720","provider_line_item_external_id":"merchant-line-item-abc-123","product_id":"29871298310292","variant_id":"23498287203948","sku":"2039473-Y","title":"Black Striped Shirt","price":"78.00","discount":"0.00","tax":"4.29","refund":"31.65","refund_item":"27.36","refund_tax":"4.29","refund_shipping":"4.00","refund_excluding_shipping":"27.65","refund_shipping_tax":"0.40","refund_excluding_shipping_tax":"4.29","returned_at":"2023-01-01T22:27:16.000Z","exchange_variant":"","return_reason":"I like another style more","parent_return_reason":"Didn't like it","return_comment":"N/A","barcode":"290832428347","outcome":"default","provider_restock_location_id":"\u003cstring>","consolidation_tracking":"MS6681181","consolidation_destination_id":"357","condition":{"description":"Grade A: No refurbishment needed","condition_category":"grade_c","return_processor":"warehouse-operator@example.com","note":"This item is missing the original packaging. Light refurbishment required. Scuff marks on the back of the item.","inspected_at":"2023-07-19T15:11:32+00:00","images":["https://example.com/image.jpg"]},"disposition":{"disposition_outcome":"back_to_stock","return_processor":"warehouse-operator@example.com","note":"This item will be returned to stock after bagging and tagging","inspected_at":"2023-07-19T15:11:32+00:00"}}],"presentment":{"currency":"CAD","return_product_total":"156.00","return_discount_total":"0.00","return_tax_total":"8.58","return_total":"164.58","return_shipping_total":"4.00","return_shipping_tax_total":"0.40","credit_shipping_total":"0.00","handling_fee":"0.00","return_credit_total":"0.00","gift_card":"0.00","refund":"168.58","refund_breakdown":[{"gateway":"shopify_payments","provider":"shopify","amount":"168.58","currency":"CAD"}],"line_items":[{"line_item_id":"59989689","price":"156.00","discount":"0.00","tax":"8.58"}]},"exchanges":[{"exchange_id":"23423423","exchange_order_id":2342352463453,"exchange_order_name":"EXC-4736272-1","product_id":"2342342342344","variant_id":"49483943473899","sku":"2833928-Y","type":"storefront","title":"Grey Striped Shirt","price":"48.00","discount":"0.00","tax":"2.64","total":"50.64","out_of_stock":false,"out_of_stock_resolution":"\u003cstring>","consolidation_tracking":"\u003cstring>"}],"carrier":"N/A","tracking_number":"N/A","label_status":"N/A","label_url":"http://example.label.url","label_rate":"\u003cstring>","status_page_url":"https://example.loopreturns.com/#/return/{uuid}","label_updated_at":"N/A","destination_id":"67896541368765","return_method":{"provider":"happy-returns","method_type":"drop-off","address":{"id":23432434,"hash":"dd93hf99d83hdops9d8fhh38fhd03hh3","created_at":"2021-10-01T03:30:15.000Z","updated_at":"2021-10-01T03:30:15.000Z","name":"Staples","company":"Example Company","address1":"1747 Olentangy River Rd","address2":"","city":"Columbus","state":"OH","zip":"43212","country":"United States of America","country_code":"US","phone":"","latitude":39.995329,"longitude":-83.026838},"state":"new","rma_id":"HR12345","qr_code_url":"https://partner.happyreturns.com/barcode/qr?code=HR12345","updated_at":{"date":"\u003cstring>","timezone_type":123,"timezone":"\u003cstring>"},"scheduled_at":"2023-11-07T05:31:56Z","scannable_id":"\u003cstring>"},"package_reference":"\u003cstring>","type":"standard","labels":[{"status":"N/A","updated_at":"2023-01-01T22:27:18.000Z","url":"http://example.label.url","rate":123,"carrier":"USPS","tracking_number":"9999999999999999999999","line_items":[1001,1002]}]}]}},"exampleType":"generated"}},"exampleType":"generated"},"30f469d8-9270-4889-9564-c79756e6ad61":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"string","examples":["Unauthorized."],"isRequired":true,"uniqueKey":"errors","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":"Unauthorized."}}},"exampleType":"generated"}},"exampleType":"generated"},"b59c16ca-73c3-4b5a-95bb-65665398f202":{"description":"Unprocessable","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"message":{"type":"string","examples":["The `from attribute has an invalid date format."],"uniqueKey":"oneOf.0.message","typeLabel":"string"},"errors":{"type":"object","properties":{"from":{"type":"array","items":{"type":"string","examples":["The `from` attribute has an invalid date format."],"uniqueKey":"oneOf.0.errors.from.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.0.errors.from","typeLabel":"string[]"}},"uniqueKey":"oneOf.0.errors","typeLabel":"object"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","properties":{"message":{"type":"string","examples":["The `to` attribute has an invalid date format."],"uniqueKey":"oneOf.1.message","typeLabel":"string"},"errors":{"type":"object","properties":{"from":{"type":"array","items":{"type":"string","examples":["The `to` attribute has an invalid date format."],"uniqueKey":"oneOf.1.errors.from.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.1.errors.from","typeLabel":"string[]"}},"uniqueKey":"oneOf.1.errors","typeLabel":"object"}},"uniqueKey":"oneOf.1","typeLabel":"object"},{"type":"object","properties":{"message":{"type":"string","examples":["The selected state is invalid."],"uniqueKey":"oneOf.2.message","typeLabel":"string"},"errors":{"type":"object","properties":{"from":{"type":"array","items":{"type":"string","examples":["The selected state is invalid."],"uniqueKey":"oneOf.2.errors.from.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.2.errors.from","typeLabel":"string[]"}},"uniqueKey":"oneOf.2.errors","typeLabel":"object"}},"uniqueKey":"oneOf.2","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"The `from attribute has an invalid date format.","errors":{"from":["The `from` attribute has an invalid date format."]}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"849cf651-0fbb-4f2a-9e64-be11c086bca4":{"api_key":{"type":"apiKey","name":"X-Authorization","in":"header","scopes":[],"schemeName":"api_key"}}},"servers":{"35001b8b-d6cc-40f7-876b-79dcf40cbe57":{"url":"https://api.loopreturns.com/api/2026-10","description":"2026-10 (Stable)"},"6192e428-fa8f-4bee-b9d8-3b60739b3dad":{"url":"https://api.loopreturns.com/api/2026-07","description":"2026-07"},"a8efd23a-faac-4d13-b274-d31db9cb356a":{"url":"https://api.loopreturns.com/api/unstable","description":"Unstable (Preview)"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","name":"X-Authorization","in":"header","scopes":[],"schemeName":"api_key"},"schema":{"title":"X-Authorization","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"api_key","name":"X-Authorization"}],"title":"api_key"}]},"originalFileLocation":"openapi/returns-api.yaml"},"subdomain":"loopreturns","siteName":"Loop Returns Documentation","title":"Detailed Returns List - Loop Returns Documentation","navMaps":{"firstHrefInVersion":{"2026-07":{"href":"/api-reference/latest/return-data/detailed-returns-list","matchLevel":0},"2026-10":{"href":"/api-reference/latest/return-data/detailed-returns-list","matchLevel":0},"unstable":{"href":"/api-reference/latest/return-data/detailed-returns-list","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2025-08-11T14:42:17.593Z","originalFileLocation":"api-reference/latest/return-data/detailed-returns-list.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=\"Pull a detailed list of returns created within a given timeframe. This endpoint supports pagination. We highly encourage using pagination for this endpoint. Read the guide on paginating requests for details. Note: If neither from nor to is passed, the response defaults to only contain returns from the previous 24 hours. See from and to below for more information. Note: The maximum number of days in the range of the from and to properties is 120 days. If the number of days in this range exceeds 120 days, a validation error will be returned. Note: If no state is passed, the response defaults to only contain open, closed, and expired returns. See state below for more information. ### Required API key scope - Returns\">\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=\"Detailed Returns List - Loop Returns Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Pull a detailed list of returns created within a given timeframe. This endpoint supports pagination. We highly encourage using pagination for this endpoint. Read the guide on paginating requests for details. Note: If neither from nor to is passed, the response defaults to only contain returns from the previous 24 hours. See from and to below for more information. Note: The maximum number of days in the range of the from and to properties is 120 days. If the number of days in this range exceeds 120 days, a validation error will be returned. Note: If no state is passed, the response defaults to only contain open, closed, and expired returns. See state below for more information. ### Required API key scope - Returns\">\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/return-data/detailed-returns-list\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://loopreturns.mintlify.app/_mintlify/api/og/v2?division=Return+Data\u0026amp;title=Detailed+Returns+List\u0026amp;description=Pull+a+detailed+list+of+returns+created+within+a+given+timeframe.%0A%0AThis+endpoint+supports+pagination.+We+_highly_%0Aencourage+using+%5Bpagination%5D%28https%3A%2F%2Fdocs.loop\u0026amp;theme=5ccacdea69e246fe33e6ab29\u0026amp;signature=7591c2040755b3ccbe599b8f5702e22275830f0f752779cb57499186f803e0df\">\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=\"Detailed Returns List - Loop Returns Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Pull a detailed list of returns created within a given timeframe. This endpoint supports pagination. We highly encourage using pagination for this endpoint. Read the guide on paginating requests for details. Note: If neither from nor to is passed, the response defaults to only contain returns from the previous 24 hours. See from and to below for more information. Note: The maximum number of days in the range of the from and to properties is 120 days. If the number of days in this range exceeds 120 days, a validation error will be returned. Note: If no state is passed, the response defaults to only contain open, closed, and expired returns. See state below for more information. ### Required API key scope - Returns\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://loopreturns.mintlify.app/_mintlify/api/og/v2?division=Return+Data\u0026amp;title=Detailed+Returns+List\u0026amp;description=Pull+a+detailed+list+of+returns+created+within+a+given+timeframe.%0A%0AThis+endpoint+supports+pagination.+We+_highly_%0Aencourage+using+%5Bpagination%5D%28https%3A%2F%2Fdocs.loop\u0026amp;theme=5ccacdea69e246fe33e6ab29\u0026amp;signature=7591c2040755b3ccbe599b8f5702e22275830f0f752779cb57499186f803e0df\">\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/return-data/detailed-returns-list\">\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/return-data/detailed-returns-list.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/return-data/detailed-returns-list#webpage\",\"url\":\"https://docs.loopreturns.com/api-reference/latest/return-data/detailed-returns-list\",\"name\":\"Detailed Returns List\",\"description\":\"Pull a detailed list of returns created within a given timeframe. This endpoint supports pagination. We highly encourage using pagination for this endpoint. Read the guide on paginating requests for details. Note: If neither from nor to is passed, the response defaults to only contain returns from the previous 24 hours. See from and to below for more information. Note: The maximum number of days in the range of the from and to properties is 120 days. If the number of days in this range exceeds 120 days, a validation error will be returned. Note: If no state is passed, the response defaults to only contain open, closed, and expired returns. See state below for more information. ### Required API key scope - Returns\",\"dateModified\":\"2025-08-11T14:42:17.593Z\",\"isPartOf\":{\"@id\":\"https://docs.loopreturns.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.loopreturns.com/api-reference/latest/return-data/detailed-returns-list#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.loopreturns.com/api-reference/latest/return-data/detailed-returns-list#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\":\"Detailed Returns List\",\"item\":\"https://docs.loopreturns.com/api-reference/latest/return-data/detailed-returns-list\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.loopreturns.com/api-reference/latest/return-data/detailed-returns-list#apireference\",\"headline\":\"Detailed Returns List\",\"name\":\"Detailed Returns List\",\"description\":\"Pull a detailed list of returns created within a given timeframe. This endpoint supports pagination. We highly encourage using pagination for this endpoint. Read the guide on paginating requests for details. Note: If neither from nor to is passed, the response defaults to only contain returns from the previous 24 hours. See from and to below for more information. Note: The maximum number of days in the range of the from and to properties is 120 days. If the number of days in this range exceeds 120 days, a validation error will be returned. Note: If no state is passed, the response defaults to only contain open, closed, and expired returns. See state below for more information. ### Required API key scope - Returns\",\"url\":\"https://docs.loopreturns.com/api-reference/latest/return-data/detailed-returns-list\",\"mainEntityOfPage\":{\"@id\":\"https://docs.loopreturns.com/api-reference/latest/return-data/detailed-returns-list#webpage\"},\"dateModified\":\"2025-08-11T14:42:17.593Z\",\"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","description":"Generate a link to a QR code image file that,\nwhen scanned, will take the user directly to their order in Loop so\nthey can initiate a return without requiring them to enter their order information.\n\nThe deep link URL is also returned. If `type` is not included in the request, or is a non-supported format, a\n`png` will be returned.\n\n### Required API key scope\n- Orders\n","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","description":"Get the details of a specific return based on a return's ID,\nan order name, or an order ID from the commerce provider (e.g. Shopify) depending on the\nquery value of the call.\n\n### Required API key scope\n- Returns\n","href":"/api-reference/latest/return-data/get-return-details"},{"openapi":"get /warehouse/reporting/asn","title":"Advanced Shipping Notice","href":"/api-reference/latest/return-data/advanced-shipping-notice"}]},{"group":"Programmatic Webhooks","pages":[{"openapi":"get /webhooks","title":"Get Webhooks","href":"/api-reference/latest/programmatic-webhooks/get-webhooks"},{"openapi":"post /webhooks","title":"Create Webhook","href":"/api-reference/latest/programmatic-webhooks/create-webhook"},{"openapi":"put /webhooks/{id}","title":"Update Webhook","href":"/api-reference/latest/programmatic-webhooks/update-webhook"},{"openapi":"delete /webhooks/{id}","title":"Delete Webhook","href":"/api-reference/latest/programmatic-webhooks/delete-webhook"}]},{"group":"Item Grading and Dispositioning","pages":[{"openapi":"post /dispositioning/grade","title":"Grade Items","href":"/api-reference/latest/item-grading-and-disposition/grade-items"},{"openapi":"post /dispositioning/assess","title":"Assess Dispositions","href":"/api-reference/latest/item-grading-and-disposition/assess-dispositions"}]},{"group":"Cart","pages":[{"openapi":"post /cart","title":"Create Cart","href":"/api-reference/latest/cart/create-cart"},{"openapi":"get /cart/{token}","title":null,"href":"/api-reference/latest/cart/get-cart"},{"openapi":"post /cart/{token}","title":null,"href":"/api-reference/latest/cart/update-cart"},{"openapi":"delete /cart/{token}","title":null,"href":"/api-reference/latest/cart/delete-cart"}]},{"group":"Destinations","pages":[{"openapi":"get /destinations","title":"Get All Destinations","href":"/api-reference/latest/destinations/get-all-destinations"},{"openapi":"post /destinations","title":"Create Destination","href":"/api-reference/latest/destinations/create-destination"},{"openapi":"get /destinations/{id}","title":"Get Destination Details","href":"/api-reference/latest/destinations/get-destination-details"},{"openapi":"put /destinations/{id}","title":"Update Destination","href":"/api-reference/latest/destinations/update-destination"},{"openapi":"delete /destinations/{id}","title":"Delete Destination","href":"/api-reference/latest/destinations/delete-destination"}]},{"group":"Blocklist","pages":[{"openapi":"get /blocklists","title":"List Blocklist Items","href":"/api-reference/latest/blocklist/list-blocklist-items"},{"openapi":"post /blocklists","title":"Create Blocklist Item","href":"/api-reference/latest/blocklist/create-blocklist-item"},{"openapi":"get /blocklists/{id}","title":"Get Blocklist Item","href":"/api-reference/latest/blocklist/get-blocklist-item"},{"openapi":"delete /blocklists/{id}","title":"Delete Blocklist Item","href":"/api-reference/latest/blocklist/delete-blocklist-item"}]},{"group":"Allowlist","pages":[{"openapi":"get /allowlists","title":"List Allowlist Items","href":"/api-reference/latest/allowlist/list-allowlist-items"},{"openapi":"post /allowlists","title":"Create Allowlist Item","href":"/api-reference/latest/allowlist/create-allowlist-item"},{"openapi":"get /allowlists/{id}","title":"Get Allowlist Item","href":"/api-reference/latest/allowlist/get-allowlist-item"},{"openapi":"delete /allowlists/{id}","title":"Delete Allowlist Item","href":"/api-reference/latest/allowlist/delete-allowlist-item"}]},{"group":"Fraud Reports","pages":[{"openapi":"post /returns/{id}/fraud-report","title":"Create Fraud Report","href":"/api-reference/latest/return-actions/create-fraud-report"}]},{"group":"Order Return Eligibility","pages":[{"openapi":"post /orders/return-eligibility","title":"Look Up Order Return Eligibility by Order Name","href":"/api-reference/latest/orders/look-up-order-return-eligibility"}]},{"group":"Happy Returns Shipments","pages":[{"openapi":"get /happy-returns/shipments/{happy_returns_shipment_id}","title":"Get Shipment Information","href":"/api-reference/latest/happy-returns-shipment/get-shipment-information"},{"openapi":"get /happy-returns/shipments","title":"Get Shipments","href":"/api-reference/latest/happy-returns-shipment/get-shipments"},{"openapi":"get /happy-returns/shipments/{id}/items","title":"Get Shipment Items","href":"/api-reference/latest/happy-returns-shipment-items/get-shipment-items"}]},{"group":"Label Requests","pages":[{"openapi":"get /label-requests","title":"List Label Requests","href":"/api-reference/latest/label-requests/list-label-requests"},{"openapi":"get /label-requests/{id}","title":"Get Label Request","href":"/api-reference/latest/label-requests/get-label-request"},{"openapi":"post /label-requests/{id}/errors","title":"Create Label Request Error","href":"/api-reference/latest/label-requests/create-a-label-request-error"},{"openapi":"post /labels","title":"Create Label","href":"/api-reference/latest/label-requests/create-label"},{"openapi":"post /returns/{returnId}/labels","title":"Generate Label","href":"/api-reference/latest/label-requests/generate-label"},{"openapi":"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"}]},{"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","description":"Generate a link to a QR code image file that,\nwhen scanned, will take the user directly to their order in Loop so\nthey can initiate a return without requiring them to enter their order information.\n\nThe deep link URL is also returned. If `type` is not included in the request, or is a non-supported format, a\n`png` will be returned.\n\n### Required API key scope\n- Orders\n","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","description":"Get the details of a specific return based on a return's ID,\nan order name, or an order ID from the commerce provider (e.g. Shopify) depending on the\nquery value of the call.\n\n### Required API key scope\n- Returns\n","href":"/api-reference/latest/return-data/get-return-details"},{"openapi":"get /warehouse/reporting/asn","title":"Advanced Shipping Notice","href":"/api-reference/latest/return-data/advanced-shipping-notice"}]},{"group":"Programmatic Webhooks","pages":[{"openapi":"get /webhooks","title":"Get Webhooks","href":"/api-reference/latest/programmatic-webhooks/get-webhooks"},{"openapi":"post /webhooks","title":"Create Webhook","href":"/api-reference/latest/programmatic-webhooks/create-webhook"},{"openapi":"put /webhooks/{id}","title":"Update Webhook","href":"/api-reference/latest/programmatic-webhooks/update-webhook"},{"openapi":"delete /webhooks/{id}","title":"Delete Webhook","href":"/api-reference/latest/programmatic-webhooks/delete-webhook"}]},{"group":"Item Grading and Dispositioning","pages":[{"openapi":"post /dispositioning/grade","title":"Grade Items","href":"/api-reference/latest/item-grading-and-disposition/grade-items"},{"openapi":"post /dispositioning/assess","title":"Assess Dispositions","href":"/api-reference/latest/item-grading-and-disposition/assess-dispositions"}]},{"group":"Cart","pages":[{"openapi":"post /cart","title":"Create Cart","href":"/api-reference/latest/cart/create-cart"},{"openapi":"get /cart/{token}","title":null,"href":"/api-reference/latest/cart/get-cart"},{"openapi":"post /cart/{token}","title":null,"href":"/api-reference/latest/cart/update-cart"},{"openapi":"delete /cart/{token}","title":null,"href":"/api-reference/latest/cart/delete-cart"}]},{"group":"Destinations","pages":[{"openapi":"get /destinations","title":"Get All Destinations","href":"/api-reference/latest/destinations/get-all-destinations"},{"openapi":"post /destinations","title":"Create Destination","href":"/api-reference/latest/destinations/create-destination"},{"openapi":"get /destinations/{id}","title":"Get Destination Details","href":"/api-reference/latest/destinations/get-destination-details"},{"openapi":"put /destinations/{id}","title":"Update Destination","href":"/api-reference/latest/destinations/update-destination"},{"openapi":"delete /destinations/{id}","title":"Delete Destination","href":"/api-reference/latest/destinations/delete-destination"}]},{"group":"Blocklist","pages":[{"openapi":"get /blocklists","title":"List Blocklist Items","href":"/api-reference/latest/blocklist/list-blocklist-items"},{"openapi":"post /blocklists","title":"Create Blocklist Item","href":"/api-reference/latest/blocklist/create-blocklist-item"},{"openapi":"get /blocklists/{id}","title":"Get Blocklist Item","href":"/api-reference/latest/blocklist/get-blocklist-item"},{"openapi":"delete /blocklists/{id}","title":"Delete Blocklist Item","href":"/api-reference/latest/blocklist/delete-blocklist-item"}]},{"group":"Allowlist","pages":[{"openapi":"get /allowlists","title":"List Allowlist Items","href":"/api-reference/latest/allowlist/list-allowlist-items"},{"openapi":"post /allowlists","title":"Create Allowlist Item","href":"/api-reference/latest/allowlist/create-allowlist-item"},{"openapi":"get /allowlists/{id}","title":"Get Allowlist Item","href":"/api-reference/latest/allowlist/get-allowlist-item"},{"openapi":"delete /allowlists/{id}","title":"Delete Allowlist Item","href":"/api-reference/latest/allowlist/delete-allowlist-item"}]},{"group":"Fraud Reports","pages":[{"openapi":"post /returns/{id}/fraud-report","title":"Create Fraud Report","href":"/api-reference/latest/return-actions/create-fraud-report"}]},{"group":"Order Return Eligibility","pages":[{"openapi":"post /orders/return-eligibility","title":"Look Up Order Return Eligibility by Order Name","href":"/api-reference/latest/orders/look-up-order-return-eligibility"}]},{"group":"Happy Returns Shipments","pages":[{"openapi":"get /happy-returns/shipments/{happy_returns_shipment_id}","title":"Get Shipment Information","href":"/api-reference/latest/happy-returns-shipment/get-shipment-information"},{"openapi":"get /happy-returns/shipments","title":"Get Shipments","href":"/api-reference/latest/happy-returns-shipment/get-shipments"},{"openapi":"get /happy-returns/shipments/{id}/items","title":"Get Shipment Items","href":"/api-reference/latest/happy-returns-shipment-items/get-shipment-items"}]},{"group":"Label Requests","pages":[{"openapi":"get /label-requests","title":"List Label Requests","href":"/api-reference/latest/label-requests/list-label-requests"},{"openapi":"get /label-requests/{id}","title":"Get Label Request","href":"/api-reference/latest/label-requests/get-label-request"},{"openapi":"post /label-requests/{id}/errors","title":"Create Label Request Error","href":"/api-reference/latest/label-requests/create-a-label-request-error"},{"openapi":"post /labels","title":"Create Label","href":"/api-reference/latest/label-requests/create-label"},{"openapi":"post /returns/{returnId}/labels","title":"Generate Label","href":"/api-reference/latest/label-requests/generate-label"},{"openapi":"put /labels/{id}","title":"Update Label Status","href":"/api-reference/latest/label-requests/update-label-status"}]},{"group":"Return Create (HAL-Forms)","pages":[{"title":"Draft Returns (HAL Forms)","version":"2026-10","href":"/api-reference/2026-10/draft-returns/overview"},{"openapi":"draft-returns-hal-forms get /draft-returns","title":"List Draft Returns","href":"/api-reference/2026-10/draft-returns/list-draft-returns"},{"openapi":"draft-returns-hal-forms get /draft-returns/{draft_return_id}","title":"Get Draft Return","href":"/api-reference/2026-10/draft-returns/get-draft-return"},{"openapi":"draft-returns-hal-forms get /draft-returns/{draft_return_id}/order/items","title":"List Order Line Items","href":"/api-reference/2026-10/draft-returns/list-order-line-items"},{"openapi":"draft-returns-hal-forms get /draft-returns/{draft_return_id}/totals","title":"Get Draft Return Totals","href":"/api-reference/2026-10/draft-returns/get-draft-return-totals"},{"openapi":"draft-returns-hal-forms post /draft-returns","title":"Initialize Draft Return","href":"/api-reference/2026-10/draft-returns/initialize-draft-return"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/accept-return-policy","title":"Accept Return Policy","href":"/api-reference/2026-10/draft-returns/accept-return-policy"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/cancel","title":"Cancel Draft Return","href":"/api-reference/2026-10/draft-returns/cancel-draft-return"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/customer","title":"Set Customer","href":"/api-reference/2026-10/draft-returns/set-customer"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/address","title":"Set Address","href":"/api-reference/2026-10/draft-returns/set-address"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/returning-items","title":"Add Returning Item","href":"/api-reference/2026-10/draft-returns/add-returning-item"},{"openapi":"draft-returns-hal-forms delete /draft-returns/{draft_return_id}/returning-items/{returning_item_id}","title":"Remove Returning Item","href":"/api-reference/2026-10/draft-returns/remove-returning-item"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/returning-items/{returning_item_id}/return-reason","title":"Set Returning Item Return Reason","href":"/api-reference/2026-10/draft-returns/set-returning-item-return-reason"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/returning-items/{returning_item_id}/user-input/{user_input_id}","title":"Add Returning Item User Input","href":"/api-reference/2026-10/draft-returns/add-returning-item-user-input"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/returning-items/{returning_item_id}/return-type","title":"Set Returning Item Return Type","href":"/api-reference/2026-10/draft-returns/set-returning-item-return-type"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/returning-items/{returning_item_id}/exchange-item","title":"Add Returning Item Exchange Item","href":"/api-reference/2026-10/draft-returns/add-returning-item-exchange-item"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/cart/items","title":"Add Cart Item","href":"/api-reference/2026-10/draft-returns/add-cart-item"},{"openapi":"draft-returns-hal-forms delete /draft-returns/{draft_return_id}/cart/items/{cart_item_id}","title":"Remove Cart Item","href":"/api-reference/2026-10/draft-returns/remove-cart-item"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/credit-type","title":"Set Credit Type","href":"/api-reference/2026-10/draft-returns/set-credit-type"},{"openapi":"draft-returns-hal-forms delete /draft-returns/{draft_return_id}/credit-type","title":"Unset Credit Type","href":"/api-reference/2026-10/draft-returns/unset-credit-type"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/processing-type","title":"Set Processing Type","href":"/api-reference/2026-10/draft-returns/set-processing-type"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/finalize-items","title":"Finalize Items","href":"/api-reference/2026-10/draft-returns/finalize-items"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/unfinalize-items","title":"Unfinalize Items","href":"/api-reference/2026-10/draft-returns/unfinalize-items"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/return-method","title":"Select Return Method","href":"/api-reference/2026-10/draft-returns/select-return-method"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/return-method/carrier","title":"Select Return Method Carrier","href":"/api-reference/2026-10/draft-returns/select-return-method-carrier"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/language","title":"Set Language","href":"/api-reference/2026-10/draft-returns/set-language"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/cart","title":"Set Cart","href":"/api-reference/2026-10/draft-returns/set-cart"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/payment-intent","title":"Create Payment Intent","href":"/api-reference/2026-10/draft-returns/create-payment-intent"},{"openapi":"draft-returns-hal-forms delete /draft-returns/{draft_return_id}/payment-intent/{payment_intent_id}","title":"Remove Payment Intent","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"}]},{"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","description":"Generate a link to a QR code image file that,\nwhen scanned, will take the user directly to their order in Loop so\nthey can initiate a return without requiring them to enter their order information.\n\nThe deep link URL is also returned. If `type` is not included in the request, or is a non-supported format, a\n`png` will be returned.\n\n### Required API key scope\n- Orders\n","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","description":"Get the details of a specific return based on a return's ID,\nan order name, or an order ID from the commerce provider (e.g. Shopify) depending on the\nquery value of the call.\n\n### Required API key scope\n- Returns\n","href":"/api-reference/latest/return-data/get-return-details"},{"openapi":"get /warehouse/reporting/asn","title":"Advanced Shipping Notice","href":"/api-reference/latest/return-data/advanced-shipping-notice"}]},{"group":"Programmatic Webhooks","pages":[{"openapi":"get /webhooks","title":"Get Webhooks","href":"/api-reference/latest/programmatic-webhooks/get-webhooks"},{"openapi":"post /webhooks","title":"Create Webhook","href":"/api-reference/latest/programmatic-webhooks/create-webhook"},{"openapi":"put /webhooks/{id}","title":"Update Webhook","href":"/api-reference/latest/programmatic-webhooks/update-webhook"},{"openapi":"delete /webhooks/{id}","title":"Delete Webhook","href":"/api-reference/latest/programmatic-webhooks/delete-webhook"}]},{"group":"Item Grading and Dispositioning","pages":[{"openapi":"post /dispositioning/grade","title":"Grade Items","href":"/api-reference/latest/item-grading-and-disposition/grade-items"},{"openapi":"post /dispositioning/assess","title":"Assess Dispositions","href":"/api-reference/latest/item-grading-and-disposition/assess-dispositions"}]},{"group":"Cart","pages":[{"openapi":"post /cart","title":"Create Cart","href":"/api-reference/latest/cart/create-cart"},{"openapi":"get /cart/{token}","title":null,"href":"/api-reference/latest/cart/get-cart"},{"openapi":"post /cart/{token}","title":null,"href":"/api-reference/latest/cart/update-cart"},{"openapi":"delete /cart/{token}","title":null,"href":"/api-reference/latest/cart/delete-cart"}]},{"group":"Destinations","pages":[{"openapi":"get /destinations","title":"Get All Destinations","href":"/api-reference/latest/destinations/get-all-destinations"},{"openapi":"post /destinations","title":"Create Destination","href":"/api-reference/latest/destinations/create-destination"},{"openapi":"get /destinations/{id}","title":"Get Destination Details","href":"/api-reference/latest/destinations/get-destination-details"},{"openapi":"put /destinations/{id}","title":"Update Destination","href":"/api-reference/latest/destinations/update-destination"},{"openapi":"delete /destinations/{id}","title":"Delete Destination","href":"/api-reference/latest/destinations/delete-destination"}]},{"group":"Blocklist","pages":[{"openapi":"get /blocklists","title":"List Blocklist Items","href":"/api-reference/latest/blocklist/list-blocklist-items"},{"openapi":"post /blocklists","title":"Create Blocklist Item","href":"/api-reference/latest/blocklist/create-blocklist-item"},{"openapi":"get /blocklists/{id}","title":"Get Blocklist Item","href":"/api-reference/latest/blocklist/get-blocklist-item"},{"openapi":"delete /blocklists/{id}","title":"Delete Blocklist Item","href":"/api-reference/latest/blocklist/delete-blocklist-item"}]},{"group":"Allowlist","pages":[{"openapi":"get /allowlists","title":"List Allowlist Items","href":"/api-reference/latest/allowlist/list-allowlist-items"},{"openapi":"post /allowlists","title":"Create Allowlist Item","href":"/api-reference/latest/allowlist/create-allowlist-item"},{"openapi":"get /allowlists/{id}","title":"Get Allowlist Item","href":"/api-reference/latest/allowlist/get-allowlist-item"},{"openapi":"delete /allowlists/{id}","title":"Delete Allowlist Item","href":"/api-reference/latest/allowlist/delete-allowlist-item"}]},{"group":"Fraud Reports","pages":[{"openapi":"post /returns/{id}/fraud-report","title":"Create Fraud Report","href":"/api-reference/latest/return-actions/create-fraud-report"}]},{"group":"Order Return Eligibility","pages":[{"openapi":"post /orders/return-eligibility","title":"Look Up Order Return Eligibility by Order Name","href":"/api-reference/latest/orders/look-up-order-return-eligibility"}]},{"group":"Happy Returns Shipments","pages":[{"openapi":"get /happy-returns/shipments/{happy_returns_shipment_id}","title":"Get Shipment Information","href":"/api-reference/latest/happy-returns-shipment/get-shipment-information"},{"openapi":"get /happy-returns/shipments","title":"Get Shipments","href":"/api-reference/latest/happy-returns-shipment/get-shipments"},{"openapi":"get /happy-returns/shipments/{id}/items","title":"Get Shipment Items","href":"/api-reference/latest/happy-returns-shipment-items/get-shipment-items"}]},{"group":"Label Requests","pages":[{"openapi":"get /label-requests","title":"List Label Requests","href":"/api-reference/latest/label-requests/list-label-requests"},{"openapi":"get /label-requests/{id}","title":"Get Label Request","href":"/api-reference/latest/label-requests/get-label-request"},{"openapi":"post /label-requests/{id}/errors","title":"Create Label Request Error","href":"/api-reference/latest/label-requests/create-a-label-request-error"},{"openapi":"post /labels","title":"Create Label","href":"/api-reference/latest/label-requests/create-label"},{"openapi":"post /returns/{returnId}/labels","title":"Generate Label","href":"/api-reference/latest/label-requests/generate-label"},{"openapi":"put /labels/{id}","title":"Update Label Status","href":"/api-reference/latest/label-requests/update-label-status"}]},{"group":"Return Create (HAL-Forms)","pages":[{"title":"Draft Returns (HAL Forms)","version":"2026-10","href":"/api-reference/2026-10/draft-returns/overview"},{"openapi":"draft-returns-hal-forms get /draft-returns","title":"List Draft Returns","href":"/api-reference/2026-10/draft-returns/list-draft-returns"},{"openapi":"draft-returns-hal-forms get /draft-returns/{draft_return_id}","title":"Get Draft Return","href":"/api-reference/2026-10/draft-returns/get-draft-return"},{"openapi":"draft-returns-hal-forms get /draft-returns/{draft_return_id}/order/items","title":"List Order Line Items","href":"/api-reference/2026-10/draft-returns/list-order-line-items"},{"openapi":"draft-returns-hal-forms get /draft-returns/{draft_return_id}/totals","title":"Get Draft Return Totals","href":"/api-reference/2026-10/draft-returns/get-draft-return-totals"},{"openapi":"draft-returns-hal-forms post /draft-returns","title":"Initialize Draft Return","href":"/api-reference/2026-10/draft-returns/initialize-draft-return"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/accept-return-policy","title":"Accept Return Policy","href":"/api-reference/2026-10/draft-returns/accept-return-policy"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/cancel","title":"Cancel Draft Return","href":"/api-reference/2026-10/draft-returns/cancel-draft-return"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/customer","title":"Set Customer","href":"/api-reference/2026-10/draft-returns/set-customer"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/address","title":"Set Address","href":"/api-reference/2026-10/draft-returns/set-address"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/returning-items","title":"Add Returning Item","href":"/api-reference/2026-10/draft-returns/add-returning-item"},{"openapi":"draft-returns-hal-forms delete /draft-returns/{draft_return_id}/returning-items/{returning_item_id}","title":"Remove Returning Item","href":"/api-reference/2026-10/draft-returns/remove-returning-item"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/returning-items/{returning_item_id}/return-reason","title":"Set Returning Item Return Reason","href":"/api-reference/2026-10/draft-returns/set-returning-item-return-reason"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/returning-items/{returning_item_id}/user-input/{user_input_id}","title":"Add Returning Item User Input","href":"/api-reference/2026-10/draft-returns/add-returning-item-user-input"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/returning-items/{returning_item_id}/return-type","title":"Set Returning Item Return Type","href":"/api-reference/2026-10/draft-returns/set-returning-item-return-type"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/returning-items/{returning_item_id}/exchange-item","title":"Add Returning Item Exchange Item","href":"/api-reference/2026-10/draft-returns/add-returning-item-exchange-item"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/cart/items","title":"Add Cart Item","href":"/api-reference/2026-10/draft-returns/add-cart-item"},{"openapi":"draft-returns-hal-forms delete /draft-returns/{draft_return_id}/cart/items/{cart_item_id}","title":"Remove Cart Item","href":"/api-reference/2026-10/draft-returns/remove-cart-item"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/credit-type","title":"Set Credit Type","href":"/api-reference/2026-10/draft-returns/set-credit-type"},{"openapi":"draft-returns-hal-forms delete /draft-returns/{draft_return_id}/credit-type","title":"Unset Credit Type","href":"/api-reference/2026-10/draft-returns/unset-credit-type"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/processing-type","title":"Set Processing Type","href":"/api-reference/2026-10/draft-returns/set-processing-type"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/finalize-items","title":"Finalize Items","href":"/api-reference/2026-10/draft-returns/finalize-items"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/unfinalize-items","title":"Unfinalize Items","href":"/api-reference/2026-10/draft-returns/unfinalize-items"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/return-method","title":"Select Return Method","href":"/api-reference/2026-10/draft-returns/select-return-method"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/return-method/carrier","title":"Select Return Method Carrier","href":"/api-reference/2026-10/draft-returns/select-return-method-carrier"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/language","title":"Set Language","href":"/api-reference/2026-10/draft-returns/set-language"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/cart","title":"Set Cart","href":"/api-reference/2026-10/draft-returns/set-cart"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/payment-intent","title":"Create Payment Intent","href":"/api-reference/2026-10/draft-returns/create-payment-intent"},{"openapi":"draft-returns-hal-forms delete /draft-returns/{draft_return_id}/payment-intent/{payment_intent_id}","title":"Remove Payment Intent","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"}]},{"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":"Detailed Returns List - Loop Returns Documentation","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}