Optional key that makes this request safe to retry. Send the same key on a retry and Trackstar returns the first attempt's response instead of writing again; if the first attempt failed, the retry runs the write again. Reusing a key with a different request is rejected. Keys expire after 24 hours.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Trackstar","colors":{"primary":"#7691DA","light":"#D3D665","dark":"#2E3B72"},"logo":{"light":"https://mintcdn.com/trackstar/e_R8AMY4ayyVfYRU/logo/light.svg?fit=max\u0026auto=format\u0026n=e_R8AMY4ayyVfYRU\u0026q=85\u0026s=eb832f4ffc768291fd95c4939b2ac6c2","dark":"https://mintcdn.com/trackstar/e_R8AMY4ayyVfYRU/logo/dark.svg?fit=max\u0026auto=format\u0026n=e_R8AMY4ayyVfYRU\u0026q=85\u0026s=1a2845225060cfe1d75c91a7240341a0"},"favicon":"https://mintcdn.com/trackstar/ronaGfFeKtERpohJ/favicon.png?fit=max\u0026auto=format\u0026n=ronaGfFeKtERpohJ\u0026q=85\u0026s=b3a24a0d7d7c7acc8e7394c0640eb8c6","api":{"openapi":"https://production.trackstarhq.com/openapi.json","mdx":{"server":"https://production.trackstarhq.com"}},"navbar":{"primary":{"type":"button","label":"Get an API Key","href":"https://www.trackstarhq.com/#"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/trackstarhq","website":"https://www.trackstarhq.com/"}},"integrations":{"clearbit":{"publicApiKey":"pk_1c5d72a7b03149b504c277cee5b4032a"}},"contextual":{"options":["copy","view","claude","chatgpt","cursor","vscode","mcp","add-mcp","download-spec"],"display":"header"},"markdown":{"instructions":["Trackstar is a unified REST API for WMS, cart, and carrier systems. Base URL: https://production.trackstarhq.com. There is no SDK; call the API with plain HTTP.","Send x-trackstar-api-key on every request. Endpoints scoped to one connection also need x-trackstar-access-token. Read both from environment variables and never print them.","Reads return data Trackstar has already synced from the connected system. Writes (POST, PUT, PATCH, DELETE) are forwarded to the connected system immediately.","A new connection has no data until its initial sync finishes. Wait for the connection.historical-sync-completed webhook, or poll GET /connections/{connection_id} and check historical_sync_completed.","List endpoints page with page_token and next_token (limit is capped at 1000). Repeat every filter on every page. Filters use field[operator]=value, for example created_date[gte]=2026-01-01T00:00:00Z.","Write bodies must not contain null or empty strings; omit the field instead. Call GET /integrations/{integration_type}/{integration_name}/write-info first to learn the exact fields an integration accepts.","To test without real credentials, POST /sandbox/generate-sandbox/{wms|cart|carrier} with the API key returns a sandbox access token. Start at https://docs.trackstarhq.com/how-to-guides/build-with-ai.md and install the skills with: npx skills add https://docs.trackstarhq.com"]},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Request an API Key","icon":"key","href":"https://trackstarhq.com/get-started"},{"anchor":"Login to Dashboard","icon":"browser","href":"https://dashboard.trackstarhq.com"},{"anchor":"WMS Integrations","icon":"warehouse","href":"https://trackstarhq.com/integrations/wms"},{"anchor":"Cart Integrations","icon":"cart-shopping","href":"https://trackstarhq.com/integrations/cart"},{"anchor":"Carrier Integrations","icon":"truck","href":"https://trackstarhq.com/integrations/carrier"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"trackstar","hasAudioNarration":false,"actualSubdomain":"trackstar","customDomains":["docs.trackstarhq.com"],"gitSource":{"type":"github","owner":"trackstarhq","repo":"documentation","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae4f3ab7acf49fac9da16ec","collectionId":"8357bb4d-ef58-4cad-9f49-3af74e319ee4","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae4f3ab7acf49fac9da16ec"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae4f3ab7acf49fac9da16ec","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"Guides","count":67},{"language":"default","tag":"How-To Guides","count":58},{"language":"default","tag":"WMS API","count":55},{"language":"default","tag":"WMS API Reference","count":55},{"language":"default","tag":"Webhooks","count":48},{"language":"default","tag":"WMS","count":29},{"language":"default","tag":"Admin API","count":21},{"language":"default","tag":"Admin API Reference","count":20},{"language":"default","tag":"Orders","count":17},{"language":"default","tag":"Cart API","count":16}]},"assistantConfig":{"enableStarterQuestions":true},"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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/wms-api/returns/put","slug":"/api-reference/wms-api/returns/put","pageMetadata":{"openapi":"put /wms/returns/{return_id}","title":"Update Return","description":"Get the required, optional, and integration specific fields by calling the [integrations](/api-reference/mgmt/integrations) endpoint.","href":"/api-reference/wms-api/returns/put"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Get the required, optional, and integration specific fields by calling the \", _jsx(_components.a, {\n href: \"/api-reference/mgmt/integrations\",\n children: \"integrations\"\n }), \" endpoint.\"]\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":"put /wms/returns/{return_id}","title":"Update Return","description":"Get the required, optional, and integration specific fields by calling the [integrations](/api-reference/mgmt/integrations) endpoint.","href":"/api-reference/wms-api/returns/put"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/trackstar/30b448b1cb413b03/required.js","/_mintlify/custom/trackstar/a23a6fd668fcabff/tab-dropdown.js","/_mintlify/custom/trackstar/bf284930523528a1/write-fields.js"],"openApiReferenceData":{"operation":{"parameters":["6cb4bcd9-0045-4e5f-9246-0b7a5584d35a","db010037-9011-4d58-a898-90788db9ef2d","64a29e24-8f9f-415f-8b97-f4e239212c0b","7dedfbee-9712-4b01-9942-eb60b213dfd6"],"responses":{"200":"9df46cae-ea9d-4f71-9217-73f50e495190","404":"8739e50c-e2a2-4085-827f-fc32cfd6e761","422":"d6ac2af2-87da-4314-b64b-ce739e31104d"},"tags":["wms","Returns"],"summary":"Update Return","description":"Get the required, optional, and integration specific fields by calling the [integrations](/api-reference/mgmt/integrations) endpoint.","operationId":"put_wms_update_return","requestBody":"61c81f31-2170-460d-8401-481c3e55a34a","method":"put","type":"path","servers":["eb5659b4-6eec-462c-991a-7da8383bb677"],"security":[],"path":"/wms/returns/{return_id}","baseUrlOptions":["https://production.trackstarhq.com"],"title":"Update Return","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"6cb4bcd9-0045-4e5f-9246-0b7a5584d35a":{"in":"path","name":"return_id","schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true},"db010037-9011-4d58-a898-90788db9ef2d":{"in":"header","name":"x-trackstar-api-key","description":"Your organization-level Trackstar API key.","schema":{"type":"string","example":"\u003cx-trackstar-api-key>","isRequired":true,"description":"Your organization-level Trackstar API key.","uniqueKey":"","typeLabel":"string"},"required":true},"64a29e24-8f9f-415f-8b97-f4e239212c0b":{"in":"header","name":"x-trackstar-access-token","description":"Your user's access token for a specific integration (ShipHero, Extensiv, etc).","schema":{"type":"string","example":"\u003cx-trackstar-access-token>","isRequired":true,"description":"Your user's access token for a specific integration (ShipHero, Extensiv, etc).","uniqueKey":"","typeLabel":"string"},"required":true},"7dedfbee-9712-4b01-9942-eb60b213dfd6":{"in":"header","name":"Idempotency-Key","description":"Optional key that makes this request safe to retry. Send the same key on a retry and Trackstar returns the first attempt's response instead of writing again; if the first attempt failed, the retry runs the write again. Reusing a key with a different request is rejected. Keys expire after 24 hours.","schema":{"type":"string","minLength":1,"maxLength":255,"example":"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00","isRequired":false,"description":"Optional key that makes this request safe to retry. Send the same key on a retry and Trackstar returns the first attempt's response instead of writing again; if the first attempt failed, the retry runs the write again. Reusing a key with a different request is rejected. Keys expire after 24 hours.","uniqueKey":"","typeLabel":"string"},"required":false}},"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"WMS Sandbox","properties":{"trackstar_tags":{"oneOf":[{"type":"array","description":"A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.","example":["tag1","tag2",{"tag3":"value3"}],"items":{"oneOf":[{}],"uniqueKey":"oneOf.0.trackstar_tags.oneOf.0.items.[INDEX]","typeLabel":"any"},"uniqueKey":"oneOf.0.trackstar_tags.oneOf.0","typeLabel":"any[]"},{"type":"null","description":"A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.","example":["tag1","tag2",{"tag3":"value3"}],"items":{"oneOf":[{}]},"uniqueKey":"oneOf.0.trackstar_tags.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.trackstar_tags","typeLabel":"any[] | null"},"warehouse_id":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse","uniqueKey":"oneOf.0.warehouse_id","typeLabel":"enum\u003cstring>"},"order_id":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id","uniqueKey":"oneOf.0.order_id","typeLabel":"enum\u003cstring>"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"XS-RED-SHIRT","expected_quantity":1,"return_reason":"damaged"}],"items":{"type":"object","properties":{"sku":{"type":"string","enum":["N/A - Connect an account to see options"],"description":"sku","example":"XS-RED-SHIRT","isRequired":true,"uniqueKey":"oneOf.0.line_items.items.[INDEX].sku","typeLabel":"enum\u003cstring>"},"expected_quantity":{"type":"integer","description":"","example":1,"isRequired":true,"uniqueKey":"oneOf.0.line_items.items.[INDEX].expected_quantity","typeLabel":"integer"},"return_reason":{"type":"string","description":"The reason for the return.","example":"damaged","uniqueKey":"oneOf.0.line_items.items.[INDEX].return_reason","typeLabel":"string"}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsSandboxUpdateReturnLineItems","uniqueKey":"oneOf.0.line_items.items.[INDEX]","typeLabel":"WmsSandboxUpdateReturnLineItems · object"},"uniqueKey":"oneOf.0.line_items","typeLabel":"WmsSandboxUpdateReturnLineItems · object[]"}},"additionalProperties":false,"uniqueKey":"oneOf.0","typeLabel":"WMS Sandbox · object"},{"type":"object","title":"Boxzooka","properties":{"trackstar_tags":{"oneOf":[{"type":"array","description":"A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.","example":["tag1","tag2",{"tag3":"value3"}],"items":{"oneOf":[{}],"uniqueKey":"oneOf.1.trackstar_tags.oneOf.0.items.[INDEX]","typeLabel":"any"},"uniqueKey":"oneOf.1.trackstar_tags.oneOf.0","typeLabel":"any[]"},{"type":"null","description":"A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.","example":["tag1","tag2",{"tag3":"value3"}],"items":{"oneOf":[{}]},"uniqueKey":"oneOf.1.trackstar_tags.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.trackstar_tags","typeLabel":"any[] | null"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":1,"return_reason":"return_reason","condition":"condition"}],"items":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku","isRequired":true,"uniqueKey":"oneOf.1.line_items.items.[INDEX].sku","typeLabel":"string"},"expected_quantity":{"type":"integer","description":"","example":1,"isRequired":true,"uniqueKey":"oneOf.1.line_items.items.[INDEX].expected_quantity","typeLabel":"integer"},"return_reason":{"type":"string","description":"","example":"return_reason","uniqueKey":"oneOf.1.line_items.items.[INDEX].return_reason","typeLabel":"string"},"condition":{"type":"string","description":"","example":"condition","uniqueKey":"oneOf.1.line_items.items.[INDEX].condition","typeLabel":"string"}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsReturnWriteLineItemboxzooka","uniqueKey":"oneOf.1.line_items.items.[INDEX]","typeLabel":"WmsReturnWriteLineItemboxzooka · object"},"uniqueKey":"oneOf.1.line_items","typeLabel":"WmsReturnWriteLineItemboxzooka · object[]"},"tracking_number":{"type":"string","description":"The tracking number of the return shipment.","example":"1Z999AA10123456784","uniqueKey":"oneOf.1.tracking_number","typeLabel":"string"},"carrier":{"type":"string","description":"The carrier for the return shipment.","example":"carrier","uniqueKey":"oneOf.1.carrier","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"oneOf.1","typeLabel":"Boxzooka · object"},{"type":"object","title":"Cirro","properties":{"trackstar_tags":{"oneOf":[{"type":"array","description":"A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.","example":["tag1","tag2",{"tag3":"value3"}],"items":{"oneOf":[{}],"uniqueKey":"oneOf.2.trackstar_tags.oneOf.0.items.[INDEX]","typeLabel":"any"},"uniqueKey":"oneOf.2.trackstar_tags.oneOf.0","typeLabel":"any[]"},{"type":"null","description":"A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.","example":["tag1","tag2",{"tag3":"value3"}],"items":{"oneOf":[{}]},"uniqueKey":"oneOf.2.trackstar_tags.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.2.trackstar_tags","typeLabel":"any[] | null"},"warehouse_id":{"type":"string","description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse","uniqueKey":"oneOf.2.warehouse_id","typeLabel":"string"},"carrier_id":{"type":"string","description":"The carrier to use for the return shipment. One of carrier_id or carrier_name is required. Will take precedence over carrier_name if provided.","example":"UPS","uniqueKey":"oneOf.2.carrier_id","typeLabel":"string"},"carrier_name":{"type":"string","description":"The carrier to use for the return shipment","example":"UPS","uniqueKey":"oneOf.2.carrier_name","typeLabel":"string"},"tracking_number":{"type":"string","description":"The tracking number for the return shipment","example":"1Z12345E0205271688","uniqueKey":"oneOf.2.tracking_number","typeLabel":"string"},"reference_number":{"type":"string","description":"The reference number for the return shipment","example":"1234567890","uniqueKey":"oneOf.2.reference_number","typeLabel":"string"},"ship_to_address":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe","isRequired":true,"uniqueKey":"oneOf.2.ship_to_address.full_name","typeLabel":"string"},"address1":{"type":"string","description":"","example":"123 Main St","isRequired":true,"uniqueKey":"oneOf.2.ship_to_address.address1","typeLabel":"string"},"city":{"type":"string","description":"","example":"San Francisco","isRequired":true,"uniqueKey":"oneOf.2.ship_to_address.city","typeLabel":"string"},"state":{"type":"string","description":"","example":"CA","isRequired":true,"uniqueKey":"oneOf.2.ship_to_address.state","typeLabel":"string"},"postal_code":{"type":"string","description":"","example":"94105","isRequired":true,"uniqueKey":"oneOf.2.ship_to_address.postal_code","typeLabel":"string"},"country":{"type":"string","description":"","example":"United States","isRequired":true,"uniqueKey":"oneOf.2.ship_to_address.country","typeLabel":"string"},"address2":{"type":"string","description":"","example":"Apt 2","uniqueKey":"oneOf.2.ship_to_address.address2","typeLabel":"string"}},"required":["address1","city","country","full_name","postal_code","state"],"additionalProperties":false,"title":"ReturnShipToAddressCirro","uniqueKey":"oneOf.2.ship_to_address","typeLabel":"ReturnShipToAddressCirro · object"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","platform_name":"SHOPIFY","expected_quantity":0}],"items":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku","isRequired":true,"uniqueKey":"oneOf.2.line_items.items.[INDEX].sku","typeLabel":"string"},"expected_quantity":{"type":"integer","description":"","example":0,"isRequired":true,"uniqueKey":"oneOf.2.line_items.items.[INDEX].expected_quantity","typeLabel":"integer"},"platform_name":{"type":"string","enum":["AMAZON","SHOPIFY","EBAY","WOOCOMERCE","TIKTOK_SHOP","WALMART","SHEIN","EASYSHIP","IML","LINNWORKS","PRESTASHOP","SKUBANA","ETSY","MINTSOFT","CHANNELADVISOR","SPSCOMMERCE","SHIPSTATION","SPRING","WIX","ECWID","SQUARESPACE","BIGCOMMERCE","MAGENTO","CART.COM","CHORD","XCART","ACENDA","COMMERCETOOLS","VTEX","SELLERACTIVE","WAYFAIR","MIRAKL","HOUZZ","APPARELMAGIC","SALESFORCE","SQUARE"],"description":"The name of the platform from which the sku originates. If provided, will be used to find the Cirro SKU.","example":"SHOPIFY","uniqueKey":"oneOf.2.line_items.items.[INDEX].platform_name","typeLabel":"enum\u003cstring>"}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsReturnWriteLineItemcirro","uniqueKey":"oneOf.2.line_items.items.[INDEX]","typeLabel":"WmsReturnWriteLineItemcirro · object"},"uniqueKey":"oneOf.2.line_items","typeLabel":"WmsReturnWriteLineItemcirro · object[]"},"return_reason":{"type":"string","description":"The reason for the return. Damaged, Defective, Incorrect Item, etc.","example":"return_reason","uniqueKey":"oneOf.2.return_reason","typeLabel":"string"},"order_id":{"type":"string","description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id","uniqueKey":"oneOf.2.order_id","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"oneOf.2","typeLabel":"Cirro · object"},{"type":"object","title":"J\u0026J Global Fulfillment (Control Port)","properties":{"trackstar_tags":{"oneOf":[{"type":"array","description":"A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.","example":["tag1","tag2",{"tag3":"value3"}],"items":{"oneOf":[{}],"uniqueKey":"oneOf.3.trackstar_tags.oneOf.0.items.[INDEX]","typeLabel":"any"},"uniqueKey":"oneOf.3.trackstar_tags.oneOf.0","typeLabel":"any[]"},{"type":"null","description":"A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.","example":["tag1","tag2",{"tag3":"value3"}],"items":{"oneOf":[{}]},"uniqueKey":"oneOf.3.trackstar_tags.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.3.trackstar_tags","typeLabel":"any[] | null"},"warehouse_id":{"type":"string","pattern":"^[0-9]+$","description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","uniqueKey":"oneOf.3.warehouse_id","typeLabel":"string"},"tracking_number":{"type":"string","description":"tracking number for the return shipment","example":"tracking_number","uniqueKey":"oneOf.3.tracking_number","typeLabel":"string"},"carrier_name":{"type":"string","description":"carrier bringing the return back","example":"carrier_name","uniqueKey":"oneOf.3.carrier_name","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"oneOf.3","typeLabel":"J\u0026J Global Fulfillment (Control Port) · object"},{"type":"object","title":"Deposco","required":["line_items"],"properties":{"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","inventory_item_id":"inventory_item_id","expected_quantity":0,"custom_attribute_1":"Custom attribute 1"}],"items":{"oneOf":[{"type":"object","title":"WmsReturnWriteLineItemdeposco","required":["expected_quantity","sku"],"properties":{"sku":{"type":"string","description":"The SKU of the product to return.","example":"sku","isRequired":true,"uniqueKey":"oneOf.4.line_items.items.[INDEX].oneOf.0.sku","typeLabel":"string"},"expected_quantity":{"type":"integer","description":"","example":0,"isRequired":true,"uniqueKey":"oneOf.4.line_items.items.[INDEX].oneOf.0.expected_quantity","typeLabel":"integer"},"inventory_item_id":{"type":"string","description":"Deprecated. Use `sku` instead.","example":"inventory_item_id","uniqueKey":"oneOf.4.line_items.items.[INDEX].oneOf.0.inventory_item_id","typeLabel":"string"},"custom_attribute_1":{"type":"string","description":"Custom attribute 1 on the return line","example":"Custom attribute 1","uniqueKey":"oneOf.4.line_items.items.[INDEX].oneOf.0.custom_attribute_1","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"oneOf.4.line_items.items.[INDEX].oneOf.0","typeLabel":"WmsReturnWriteLineItemdeposco · object"},{"type":"object","title":"WmsReturnWriteLineItemdeposco","required":["expected_quantity","inventory_item_id"],"properties":{"inventory_item_id":{"type":"string","description":"Deprecated. Use `sku` instead.","example":"inventory_item_id","isRequired":true,"uniqueKey":"oneOf.4.line_items.items.[INDEX].oneOf.1.inventory_item_id","typeLabel":"string"},"expected_quantity":{"type":"integer","description":"","example":0,"isRequired":true,"uniqueKey":"oneOf.4.line_items.items.[INDEX].oneOf.1.expected_quantity","typeLabel":"integer"},"sku":{"type":"string","description":"The SKU of the product to return.","example":"sku","uniqueKey":"oneOf.4.line_items.items.[INDEX].oneOf.1.sku","typeLabel":"string"},"custom_attribute_1":{"type":"string","description":"Custom attribute 1 on the return line","example":"Custom attribute 1","uniqueKey":"oneOf.4.line_items.items.[INDEX].oneOf.1.custom_attribute_1","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"oneOf.4.line_items.items.[INDEX].oneOf.1","typeLabel":"WmsReturnWriteLineItemdeposco · object"}],"uniqueKey":"oneOf.4.line_items.items.[INDEX]","typeLabel":"WmsReturnWriteLineItemdeposco · object"},"isRequired":true,"uniqueKey":"oneOf.4.line_items","typeLabel":"WmsReturnWriteLineItemdeposco · object[]"},"trackstar_tags":{"oneOf":[{"type":"array","description":"A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.","example":["tag1","tag2",{"tag3":"value3"}],"items":{"oneOf":[{}],"uniqueKey":"oneOf.4.trackstar_tags.oneOf.0.items.[INDEX]","typeLabel":"any"},"uniqueKey":"oneOf.4.trackstar_tags.oneOf.0","typeLabel":"any[]"},{"type":"null","description":"A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.","example":["tag1","tag2",{"tag3":"value3"}],"items":{"oneOf":[{}]},"uniqueKey":"oneOf.4.trackstar_tags.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.4.trackstar_tags","typeLabel":"any[] | null"},"warehouse_id":{"type":"string","description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse","uniqueKey":"oneOf.4.warehouse_id","typeLabel":"string"},"ship_to_address":{"type":"object","properties":{"address1":{"type":"string","description":"","example":"123 Main St","isRequired":true,"uniqueKey":"oneOf.4.ship_to_address.address1","typeLabel":"string"},"city":{"type":"string","description":"","example":"San Francisco","isRequired":true,"uniqueKey":"oneOf.4.ship_to_address.city","typeLabel":"string"},"state":{"type":"string","description":"","example":"CA","isRequired":true,"uniqueKey":"oneOf.4.ship_to_address.state","typeLabel":"string"},"postal_code":{"type":"string","description":"","example":"94105","isRequired":true,"uniqueKey":"oneOf.4.ship_to_address.postal_code","typeLabel":"string"},"country":{"type":"string","description":"","example":"United States","isRequired":true,"uniqueKey":"oneOf.4.ship_to_address.country","typeLabel":"string"},"full_name":{"type":"string","description":"","example":"John Doe","uniqueKey":"oneOf.4.ship_to_address.full_name","typeLabel":"string"},"address2":{"type":"string","description":"","example":"Apt 2","uniqueKey":"oneOf.4.ship_to_address.address2","typeLabel":"string"}},"required":["address1","city","country","postal_code","state"],"additionalProperties":false,"title":"ReturnShipToAddressDeposco","uniqueKey":"oneOf.4.ship_to_address","typeLabel":"ReturnShipToAddressDeposco · object"},"order_id":{"type":"string","description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id","uniqueKey":"oneOf.4.order_id","typeLabel":"string"},"number":{"type":"string","description":"An optional return number to use for the return. If not provided, a unique number will be generated.","example":"RMA123","uniqueKey":"oneOf.4.number","typeLabel":"string"},"return_reason":{"type":"string","description":"The reason for the return. RTS, Partial Customer Return, Full Customer Return","example":"return_reason","uniqueKey":"oneOf.4.return_reason","typeLabel":"string"},"customer_order_number":{"type":"string","description":"The customer order number in Deposco","example":"PF#","uniqueKey":"oneOf.4.customer_order_number","typeLabel":"string"},"tracking_number":{"type":"string","description":"The tracking number of the return","example":"9434636106023310081309","uniqueKey":"oneOf.4.tracking_number","typeLabel":"string"},"other_reference_number":{"type":"string","description":"Other reference number on the return","example":"9434636106023310081309","uniqueKey":"oneOf.4.other_reference_number","typeLabel":"string"},"order_source":{"type":"string","description":"Name of the external system from which the return originated.","example":"my_system","uniqueKey":"oneOf.4.order_source","typeLabel":"string"},"custom_attribute_1":{"type":"string","description":"Custom attribute 1","example":"Custom attribute 1","uniqueKey":"oneOf.4.custom_attribute_1","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"oneOf.4","typeLabel":"Deposco · object"},{"type":"object","title":"Everstox","required":["line_items","warehouse_id","order_id"],"properties":{"warehouse_id":{"type":"string","description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse","isRequired":true,"uniqueKey":"oneOf.5.warehouse_id","typeLabel":"string"},"order_id":{"type":"string","description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id","isRequired":true,"uniqueKey":"oneOf.5.order_id","typeLabel":"string"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":0,"return_reason":"return_reason"}],"items":{"type":"object","properties":{"sku":{"type":"string","description":"The SKU of the product to return.","example":"sku","isRequired":true,"uniqueKey":"oneOf.5.line_items.items.[INDEX].sku","typeLabel":"string"},"expected_quantity":{"type":"integer","minimum":1,"description":"","example":0,"isRequired":true,"uniqueKey":"oneOf.5.line_items.items.[INDEX].expected_quantity","typeLabel":"integer"},"return_reason":{"type":"string","description":"The reason for the return.","example":"return_reason","uniqueKey":"oneOf.5.line_items.items.[INDEX].return_reason","typeLabel":"string"}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsReturnWriteLineItemeverstox","uniqueKey":"oneOf.5.line_items.items.[INDEX]","typeLabel":"WmsReturnWriteLineItemeverstox · object"},"isRequired":true,"uniqueKey":"oneOf.5.line_items","typeLabel":"WmsReturnWriteLineItemeverstox · object[]"},"trackstar_tags":{"oneOf":[{"type":"array","description":"A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.","example":["tag1","tag2",{"tag3":"value3"}],"items":{"oneOf":[{}],"uniqueKey":"oneOf.5.trackstar_tags.oneOf.0.items.[INDEX]","typeLabel":"any"},"uniqueKey":"oneOf.5.trackstar_tags.oneOf.0","typeLabel":"any[]"},{"type":"null","description":"A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.","example":["tag1","tag2",{"tag3":"value3"}],"items":{"oneOf":[{}]},"uniqueKey":"oneOf.5.trackstar_tags.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.5.trackstar_tags","typeLabel":"any[] | null"},"rma_num":{"type":"string","description":"The return merchandise authorization number. Required when `order_id` is not provided.","example":"RMA123","uniqueKey":"oneOf.5.rma_num","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"oneOf.5","typeLabel":"Everstox · object"},{"type":"object","title":"Everstox","required":["line_items","warehouse_id","rma_num"],"properties":{"warehouse_id":{"type":"string","description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse","isRequired":true,"uniqueKey":"oneOf.6.warehouse_id","typeLabel":"string"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":0,"return_reason":"return_reason"}],"items":{"type":"object","properties":{"sku":{"type":"string","description":"The SKU of the product to return.","example":"sku","isRequired":true,"uniqueKey":"oneOf.6.line_items.items.[INDEX].sku","typeLabel":"string"},"expected_quantity":{"type":"integer","minimum":1,"description":"","example":0,"isRequired":true,"uniqueKey":"oneOf.6.line_items.items.[INDEX].expected_quantity","typeLabel":"integer"},"return_reason":{"type":"string","description":"The reason for the return.","example":"return_reason","uniqueKey":"oneOf.6.line_items.items.[INDEX].return_reason","typeLabel":"string"}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsReturnWriteLineItemeverstox","uniqueKey":"oneOf.6.line_items.items.[INDEX]","typeLabel":"WmsReturnWriteLineItemeverstox · object"},"isRequired":true,"uniqueKey":"oneOf.6.line_items","typeLabel":"WmsReturnWriteLineItemeverstox · object[]"},"rma_num":{"type":"string","description":"The return merchandise authorization number. Required when `order_id` is not provided.","example":"RMA123","isRequired":true,"uniqueKey":"oneOf.6.rma_num","typeLabel":"string"},"trackstar_tags":{"oneOf":[{"type":"array","description":"A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.","example":["tag1","tag2",{"tag3":"value3"}],"items":{"oneOf":[{}],"uniqueKey":"oneOf.6.trackstar_tags.oneOf.0.items.[INDEX]","typeLabel":"any"},"uniqueKey":"oneOf.6.trackstar_tags.oneOf.0","typeLabel":"any[]"},{"type":"null","description":"A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.","example":["tag1","tag2",{"tag3":"value3"}],"items":{"oneOf":[{}]},"uniqueKey":"oneOf.6.trackstar_tags.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.6.trackstar_tags","typeLabel":"any[] | null"},"order_id":{"type":"string","description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id","uniqueKey":"oneOf.6.order_id","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"oneOf.6","typeLabel":"Everstox · object"},{"type":"object","title":"Infoplus","required":["line_items","order_id","return_type","supplier_object","warehouse_id"],"properties":{"warehouse_id":{"type":"string","pattern":"^[0-9]+$","description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","isRequired":true,"uniqueKey":"oneOf.7.warehouse_id","typeLabel":"string"},"supplier_object":{"oneOf":[{"type":"object","title":"SupplierId","description":"The supplier from which the shipment is being sent.","required":["supplier_id"],"properties":{"supplier_id":{"type":"string","description":"The ID of the supplier.","example":"supplier_id","isRequired":true,"uniqueKey":"oneOf.7.supplier_object.oneOf.0.supplier_id","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"oneOf.7.supplier_object.oneOf.0","typeLabel":"SupplierId · object"},{"type":"object","title":"WriteSupplierName","description":"The supplier from which the shipment is being sent.","required":["supplier_name"],"properties":{"supplier_name":{"type":"string","description":"The name of the supplier. If supplier ID is provided, that will take precedence over this.","example":"supplier_name","isRequired":true,"uniqueKey":"oneOf.7.supplier_object.oneOf.1.supplier_name","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"oneOf.7.supplier_object.oneOf.1","typeLabel":"WriteSupplierName · object"}],"isRequired":true,"uniqueKey":"oneOf.7.supplier_object","typeLabel":"SupplierId · object | WriteSupplierName · object"},"return_type":{"type":"string","enum":["Job","Kit","Normal","Transfer","Blind"],"description":"Type of return","example":"Blind","isRequired":true,"uniqueKey":"oneOf.7.return_type","typeLabel":"enum\u003cstring>"},"order_id":{"type":"string","description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id","isRequired":true,"uniqueKey":"oneOf.7.order_id","typeLabel":"string"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":0}],"items":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku","isRequired":true,"uniqueKey":"oneOf.7.line_items.items.[INDEX].sku","typeLabel":"string"},"expected_quantity":{"type":"integer","description":"","example":0,"isRequired":true,"uniqueKey":"oneOf.7.line_items.items.[INDEX].expected_quantity","typeLabel":"integer"}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsReturnWriteLineIteminfoplus","uniqueKey":"oneOf.7.line_items.items.[INDEX]","typeLabel":"WmsReturnWriteLineIteminfoplus · object"},"isRequired":true,"uniqueKey":"oneOf.7.line_items","typeLabel":"WmsReturnWriteLineIteminfoplus · object[]"},"trackstar_tags":{"oneOf":[{"type":"array","description":"A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.","example":["tag1","tag2",{"tag3":"value3"}],"items":{"oneOf":[{}],"uniqueKey":"oneOf.7.trackstar_tags.oneOf.0.items.[INDEX]","typeLabel":"any"},"uniqueKey":"oneOf.7.trackstar_tags.oneOf.0","typeLabel":"any[]"},{"type":"null","description":"A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.","example":["tag1","tag2",{"tag3":"value3"}],"items":{"oneOf":[{}]},"uniqueKey":"oneOf.7.trackstar_tags.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.7.trackstar_tags","typeLabel":"any[] | null"},"warehouse_customer_id":{"oneOf":[{"type":"string","description":"The ID of the merchant/tenant/customer that owns the return. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details. Used for 3PL accounts.","example":"warehouse_customer_id","uniqueKey":"oneOf.7.warehouse_customer_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The ID of the merchant/tenant/customer that owns the return. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details. Used for 3PL accounts.","example":"warehouse_customer_id","uniqueKey":"oneOf.7.warehouse_customer_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.7.warehouse_customer_id","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"oneOf.7","typeLabel":"Infoplus · object"},{"type":"object","title":"Logiwa IO","properties":{"trackstar_tags":{"oneOf":[{"type":"array","description":"A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.","example":["tag1","tag2",{"tag3":"value3"}],"items":{"oneOf":[{}],"uniqueKey":"oneOf.8.trackstar_tags.oneOf.0.items.[INDEX]","typeLabel":"any"},"uniqueKey":"oneOf.8.trackstar_tags.oneOf.0","typeLabel":"any[]"},{"type":"null","description":"A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.","example":["tag1","tag2",{"tag3":"value3"}],"items":{"oneOf":[{}]},"uniqueKey":"oneOf.8.trackstar_tags.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.8.trackstar_tags","typeLabel":"any[] | null"},"order_id":{"type":"string","description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id","uniqueKey":"oneOf.8.order_id","typeLabel":"string"},"warehouse_id":{"type":"string","description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse","uniqueKey":"oneOf.8.warehouse_id","typeLabel":"string"},"rma_number":{"type":"string","description":"An optional RMA number. If not provided, a random one will be generated.","example":"rma_number","uniqueKey":"oneOf.8.rma_number","typeLabel":"string"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":0}],"items":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku","isRequired":true,"uniqueKey":"oneOf.8.line_items.items.[INDEX].sku","typeLabel":"string"},"expected_quantity":{"type":"integer","description":"","example":0,"isRequired":true,"uniqueKey":"oneOf.8.line_items.items.[INDEX].expected_quantity","typeLabel":"integer"}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsReturnWriteLineItemlogiwa-io","uniqueKey":"oneOf.8.line_items.items.[INDEX]","typeLabel":"WmsReturnWriteLineItemlogiwa-io · object"},"uniqueKey":"oneOf.8.line_items","typeLabel":"WmsReturnWriteLineItemlogiwa-io · object[]"},"tracking_number":{"type":"string","description":"The tracking number of the return.","example":"tracking_number","uniqueKey":"oneOf.8.tracking_number","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"oneOf.8","typeLabel":"Logiwa IO · object"},{"type":"object","title":"Luminous","required":["restock"],"properties":{"restock":{"type":"boolean","description":"Whether receiving this return puts stock back into inventory.","example":true,"isRequired":true,"uniqueKey":"oneOf.9.restock","typeLabel":"boolean"},"trackstar_tags":{"oneOf":[{"type":"array","description":"A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.","example":["tag1","tag2",{"tag3":"value3"}],"items":{"oneOf":[{}],"uniqueKey":"oneOf.9.trackstar_tags.oneOf.0.items.[INDEX]","typeLabel":"any"},"uniqueKey":"oneOf.9.trackstar_tags.oneOf.0","typeLabel":"any[]"},{"type":"null","description":"A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.","example":["tag1","tag2",{"tag3":"value3"}],"items":{"oneOf":[{}]},"uniqueKey":"oneOf.9.trackstar_tags.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.9.trackstar_tags","typeLabel":"any[] | null"}},"additionalProperties":false,"uniqueKey":"oneOf.9","typeLabel":"Luminous · object"},{"type":"object","title":"MasonHub","required":["line_items","return_type","ship_from_address"],"properties":{"return_type":{"type":"string","enum":["returned_to_sender","rma_submitted_by_customer","rma_created_by_distribution_center"],"description":"The type of return.","example":"returned_to_sender","isRequired":true,"uniqueKey":"oneOf.10.return_type","typeLabel":"enum\u003cstring>"},"ship_from_address":{"type":"object","properties":{"full_name":{"type":"string","description":"","example":"John Doe","isRequired":true,"uniqueKey":"oneOf.10.ship_from_address.full_name","typeLabel":"string"},"address1":{"type":"string","description":"","example":"123 Main St","isRequired":true,"uniqueKey":"oneOf.10.ship_from_address.address1","typeLabel":"string"},"city":{"type":"string","description":"","example":"San Francisco","isRequired":true,"uniqueKey":"oneOf.10.ship_from_address.city","typeLabel":"string"},"state":{"type":"string","description":"","example":"CA","isRequired":true,"uniqueKey":"oneOf.10.ship_from_address.state","typeLabel":"string"},"postal_code":{"type":"string","description":"","example":"94105","isRequired":true,"uniqueKey":"oneOf.10.ship_from_address.postal_code","typeLabel":"string"},"country":{"type":"string","description":"","example":"United States","isRequired":true,"uniqueKey":"oneOf.10.ship_from_address.country","typeLabel":"string"},"address2":{"type":"string","description":"","example":"Apt 2","uniqueKey":"oneOf.10.ship_from_address.address2","typeLabel":"string"}},"required":["address1","city","country","full_name","postal_code","state"],"additionalProperties":false,"title":"ShipFromAddressMasonhub","isRequired":true,"uniqueKey":"oneOf.10.ship_from_address","typeLabel":"ShipFromAddressMasonhub · object"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":0,"return_reason":"damaged","return_inventory_status":"qc"}],"items":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku","isRequired":true,"uniqueKey":"oneOf.10.line_items.items.[INDEX].sku","typeLabel":"string"},"expected_quantity":{"type":"integer","description":"","example":0,"isRequired":true,"uniqueKey":"oneOf.10.line_items.items.[INDEX].expected_quantity","typeLabel":"integer"},"return_reason":{"type":"string","enum":["tooBig","tooSmall","damaged","wrongItem","other"],"description":"Customer supplied reason code for this return","example":"damaged","isRequired":true,"uniqueKey":"oneOf.10.line_items.items.[INDEX].return_reason","typeLabel":"enum\u003cstring>"},"return_inventory_status":{"type":"string","default":"qc","enum":["available","qc","damaged","quarantine"],"description":"The inventory status to return the units into.","example":"qc","uniqueKey":"oneOf.10.line_items.items.[INDEX].return_inventory_status","typeLabel":"enum\u003cstring>"}},"required":["expected_quantity","return_reason","sku"],"additionalProperties":false,"title":"WmsReturnWriteLineItemmasonhub","uniqueKey":"oneOf.10.line_items.items.[INDEX]","typeLabel":"WmsReturnWriteLineItemmasonhub · object"},"isRequired":true,"uniqueKey":"oneOf.10.line_items","typeLabel":"WmsReturnWriteLineItemmasonhub · object[]"},"trackstar_tags":{"oneOf":[{"type":"array","description":"A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.","example":["tag1","tag2",{"tag3":"value3"}],"items":{"oneOf":[{}],"uniqueKey":"oneOf.10.trackstar_tags.oneOf.0.items.[INDEX]","typeLabel":"any"},"uniqueKey":"oneOf.10.trackstar_tags.oneOf.0","typeLabel":"any[]"},{"type":"null","description":"A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.","example":["tag1","tag2",{"tag3":"value3"}],"items":{"oneOf":[{}]},"uniqueKey":"oneOf.10.trackstar_tags.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.10.trackstar_tags","typeLabel":"any[] | null"},"order_id":{"type":"string","description":"The ID of the original order.","example":"order_id","uniqueKey":"oneOf.10.order_id","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"oneOf.10","typeLabel":"MasonHub · object"},{"type":"object","title":"Ongoing WMS","properties":{"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":0,"return_cause":null}],"items":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku","isRequired":true,"uniqueKey":"oneOf.11.line_items.items.[INDEX].sku","typeLabel":"string"},"expected_quantity":{"type":"integer","description":"","example":0,"isRequired":true,"uniqueKey":"oneOf.11.line_items.items.[INDEX].expected_quantity","typeLabel":"integer"},"return_cause":{"type":"object","properties":{"code":{"type":"string","enum":["N/A"],"description":"The reason code for this return.","example":"code","isRequired":true,"uniqueKey":"oneOf.11.line_items.items.[INDEX].return_cause.code","typeLabel":"enum\u003cstring>"},"return_reason":{"oneOf":[{"type":"string","enum":["Connect an account to get return causes."],"description":"The reason description for this return.","example":"return_reason","uniqueKey":"oneOf.11.line_items.items.[INDEX].return_cause.return_reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["Connect an account to get return causes."],"description":"The reason description for this return.","example":"return_reason","uniqueKey":"oneOf.11.line_items.items.[INDEX].return_cause.return_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.11.line_items.items.[INDEX].return_cause.return_reason","typeLabel":"enum\u003cstring> | null"}},"required":["code"],"additionalProperties":false,"title":"ReturnCause","uniqueKey":"oneOf.11.line_items.items.[INDEX].return_cause","typeLabel":"ReturnCause · object"}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsReturnWriteLineItemongoing","uniqueKey":"oneOf.11.line_items.items.[INDEX]","typeLabel":"WmsReturnWriteLineItemongoing · object"},"uniqueKey":"oneOf.11.line_items","typeLabel":"WmsReturnWriteLineItemongoing · object[]"},"warehouse_id":{"type":"string","pattern":"^[0-9]+$","description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","uniqueKey":"oneOf.11.warehouse_id","typeLabel":"string"},"tracking_number":{"type":"string","description":"","example":"tracking_number","uniqueKey":"oneOf.11.tracking_number","typeLabel":"string"},"tracking_url":{"type":"string","description":"","example":"tracking_url","uniqueKey":"oneOf.11.tracking_url","typeLabel":"string"},"trackstar_tags":{"oneOf":[{"type":"array","description":"A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.","example":["tag1","tag2",{"tag3":"value3"}],"items":{"oneOf":[{}],"uniqueKey":"oneOf.11.trackstar_tags.oneOf.0.items.[INDEX]","typeLabel":"any"},"uniqueKey":"oneOf.11.trackstar_tags.oneOf.0","typeLabel":"any[]"},{"type":"null","description":"A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.","example":["tag1","tag2",{"tag3":"value3"}],"items":{"oneOf":[{}]},"uniqueKey":"oneOf.11.trackstar_tags.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.11.trackstar_tags","typeLabel":"any[] | null"}},"additionalProperties":false,"uniqueKey":"oneOf.11","typeLabel":"Ongoing WMS · object"},{"type":"object","title":"ShipBob","required":["line_items","warehouse_id"],"properties":{"warehouse_id":{"type":"string","description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse","isRequired":true,"uniqueKey":"oneOf.12.warehouse_id","typeLabel":"string"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"inventory_item_id":"inventory_item_id","expected_quantity":0}],"items":{"type":"object","properties":{"inventory_item_id":{"type":"string","description":"","example":"inventory_item_id","isRequired":true,"uniqueKey":"oneOf.12.line_items.items.[INDEX].inventory_item_id","typeLabel":"string"},"expected_quantity":{"type":"integer","description":"","example":0,"isRequired":true,"uniqueKey":"oneOf.12.line_items.items.[INDEX].expected_quantity","typeLabel":"integer"}},"required":["expected_quantity","inventory_item_id"],"additionalProperties":false,"title":"WmsReturnWriteLineItemshipbob","uniqueKey":"oneOf.12.line_items.items.[INDEX]","typeLabel":"WmsReturnWriteLineItemshipbob · object"},"isRequired":true,"uniqueKey":"oneOf.12.line_items","typeLabel":"WmsReturnWriteLineItemshipbob · object[]"},"trackstar_tags":{"oneOf":[{"type":"array","description":"A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.","example":["tag1","tag2",{"tag3":"value3"}],"items":{"oneOf":[{}],"uniqueKey":"oneOf.12.trackstar_tags.oneOf.0.items.[INDEX]","typeLabel":"any"},"uniqueKey":"oneOf.12.trackstar_tags.oneOf.0","typeLabel":"any[]"},{"type":"null","description":"A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.","example":["tag1","tag2",{"tag3":"value3"}],"items":{"oneOf":[{}]},"uniqueKey":"oneOf.12.trackstar_tags.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.12.trackstar_tags","typeLabel":"any[] | null"},"tracking_number":{"type":"string","description":"Tracking number of the return.","example":"tracking_number","uniqueKey":"oneOf.12.tracking_number","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"oneOf.12","typeLabel":"ShipBob · object"},{"type":"object","title":"ShipHero","required":["status","trackstar_tags"],"properties":{"status":{"type":"string","enum":["open","in-transit","receiving","received","cancelled","other"],"description":"The status of the return. See the [return information](info) for more details.","example":"open","isRequired":true,"uniqueKey":"oneOf.13.status","typeLabel":"enum\u003cstring>"},"trackstar_tags":{"oneOf":[{"type":"array","description":"A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.","example":["tag1","tag2",{"tag3":"value3"}],"items":{"oneOf":[{}],"uniqueKey":"oneOf.13.trackstar_tags.oneOf.0.items.[INDEX]","typeLabel":"any"},"isRequired":true,"uniqueKey":"oneOf.13.trackstar_tags.oneOf.0","typeLabel":"any[]"},{"type":"null","description":"A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.","example":["tag1","tag2",{"tag3":"value3"}],"items":{"oneOf":[{}]},"isRequired":true,"uniqueKey":"oneOf.13.trackstar_tags.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.13.trackstar_tags","typeLabel":"any[] | null"}},"additionalProperties":false,"uniqueKey":"oneOf.13","typeLabel":"ShipHero · object"},{"type":"object","title":"ShipMonk","required":["line_items","order_id","return_reason","warehouse_id"],"properties":{"order_id":{"type":"string","description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id","isRequired":true,"uniqueKey":"oneOf.14.order_id","typeLabel":"string"},"warehouse_id":{"type":"string","description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse","isRequired":true,"uniqueKey":"oneOf.14.warehouse_id","typeLabel":"string"},"return_reason":{"type":"string","enum":["reason_exchange","reason_changed_mind","reason_undeliverable","reason_unknown","reason_incorrect_product"],"description":"Reason for the return.","example":"reason_changed_mind","isRequired":true,"uniqueKey":"oneOf.14.return_reason","typeLabel":"enum\u003cstring>"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":0,"desired_action":"damaged_not_resellable"}],"items":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku","isRequired":true,"uniqueKey":"oneOf.14.line_items.items.[INDEX].sku","typeLabel":"string"},"expected_quantity":{"type":"integer","description":"","example":0,"isRequired":true,"uniqueKey":"oneOf.14.line_items.items.[INDEX].expected_quantity","typeLabel":"integer"},"desired_action":{"type":"string","enum":["received_back_into_inventory","damaged_not_resellable"],"description":"Desired action for the returned item.","example":"damaged_not_resellable","isRequired":true,"uniqueKey":"oneOf.14.line_items.items.[INDEX].desired_action","typeLabel":"enum\u003cstring>"}},"required":["desired_action","expected_quantity","sku"],"additionalProperties":false,"title":"WmsReturnWriteLineItemshipmonk","uniqueKey":"oneOf.14.line_items.items.[INDEX]","typeLabel":"WmsReturnWriteLineItemshipmonk · object"},"isRequired":true,"uniqueKey":"oneOf.14.line_items","typeLabel":"WmsReturnWriteLineItemshipmonk · object[]"},"trackstar_tags":{"oneOf":[{"type":"array","description":"A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.","example":["tag1","tag2",{"tag3":"value3"}],"items":{"oneOf":[{}],"uniqueKey":"oneOf.14.trackstar_tags.oneOf.0.items.[INDEX]","typeLabel":"any"},"uniqueKey":"oneOf.14.trackstar_tags.oneOf.0","typeLabel":"any[]"},{"type":"null","description":"A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.","example":["tag1","tag2",{"tag3":"value3"}],"items":{"oneOf":[{}]},"uniqueKey":"oneOf.14.trackstar_tags.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.14.trackstar_tags","typeLabel":"any[] | null"},"tracking_number":{"type":"string","description":"The tracking number for the return.","example":"123456789","uniqueKey":"oneOf.14.tracking_number","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"oneOf.14","typeLabel":"ShipMonk · object"},{"type":"object","title":"ShipStream","properties":{"trackstar_tags":{"oneOf":[{"type":"array","description":"A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.","example":["tag1","tag2",{"tag3":"value3"}],"items":{"oneOf":[{}],"uniqueKey":"oneOf.15.trackstar_tags.oneOf.0.items.[INDEX]","typeLabel":"any"},"uniqueKey":"oneOf.15.trackstar_tags.oneOf.0","typeLabel":"any[]"},{"type":"null","description":"A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.","example":["tag1","tag2",{"tag3":"value3"}],"items":{"oneOf":[{}]},"uniqueKey":"oneOf.15.trackstar_tags.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.15.trackstar_tags","typeLabel":"any[] | null"},"warehouse_id":{"type":"string","pattern":"^[0-9]+$","description":"The ID of the warehouse receiving the return. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","uniqueKey":"oneOf.15.warehouse_id","typeLabel":"string"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"sku":"sku","expected_quantity":0}],"items":{"type":"object","properties":{"sku":{"type":"string","description":"","example":"sku","isRequired":true,"uniqueKey":"oneOf.15.line_items.items.[INDEX].sku","typeLabel":"string"},"expected_quantity":{"type":"integer","description":"","example":0,"isRequired":true,"uniqueKey":"oneOf.15.line_items.items.[INDEX].expected_quantity","typeLabel":"integer"}},"required":["expected_quantity","sku"],"additionalProperties":false,"title":"WmsReturnWriteLineItemshipstream","uniqueKey":"oneOf.15.line_items.items.[INDEX]","typeLabel":"WmsReturnWriteLineItemshipstream · object"},"uniqueKey":"oneOf.15.line_items","typeLabel":"WmsReturnWriteLineItemshipstream · object[]"},"carrier_id":{"type":"string","description":"Carrier ID. Will take precedence over carrier_name if passed.","example":"carrier_id","uniqueKey":"oneOf.15.carrier_id","typeLabel":"string"},"carrier_name":{"type":"string","description":"Carrier name.","example":"carrier_name","uniqueKey":"oneOf.15.carrier_name","typeLabel":"string"},"carrier_tracking_number":{"type":"string","pattern":"^[0-9]+$","description":"Carrier tracking number","uniqueKey":"oneOf.15.carrier_tracking_number","typeLabel":"string"},"customer_name":{"type":"string","description":"Customer name","example":"customer_name","uniqueKey":"oneOf.15.customer_name","typeLabel":"string"},"merchant_order_number":{"type":"string","description":"Merchant order number","example":"merchant_order_number","uniqueKey":"oneOf.15.merchant_order_number","typeLabel":"string"},"tracking_numbers":{"type":"array","description":"List of tracking numbers","items":{"type":"string","description":"","example":"tracking_numbers","uniqueKey":"oneOf.15.tracking_numbers.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.15.tracking_numbers","typeLabel":"string[]"},"merchant_rma_number":{"type":"integer","description":"Merchant RMA number","example":0,"uniqueKey":"oneOf.15.merchant_rma_number","typeLabel":"integer"},"expected_arrival_date":{"type":"string","format":"date","description":"Expected arrival date","example":"2023-03-15","uniqueKey":"oneOf.15.expected_arrival_date","typeLabel":"string\u003cdate>"},"notes":{"type":"string","description":"Notes","example":"notes","uniqueKey":"oneOf.15.notes","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"oneOf.15","typeLabel":"ShipStream · object"},{"type":"object","title":"Whiplash (Ryder)","properties":{"requires_label":{"type":"boolean","description":"Whether or not a label is required.","example":true,"uniqueKey":"oneOf.16.requires_label","typeLabel":"boolean"},"carrier_id":{"type":"string","default":"Whiplash","description":"The carrier for the return. Defaults to 'Whiplash'.","example":"Whiplash","uniqueKey":"oneOf.16.carrier_id","typeLabel":"string"},"tracking_number":{"type":"string","description":"","example":"tracking_number","uniqueKey":"oneOf.16.tracking_number","typeLabel":"string"},"trackstar_tags":{"oneOf":[{"type":"array","description":"A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.","example":["tag1","tag2",{"tag3":"value3"}],"items":{"oneOf":[{}],"uniqueKey":"oneOf.16.trackstar_tags.oneOf.0.items.[INDEX]","typeLabel":"any"},"uniqueKey":"oneOf.16.trackstar_tags.oneOf.0","typeLabel":"any[]"},{"type":"null","description":"A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.","example":["tag1","tag2",{"tag3":"value3"}],"items":{"oneOf":[{}]},"uniqueKey":"oneOf.16.trackstar_tags.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.16.trackstar_tags","typeLabel":"any[] | null"}},"additionalProperties":false,"uniqueKey":"oneOf.16","typeLabel":"Whiplash (Ryder) · object"}],"uniqueKey":"","typeLabel":"WMS Sandbox · object · Boxzooka · object · Cirro · object · J\u0026J Global Fulfillment (Control Port) · object · Deposco · object · Everstox · object · Everstox · object · Infoplus · object · Logiwa IO · object · Luminous · object · MasonHub · object · Ongoing WMS · object · ShipBob · object · ShipHero · object · ShipMonk · object · ShipStream · object · Whiplash (Ryder) · object"},"examples":{"Example":{"title":"Example","value":{"trackstar_tags":["tag1","tag2",{"tag3":"value3"}],"warehouse_id":"warehouse","order_id":"order_id","line_items":[{"sku":"XS-RED-SHIRT","expected_quantity":1,"return_reason":"damaged"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"9df46cae-ea9d-4f71-9217-73f50e495190":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the object that has been created or modified","example":"id","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"unused_fields":{"type":"array","description":"Unused fields","items":{"type":"string","description":"","example":"unused_fields","uniqueKey":"unused_fields.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"unused_fields","typeLabel":"string[]"},"data":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the return.","example":"return_id","isRequired":true,"uniqueKey":"data.id","typeLabel":"string"},"warehouse_customer_id":{"oneOf":[{"type":"string","description":"The ID of the merchant/tenant/customer that owns the return. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id","isRequired":true,"uniqueKey":"data.warehouse_customer_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The ID of the merchant/tenant/customer that owns the return. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details.","example":"warehouse_customer_id","isRequired":true,"uniqueKey":"data.warehouse_customer_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.warehouse_customer_id","typeLabel":"string | null"},"created_date":{"type":"string","format":"date-time","description":"The date the return was created.","example":"2022-01-01T00:00:00Z","isRequired":true,"uniqueKey":"data.created_date","typeLabel":"string\u003cdate-time>"},"updated_date":{"type":"string","format":"date-time","description":"The date the return was last updated.","example":"2022-01-02T05:05:05Z","isRequired":true,"uniqueKey":"data.updated_date","typeLabel":"string\u003cdate-time>"},"status":{"type":"string","enum":["open","in-transit","receiving","received","cancelled","other"],"description":"The status of the return. See the [return information](info) for more details.","example":"open","isRequired":true,"uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"raw_status":{"oneOf":[{"type":"string","description":"The raw status (if available) returned directly from the WMS.","example":"raw_status","isRequired":true,"uniqueKey":"data.raw_status.oneOf.0","typeLabel":"string"},{"type":"null","description":"The raw status (if available) returned directly from the WMS.","example":"raw_status","isRequired":true,"uniqueKey":"data.raw_status.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.raw_status","typeLabel":"string | null"},"order_id":{"oneOf":[{"type":"string","description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id","isRequired":true,"uniqueKey":"data.order_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The ID of the order that the return is associated with. Can be passed into the [Order](/api-reference/wms-api/orders/get-item) endpoint for more details.","example":"order_id","isRequired":true,"uniqueKey":"data.order_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.order_id","typeLabel":"string | null"},"notes":{"type":"array","description":"A list of notes associated with the return.","example":["This is a note"],"items":{"type":"string","description":"This is a note","example":"notes","uniqueKey":"data.notes.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"data.notes","typeLabel":"string[]"},"line_items":{"type":"array","description":"A list of inventory items included in the return.","example":[{"inventory_item_id":"item_id","sku":"sku","expected_quantity":1,"received_quantity":1,"restocked_quantity":1,"return_reason":"Too Small"}],"items":{"type":"object","properties":{"inventory_item_id":{"type":"string","description":"Can be passed into the [Inventory](/api-reference/wms-api/inventory/get-item) endpoint for more details.","example":"item_id","isRequired":true,"uniqueKey":"data.line_items.items.[INDEX].inventory_item_id","typeLabel":"string"},"sku":{"oneOf":[{"type":"string","description":"","example":"sku","isRequired":true,"uniqueKey":"data.line_items.items.[INDEX].sku.oneOf.0","typeLabel":"string"},{"type":"null","description":"","example":"sku","isRequired":true,"uniqueKey":"data.line_items.items.[INDEX].sku.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.line_items.items.[INDEX].sku","typeLabel":"string | null"},"expected_quantity":{"type":"integer","description":"How many units are expected to arrive.","example":1,"isRequired":true,"uniqueKey":"data.line_items.items.[INDEX].expected_quantity","typeLabel":"integer"},"received_quantity":{"type":"integer","description":"How many units actually arrived.","example":1,"isRequired":true,"uniqueKey":"data.line_items.items.[INDEX].received_quantity","typeLabel":"integer"},"restocked_quantity":{"oneOf":[{"type":"integer","description":"The number of returned inventory items that have been restocked.","example":1,"isRequired":true,"uniqueKey":"data.line_items.items.[INDEX].restocked_quantity.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of returned inventory items that have been restocked.","example":1,"isRequired":true,"uniqueKey":"data.line_items.items.[INDEX].restocked_quantity.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.line_items.items.[INDEX].restocked_quantity","typeLabel":"integer | null"},"return_reason":{"oneOf":[{"type":"string","description":"The reason for the return.","example":"Too Small","isRequired":true,"uniqueKey":"data.line_items.items.[INDEX].return_reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"The reason for the return.","example":"Too Small","isRequired":true,"uniqueKey":"data.line_items.items.[INDEX].return_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.line_items.items.[INDEX].return_reason","typeLabel":"string | null"}},"required":["expected_quantity","inventory_item_id","received_quantity","restocked_quantity","return_reason","sku"],"additionalProperties":false,"title":"WmsReturnLineItem","uniqueKey":"data.line_items.items.[INDEX]","typeLabel":"WmsReturnLineItem · object"},"isRequired":true,"uniqueKey":"data.line_items","typeLabel":"WmsReturnLineItem · object[]"},"shipments":{"type":"array","description":"List of the shipments associated with the return.","example":[{"tracking_number":"tracking_number","shipped_date":"2023-02-03T02:04:06Z","arrived_date":"2023-02-03T02:04:06Z","warehouse_id":"warehouse_id","carrier_id":"carrier_id","carrier_name":"carrier_name","scac":"FDXG","shipping_cost":1.23,"measurements":{"length":1,"width":1,"height":1,"unit":"in","weight":1,"weight_unit":"lb"},"line_items":[{"inventory_item_id":"item_id","sku":"sku","quantity":4,"receiving_details":[{"quantity":1,"condition":"good","disposition":"restocked"},{"quantity":1,"condition":"damaged","disposition":"scrapped"}]}]}],"items":{"type":"object","properties":{"tracking_number":{"oneOf":[{"type":"string","description":"The tracking number of the shipment.","example":"tracking_number","isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].tracking_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"The tracking number of the shipment.","example":"tracking_number","isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].tracking_number.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].tracking_number","typeLabel":"string | null"},"shipped_date":{"oneOf":[{"type":"string","format":"date-time","description":"The date the shipment was sent.","example":"2023-03-15T13:45:30Z","isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].shipped_date.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date the shipment was sent.","example":"2023-03-15T13:45:30Z","isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].shipped_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].shipped_date","typeLabel":"string\u003cdate-time> | null"},"arrived_date":{"oneOf":[{"type":"string","format":"date-time","description":"The date the shipment arrived.","example":"2023-03-15T13:45:30Z","isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].arrived_date.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date the shipment arrived.","example":"2023-03-15T13:45:30Z","isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].arrived_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].arrived_date","typeLabel":"string\u003cdate-time> | null"},"warehouse_id":{"oneOf":[{"type":"string","description":"The ID of the warehouse the shipment was sent to. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id","isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].warehouse_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The ID of the warehouse the shipment was sent to. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.","example":"warehouse_id","isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].warehouse_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].warehouse_id","typeLabel":"string | null"},"carrier_id":{"oneOf":[{"type":"string","description":"The ID of the carrier for the shipment.","example":"carrier_id","isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].carrier_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The ID of the carrier for the shipment.","example":"carrier_id","isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].carrier_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].carrier_id","typeLabel":"string | null"},"carrier_name":{"oneOf":[{"type":"string","description":"The name of the carrier for the shipment.","example":"carrier_name","isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].carrier_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name of the carrier for the shipment.","example":"carrier_name","isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].carrier_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].carrier_name","typeLabel":"string | null"},"scac":{"oneOf":[{"type":"string","description":"The Standard Carrier Alpha Code (SCAC) for the shipment.","example":"FDXG","isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].scac.oneOf.0","typeLabel":"string"},{"type":"null","description":"The Standard Carrier Alpha Code (SCAC) for the shipment.","example":"FDXG","isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].scac.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].scac","typeLabel":"string | null"},"shipping_cost":{"oneOf":[{"type":"number","description":"The cost of the shipment.","example":0,"isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].shipping_cost.oneOf.0","typeLabel":"number"},{"type":"null","description":"The cost of the shipment.","example":0,"isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].shipping_cost.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].shipping_cost","typeLabel":"number | null"},"measurements":{"type":"object","properties":{"length":{"oneOf":[{"type":"number","description":"","example":1.5,"isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].measurements.length.oneOf.0","typeLabel":"number"},{"type":"null","description":"","example":1.5,"isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].measurements.length.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].measurements.length","typeLabel":"number | null"},"width":{"oneOf":[{"type":"number","description":"","example":1.5,"isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].measurements.width.oneOf.0","typeLabel":"number"},{"type":"null","description":"","example":1.5,"isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].measurements.width.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].measurements.width","typeLabel":"number | null"},"height":{"oneOf":[{"type":"number","description":"","example":1.5,"isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].measurements.height.oneOf.0","typeLabel":"number"},{"type":"null","description":"","example":1.5,"isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].measurements.height.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].measurements.height","typeLabel":"number | null"},"unit":{"oneOf":[{"type":"string","enum":["cm","in"],"description":"The unit of measurement for the size of the shipment.","example":"in","isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].measurements.unit.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["cm","in"],"description":"The unit of measurement for the size of the shipment.","example":"in","isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].measurements.unit.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].measurements.unit","typeLabel":"enum\u003cstring> | null"},"weight":{"oneOf":[{"type":"number","description":"","example":2.5,"isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].measurements.weight.oneOf.0","typeLabel":"number"},{"type":"null","description":"","example":2.5,"isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].measurements.weight.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].measurements.weight","typeLabel":"number | null"},"weight_unit":{"oneOf":[{"type":"string","enum":["kg","oz","lb"],"description":"The unit of measurement for the weight of the shipment.","example":"lb","isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].measurements.weight_unit.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["kg","oz","lb"],"description":"The unit of measurement for the weight of the shipment.","example":"lb","isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].measurements.weight_unit.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].measurements.weight_unit","typeLabel":"enum\u003cstring> | null"}},"required":["height","length","unit","weight","weight_unit","width"],"additionalProperties":false,"title":"ShipmentMeasurements","isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].measurements","typeLabel":"ShipmentMeasurements · object"},"line_items":{"type":"array","description":"List of inventory items items in the shipment.","items":{"type":"object","properties":{"inventory_item_id":{"type":"string","description":"Can be passed into the [Inventory](/api-reference/wms-api/inventory/get-item) endpoint for more details.","example":"item_id","isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].line_items.items.[INDEX].inventory_item_id","typeLabel":"string"},"sku":{"oneOf":[{"type":"string","description":"","example":"sku","isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].line_items.items.[INDEX].sku.oneOf.0","typeLabel":"string"},{"type":"null","description":"","example":"sku","isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].line_items.items.[INDEX].sku.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].line_items.items.[INDEX].sku","typeLabel":"string | null"},"quantity":{"type":"integer","description":"How many units were shipped.","example":1,"isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].line_items.items.[INDEX].quantity","typeLabel":"integer"},"receiving_details":{"type":"array","description":"Details about received items in the shipment.","example":[{"quantity":1,"condition":"good","disposition":"restocked"}],"items":{"type":"object","properties":{"quantity":{"type":"integer","minimum":1,"description":"How many units were received in this condition and disposition.","example":1,"isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].line_items.items.[INDEX].receiving_details.items.[INDEX].quantity","typeLabel":"integer"},"condition":{"oneOf":[{"type":"string","description":"The condition of the item received.","example":"good","isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].line_items.items.[INDEX].receiving_details.items.[INDEX].condition.oneOf.0","typeLabel":"string"},{"type":"null","description":"The condition of the item received.","example":"good","isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].line_items.items.[INDEX].receiving_details.items.[INDEX].condition.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].line_items.items.[INDEX].receiving_details.items.[INDEX].condition","typeLabel":"string | null"},"disposition":{"oneOf":[{"type":"string","description":"The disposition of the item received, eg restocked or discarded.","example":"restocked","isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].line_items.items.[INDEX].receiving_details.items.[INDEX].disposition.oneOf.0","typeLabel":"string"},{"type":"null","description":"The disposition of the item received, eg restocked or discarded.","example":"restocked","isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].line_items.items.[INDEX].receiving_details.items.[INDEX].disposition.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].line_items.items.[INDEX].receiving_details.items.[INDEX].disposition","typeLabel":"string | null"}},"required":["condition","disposition","quantity"],"additionalProperties":false,"title":"ReceivingDetails","uniqueKey":"data.shipments.items.[INDEX].line_items.items.[INDEX].receiving_details.items.[INDEX]","typeLabel":"ReceivingDetails · object"},"isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].line_items.items.[INDEX].receiving_details","typeLabel":"ReceivingDetails · object[]"}},"required":["inventory_item_id","quantity","receiving_details","sku"],"additionalProperties":false,"title":"ReturnShipmentLineItem","uniqueKey":"data.shipments.items.[INDEX].line_items.items.[INDEX]","typeLabel":"ReturnShipmentLineItem · object"},"isRequired":true,"uniqueKey":"data.shipments.items.[INDEX].line_items","typeLabel":"ReturnShipmentLineItem · object[]"}},"required":["arrived_date","carrier_id","carrier_name","line_items","measurements","scac","shipped_date","shipping_cost","tracking_number","warehouse_id"],"additionalProperties":false,"title":"ReturnShipment","uniqueKey":"data.shipments.items.[INDEX]","typeLabel":"ReturnShipment · object"},"isRequired":true,"uniqueKey":"data.shipments","typeLabel":"ReturnShipment · object[]"},"external_system_url":{"oneOf":[{"type":"string","description":"URL link to the return in the external system (WMS/Freight etc).","example":"https://example.com/return/123","isRequired":true,"uniqueKey":"data.external_system_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL link to the return in the external system (WMS/Freight etc).","example":"https://example.com/return/123","isRequired":true,"uniqueKey":"data.external_system_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.external_system_url","typeLabel":"string | null"},"trackstar_tags":{"oneOf":[{"type":"array","description":"A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.","example":["tag1","tag2",{"tag3":"value3"}],"items":{"oneOf":[{}],"uniqueKey":"data.trackstar_tags.oneOf.0.items.[INDEX]","typeLabel":"any"},"isRequired":true,"uniqueKey":"data.trackstar_tags.oneOf.0","typeLabel":"any[]"},{"type":"null","description":"A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.","example":["tag1","tag2",{"tag3":"value3"}],"items":{"oneOf":[{}]},"isRequired":true,"uniqueKey":"data.trackstar_tags.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.trackstar_tags","typeLabel":"any[] | null"},"additional_fields":{"type":"object","description":"Integration-specific fields","example":{"key":"value"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"data.additional_fields.additionalProperties","typeLabel":"any"},"isRequired":true,"uniqueKey":"data.additional_fields","typeLabel":"object"},"trackstar_created_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z","isRequired":true,"uniqueKey":"data.trackstar_created_date","typeLabel":"string\u003cdate-time>"},"trackstar_updated_date":{"type":"string","format":"date-time","description":"","example":"2023-03-15T13:45:30Z","isRequired":true,"uniqueKey":"data.trackstar_updated_date","typeLabel":"string\u003cdate-time>"}},"required":["additional_fields","created_date","external_system_url","id","line_items","notes","order_id","raw_status","shipments","status","trackstar_created_date","trackstar_tags","trackstar_updated_date","updated_date","warehouse_customer_id"],"additionalProperties":false,"title":"WmsReturnApiItemSchema","uniqueKey":"data","typeLabel":"WmsReturnApiItemSchema · object"}},"required":["id","unused_fields"],"additionalProperties":false,"title":"wmsUpdateReturnResponse","uniqueKey":"","typeLabel":"wmsUpdateReturnResponse · object"},"examples":{"Example":{"title":"Example","value":{"id":"id","unused_fields":["unused_fields"],"data":{"id":"return_id","warehouse_customer_id":"warehouse_customer_id","created_date":"2022-01-01T00:00:00Z","updated_date":"2022-01-02T05:05:05Z","status":"open","raw_status":"raw_status","order_id":"order_id","notes":["This is a note"],"line_items":[{"inventory_item_id":"item_id","sku":"sku","expected_quantity":1,"received_quantity":1,"restocked_quantity":1,"return_reason":"Too Small"}],"shipments":[{"tracking_number":"tracking_number","shipped_date":"2023-02-03T02:04:06Z","arrived_date":"2023-02-03T02:04:06Z","warehouse_id":"warehouse_id","carrier_id":"carrier_id","carrier_name":"carrier_name","scac":"FDXG","shipping_cost":1.23,"measurements":{"length":1,"width":1,"height":1,"unit":"in","weight":1,"weight_unit":"lb"},"line_items":[{"inventory_item_id":"item_id","sku":"sku","quantity":4,"receiving_details":[{"quantity":1,"condition":"good","disposition":"restocked"},{"quantity":1,"condition":"damaged","disposition":"scrapped"}]}]}],"external_system_url":"https://example.com/return/123","trackstar_tags":["tag1","tag2",{"tag3":"value3"}],"additional_fields":{"key":"value"},"trackstar_created_date":"2023-03-15T13:45:30Z","trackstar_updated_date":"2023-03-15T13:45:30Z"}}}},"exampleType":"generated"}},"description":"Successful response","exampleType":"generated"},"8739e50c-e2a2-4085-827f-fc32cfd6e761":{"content":{"application/json":{"schema":{"properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"id":{"type":"string","description":"The ID of the item that wasn't found.","uniqueKey":"id","typeLabel":"string"}},"required":["error"],"type":"object","title":"HTTPError","uniqueKey":"","typeLabel":"HTTPError · object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","id":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Not found","exampleType":"generated"},"d6ac2af2-87da-4314-b64b-ce739e31104d":{"content":{"application/json":{"schema":{"properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"detail":{"type":"object","properties":{"\u003clocation>":{"type":"object","properties":{"\u003cfield_name>":{"type":"array","items":{"type":"string","uniqueKey":"detail.\u003clocation>.\u003cfield_name>.items.[INDEX]","typeLabel":"string"},"uniqueKey":"detail.\u003clocation>.\u003cfield_name>","typeLabel":"string[]"}},"uniqueKey":"detail.\u003clocation>","typeLabel":"object"}},"uniqueKey":"detail","typeLabel":"object"}},"required":["error"],"type":"object","title":"ValidationError","uniqueKey":"","typeLabel":"ValidationError · object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","detail":{"\u003clocation>":{"\u003cfield_name>":["\u003cstring>"]}}}}},"exampleType":"generated"}},"description":"Validation error","exampleType":"generated"}},"security":{},"servers":{"eb5659b4-6eec-462c-991a-7da8383bb677":{"description":"Trackstar API","url":"https://production.trackstarhq.com"}}},"originalFileLocation":"https://production.trackstarhq.com/openapi.json"},"subdomain":"trackstar","siteName":"Trackstar","title":"Update Return - Trackstar","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-28T22:40:27.910Z","originalFileLocation":"api-reference/wms-api/returns/put.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=\"Get the required, optional, and integration specific fields by calling the integrations endpoint.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Trackstar\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/trackstar/pv8TH9ZNYgztdvmO/_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/trackstar/pv8TH9ZNYgztdvmO/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/trackstar/pv8TH9ZNYgztdvmO/_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/trackstar/pv8TH9ZNYgztdvmO/_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/trackstar/pv8TH9ZNYgztdvmO/_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/trackstar/pv8TH9ZNYgztdvmO/_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/trackstar/pv8TH9ZNYgztdvmO/_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/trackstar/pv8TH9ZNYgztdvmO/_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/trackstar/pv8TH9ZNYgztdvmO/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update Return - Trackstar\">\u003cmeta data-mint-head property=\"og:description\" content=\"Get the required, optional, and integration specific fields by calling the integrations endpoint.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Trackstar\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.trackstarhq.com/api-reference/wms-api/returns/put\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://trackstar.mintlify.app/_mintlify/api/og/v2?division=Returns\u0026amp;title=Update+Return\u0026amp;description=Get+the+required%2C+optional%2C+and+integration+specific+fields+by+calling+the+%5Bintegrations%5D%28%2Fapi-reference%2Fmgmt%2Fintegrations%29+endpoint.\u0026amp;theme=a7581761d745b5f6f24e3162\u0026amp;signature=40e8d0d9ac3c5a5985f13f1f60f6847d1e9308af30a87a9c5adae52debdb988b\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Update Return - Trackstar\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Get the required, optional, and integration specific fields by calling the integrations endpoint.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://trackstar.mintlify.app/_mintlify/api/og/v2?division=Returns\u0026amp;title=Update+Return\u0026amp;description=Get+the+required%2C+optional%2C+and+integration+specific+fields+by+calling+the+%5Bintegrations%5D%28%2Fapi-reference%2Fmgmt%2Fintegrations%29+endpoint.\u0026amp;theme=a7581761d745b5f6f24e3162\u0026amp;signature=40e8d0d9ac3c5a5985f13f1f60f6847d1e9308af30a87a9c5adae52debdb988b\">\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/trackstar/pv8TH9ZNYgztdvmO/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Trackstar\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#7691DA\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.trackstarhq.com/api-reference/wms-api/returns/put\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/wms-api/returns/put.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.trackstarhq.com/#organization\",\"name\":\"Trackstar\",\"url\":\"https://docs.trackstarhq.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/trackstar/e_R8AMY4ayyVfYRU/logo/light.svg?fit=max\u0026auto=format\u0026n=e_R8AMY4ayyVfYRU\u0026q=85\u0026s=eb832f4ffc768291fd95c4939b2ac6c2\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.trackstarhq.com#website\",\"name\":\"Trackstar\",\"url\":\"https://docs.trackstarhq.com\",\"publisher\":{\"@id\":\"https://docs.trackstarhq.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.trackstarhq.com/api-reference/wms-api/returns/put#webpage\",\"url\":\"https://docs.trackstarhq.com/api-reference/wms-api/returns/put\",\"name\":\"Update Return\",\"description\":\"Get the required, optional, and integration specific fields by calling the integrations endpoint.\",\"dateModified\":\"2026-01-28T22:40:27.910Z\",\"isPartOf\":{\"@id\":\"https://docs.trackstarhq.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.trackstarhq.com/api-reference/wms-api/returns/put#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.trackstarhq.com/api-reference/wms-api/returns/put#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"WMS API Reference\",\"item\":\"https://docs.trackstarhq.com/api-reference/wms-api/inventory/info\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Returns\",\"item\":\"https://docs.trackstarhq.com/api-reference/wms-api/returns/info\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Update Return\",\"item\":\"https://docs.trackstarhq.com/api-reference/wms-api/returns/put\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.trackstarhq.com/api-reference/wms-api/returns/put#apireference\",\"headline\":\"Update Return\",\"name\":\"Update Return\",\"description\":\"Get the required, optional, and integration specific fields by calling the integrations endpoint.\",\"url\":\"https://docs.trackstarhq.com/api-reference/wms-api/returns/put\",\"mainEntityOfPage\":{\"@id\":\"https://docs.trackstarhq.com/api-reference/wms-api/returns/put#webpage\"},\"dateModified\":\"2026-01-28T22:40:27.910Z\",\"publisher\":{\"@id\":\"https://docs.trackstarhq.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.trackstarhq.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Trackstar\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Trackstar","nav":{"global":{"anchors":[{"anchor":"Request an API Key","icon":"key","href":"https://trackstarhq.com/get-started"},{"anchor":"Login to Dashboard","icon":"browser","href":"https://dashboard.trackstarhq.com"},{"anchor":"WMS Integrations","icon":"warehouse","href":"https://trackstarhq.com/integrations/wms"},{"anchor":"Cart Integrations","icon":"cart-shopping","href":"https://trackstarhq.com/integrations/cart"},{"anchor":"Carrier Integrations","icon":"truck","href":"https://trackstarhq.com/integrations/carrier"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/introduction"}]},{"tab":"Admin API","pages":[{"title":"Admin API","href":"/api-reference/mgmt/create-link-token"}]},{"tab":"WMS API","groups":[{"group":"WMS API Reference","pages":[{"group":"Inventory","pages":[{"title":"Inventory","href":"/api-reference/wms-api/inventory/info"},{"openapi":"get /wms/inventory","title":"Get All Inventory Items","href":"/api-reference/wms-api/inventory/get"},{"openapi":"get /wms/inventory/{inventory_id}","title":"Get Inventory Item","href":"/api-reference/wms-api/inventory/get-item"},{"openapi":"get /wms/inventory/ledger","title":"Get Inventory Ledger","href":"/api-reference/wms-api/inventory/inventory-ledger"},{"openapi":"put /wms/inventory/{inventory_id}/adjust","title":"Adjust Inventory Item","href":"/api-reference/wms-api/inventory/adjust"},{"openapi":"put /wms/inventory/{inventory_id}/trackstar-tags","title":"Update Inventory Trackstar Tags","href":"/api-reference/wms-api/inventory/add-tag"}]},{"group":"Products","pages":[{"title":"Products","href":"/api-reference/wms-api/products/info"},{"openapi":"get /wms/products","title":"Get All Products","href":"/api-reference/wms-api/products/get"},{"openapi":"get /wms/products/{product_id}","title":"Get Product","href":"/api-reference/wms-api/products/get-item"},{"openapi":"post /wms/products","title":"Create Product","href":"/api-reference/wms-api/products/post"},{"openapi":"put /wms/products/{product_id}","title":"Update Product","href":"/api-reference/wms-api/products/put"},{"openapi":"post /wms/kits","title":"Create a Kit Product","href":"/api-reference/wms-api/products/kit-post"},{"openapi":"put /wms/kits/{kit_id}","title":"Update a Kit Product","href":"/api-reference/wms-api/products/kit-put"},{"openapi":"put /wms/products/{product_id}/trackstar-tags","title":"Update Product Trackstar Tags","href":"/api-reference/wms-api/products/add-tag"}]},{"group":"Orders","pages":[{"title":"Orders","href":"/api-reference/wms-api/orders/info"},{"openapi":"get /wms/orders","title":"Get All Orders","href":"/api-reference/wms-api/orders/get"},{"openapi":"get /wms/orders/{order_id}","title":"Get Order","href":"/api-reference/wms-api/orders/get-item"},{"openapi":"post /wms/orders","title":"Create Order","href":"/api-reference/wms-api/orders/post"},{"openapi":"put /wms/orders/{order_id}","title":"Update Order","href":"/api-reference/wms-api/orders/put"},{"openapi":"put /wms/orders/{order_id}/cancel","title":"Cancel Order","href":"/api-reference/wms-api/orders/cancel"},{"openapi":"get /wms/orders/{order_id}/packs","title":"Get Order Packs","href":"/api-reference/wms-api/orders/get-packs"},{"openapi":"post /wms/orders/{order_id}/shipments","title":"Ship Order","href":"/api-reference/wms-api/orders/create-shipment"},{"openapi":"post /wms/orders/{order_id}/file","title":"Create Order File","href":"/api-reference/wms-api/orders/attach-file"},{"openapi":"get /wms/orders/channels","title":"Get All Order Channels","href":"/api-reference/wms-api/orders/order-channels-get"},{"openapi":"put /wms/orders/{order_id}/trackstar-tags","title":"Update Order Trackstar Tags","href":"/api-reference/wms-api/orders/add-tag"}]},{"group":"Inbound Shipments","pages":[{"title":"Inbound Shipments","href":"/api-reference/wms-api/inbound-shipments/info"},{"openapi":"get /wms/inbound-shipments","title":"Get All Inbound Shipments","href":"/api-reference/wms-api/inbound-shipments/get"},{"openapi":"get /wms/inbound-shipments/{inbound_shipment_id}","title":"Get Inbound Shipment","href":"/api-reference/wms-api/inbound-shipments/get-item"},{"openapi":"post /wms/inbound-shipments","title":"Create Inbound Shipment","href":"/api-reference/wms-api/inbound-shipments/post"},{"openapi":"put /wms/inbound-shipments/{inbound_shipment_id}","title":"Update Inbound Shipment","href":"/api-reference/wms-api/inbound-shipments/put"},{"openapi":"put /wms/inbound-shipments/{inbound_shipment_id}/receive","title":"Receive Inbound Shipment","href":"/api-reference/wms-api/inbound-shipments/receive"},{"openapi":"get /wms/inbound-shipments/suppliers","title":"Get All Inbound Shipment Suppliers","href":"/api-reference/wms-api/inbound-shipments/inbound-shipment-suppliers-get"},{"openapi":"put /wms/inbound-shipments/{inbound_shipment_id}/trackstar-tags","title":"Update Inbound Shipment Trackstar Tags","href":"/api-reference/wms-api/inbound-shipments/add-tag"}]},{"group":"Shipping Methods","pages":[{"title":"Shipping Methods","href":"/api-reference/wms-api/shipping-methods/info"},{"openapi":"get /wms/shipping-methods","title":"Get All Shipping Methods","href":"/api-reference/wms-api/shipping-methods/get"},{"openapi":"get /wms/shipping-methods/{shipping_method_id}","title":"Get Shipping Method","href":"/api-reference/wms-api/shipping-methods/get-item"}]},{"group":"Returns","pages":[{"title":"Returns","href":"/api-reference/wms-api/returns/info"},{"openapi":"get /wms/returns","title":"Get All Returns","href":"/api-reference/wms-api/returns/get"},{"openapi":"get /wms/returns/{return_id}","title":"Get Return","href":"/api-reference/wms-api/returns/get-item"},{"openapi":"post /wms/returns","title":"Create Return","description":"Get the required, optional, and integration specific fields by calling the [integrations](/api-reference/mgmt/integrations) endpoint.","href":"/api-reference/wms-api/returns/post"},{"openapi":"put /wms/returns/{return_id}","title":"Update Return","href":"/api-reference/wms-api/returns/put"},{"openapi":"put /wms/returns/{return_id}/cancel","title":"Cancel Return","description":"Cancel a return for the WMS connection with the associated return id.","href":"/api-reference/wms-api/returns/cancel"},{"openapi":"put /wms/returns/{return_id}/trackstar-tags","title":"Update Return Trackstar Tags","href":"/api-reference/wms-api/returns/add-tag"}]},{"group":"Billing","pages":[{"title":"Billing","href":"/api-reference/wms-api/billing/info"},{"openapi":"get /wms/billing","title":"Get All Bills","href":"/api-reference/wms-api/billing/get"},{"openapi":"get /wms/billing/{bill_id}","title":"Get Bill","href":"/api-reference/wms-api/billing/get-item"}]},{"group":"Warehouses","pages":[{"title":"Warehouses","href":"/api-reference/wms-api/warehouses/info"},{"openapi":"get /wms/warehouses","title":"Get All Warehouses","href":"/api-reference/wms-api/warehouses/get"},{"openapi":"get /wms/warehouses/{warehouse_id}","title":"Get Warehouse","href":"/api-reference/wms-api/warehouses/get-item"},{"openapi":"get /wms/warehouses/{warehouse_id}/locations","title":"Get All Warehouse Locations","href":"/api-reference/wms-api/warehouses/get-warehouse-locations"},{"openapi":"get /wms/warehouses/{warehouse_id}/locations/{location_id}","title":"Get Warehouse Location","href":"/api-reference/wms-api/warehouses/get-warehouse-locations-item"},{"openapi":"put /wms/warehouses/{warehouse_id}/trackstar-tags","title":"Update Warehouse Trackstar Tags","href":"/api-reference/wms-api/warehouses/add-tag"}]},{"group":"Warehouse Customers","pages":[{"title":"Warehouse Customers","href":"/api-reference/wms-api/warehouse-customers/info"},{"openapi":"get /wms/warehouse-customers","title":"Get All Warehouse Customers","href":"/api-reference/wms-api/warehouse-customers/get"},{"openapi":"get /wms/warehouse-customers/{warehouse_customer_id}","title":"Get Warehouse Customer","href":"/api-reference/wms-api/warehouse-customers/get-item"}]}]}]},{"tab":"Cart API","pages":[{"title":"Cart API","href":"/api-reference/cart-api/products/info"}]},{"tab":"Carrier API","pages":[{"title":"Carrier API","href":"/api-reference/carrier-api/invoice-line-items/info"}]}]},"basePath":"","title":"Update Return - Trackstar","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B7XKH4J3.js","utils-lOYzL7z-.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DF6jUUIM.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dpsj5f7C.js","snippetPresets-CYeiDe8v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CUFz1YZ_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D8H_iLS4.js","shallow-DdluZBHX.js","getApiPlaygroundDisplay-B9922vev.js","CodeSnippet-CMoRNGYs.js","CodeSnippets-DwyrPHuw.js","Page-DSVu9Ucl.js","getPastedJson-G-zIvlHh.js","icon-B03fnEy0.js","MethodPill-CW7teklc.js","DuplicateIcon-CtO8eekd.js","createIcon-DZTKdM_A.js","DynamicMarkdown-D5M2At0B.js","SectionHeading-C_2NaA2U.js","axios-vUo_bRtp.js","Markdown-D7QRHV3m.js","clsx-D1Z-ELXV.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-lvhuD9Du.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CKfC4ywL.js"]}