Translated content for this product, 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).
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Loop Returns Documentation","colors":{"primary":"#0672FF","light":"#FFFCF7","dark":"#000000"},"logo":{"light":"https://mintcdn.com/loopreturns/mWP1nZGNp75FiB-l/logo/loop-logo-lapis-charcoal.svg?fit=max\u0026auto=format\u0026n=mWP1nZGNp75FiB-l\u0026q=85\u0026s=5113cc3f8f2d70a65c2c774e471a13c4","dark":"https://mintcdn.com/loopreturns/mWP1nZGNp75FiB-l/logo/loop-logo-lapis-newsprint.svg?fit=max\u0026auto=format\u0026n=mWP1nZGNp75FiB-l\u0026q=85\u0026s=c2197689146b468c5df1b8581f091743"},"favicon":"https://mintcdn.com/loopreturns/mWP1nZGNp75FiB-l/favicon.svg?fit=max\u0026auto=format\u0026n=mWP1nZGNp75FiB-l\u0026q=85\u0026s=93b43e224efe823b43c6d1b9c45799f9","navbar":{"links":[{"href":"https://help.loopreturns.com","label":"Support"}],"primary":{"type":"button","label":"Request Demo","href":"https://www.loopreturns.com/book-a-demo-today/"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/loop-returns","instagram":"https://www.instagram.com/loopreturns"}},"fonts":{"heading":{"family":"ABC Ginto","weight":900,"source":"fonts/ABCGinto-Black.woff2","format":"woff2"},"body":{"family":"Matter","weight":400,"source":"fonts/Matter-Regular.woff2","format":"woff2"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"System Status","icon":"radar","href":"https://status.loopreturns.com"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"loopreturns","hasAudioNarration":false,"actualSubdomain":"loopreturns","customDomains":["docs.loopreturns.com"],"gitSource":{"type":"gitlab","owner":"loopreturns/documentation","repo":"public-api-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"projectId":67355043,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae4ca2de9bd8b42e55fc8cc","collectionId":"07592d87-410d-45be-9292-bab2557b7a91","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae4ca2de9bd8b42e55fc8cc"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae4ca2de9bd8b42e55fc8cc","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"API Reference","count":173},{"language":"default","tag":"APIs","count":165},{"language":"default","tag":"Commerce Data","count":68},{"language":"default","tag":"Return Create (HAL-Forms)","count":30},{"language":"default","tag":"Guides","count":30},{"language":"default","tag":"Return Create","count":22},{"language":"default","tag":"Products","count":17},{"language":"default","tag":"Webhook Reference","count":13},{"language":"default","tag":"Collections","count":12},{"language":"default","tag":"Orders","count":11}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/latest/products/upsert-product","slug":"/api-reference/latest/products/upsert-product","pageMetadata":{"openapi":"put /products","title":"Upsert Product","description":"Upsert a product, identified using the product's `external_id`.","href":"/api-reference/latest/products/upsert-product"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Upsert a product, identified using the product’s \", _jsx(_components.code, {\n children: \"external_id\"\n }), \".\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"put /products","title":"Upsert Product","description":"Upsert a product, identified using the product's `external_id`.","href":"/api-reference/latest/products/upsert-product"}}},"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":"Upsert Product","description":"Upsert a product, identified using the product's `external_id`.","operationId":"upsertProduct","tags":["Products"],"requestBody":"ee83c01e-1075-4694-9085-7f2dcef76296","responses":{"200":"ac22c7dd-9a32-4d85-a498-459a00d6714c","401":"36d9a1f0-cc29-4076-8833-4c519070e114"},"security":["157ac403-e38a-4a83-b278-a2acc42718ec"],"method":"put","type":"path","servers":["7d941531-0074-469e-a2b6-94971d04b41c","a9fa2de8-dff4-49d3-a6e5-e3046fcae1bc","7c167765-8024-46e9-b0e8-3738052e7ce0"],"path":"/products","baseUrlOptions":["https://api.loopreturns.com/api/2026-10","https://api.loopreturns.com/api/2026-07","https://api.loopreturns.com/api/unstable"],"title":"Upsert Product","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"UpsertProductRequest","type":"object","properties":{"name":{"type":"string","maxLength":255,"description":"The name of the product.","examples":["Classic Brown Dress Shoes"],"isRequired":true,"uniqueKey":"name","typeLabel":"string"},"external_id":{"type":"string","maxLength":100,"examples":["564400c7-7a6b-4f29-b6a5-7bb580b2992c"],"description":"The identifier used by an external source to identify the product.","isRequired":true,"uniqueKey":"external_id","typeLabel":"string"},"sales_channel":{"type":"string","maxLength":255,"description":"If a channel with this name is not already associated with the shop, it will be used to create a new channel.","isRequired":true,"uniqueKey":"sales_channel","typeLabel":"string"},"sku":{"oneOf":[{"type":"string","examples":["SHOES-US44-M-Brwn"],"maxLength":255,"description":"The SKU of the product.","uniqueKey":"sku.oneOf.0","typeLabel":"string"},{"type":"null","examples":["SHOES-US44-M-Brwn"],"maxLength":255,"description":"The SKU of the product.","uniqueKey":"sku.oneOf.1","typeLabel":"null"}],"uniqueKey":"sku","typeLabel":"string | null"},"weight_grams":{"oneOf":[{"type":"integer","description":"The weight of the product in grams.","examples":[440],"uniqueKey":"weight_grams.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The weight of the product 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.","examples":[712345000019],"uniqueKey":"barcode.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"The barcode of the product.","examples":[712345000019],"uniqueKey":"barcode.oneOf.1","typeLabel":"null"}],"uniqueKey":"barcode","typeLabel":"string | null"},"description":{"oneOf":[{"maxLength":65000,"type":"string","description":"The description of the product.","uniqueKey":"description.oneOf.0","typeLabel":"string"},{"maxLength":65000,"type":"null","description":"The description of the product.","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"type":{"oneOf":[{"type":"string","maxLength":255,"examples":["shoes"],"description":"The \"type\" of the product. This is a single value used to classify and group similar products.","uniqueKey":"type.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"examples":["shoes"],"description":"The \"type\" of the product. This is a single value used to classify and group similar products.","uniqueKey":"type.oneOf.1","typeLabel":"null"}],"uniqueKey":"type","typeLabel":"string | null"},"vendor":{"oneOf":[{"type":"string","maxLength":255,"examples":["Internal"],"description":"The manufacturer or seller of the product.","uniqueKey":"vendor.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"examples":["Internal"],"description":"The manufacturer or seller of the product.","uniqueKey":"vendor.oneOf.1","typeLabel":"null"}],"uniqueKey":"vendor","typeLabel":"string | null"},"price":{"oneOf":[{"type":"object","description":"The price of the product in minor units, such as cents, with its corresponding currency.","required":["amount","currency_code"],"example":10000,"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 in minor units, such as cents, with its corresponding currency.","example":10000,"uniqueKey":"price.oneOf.1","typeLabel":"null"}],"uniqueKey":"price","typeLabel":"object | null"},"created_at":{"oneOf":[{"type":"string","format":"date-time","examples":["2023-04-25T13:25:00-05:00"],"description":"The date and time at which the product was created.","uniqueKey":"created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","examples":["2023-04-25T13:25:00-05:00"],"description":"The date and time at which the product was created.","uniqueKey":"created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"created_at","typeLabel":"string\u003cdate-time> | null"},"updated_at":{"oneOf":[{"type":"string","examples":["2023-04-25T13:45:00-05:00"],"format":"date-time","description":"The date and time at which the product was updated. The value must be equal to or greater than `created_at`.","uniqueKey":"updated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","examples":["2023-04-25T13:45:00-05:00"],"format":"date-time","description":"The date and time at which the product was updated. The value must be equal to or greater than `created_at`.","uniqueKey":"updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time> | null"},"options":{"oneOf":[{"type":"array","items":{"title":"ProductOption","type":"object","properties":{"position":{"type":"integer","format":"int32","examples":[1],"isRequired":true,"uniqueKey":"options.oneOf.0.items.[INDEX].position","typeLabel":"integer\u003cint32>"},"values":{"type":"array","items":{"type":"string","examples":["red","green","blue"],"uniqueKey":"options.oneOf.0.items.[INDEX].values.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"options.oneOf.0.items.[INDEX].values","typeLabel":"string[]"},"name":{"type":"string","examples":["Colors"],"isRequired":true,"uniqueKey":"options.oneOf.0.items.[INDEX].name","typeLabel":"string"}},"required":["position","values","name"],"uniqueKey":"options.oneOf.0.items.[INDEX]","typeLabel":"ProductOption · object"},"description":"An array of optional features or characteristics of the product that can be selected by the customer.","uniqueKey":"options.oneOf.0","typeLabel":"ProductOption · object[]"},{"type":"null","items":{"title":"ProductOption","type":"object","properties":{"position":{"type":"integer","format":"int32","examples":[1]},"values":{"type":"array","items":{"type":"string","examples":["red","green","blue"]}},"name":{"type":"string","examples":["Colors"]}},"required":["position","values","name"]},"description":"An array of optional features or characteristics of the product that can be selected by the customer.","uniqueKey":"options.oneOf.1","typeLabel":"null"}],"uniqueKey":"options","typeLabel":"ProductOption · 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"},"tags":{"oneOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":255,"examples":["shoes"],"uniqueKey":"tags.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"An array of tags added to the product.","uniqueKey":"tags.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string","minLength":1,"maxLength":255,"examples":["shoes"]},"description":"An array of tags added to the product.","uniqueKey":"tags.oneOf.1","typeLabel":"null"}],"uniqueKey":"tags","typeLabel":"string[] | null"},"source":{"oneOf":[{"type":"string","maxLength":255,"examples":["Shopify"],"description":"The ecommerce platform from which the product is available.","uniqueKey":"source.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"examples":["Shopify"],"description":"The ecommerce platform from which the product is available.","uniqueKey":"source.oneOf.1","typeLabel":"null"}],"uniqueKey":"source","typeLabel":"string | null"},"is_gift_card":{"oneOf":[{"type":"boolean","description":"Whether the product is a gift card.","examples":[false],"uniqueKey":"is_gift_card.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether the product is a gift card.","examples":[false],"uniqueKey":"is_gift_card.oneOf.1","typeLabel":"null"}],"uniqueKey":"is_gift_card","typeLabel":"boolean | null"},"locale_data":{"oneOf":[{"type":"array","description":"Translated content for this product, 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).","items":{"title":"ProductLocaleData","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.","examples":["Chaussures Habillées Marron Classiques"],"isRequired":true,"uniqueKey":"locale_data.oneOf.0.items.[INDEX].name","typeLabel":"string"},"description":{"oneOf":[{"type":"string","maxLength":65000,"description":"The translated description of the product. Optional, matching the top-level `description` field on the product itself.","uniqueKey":"locale_data.oneOf.0.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":65000,"description":"The translated description of the product. Optional, matching the top-level `description` field on the product itself.","uniqueKey":"locale_data.oneOf.0.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"locale_data.oneOf.0.items.[INDEX].description","typeLabel":"string | null"},"options":{"oneOf":[{"type":"array","description":"Translated overrides for the product's options. Requires this request's own `options` array to also be present — if this array is non-empty and the request's `options` is omitted, the request is rejected. Each entry's `position` must match a position present in this request's `options` array, and each entry must be fully populated — a partial override is rejected.","items":{"title":"ProductLocaleDataOption","type":"object","properties":{"position":{"type":"integer","format":"int32","description":"Must match a `position` present in this request's `options` array.","examples":[1],"isRequired":true,"uniqueKey":"locale_data.oneOf.0.items.[INDEX].options.oneOf.0.items.[INDEX].position","typeLabel":"integer\u003cint32>"},"name":{"type":"string","maxLength":255,"description":"The translated name for this option.","examples":["Couleur"],"isRequired":true,"uniqueKey":"locale_data.oneOf.0.items.[INDEX].options.oneOf.0.items.[INDEX].name","typeLabel":"string"},"values":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"locale_data.oneOf.0.items.[INDEX].options.oneOf.0.items.[INDEX].values.additionalProperties","typeLabel":"string"},"description":"A translated value for every value in the matched base option's `values` array — no missing values, no extra ones.","examples":[{"red":"rouge","green":"vert","blue":"bleu"}],"isRequired":true,"uniqueKey":"locale_data.oneOf.0.items.[INDEX].options.oneOf.0.items.[INDEX].values","typeLabel":"object"}},"required":["position","name","values"],"uniqueKey":"locale_data.oneOf.0.items.[INDEX].options.oneOf.0.items.[INDEX]","typeLabel":"ProductLocaleDataOption · object"},"uniqueKey":"locale_data.oneOf.0.items.[INDEX].options.oneOf.0","typeLabel":"ProductLocaleDataOption · object[]"},{"type":"null","description":"Translated overrides for the product's options. Requires this request's own `options` array to also be present — if this array is non-empty and the request's `options` is omitted, the request is rejected. Each entry's `position` must match a position present in this request's `options` array, and each entry must be fully populated — a partial override is rejected.","items":{"title":"ProductLocaleDataOption","type":"object","properties":{"position":{"type":"integer","format":"int32","description":"Must match a `position` present in this request's `options` array.","examples":[1]},"name":{"type":"string","maxLength":255,"description":"The translated name for this option.","examples":["Couleur"]},"values":{"type":"object","additionalProperties":{"type":"string"},"description":"A translated value for every value in the matched base option's `values` array — no missing values, no extra ones.","examples":[{"red":"rouge","green":"vert","blue":"bleu"}]}},"required":["position","name","values"]},"uniqueKey":"locale_data.oneOf.0.items.[INDEX].options.oneOf.1","typeLabel":"null"}],"uniqueKey":"locale_data.oneOf.0.items.[INDEX].options","typeLabel":"ProductLocaleDataOption · object[] | null"}},"required":["locale","name"],"uniqueKey":"locale_data.oneOf.0.items.[INDEX]","typeLabel":"ProductLocaleData · object"},"uniqueKey":"locale_data.oneOf.0","typeLabel":"ProductLocaleData · object[]"},{"type":"null","description":"Translated content for this product, 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).","items":{"title":"ProductLocaleData","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.","examples":["Chaussures Habillées Marron Classiques"]},"description":{"oneOf":[{"type":"string","maxLength":65000,"description":"The translated description of the product. Optional, matching the top-level `description` field on the product itself."},{"type":"null","maxLength":65000,"description":"The translated description of the product. Optional, matching the top-level `description` field on the product itself."}]},"options":{"oneOf":[{"type":"array","description":"Translated overrides for the product's options. Requires this request's own `options` array to also be present — if this array is non-empty and the request's `options` is omitted, the request is rejected. Each entry's `position` must match a position present in this request's `options` array, and each entry must be fully populated — a partial override is rejected.","items":{"title":"ProductLocaleDataOption","type":"object","properties":{"position":{"type":"integer","format":"int32","description":"Must match a `position` present in this request's `options` array.","examples":[1]},"name":{"type":"string","maxLength":255,"description":"The translated name for this option.","examples":["Couleur"]},"values":{"type":"object","additionalProperties":{"type":"string"},"description":"A translated value for every value in the matched base option's `values` array — no missing values, no extra ones.","examples":[{"red":"rouge","green":"vert","blue":"bleu"}]}},"required":["position","name","values"]}},{"type":"null","description":"Translated overrides for the product's options. Requires this request's own `options` array to also be present — if this array is non-empty and the request's `options` is omitted, the request is rejected. Each entry's `position` must match a position present in this request's `options` array, and each entry must be fully populated — a partial override is rejected.","items":{"title":"ProductLocaleDataOption","type":"object","properties":{"position":{"type":"integer","format":"int32","description":"Must match a `position` present in this request's `options` array.","examples":[1]},"name":{"type":"string","maxLength":255,"description":"The translated name for this option.","examples":["Couleur"]},"values":{"type":"object","additionalProperties":{"type":"string"},"description":"A translated value for every value in the matched base option's `values` array — no missing values, no extra ones.","examples":[{"red":"rouge","green":"vert","blue":"bleu"}]}},"required":["position","name","values"]}}]}},"required":["locale","name"]},"uniqueKey":"locale_data.oneOf.1","typeLabel":"null"}],"uniqueKey":"locale_data","typeLabel":"ProductLocaleData · object[] | null"}},"required":["external_id","name","sales_channel"],"uniqueKey":"","typeLabel":"UpsertProductRequest · object"},"examples":{"Example":{"title":"Example","value":{"name":"Classic Brown Dress Shoes","external_id":"564400c7-7a6b-4f29-b6a5-7bb580b2992c","sales_channel":"\u003cstring>","sku":"SHOES-US44-M-Brwn","weight_grams":440,"barcode":712345000019,"description":"\u003cstring>","type":"shoes","vendor":"Internal","price":10000,"created_at":"2023-04-25T13:25:00-05:00","updated_at":"2023-04-25T13:45:00-05:00","options":[{"position":1,"values":["red"],"name":"Colors"}],"images":["https://example.com/example.jpg"],"tags":["shoes"],"source":"Shopify","is_gift_card":false,"locale_data":[{"locale":"fr-CA","name":"Chaussures Habillées Marron Classiques","description":"\u003cstring>","options":[{"position":1,"name":"Couleur","values":{"red":"rouge","green":"vert","blue":"bleu"}}]}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"ac22c7dd-9a32-4d85-a498-459a00d6714c":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"product":{"title":"ProductResponse","type":"object","properties":{"id":{"type":"integer","format":"int64","minimum":1,"examples":[810772],"readOnly":true,"description":"The unique integer identifier for the product, created by Loop.","uniqueKey":"product.id","typeLabel":"integer\u003cint64>"},"external_id":{"oneOf":[{"type":"string","examples":["564400c7-7a6b-4f29-b6a5-7bb580b2992c"],"description":"The identifier used by an external source to identify the product.","uniqueKey":"product.external_id.oneOf.0","typeLabel":"string"},{"type":"null","examples":["564400c7-7a6b-4f29-b6a5-7bb580b2992c"],"description":"The identifier used by an external source to identify the product.","uniqueKey":"product.external_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.external_id","typeLabel":"string | null"},"sales_channel":{"type":"string","description":"The name of the channel.","uniqueKey":"product.sales_channel","typeLabel":"string"},"sku":{"oneOf":[{"type":"string","examples":["SHOES-US44-M-Brwn"],"description":"The SKU of the product.","uniqueKey":"product.sku.oneOf.0","typeLabel":"string"},{"type":"null","examples":["SHOES-US44-M-Brwn"],"description":"The SKU of the product.","uniqueKey":"product.sku.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.sku","typeLabel":"string | null"},"name":{"type":"string","description":"The name of the product.","examples":["Classic Brown Dress Shoes"],"uniqueKey":"product.name","typeLabel":"string"},"weight_grams":{"oneOf":[{"type":"integer","format":"int32","examples":[440],"description":"The weight of the product in grams.","uniqueKey":"product.weight_grams.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","examples":[440],"description":"The weight of the product in grams.","uniqueKey":"product.weight_grams.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.weight_grams","typeLabel":"integer\u003cint32> | null"},"barcode":{"oneOf":[{"type":"string","examples":[712345000019],"description":"The barcode of the product.","uniqueKey":"product.barcode.oneOf.0","typeLabel":"string"},{"type":"null","examples":[712345000019],"description":"The barcode of the product.","uniqueKey":"product.barcode.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.barcode","typeLabel":"string | null"},"description":{"oneOf":[{"maxLength":65000,"type":"string","description":"The description of the product.","uniqueKey":"product.description.oneOf.0","typeLabel":"string"},{"maxLength":65000,"type":"null","description":"The description of the product.","uniqueKey":"product.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.description","typeLabel":"string | null"},"type":{"oneOf":[{"type":"string","examples":["shoes"],"description":"The \"type\" of the product. This is a single value used to classify and group similar products.","uniqueKey":"product.type.oneOf.0","typeLabel":"string"},{"type":"null","examples":["shoes"],"description":"The \"type\" of the product. This is a single value used to classify and group similar products.","uniqueKey":"product.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.type","typeLabel":"string | null"},"vendor":{"oneOf":[{"type":"string","examples":["Internal"],"description":"The manufacturer or seller of the product.","uniqueKey":"product.vendor.oneOf.0","typeLabel":"string"},{"type":"null","examples":["Internal"],"description":"The manufacturer or seller of the product.","uniqueKey":"product.vendor.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.vendor","typeLabel":"string | null"},"price":{"oneOf":[{"type":"object","description":"The price of the product 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.price.oneOf.0.amount","typeLabel":"integer\u003cint32>"},"currency_code":{"type":"string","default":"USD","examples":["EUR"],"isRequired":true,"uniqueKey":"product.price.oneOf.0.currency_code","typeLabel":"string"}},"uniqueKey":"product.price.oneOf.0","typeLabel":"object"},{"type":"null","description":"The price of the product in minor units, such as cents, with its corresponding currency.","uniqueKey":"product.price.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.price","typeLabel":"object | null"},"created_at":{"oneOf":[{"type":"string","format":"date-time","examples":["2023-04-25T13:25:00-05:00"],"description":"The date and time at which the product was created.","uniqueKey":"product.created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","examples":["2023-04-25T13:25:00-05:00"],"description":"The date and time at which the product was created.","uniqueKey":"product.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.created_at","typeLabel":"string\u003cdate-time> | null"},"updated_at":{"oneOf":[{"type":"string","examples":["2023-04-25T13:45:00-05:00"],"format":"date-time","description":"The date and time at which the product was updated. The value must be equal to or greater than `created_at`.","uniqueKey":"product.updated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","examples":["2023-04-25T13:45:00-05:00"],"format":"date-time","description":"The date and time at which the product was updated. The value must be equal to or greater than `created_at`.","uniqueKey":"product.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.updated_at","typeLabel":"string\u003cdate-time> | null"},"collections":{"oneOf":[{"type":"array","items":{"title":"Collection","type":"object","properties":{"id":{"type":"integer","format":"int64","examples":[891009],"minimum":1,"readOnly":true,"uniqueKey":"product.collections.oneOf.0.items.[INDEX].id","typeLabel":"integer\u003cint64>"},"external_id":{"oneOf":[{"type":"string","examples":["62291d16-9b61-4fbb-b868-21c2d32dc155"],"uniqueKey":"product.collections.oneOf.0.items.[INDEX].external_id.oneOf.0","typeLabel":"string"},{"type":"null","examples":["62291d16-9b61-4fbb-b868-21c2d32dc155"],"uniqueKey":"product.collections.oneOf.0.items.[INDEX].external_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.collections.oneOf.0.items.[INDEX].external_id","typeLabel":"string | null"},"name":{"type":"string","uniqueKey":"product.collections.oneOf.0.items.[INDEX].name","typeLabel":"string"}},"uniqueKey":"product.collections.oneOf.0.items.[INDEX]","typeLabel":"Collection · object"},"description":"A grouping of products which can be used to organize a merchant's shop.","uniqueKey":"product.collections.oneOf.0","typeLabel":"Collection · object[]"},{"type":"null","items":{"title":"Collection","type":"object","properties":{"id":{"type":"integer","format":"int64","examples":[891009],"minimum":1,"readOnly":true},"external_id":{"oneOf":[{"type":"string","examples":["62291d16-9b61-4fbb-b868-21c2d32dc155"]},{"type":"null","examples":["62291d16-9b61-4fbb-b868-21c2d32dc155"]}]},"name":{"type":"string"}}},"description":"A grouping of products which can be used to organize a merchant's shop.","uniqueKey":"product.collections.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.collections","typeLabel":"Collection · object[] | null"},"options":{"oneOf":[{"type":"array","items":{"title":"ProductOption","type":"object","properties":{"position":{"type":"integer","format":"int32","examples":[1],"isRequired":true,"uniqueKey":"product.options.oneOf.0.items.[INDEX].position","typeLabel":"integer\u003cint32>"},"values":{"type":"array","items":{"type":"string","examples":["red","green","blue"],"uniqueKey":"product.options.oneOf.0.items.[INDEX].values.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"product.options.oneOf.0.items.[INDEX].values","typeLabel":"string[]"},"name":{"type":"string","examples":["Colors"],"isRequired":true,"uniqueKey":"product.options.oneOf.0.items.[INDEX].name","typeLabel":"string"}},"required":["position","values","name"],"uniqueKey":"product.options.oneOf.0.items.[INDEX]","typeLabel":"ProductOption · object"},"description":"An array of optional features or characteristics of the product that can be selected by the customer.","uniqueKey":"product.options.oneOf.0","typeLabel":"ProductOption · object[]"},{"type":"null","items":{"title":"ProductOption","type":"object","properties":{"position":{"type":"integer","format":"int32","examples":[1]},"values":{"type":"array","items":{"type":"string","examples":["red","green","blue"]}},"name":{"type":"string","examples":["Colors"]}},"required":["position","values","name"]},"description":"An array of optional features or characteristics of the product that can be selected by the customer.","uniqueKey":"product.options.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.options","typeLabel":"ProductOption · object[] | null"},"images":{"oneOf":[{"type":"array","items":{"type":"string","format":"uri","examples":["https://example.com/example.jpg"],"uniqueKey":"product.images.oneOf.0.items.[INDEX]","typeLabel":"string\u003curi>"},"description":"An array of links to images of the product.","uniqueKey":"product.images.oneOf.0","typeLabel":"string\u003curi>[]"},{"type":"null","items":{"type":"string","format":"uri","examples":["https://example.com/example.jpg"]},"description":"An array of links to images of the product.","uniqueKey":"product.images.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.images","typeLabel":"string\u003curi>[] | null"},"tags":{"oneOf":[{"type":"array","items":{"type":"string","examples":["shoes"],"uniqueKey":"product.tags.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"An array of tags used to classify and group products.","uniqueKey":"product.tags.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string","examples":["shoes"]},"description":"An array of tags used to classify and group products.","uniqueKey":"product.tags.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.tags","typeLabel":"string[] | null"},"source":{"oneOf":[{"type":"string","examples":["Shopify"],"description":"The ecommerce platform from which the product is available.","uniqueKey":"product.source.oneOf.0","typeLabel":"string"},{"type":"null","examples":["Shopify"],"description":"The ecommerce platform from which the product is available.","uniqueKey":"product.source.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.source","typeLabel":"string | null"},"default_variant_id":{"oneOf":[{"type":"integer","format":"int64","examples":[810773],"description":"The global identifier (created by Loop) of the product's default variant. Present only when the product has no explicit variants; null otherwise.","uniqueKey":"product.default_variant_id.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","examples":[810773],"description":"The global identifier (created by Loop) of the product's default variant. Present only when the product has no explicit variants; null otherwise.","uniqueKey":"product.default_variant_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.default_variant_id","typeLabel":"integer\u003cint64> | null"},"locale_data":{"type":"array","description":"Every stored per-locale translation of the product, in the same shape the create and upsert `locale_data` request field accepts (see `ProductLocaleData`). Empty when the product has no translations. When resubmitting these entries on a write, follow the request-side `locale_data` rules — in particular each locale's `options` overrides must still match the request's own `options` and translate every value, so refresh them whenever you change a product's option values.","items":{"title":"ProductLocaleDataResponse","type":"object","properties":{"locale":{"type":"string","maxLength":5,"description":"The locale this translation applies to.","examples":["fr-CA"],"isRequired":true,"uniqueKey":"product.locale_data.items.[INDEX].locale","typeLabel":"string"},"name":{"type":"string","description":"The translated name of the product.","examples":["Arizona Birko-Flor Nubuck"],"isRequired":true,"uniqueKey":"product.locale_data.items.[INDEX].name","typeLabel":"string"},"description":{"oneOf":[{"type":"string","description":"The translated description of the product.","uniqueKey":"product.locale_data.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","description":"The translated description of the product.","uniqueKey":"product.locale_data.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.locale_data.items.[INDEX].description","typeLabel":"string | null"},"options":{"oneOf":[{"type":"array","description":"Translated overrides for the product's options — one entry per base option that has a translation for this locale.","items":{"title":"ProductLocaleDataOptionResponse","type":"object","properties":{"position":{"type":"integer","format":"int32","description":"The position of the base option this translation applies to.","examples":[1],"isRequired":true,"uniqueKey":"product.locale_data.items.[INDEX].options.oneOf.0.items.[INDEX].position","typeLabel":"integer\u003cint32>"},"name":{"type":"string","description":"The translated name of the option.","examples":["Couleur"],"isRequired":true,"uniqueKey":"product.locale_data.items.[INDEX].options.oneOf.0.items.[INDEX].name","typeLabel":"string"},"values":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"product.locale_data.items.[INDEX].options.oneOf.0.items.[INDEX].values.additionalProperties","typeLabel":"string"},"description":"The translated value for each of the base option's values.","examples":[{"Stone":"Pierre"}],"isRequired":true,"uniqueKey":"product.locale_data.items.[INDEX].options.oneOf.0.items.[INDEX].values","typeLabel":"object"}},"required":["position","name","values"],"uniqueKey":"product.locale_data.items.[INDEX].options.oneOf.0.items.[INDEX]","typeLabel":"ProductLocaleDataOptionResponse · object"},"uniqueKey":"product.locale_data.items.[INDEX].options.oneOf.0","typeLabel":"ProductLocaleDataOptionResponse · object[]"},{"type":"null","description":"Translated overrides for the product's options — one entry per base option that has a translation for this locale.","items":{"title":"ProductLocaleDataOptionResponse","type":"object","properties":{"position":{"type":"integer","format":"int32","description":"The position of the base option this translation applies to.","examples":[1]},"name":{"type":"string","description":"The translated name of the option.","examples":["Couleur"]},"values":{"type":"object","additionalProperties":{"type":"string"},"description":"The translated value for each of the base option's values.","examples":[{"Stone":"Pierre"}]}},"required":["position","name","values"]},"uniqueKey":"product.locale_data.items.[INDEX].options.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.locale_data.items.[INDEX].options","typeLabel":"ProductLocaleDataOptionResponse · object[] | null"}},"required":["locale","name"],"uniqueKey":"product.locale_data.items.[INDEX]","typeLabel":"ProductLocaleDataResponse · object"},"uniqueKey":"product.locale_data","typeLabel":"ProductLocaleDataResponse · object[]"}},"uniqueKey":"product","typeLabel":"ProductResponse · object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"product":{"id":810772,"external_id":"564400c7-7a6b-4f29-b6a5-7bb580b2992c","sales_channel":"\u003cstring>","sku":"SHOES-US44-M-Brwn","name":"Classic Brown Dress Shoes","weight_grams":440,"barcode":712345000019,"description":"\u003cstring>","type":"shoes","vendor":"Internal","price":{"amount":50000,"currency_code":"USD"},"created_at":"2023-04-25T13:25:00-05:00","updated_at":"2023-04-25T13:45:00-05:00","collections":[{"id":891009,"external_id":"62291d16-9b61-4fbb-b868-21c2d32dc155","name":"\u003cstring>"}],"options":[{"position":1,"values":["red"],"name":"Colors"}],"images":["https://example.com/example.jpg"],"tags":["shoes"],"source":"Shopify","default_variant_id":810773,"locale_data":[{"locale":"fr-CA","name":"Arizona Birko-Flor Nubuck","description":"\u003cstring>","options":[{"position":1,"name":"Couleur","values":{"Stone":"Pierre"}}]}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"36d9a1f0-cc29-4076-8833-4c519070e114":{"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."],"isRequired":true,"uniqueKey":"errors","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":"Unauthorized."}}},"exampleType":"generated"}},"headers":{"X-Loop-Request-ID":{"schema":{"type":"string","examples":["5a748e7c-5fcc-4fb0-a777-6a4d28e60d4c"],"format":"uuid"},"description":"UUID to aid in debugging API issues"}},"exampleType":"generated"}},"security":{"157ac403-e38a-4a83-b278-a2acc42718ec":{"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":"Upsert Product - Loop Returns Documentation","navMaps":{"firstHrefInVersion":{"2026-07":{"href":"/api-reference/latest/products/upsert-product","matchLevel":0},"2026-10":{"href":"/api-reference/latest/products/upsert-product","matchLevel":0},"unstable":{"href":"/api-reference/latest/products/upsert-product","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2025-08-11T14:42:17.583Z","originalFileLocation":"api-reference/latest/products/upsert-product.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=\"Upsert a product, identified using the product\u0026#x27;s external_id.\">\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=\"Upsert Product - Loop Returns Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Upsert a product, identified using the product\u0026#x27;s external_id.\">\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/upsert-product\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://loopreturns.mintlify.app/_mintlify/api/og/v2?division=Products\u0026amp;title=Upsert+Product\u0026amp;description=Upsert+a+product%2C+identified+using+the+product%27s+%60external_id%60.\u0026amp;theme=5ccacdea69e246fe33e6ab29\u0026amp;signature=4b72d6d2707e93aa8210479ca21058d65206d163aa68386ab324f7524e6a83c4\">\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=\"Upsert Product - Loop Returns Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Upsert a product, identified using the product\u0026#x27;s external_id.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://loopreturns.mintlify.app/_mintlify/api/og/v2?division=Products\u0026amp;title=Upsert+Product\u0026amp;description=Upsert+a+product%2C+identified+using+the+product%27s+%60external_id%60.\u0026amp;theme=5ccacdea69e246fe33e6ab29\u0026amp;signature=4b72d6d2707e93aa8210479ca21058d65206d163aa68386ab324f7524e6a83c4\">\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/upsert-product\">\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/upsert-product.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/upsert-product#webpage\",\"url\":\"https://docs.loopreturns.com/api-reference/latest/products/upsert-product\",\"name\":\"Upsert Product\",\"description\":\"Upsert a product, identified using the product's external_id.\",\"dateModified\":\"2025-08-11T14:42:17.583Z\",\"isPartOf\":{\"@id\":\"https://docs.loopreturns.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.loopreturns.com/api-reference/latest/products/upsert-product#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.loopreturns.com/api-reference/latest/products/upsert-product#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\":\"Upsert Product\",\"item\":\"https://docs.loopreturns.com/api-reference/latest/products/upsert-product\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.loopreturns.com/api-reference/latest/products/upsert-product#apireference\",\"headline\":\"Upsert Product\",\"name\":\"Upsert Product\",\"description\":\"Upsert a product, identified using the product's external_id.\",\"url\":\"https://docs.loopreturns.com/api-reference/latest/products/upsert-product\",\"mainEntityOfPage\":{\"@id\":\"https://docs.loopreturns.com/api-reference/latest/products/upsert-product#webpage\"},\"dateModified\":\"2025-08-11T14:42:17.583Z\",\"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","description":"Create a new 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","description":"Get the details about a single product.","href":"/api-reference/latest/products/get-product"},{"openapi":"get /products/external/{externalId}","title":"Get Product by External ID","href":"/api-reference/latest/products/get-product-by-external-id"},{"openapi":"put /products/{id}","title":"Update Product","href":"/api-reference/latest/products/update-product"},{"openapi":"delete /products/{id}","title":"Delete Product","href":"/api-reference/latest/products/delete-product"},{"openapi":"delete /products/external/{externalId}","title":"Delete Product by External ID","href":"/api-reference/latest/products/delete-product-by-external-id"},{"openapi":"get /products/{productId}/product-variants","title":"List Product Variants","href":"/api-reference/latest/products/list-product-variants"},{"openapi":"post /products/{productId}/product-variants","title":"Create Product Variant","href":"/api-reference/latest/products/create-product-variant"},{"openapi":"put /products/{productId}/product-variants","title":"Upsert Product Variant","href":"/api-reference/latest/products/upsert-product-variant"},{"openapi":"put /products/external/{productExternalId}/product-variants","title":"Upsert Product Variant by Product External ID","href":"/api-reference/latest/products/upsert-product-variant-by-product-external-id"},{"openapi":"get /products/{productId}/product-variants/{id}","title":"Get Product Variant","href":"/api-reference/latest/products/get-product-variant"},{"openapi":"get /products/external/{productExternalId}/product-variants/{externalId}","title":"Get Product Variant by External ID","href":"/api-reference/latest/products/get-product-variant-by-external-id"},{"openapi":"patch /products/{productId}/product-variants/{id}","title":"Update Product Variant","href":"/api-reference/latest/products/update-product-variant"},{"openapi":"delete /products/{productId}/product-variants/{id}","title":"Delete Product Variant","href":"/api-reference/latest/products/delete-product-variant"},{"openapi":"delete /products/external/{productExternalId}/product-variants/{externalId}","title":"Delete Product Variant by External ID","href":"/api-reference/latest/products/delete-product-variant-by-external-id"}]},{"group":"Orders","pages":[{"openapi":"get /orders","title":"List Orders","href":"/api-reference/latest/orders/list-orders"},{"openapi":"openapi/orders-api-2026-07.yaml post /orders","title":"Create Order","href":"/api-reference/2026-07/orders/create-order"},{"openapi":"openapi/orders-api-2026-07.yaml put /orders","title":"Upsert Order","href":"/api-reference/2026-07/orders/upsert-order"},{"openapi":"get /orders/{id}","title":"Get Order","href":"/api-reference/latest/orders/get-order"},{"openapi":"get /orders/external/{externalId}","title":"Get Order by External ID","href":"/api-reference/latest/orders/get-order-by-external-id"},{"openapi":"openapi/orders-api-2026-07.yaml put /orders/{id}","title":"Update Order","href":"/api-reference/2026-07/orders/update-order"},{"openapi":"delete /orders/{id}","title":"Delete Order","href":"/api-reference/latest/orders/delete-order"},{"openapi":"delete /orders/external/{externalId}","title":"Delete Order by External ID","href":"/api-reference/latest/orders/delete-order-by-external-id"}]},{"group":"Customers","pages":[{"openapi":"get /customers","title":"List Customers","href":"/api-reference/latest/customers/list-customers"},{"openapi":"post /customers","title":"Create Customer","href":"/api-reference/latest/customers/create-customer"},{"openapi":"put /customers","title":"Upsert Customer","href":"/api-reference/latest/customers/upsert-customer"},{"openapi":"get /customers/{id}","title":"Get Customer","href":"/api-reference/latest/customers/get-customer"},{"openapi":"get /customers/external/{externalId}","title":"Get Customer by External ID","href":"/api-reference/latest/customers/get-customer-by-external-id"},{"openapi":"put /customers/{id}","title":"Update Customer","href":"/api-reference/latest/customers/update-customer"},{"openapi":"delete /customers/{id}","title":"Delete Customer","href":"/api-reference/latest/customers/delete-customer"},{"openapi":"delete /customers/external/{externalId}","title":"Delete Customer by External ID","href":"/api-reference/latest/customers/delete-customer-by-external-id"}]},{"group":"Locations","pages":[{"openapi":"get /locations","title":"List Locations","href":"/api-reference/latest/locations/list-locations"},{"openapi":"post /locations","title":"Create Location","href":"/api-reference/latest/locations/create-location"},{"openapi":"put /locations","title":"Upsert Location","href":"/api-reference/latest/locations/upsert-location"},{"openapi":"get /locations/{id}","title":"Get Location","href":"/api-reference/latest/locations/get-location"},{"openapi":"get /locations/external/{externalId}","title":"Get Location by External ID","href":"/api-reference/latest/locations/get-location-by-external-id"},{"openapi":"put /locations/{id}","title":"Update Location","href":"/api-reference/latest/locations/update-location"},{"openapi":"delete /locations/{id}","title":"Delete Location","href":"/api-reference/latest/locations/delete-location"},{"openapi":"delete /locations/external/{externalId}","title":"Delete Location by External ID","href":"/api-reference/latest/locations/delete-location-by-external-id"}]},{"group":"Inventories","pages":[{"openapi":"get /inventories","title":"List Inventories","href":"/api-reference/latest/inventories/list-inventories"},{"openapi":"post /inventories/{productVariantId}/{locationId}","title":"Upsert Inventory","href":"/api-reference/latest/inventories/create-inventory"},{"openapi":"put /inventories/{productVariantId}/{locationId}","title":"Upsert Inventory","href":"/api-reference/latest/inventories/upsert-inventory"},{"openapi":"put /inventories/external/{variantExternalId}/{locationExternalId}","title":"Upsert Inventory by External IDs","href":"/api-reference/latest/inventories/upsert-inventory-by-external-ids"},{"openapi":"get /inventories/{productVariantId}/{locationId}","title":"Get Inventory","href":"/api-reference/latest/inventories/get-inventory"},{"openapi":"get /inventories/external/{variantExternalId}/{locationExternalId}","title":"Get Inventory by External IDs","href":"/api-reference/latest/inventories/get-inventory-by-external-ids"},{"openapi":"delete /inventories/{productVariantId}/{locationId}","title":"Delete Inventory","href":"/api-reference/latest/inventories/delete-inventory"},{"openapi":"delete /inventories/external/{variantExternalId}/{locationExternalId}","title":"Delete Inventory by External IDs","href":"/api-reference/latest/inventories/delete-inventory-by-external-ids"}]},{"group":"Collections","pages":[{"openapi":"get /collections","title":"List Collections","href":"/api-reference/latest/collections/list-collections"},{"openapi":"post /collections","title":"Create Collection","href":"/api-reference/latest/collections/create-collection"},{"openapi":"put /collections","title":"Upsert Collection","href":"/api-reference/latest/collections/upsert-collection"},{"openapi":"get /collections/{id}","title":"Get Collection","href":"/api-reference/latest/collections/get-collection"},{"openapi":"get /collections/external/{externalId}","title":"Get Collection by External ID","href":"/api-reference/latest/collections/get-collection-by-external-id"},{"openapi":"put /collections/{id}","title":"Update Collection","href":"/api-reference/latest/collections/update-collection"},{"openapi":"delete /collections/{id}","title":"Delete Collection","href":"/api-reference/latest/collections/delete-collection"},{"openapi":"delete /collections/external/{externalId}","title":"Delete Collection by External ID","href":"/api-reference/latest/collections/delete-collection-by-external-id"},{"openapi":"post /collections/{id}/products/{productId}","title":"Add Product to Collection","href":"/api-reference/latest/collections/add-product-to-collection"},{"openapi":"delete /collections/{id}/products/{productId}","title":"Delete Product from Collection","href":"/api-reference/latest/collections/delete-product-from-collection"},{"openapi":"post /collections/external/{collectionExternalId}/products/external/{productExternalId}","title":"Add Product to Collection by External ID","href":"/api-reference/latest/collections/add-product-to-collection-by-external-id"},{"openapi":"delete /collections/external/{collectionExternalId}/products/external/{productExternalId}","title":"Delete Product from Collection by External ID","href":"/api-reference/latest/collections/delete-product-from-collection-by-external-id"}]},{"group":"Bulk Operations","pages":[{"openapi":"post /bulk-operations","title":"Create Bulk Operation","href":"/api-reference/latest/bulk-operations/create-bulk-operation"},{"openapi":"get /bulk-operations","title":"List Bulk Operations","href":"/api-reference/latest/bulk-operations/list-bulk-operations"},{"openapi":"get /bulk-operations/{id}","title":"Get Bulk Operation","href":"/api-reference/latest/bulk-operations/get-bulk-operation"},{"openapi":"get /bulk-operations/{id}/jobs","title":"List Bulk Operation Jobs","href":"/api-reference/latest/bulk-operations/list-bulk-operation-jobs"}]}]}]}]},{"tab":"Webhook Reference","pages":[{"title":"Webhook Reference","href":"/webhook-reference/getting-started"}]}]},{"version":"2026-10","default":true,"tabs":[{"tab":"Introduction","pages":[{"title":"Introduction","href":"/welcome"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/integration-guides/overview"}]},{"tab":"MCP Server","pages":[{"title":"MCP Server","href":"/mcp/overview"}]},{"tab":"API Reference","groups":[{"group":"Using the API","pages":[{"title":"Getting Started","icon":"play","href":"/api-reference/getting-started"},{"title":"Authentication","version":"2026-07","icon":"lock","href":"/api-reference/authentication"},{"title":"API Versioning","icon":"clock","href":"/api-reference/versioning"},{"title":"Rate limit","icon":"gauge","href":"/api-reference/rate-limit"},{"title":"Pagination","icon":"page","href":"/api-reference/pagination"},{"title":"Error codes","icon":"circle-exclamation","iconType":"regular","href":"/api-reference/error-codes"},{"title":"Postman Collection","icon":"bolt","href":"/api-reference/postman"}]},{"group":"APIs","pages":[{"group":"Return Actions","pages":[{"openapi":"post /warehouse/return/{id}/process","title":"Process Return","href":"/api-reference/latest/return-actions/process-return"},{"openapi":"post /warehouse/return/{id}/remove","title":"Remove Line Items","href":"/api-reference/latest/return-actions/remove-line-items"},{"openapi":"post /warehouse/return/{id}/cancel","title":"Cancel Return","href":"/api-reference/latest/return-actions/cancel-return"},{"openapi":"post /warehouse/return/{id}/flag","title":"Flag Return","href":"/api-reference/latest/return-actions/flag-return"},{"openapi":"post /warehouse/return/{id}/close","title":"Close Return","href":"/api-reference/latest/return-actions/close-return"},{"openapi":"get /warehouse/return/{id}/notes","title":"Get Return Notes","href":"/api-reference/latest/return-actions/get-return-notes"},{"openapi":"post /warehouse/return/{id}/note","title":"Create Return Note","href":"/api-reference/latest/return-actions/create-return-note"},{"openapi":"post /order/link","title":"Create Return Deep Link","href":"/api-reference/latest/return-actions/create-return-deep-link"},{"openapi":"post /order/qr","title":"Create Return Deep Link with QR Code","href":"/api-reference/latest/return-actions/create-return-deep-link-with-qr-code"}]},{"group":"Return Data","pages":[{"openapi":"get /warehouse/return/list","title":"Detailed Returns List","href":"/api-reference/latest/return-data/detailed-returns-list"},{"openapi":"get /warehouse/return/details","title":"Get Return Details","href":"/api-reference/latest/return-data/get-return-details"},{"openapi":"get /warehouse/reporting/asn","title":"Advanced Shipping Notice","href":"/api-reference/latest/return-data/advanced-shipping-notice"}]},{"group":"Programmatic Webhooks","pages":[{"openapi":"get /webhooks","title":"Get Webhooks","href":"/api-reference/latest/programmatic-webhooks/get-webhooks"},{"openapi":"post /webhooks","title":"Create Webhook","href":"/api-reference/latest/programmatic-webhooks/create-webhook"},{"openapi":"put /webhooks/{id}","title":"Update Webhook","href":"/api-reference/latest/programmatic-webhooks/update-webhook"},{"openapi":"delete /webhooks/{id}","title":"Delete Webhook","href":"/api-reference/latest/programmatic-webhooks/delete-webhook"}]},{"group":"Item Grading and Dispositioning","pages":[{"openapi":"post /dispositioning/grade","title":"Grade Items","href":"/api-reference/latest/item-grading-and-disposition/grade-items"},{"openapi":"post /dispositioning/assess","title":"Assess Dispositions","href":"/api-reference/latest/item-grading-and-disposition/assess-dispositions"}]},{"group":"Cart","pages":[{"openapi":"post /cart","title":"Create Cart","href":"/api-reference/latest/cart/create-cart"},{"openapi":"get /cart/{token}","title":null,"href":"/api-reference/latest/cart/get-cart"},{"openapi":"post /cart/{token}","title":null,"href":"/api-reference/latest/cart/update-cart"},{"openapi":"delete /cart/{token}","title":null,"href":"/api-reference/latest/cart/delete-cart"}]},{"group":"Destinations","pages":[{"openapi":"get /destinations","title":"Get All Destinations","href":"/api-reference/latest/destinations/get-all-destinations"},{"openapi":"post /destinations","title":"Create Destination","href":"/api-reference/latest/destinations/create-destination"},{"openapi":"get /destinations/{id}","title":"Get Destination Details","href":"/api-reference/latest/destinations/get-destination-details"},{"openapi":"put /destinations/{id}","title":"Update Destination","href":"/api-reference/latest/destinations/update-destination"},{"openapi":"delete /destinations/{id}","title":"Delete Destination","href":"/api-reference/latest/destinations/delete-destination"}]},{"group":"Blocklist","pages":[{"openapi":"get /blocklists","title":"List Blocklist Items","href":"/api-reference/latest/blocklist/list-blocklist-items"},{"openapi":"post /blocklists","title":"Create Blocklist Item","href":"/api-reference/latest/blocklist/create-blocklist-item"},{"openapi":"get /blocklists/{id}","title":"Get Blocklist Item","href":"/api-reference/latest/blocklist/get-blocklist-item"},{"openapi":"delete /blocklists/{id}","title":"Delete Blocklist Item","href":"/api-reference/latest/blocklist/delete-blocklist-item"}]},{"group":"Allowlist","pages":[{"openapi":"get /allowlists","title":"List Allowlist Items","href":"/api-reference/latest/allowlist/list-allowlist-items"},{"openapi":"post /allowlists","title":"Create Allowlist Item","href":"/api-reference/latest/allowlist/create-allowlist-item"},{"openapi":"get /allowlists/{id}","title":"Get Allowlist Item","href":"/api-reference/latest/allowlist/get-allowlist-item"},{"openapi":"delete /allowlists/{id}","title":"Delete Allowlist Item","href":"/api-reference/latest/allowlist/delete-allowlist-item"}]},{"group":"Fraud Reports","pages":[{"openapi":"post /returns/{id}/fraud-report","title":"Create Fraud Report","href":"/api-reference/latest/return-actions/create-fraud-report"}]},{"group":"Order Return Eligibility","pages":[{"openapi":"post /orders/return-eligibility","title":"Look Up Order Return Eligibility by Order Name","href":"/api-reference/latest/orders/look-up-order-return-eligibility"}]},{"group":"Happy Returns Shipments","pages":[{"openapi":"get /happy-returns/shipments/{happy_returns_shipment_id}","title":"Get Shipment Information","href":"/api-reference/latest/happy-returns-shipment/get-shipment-information"},{"openapi":"get /happy-returns/shipments","title":"Get Shipments","href":"/api-reference/latest/happy-returns-shipment/get-shipments"},{"openapi":"get /happy-returns/shipments/{id}/items","title":"Get Shipment Items","href":"/api-reference/latest/happy-returns-shipment-items/get-shipment-items"}]},{"group":"Label Requests","pages":[{"openapi":"get /label-requests","title":"List Label Requests","href":"/api-reference/latest/label-requests/list-label-requests"},{"openapi":"get /label-requests/{id}","title":"Get Label Request","href":"/api-reference/latest/label-requests/get-label-request"},{"openapi":"post /label-requests/{id}/errors","title":"Create Label Request Error","href":"/api-reference/latest/label-requests/create-a-label-request-error"},{"openapi":"post /labels","title":"Create Label","href":"/api-reference/latest/label-requests/create-label"},{"openapi":"post /returns/{returnId}/labels","title":"Generate Label","href":"/api-reference/latest/label-requests/generate-label"},{"openapi":"put /labels/{id}","title":"Update Label Status","href":"/api-reference/latest/label-requests/update-label-status"}]},{"group":"Return Create (HAL-Forms)","pages":[{"title":"Draft Returns (HAL Forms)","version":"2026-10","href":"/api-reference/2026-10/draft-returns/overview"},{"openapi":"draft-returns-hal-forms get /draft-returns","title":"List Draft Returns","href":"/api-reference/2026-10/draft-returns/list-draft-returns"},{"openapi":"draft-returns-hal-forms get /draft-returns/{draft_return_id}","title":"Get Draft Return","href":"/api-reference/2026-10/draft-returns/get-draft-return"},{"openapi":"draft-returns-hal-forms get /draft-returns/{draft_return_id}/order/items","title":"List Order Line Items","href":"/api-reference/2026-10/draft-returns/list-order-line-items"},{"openapi":"draft-returns-hal-forms get /draft-returns/{draft_return_id}/totals","title":"Get Draft Return Totals","href":"/api-reference/2026-10/draft-returns/get-draft-return-totals"},{"openapi":"draft-returns-hal-forms post /draft-returns","title":"Initialize Draft Return","href":"/api-reference/2026-10/draft-returns/initialize-draft-return"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/accept-return-policy","title":"Accept Return Policy","href":"/api-reference/2026-10/draft-returns/accept-return-policy"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/cancel","title":"Cancel Draft Return","href":"/api-reference/2026-10/draft-returns/cancel-draft-return"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/customer","title":"Set Customer","href":"/api-reference/2026-10/draft-returns/set-customer"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/address","title":"Set Address","href":"/api-reference/2026-10/draft-returns/set-address"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/returning-items","title":"Add Returning Item","href":"/api-reference/2026-10/draft-returns/add-returning-item"},{"openapi":"draft-returns-hal-forms delete /draft-returns/{draft_return_id}/returning-items/{returning_item_id}","title":"Remove Returning Item","href":"/api-reference/2026-10/draft-returns/remove-returning-item"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/returning-items/{returning_item_id}/return-reason","title":"Set Returning Item Return Reason","href":"/api-reference/2026-10/draft-returns/set-returning-item-return-reason"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/returning-items/{returning_item_id}/user-input/{user_input_id}","title":"Add Returning Item User Input","href":"/api-reference/2026-10/draft-returns/add-returning-item-user-input"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/returning-items/{returning_item_id}/return-type","title":"Set Returning Item Return Type","href":"/api-reference/2026-10/draft-returns/set-returning-item-return-type"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/returning-items/{returning_item_id}/exchange-item","title":"Add Returning Item Exchange Item","href":"/api-reference/2026-10/draft-returns/add-returning-item-exchange-item"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/cart/items","title":"Add Cart Item","href":"/api-reference/2026-10/draft-returns/add-cart-item"},{"openapi":"draft-returns-hal-forms delete /draft-returns/{draft_return_id}/cart/items/{cart_item_id}","title":"Remove Cart Item","href":"/api-reference/2026-10/draft-returns/remove-cart-item"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/credit-type","title":"Set Credit Type","href":"/api-reference/2026-10/draft-returns/set-credit-type"},{"openapi":"draft-returns-hal-forms delete /draft-returns/{draft_return_id}/credit-type","title":"Unset Credit Type","href":"/api-reference/2026-10/draft-returns/unset-credit-type"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/processing-type","title":"Set Processing Type","href":"/api-reference/2026-10/draft-returns/set-processing-type"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/finalize-items","title":"Finalize Items","href":"/api-reference/2026-10/draft-returns/finalize-items"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/unfinalize-items","title":"Unfinalize Items","href":"/api-reference/2026-10/draft-returns/unfinalize-items"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/return-method","title":"Select Return Method","href":"/api-reference/2026-10/draft-returns/select-return-method"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/return-method/carrier","title":"Select Return Method Carrier","href":"/api-reference/2026-10/draft-returns/select-return-method-carrier"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/language","title":"Set Language","href":"/api-reference/2026-10/draft-returns/set-language"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/cart","title":"Set Cart","href":"/api-reference/2026-10/draft-returns/set-cart"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/payment-intent","title":"Create Payment Intent","href":"/api-reference/2026-10/draft-returns/create-payment-intent"},{"openapi":"draft-returns-hal-forms delete /draft-returns/{draft_return_id}/payment-intent/{payment_intent_id}","title":"Remove Payment Intent","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","description":"Create a new 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","description":"Get the details about a single product.","href":"/api-reference/latest/products/get-product"},{"openapi":"get /products/external/{externalId}","title":"Get Product by External ID","href":"/api-reference/latest/products/get-product-by-external-id"},{"openapi":"put /products/{id}","title":"Update Product","href":"/api-reference/latest/products/update-product"},{"openapi":"delete /products/{id}","title":"Delete Product","href":"/api-reference/latest/products/delete-product"},{"openapi":"delete /products/external/{externalId}","title":"Delete Product by External ID","href":"/api-reference/latest/products/delete-product-by-external-id"},{"openapi":"get /products/{productId}/product-variants","title":"List Product Variants","href":"/api-reference/latest/products/list-product-variants"},{"openapi":"post /products/{productId}/product-variants","title":"Create Product Variant","href":"/api-reference/latest/products/create-product-variant"},{"openapi":"put /products/{productId}/product-variants","title":"Upsert Product Variant","href":"/api-reference/latest/products/upsert-product-variant"},{"openapi":"put /products/external/{productExternalId}/product-variants","title":"Upsert Product Variant by Product External ID","href":"/api-reference/latest/products/upsert-product-variant-by-product-external-id"},{"openapi":"get /products/{productId}/product-variants/{id}","title":"Get Product Variant","href":"/api-reference/latest/products/get-product-variant"},{"openapi":"get /products/external/{productExternalId}/product-variants/{externalId}","title":"Get Product Variant by External ID","href":"/api-reference/latest/products/get-product-variant-by-external-id"},{"openapi":"patch /products/{productId}/product-variants/{id}","title":"Update Product Variant","href":"/api-reference/latest/products/update-product-variant"},{"openapi":"delete /products/{productId}/product-variants/{id}","title":"Delete Product Variant","href":"/api-reference/latest/products/delete-product-variant"},{"openapi":"delete /products/external/{productExternalId}/product-variants/{externalId}","title":"Delete Product Variant by External ID","href":"/api-reference/latest/products/delete-product-variant-by-external-id"}]},{"group":"Orders","pages":[{"openapi":"get /orders","title":"List Orders","href":"/api-reference/latest/orders/list-orders"},{"openapi":"openapi/orders-api.yaml post /orders","title":"Create Order","href":"/api-reference/latest/orders/create-order"},{"openapi":"openapi/orders-api.yaml put /orders","title":"Upsert Order","href":"/api-reference/latest/orders/upsert-order"},{"openapi":"get /orders/{id}","title":"Get Order","href":"/api-reference/latest/orders/get-order"},{"openapi":"get /orders/external/{externalId}","title":"Get Order by External ID","href":"/api-reference/latest/orders/get-order-by-external-id"},{"openapi":"openapi/orders-api.yaml put /orders/{id}","title":"Update Order","href":"/api-reference/latest/orders/update-order"},{"openapi":"delete /orders/{id}","title":"Delete Order","href":"/api-reference/latest/orders/delete-order"},{"openapi":"delete /orders/external/{externalId}","title":"Delete Order by External ID","href":"/api-reference/latest/orders/delete-order-by-external-id"}]},{"group":"Customers","pages":[{"openapi":"get /customers","title":"List Customers","href":"/api-reference/latest/customers/list-customers"},{"openapi":"post /customers","title":"Create Customer","href":"/api-reference/latest/customers/create-customer"},{"openapi":"put /customers","title":"Upsert Customer","href":"/api-reference/latest/customers/upsert-customer"},{"openapi":"get /customers/{id}","title":"Get Customer","href":"/api-reference/latest/customers/get-customer"},{"openapi":"get /customers/external/{externalId}","title":"Get Customer by External ID","href":"/api-reference/latest/customers/get-customer-by-external-id"},{"openapi":"put /customers/{id}","title":"Update Customer","href":"/api-reference/latest/customers/update-customer"},{"openapi":"delete /customers/{id}","title":"Delete Customer","href":"/api-reference/latest/customers/delete-customer"},{"openapi":"delete /customers/external/{externalId}","title":"Delete Customer by External ID","href":"/api-reference/latest/customers/delete-customer-by-external-id"}]},{"group":"Locations","pages":[{"openapi":"get /locations","title":"List Locations","href":"/api-reference/latest/locations/list-locations"},{"openapi":"post /locations","title":"Create Location","href":"/api-reference/latest/locations/create-location"},{"openapi":"put /locations","title":"Upsert Location","href":"/api-reference/latest/locations/upsert-location"},{"openapi":"get /locations/{id}","title":"Get Location","href":"/api-reference/latest/locations/get-location"},{"openapi":"get /locations/external/{externalId}","title":"Get Location by External ID","href":"/api-reference/latest/locations/get-location-by-external-id"},{"openapi":"put /locations/{id}","title":"Update Location","href":"/api-reference/latest/locations/update-location"},{"openapi":"delete /locations/{id}","title":"Delete Location","href":"/api-reference/latest/locations/delete-location"},{"openapi":"delete /locations/external/{externalId}","title":"Delete Location by External ID","href":"/api-reference/latest/locations/delete-location-by-external-id"}]},{"group":"Inventories","pages":[{"openapi":"get /inventories","title":"List Inventories","href":"/api-reference/latest/inventories/list-inventories"},{"openapi":"post /inventories/{productVariantId}/{locationId}","title":"Upsert Inventory","href":"/api-reference/latest/inventories/create-inventory"},{"openapi":"put /inventories/{productVariantId}/{locationId}","title":"Upsert Inventory","href":"/api-reference/latest/inventories/upsert-inventory"},{"openapi":"put /inventories/external/{variantExternalId}/{locationExternalId}","title":"Upsert Inventory by External IDs","href":"/api-reference/latest/inventories/upsert-inventory-by-external-ids"},{"openapi":"get /inventories/{productVariantId}/{locationId}","title":"Get Inventory","href":"/api-reference/latest/inventories/get-inventory"},{"openapi":"get /inventories/external/{variantExternalId}/{locationExternalId}","title":"Get Inventory by External IDs","href":"/api-reference/latest/inventories/get-inventory-by-external-ids"},{"openapi":"delete /inventories/{productVariantId}/{locationId}","title":"Delete Inventory","href":"/api-reference/latest/inventories/delete-inventory"},{"openapi":"delete /inventories/external/{variantExternalId}/{locationExternalId}","title":"Delete Inventory by External IDs","href":"/api-reference/latest/inventories/delete-inventory-by-external-ids"}]},{"group":"Collections","pages":[{"openapi":"get /collections","title":"List Collections","href":"/api-reference/latest/collections/list-collections"},{"openapi":"post /collections","title":"Create Collection","href":"/api-reference/latest/collections/create-collection"},{"openapi":"put /collections","title":"Upsert Collection","href":"/api-reference/latest/collections/upsert-collection"},{"openapi":"get /collections/{id}","title":"Get Collection","href":"/api-reference/latest/collections/get-collection"},{"openapi":"get /collections/external/{externalId}","title":"Get Collection by External ID","href":"/api-reference/latest/collections/get-collection-by-external-id"},{"openapi":"put /collections/{id}","title":"Update Collection","href":"/api-reference/latest/collections/update-collection"},{"openapi":"delete /collections/{id}","title":"Delete Collection","href":"/api-reference/latest/collections/delete-collection"},{"openapi":"delete /collections/external/{externalId}","title":"Delete Collection by External ID","href":"/api-reference/latest/collections/delete-collection-by-external-id"},{"openapi":"post /collections/{id}/products/{productId}","title":"Add Product to Collection","href":"/api-reference/latest/collections/add-product-to-collection"},{"openapi":"delete /collections/{id}/products/{productId}","title":"Delete Product from Collection","href":"/api-reference/latest/collections/delete-product-from-collection"},{"openapi":"post /collections/external/{collectionExternalId}/products/external/{productExternalId}","title":"Add Product to Collection by External ID","href":"/api-reference/latest/collections/add-product-to-collection-by-external-id"},{"openapi":"delete /collections/external/{collectionExternalId}/products/external/{productExternalId}","title":"Delete Product from Collection by External ID","href":"/api-reference/latest/collections/delete-product-from-collection-by-external-id"}]},{"group":"Bulk Operations","pages":[{"openapi":"post /bulk-operations","title":"Create Bulk Operation","href":"/api-reference/latest/bulk-operations/create-bulk-operation"},{"openapi":"get /bulk-operations","title":"List Bulk Operations","href":"/api-reference/latest/bulk-operations/list-bulk-operations"},{"openapi":"get /bulk-operations/{id}","title":"Get Bulk Operation","href":"/api-reference/latest/bulk-operations/get-bulk-operation"},{"openapi":"get /bulk-operations/{id}/jobs","title":"List Bulk Operation Jobs","href":"/api-reference/latest/bulk-operations/list-bulk-operation-jobs"}]}]}]}]},{"tab":"Webhook Reference","pages":[{"title":"Webhook Reference","href":"/webhook-reference/getting-started"}]}]},{"version":"unstable","tabs":[{"tab":"Introduction","pages":[{"title":"Introduction","href":"/welcome"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/integration-guides/overview"}]},{"tab":"MCP Server","pages":[{"title":"MCP Server","href":"/mcp/overview"}]},{"tab":"API Reference","groups":[{"group":"Unstable","pages":[{"title":"What's different in unstable","sidebarTitle":"What's Changed","href":"/api-reference/unstable/changes"}]},{"group":"Using the API","pages":[{"title":"Getting Started","icon":"play","href":"/api-reference/getting-started"},{"title":"Authentication","version":"2026-07","icon":"lock","href":"/api-reference/authentication"},{"title":"API Versioning","icon":"clock","href":"/api-reference/versioning"},{"title":"Rate limit","icon":"gauge","href":"/api-reference/rate-limit"},{"title":"Pagination","icon":"page","href":"/api-reference/pagination"},{"title":"Error codes","icon":"circle-exclamation","iconType":"regular","href":"/api-reference/error-codes"},{"title":"Postman Collection","icon":"bolt","href":"/api-reference/postman"}]},{"group":"APIs","pages":[{"group":"Return Actions","pages":[{"openapi":"post /warehouse/return/{id}/process","title":"Process Return","href":"/api-reference/latest/return-actions/process-return"},{"openapi":"post /warehouse/return/{id}/remove","title":"Remove Line Items","href":"/api-reference/latest/return-actions/remove-line-items"},{"openapi":"post /warehouse/return/{id}/cancel","title":"Cancel Return","href":"/api-reference/latest/return-actions/cancel-return"},{"openapi":"post /warehouse/return/{id}/flag","title":"Flag Return","href":"/api-reference/latest/return-actions/flag-return"},{"openapi":"post /warehouse/return/{id}/close","title":"Close Return","href":"/api-reference/latest/return-actions/close-return"},{"openapi":"get /warehouse/return/{id}/notes","title":"Get Return Notes","href":"/api-reference/latest/return-actions/get-return-notes"},{"openapi":"post /warehouse/return/{id}/note","title":"Create Return Note","href":"/api-reference/latest/return-actions/create-return-note"},{"openapi":"post /order/link","title":"Create Return Deep Link","href":"/api-reference/latest/return-actions/create-return-deep-link"},{"openapi":"post /order/qr","title":"Create Return Deep Link with QR Code","href":"/api-reference/latest/return-actions/create-return-deep-link-with-qr-code"}]},{"group":"Return Data","pages":[{"openapi":"get /warehouse/return/list","title":"Detailed Returns List","href":"/api-reference/latest/return-data/detailed-returns-list"},{"openapi":"get /warehouse/return/details","title":"Get Return Details","href":"/api-reference/latest/return-data/get-return-details"},{"openapi":"get /warehouse/reporting/asn","title":"Advanced Shipping Notice","href":"/api-reference/latest/return-data/advanced-shipping-notice"}]},{"group":"Programmatic Webhooks","pages":[{"openapi":"get /webhooks","title":"Get Webhooks","href":"/api-reference/latest/programmatic-webhooks/get-webhooks"},{"openapi":"post /webhooks","title":"Create Webhook","href":"/api-reference/latest/programmatic-webhooks/create-webhook"},{"openapi":"put /webhooks/{id}","title":"Update Webhook","href":"/api-reference/latest/programmatic-webhooks/update-webhook"},{"openapi":"delete /webhooks/{id}","title":"Delete Webhook","href":"/api-reference/latest/programmatic-webhooks/delete-webhook"}]},{"group":"Item Grading and Dispositioning","pages":[{"openapi":"post /dispositioning/grade","title":"Grade Items","href":"/api-reference/latest/item-grading-and-disposition/grade-items"},{"openapi":"post /dispositioning/assess","title":"Assess Dispositions","href":"/api-reference/latest/item-grading-and-disposition/assess-dispositions"}]},{"group":"Cart","pages":[{"openapi":"post /cart","title":"Create Cart","href":"/api-reference/latest/cart/create-cart"},{"openapi":"get /cart/{token}","title":null,"href":"/api-reference/latest/cart/get-cart"},{"openapi":"post /cart/{token}","title":null,"href":"/api-reference/latest/cart/update-cart"},{"openapi":"delete /cart/{token}","title":null,"href":"/api-reference/latest/cart/delete-cart"}]},{"group":"Destinations","pages":[{"openapi":"get /destinations","title":"Get All Destinations","href":"/api-reference/latest/destinations/get-all-destinations"},{"openapi":"post /destinations","title":"Create Destination","href":"/api-reference/latest/destinations/create-destination"},{"openapi":"get /destinations/{id}","title":"Get Destination Details","href":"/api-reference/latest/destinations/get-destination-details"},{"openapi":"put /destinations/{id}","title":"Update Destination","href":"/api-reference/latest/destinations/update-destination"},{"openapi":"delete /destinations/{id}","title":"Delete Destination","href":"/api-reference/latest/destinations/delete-destination"}]},{"group":"Blocklist","pages":[{"openapi":"get /blocklists","title":"List Blocklist Items","href":"/api-reference/latest/blocklist/list-blocklist-items"},{"openapi":"post /blocklists","title":"Create Blocklist Item","href":"/api-reference/latest/blocklist/create-blocklist-item"},{"openapi":"get /blocklists/{id}","title":"Get Blocklist Item","href":"/api-reference/latest/blocklist/get-blocklist-item"},{"openapi":"delete /blocklists/{id}","title":"Delete Blocklist Item","href":"/api-reference/latest/blocklist/delete-blocklist-item"}]},{"group":"Allowlist","pages":[{"openapi":"get /allowlists","title":"List Allowlist Items","href":"/api-reference/latest/allowlist/list-allowlist-items"},{"openapi":"post /allowlists","title":"Create Allowlist Item","href":"/api-reference/latest/allowlist/create-allowlist-item"},{"openapi":"get /allowlists/{id}","title":"Get Allowlist Item","href":"/api-reference/latest/allowlist/get-allowlist-item"},{"openapi":"delete /allowlists/{id}","title":"Delete Allowlist Item","href":"/api-reference/latest/allowlist/delete-allowlist-item"}]},{"group":"Fraud Reports","pages":[{"openapi":"post /returns/{id}/fraud-report","title":"Create Fraud Report","href":"/api-reference/latest/return-actions/create-fraud-report"}]},{"group":"Order Return Eligibility","pages":[{"openapi":"post /orders/return-eligibility","title":"Look Up Order Return Eligibility by Order Name","href":"/api-reference/latest/orders/look-up-order-return-eligibility"}]},{"group":"Happy Returns Shipments","pages":[{"openapi":"get /happy-returns/shipments/{happy_returns_shipment_id}","title":"Get Shipment Information","href":"/api-reference/latest/happy-returns-shipment/get-shipment-information"},{"openapi":"get /happy-returns/shipments","title":"Get Shipments","href":"/api-reference/latest/happy-returns-shipment/get-shipments"},{"openapi":"get /happy-returns/shipments/{id}/items","title":"Get Shipment Items","href":"/api-reference/latest/happy-returns-shipment-items/get-shipment-items"}]},{"group":"Label Requests","pages":[{"openapi":"get /label-requests","title":"List Label Requests","href":"/api-reference/latest/label-requests/list-label-requests"},{"openapi":"get /label-requests/{id}","title":"Get Label Request","href":"/api-reference/latest/label-requests/get-label-request"},{"openapi":"post /label-requests/{id}/errors","title":"Create Label Request Error","href":"/api-reference/latest/label-requests/create-a-label-request-error"},{"openapi":"post /labels","title":"Create Label","href":"/api-reference/latest/label-requests/create-label"},{"openapi":"post /returns/{returnId}/labels","title":"Generate Label","href":"/api-reference/latest/label-requests/generate-label"},{"openapi":"put /labels/{id}","title":"Update Label Status","href":"/api-reference/latest/label-requests/update-label-status"}]},{"group":"Return Create (HAL-Forms)","pages":[{"title":"Draft Returns (HAL Forms)","version":"2026-10","href":"/api-reference/2026-10/draft-returns/overview"},{"openapi":"draft-returns-hal-forms get /draft-returns","title":"List Draft Returns","href":"/api-reference/2026-10/draft-returns/list-draft-returns"},{"openapi":"draft-returns-hal-forms get /draft-returns/{draft_return_id}","title":"Get Draft Return","href":"/api-reference/2026-10/draft-returns/get-draft-return"},{"openapi":"draft-returns-hal-forms get /draft-returns/{draft_return_id}/order/items","title":"List Order Line Items","href":"/api-reference/2026-10/draft-returns/list-order-line-items"},{"openapi":"draft-returns-hal-forms get /draft-returns/{draft_return_id}/totals","title":"Get Draft Return Totals","href":"/api-reference/2026-10/draft-returns/get-draft-return-totals"},{"openapi":"draft-returns-hal-forms post /draft-returns","title":"Initialize Draft Return","href":"/api-reference/2026-10/draft-returns/initialize-draft-return"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/accept-return-policy","title":"Accept Return Policy","href":"/api-reference/2026-10/draft-returns/accept-return-policy"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/cancel","title":"Cancel Draft Return","href":"/api-reference/2026-10/draft-returns/cancel-draft-return"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/customer","title":"Set Customer","href":"/api-reference/2026-10/draft-returns/set-customer"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/address","title":"Set Address","href":"/api-reference/2026-10/draft-returns/set-address"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/returning-items","title":"Add Returning Item","href":"/api-reference/2026-10/draft-returns/add-returning-item"},{"openapi":"draft-returns-hal-forms delete /draft-returns/{draft_return_id}/returning-items/{returning_item_id}","title":"Remove Returning Item","href":"/api-reference/2026-10/draft-returns/remove-returning-item"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/returning-items/{returning_item_id}/return-reason","title":"Set Returning Item Return Reason","href":"/api-reference/2026-10/draft-returns/set-returning-item-return-reason"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/returning-items/{returning_item_id}/user-input/{user_input_id}","title":"Add Returning Item User Input","href":"/api-reference/2026-10/draft-returns/add-returning-item-user-input"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/returning-items/{returning_item_id}/return-type","title":"Set Returning Item Return Type","href":"/api-reference/2026-10/draft-returns/set-returning-item-return-type"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/returning-items/{returning_item_id}/exchange-item","title":"Add Returning Item Exchange Item","href":"/api-reference/2026-10/draft-returns/add-returning-item-exchange-item"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/cart/items","title":"Add Cart Item","href":"/api-reference/2026-10/draft-returns/add-cart-item"},{"openapi":"draft-returns-hal-forms delete /draft-returns/{draft_return_id}/cart/items/{cart_item_id}","title":"Remove Cart Item","href":"/api-reference/2026-10/draft-returns/remove-cart-item"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/credit-type","title":"Set Credit Type","href":"/api-reference/2026-10/draft-returns/set-credit-type"},{"openapi":"draft-returns-hal-forms delete /draft-returns/{draft_return_id}/credit-type","title":"Unset Credit Type","href":"/api-reference/2026-10/draft-returns/unset-credit-type"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/processing-type","title":"Set Processing Type","href":"/api-reference/2026-10/draft-returns/set-processing-type"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/finalize-items","title":"Finalize Items","href":"/api-reference/2026-10/draft-returns/finalize-items"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/unfinalize-items","title":"Unfinalize Items","href":"/api-reference/2026-10/draft-returns/unfinalize-items"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/return-method","title":"Select Return Method","href":"/api-reference/2026-10/draft-returns/select-return-method"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/return-method/carrier","title":"Select Return Method Carrier","href":"/api-reference/2026-10/draft-returns/select-return-method-carrier"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/language","title":"Set Language","href":"/api-reference/2026-10/draft-returns/set-language"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/cart","title":"Set Cart","href":"/api-reference/2026-10/draft-returns/set-cart"},{"openapi":"draft-returns-hal-forms post /draft-returns/{draft_return_id}/payment-intent","title":"Create Payment Intent","href":"/api-reference/2026-10/draft-returns/create-payment-intent"},{"openapi":"draft-returns-hal-forms delete /draft-returns/{draft_return_id}/payment-intent/{payment_intent_id}","title":"Remove Payment Intent","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","description":"Create a new 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","description":"Get the details about a single product.","href":"/api-reference/latest/products/get-product"},{"openapi":"get /products/external/{externalId}","title":"Get Product by External ID","href":"/api-reference/latest/products/get-product-by-external-id"},{"openapi":"put /products/{id}","title":"Update Product","href":"/api-reference/latest/products/update-product"},{"openapi":"delete /products/{id}","title":"Delete Product","href":"/api-reference/latest/products/delete-product"},{"openapi":"delete /products/external/{externalId}","title":"Delete Product by External ID","href":"/api-reference/latest/products/delete-product-by-external-id"},{"openapi":"get /products/{productId}/product-variants","title":"List Product Variants","href":"/api-reference/latest/products/list-product-variants"},{"openapi":"post /products/{productId}/product-variants","title":"Create Product Variant","href":"/api-reference/latest/products/create-product-variant"},{"openapi":"put /products/{productId}/product-variants","title":"Upsert Product Variant","href":"/api-reference/latest/products/upsert-product-variant"},{"openapi":"put /products/external/{productExternalId}/product-variants","title":"Upsert Product Variant by Product External ID","href":"/api-reference/latest/products/upsert-product-variant-by-product-external-id"},{"openapi":"get /products/{productId}/product-variants/{id}","title":"Get Product Variant","href":"/api-reference/latest/products/get-product-variant"},{"openapi":"get /products/external/{productExternalId}/product-variants/{externalId}","title":"Get Product Variant by External ID","href":"/api-reference/latest/products/get-product-variant-by-external-id"},{"openapi":"patch /products/{productId}/product-variants/{id}","title":"Update Product Variant","href":"/api-reference/latest/products/update-product-variant"},{"openapi":"delete /products/{productId}/product-variants/{id}","title":"Delete Product Variant","href":"/api-reference/latest/products/delete-product-variant"},{"openapi":"delete /products/external/{productExternalId}/product-variants/{externalId}","title":"Delete Product Variant by External ID","href":"/api-reference/latest/products/delete-product-variant-by-external-id"}]},{"group":"Orders","pages":[{"openapi":"get /orders","title":"List Orders","href":"/api-reference/latest/orders/list-orders"},{"openapi":"openapi/orders-api.yaml post /orders","title":"Create Order","href":"/api-reference/latest/orders/create-order"},{"openapi":"openapi/orders-api.yaml put /orders","title":"Upsert Order","href":"/api-reference/latest/orders/upsert-order"},{"openapi":"get /orders/{id}","title":"Get Order","href":"/api-reference/latest/orders/get-order"},{"openapi":"get /orders/external/{externalId}","title":"Get Order by External ID","href":"/api-reference/latest/orders/get-order-by-external-id"},{"openapi":"openapi/orders-api.yaml put /orders/{id}","title":"Update Order","href":"/api-reference/latest/orders/update-order"},{"openapi":"delete /orders/{id}","title":"Delete Order","href":"/api-reference/latest/orders/delete-order"},{"openapi":"delete /orders/external/{externalId}","title":"Delete Order by External ID","href":"/api-reference/latest/orders/delete-order-by-external-id"}]},{"group":"Customers","pages":[{"openapi":"get /customers","title":"List Customers","href":"/api-reference/latest/customers/list-customers"},{"openapi":"post /customers","title":"Create Customer","href":"/api-reference/latest/customers/create-customer"},{"openapi":"put /customers","title":"Upsert Customer","href":"/api-reference/latest/customers/upsert-customer"},{"openapi":"get /customers/{id}","title":"Get Customer","href":"/api-reference/latest/customers/get-customer"},{"openapi":"get /customers/external/{externalId}","title":"Get Customer by External ID","href":"/api-reference/latest/customers/get-customer-by-external-id"},{"openapi":"put /customers/{id}","title":"Update Customer","href":"/api-reference/latest/customers/update-customer"},{"openapi":"delete /customers/{id}","title":"Delete Customer","href":"/api-reference/latest/customers/delete-customer"},{"openapi":"delete /customers/external/{externalId}","title":"Delete Customer by External ID","href":"/api-reference/latest/customers/delete-customer-by-external-id"}]},{"group":"Locations","pages":[{"openapi":"get /locations","title":"List Locations","href":"/api-reference/latest/locations/list-locations"},{"openapi":"post /locations","title":"Create Location","href":"/api-reference/latest/locations/create-location"},{"openapi":"put /locations","title":"Upsert Location","href":"/api-reference/latest/locations/upsert-location"},{"openapi":"get /locations/{id}","title":"Get Location","href":"/api-reference/latest/locations/get-location"},{"openapi":"get /locations/external/{externalId}","title":"Get Location by External ID","href":"/api-reference/latest/locations/get-location-by-external-id"},{"openapi":"put /locations/{id}","title":"Update Location","href":"/api-reference/latest/locations/update-location"},{"openapi":"delete /locations/{id}","title":"Delete Location","href":"/api-reference/latest/locations/delete-location"},{"openapi":"delete /locations/external/{externalId}","title":"Delete Location by External ID","href":"/api-reference/latest/locations/delete-location-by-external-id"}]},{"group":"Inventories","pages":[{"openapi":"get /inventories","title":"List Inventories","href":"/api-reference/latest/inventories/list-inventories"},{"openapi":"post /inventories/{productVariantId}/{locationId}","title":"Upsert Inventory","href":"/api-reference/latest/inventories/create-inventory"},{"openapi":"put /inventories/{productVariantId}/{locationId}","title":"Upsert Inventory","href":"/api-reference/latest/inventories/upsert-inventory"},{"openapi":"put /inventories/external/{variantExternalId}/{locationExternalId}","title":"Upsert Inventory by External IDs","href":"/api-reference/latest/inventories/upsert-inventory-by-external-ids"},{"openapi":"get /inventories/{productVariantId}/{locationId}","title":"Get Inventory","href":"/api-reference/latest/inventories/get-inventory"},{"openapi":"get /inventories/external/{variantExternalId}/{locationExternalId}","title":"Get Inventory by External IDs","href":"/api-reference/latest/inventories/get-inventory-by-external-ids"},{"openapi":"delete /inventories/{productVariantId}/{locationId}","title":"Delete Inventory","href":"/api-reference/latest/inventories/delete-inventory"},{"openapi":"delete /inventories/external/{variantExternalId}/{locationExternalId}","title":"Delete Inventory by External IDs","href":"/api-reference/latest/inventories/delete-inventory-by-external-ids"}]},{"group":"Collections","pages":[{"openapi":"get /collections","title":"List Collections","href":"/api-reference/latest/collections/list-collections"},{"openapi":"post /collections","title":"Create Collection","href":"/api-reference/latest/collections/create-collection"},{"openapi":"put /collections","title":"Upsert Collection","href":"/api-reference/latest/collections/upsert-collection"},{"openapi":"get /collections/{id}","title":"Get Collection","href":"/api-reference/latest/collections/get-collection"},{"openapi":"get /collections/external/{externalId}","title":"Get Collection by External ID","href":"/api-reference/latest/collections/get-collection-by-external-id"},{"openapi":"put /collections/{id}","title":"Update Collection","href":"/api-reference/latest/collections/update-collection"},{"openapi":"delete /collections/{id}","title":"Delete Collection","href":"/api-reference/latest/collections/delete-collection"},{"openapi":"delete /collections/external/{externalId}","title":"Delete Collection by External ID","href":"/api-reference/latest/collections/delete-collection-by-external-id"},{"openapi":"post /collections/{id}/products/{productId}","title":"Add Product to Collection","href":"/api-reference/latest/collections/add-product-to-collection"},{"openapi":"delete /collections/{id}/products/{productId}","title":"Delete Product from Collection","href":"/api-reference/latest/collections/delete-product-from-collection"},{"openapi":"post /collections/external/{collectionExternalId}/products/external/{productExternalId}","title":"Add Product to Collection by External ID","href":"/api-reference/latest/collections/add-product-to-collection-by-external-id"},{"openapi":"delete /collections/external/{collectionExternalId}/products/external/{productExternalId}","title":"Delete Product from Collection by External ID","href":"/api-reference/latest/collections/delete-product-from-collection-by-external-id"}]},{"group":"Bulk Operations","pages":[{"openapi":"post /bulk-operations","title":"Create Bulk Operation","href":"/api-reference/latest/bulk-operations/create-bulk-operation"},{"openapi":"get /bulk-operations","title":"List Bulk Operations","href":"/api-reference/latest/bulk-operations/list-bulk-operations"},{"openapi":"get /bulk-operations/{id}","title":"Get Bulk Operation","href":"/api-reference/latest/bulk-operations/get-bulk-operation"},{"openapi":"get /bulk-operations/{id}/jobs","title":"List Bulk Operation Jobs","href":"/api-reference/latest/bulk-operations/list-bulk-operation-jobs"}]}]}]}]},{"tab":"Webhook Reference","pages":[{"title":"Webhook Reference","href":"/webhook-reference/getting-started"}]}]}]},"basePath":"","title":"Upsert Product - Loop Returns Documentation","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}