The single category this product belongs to, as a structured CategorySummary (slug, title, path, has_children).
Show child attributes
gender
enum<string> | null
Product gender. 'unisex' is deprecated: coerced to None on input, never emitted.
Available options:
male,
female
age
enum<string> | null
Target age group. Age-agnostic products are typically returned as 'adult'.
Available options:
newborn,
infant,
toddler,
kids,
adult
materials
string[] | null
key_features
string[] | null
colors
ProductColor · object[]
Colors of the cleaned main product image, ordered by pixel share (descending). Empty when the product has no cleaned image palette.
Show child attributes
offers
ProductOffer · object[]
All merchant offers for this product in the requested locale.
Show child attributes
variants
Variants · object | null
Variant interaction state — options, selected. Absent when the product has no variations.
Show child attributes
structured_attributes
Structured Attributes · object
Structured attributes extracted for this product, keyed by attribute handle (e.g. 'color', 'material'). Values are the canonical allowed values for that handle.
Show child attributes
ratings
ProductRatings · object | null
Cross-merchant rating rollup. Null when no merchant has a usable product rating.
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Channel3","colors":{"primary":"#6F96B5","light":"#6F96B5","dark":"#6F96B5"},"logo":{"light":"https://mintcdn.com/channel3/MdbRmpXO6ogT4w7g/logo/channel3-logo-wide-light.svg?fit=max\u0026auto=format\u0026n=MdbRmpXO6ogT4w7g\u0026q=85\u0026s=d23a7735ff07b0e7ad75f84ecffc413e","dark":"https://mintcdn.com/channel3/MdbRmpXO6ogT4w7g/logo/channel3-logo-wide-dark.svg?fit=max\u0026auto=format\u0026n=MdbRmpXO6ogT4w7g\u0026q=85\u0026s=2eab753f0c6950d281b85ee099e3ce30"},"favicon":"https://mintcdn.com/channel3/MdbRmpXO6ogT4w7g/favicon.svg?fit=max\u0026auto=format\u0026n=MdbRmpXO6ogT4w7g\u0026q=85\u0026s=3d39bd96ce5d83d11fae9a829b0da744","api":{"examples":{"defaults":"required","languages":["python","javascript","curl"]}},"navbar":{"links":[{"icon":"/logo/discord.svg","href":"https://discord.gg/6J6MjctXrH","label":"Discord"},{"href":"mailto:support@channel3.ai","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://channel3.ai/dashboard"}},"styling":{"codeblocks":{"theme":{"light":"github-light","dark":"github-dark"}},"latex":false},"integrations":{"gtm":{"tagId":"GTM-WGKVRXL8"},"posthog":{"apiKey":"phc_rgdJvtXC2gguCCcXmacTEvAxuegz0vcgLbcyNQrTRdy","sessionRecording":false}},"contextual":{"options":["copy","view","chatgpt","claude","cursor","mcp","vscode"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"channel3","hasAudioNarration":false,"actualSubdomain":"channel3","customDomains":[],"gitSource":{"type":"github","owner":"channel3-ai","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"}},"buildId":"6b00c0d414ebbf8b8d982a7e","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Documentation","count":116},{"language":"default","tag":"API Reference","count":53},{"language":"default","tag":"Integrate","count":48},{"language":"default","tag":"Changelog","count":31},{"language":"default","tag":"Release notes","count":24},{"language":"default","tag":"Conversational Agent","count":16},{"language":"default","tag":"SDK","count":16},{"language":"default","tag":"Make a Search","count":15},{"language":"default","tag":"Search","count":13},{"language":"default","tag":"CLI","count":11}]},"assistantConfig":{"enableStarterQuestions":true,"enableContextualStarterQuestions":true},"basePath":"/docs","hasChatPermissions":true,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":":root,.dark{--radius: 4px;--radius-sm: 2px;--radius-md: 4px;--radius-lg: 4px;--radius-xl: 6px;--radius-2xl: 6px;--radius-3xl: 6px}card,tile,callout,accordion,code-block,code-group,frame,expandable,update,tooltip,step{border-radius:4px!important;overflow:hidden}code-group,code-block,pre,figure,[data-component-name=\"code-block\"],[data-component-name=\"code-group\"]{border-radius:4px!important;overflow:hidden}button,[data-component-name=\"primary-header-button\"],input,select,textarea,img{border-radius:4px!important}.rounded,.rounded-sm,.rounded-md,.rounded-lg,.rounded-xl,.rounded-2xl,.rounded-3xl,[class*=\"rounded-[\"]{border-radius:4px!important}#search-bar-entry,#search-bar-entry-mobile,#search-input{border-radius:4px!important}"}]}
{"page":{"pagePath":"product-model","slug":"/product-model","pageMetadata":{"title":"Product","icon":"cube","openapi-schema":"openapi/openapi.json Product","description":null,"href":"/product-model"},"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":{"codeStyling":{"theme":{"light":"github-light","dark":"github-dark"}},"config":{},"pageMetadata":{"title":"Product","icon":"cube","openapi-schema":"openapi/openapi.json Product","description":null,"href":"/product-model"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/channel3/adddcf3cd6dd6252/scripts/generate-categories-tree.js","/docs/_mintlify/custom/channel3/8c5186294b23fcfa/google-ads.js"],"openApiReferenceData":{"schemaData":{"properties":{"id":{"type":"string","title":"Id","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"title":{"type":"string","title":"Title","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"description":{"oneOf":[{"type":"string","title":"Description","uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","title":"Description","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"brands":{"items":{"properties":{"id":{"type":"string","title":"Id","isRequired":true,"uniqueKey":"brands.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","title":"Name","isRequired":true,"uniqueKey":"brands.items.[INDEX].name","typeLabel":"string"}},"type":"object","required":["id","name"],"title":"ProductBrand","uniqueKey":"brands.items.[INDEX]","typeLabel":"ProductBrand · object"},"type":"array","title":"Brands","description":"Ordered list of brands.","uniqueKey":"brands","typeLabel":"ProductBrand · object[]"},"images":{"items":{"properties":{"url":{"type":"string","title":"Url","isRequired":true,"uniqueKey":"images.items.[INDEX].url","typeLabel":"string"},"cleaned_url":{"oneOf":[{"type":"string","title":"Cleaned Url","description":"Background-removed square image on Channel3 CDN when available. Use for product grids; ``url`` is the regular hosted shot.","uniqueKey":"images.items.[INDEX].cleaned_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Cleaned Url","description":"Background-removed square image on Channel3 CDN when available. Use for product grids; ``url`` is the regular hosted shot.","uniqueKey":"images.items.[INDEX].cleaned_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"images.items.[INDEX].cleaned_url","typeLabel":"string | null"},"is_main_image":{"type":"boolean","title":"Is Main Image","default":false,"uniqueKey":"images.items.[INDEX].is_main_image","typeLabel":"boolean"},"shot_type":{"oneOf":[{"type":"string","title":"ApiProductImageType","description":"Product image type classification for API responses.","enum":["hero","lifestyle","on_model","detail","scale_reference","angle_view","flat_lay","in_use","packaging","size_chart","product_information","merchant_information"],"uniqueKey":"images.items.[INDEX].shot_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"images.items.[INDEX].shot_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"images.items.[INDEX].shot_type","typeLabel":"enum\u003cstring> | null"},"alt_text":{"oneOf":[{"type":"string","title":"Alt Text","uniqueKey":"images.items.[INDEX].alt_text.oneOf.0","typeLabel":"string"},{"type":"null","title":"Alt Text","uniqueKey":"images.items.[INDEX].alt_text.oneOf.1","typeLabel":"null"}],"uniqueKey":"images.items.[INDEX].alt_text","typeLabel":"string | null"}},"type":"object","required":["url"],"title":"ProductImage","description":"Product image with metadata.","uniqueKey":"images.items.[INDEX]","typeLabel":"ProductImage · object"},"type":"array","title":"Images","default":[],"uniqueKey":"images","typeLabel":"ProductImage · object[]"},"category":{"oneOf":[{"type":"object","title":"CategorySummary","description":"The single category this product belongs to, as a structured `CategorySummary` (slug, title, path, has_children).","required":["slug","title","has_children"],"properties":{"slug":{"type":"string","title":"Slug","description":"URL-friendly slug (e.g. 'sofas')","isRequired":true,"uniqueKey":"category.oneOf.0.slug","typeLabel":"string"},"title":{"type":"string","title":"Title","description":"Human-readable category title","isRequired":true,"uniqueKey":"category.oneOf.0.title","typeLabel":"string"},"has_children":{"type":"boolean","title":"Has Children","description":"Whether this category has subcategories","isRequired":true,"uniqueKey":"category.oneOf.0.has_children","typeLabel":"boolean"},"path":{"items":{"properties":{"slug":{"type":"string","title":"Slug","description":"URL-friendly slug (e.g. 'sofas')","isRequired":true,"uniqueKey":"category.oneOf.0.path.items.[INDEX].slug","typeLabel":"string"},"title":{"type":"string","title":"Title","description":"Human-readable category title","isRequired":true,"uniqueKey":"category.oneOf.0.path.items.[INDEX].title","typeLabel":"string"}},"type":"object","required":["slug","title"],"title":"CategoryRef","description":"Lean reference to a category, used in path and children arrays.","uniqueKey":"category.oneOf.0.path.items.[INDEX]","typeLabel":"CategoryRef · object"},"type":"array","title":"Path","description":"Hierarchical path as a structured list, root first; the last entry is this category itself","uniqueKey":"category.oneOf.0.path","typeLabel":"CategoryRef · object[]"}},"uniqueKey":"category.oneOf.0","typeLabel":"CategorySummary · object"},{"type":"null","description":"The single category this product belongs to, as a structured `CategorySummary` (slug, title, path, has_children).","uniqueKey":"category.oneOf.1","typeLabel":"null"}],"uniqueKey":"category","typeLabel":"CategorySummary · object | null"},"gender":{"oneOf":[{"type":"string","title":"Gender","description":"Product gender. 'unisex' is deprecated: coerced to None on input, never emitted.","enum":["male","female"],"uniqueKey":"gender.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"gender.oneOf.1","typeLabel":"null"}],"uniqueKey":"gender","typeLabel":"enum\u003cstring> | null"},"age":{"oneOf":[{"type":"string","title":"Age","description":"Target age group. Age-agnostic products are typically returned as 'adult'.","enum":["newborn","infant","toddler","kids","adult"],"uniqueKey":"age.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Target age group. Age-agnostic products are typically returned as 'adult'.","uniqueKey":"age.oneOf.1","typeLabel":"null"}],"uniqueKey":"age","typeLabel":"enum\u003cstring> | null"},"materials":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"materials.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Materials","uniqueKey":"materials.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Materials","uniqueKey":"materials.oneOf.1","typeLabel":"null"}],"uniqueKey":"materials","typeLabel":"string[] | null"},"key_features":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"key_features.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Key Features","uniqueKey":"key_features.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Key Features","uniqueKey":"key_features.oneOf.1","typeLabel":"null"}],"uniqueKey":"key_features","typeLabel":"string[] | null"},"colors":{"items":{"properties":{"hex":{"type":"string","title":"Hex","description":"sRGB hex string, e.g. '#a1b2c3'","isRequired":true,"uniqueKey":"colors.items.[INDEX].hex","typeLabel":"string"},"percentage":{"type":"number","title":"Percentage","description":"Fraction of foreground pixels in [0, 1]; 1.0 is 100%.","isRequired":true,"uniqueKey":"colors.items.[INDEX].percentage","typeLabel":"number"}},"type":"object","required":["hex","percentage"],"title":"ProductColor","description":"A color of the cleaned main product image; visual share, not composition or the Color variant axis.","uniqueKey":"colors.items.[INDEX]","typeLabel":"ProductColor · object"},"type":"array","title":"Colors","description":"Colors of the cleaned main product image, ordered by pixel share (descending). Empty when the product has no cleaned image palette.","uniqueKey":"colors","typeLabel":"ProductColor · object[]"},"offers":{"items":{"properties":{"url":{"type":"string","title":"Url","isRequired":true,"uniqueKey":"offers.items.[INDEX].url","typeLabel":"string"},"domain":{"type":"string","title":"Domain","isRequired":true,"uniqueKey":"offers.items.[INDEX].domain","typeLabel":"string"},"price":{"properties":{"price":{"type":"number","title":"Price","description":"The current price of the product, including any discounts.","isRequired":true,"uniqueKey":"offers.items.[INDEX].price.price","typeLabel":"number"},"currency":{"type":"string","title":"Currency","description":"The currency code of the product, like USD, EUR, GBP, etc.","isRequired":true,"uniqueKey":"offers.items.[INDEX].price.currency","typeLabel":"string"},"compare_at_price":{"oneOf":[{"type":"number","title":"Compare At Price","description":"The original price of the product before any discounts.","uniqueKey":"offers.items.[INDEX].price.compare_at_price.oneOf.0","typeLabel":"number"},{"type":"null","title":"Compare At Price","description":"The original price of the product before any discounts.","uniqueKey":"offers.items.[INDEX].price.compare_at_price.oneOf.1","typeLabel":"null"}],"uniqueKey":"offers.items.[INDEX].price.compare_at_price","typeLabel":"number | null"}},"type":"object","required":["price","currency"],"title":"Price","isRequired":true,"uniqueKey":"offers.items.[INDEX].price","typeLabel":"Price · object"},"availability":{"type":"string","enum":["InStock","OutOfStock"],"title":"OfferAvailabilityStatus","description":"The two availability values the public API emits on offers.\n\nInternal ``AvailabilityStatus`` values are collapsed to these via\n``AvailabilityStatus.to_api()``.","isRequired":true,"uniqueKey":"offers.items.[INDEX].availability","typeLabel":"enum\u003cstring>"},"condition":{"oneOf":[{"type":"string","title":"Condition","description":"Condition of this merchant offer (new or used). Null when condition is unknown.","enum":["new","used"],"uniqueKey":"offers.items.[INDEX].condition.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Condition of this merchant offer (new or used). Null when condition is unknown.","uniqueKey":"offers.items.[INDEX].condition.oneOf.1","typeLabel":"null"}],"uniqueKey":"offers.items.[INDEX].condition","typeLabel":"enum\u003cstring> | null"},"max_commission_rate":{"type":"number","title":"Max Commission Rate","description":"The maximum commission rate for the merchant, as a decimal fraction: 0 is no commission, 0.5 is 50% commission. 'Max' because the actual commission rate may be lower due to vendor-specific affiliate rules.","default":0,"uniqueKey":"offers.items.[INDEX].max_commission_rate","typeLabel":"number"},"dimensions":{"oneOf":[{"type":"object","title":"Dimensions","description":"Physical dimensions of this offer. Null when unknown.","properties":{"length":{"oneOf":[{"type":"object","title":"LengthDimension","description":"A length measurement, in one of the supported length units.","required":["number","unit"],"properties":{"number":{"type":"number","title":"Number","isRequired":true,"uniqueKey":"offers.items.[INDEX].dimensions.oneOf.0.length.oneOf.0.number","typeLabel":"number"},"unit":{"type":"string","enum":["mm","cm","m","in","ft"],"title":"LengthUnit","description":"The unit from the request's dimension filters when one was given (the value is converted to it); otherwise the unit the merchant stated.","isRequired":true,"uniqueKey":"offers.items.[INDEX].dimensions.oneOf.0.length.oneOf.0.unit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"offers.items.[INDEX].dimensions.oneOf.0.length.oneOf.0","typeLabel":"LengthDimension · object"},{"type":"null","uniqueKey":"offers.items.[INDEX].dimensions.oneOf.0.length.oneOf.1","typeLabel":"null"}],"uniqueKey":"offers.items.[INDEX].dimensions.oneOf.0.length","typeLabel":"LengthDimension · object | null"},"width":{"oneOf":[{"type":"object","title":"LengthDimension","description":"A length measurement, in one of the supported length units.","required":["number","unit"],"properties":{"number":{"type":"number","title":"Number","isRequired":true,"uniqueKey":"offers.items.[INDEX].dimensions.oneOf.0.width.oneOf.0.number","typeLabel":"number"},"unit":{"type":"string","enum":["mm","cm","m","in","ft"],"title":"LengthUnit","description":"The unit from the request's dimension filters when one was given (the value is converted to it); otherwise the unit the merchant stated.","isRequired":true,"uniqueKey":"offers.items.[INDEX].dimensions.oneOf.0.width.oneOf.0.unit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"offers.items.[INDEX].dimensions.oneOf.0.width.oneOf.0","typeLabel":"LengthDimension · object"},{"type":"null","uniqueKey":"offers.items.[INDEX].dimensions.oneOf.0.width.oneOf.1","typeLabel":"null"}],"uniqueKey":"offers.items.[INDEX].dimensions.oneOf.0.width","typeLabel":"LengthDimension · object | null"},"height":{"oneOf":[{"type":"object","title":"LengthDimension","description":"A length measurement, in one of the supported length units.","required":["number","unit"],"properties":{"number":{"type":"number","title":"Number","isRequired":true,"uniqueKey":"offers.items.[INDEX].dimensions.oneOf.0.height.oneOf.0.number","typeLabel":"number"},"unit":{"type":"string","enum":["mm","cm","m","in","ft"],"title":"LengthUnit","description":"The unit from the request's dimension filters when one was given (the value is converted to it); otherwise the unit the merchant stated.","isRequired":true,"uniqueKey":"offers.items.[INDEX].dimensions.oneOf.0.height.oneOf.0.unit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"offers.items.[INDEX].dimensions.oneOf.0.height.oneOf.0","typeLabel":"LengthDimension · object"},{"type":"null","uniqueKey":"offers.items.[INDEX].dimensions.oneOf.0.height.oneOf.1","typeLabel":"null"}],"uniqueKey":"offers.items.[INDEX].dimensions.oneOf.0.height","typeLabel":"LengthDimension · object | null"},"weight":{"oneOf":[{"type":"object","title":"WeightDimension","description":"A weight measurement, in one of the supported weight units.","required":["number","unit"],"properties":{"number":{"type":"number","title":"Number","isRequired":true,"uniqueKey":"offers.items.[INDEX].dimensions.oneOf.0.weight.oneOf.0.number","typeLabel":"number"},"unit":{"type":"string","enum":["mg","g","kg","oz","lb"],"title":"WeightUnit","description":"The unit from the request's dimension filters when one was given (the value is converted to it); otherwise the unit the merchant stated.","isRequired":true,"uniqueKey":"offers.items.[INDEX].dimensions.oneOf.0.weight.oneOf.0.unit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"offers.items.[INDEX].dimensions.oneOf.0.weight.oneOf.0","typeLabel":"WeightDimension · object"},{"type":"null","uniqueKey":"offers.items.[INDEX].dimensions.oneOf.0.weight.oneOf.1","typeLabel":"null"}],"uniqueKey":"offers.items.[INDEX].dimensions.oneOf.0.weight","typeLabel":"WeightDimension · object | null"}},"uniqueKey":"offers.items.[INDEX].dimensions.oneOf.0","typeLabel":"Dimensions · object"},{"type":"null","description":"Physical dimensions of this offer. Null when unknown.","uniqueKey":"offers.items.[INDEX].dimensions.oneOf.1","typeLabel":"null"}],"uniqueKey":"offers.items.[INDEX].dimensions","typeLabel":"Dimensions · object | null"}},"type":"object","required":["url","domain","price","availability"],"title":"ProductOffer","uniqueKey":"offers.items.[INDEX]","typeLabel":"ProductOffer · object"},"type":"array","title":"Offers","description":"All merchant offers for this product in the requested locale.","uniqueKey":"offers","typeLabel":"ProductOffer · object[]"},"variants":{"oneOf":[{"type":"object","title":"Variants","description":"Variant interaction state — options, selected. Absent when the product has no variations.","required":["options","selected"],"properties":{"options":{"items":{"properties":{"name":{"type":"string","title":"Name","description":"The name of the option (e.g. 'Color', 'Size')","isRequired":true,"uniqueKey":"variants.oneOf.0.options.items.[INDEX].name","typeLabel":"string"},"values":{"items":{"properties":{"label":{"type":"string","title":"Label","description":"The display value of the option value (e.g. 'Blue')","isRequired":true,"uniqueKey":"variants.oneOf.0.options.items.[INDEX].values.items.[INDEX].label","typeLabel":"string"},"exists":{"type":"boolean","title":"Exists","description":"Whether the option value exists on the product, or is a configuration only present on another variant of the same product. For example, a shirt that comes in multiple colors, but only one color is available in Size XL.","isRequired":true,"uniqueKey":"variants.oneOf.0.options.items.[INDEX].values.items.[INDEX].exists","typeLabel":"boolean"},"available":{"oneOf":[{"type":"string","title":"OfferAvailabilityStatus","description":"The availability status of the option value. None when returned on search results, hydrated only on get product detail requests.","enum":["InStock","OutOfStock"],"uniqueKey":"variants.oneOf.0.options.items.[INDEX].values.items.[INDEX].available.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The availability status of the option value. None when returned on search results, hydrated only on get product detail requests.","uniqueKey":"variants.oneOf.0.options.items.[INDEX].values.items.[INDEX].available.oneOf.1","typeLabel":"null"}],"uniqueKey":"variants.oneOf.0.options.items.[INDEX].values.items.[INDEX].available","typeLabel":"enum\u003cstring> | null"},"thumbnail_url":{"oneOf":[{"type":"string","title":"Thumbnail Url","description":"For options that reference different products, this is the URL of the thumbnail image for the option value. E.g., a shoe that comes in multiple colors will have an OptionValue for each color with a thumbnail_url set.","uniqueKey":"variants.oneOf.0.options.items.[INDEX].values.items.[INDEX].thumbnail_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Thumbnail Url","description":"For options that reference different products, this is the URL of the thumbnail image for the option value. E.g., a shoe that comes in multiple colors will have an OptionValue for each color with a thumbnail_url set.","uniqueKey":"variants.oneOf.0.options.items.[INDEX].values.items.[INDEX].thumbnail_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"variants.oneOf.0.options.items.[INDEX].values.items.[INDEX].thumbnail_url","typeLabel":"string | null"},"product_id":{"oneOf":[{"type":"string","title":"Product Id","description":"The product id that represents this value. Variants that point to different products will have this field set, as well as thumbnail_url for displaying selector icons.","uniqueKey":"variants.oneOf.0.options.items.[INDEX].values.items.[INDEX].product_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Product Id","description":"The product id that represents this value. Variants that point to different products will have this field set, as well as thumbnail_url for displaying selector icons.","uniqueKey":"variants.oneOf.0.options.items.[INDEX].values.items.[INDEX].product_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"variants.oneOf.0.options.items.[INDEX].values.items.[INDEX].product_id","typeLabel":"string | null"}},"type":"object","required":["label","exists"],"title":"OptionValue","description":"One value of one variant option (e.g. 'Blue' under 'Color')","uniqueKey":"variants.oneOf.0.options.items.[INDEX].values.items.[INDEX]","typeLabel":"OptionValue · object"},"type":"array","title":"Values","description":"The values of the option (e.g. ['Blue', 'Red', 'Green'])","isRequired":true,"uniqueKey":"variants.oneOf.0.options.items.[INDEX].values","typeLabel":"OptionValue · object[]"}},"type":"object","required":["name","values"],"title":"VariantOption","description":"One dimension of a product family (e.g. 'Color', 'Size').","uniqueKey":"variants.oneOf.0.options.items.[INDEX]","typeLabel":"VariantOption · object"},"type":"array","title":"Options","isRequired":true,"uniqueKey":"variants.oneOf.0.options","typeLabel":"VariantOption · object[]"},"selected":{"items":{"properties":{"name":{"type":"string","title":"Name","description":"The name of the selected option (e.g. 'Color', 'Size')","isRequired":true,"uniqueKey":"variants.oneOf.0.selected.items.[INDEX].name","typeLabel":"string"},"label":{"type":"string","title":"Label","description":"The display value of the selected option (e.g. 'Blue', 'XL')","isRequired":true,"uniqueKey":"variants.oneOf.0.selected.items.[INDEX].label","typeLabel":"string"}},"type":"object","required":["name","label"],"title":"SelectedOption","description":"One effective selection on a product, post server-side relaxation.","uniqueKey":"variants.oneOf.0.selected.items.[INDEX]","typeLabel":"SelectedOption · object"},"type":"array","title":"Selected","isRequired":true,"uniqueKey":"variants.oneOf.0.selected","typeLabel":"SelectedOption · object[]"}},"uniqueKey":"variants.oneOf.0","typeLabel":"Variants · object"},{"type":"null","description":"Variant interaction state — options, selected. Absent when the product has no variations.","uniqueKey":"variants.oneOf.1","typeLabel":"null"}],"uniqueKey":"variants","typeLabel":"Variants · object | null"},"structured_attributes":{"additionalProperties":{"items":{"type":"string","uniqueKey":"structured_attributes.additionalProperties.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"structured_attributes.additionalProperties","typeLabel":"string[]"},"type":"object","title":"Structured Attributes","description":"Structured attributes extracted for this product, keyed by attribute handle (e.g. 'color', 'material'). Values are the canonical allowed values for that handle.","uniqueKey":"structured_attributes","typeLabel":"Structured Attributes · object"},"ratings":{"oneOf":[{"type":"object","title":"ProductRatings","description":"Cross-merchant rating rollup. Null when no merchant has a usable product rating.","required":["value","count","source_count"],"properties":{"value":{"type":"number","title":"Value","description":"Average on a 0–5 scale, weighted by each merchant's review count.","isRequired":true,"uniqueKey":"ratings.oneOf.0.value","typeLabel":"number"},"count":{"type":"integer","title":"Count","description":"Total review count after collapsing identical merchant pools.","isRequired":true,"uniqueKey":"ratings.oneOf.0.count","typeLabel":"integer"},"source_count":{"type":"integer","title":"Source Count","description":"Distinct merchant rating pools that contributed.","isRequired":true,"uniqueKey":"ratings.oneOf.0.source_count","typeLabel":"integer"}},"uniqueKey":"ratings.oneOf.0","typeLabel":"ProductRatings · object"},{"type":"null","description":"Cross-merchant rating rollup. Null when no merchant has a usable product rating.","uniqueKey":"ratings.oneOf.1","typeLabel":"null"}],"uniqueKey":"ratings","typeLabel":"ProductRatings · object | null"}},"type":"object","required":["id","title"],"title":"Product","description":"Product with detailed information.","uniqueKey":"","typeLabel":"Product · object","example":{"title":"Example","value":{"id":"\u003cstring>","title":"\u003cstring>","description":"\u003cstring>","brands":[{"id":"\u003cstring>","name":"\u003cstring>"}],"images":[],"category":{"slug":"\u003cstring>","title":"\u003cstring>","has_children":true,"path":[{"slug":"\u003cstring>","title":"\u003cstring>"}]},"materials":["\u003cstring>"],"key_features":["\u003cstring>"],"colors":[{"hex":"\u003cstring>","percentage":123}],"offers":[{"url":"\u003cstring>","domain":"\u003cstring>","price":{"price":123,"currency":"\u003cstring>","compare_at_price":123},"max_commission_rate":0,"dimensions":{"length":{"number":123},"width":{"number":123},"height":{"number":123},"weight":{"number":123}}}],"variants":{"options":[{"name":"\u003cstring>","values":[{"label":"\u003cstring>","exists":true,"thumbnail_url":"\u003cstring>","product_id":"\u003cstring>"}]}],"selected":[{"name":"\u003cstring>","label":"\u003cstring>"}]},"structured_attributes":{},"ratings":{"value":123,"count":123,"source_count":123}}}},"originalFileLocation":"openapi/openapi.json"},"subdomain":"channel3","siteName":"Channel3","title":"Product - Channel3","contextualStarterQuestions":[{"_id":"6af25db6457542f7c73861de","deploymentId":"68197fcc6a8a4c211f25fc1f","questionText":"What fields does product have?","status":"active","generatedBy":"contextual","path":"product-model","createdAt":"2026-11-09T23:56:38.037Z","updatedAt":"2026-11-09T23:56:38.037Z","__v":0},{"_id":"6af25db6457542f7c73861dc","deploymentId":"68197fcc6a8a4c211f25fc1f","questionText":"What is a product model?","status":"active","generatedBy":"contextual","path":"product-model","createdAt":"2026-11-09T23:56:38.037Z","updatedAt":"2026-11-09T23:56:38.037Z","__v":0},{"_id":"6af25db6457542f7c73861dd","deploymentId":"68197fcc6a8a4c211f25fc1f","questionText":"How do I create a product?","status":"active","generatedBy":"contextual","path":"product-model","createdAt":"2026-11-09T23:56:38.037Z","updatedAt":"2026-11-09T23:56:38.037Z","__v":0}],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-09T23:56:31.084Z","originalFileLocation":"product-model.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=\"application-name\" content=\"Channel3\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/channel3/J4Ecdkdi6GezgyFh/_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=\"/docs/mintlify-assets/_mintlify/favicons/channel3/J4Ecdkdi6GezgyFh/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/channel3/J4Ecdkdi6GezgyFh/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/channel3/J4Ecdkdi6GezgyFh/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/channel3/J4Ecdkdi6GezgyFh/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/channel3/J4Ecdkdi6GezgyFh/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/channel3/J4Ecdkdi6GezgyFh/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/channel3/J4Ecdkdi6GezgyFh/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/channel3/J4Ecdkdi6GezgyFh/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Product - Channel3\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Channel3\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://channel3.mintlify.dev/docs/product-model\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://channel3.mintlify.site/docs/_mintlify/api/og/v2?division=Models\u0026amp;title=Product\u0026amp;theme=3e46104af545c2aa15a9a043\u0026amp;signature=f1fc61704605c70cbad872e3b344b24f089454d0640bf285b59c380cbfdf90a1\">\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=\"Product - Channel3\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://channel3.mintlify.site/docs/_mintlify/api/og/v2?division=Models\u0026amp;title=Product\u0026amp;theme=3e46104af545c2aa15a9a043\u0026amp;signature=f1fc61704605c70cbad872e3b344b24f089454d0640bf285b59c380cbfdf90a1\">\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=\"/docs/mintlify-assets/_mintlify/favicons/channel3/J4Ecdkdi6GezgyFh/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Channel3\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6F96B5\">\u003clink data-mint-head rel=\"canonical\" href=\"https://channel3.mintlify.dev/docs/product-model\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/product-model.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://channel3.mintlify.dev/#organization\",\"name\":\"Channel3\",\"url\":\"https://channel3.mintlify.dev\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/channel3/MdbRmpXO6ogT4w7g/logo/channel3-logo-wide-light.svg?fit=max\u0026auto=format\u0026n=MdbRmpXO6ogT4w7g\u0026q=85\u0026s=d23a7735ff07b0e7ad75f84ecffc413e\"}},{\"@type\":\"WebSite\",\"@id\":\"https://channel3.mintlify.dev/docs#website\",\"name\":\"Channel3\",\"url\":\"https://channel3.mintlify.dev/docs\",\"publisher\":{\"@id\":\"https://channel3.mintlify.dev/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://channel3.mintlify.dev/docs/product-model#webpage\",\"url\":\"https://channel3.mintlify.dev/docs/product-model\",\"name\":\"Product\",\"dateModified\":\"2026-11-09T23:56:31.084Z\",\"isPartOf\":{\"@id\":\"https://channel3.mintlify.dev/docs#website\"},\"breadcrumb\":{\"@id\":\"https://channel3.mintlify.dev/docs/product-model#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://channel3.mintlify.dev/docs/product-model#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Channel3\",\"item\":\"https://channel3.mintlify.dev/docs\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Product\",\"item\":\"https://channel3.mintlify.dev/docs/product-model\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://channel3.mintlify.dev/docs/product-model#apireference\",\"headline\":\"Product\",\"name\":\"Product\",\"url\":\"https://channel3.mintlify.dev/docs/product-model\",\"mainEntityOfPage\":{\"@id\":\"https://channel3.mintlify.dev/docs/product-model#webpage\"},\"dateModified\":\"2026-11-09T23:56:31.084Z\",\"publisher\":{\"@id\":\"https://channel3.mintlify.dev/#organization\"},\"isPartOf\":{\"@id\":\"https://channel3.mintlify.dev/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Channel3\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Channel3\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/docs/product-model.md","siteName":"Channel3","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API Reference","groups":[{"group":"Products","pages":[{"openapi":"post /v1/search","title":"Search","href":"/api-reference/v1/search"},{"openapi":"post /v1/image-search","title":"Image Search","href":"/api-reference/v1/image-search"},{"openapi":"post /experimental/find-products-in-image","title":"Find products in an image","href":"/api-reference/v1/find-products-in-image"},{"openapi":"post /experimental/sticker","title":"Get a product sticker","href":"/api-reference/v1/sticker"},{"openapi":"post /v1/similar","title":"Similar Products","href":"/api-reference/v1/similar-products"},{"openapi":"get /v1/products/{product_id}","title":"Product Detail","href":"/api-reference/v1/product-detail"},{"openapi":"post /v1/lookup","title":"Lookup Product","href":"/api-reference/v1/lookup-product"},{"openapi":"post /v1/browse","title":"Browse","href":"/api-reference/v1/browse"}]},{"group":"Product Reviews","pages":[{"openapi":"post /v1/products/{product_id}/reviews","title":"Submit a product review","href":"/api-reference/v1/submit-product-review"},{"openapi":"get /v1/products/{product_id}/reviews","title":"List product reviews","href":"/api-reference/v1/list-product-reviews"}]},{"group":"Conversational Agent","pages":[{"title":"Create Turn","openapi":"post /v1/conversations","href":"/api-reference/v1/create-turn"},{"title":"Create Client Token","openapi":"post /v1/conversations/client_tokens","href":"/api-reference/v1/create-client-token"},{"title":"Revoke Client Token","openapi":"post /v1/conversations/client_tokens/revoke","href":"/api-reference/v1/revoke-client-token"},{"title":"Get Conversation","openapi":"get /v1/conversations/{conversation_id}","href":"/api-reference/v1/get-conversation"}]},{"group":"Collections","pages":[{"openapi":"post /v1/collections","title":"Create Collection","href":"/api-reference/v1/create-collection"},{"openapi":"get /v1/collections","title":"List Collections","href":"/api-reference/v1/list-collections"},{"openapi":"get /v1/collections/{collection_id}","title":"Get Collection","href":"/api-reference/v1/get-collection"},{"openapi":"patch /v1/collections/{collection_id}","title":"Patch Collection","href":"/api-reference/v1/update-collection"},{"openapi":"delete /v1/collections/{collection_id}","title":"Delete Collection","href":"/api-reference/v1/delete-collection"}]},{"group":"Brands","pages":[{"openapi":"get /v1/brands/search","title":"Search Brands","href":"/api-reference/v1/search-brands"},{"openapi":"get /v1/brands","title":"List Brands","href":"/api-reference/v1/list-brands"},{"openapi":"get /v1/brands/{brand_id}","title":"Brand Detail","href":"/api-reference/v1/brand-detail"}]},{"group":"Categories","pages":[{"title":"Category Explorer","href":"/categories"},{"openapi":"get /v1/categories/search","title":"Search Categories","href":"/api-reference/v1/search-categories"},{"openapi":"get /v1/categories","title":"List Categories","href":"/api-reference/v1/list-categories"},{"openapi":"get /v1/categories/{slug}","title":"Category Detail","href":"/api-reference/v1/category-detail"}]},{"group":"Websites","pages":[{"openapi":"get /v1/websites/search","title":"Search Websites","href":"/api-reference/v1/search-websites"},{"openapi":"get /v1/websites","title":"List Websites","href":"/api-reference/v1/list-websites"},{"openapi":"get /v1/websites/{website_id}","title":"Website Detail","href":"/api-reference/v1/website-detail"},{"openapi":"get /v0/websites","title":"Websites","href":"/api-reference/channel3-api/websites"}]},{"group":"Reporting","pages":[{"openapi":"get /v1/reporting/clicks","title":"List Clicks","href":"/api-reference/v1/reporting-clicks"},{"openapi":"get /v1/reporting/transactions","title":"List Transactions","href":"/api-reference/v1/reporting-transactions"},{"openapi":"get /v1/reporting/usage","title":"Get API Usage","href":"/api-reference/v1/reporting-usage"},{"openapi":"post /v1/reporting/feedback","title":"Submit feedback","href":"/api-reference/v1/submit-feedback"}]},{"group":"Price \u0026 Availability","pages":[{"openapi":"post /v1/product-subscriptions","title":"Create Product Subscription","href":"/api-reference/product-subscriptions/create-subscription"},{"openapi":"get /v1/product-subscriptions","title":"List Product Subscriptions","href":"/api-reference/product-subscriptions/list-subscriptions"},{"openapi":"get /v1/product-subscriptions/{subscription_id}","title":"Get Product Subscription","href":"/api-reference/product-subscriptions/get-subscription"},{"openapi":"delete /v1/product-subscriptions/{subscription_id}","title":"Cancel Product Subscription","href":"/api-reference/product-subscriptions/cancel-subscription"},{"title":"Product Subscription Webhooks","icon":"webhook","href":"/product-subscription-webhooks"},{"openapi":"get /v0/price-tracking/history/{canonical_product_id}","title":"Get Price History","href":"/api-reference/price-tracking/get-price-history"},{"openapi":"post /v0/price-tracking/start","deprecated":true,"title":"Start Tracking","href":"/api-reference/price-tracking/start-tracking"},{"openapi":"post /v0/price-tracking/stop","deprecated":true,"title":"Stop Tracking","href":"/api-reference/price-tracking/stop-tracking"},{"openapi":"get /v0/price-tracking/subscriptions","deprecated":true,"title":"List Subscriptions","href":"/api-reference/price-tracking/list-subscriptions"},{"title":"Price Tracking Webhooks","icon":"webhook","href":"/price-tracking-webhooks"}]},{"group":"Webhooks","pages":[{"title":"offer.created","openapi":"webhook offer.created","href":"/api-reference/webhooks/offer-created"},{"title":"offer.price.changed","openapi":"webhook offer.price.changed","href":"/api-reference/webhooks/offer-price-changed"},{"title":"offer.availability.changed","openapi":"webhook offer.availability.changed","href":"/api-reference/webhooks/offer-availability-changed"},{"title":"offer.deleted","openapi":"webhook offer.deleted","href":"/api-reference/webhooks/offer-deleted"},{"title":"price.changed","openapi":"webhook price.changed","description":"Triggered when the price changes for a product you're tracking.","href":"/api-reference/webhooks/price-changed"}]},{"group":"Models","pages":[{"title":"Product","icon":"cube","href":"/product-model"},{"title":"Category","icon":"sitemap","description":null,"href":"/api-reference/category-model"},{"title":"Brand","icon":"tag","href":"/api-reference/brand-model"},{"title":"Website","icon":"store","href":"/api-reference/website-model"}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog/announcements/update-7-component-library"}]}]},"basePath":"","title":"Product - Channel3","deploymentId":"dpl_53YqbBPsHdrqSGqXiWPGU7csRVod","buildId":"dpl_53YqbBPsHdrqSGqXiWPGU7csRVod","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Ku9dSkH0.js","snippetPresets-Cjez4eet.js","utils-BqNa-fnS.js","style-to-object-BY3JEAdk.js","utils-DiE92JCe.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-Bi0DpqVf.js","conditional-requirements-CFM0id0Q.js","cloneDeep-C6xnxscF.js","_Uint8Array-B7g0OYAt.js","isObject-FP1Yky1u.js","ApiExamples-Bf8Ecb5t.js","usePlaygroundInputsStore-BA942cq6.js","shallow-D0sePNkF.js","isEqual-CnnQO8sL.js","CodeSnippets-BTANoy1T.js","CodeSnippet-CTZvgJfu.js","getApiPlaygroundDisplay-BK2o1XYu.js","Page--B9YZ09u.js","DynamicMarkdown-CsgNpZb1.js","SectionHeading-C3K437Dy.js","icon-DlxjjqnB.js","MethodPill-Cr7Ib9nN.js","getPastedJson-DXo3wtHt.js","Check2Icon-ChEI-f_B.js","axios-CsQoIw0U.js","Markdown-CH4mv0N8.js","AssistantPageLink-BHjmqccN.js","dist-DYCPzQwJ.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}