The identifier used by an external source to identify the product variant. Must be unique within the shop. If a non-unique external_id is provided, the API will respond with an error.
The dimensions of the product variant, interpreted as inches. Optional and nullable. When provided, depth, width, and height are all required. Omit dimensions to leave any stored dimensions untouched, or send null to delete the stored dimensions.
Translated content for this product variant, one entry per locale. Locales must be unique within the array — uniqueness is checked against each locale's canonicalized tag (fr-CA, fr_ca, and FR-CA all collide). Update-time behavior (overwrite vs. merge with any existing translations) is not yet defined — this field is currently validation-only, ahead of the persistence work that will define it.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Loop Returns Documentation","colors":{"primary":"#0672FF","light":"#FFFCF7","dark":"#000000"},"logo":{"light":"https://mintcdn.com/loopreturns/mWP1nZGNp75FiB-l/logo/loop-logo-lapis-charcoal.svg?fit=max\u0026auto=format\u0026n=mWP1nZGNp75FiB-l\u0026q=85\u0026s=5113cc3f8f2d70a65c2c774e471a13c4","dark":"https://mintcdn.com/loopreturns/mWP1nZGNp75FiB-l/logo/loop-logo-lapis-newsprint.svg?fit=max\u0026auto=format\u0026n=mWP1nZGNp75FiB-l\u0026q=85\u0026s=c2197689146b468c5df1b8581f091743"},"favicon":"https://mintcdn.com/loopreturns/mWP1nZGNp75FiB-l/favicon.svg?fit=max\u0026auto=format\u0026n=mWP1nZGNp75FiB-l\u0026q=85\u0026s=93b43e224efe823b43c6d1b9c45799f9","navbar":{"links":[{"href":"https://help.loopreturns.com","label":"Support"}],"primary":{"type":"button","label":"Request Demo","href":"https://www.loopreturns.com/book-a-demo-today/"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/loop-returns","instagram":"https://www.instagram.com/loopreturns"}},"fonts":{"heading":{"family":"ABC Ginto","weight":900,"source":"fonts/ABCGinto-Black.woff2","format":"woff2"},"body":{"family":"Matter","weight":400,"source":"fonts/Matter-Regular.woff2","format":"woff2"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"System Status","icon":"radar","href":"https://status.loopreturns.com"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"loopreturns","hasAudioNarration":false,"actualSubdomain":"loopreturns","customDomains":["docs.loopreturns.com"],"gitSource":{"type":"gitlab","owner":"loopreturns/documentation","repo":"public-api-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"projectId":67355043,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aee02e9b56b944fc2811a93","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"API Reference","count":177},{"language":"default","tag":"APIs","count":169},{"language":"default","tag":"Commerce Data","count":69},{"language":"default","tag":"Return Create","count":52},{"language":"default","tag":"Guides","count":30},{"language":"default","tag":"Products","count":17},{"language":"default","tag":"Webhook Reference","count":14},{"language":"default","tag":"Collections","count":12},{"language":"default","tag":"Orders","count":11},{"language":"default","tag":"MCP Server","count":10}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/latest/products/update-product-variant","slug":"/api-reference/latest/products/update-product-variant","pageMetadata":{"openapi":"patch /products/{productId}/product-variants/{id}","title":"Update Product Variant","description":"Update a product variant.","href":"/api-reference/latest/products/update-product-variant"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Update a product variant.\"\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":"patch /products/{productId}/product-variants/{id}","title":"Update Product Variant","description":"Update a product variant.","href":"/api-reference/latest/products/update-product-variant"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/loopreturns/d7dc6883aeaefe8b/scripts/generate-unstable-nav.js","/_mintlify/custom/loopreturns/eb155f0b6d2849a4/scripts/update-openapi-servers.js"],"openApiReferenceData":{"operation":{"summary":"Update Product Variant","operationId":"updateProductVariants","description":"Update a product variant.","tags":["Product Variants"],"security":["7fc208b0-235e-4be7-b52f-d573c01b20d8"],"parameters":["188ccbbe-0221-454f-b268-921da247eb7d","0817625f-1c57-48a7-92b4-d37dd52ba0e7"],"requestBody":"29c1fe28-8a5e-46b3-957b-3f5bb3c57010","responses":{"200":"f766a012-1d26-44ca-945d-c743619501a2","401":"1f2c835b-e2ef-4c08-9abd-25fb4acb76a9","404":"1bc4a71e-70df-431a-8ba6-a77f42fed7ed"},"x-stoplight":{"id":"xmusuztx7ezs2"},"method":"patch","type":"path","servers":["7d941531-0074-469e-a2b6-94971d04b41c","a9fa2de8-dff4-49d3-a6e5-e3046fcae1bc","7c167765-8024-46e9-b0e8-3738052e7ce0"],"path":"/products/{productId}/product-variants/{id}","baseUrlOptions":["https://api.loopreturns.com/api/2026-10","https://api.loopreturns.com/api/2026-07","https://api.loopreturns.com/api/unstable"],"title":"Update Product Variant","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"188ccbbe-0221-454f-b268-921da247eb7d":{"schema":{"type":"integer","isRequired":true,"description":"The unique Loop identifier of the parent product.","uniqueKey":"","typeLabel":"integer"},"name":"productId","in":"path","required":true,"description":"The unique Loop identifier of the parent product.","example":1234567890},"0817625f-1c57-48a7-92b4-d37dd52ba0e7":{"schema":{"type":"integer","isRequired":true,"description":"The product variant's unique identifier.","uniqueKey":"","typeLabel":"integer"},"name":"id","in":"path","required":true,"description":"The product variant's unique identifier.","example":1123456789}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the product variant.","examples":["Classic Brown Dress Shoes - Size 12"],"isRequired":true,"uniqueKey":"name","typeLabel":"string"},"external_id":{"oneOf":[{"type":"string","maxLength":100,"description":"The identifier used by an external source to identify the product variant. Must be unique within the shop. If a non-unique `external_id` is provided, the API will respond with an error.","examples":["564400c7-7a6b-4f29-b6a5-7bb580b2992c"],"uniqueKey":"external_id.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":100,"description":"The identifier used by an external source to identify the product variant. Must be unique within the shop. If a non-unique `external_id` is provided, the API will respond with an error.","examples":["564400c7-7a6b-4f29-b6a5-7bb580b2992c"],"uniqueKey":"external_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"external_id","typeLabel":"string | null"},"sku":{"oneOf":[{"type":"string","maxLength":255,"description":"The SKU of the product variant.","examples":["SHOES-US44-M-Brwn"],"uniqueKey":"sku.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"The SKU of the product variant.","examples":["SHOES-US44-M-Brwn"],"uniqueKey":"sku.oneOf.1","typeLabel":"null"}],"uniqueKey":"sku","typeLabel":"string | null"},"weight_grams":{"oneOf":[{"type":"integer","description":"The weight of the product variant in grams.","examples":[440],"uniqueKey":"weight_grams.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The weight of the product variant in grams.","examples":[440],"uniqueKey":"weight_grams.oneOf.1","typeLabel":"null"}],"uniqueKey":"weight_grams","typeLabel":"integer | null"},"barcode":{"oneOf":[{"type":"string","maxLength":255,"description":"The barcode of the product variant.","examples":[712345000019],"uniqueKey":"barcode.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"The barcode of the product variant.","examples":[712345000019],"uniqueKey":"barcode.oneOf.1","typeLabel":"null"}],"uniqueKey":"barcode","typeLabel":"string | null"},"price":{"oneOf":[{"type":"object","description":"The price of the product variant in minor units, such as cents, with its corresponding currency.","required":["amount","currency_code"],"example":{"amount":50000,"currency_code":"USD"},"properties":{"amount":{"type":"integer","format":"int32","examples":[25000],"isRequired":true,"uniqueKey":"price.oneOf.0.amount","typeLabel":"integer\u003cint32>"},"currency_code":{"type":"string","default":"USD","examples":["EUR"],"isRequired":true,"uniqueKey":"price.oneOf.0.currency_code","typeLabel":"string"}},"uniqueKey":"price.oneOf.0","typeLabel":"object"},{"type":"null","description":"The price of the product variant in minor units, such as cents, with its corresponding currency.","uniqueKey":"price.oneOf.1","typeLabel":"null"}],"uniqueKey":"price","typeLabel":"object | null"},"images":{"oneOf":[{"type":"array","items":{"type":"string","format":"uri","examples":["https://example.com/example.jpg"],"minLength":1,"uniqueKey":"images.oneOf.0.items.[INDEX]","typeLabel":"string\u003curi>"},"description":"An array of URLs which reference images of the product.","uniqueKey":"images.oneOf.0","typeLabel":"string\u003curi>[]"},{"type":"null","items":{"type":"string","format":"uri","examples":["https://example.com/example.jpg"],"minLength":1},"description":"An array of URLs which reference images of the product.","uniqueKey":"images.oneOf.1","typeLabel":"null"}],"uniqueKey":"images","typeLabel":"string\u003curi>[] | null"},"options":{"oneOf":[{"type":"array","description":"An array of optional features or characteristics of the product variant that can be selected by the customer.","items":{"title":"ProductVariantOption","type":"object","properties":{"position":{"type":"integer","format":"int32","examples":[1],"isRequired":true,"uniqueKey":"options.oneOf.0.items.[INDEX].position","typeLabel":"integer\u003cint32>"},"value":{"type":"string","examples":["Red"],"isRequired":true,"uniqueKey":"options.oneOf.0.items.[INDEX].value","typeLabel":"string"}},"required":["position","value"],"uniqueKey":"options.oneOf.0.items.[INDEX]","typeLabel":"ProductVariantOption · object"},"uniqueKey":"options.oneOf.0","typeLabel":"ProductVariantOption · object[]"},{"type":"null","description":"An array of optional features or characteristics of the product variant that can be selected by the customer.","items":{"title":"ProductVariantOption","type":"object","properties":{"position":{"type":"integer","format":"int32","examples":[1]},"value":{"type":"string","examples":["Red"]}},"required":["position","value"]},"uniqueKey":"options.oneOf.1","typeLabel":"null"}],"uniqueKey":"options","typeLabel":"ProductVariantOption · object[] | null"},"logistics_information":{"oneOf":[{"type":"object","title":"ProductVariantLogisticsInformation","description":"The logistics information for the product variant such as code classification, shipping, and cost.","properties":{"origin_country_code":{"oneOf":[{"type":"string","examples":["US"],"minLength":2,"maxLength":2,"description":"The ISO 3166-1 alpha-2 country code of the country where the product variant is manufactured.","uniqueKey":"logistics_information.oneOf.0.origin_country_code.oneOf.0","typeLabel":"string"},{"type":"null","examples":["US"],"minLength":2,"maxLength":2,"description":"The ISO 3166-1 alpha-2 country code of the country where the product variant is manufactured.","uniqueKey":"logistics_information.oneOf.0.origin_country_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"logistics_information.oneOf.0.origin_country_code","typeLabel":"string | null"},"origin_region_code":{"oneOf":[{"type":"string","examples":["CA"],"minLength":2,"maxLength":2,"description":"The ISO 3166-2 alpha-2 region code of the region where the product variant is manufactured.","uniqueKey":"logistics_information.oneOf.0.origin_region_code.oneOf.0","typeLabel":"string"},{"type":"null","examples":["CA"],"minLength":2,"maxLength":2,"description":"The ISO 3166-2 alpha-2 region code of the region where the product variant is manufactured.","uniqueKey":"logistics_information.oneOf.0.origin_region_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"logistics_information.oneOf.0.origin_region_code","typeLabel":"string | null"},"default_hs_code":{"oneOf":[{"type":"string","examples":["1234567890"],"minLength":6,"maxLength":13,"description":"The default Harmonized System (HS) code of the product variant. This code is used for any country that does not have a corresponding entry in the `destination_country_hs_codes` array.","uniqueKey":"logistics_information.oneOf.0.default_hs_code.oneOf.0","typeLabel":"string"},{"type":"null","examples":["1234567890"],"minLength":6,"maxLength":13,"description":"The default Harmonized System (HS) code of the product variant. This code is used for any country that does not have a corresponding entry in the `destination_country_hs_codes` array.","uniqueKey":"logistics_information.oneOf.0.default_hs_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"logistics_information.oneOf.0.default_hs_code","typeLabel":"string | null"},"requires_shipping":{"oneOf":[{"type":"boolean","description":"The value that determines whether the product variant requires shipping.","uniqueKey":"logistics_information.oneOf.0.requires_shipping.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"The value that determines whether the product variant requires shipping.","uniqueKey":"logistics_information.oneOf.0.requires_shipping.oneOf.1","typeLabel":"null"}],"uniqueKey":"logistics_information.oneOf.0.requires_shipping","typeLabel":"boolean | null"},"cost":{"oneOf":[{"type":"object","description":"The cost of the product variant in minor units, such as cents, with its corresponding currency.","required":["amount","currency_code"],"example":{"amount":50000,"currency_code":"USD"},"properties":{"amount":{"type":"integer","format":"int32","examples":[25000],"isRequired":true,"uniqueKey":"logistics_information.oneOf.0.cost.oneOf.0.amount","typeLabel":"integer\u003cint32>"},"currency_code":{"type":"string","default":"USD","examples":["EUR"],"isRequired":true,"uniqueKey":"logistics_information.oneOf.0.cost.oneOf.0.currency_code","typeLabel":"string"}},"uniqueKey":"logistics_information.oneOf.0.cost.oneOf.0","typeLabel":"object"},{"type":"null","description":"The cost of the product variant in minor units, such as cents, with its corresponding currency.","uniqueKey":"logistics_information.oneOf.0.cost.oneOf.1","typeLabel":"null"}],"uniqueKey":"logistics_information.oneOf.0.cost","typeLabel":"object | null"},"destination_country_hs_codes":{"oneOf":[{"type":"array","items":{"title":"DestinationCountryHsCode","type":"object","properties":{"destination_country_code":{"type":"string","examples":["US"],"minLength":2,"maxLength":2,"description":"The ISO 3166-1 alpha-2 country code of the destination country.","uniqueKey":"logistics_information.oneOf.0.destination_country_hs_codes.oneOf.0.items.[INDEX].destination_country_code","typeLabel":"string"},"hs_code":{"type":"string","examples":["1234567890"],"minLength":6,"maxLength":13,"description":"The Harmonized System (HS) code of the product variant for the destination country.","uniqueKey":"logistics_information.oneOf.0.destination_country_hs_codes.oneOf.0.items.[INDEX].hs_code","typeLabel":"string"}},"uniqueKey":"logistics_information.oneOf.0.destination_country_hs_codes.oneOf.0.items.[INDEX]","typeLabel":"DestinationCountryHsCode · object"},"description":"The list of destination country-specific HS codes for the product variant (each country code may occur only once in the list).","uniqueKey":"logistics_information.oneOf.0.destination_country_hs_codes.oneOf.0","typeLabel":"DestinationCountryHsCode · object[]"},{"type":"null","items":{"title":"DestinationCountryHsCode","type":"object","properties":{"destination_country_code":{"type":"string","examples":["US"],"minLength":2,"maxLength":2,"description":"The ISO 3166-1 alpha-2 country code of the destination country."},"hs_code":{"type":"string","examples":["1234567890"],"minLength":6,"maxLength":13,"description":"The Harmonized System (HS) code of the product variant for the destination country."}}},"description":"The list of destination country-specific HS codes for the product variant (each country code may occur only once in the list).","uniqueKey":"logistics_information.oneOf.0.destination_country_hs_codes.oneOf.1","typeLabel":"null"}],"uniqueKey":"logistics_information.oneOf.0.destination_country_hs_codes","typeLabel":"DestinationCountryHsCode · object[] | null"}},"uniqueKey":"logistics_information.oneOf.0","typeLabel":"ProductVariantLogisticsInformation · object"},{"type":"null","description":"The logistics information for the product variant such as code classification, shipping, and cost.","uniqueKey":"logistics_information.oneOf.1","typeLabel":"null"}],"uniqueKey":"logistics_information","typeLabel":"ProductVariantLogisticsInformation · object | null"},"dimensions":{"oneOf":[{"type":"object","title":"ProductVariantDimensions","description":"The dimensions of the product variant, interpreted as inches. Optional and nullable. When provided, `depth`, `width`, and `height` are all required. Omit `dimensions` to leave any stored dimensions untouched, or send `null` to delete the stored dimensions.","required":["depth","width","height"],"properties":{"depth":{"type":"number","format":"float","exclusiveMinimum":0,"maximum":9999.9999,"multipleOf":0.0001,"examples":[8.5],"description":"The depth of the product variant, in inches. Must be greater than 0, at most 9999.9999, and have no more than 4 decimal places.","isRequired":true,"uniqueKey":"dimensions.oneOf.0.depth","typeLabel":"number\u003cfloat>"},"width":{"type":"number","format":"float","exclusiveMinimum":0,"maximum":9999.9999,"multipleOf":0.0001,"examples":[6],"description":"The width of the product variant, in inches. Must be greater than 0, at most 9999.9999, and have no more than 4 decimal places.","isRequired":true,"uniqueKey":"dimensions.oneOf.0.width","typeLabel":"number\u003cfloat>"},"height":{"type":"number","format":"float","exclusiveMinimum":0,"maximum":9999.9999,"multipleOf":0.0001,"examples":[2.25],"description":"The height of the product variant, in inches. Must be greater than 0, at most 9999.9999, and have no more than 4 decimal places.","isRequired":true,"uniqueKey":"dimensions.oneOf.0.height","typeLabel":"number\u003cfloat>"}},"uniqueKey":"dimensions.oneOf.0","typeLabel":"ProductVariantDimensions · object"},{"type":"null","description":"The dimensions of the product variant, interpreted as inches. Optional and nullable. When provided, `depth`, `width`, and `height` are all required. Omit `dimensions` to leave any stored dimensions untouched, or send `null` to delete the stored dimensions.","uniqueKey":"dimensions.oneOf.1","typeLabel":"null"}],"uniqueKey":"dimensions","typeLabel":"ProductVariantDimensions · object | null"},"locale_data":{"oneOf":[{"type":"array","description":"Translated content for this product variant, one entry per locale. Locales must be unique within the array — uniqueness is checked against each locale's canonicalized tag (`fr-CA`, `fr_ca`, and `FR-CA` all collide). Update-time behavior (overwrite vs. merge with any existing translations) is not yet defined — this field is currently validation-only, ahead of the persistence work that will define it.","items":{"title":"ProductVariantLocaleData","type":"object","properties":{"locale":{"type":"string","maxLength":5,"description":"The locale this translation applies to. Loop's canonical v1 shape — the form to send — is a plain `language` or `language-REGION` tag: a lowercase 2-letter language code, optionally followed by a hyphen and an uppercase 2-letter ISO 3166-1 region code (e.g. `en`, `fr-CA`). For input leniency, `_` is also accepted as the separator and input case is not enforced (e.g. `en_us`, `FR-ca`); these are canonicalized to the form above before being stored and compared for uniqueness. Script subtags (e.g. `zh-Hans`), numeric region codes, and 3+ letter language codes are rejected with a 422. This is a known v1 limitation.","examples":["fr-CA"],"isRequired":true,"uniqueKey":"locale_data.oneOf.0.items.[INDEX].locale","typeLabel":"string"},"name":{"type":"string","maxLength":255,"description":"The translated name of the product variant.","examples":["Chaussures Habillées Marron Classiques - Taille 12"],"isRequired":true,"uniqueKey":"locale_data.oneOf.0.items.[INDEX].name","typeLabel":"string"}},"required":["locale","name"],"uniqueKey":"locale_data.oneOf.0.items.[INDEX]","typeLabel":"ProductVariantLocaleData · object"},"uniqueKey":"locale_data.oneOf.0","typeLabel":"ProductVariantLocaleData · object[]"},{"type":"null","description":"Translated content for this product variant, one entry per locale. Locales must be unique within the array — uniqueness is checked against each locale's canonicalized tag (`fr-CA`, `fr_ca`, and `FR-CA` all collide). Update-time behavior (overwrite vs. merge with any existing translations) is not yet defined — this field is currently validation-only, ahead of the persistence work that will define it.","items":{"title":"ProductVariantLocaleData","type":"object","properties":{"locale":{"type":"string","maxLength":5,"description":"The locale this translation applies to. Loop's canonical v1 shape — the form to send — is a plain `language` or `language-REGION` tag: a lowercase 2-letter language code, optionally followed by a hyphen and an uppercase 2-letter ISO 3166-1 region code (e.g. `en`, `fr-CA`). For input leniency, `_` is also accepted as the separator and input case is not enforced (e.g. `en_us`, `FR-ca`); these are canonicalized to the form above before being stored and compared for uniqueness. Script subtags (e.g. `zh-Hans`), numeric region codes, and 3+ letter language codes are rejected with a 422. This is a known v1 limitation.","examples":["fr-CA"]},"name":{"type":"string","maxLength":255,"description":"The translated name of the product variant.","examples":["Chaussures Habillées Marron Classiques - Taille 12"]}},"required":["locale","name"]},"uniqueKey":"locale_data.oneOf.1","typeLabel":"null"}],"uniqueKey":"locale_data","typeLabel":"ProductVariantLocaleData · object[] | null"}},"required":["name"],"x-stoplight":{"id":"xsa7ujtb39y0o"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"Classic Brown Dress Shoes - Size 12","external_id":"564400c7-7a6b-4f29-b6a5-7bb580b2992c","sku":"SHOES-US44-M-Brwn","weight_grams":440,"barcode":712345000019,"price":{"amount":50000,"currency_code":"USD"},"images":["https://example.com/example.jpg"],"options":[{"position":1,"value":"Red"}],"logistics_information":{"origin_country_code":"US","origin_region_code":"CA","default_hs_code":"1234567890","requires_shipping":true,"cost":{"amount":50000,"currency_code":"USD"},"destination_country_hs_codes":[{"destination_country_code":"US","hs_code":"1234567890"}]},"dimensions":{"depth":8.5,"width":6,"height":2.25},"locale_data":[{"locale":"fr-CA","name":"Chaussures Habillées Marron Classiques - Taille 12"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"f766a012-1d26-44ca-945d-c743619501a2":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"product_variant":{"title":"ProductVariantResponse","type":"object","properties":{"id":{"type":"integer","format":"int64","minimum":1,"description":"The unique integer identifier for the product variant, created by Loop.","examples":[810772],"readOnly":true,"uniqueKey":"product_variant.id","typeLabel":"integer\u003cint64>"},"external_id":{"oneOf":[{"type":"string","description":"The identifier used by an external source to identify the product variant.","examples":["564400c7-7a6b-4f29-b6a5-7bb580b2992c"],"uniqueKey":"product_variant.external_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The identifier used by an external source to identify the product variant.","examples":["564400c7-7a6b-4f29-b6a5-7bb580b2992c"],"uniqueKey":"product_variant.external_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"product_variant.external_id","typeLabel":"string | null"},"sku":{"oneOf":[{"type":"string","description":"The SKU of the product variant.","examples":["SHOES-US44-M-Brwn"],"uniqueKey":"product_variant.sku.oneOf.0","typeLabel":"string"},{"type":"null","description":"The SKU of the product variant.","examples":["SHOES-US44-M-Brwn"],"uniqueKey":"product_variant.sku.oneOf.1","typeLabel":"null"}],"uniqueKey":"product_variant.sku","typeLabel":"string | null"},"name":{"type":"string","description":"The name of the product variant.","examples":["Classic Brown Dress Shoes - Size 12"],"uniqueKey":"product_variant.name","typeLabel":"string"},"weight_grams":{"oneOf":[{"type":"integer","format":"int32","description":"The weight of the product variant in grams.","examples":[500],"uniqueKey":"product_variant.weight_grams.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"The weight of the product variant in grams.","examples":[500],"uniqueKey":"product_variant.weight_grams.oneOf.1","typeLabel":"null"}],"uniqueKey":"product_variant.weight_grams","typeLabel":"integer\u003cint32> | null"},"barcode":{"oneOf":[{"type":"string","description":"The barcode of the product variant.","examples":["1234asdf324"],"uniqueKey":"product_variant.barcode.oneOf.0","typeLabel":"string"},{"type":"null","description":"The barcode of the product variant.","examples":["1234asdf324"],"uniqueKey":"product_variant.barcode.oneOf.1","typeLabel":"null"}],"uniqueKey":"product_variant.barcode","typeLabel":"string | null"},"product":{"oneOf":[{"type":"object","description":"The details associated with the parent product.","properties":{"id":{"type":"integer","format":"int64","minimum":1,"examples":[810772],"readOnly":true,"uniqueKey":"product_variant.product.oneOf.0.id","typeLabel":"integer\u003cint64>"},"external_id":{"oneOf":[{"type":"string","examples":["564400c7-7a6b-4f29-b6a5-7bb580b2992c"],"uniqueKey":"product_variant.product.oneOf.0.external_id.oneOf.0","typeLabel":"string"},{"type":"null","examples":["564400c7-7a6b-4f29-b6a5-7bb580b2992c"],"uniqueKey":"product_variant.product.oneOf.0.external_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"product_variant.product.oneOf.0.external_id","typeLabel":"string | null"},"sku":{"oneOf":[{"type":"string","examples":["SHOES-US44-M-Brwn"],"uniqueKey":"product_variant.product.oneOf.0.sku.oneOf.0","typeLabel":"string"},{"type":"null","examples":["SHOES-US44-M-Brwn"],"uniqueKey":"product_variant.product.oneOf.0.sku.oneOf.1","typeLabel":"null"}],"uniqueKey":"product_variant.product.oneOf.0.sku","typeLabel":"string | null"},"name":{"type":"string","uniqueKey":"product_variant.product.oneOf.0.name","typeLabel":"string"}},"uniqueKey":"product_variant.product.oneOf.0","typeLabel":"object"},{"type":"null","description":"The details associated with the parent product.","uniqueKey":"product_variant.product.oneOf.1","typeLabel":"null"}],"uniqueKey":"product_variant.product","typeLabel":"object | null"},"price":{"oneOf":[{"type":"object","description":"The price of the product variant in minor units, such as cents, with its corresponding currency.","required":["amount","currency_code"],"example":{"amount":50000,"currency_code":"USD"},"properties":{"amount":{"type":"integer","format":"int32","examples":[25000],"isRequired":true,"uniqueKey":"product_variant.price.oneOf.0.amount","typeLabel":"integer\u003cint32>"},"currency_code":{"type":"string","default":"USD","examples":["EUR"],"isRequired":true,"uniqueKey":"product_variant.price.oneOf.0.currency_code","typeLabel":"string"}},"uniqueKey":"product_variant.price.oneOf.0","typeLabel":"object"},{"type":"null","description":"The price of the product variant in minor units, such as cents, with its corresponding currency.","uniqueKey":"product_variant.price.oneOf.1","typeLabel":"null"}],"uniqueKey":"product_variant.price","typeLabel":"object | null"},"images":{"oneOf":[{"type":"array","description":"An array of links to images of the product variant.","items":{"type":"string","format":"uri","examples":["https://example.com/example.jpg"],"uniqueKey":"product_variant.images.oneOf.0.items.[INDEX]","typeLabel":"string\u003curi>"},"uniqueKey":"product_variant.images.oneOf.0","typeLabel":"string\u003curi>[]"},{"type":"null","description":"An array of links to images of the product variant.","items":{"type":"string","format":"uri","examples":["https://example.com/example.jpg"]},"uniqueKey":"product_variant.images.oneOf.1","typeLabel":"null"}],"uniqueKey":"product_variant.images","typeLabel":"string\u003curi>[] | null"},"inventories":{"oneOf":[{"description":"The record of available count and location by product variant.","type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","minimum":1,"examples":[127302],"readOnly":true,"uniqueKey":"product_variant.inventories.oneOf.0.items.[INDEX].id","typeLabel":"integer\u003cint64>"},"available_count":{"type":"integer","format":"int32","examples":[10],"uniqueKey":"product_variant.inventories.oneOf.0.items.[INDEX].available_count","typeLabel":"integer\u003cint32>"},"location":{"oneOf":[{"type":"object","properties":{"id":{"type":"integer","format":"int64","minimum":1,"examples":[182973],"readOnly":true,"uniqueKey":"product_variant.inventories.oneOf.0.items.[INDEX].location.oneOf.0.id","typeLabel":"integer\u003cint64>"},"external_id":{"oneOf":[{"type":"string","examples":["564400c7-7a6b-4f29-b6a5-7bb580b2992c"],"uniqueKey":"product_variant.inventories.oneOf.0.items.[INDEX].location.oneOf.0.external_id.oneOf.0","typeLabel":"string"},{"type":"null","examples":["564400c7-7a6b-4f29-b6a5-7bb580b2992c"],"uniqueKey":"product_variant.inventories.oneOf.0.items.[INDEX].location.oneOf.0.external_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"product_variant.inventories.oneOf.0.items.[INDEX].location.oneOf.0.external_id","typeLabel":"string | null"},"name":{"type":"string","uniqueKey":"product_variant.inventories.oneOf.0.items.[INDEX].location.oneOf.0.name","typeLabel":"string"}},"uniqueKey":"product_variant.inventories.oneOf.0.items.[INDEX].location.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"product_variant.inventories.oneOf.0.items.[INDEX].location.oneOf.1","typeLabel":"null"}],"uniqueKey":"product_variant.inventories.oneOf.0.items.[INDEX].location","typeLabel":"object | null"}},"uniqueKey":"product_variant.inventories.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"product_variant.inventories.oneOf.0","typeLabel":"object[]"},{"description":"The record of available count and location by product variant.","type":"null","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","minimum":1,"examples":[127302],"readOnly":true},"available_count":{"type":"integer","format":"int32","examples":[10]},"location":{"oneOf":[{"type":"object","properties":{"id":{"type":"integer","format":"int64","minimum":1,"examples":[182973],"readOnly":true},"external_id":{"oneOf":[{"type":"string","examples":["564400c7-7a6b-4f29-b6a5-7bb580b2992c"]},{"type":"null","examples":["564400c7-7a6b-4f29-b6a5-7bb580b2992c"]}]},"name":{"type":"string"}}},{"type":"null"}]}}},"uniqueKey":"product_variant.inventories.oneOf.1","typeLabel":"null"}],"uniqueKey":"product_variant.inventories","typeLabel":"object[] | null"},"options":{"oneOf":[{"type":"array","description":"An array of optional features or characteristics of the product variant that can be selected by the customer.","items":{"title":"ProductVariantOption","type":"object","properties":{"position":{"type":"integer","format":"int32","examples":[1],"isRequired":true,"uniqueKey":"product_variant.options.oneOf.0.items.[INDEX].position","typeLabel":"integer\u003cint32>"},"value":{"type":"string","examples":["Red"],"isRequired":true,"uniqueKey":"product_variant.options.oneOf.0.items.[INDEX].value","typeLabel":"string"}},"required":["position","value"],"uniqueKey":"product_variant.options.oneOf.0.items.[INDEX]","typeLabel":"ProductVariantOption · object"},"uniqueKey":"product_variant.options.oneOf.0","typeLabel":"ProductVariantOption · object[]"},{"type":"null","description":"An array of optional features or characteristics of the product variant that can be selected by the customer.","items":{"title":"ProductVariantOption","type":"object","properties":{"position":{"type":"integer","format":"int32","examples":[1]},"value":{"type":"string","examples":["Red"]}},"required":["position","value"]},"uniqueKey":"product_variant.options.oneOf.1","typeLabel":"null"}],"uniqueKey":"product_variant.options","typeLabel":"ProductVariantOption · object[] | null"},"logistics_information":{"oneOf":[{"type":"object","title":"ProductVariantLogisticsInformation","description":"The logistics information for the product variant such as code classification, shipping, and cost.","properties":{"origin_country_code":{"oneOf":[{"type":"string","examples":["US"],"minLength":2,"maxLength":2,"description":"The ISO 3166-1 alpha-2 country code of the country where the product variant is manufactured.","uniqueKey":"product_variant.logistics_information.oneOf.0.origin_country_code.oneOf.0","typeLabel":"string"},{"type":"null","examples":["US"],"minLength":2,"maxLength":2,"description":"The ISO 3166-1 alpha-2 country code of the country where the product variant is manufactured.","uniqueKey":"product_variant.logistics_information.oneOf.0.origin_country_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"product_variant.logistics_information.oneOf.0.origin_country_code","typeLabel":"string | null"},"origin_region_code":{"oneOf":[{"type":"string","examples":["CA"],"minLength":2,"maxLength":2,"description":"The ISO 3166-2 alpha-2 region code of the region where the product variant is manufactured.","uniqueKey":"product_variant.logistics_information.oneOf.0.origin_region_code.oneOf.0","typeLabel":"string"},{"type":"null","examples":["CA"],"minLength":2,"maxLength":2,"description":"The ISO 3166-2 alpha-2 region code of the region where the product variant is manufactured.","uniqueKey":"product_variant.logistics_information.oneOf.0.origin_region_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"product_variant.logistics_information.oneOf.0.origin_region_code","typeLabel":"string | null"},"default_hs_code":{"oneOf":[{"type":"string","examples":["1234567890"],"minLength":6,"maxLength":13,"description":"The default Harmonized System (HS) code of the product variant. This code is used for any country that does not have a corresponding entry in the `destination_country_hs_codes` array.","uniqueKey":"product_variant.logistics_information.oneOf.0.default_hs_code.oneOf.0","typeLabel":"string"},{"type":"null","examples":["1234567890"],"minLength":6,"maxLength":13,"description":"The default Harmonized System (HS) code of the product variant. This code is used for any country that does not have a corresponding entry in the `destination_country_hs_codes` array.","uniqueKey":"product_variant.logistics_information.oneOf.0.default_hs_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"product_variant.logistics_information.oneOf.0.default_hs_code","typeLabel":"string | null"},"requires_shipping":{"oneOf":[{"type":"boolean","description":"The value that determines whether the product variant requires shipping.","uniqueKey":"product_variant.logistics_information.oneOf.0.requires_shipping.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"The value that determines whether the product variant requires shipping.","uniqueKey":"product_variant.logistics_information.oneOf.0.requires_shipping.oneOf.1","typeLabel":"null"}],"uniqueKey":"product_variant.logistics_information.oneOf.0.requires_shipping","typeLabel":"boolean | null"},"cost":{"oneOf":[{"type":"object","description":"The cost of the product variant in minor units, such as cents, with its corresponding currency.","required":["amount","currency_code"],"example":{"amount":50000,"currency_code":"USD"},"properties":{"amount":{"type":"integer","format":"int32","examples":[25000],"isRequired":true,"uniqueKey":"product_variant.logistics_information.oneOf.0.cost.oneOf.0.amount","typeLabel":"integer\u003cint32>"},"currency_code":{"type":"string","default":"USD","examples":["EUR"],"isRequired":true,"uniqueKey":"product_variant.logistics_information.oneOf.0.cost.oneOf.0.currency_code","typeLabel":"string"}},"uniqueKey":"product_variant.logistics_information.oneOf.0.cost.oneOf.0","typeLabel":"object"},{"type":"null","description":"The cost of the product variant in minor units, such as cents, with its corresponding currency.","uniqueKey":"product_variant.logistics_information.oneOf.0.cost.oneOf.1","typeLabel":"null"}],"uniqueKey":"product_variant.logistics_information.oneOf.0.cost","typeLabel":"object | null"},"destination_country_hs_codes":{"oneOf":[{"type":"array","items":{"title":"DestinationCountryHsCode","type":"object","properties":{"destination_country_code":{"type":"string","examples":["US"],"minLength":2,"maxLength":2,"description":"The ISO 3166-1 alpha-2 country code of the destination country.","uniqueKey":"product_variant.logistics_information.oneOf.0.destination_country_hs_codes.oneOf.0.items.[INDEX].destination_country_code","typeLabel":"string"},"hs_code":{"type":"string","examples":["1234567890"],"minLength":6,"maxLength":13,"description":"The Harmonized System (HS) code of the product variant for the destination country.","uniqueKey":"product_variant.logistics_information.oneOf.0.destination_country_hs_codes.oneOf.0.items.[INDEX].hs_code","typeLabel":"string"}},"uniqueKey":"product_variant.logistics_information.oneOf.0.destination_country_hs_codes.oneOf.0.items.[INDEX]","typeLabel":"DestinationCountryHsCode · object"},"description":"The list of destination country-specific HS codes for the product variant (each country code may occur only once in the list).","uniqueKey":"product_variant.logistics_information.oneOf.0.destination_country_hs_codes.oneOf.0","typeLabel":"DestinationCountryHsCode · object[]"},{"type":"null","items":{"title":"DestinationCountryHsCode","type":"object","properties":{"destination_country_code":{"type":"string","examples":["US"],"minLength":2,"maxLength":2,"description":"The ISO 3166-1 alpha-2 country code of the destination country."},"hs_code":{"type":"string","examples":["1234567890"],"minLength":6,"maxLength":13,"description":"The Harmonized System (HS) code of the product variant for the destination country."}}},"description":"The list of destination country-specific HS codes for the product variant (each country code may occur only once in the list).","uniqueKey":"product_variant.logistics_information.oneOf.0.destination_country_hs_codes.oneOf.1","typeLabel":"null"}],"uniqueKey":"product_variant.logistics_information.oneOf.0.destination_country_hs_codes","typeLabel":"DestinationCountryHsCode · object[] | null"}},"uniqueKey":"product_variant.logistics_information.oneOf.0","typeLabel":"ProductVariantLogisticsInformation · object"},{"type":"null","description":"The logistics information for the product variant such as code classification, shipping, and cost.","uniqueKey":"product_variant.logistics_information.oneOf.1","typeLabel":"null"}],"uniqueKey":"product_variant.logistics_information","typeLabel":"ProductVariantLogisticsInformation · object | null"},"dimensions":{"oneOf":[{"type":"object","title":"ProductVariantDimensions","description":"The dimensions of the product variant, interpreted as inches, or `null` when none are stored.","required":["depth","width","height"],"properties":{"depth":{"type":"number","format":"float","exclusiveMinimum":0,"maximum":9999.9999,"multipleOf":0.0001,"examples":[8.5],"description":"The depth of the product variant, in inches. Must be greater than 0, at most 9999.9999, and have no more than 4 decimal places.","isRequired":true,"uniqueKey":"product_variant.dimensions.oneOf.0.depth","typeLabel":"number\u003cfloat>"},"width":{"type":"number","format":"float","exclusiveMinimum":0,"maximum":9999.9999,"multipleOf":0.0001,"examples":[6],"description":"The width of the product variant, in inches. Must be greater than 0, at most 9999.9999, and have no more than 4 decimal places.","isRequired":true,"uniqueKey":"product_variant.dimensions.oneOf.0.width","typeLabel":"number\u003cfloat>"},"height":{"type":"number","format":"float","exclusiveMinimum":0,"maximum":9999.9999,"multipleOf":0.0001,"examples":[2.25],"description":"The height of the product variant, in inches. Must be greater than 0, at most 9999.9999, and have no more than 4 decimal places.","isRequired":true,"uniqueKey":"product_variant.dimensions.oneOf.0.height","typeLabel":"number\u003cfloat>"}},"uniqueKey":"product_variant.dimensions.oneOf.0","typeLabel":"ProductVariantDimensions · object"},{"type":"null","description":"The dimensions of the product variant, interpreted as inches, or `null` when none are stored.","uniqueKey":"product_variant.dimensions.oneOf.1","typeLabel":"null"}],"uniqueKey":"product_variant.dimensions","typeLabel":"ProductVariantDimensions · object | null"}},"uniqueKey":"product_variant","typeLabel":"ProductVariantResponse · object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"product_variant":{"id":810772,"external_id":"564400c7-7a6b-4f29-b6a5-7bb580b2992c","sku":"SHOES-US44-M-Brwn","name":"Classic Brown Dress Shoes - Size 12","weight_grams":500,"barcode":"1234asdf324","product":{"id":810772,"external_id":"564400c7-7a6b-4f29-b6a5-7bb580b2992c","sku":"SHOES-US44-M-Brwn","name":"\u003cstring>"},"price":{"amount":50000,"currency_code":"USD"},"images":["https://example.com/example.jpg"],"inventories":[{"id":127302,"available_count":10,"location":{"id":182973,"external_id":"564400c7-7a6b-4f29-b6a5-7bb580b2992c","name":"\u003cstring>"}}],"options":[{"position":1,"value":"Red"}],"logistics_information":{"origin_country_code":"US","origin_region_code":"CA","default_hs_code":"1234567890","requires_shipping":true,"cost":{"amount":50000,"currency_code":"USD"},"destination_country_hs_codes":[{"destination_country_code":"US","hs_code":"1234567890"}]},"dimensions":{"depth":8.5,"width":6,"height":2.25}}}}},"exampleType":"generated"}},"exampleType":"generated"},"1f2c835b-e2ef-4c08-9abd-25fb4acb76a9":{"description":"Unauthorized","content":{"application/json":{"schema":{"description":"Example response if request submitted without a valid API Key in X-Authorization.","content":{"application/json":{"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"string","examples":["Unauthorized."]}}}}},"headers":{"X-Loop-Request-ID":{"schema":{"type":"string","examples":["5a748e7c-5fcc-4fb0-a777-6a4d28e60d4c"],"format":"uuid"},"description":"UUID to aid in debugging API issues"}},"uniqueKey":"","typeLabel":"any"},"examples":{"Example":{"title":"Example","value":"\u003cunknown>"}},"exampleType":"generated"}},"exampleType":"generated"},"1bc4a71e-70df-431a-8ba6-a77f42fed7ed":{"description":"Not Found","content":{"application/json":{"schema":{"description":"The requested entity could not be found.","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","examples":["Resource not found."]}}}}},"headers":{"X-Loop-Request-ID":{"schema":{"type":"string"},"description":"UUID to aid in debugging API issues"}},"uniqueKey":"","typeLabel":"any"},"examples":{"Example":{"title":"Example","value":"\u003cunknown>"}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"7fc208b0-235e-4be7-b52f-d573c01b20d8":{"write":{"name":"X-Authorization","type":"apiKey","in":"header","description":"API Scope: \"Product (write)\"","scopes":[],"schemeName":"write"}}},"servers":{"7d941531-0074-469e-a2b6-94971d04b41c":{"url":"https://api.loopreturns.com/api/2026-10","description":"2026-10 (Stable)"},"a9fa2de8-dff4-49d3-a6e5-e3046fcae1bc":{"url":"https://api.loopreturns.com/api/2026-07","description":"2026-07"},"7c167765-8024-46e9-b0e8-3738052e7ce0":{"url":"https://api.loopreturns.com/api/unstable","description":"Unstable (Preview)"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"name":"X-Authorization","type":"apiKey","in":"header","description":"API Scope: \"Product (write)\"","scopes":[],"schemeName":"write"},"schema":{"title":"X-Authorization","type":"string","description":"API Scope: \"Product (write)\"","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"write","name":"X-Authorization"}],"title":"write"}]},"originalFileLocation":"openapi/products-api.yaml"},"subdomain":"loopreturns","siteName":"Loop Returns Documentation","title":"Update Product Variant - Loop Returns Documentation","navMaps":{"firstHrefInVersion":{"2026-07":{"href":"/api-reference/latest/products/update-product-variant","matchLevel":0},"2026-10":{"href":"/api-reference/latest/products/update-product-variant","matchLevel":0},"unstable":{"href":"/api-reference/latest/products/update-product-variant","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2025-08-11T14:42:17.622Z","originalFileLocation":"api-reference/latest/products/update-product-variant.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Update a product variant.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Loop Returns Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/loopreturns/X0rUYkP1UIsEaMhI/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/loopreturns/X0rUYkP1UIsEaMhI/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/loopreturns/X0rUYkP1UIsEaMhI/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/loopreturns/X0rUYkP1UIsEaMhI/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/loopreturns/X0rUYkP1UIsEaMhI/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/loopreturns/X0rUYkP1UIsEaMhI/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/loopreturns/X0rUYkP1UIsEaMhI/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/loopreturns/X0rUYkP1UIsEaMhI/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/loopreturns/X0rUYkP1UIsEaMhI/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update Product Variant - Loop Returns Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Update a product variant.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Loop Returns Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.loopreturns.com/api-reference/latest/products/update-product-variant\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://loopreturns.mintlify.site/_mintlify/api/og/v2?division=Products\u0026amp;title=Update+Product+Variant\u0026amp;description=Update+a+product+variant.\u0026amp;theme=05cb70602dae72597560a592\u0026amp;signature=8b114db78d5cbe73a758f62efe25732302b8fc234c5b0b2f710696a4f145e4f2\">\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 Product Variant - Loop Returns Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Update a product variant.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://loopreturns.mintlify.site/_mintlify/api/og/v2?division=Products\u0026amp;title=Update+Product+Variant\u0026amp;description=Update+a+product+variant.\u0026amp;theme=05cb70602dae72597560a592\u0026amp;signature=8b114db78d5cbe73a758f62efe25732302b8fc234c5b0b2f710696a4f145e4f2\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/loopreturns/X0rUYkP1UIsEaMhI/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Loop Returns Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0672FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.loopreturns.com/api-reference/latest/products/update-product-variant\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/latest/products/update-product-variant.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.loopreturns.com/#organization\",\"name\":\"Loop Returns Documentation\",\"url\":\"https://docs.loopreturns.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/loopreturns/mWP1nZGNp75FiB-l/logo/loop-logo-lapis-charcoal.svg?fit=max\u0026auto=format\u0026n=mWP1nZGNp75FiB-l\u0026q=85\u0026s=5113cc3f8f2d70a65c2c774e471a13c4\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.loopreturns.com#website\",\"name\":\"Loop Returns Documentation\",\"url\":\"https://docs.loopreturns.com\",\"publisher\":{\"@id\":\"https://docs.loopreturns.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.loopreturns.com/api-reference/latest/products/update-product-variant#webpage\",\"url\":\"https://docs.loopreturns.com/api-reference/latest/products/update-product-variant\",\"name\":\"Update Product Variant\",\"description\":\"Update a product variant.\",\"dateModified\":\"2025-08-11T14:42:17.622Z\",\"isPartOf\":{\"@id\":\"https://docs.loopreturns.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.loopreturns.com/api-reference/latest/products/update-product-variant#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.loopreturns.com/api-reference/latest/products/update-product-variant#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"APIs\",\"item\":\"https://docs.loopreturns.com/api-reference/latest/return-actions/process-return\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Commerce Data\",\"item\":\"https://docs.loopreturns.com/api-reference/latest/products/list-products\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Products\",\"item\":\"https://docs.loopreturns.com/api-reference/latest/products/list-products\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Update Product Variant\",\"item\":\"https://docs.loopreturns.com/api-reference/latest/products/update-product-variant\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.loopreturns.com/api-reference/latest/products/update-product-variant#apireference\",\"headline\":\"Update Product Variant\",\"name\":\"Update Product Variant\",\"description\":\"Update a product variant.\",\"url\":\"https://docs.loopreturns.com/api-reference/latest/products/update-product-variant\",\"mainEntityOfPage\":{\"@id\":\"https://docs.loopreturns.com/api-reference/latest/products/update-product-variant#webpage\"},\"dateModified\":\"2025-08-11T14:42:17.622Z\",\"publisher\":{\"@id\":\"https://docs.loopreturns.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.loopreturns.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Loop Returns Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Loop Returns Documentation","nav":{"global":{"anchors":[{"anchor":"System Status","icon":"radar","href":"https://status.loopreturns.com"}]},"versions":[{"version":"2026-07","tabs":[{"tab":"Introduction","pages":[{"title":"Introduction","href":"/welcome"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/integration-guides/overview"}]},{"tab":"MCP Server","pages":[{"title":"MCP Server","href":"/mcp/overview"}]},{"tab":"API Reference","groups":[{"group":"Using the API","pages":[{"title":"Getting Started","icon":"play","href":"/api-reference/getting-started"},{"title":"Authentication","version":"2026-07","icon":"lock","href":"/api-reference/authentication"},{"title":"API Versioning","icon":"clock","href":"/api-reference/versioning"},{"title":"Rate limit","icon":"gauge","href":"/api-reference/rate-limit"},{"title":"Pagination","icon":"page","href":"/api-reference/pagination"},{"title":"Error codes","icon":"circle-exclamation","iconType":"regular","href":"/api-reference/error-codes"},{"title":"Postman Collection","icon":"bolt","href":"/api-reference/postman"}]},{"group":"APIs","pages":[{"group":"Return Actions","pages":[{"openapi":"post /warehouse/return/{id}/process","title":"Process Return","href":"/api-reference/latest/return-actions/process-return"},{"openapi":"post /warehouse/return/{id}/remove","title":"Remove Line Items","href":"/api-reference/latest/return-actions/remove-line-items"},{"openapi":"post /warehouse/return/{id}/cancel","title":"Cancel Return","href":"/api-reference/latest/return-actions/cancel-return"},{"openapi":"post /warehouse/return/{id}/flag","title":"Flag Return","href":"/api-reference/latest/return-actions/flag-return"},{"openapi":"post /warehouse/return/{id}/close","title":"Close Return","href":"/api-reference/latest/return-actions/close-return"},{"openapi":"get /warehouse/return/{id}/notes","title":"Get Return Notes","href":"/api-reference/latest/return-actions/get-return-notes"},{"openapi":"post /warehouse/return/{id}/note","title":"Create Return Note","href":"/api-reference/latest/return-actions/create-return-note"},{"openapi":"post /order/link","title":"Create Return Deep Link","href":"/api-reference/latest/return-actions/create-return-deep-link"},{"openapi":"post /order/qr","title":"Create Return Deep Link with QR Code","href":"/api-reference/latest/return-actions/create-return-deep-link-with-qr-code"}]},{"group":"Return Data","pages":[{"openapi":"get /warehouse/return/list","title":"Detailed Returns List","href":"/api-reference/latest/return-data/detailed-returns-list"},{"openapi":"get /warehouse/return/details","title":"Get Return Details","href":"/api-reference/latest/return-data/get-return-details"},{"openapi":"get /warehouse/reporting/asn","title":"Advanced Shipping Notice","href":"/api-reference/latest/return-data/advanced-shipping-notice"}]},{"group":"Programmatic Webhooks","pages":[{"openapi":"get /webhooks","title":"Get Webhooks","href":"/api-reference/latest/programmatic-webhooks/get-webhooks"},{"openapi":"post /webhooks","title":"Create Webhook","href":"/api-reference/latest/programmatic-webhooks/create-webhook"},{"openapi":"put /webhooks/{id}","title":"Update Webhook","href":"/api-reference/latest/programmatic-webhooks/update-webhook"},{"openapi":"delete /webhooks/{id}","title":"Delete Webhook","href":"/api-reference/latest/programmatic-webhooks/delete-webhook"}]},{"group":"Item Grading and Dispositioning","pages":[{"openapi":"post /dispositioning/grade","title":"Grade Items","href":"/api-reference/latest/item-grading-and-disposition/grade-items"},{"openapi":"post /dispositioning/assess","title":"Assess Dispositions","href":"/api-reference/latest/item-grading-and-disposition/assess-dispositions"}]},{"group":"Cart","pages":[{"openapi":"post /cart","title":"Create Cart","href":"/api-reference/latest/cart/create-cart"},{"openapi":"get /cart/{token}","title":null,"href":"/api-reference/latest/cart/get-cart"},{"openapi":"post /cart/{token}","title":null,"href":"/api-reference/latest/cart/update-cart"},{"openapi":"delete /cart/{token}","title":null,"href":"/api-reference/latest/cart/delete-cart"}]},{"group":"Destinations","pages":[{"openapi":"get /destinations","title":"Get All Destinations","href":"/api-reference/latest/destinations/get-all-destinations"},{"openapi":"post /destinations","title":"Create Destination","href":"/api-reference/latest/destinations/create-destination"},{"openapi":"get /destinations/{id}","title":"Get Destination Details","href":"/api-reference/latest/destinations/get-destination-details"},{"openapi":"put /destinations/{id}","title":"Update Destination","href":"/api-reference/latest/destinations/update-destination"},{"openapi":"delete /destinations/{id}","title":"Delete Destination","href":"/api-reference/latest/destinations/delete-destination"}]},{"group":"Blocklist","pages":[{"openapi":"get /blocklists","title":"List Blocklist Items","href":"/api-reference/latest/blocklist/list-blocklist-items"},{"openapi":"post /blocklists","title":"Create Blocklist Item","href":"/api-reference/latest/blocklist/create-blocklist-item"},{"openapi":"get /blocklists/{id}","title":"Get Blocklist Item","href":"/api-reference/latest/blocklist/get-blocklist-item"},{"openapi":"delete /blocklists/{id}","title":"Delete Blocklist Item","href":"/api-reference/latest/blocklist/delete-blocklist-item"}]},{"group":"Allowlist","pages":[{"openapi":"get /allowlists","title":"List Allowlist Items","href":"/api-reference/latest/allowlist/list-allowlist-items"},{"openapi":"post /allowlists","title":"Create Allowlist Item","href":"/api-reference/latest/allowlist/create-allowlist-item"},{"openapi":"get /allowlists/{id}","title":"Get Allowlist Item","href":"/api-reference/latest/allowlist/get-allowlist-item"},{"openapi":"delete /allowlists/{id}","title":"Delete Allowlist Item","href":"/api-reference/latest/allowlist/delete-allowlist-item"}]},{"group":"Fraud Reports","pages":[{"openapi":"post /returns/{id}/fraud-report","title":"Create Fraud Report","href":"/api-reference/latest/return-actions/create-fraud-report"}]},{"group":"Order Return Eligibility","pages":[{"openapi":"post /orders/return-eligibility","title":"Look Up Order Return Eligibility by Order Name","href":"/api-reference/latest/orders/look-up-order-return-eligibility"}]},{"group":"Happy Returns Shipments","pages":[{"openapi":"get /happy-returns/shipments/{happy_returns_shipment_id}","title":"Get Shipment Information","href":"/api-reference/latest/happy-returns-shipment/get-shipment-information"},{"openapi":"get /happy-returns/shipments","title":"Get Shipments","href":"/api-reference/latest/happy-returns-shipment/get-shipments"},{"openapi":"get /happy-returns/shipments/{id}/items","title":"Get Shipment Items","href":"/api-reference/latest/happy-returns-shipment-items/get-shipment-items"}]},{"group":"Label Requests","pages":[{"openapi":"get /label-requests","title":"List Label Requests","href":"/api-reference/latest/label-requests/list-label-requests"},{"openapi":"get /label-requests/{id}","title":"Get Label Request","href":"/api-reference/latest/label-requests/get-label-request"},{"openapi":"post /label-requests/{id}/errors","title":"Create Label Request Error","href":"/api-reference/latest/label-requests/create-a-label-request-error"},{"openapi":"post /labels","title":"Create Label","href":"/api-reference/latest/label-requests/create-label"},{"openapi":"post /returns/{returnId}/labels","title":"Generate Label","href":"/api-reference/latest/label-requests/generate-label"},{"openapi":"post /returns/{returnId}/labels/regenerate","title":"Regenerate Label","href":"/api-reference/latest/label-requests/regenerate-label"},{"openapi":"put /labels/{id}","title":"Update Label Status","href":"/api-reference/latest/label-requests/update-label-status"}]},{"group":"Return Create","pages":[{"title":"Return Create Overview","href":"/api-reference/latest/draft-returns/overview"},{"openapi":"openapi/draft-returns.yaml get /draft-returns/{draft_return_id}","title":"Get Draft Return","href":"/api-reference/latest/draft-returns/get-draft-return"},{"openapi":"openapi/draft-returns.yaml post /draft-returns","title":"Initialize Draft Return","href":"/api-reference/latest/draft-returns/initialize-draft-return"},{"openapi":"openapi/draft-returns.yaml post /draft-returns/{draft_return_id}/cancel","title":"Cancel Draft Return","href":"/api-reference/latest/draft-returns/cancel-draft-return"},{"openapi":"openapi/draft-returns.yaml post /draft-returns/{draft_return_id}/customer","title":"Set Customer","href":"/api-reference/latest/draft-returns/set-customer"},{"openapi":"openapi/draft-returns.yaml post /draft-returns/{draft_return_id}/address","title":"Set Address","href":"/api-reference/latest/draft-returns/set-address"},{"openapi":"openapi/draft-returns.yaml post /draft-returns/{draft_return_id}/returning-items","title":"Add Returning Item","href":"/api-reference/latest/draft-returns/add-returning-item"},{"openapi":"openapi/draft-returns.yaml delete /draft-returns/{draft_return_id}/returning-items/{returning_item_id}","title":"Remove Returning Item","href":"/api-reference/latest/draft-returns/remove-returning-item"},{"openapi":"openapi/draft-returns.yaml post /draft-returns/{draft_return_id}/returning-items/{returning_item_id}/return-reason","title":"Set Returning Item Return Reason","href":"/api-reference/latest/draft-returns/set-returning-item-return-reason"},{"openapi":"openapi/draft-returns.yaml post /draft-returns/{draft_return_id}/returning-items/{returning_item_id}/user-input/{user_input_id}","title":"Add Returning Item User Input","href":"/api-reference/latest/draft-returns/add-returning-item-user-input"},{"openapi":"openapi/draft-returns.yaml post /draft-returns/{draft_return_id}/returning-items/{returning_item_id}/return-type","title":"Set Returning Item Return Type","href":"/api-reference/latest/draft-returns/set-returning-item-return-type"},{"openapi":"openapi/draft-returns.yaml post /draft-returns/{draft_return_id}/returning-items/{returning_item_id}/exchange-item","title":"Add Returning Item Exchange Item","href":"/api-reference/latest/draft-returns/add-returning-item-exchange-item"},{"openapi":"openapi/draft-returns.yaml post /draft-returns/{draft_return_id}/cart/items","title":"Add Cart Item","href":"/api-reference/latest/draft-returns/add-cart-item"},{"openapi":"openapi/draft-returns.yaml delete /draft-returns/{draft_return_id}/cart/items/{cart_item_id}","title":"Remove Cart Item","href":"/api-reference/latest/draft-returns/remove-cart-item"},{"openapi":"openapi/draft-returns.yaml post /draft-returns/{draft_return_id}/credit-type","title":"Set Credit Type","href":"/api-reference/latest/draft-returns/set-credit-type"},{"openapi":"openapi/draft-returns.yaml post /draft-returns/{draft_return_id}/processing-type","title":"Set Processing Type","href":"/api-reference/latest/draft-returns/set-processing-type"},{"openapi":"openapi/draft-returns.yaml post /draft-returns/{draft_return_id}/finalize-items","title":"Finalize Items","href":"/api-reference/latest/draft-returns/finalize-items"},{"openapi":"openapi/draft-returns.yaml post /draft-returns/{draft_return_id}/unfinalize-items","title":"Unfinalize Items","href":"/api-reference/latest/draft-returns/unfinalize-items"},{"openapi":"openapi/draft-returns.yaml post /draft-returns/{draft_return_id}/return-method","title":"Select Return Method","href":"/api-reference/latest/draft-returns/select-return-method"},{"openapi":"openapi/draft-returns.yaml post /draft-returns/{draft_return_id}/submit","title":"Submit Draft Return","href":"/api-reference/latest/draft-returns/submit-draft-return"}]},{"group":"Commerce Data","pages":[{"group":"Products","pages":[{"openapi":"get /products","title":"List Products","href":"/api-reference/latest/products/list-products"},{"openapi":"post /products","title":"Create Product","href":"/api-reference/latest/products/create-product"},{"openapi":"put /products","title":"Upsert Product","href":"/api-reference/latest/products/upsert-product"},{"openapi":"get /products/{id}","title":"Get Product","href":"/api-reference/latest/products/get-product"},{"openapi":"get /products/external/{externalId}","title":"Get Product by External ID","href":"/api-reference/latest/products/get-product-by-external-id"},{"openapi":"put /products/{id}","title":"Update Product","href":"/api-reference/latest/products/update-product"},{"openapi":"delete /products/{id}","title":"Delete Product","href":"/api-reference/latest/products/delete-product"},{"openapi":"delete /products/external/{externalId}","title":"Delete Product by External ID","href":"/api-reference/latest/products/delete-product-by-external-id"},{"openapi":"get /products/{productId}/product-variants","title":"List Product Variants","href":"/api-reference/latest/products/list-product-variants"},{"openapi":"post /products/{productId}/product-variants","title":"Create Product Variant","href":"/api-reference/latest/products/create-product-variant"},{"openapi":"put /products/{productId}/product-variants","title":"Upsert Product Variant","href":"/api-reference/latest/products/upsert-product-variant"},{"openapi":"put /products/external/{productExternalId}/product-variants","title":"Upsert Product Variant by Product External ID","href":"/api-reference/latest/products/upsert-product-variant-by-product-external-id"},{"openapi":"get /products/{productId}/product-variants/{id}","title":"Get Product Variant","href":"/api-reference/latest/products/get-product-variant"},{"openapi":"get /products/external/{productExternalId}/product-variants/{externalId}","title":"Get Product Variant by External ID","description":"Get the details about a single product variant by the parent product's commerce `external_id` and the variant's commerce `external_id`.","href":"/api-reference/latest/products/get-product-variant-by-external-id"},{"openapi":"patch /products/{productId}/product-variants/{id}","title":"Update Product Variant","href":"/api-reference/latest/products/update-product-variant"},{"openapi":"delete /products/{productId}/product-variants/{id}","title":"Delete Product Variant","description":"Delete a product variant.","href":"/api-reference/latest/products/delete-product-variant"},{"openapi":"delete /products/external/{productExternalId}/product-variants/{externalId}","title":"Delete Product Variant by External ID","href":"/api-reference/latest/products/delete-product-variant-by-external-id"}]},{"group":"Orders","pages":[{"openapi":"get /orders","title":"List Orders","href":"/api-reference/latest/orders/list-orders"},{"openapi":"openapi/orders-api-2026-07.yaml post /orders","title":"Create Order","href":"/api-reference/2026-07/orders/create-order"},{"openapi":"openapi/orders-api-2026-07.yaml put /orders","title":"Upsert Order","href":"/api-reference/2026-07/orders/upsert-order"},{"openapi":"get /orders/{id}","title":"Get Order","href":"/api-reference/latest/orders/get-order"},{"openapi":"get /orders/external/{externalId}","title":"Get Order by External ID","href":"/api-reference/latest/orders/get-order-by-external-id"},{"openapi":"openapi/orders-api-2026-07.yaml put /orders/{id}","title":"Update Order","href":"/api-reference/2026-07/orders/update-order"},{"openapi":"delete /orders/{id}","title":"Delete Order","href":"/api-reference/latest/orders/delete-order"},{"openapi":"delete /orders/external/{externalId}","title":"Delete Order by External ID","href":"/api-reference/latest/orders/delete-order-by-external-id"}]},{"group":"Customers","pages":[{"openapi":"get /customers","title":"List Customers","href":"/api-reference/latest/customers/list-customers"},{"openapi":"post /customers","title":"Create Customer","href":"/api-reference/latest/customers/create-customer"},{"openapi":"put /customers","title":"Upsert Customer","href":"/api-reference/latest/customers/upsert-customer"},{"openapi":"get /customers/{id}","title":"Get Customer","href":"/api-reference/latest/customers/get-customer"},{"openapi":"get /customers/external/{externalId}","title":"Get Customer by External ID","href":"/api-reference/latest/customers/get-customer-by-external-id"},{"openapi":"put /customers/{id}","title":"Update Customer","href":"/api-reference/latest/customers/update-customer"},{"openapi":"delete /customers/{id}","title":"Delete Customer","href":"/api-reference/latest/customers/delete-customer"},{"openapi":"delete /customers/external/{externalId}","title":"Delete Customer by External ID","href":"/api-reference/latest/customers/delete-customer-by-external-id"},{"title":"Redact Customer","openapi":"post /privacy/customer/redact","href":"/api-reference/latest/customers/redact-customer"}]},{"group":"Locations","pages":[{"openapi":"get /locations","title":"List Locations","href":"/api-reference/latest/locations/list-locations"},{"openapi":"post /locations","title":"Create Location","href":"/api-reference/latest/locations/create-location"},{"openapi":"put /locations","title":"Upsert Location","href":"/api-reference/latest/locations/upsert-location"},{"openapi":"get /locations/{id}","title":"Get Location","href":"/api-reference/latest/locations/get-location"},{"openapi":"get /locations/external/{externalId}","title":"Get Location by External ID","href":"/api-reference/latest/locations/get-location-by-external-id"},{"openapi":"put /locations/{id}","title":"Update Location","href":"/api-reference/latest/locations/update-location"},{"openapi":"delete /locations/{id}","title":"Delete Location","href":"/api-reference/latest/locations/delete-location"},{"openapi":"delete /locations/external/{externalId}","title":"Delete Location by External ID","href":"/api-reference/latest/locations/delete-location-by-external-id"}]},{"group":"Inventories","pages":[{"openapi":"get /inventories","title":"List Inventories","href":"/api-reference/latest/inventories/list-inventories"},{"openapi":"post /inventories/{productVariantId}/{locationId}","title":"Upsert Inventory","href":"/api-reference/latest/inventories/create-inventory"},{"openapi":"put /inventories/{productVariantId}/{locationId}","title":"Upsert Inventory","href":"/api-reference/latest/inventories/upsert-inventory"},{"openapi":"put /inventories/external/{variantExternalId}/{locationExternalId}","title":"Upsert Inventory by External IDs","href":"/api-reference/latest/inventories/upsert-inventory-by-external-ids"},{"openapi":"get /inventories/{productVariantId}/{locationId}","title":"Get Inventory","href":"/api-reference/latest/inventories/get-inventory"},{"openapi":"get /inventories/external/{variantExternalId}/{locationExternalId}","title":"Get Inventory by External IDs","href":"/api-reference/latest/inventories/get-inventory-by-external-ids"},{"openapi":"delete /inventories/{productVariantId}/{locationId}","title":"Delete Inventory","href":"/api-reference/latest/inventories/delete-inventory"},{"openapi":"delete /inventories/external/{variantExternalId}/{locationExternalId}","title":"Delete Inventory by External IDs","href":"/api-reference/latest/inventories/delete-inventory-by-external-ids"}]},{"group":"Collections","pages":[{"openapi":"get /collections","title":"List Collections","href":"/api-reference/latest/collections/list-collections"},{"openapi":"post /collections","title":"Create Collection","href":"/api-reference/latest/collections/create-collection"},{"openapi":"put /collections","title":"Upsert Collection","href":"/api-reference/latest/collections/upsert-collection"},{"openapi":"get /collections/{id}","title":"Get Collection","href":"/api-reference/latest/collections/get-collection"},{"openapi":"get /collections/external/{externalId}","title":"Get Collection by External ID","href":"/api-reference/latest/collections/get-collection-by-external-id"},{"openapi":"put /collections/{id}","title":"Update Collection","href":"/api-reference/latest/collections/update-collection"},{"openapi":"delete /collections/{id}","title":"Delete Collection","href":"/api-reference/latest/collections/delete-collection"},{"openapi":"delete /collections/external/{externalId}","title":"Delete Collection by External ID","href":"/api-reference/latest/collections/delete-collection-by-external-id"},{"openapi":"post /collections/{id}/products/{productId}","title":"Add Product to Collection","href":"/api-reference/latest/collections/add-product-to-collection"},{"openapi":"delete /collections/{id}/products/{productId}","title":"Delete Product from Collection","href":"/api-reference/latest/collections/delete-product-from-collection"},{"openapi":"post /collections/external/{collectionExternalId}/products/external/{productExternalId}","title":"Add Product to Collection by External ID","href":"/api-reference/latest/collections/add-product-to-collection-by-external-id"},{"openapi":"delete /collections/external/{collectionExternalId}/products/external/{productExternalId}","title":"Delete Product from Collection by External ID","href":"/api-reference/latest/collections/delete-product-from-collection-by-external-id"}]},{"group":"Bulk Operations","pages":[{"openapi":"post /bulk-operations","title":"Create Bulk Operation","href":"/api-reference/latest/bulk-operations/create-bulk-operation"},{"openapi":"get /bulk-operations","title":"List Bulk Operations","href":"/api-reference/latest/bulk-operations/list-bulk-operations"},{"openapi":"get /bulk-operations/{id}","title":"Get Bulk Operation","href":"/api-reference/latest/bulk-operations/get-bulk-operation"},{"openapi":"get /bulk-operations/{id}/jobs","title":"List Bulk Operation Jobs","href":"/api-reference/latest/bulk-operations/list-bulk-operation-jobs"}]}]}]}]},{"tab":"Webhook Reference","pages":[{"title":"Webhook Reference","href":"/webhook-reference/getting-started"}]}]},{"version":"2026-10","default":true,"tabs":[{"tab":"Introduction","pages":[{"title":"Introduction","href":"/welcome"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/integration-guides/overview"}]},{"tab":"MCP Server","pages":[{"title":"MCP Server","href":"/mcp/overview"}]},{"tab":"API Reference","groups":[{"group":"Using the API","pages":[{"title":"Getting Started","icon":"play","href":"/api-reference/getting-started"},{"title":"Authentication","version":"2026-07","icon":"lock","href":"/api-reference/authentication"},{"title":"API Versioning","icon":"clock","href":"/api-reference/versioning"},{"title":"Rate limit","icon":"gauge","href":"/api-reference/rate-limit"},{"title":"Pagination","icon":"page","href":"/api-reference/pagination"},{"title":"Error codes","icon":"circle-exclamation","iconType":"regular","href":"/api-reference/error-codes"},{"title":"Postman Collection","icon":"bolt","href":"/api-reference/postman"}]},{"group":"APIs","pages":[{"group":"Return Actions","pages":[{"openapi":"post /warehouse/return/{id}/process","title":"Process Return","href":"/api-reference/latest/return-actions/process-return"},{"openapi":"post /warehouse/return/{id}/remove","title":"Remove Line Items","href":"/api-reference/latest/return-actions/remove-line-items"},{"openapi":"post /warehouse/return/{id}/cancel","title":"Cancel Return","href":"/api-reference/latest/return-actions/cancel-return"},{"openapi":"post /warehouse/return/{id}/flag","title":"Flag Return","href":"/api-reference/latest/return-actions/flag-return"},{"openapi":"post /warehouse/return/{id}/close","title":"Close Return","href":"/api-reference/latest/return-actions/close-return"},{"openapi":"get /warehouse/return/{id}/notes","title":"Get Return Notes","href":"/api-reference/latest/return-actions/get-return-notes"},{"openapi":"post /warehouse/return/{id}/note","title":"Create Return Note","href":"/api-reference/latest/return-actions/create-return-note"},{"openapi":"post /order/link","title":"Create Return Deep Link","href":"/api-reference/latest/return-actions/create-return-deep-link"},{"openapi":"post /order/qr","title":"Create Return Deep Link with QR Code","href":"/api-reference/latest/return-actions/create-return-deep-link-with-qr-code"}]},{"group":"Return Data","pages":[{"openapi":"get /warehouse/return/list","title":"Detailed Returns List","href":"/api-reference/latest/return-data/detailed-returns-list"},{"openapi":"get /warehouse/return/details","title":"Get Return Details","href":"/api-reference/latest/return-data/get-return-details"},{"openapi":"get /warehouse/reporting/asn","title":"Advanced Shipping Notice","href":"/api-reference/latest/return-data/advanced-shipping-notice"}]},{"group":"Programmatic Webhooks","pages":[{"openapi":"get /webhooks","title":"Get Webhooks","href":"/api-reference/latest/programmatic-webhooks/get-webhooks"},{"openapi":"post /webhooks","title":"Create Webhook","href":"/api-reference/latest/programmatic-webhooks/create-webhook"},{"openapi":"put /webhooks/{id}","title":"Update Webhook","href":"/api-reference/latest/programmatic-webhooks/update-webhook"},{"openapi":"delete /webhooks/{id}","title":"Delete Webhook","href":"/api-reference/latest/programmatic-webhooks/delete-webhook"}]},{"group":"Item Grading and Dispositioning","pages":[{"openapi":"post /dispositioning/grade","title":"Grade Items","href":"/api-reference/latest/item-grading-and-disposition/grade-items"},{"openapi":"post /dispositioning/assess","title":"Assess Dispositions","href":"/api-reference/latest/item-grading-and-disposition/assess-dispositions"}]},{"group":"Cart","pages":[{"openapi":"post /cart","title":"Create Cart","href":"/api-reference/latest/cart/create-cart"},{"openapi":"get /cart/{token}","title":null,"href":"/api-reference/latest/cart/get-cart"},{"openapi":"post /cart/{token}","title":null,"href":"/api-reference/latest/cart/update-cart"},{"openapi":"delete /cart/{token}","title":null,"href":"/api-reference/latest/cart/delete-cart"}]},{"group":"Destinations","pages":[{"openapi":"get /destinations","title":"Get All Destinations","href":"/api-reference/latest/destinations/get-all-destinations"},{"openapi":"post /destinations","title":"Create Destination","href":"/api-reference/latest/destinations/create-destination"},{"openapi":"get /destinations/{id}","title":"Get Destination Details","href":"/api-reference/latest/destinations/get-destination-details"},{"openapi":"put /destinations/{id}","title":"Update Destination","href":"/api-reference/latest/destinations/update-destination"},{"openapi":"delete /destinations/{id}","title":"Delete Destination","href":"/api-reference/latest/destinations/delete-destination"}]},{"group":"Blocklist","pages":[{"openapi":"get /blocklists","title":"List Blocklist Items","href":"/api-reference/latest/blocklist/list-blocklist-items"},{"openapi":"post /blocklists","title":"Create Blocklist Item","href":"/api-reference/latest/blocklist/create-blocklist-item"},{"openapi":"get /blocklists/{id}","title":"Get Blocklist Item","href":"/api-reference/latest/blocklist/get-blocklist-item"},{"openapi":"delete /blocklists/{id}","title":"Delete Blocklist Item","href":"/api-reference/latest/blocklist/delete-blocklist-item"}]},{"group":"Allowlist","pages":[{"openapi":"get /allowlists","title":"List Allowlist Items","href":"/api-reference/latest/allowlist/list-allowlist-items"},{"openapi":"post /allowlists","title":"Create Allowlist Item","href":"/api-reference/latest/allowlist/create-allowlist-item"},{"openapi":"get /allowlists/{id}","title":"Get Allowlist Item","href":"/api-reference/latest/allowlist/get-allowlist-item"},{"openapi":"delete /allowlists/{id}","title":"Delete Allowlist Item","href":"/api-reference/latest/allowlist/delete-allowlist-item"}]},{"group":"Fraud Reports","pages":[{"openapi":"post /returns/{id}/fraud-report","title":"Create Fraud Report","href":"/api-reference/latest/return-actions/create-fraud-report"}]},{"group":"Order Return Eligibility","pages":[{"openapi":"post /orders/return-eligibility","title":"Look Up Order Return Eligibility by Order Name","href":"/api-reference/latest/orders/look-up-order-return-eligibility"}]},{"group":"Happy Returns Shipments","pages":[{"openapi":"get /happy-returns/shipments/{happy_returns_shipment_id}","title":"Get Shipment Information","href":"/api-reference/latest/happy-returns-shipment/get-shipment-information"},{"openapi":"get /happy-returns/shipments","title":"Get Shipments","href":"/api-reference/latest/happy-returns-shipment/get-shipments"},{"openapi":"get /happy-returns/shipments/{id}/items","title":"Get Shipment Items","href":"/api-reference/latest/happy-returns-shipment-items/get-shipment-items"}]},{"group":"Label Requests","pages":[{"openapi":"get /label-requests","title":"List Label Requests","href":"/api-reference/latest/label-requests/list-label-requests"},{"openapi":"get /label-requests/{id}","title":"Get Label Request","href":"/api-reference/latest/label-requests/get-label-request"},{"openapi":"post /label-requests/{id}/errors","title":"Create Label Request Error","href":"/api-reference/latest/label-requests/create-a-label-request-error"},{"openapi":"post /labels","title":"Create Label","href":"/api-reference/latest/label-requests/create-label"},{"openapi":"post /returns/{returnId}/labels","title":"Generate Label","href":"/api-reference/latest/label-requests/generate-label"},{"openapi":"put /labels/{id}","title":"Update Label Status","href":"/api-reference/latest/label-requests/update-label-status"}]},{"group":"Ship by Loop","pages":[{"openapi":"post /ship-by-loop/shipments/{shipmentId}/services","title":"Add available services to a shipment","href":"/api-reference/latest/ship-by-loop/add-available-services-to-a-shipment"},{"openapi":"post /ship-by-loop/shipments/{shipmentId}/orders","title":"Record orders on a shipment","href":"/api-reference/latest/ship-by-loop/record-orders-on-a-shipment"},{"openapi":"post /ship-by-loop/shipments/{shipmentId}/errors","title":"Report errors on a shipment","href":"/api-reference/latest/ship-by-loop/report-errors-on-a-shipment"}]},{"group":"Return Create","pages":[{"title":"Return Create Overview","version":"2026-10","href":"/api-reference/2026-10/draft-returns/overview"},{"openapi":"draft-returns-hal-forms get /draft-returns","title":"List Draft Returns","href":"/api-reference/2026-10/draft-returns/list-draft-returns"},{"openapi":"draft-returns-hal-forms get /draft-returns/{draft_return_id}","title":"Get Draft Return","href":"/api-reference/2026-10/draft-returns/get-draft-return"},{"openapi":"draft-returns-hal-forms get /draft-returns/{draft_return_id}/order/items","title":"List Order Line Items","href":"/api-reference/2026-10/draft-returns/list-order-line-items"},{"openapi":"draft-returns-hal-forms get /draft-returns/{draft_return_id}/totals","title":"Get Draft Return Totals","href":"/api-reference/2026-10/draft-returns/get-draft-return-totals"},{"openapi":"draft-returns-hal-forms post /draft-returns","title":"Initialize Draft Return","href":"/api-reference/2026-10/draft-returns/initialize-draft-return"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/accept-return-policy","title":"Accept Return Policy","href":"/api-reference/2026-10/draft-returns/accept-return-policy"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/cancel","title":"Cancel Draft Return","href":"/api-reference/2026-10/draft-returns/cancel-draft-return"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/customer","title":"Set Customer","href":"/api-reference/2026-10/draft-returns/set-customer"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/address","title":"Set Address","href":"/api-reference/2026-10/draft-returns/set-address"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/returning-items","title":"Add Returning Item","href":"/api-reference/2026-10/draft-returns/add-returning-item"},{"openapi":"draft-returns-hal-forms delete /draft-returns/{draft_return_id}/returning-items/{returning_item_id}","title":"Remove Returning Item","href":"/api-reference/2026-10/draft-returns/remove-returning-item"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/returning-items/{returning_item_id}/return-reason","title":"Set Returning Item Return Reason","href":"/api-reference/2026-10/draft-returns/set-returning-item-return-reason"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/returning-items/{returning_item_id}/user-input/{user_input_id}","title":"Add Returning Item User Input","href":"/api-reference/2026-10/draft-returns/add-returning-item-user-input"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/returning-items/{returning_item_id}/return-type","title":"Set Returning Item Return Type","href":"/api-reference/2026-10/draft-returns/set-returning-item-return-type"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/returning-items/{returning_item_id}/exchange-item","title":"Add Returning Item Exchange Item","href":"/api-reference/2026-10/draft-returns/add-returning-item-exchange-item"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/cart/items","title":"Add Cart Item","href":"/api-reference/2026-10/draft-returns/add-cart-item"},{"openapi":"draft-returns-hal-forms delete /draft-returns/{draft_return_id}/cart/items/{cart_item_id}","title":"Remove Cart Item","href":"/api-reference/2026-10/draft-returns/remove-cart-item"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/credit-type","title":"Set Credit Type","href":"/api-reference/2026-10/draft-returns/set-credit-type"},{"openapi":"draft-returns-hal-forms delete /draft-returns/{draft_return_id}/credit-type","title":"Unset Credit Type","href":"/api-reference/2026-10/draft-returns/unset-credit-type"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/processing-type","title":"Set Processing Type","href":"/api-reference/2026-10/draft-returns/set-processing-type"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/finalize-items","title":"Finalize Items","href":"/api-reference/2026-10/draft-returns/finalize-items"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/unfinalize-items","title":"Unfinalize Items","href":"/api-reference/2026-10/draft-returns/unfinalize-items"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/return-method","title":"Select Return Method","href":"/api-reference/2026-10/draft-returns/select-return-method"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/return-method/carrier","title":"Select Return Method Carrier","href":"/api-reference/2026-10/draft-returns/select-return-method-carrier"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/language","title":"Set Language","href":"/api-reference/2026-10/draft-returns/set-language"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/cart","title":"Set Cart","href":"/api-reference/2026-10/draft-returns/set-cart"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/payment-intent","title":"Create Payment Intent","href":"/api-reference/2026-10/draft-returns/create-payment-intent"},{"openapi":"draft-returns-hal-forms delete /draft-returns/{draft_return_id}/payment-intent/{payment_intent_id}","title":"Remove Payment Intent","href":"/api-reference/2026-10/draft-returns/remove-payment-intent"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/submit","title":"Submit Draft Return","href":"/api-reference/2026-10/draft-returns/submit-draft-return"}]},{"group":"Commerce Data","pages":[{"group":"Products","pages":[{"openapi":"get /products","title":"List Products","href":"/api-reference/latest/products/list-products"},{"openapi":"post /products","title":"Create Product","href":"/api-reference/latest/products/create-product"},{"openapi":"put /products","title":"Upsert Product","href":"/api-reference/latest/products/upsert-product"},{"openapi":"get /products/{id}","title":"Get Product","href":"/api-reference/latest/products/get-product"},{"openapi":"get /products/external/{externalId}","title":"Get Product by External ID","href":"/api-reference/latest/products/get-product-by-external-id"},{"openapi":"put /products/{id}","title":"Update Product","href":"/api-reference/latest/products/update-product"},{"openapi":"delete /products/{id}","title":"Delete Product","href":"/api-reference/latest/products/delete-product"},{"openapi":"delete /products/external/{externalId}","title":"Delete Product by External ID","href":"/api-reference/latest/products/delete-product-by-external-id"},{"openapi":"get /products/{productId}/product-variants","title":"List Product Variants","href":"/api-reference/latest/products/list-product-variants"},{"openapi":"post /products/{productId}/product-variants","title":"Create Product Variant","href":"/api-reference/latest/products/create-product-variant"},{"openapi":"put /products/{productId}/product-variants","title":"Upsert Product Variant","href":"/api-reference/latest/products/upsert-product-variant"},{"openapi":"put /products/external/{productExternalId}/product-variants","title":"Upsert Product Variant by Product External ID","href":"/api-reference/latest/products/upsert-product-variant-by-product-external-id"},{"openapi":"get /products/{productId}/product-variants/{id}","title":"Get Product Variant","href":"/api-reference/latest/products/get-product-variant"},{"openapi":"get /products/external/{productExternalId}/product-variants/{externalId}","title":"Get Product Variant by External ID","description":"Get the details about a single product variant by the parent product's commerce `external_id` and the variant's commerce `external_id`.","href":"/api-reference/latest/products/get-product-variant-by-external-id"},{"openapi":"patch /products/{productId}/product-variants/{id}","title":"Update Product Variant","href":"/api-reference/latest/products/update-product-variant"},{"openapi":"delete /products/{productId}/product-variants/{id}","title":"Delete Product Variant","description":"Delete a product variant.","href":"/api-reference/latest/products/delete-product-variant"},{"openapi":"delete /products/external/{productExternalId}/product-variants/{externalId}","title":"Delete Product Variant by External ID","href":"/api-reference/latest/products/delete-product-variant-by-external-id"}]},{"group":"Orders","pages":[{"openapi":"get /orders","title":"List Orders","href":"/api-reference/latest/orders/list-orders"},{"openapi":"openapi/orders-api.yaml post /orders","title":"Create Order","href":"/api-reference/latest/orders/create-order"},{"openapi":"openapi/orders-api.yaml put /orders","title":"Upsert Order","href":"/api-reference/latest/orders/upsert-order"},{"openapi":"get /orders/{id}","title":"Get Order","href":"/api-reference/latest/orders/get-order"},{"openapi":"get /orders/external/{externalId}","title":"Get Order by External ID","href":"/api-reference/latest/orders/get-order-by-external-id"},{"openapi":"openapi/orders-api.yaml put /orders/{id}","title":"Update Order","href":"/api-reference/latest/orders/update-order"},{"openapi":"delete /orders/{id}","title":"Delete Order","href":"/api-reference/latest/orders/delete-order"},{"openapi":"delete /orders/external/{externalId}","title":"Delete Order by External ID","href":"/api-reference/latest/orders/delete-order-by-external-id"}]},{"group":"Customers","pages":[{"openapi":"get /customers","title":"List Customers","href":"/api-reference/latest/customers/list-customers"},{"openapi":"post /customers","title":"Create Customer","href":"/api-reference/latest/customers/create-customer"},{"openapi":"put /customers","title":"Upsert Customer","href":"/api-reference/latest/customers/upsert-customer"},{"openapi":"get /customers/{id}","title":"Get Customer","href":"/api-reference/latest/customers/get-customer"},{"openapi":"get /customers/external/{externalId}","title":"Get Customer by External ID","href":"/api-reference/latest/customers/get-customer-by-external-id"},{"openapi":"put /customers/{id}","title":"Update Customer","href":"/api-reference/latest/customers/update-customer"},{"openapi":"delete /customers/{id}","title":"Delete Customer","href":"/api-reference/latest/customers/delete-customer"},{"openapi":"delete /customers/external/{externalId}","title":"Delete Customer by External ID","href":"/api-reference/latest/customers/delete-customer-by-external-id"},{"title":"Redact Customer","openapi":"post /privacy/customer/redact","href":"/api-reference/latest/customers/redact-customer"}]},{"group":"Locations","pages":[{"openapi":"get /locations","title":"List Locations","href":"/api-reference/latest/locations/list-locations"},{"openapi":"post /locations","title":"Create Location","href":"/api-reference/latest/locations/create-location"},{"openapi":"put /locations","title":"Upsert Location","href":"/api-reference/latest/locations/upsert-location"},{"openapi":"get /locations/{id}","title":"Get Location","href":"/api-reference/latest/locations/get-location"},{"openapi":"get /locations/external/{externalId}","title":"Get Location by External ID","href":"/api-reference/latest/locations/get-location-by-external-id"},{"openapi":"put /locations/{id}","title":"Update Location","href":"/api-reference/latest/locations/update-location"},{"openapi":"delete /locations/{id}","title":"Delete Location","href":"/api-reference/latest/locations/delete-location"},{"openapi":"delete /locations/external/{externalId}","title":"Delete Location by External ID","href":"/api-reference/latest/locations/delete-location-by-external-id"}]},{"group":"Inventories","pages":[{"openapi":"get /inventories","title":"List Inventories","href":"/api-reference/latest/inventories/list-inventories"},{"openapi":"post /inventories/{productVariantId}/{locationId}","title":"Upsert Inventory","href":"/api-reference/latest/inventories/create-inventory"},{"openapi":"put /inventories/{productVariantId}/{locationId}","title":"Upsert Inventory","href":"/api-reference/latest/inventories/upsert-inventory"},{"openapi":"put /inventories/external/{variantExternalId}/{locationExternalId}","title":"Upsert Inventory by External IDs","href":"/api-reference/latest/inventories/upsert-inventory-by-external-ids"},{"openapi":"get /inventories/{productVariantId}/{locationId}","title":"Get Inventory","href":"/api-reference/latest/inventories/get-inventory"},{"openapi":"get /inventories/external/{variantExternalId}/{locationExternalId}","title":"Get Inventory by External IDs","href":"/api-reference/latest/inventories/get-inventory-by-external-ids"},{"openapi":"delete /inventories/{productVariantId}/{locationId}","title":"Delete Inventory","href":"/api-reference/latest/inventories/delete-inventory"},{"openapi":"delete /inventories/external/{variantExternalId}/{locationExternalId}","title":"Delete Inventory by External IDs","href":"/api-reference/latest/inventories/delete-inventory-by-external-ids"}]},{"group":"Collections","pages":[{"openapi":"get /collections","title":"List Collections","href":"/api-reference/latest/collections/list-collections"},{"openapi":"post /collections","title":"Create Collection","href":"/api-reference/latest/collections/create-collection"},{"openapi":"put /collections","title":"Upsert Collection","href":"/api-reference/latest/collections/upsert-collection"},{"openapi":"get /collections/{id}","title":"Get Collection","href":"/api-reference/latest/collections/get-collection"},{"openapi":"get /collections/external/{externalId}","title":"Get Collection by External ID","href":"/api-reference/latest/collections/get-collection-by-external-id"},{"openapi":"put /collections/{id}","title":"Update Collection","href":"/api-reference/latest/collections/update-collection"},{"openapi":"delete /collections/{id}","title":"Delete Collection","href":"/api-reference/latest/collections/delete-collection"},{"openapi":"delete /collections/external/{externalId}","title":"Delete Collection by External ID","href":"/api-reference/latest/collections/delete-collection-by-external-id"},{"openapi":"post /collections/{id}/products/{productId}","title":"Add Product to Collection","href":"/api-reference/latest/collections/add-product-to-collection"},{"openapi":"delete /collections/{id}/products/{productId}","title":"Delete Product from Collection","href":"/api-reference/latest/collections/delete-product-from-collection"},{"openapi":"post /collections/external/{collectionExternalId}/products/external/{productExternalId}","title":"Add Product to Collection by External ID","href":"/api-reference/latest/collections/add-product-to-collection-by-external-id"},{"openapi":"delete /collections/external/{collectionExternalId}/products/external/{productExternalId}","title":"Delete Product from Collection by External ID","href":"/api-reference/latest/collections/delete-product-from-collection-by-external-id"}]},{"group":"Bulk Operations","pages":[{"openapi":"post /bulk-operations","title":"Create Bulk Operation","href":"/api-reference/latest/bulk-operations/create-bulk-operation"},{"openapi":"get /bulk-operations","title":"List Bulk Operations","href":"/api-reference/latest/bulk-operations/list-bulk-operations"},{"openapi":"get /bulk-operations/{id}","title":"Get Bulk Operation","href":"/api-reference/latest/bulk-operations/get-bulk-operation"},{"openapi":"get /bulk-operations/{id}/jobs","title":"List Bulk Operation Jobs","href":"/api-reference/latest/bulk-operations/list-bulk-operation-jobs"}]}]}]}]},{"tab":"Webhook Reference","pages":[{"title":"Webhook Reference","href":"/webhook-reference/getting-started"}]}]},{"version":"unstable","tabs":[{"tab":"Introduction","pages":[{"title":"Introduction","href":"/welcome"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/integration-guides/overview"}]},{"tab":"MCP Server","pages":[{"title":"MCP Server","href":"/mcp/overview"}]},{"tab":"API Reference","groups":[{"group":"Unstable","pages":[{"title":"What's different in unstable","sidebarTitle":"What's Changed","href":"/api-reference/unstable/changes"}]},{"group":"Using the API","pages":[{"title":"Getting Started","icon":"play","href":"/api-reference/getting-started"},{"title":"Authentication","version":"2026-07","icon":"lock","href":"/api-reference/authentication"},{"title":"API Versioning","icon":"clock","href":"/api-reference/versioning"},{"title":"Rate limit","icon":"gauge","href":"/api-reference/rate-limit"},{"title":"Pagination","icon":"page","href":"/api-reference/pagination"},{"title":"Error codes","icon":"circle-exclamation","iconType":"regular","href":"/api-reference/error-codes"},{"title":"Postman Collection","icon":"bolt","href":"/api-reference/postman"}]},{"group":"APIs","pages":[{"group":"Return Actions","pages":[{"openapi":"post /warehouse/return/{id}/process","title":"Process Return","href":"/api-reference/latest/return-actions/process-return"},{"openapi":"post /warehouse/return/{id}/remove","title":"Remove Line Items","href":"/api-reference/latest/return-actions/remove-line-items"},{"openapi":"post /warehouse/return/{id}/cancel","title":"Cancel Return","href":"/api-reference/latest/return-actions/cancel-return"},{"openapi":"post /warehouse/return/{id}/flag","title":"Flag Return","href":"/api-reference/latest/return-actions/flag-return"},{"openapi":"post /warehouse/return/{id}/close","title":"Close Return","href":"/api-reference/latest/return-actions/close-return"},{"openapi":"get /warehouse/return/{id}/notes","title":"Get Return Notes","href":"/api-reference/latest/return-actions/get-return-notes"},{"openapi":"post /warehouse/return/{id}/note","title":"Create Return Note","href":"/api-reference/latest/return-actions/create-return-note"},{"openapi":"post /order/link","title":"Create Return Deep Link","href":"/api-reference/latest/return-actions/create-return-deep-link"},{"openapi":"post /order/qr","title":"Create Return Deep Link with QR Code","href":"/api-reference/latest/return-actions/create-return-deep-link-with-qr-code"}]},{"group":"Return Data","pages":[{"openapi":"get /warehouse/return/list","title":"Detailed Returns List","href":"/api-reference/latest/return-data/detailed-returns-list"},{"openapi":"get /warehouse/return/details","title":"Get Return Details","href":"/api-reference/latest/return-data/get-return-details"},{"openapi":"get /warehouse/reporting/asn","title":"Advanced Shipping Notice","href":"/api-reference/latest/return-data/advanced-shipping-notice"}]},{"group":"Programmatic Webhooks","pages":[{"openapi":"get /webhooks","title":"Get Webhooks","href":"/api-reference/latest/programmatic-webhooks/get-webhooks"},{"openapi":"post /webhooks","title":"Create Webhook","href":"/api-reference/latest/programmatic-webhooks/create-webhook"},{"openapi":"put /webhooks/{id}","title":"Update Webhook","href":"/api-reference/latest/programmatic-webhooks/update-webhook"},{"openapi":"delete /webhooks/{id}","title":"Delete Webhook","href":"/api-reference/latest/programmatic-webhooks/delete-webhook"}]},{"group":"Item Grading and Dispositioning","pages":[{"openapi":"post /dispositioning/grade","title":"Grade Items","href":"/api-reference/latest/item-grading-and-disposition/grade-items"},{"openapi":"post /dispositioning/assess","title":"Assess Dispositions","href":"/api-reference/latest/item-grading-and-disposition/assess-dispositions"}]},{"group":"Cart","pages":[{"openapi":"post /cart","title":"Create Cart","href":"/api-reference/latest/cart/create-cart"},{"openapi":"get /cart/{token}","title":null,"href":"/api-reference/latest/cart/get-cart"},{"openapi":"post /cart/{token}","title":null,"href":"/api-reference/latest/cart/update-cart"},{"openapi":"delete /cart/{token}","title":null,"href":"/api-reference/latest/cart/delete-cart"}]},{"group":"Destinations","pages":[{"openapi":"get /destinations","title":"Get All Destinations","href":"/api-reference/latest/destinations/get-all-destinations"},{"openapi":"post /destinations","title":"Create Destination","href":"/api-reference/latest/destinations/create-destination"},{"openapi":"get /destinations/{id}","title":"Get Destination Details","href":"/api-reference/latest/destinations/get-destination-details"},{"openapi":"put /destinations/{id}","title":"Update Destination","href":"/api-reference/latest/destinations/update-destination"},{"openapi":"delete /destinations/{id}","title":"Delete Destination","href":"/api-reference/latest/destinations/delete-destination"}]},{"group":"Blocklist","pages":[{"openapi":"get /blocklists","title":"List Blocklist Items","href":"/api-reference/latest/blocklist/list-blocklist-items"},{"openapi":"post /blocklists","title":"Create Blocklist Item","href":"/api-reference/latest/blocklist/create-blocklist-item"},{"openapi":"get /blocklists/{id}","title":"Get Blocklist Item","href":"/api-reference/latest/blocklist/get-blocklist-item"},{"openapi":"delete /blocklists/{id}","title":"Delete Blocklist Item","href":"/api-reference/latest/blocklist/delete-blocklist-item"}]},{"group":"Allowlist","pages":[{"openapi":"get /allowlists","title":"List Allowlist Items","href":"/api-reference/latest/allowlist/list-allowlist-items"},{"openapi":"post /allowlists","title":"Create Allowlist Item","href":"/api-reference/latest/allowlist/create-allowlist-item"},{"openapi":"get /allowlists/{id}","title":"Get Allowlist Item","href":"/api-reference/latest/allowlist/get-allowlist-item"},{"openapi":"delete /allowlists/{id}","title":"Delete Allowlist Item","href":"/api-reference/latest/allowlist/delete-allowlist-item"}]},{"group":"Fraud Reports","pages":[{"openapi":"post /returns/{id}/fraud-report","title":"Create Fraud Report","href":"/api-reference/latest/return-actions/create-fraud-report"}]},{"group":"Order Return Eligibility","pages":[{"openapi":"post /orders/return-eligibility","title":"Look Up Order Return Eligibility by Order Name","href":"/api-reference/latest/orders/look-up-order-return-eligibility"}]},{"group":"Happy Returns Shipments","pages":[{"openapi":"get /happy-returns/shipments/{happy_returns_shipment_id}","title":"Get Shipment Information","href":"/api-reference/latest/happy-returns-shipment/get-shipment-information"},{"openapi":"get /happy-returns/shipments","title":"Get Shipments","href":"/api-reference/latest/happy-returns-shipment/get-shipments"},{"openapi":"get /happy-returns/shipments/{id}/items","title":"Get Shipment Items","href":"/api-reference/latest/happy-returns-shipment-items/get-shipment-items"}]},{"group":"Label Requests","pages":[{"openapi":"get /label-requests","title":"List Label Requests","href":"/api-reference/latest/label-requests/list-label-requests"},{"openapi":"get /label-requests/{id}","title":"Get Label Request","href":"/api-reference/latest/label-requests/get-label-request"},{"openapi":"post /label-requests/{id}/errors","title":"Create Label Request Error","href":"/api-reference/latest/label-requests/create-a-label-request-error"},{"openapi":"post /labels","title":"Create Label","href":"/api-reference/latest/label-requests/create-label"},{"openapi":"post /returns/{returnId}/labels","title":"Generate Label","href":"/api-reference/latest/label-requests/generate-label"},{"openapi":"put /labels/{id}","title":"Update Label Status","href":"/api-reference/latest/label-requests/update-label-status"}]},{"group":"Ship by Loop","pages":[{"openapi":"post /ship-by-loop/shipments/{shipmentId}/services","title":"Add available services to a shipment","href":"/api-reference/latest/ship-by-loop/add-available-services-to-a-shipment"},{"openapi":"post /ship-by-loop/shipments/{shipmentId}/orders","title":"Record orders on a shipment","href":"/api-reference/latest/ship-by-loop/record-orders-on-a-shipment"},{"openapi":"post /ship-by-loop/shipments/{shipmentId}/errors","title":"Report errors on a shipment","href":"/api-reference/latest/ship-by-loop/report-errors-on-a-shipment"}]},{"group":"Return Create","pages":[{"title":"Return Create Overview","version":"2026-10","href":"/api-reference/2026-10/draft-returns/overview"},{"openapi":"draft-returns-hal-forms get /draft-returns","title":"List Draft Returns","href":"/api-reference/2026-10/draft-returns/list-draft-returns"},{"openapi":"draft-returns-hal-forms get /draft-returns/{draft_return_id}","title":"Get Draft Return","href":"/api-reference/2026-10/draft-returns/get-draft-return"},{"openapi":"draft-returns-hal-forms get /draft-returns/{draft_return_id}/order/items","title":"List Order Line Items","href":"/api-reference/2026-10/draft-returns/list-order-line-items"},{"openapi":"draft-returns-hal-forms get /draft-returns/{draft_return_id}/totals","title":"Get Draft Return Totals","href":"/api-reference/2026-10/draft-returns/get-draft-return-totals"},{"openapi":"draft-returns-hal-forms post /draft-returns","title":"Initialize Draft Return","href":"/api-reference/2026-10/draft-returns/initialize-draft-return"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/accept-return-policy","title":"Accept Return Policy","href":"/api-reference/2026-10/draft-returns/accept-return-policy"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/cancel","title":"Cancel Draft Return","href":"/api-reference/2026-10/draft-returns/cancel-draft-return"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/customer","title":"Set Customer","href":"/api-reference/2026-10/draft-returns/set-customer"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/address","title":"Set Address","href":"/api-reference/2026-10/draft-returns/set-address"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/returning-items","title":"Add Returning Item","href":"/api-reference/2026-10/draft-returns/add-returning-item"},{"openapi":"draft-returns-hal-forms delete /draft-returns/{draft_return_id}/returning-items/{returning_item_id}","title":"Remove Returning Item","href":"/api-reference/2026-10/draft-returns/remove-returning-item"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/returning-items/{returning_item_id}/return-reason","title":"Set Returning Item Return Reason","href":"/api-reference/2026-10/draft-returns/set-returning-item-return-reason"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/returning-items/{returning_item_id}/user-input/{user_input_id}","title":"Add Returning Item User Input","href":"/api-reference/2026-10/draft-returns/add-returning-item-user-input"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/returning-items/{returning_item_id}/return-type","title":"Set Returning Item Return Type","href":"/api-reference/2026-10/draft-returns/set-returning-item-return-type"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/returning-items/{returning_item_id}/exchange-item","title":"Add Returning Item Exchange Item","href":"/api-reference/2026-10/draft-returns/add-returning-item-exchange-item"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/cart/items","title":"Add Cart Item","href":"/api-reference/2026-10/draft-returns/add-cart-item"},{"openapi":"draft-returns-hal-forms delete /draft-returns/{draft_return_id}/cart/items/{cart_item_id}","title":"Remove Cart Item","href":"/api-reference/2026-10/draft-returns/remove-cart-item"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/credit-type","title":"Set Credit Type","href":"/api-reference/2026-10/draft-returns/set-credit-type"},{"openapi":"draft-returns-hal-forms delete /draft-returns/{draft_return_id}/credit-type","title":"Unset Credit Type","href":"/api-reference/2026-10/draft-returns/unset-credit-type"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/processing-type","title":"Set Processing Type","href":"/api-reference/2026-10/draft-returns/set-processing-type"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/finalize-items","title":"Finalize Items","href":"/api-reference/2026-10/draft-returns/finalize-items"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/unfinalize-items","title":"Unfinalize Items","href":"/api-reference/2026-10/draft-returns/unfinalize-items"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/return-method","title":"Select Return Method","href":"/api-reference/2026-10/draft-returns/select-return-method"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/return-method/carrier","title":"Select Return Method Carrier","href":"/api-reference/2026-10/draft-returns/select-return-method-carrier"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/language","title":"Set Language","href":"/api-reference/2026-10/draft-returns/set-language"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/cart","title":"Set Cart","href":"/api-reference/2026-10/draft-returns/set-cart"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/payment-intent","title":"Create Payment Intent","href":"/api-reference/2026-10/draft-returns/create-payment-intent"},{"openapi":"draft-returns-hal-forms delete /draft-returns/{draft_return_id}/payment-intent/{payment_intent_id}","title":"Remove Payment Intent","href":"/api-reference/2026-10/draft-returns/remove-payment-intent"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/submit","title":"Submit Draft Return","href":"/api-reference/2026-10/draft-returns/submit-draft-return"}]},{"group":"Commerce Data","pages":[{"group":"Products","pages":[{"openapi":"get /products","title":"List Products","href":"/api-reference/latest/products/list-products"},{"openapi":"post /products","title":"Create Product","href":"/api-reference/latest/products/create-product"},{"openapi":"put /products","title":"Upsert Product","href":"/api-reference/latest/products/upsert-product"},{"openapi":"get /products/{id}","title":"Get Product","href":"/api-reference/latest/products/get-product"},{"openapi":"get /products/external/{externalId}","title":"Get Product by External ID","href":"/api-reference/latest/products/get-product-by-external-id"},{"openapi":"put /products/{id}","title":"Update Product","href":"/api-reference/latest/products/update-product"},{"openapi":"delete /products/{id}","title":"Delete Product","href":"/api-reference/latest/products/delete-product"},{"openapi":"delete /products/external/{externalId}","title":"Delete Product by External ID","href":"/api-reference/latest/products/delete-product-by-external-id"},{"openapi":"get /products/{productId}/product-variants","title":"List Product Variants","href":"/api-reference/latest/products/list-product-variants"},{"openapi":"post /products/{productId}/product-variants","title":"Create Product Variant","href":"/api-reference/latest/products/create-product-variant"},{"openapi":"put /products/{productId}/product-variants","title":"Upsert Product Variant","href":"/api-reference/latest/products/upsert-product-variant"},{"openapi":"put /products/external/{productExternalId}/product-variants","title":"Upsert Product Variant by Product External ID","href":"/api-reference/latest/products/upsert-product-variant-by-product-external-id"},{"openapi":"get /products/{productId}/product-variants/{id}","title":"Get Product Variant","href":"/api-reference/latest/products/get-product-variant"},{"openapi":"get /products/external/{productExternalId}/product-variants/{externalId}","title":"Get Product Variant by External ID","description":"Get the details about a single product variant by the parent product's commerce `external_id` and the variant's commerce `external_id`.","href":"/api-reference/latest/products/get-product-variant-by-external-id"},{"openapi":"patch /products/{productId}/product-variants/{id}","title":"Update Product Variant","href":"/api-reference/latest/products/update-product-variant"},{"openapi":"delete /products/{productId}/product-variants/{id}","title":"Delete Product Variant","description":"Delete a product variant.","href":"/api-reference/latest/products/delete-product-variant"},{"openapi":"delete /products/external/{productExternalId}/product-variants/{externalId}","title":"Delete Product Variant by External ID","href":"/api-reference/latest/products/delete-product-variant-by-external-id"}]},{"group":"Orders","pages":[{"openapi":"get /orders","title":"List Orders","href":"/api-reference/latest/orders/list-orders"},{"openapi":"openapi/orders-api.yaml post /orders","title":"Create Order","href":"/api-reference/latest/orders/create-order"},{"openapi":"openapi/orders-api.yaml put /orders","title":"Upsert Order","href":"/api-reference/latest/orders/upsert-order"},{"openapi":"get /orders/{id}","title":"Get Order","href":"/api-reference/latest/orders/get-order"},{"openapi":"get /orders/external/{externalId}","title":"Get Order by External ID","href":"/api-reference/latest/orders/get-order-by-external-id"},{"openapi":"openapi/orders-api.yaml put /orders/{id}","title":"Update Order","href":"/api-reference/latest/orders/update-order"},{"openapi":"delete /orders/{id}","title":"Delete Order","href":"/api-reference/latest/orders/delete-order"},{"openapi":"delete /orders/external/{externalId}","title":"Delete Order by External ID","href":"/api-reference/latest/orders/delete-order-by-external-id"}]},{"group":"Customers","pages":[{"openapi":"get /customers","title":"List Customers","href":"/api-reference/latest/customers/list-customers"},{"openapi":"post /customers","title":"Create Customer","href":"/api-reference/latest/customers/create-customer"},{"openapi":"put /customers","title":"Upsert Customer","href":"/api-reference/latest/customers/upsert-customer"},{"openapi":"get /customers/{id}","title":"Get Customer","href":"/api-reference/latest/customers/get-customer"},{"openapi":"get /customers/external/{externalId}","title":"Get Customer by External ID","href":"/api-reference/latest/customers/get-customer-by-external-id"},{"openapi":"put /customers/{id}","title":"Update Customer","href":"/api-reference/latest/customers/update-customer"},{"openapi":"delete /customers/{id}","title":"Delete Customer","href":"/api-reference/latest/customers/delete-customer"},{"openapi":"delete /customers/external/{externalId}","title":"Delete Customer by External ID","href":"/api-reference/latest/customers/delete-customer-by-external-id"},{"title":"Redact Customer","openapi":"post /privacy/customer/redact","href":"/api-reference/latest/customers/redact-customer"}]},{"group":"Locations","pages":[{"openapi":"get /locations","title":"List Locations","href":"/api-reference/latest/locations/list-locations"},{"openapi":"post /locations","title":"Create Location","href":"/api-reference/latest/locations/create-location"},{"openapi":"put /locations","title":"Upsert Location","href":"/api-reference/latest/locations/upsert-location"},{"openapi":"get /locations/{id}","title":"Get Location","href":"/api-reference/latest/locations/get-location"},{"openapi":"get /locations/external/{externalId}","title":"Get Location by External ID","href":"/api-reference/latest/locations/get-location-by-external-id"},{"openapi":"put /locations/{id}","title":"Update Location","href":"/api-reference/latest/locations/update-location"},{"openapi":"delete /locations/{id}","title":"Delete Location","href":"/api-reference/latest/locations/delete-location"},{"openapi":"delete /locations/external/{externalId}","title":"Delete Location by External ID","href":"/api-reference/latest/locations/delete-location-by-external-id"}]},{"group":"Inventories","pages":[{"openapi":"get /inventories","title":"List Inventories","href":"/api-reference/latest/inventories/list-inventories"},{"openapi":"post /inventories/{productVariantId}/{locationId}","title":"Upsert Inventory","href":"/api-reference/latest/inventories/create-inventory"},{"openapi":"put /inventories/{productVariantId}/{locationId}","title":"Upsert Inventory","href":"/api-reference/latest/inventories/upsert-inventory"},{"openapi":"put /inventories/external/{variantExternalId}/{locationExternalId}","title":"Upsert Inventory by External IDs","href":"/api-reference/latest/inventories/upsert-inventory-by-external-ids"},{"openapi":"get /inventories/{productVariantId}/{locationId}","title":"Get Inventory","href":"/api-reference/latest/inventories/get-inventory"},{"openapi":"get /inventories/external/{variantExternalId}/{locationExternalId}","title":"Get Inventory by External IDs","href":"/api-reference/latest/inventories/get-inventory-by-external-ids"},{"openapi":"delete /inventories/{productVariantId}/{locationId}","title":"Delete Inventory","href":"/api-reference/latest/inventories/delete-inventory"},{"openapi":"delete /inventories/external/{variantExternalId}/{locationExternalId}","title":"Delete Inventory by External IDs","href":"/api-reference/latest/inventories/delete-inventory-by-external-ids"}]},{"group":"Collections","pages":[{"openapi":"get /collections","title":"List Collections","href":"/api-reference/latest/collections/list-collections"},{"openapi":"post /collections","title":"Create Collection","href":"/api-reference/latest/collections/create-collection"},{"openapi":"put /collections","title":"Upsert Collection","href":"/api-reference/latest/collections/upsert-collection"},{"openapi":"get /collections/{id}","title":"Get Collection","href":"/api-reference/latest/collections/get-collection"},{"openapi":"get /collections/external/{externalId}","title":"Get Collection by External ID","href":"/api-reference/latest/collections/get-collection-by-external-id"},{"openapi":"put /collections/{id}","title":"Update Collection","href":"/api-reference/latest/collections/update-collection"},{"openapi":"delete /collections/{id}","title":"Delete Collection","href":"/api-reference/latest/collections/delete-collection"},{"openapi":"delete /collections/external/{externalId}","title":"Delete Collection by External ID","href":"/api-reference/latest/collections/delete-collection-by-external-id"},{"openapi":"post /collections/{id}/products/{productId}","title":"Add Product to Collection","href":"/api-reference/latest/collections/add-product-to-collection"},{"openapi":"delete /collections/{id}/products/{productId}","title":"Delete Product from Collection","href":"/api-reference/latest/collections/delete-product-from-collection"},{"openapi":"post /collections/external/{collectionExternalId}/products/external/{productExternalId}","title":"Add Product to Collection by External ID","href":"/api-reference/latest/collections/add-product-to-collection-by-external-id"},{"openapi":"delete /collections/external/{collectionExternalId}/products/external/{productExternalId}","title":"Delete Product from Collection by External ID","href":"/api-reference/latest/collections/delete-product-from-collection-by-external-id"}]},{"group":"Bulk Operations","pages":[{"openapi":"post /bulk-operations","title":"Create Bulk Operation","href":"/api-reference/latest/bulk-operations/create-bulk-operation"},{"openapi":"get /bulk-operations","title":"List Bulk Operations","href":"/api-reference/latest/bulk-operations/list-bulk-operations"},{"openapi":"get /bulk-operations/{id}","title":"Get Bulk Operation","href":"/api-reference/latest/bulk-operations/get-bulk-operation"},{"openapi":"get /bulk-operations/{id}/jobs","title":"List Bulk Operation Jobs","href":"/api-reference/latest/bulk-operations/list-bulk-operation-jobs"}]}]}]}]},{"tab":"Webhook Reference","pages":[{"title":"Webhook Reference","href":"/webhook-reference/getting-started"}]}]}]},"basePath":"","title":"Update Product Variant - Loop Returns Documentation","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}