Retrieve a collection’s details. Automation API only.To access the products in a collection, traverse:
collection > published_version > collection_categories > collection_products > product.
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Goody Developers","description":"Build on Goody: send gifts and physical products programmatically with the Goody API, or gift in natural language from Claude and other AI assistants with the Goody MCP server.","colors":{"primary":"#9159D6","light":"#B584F1","dark":"#9159D6"},"logo":{"light":"https://mintcdn.com/goody/UtvUnxw3LhFrdzGW/logo.svg?fit=max\u0026auto=format\u0026n=UtvUnxw3LhFrdzGW\u0026q=85\u0026s=271862d59190ae3cec0a504caf00f0dc","dark":"https://mintcdn.com/goody/UtvUnxw3LhFrdzGW/logo.svg?fit=max\u0026auto=format\u0026n=UtvUnxw3LhFrdzGW\u0026q=85\u0026s=271862d59190ae3cec0a504caf00f0dc"},"favicon":"https://mintcdn.com/goody/UtvUnxw3LhFrdzGW/favicon.png?fit=max\u0026auto=format\u0026n=UtvUnxw3LhFrdzGW\u0026q=85\u0026s=974bb2155b182f71382074bbbd8d109c","api":{"openapi":"goody-api-openapi.json","mdx":{"auth":{"method":"bearer"},"server":"https://api.ongoody.com"}},"navbar":{"links":[{"href":"https://www.ongoody.com/plus/organization/api/commerce","label":"Commerce API Keys"},{"href":"https://www.ongoody.com/plus/organization/api/automation","label":"Automation API Keys"}]},"footer":{"socials":{"twitter":"https://twitter.com/goodygifting","linkedin":"https://www.linkedin.com/company/ongoody","instagram":"https://instagram.com/ongoody"}},"seo":{"metatags":{"og:site_name":"Goody Developers","twitter:card":"summary_large_image","keywords":"Goody API, Goody MCP server, gifting API, gift API, MCP server, send gifts with AI, Claude gifting connector, business gifting, autogift"}},"integrations":{"ga4":{"measurementId":"G-7CST37MNCX"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"goody","hasAudioNarration":false,"actualSubdomain":"goody","customDomains":["developer.ongoody.com"],"gitSource":{"type":"github","owner":"mark-goody","repo":"api-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ac7a8825b1873d75a499d88","collectionId":"f8a426a1-1ab1-423e-bb23-3c796a6f3de8","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ac7a8825b1873d75a499d88"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ac7a8825b1873d75a499d88","clientVersion":"0.0.3990","searchFilterCounts":[{"language":"default","tag":"Schemas","count":46},{"language":"default","tag":"API Reference","count":44},{"language":"default","tag":"Documentation","count":38},{"language":"default","tag":"MCP Reference","count":31},{"language":"default","tag":"Webhooks","count":12},{"language":"default","tag":"Events","count":10},{"language":"default","tag":"Commerce API","count":8},{"language":"default","tag":"Automation API","count":7},{"language":"default","tag":"Send \u0026 track gifts","count":7},{"language":"default","tag":"Order Batches","count":6}]},"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":"editor-v7-file-tree","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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"editor-agent-model-picker","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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/collections/retrieve-a-collection","slug":"/api-reference/collections/retrieve-a-collection","pageMetadata":{"openapi":"GET /v1/collections/{id}","title":"Retrieve a collection","description":null,"href":"/api-reference/collections/retrieve-a-collection"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,..._provideComponents(),...props.components};return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Retrieve a collection’s details. Automation API only.`}),`\n`,_jsx(_components.p,{children:`To access the products in a collection, traverse:\ncollection > published_version > collection_categories > collection_products > product.`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"GET /v1/collections/{id}","title":"Retrieve a collection","description":null,"href":"/api-reference/collections/retrieve-a-collection"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Retrieve a collection","tags":["Collections"],"security":["096d6789-7d32-4a51-b3e7-7b56b6f14f7f"],"parameters":["9aa7fe6d-a27a-4205-9c08-0c5dc45b87fc"],"responses":{"200":"5bf59a86-da0b-4c8e-aa62-645ef1f75616","404":"1974125a-cffc-420f-a332-3525b0257d63"},"method":"get","type":"path","servers":["4a853b92-1c76-4ffd-85bf-5a5539f2953d","dd210492-7675-40b8-833a-2901e08fdf59"],"path":"/v1/collections/{id}","baseUrlOptions":["https://api.ongoody.com","https://api.sandbox.ongoody.com"],"title":"Retrieve a collection","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"9aa7fe6d-a27a-4205-9c08-0c5dc45b87fc":{"name":"id","in":"path","description":"Collection ID","required":true,"schema":{"type":"string","isRequired":true,"description":"Collection ID","uniqueKey":"","typeLabel":"string"}}},"responses":{"5bf59a86-da0b-4c8e-aa62-645ef1f75616":{"description":"Collection retrieved successfully","content":{"application/json":{"examples":{"Collection retrieved successfully":{"title":"Collection retrieved successfully","value":{"id":"7f50f2ba-e070-4e33-a107-3ddfe4c771dc","workspace_id":"633e3b64-1ab4-4439-b44a-8c3a069cfd76","title":"Office Favorites","is_published":true,"published_price":null,"product":null,"published_version":{"id":"3b6af2d7-74e3-4201-8dfc-88cfacbdde91","title":"Office Favorites","subtitle":"Curated treats for the whole team","multiple_select_mode":"disabled","multiple_select_count":null,"multiple_select_price":null,"international_shipping_tier":"standard","international_gift_cards_enabled":false,"display_interface":"single_page","header_image":null,"collection_categories":[{"id":"ed3c56cd-d90c-4815-8caf-fd4c79b7fd46","name":"Treats \u0026 Sips","is_featured":true,"position":1,"collection_products":[{"id":"a7fe8bd9-3023-4037-8cc4-60e141f00e62","product":{"id":"e2b9f659-e01e-430b-aa16-14a22158cd36","name":"Craft Coffee Kit","brand":{"id":"7141fe00-a619-41c5-ac6a-b54342412f6d","name":"Cookie Company","logo_image":null,"shipping_price":1000,"free_shipping_minimum":null,"brand_values":[]},"subtitle":null,"subtitle_short":null,"recipient_description":"","variants_label":null,"variants_num_selectable":null,"variants":[],"variant_groups":[],"images":[],"price":1000,"price_is_variable":false,"restricted_states":[],"attributes":[],"updated_at":"2026-06-03T12:24:04Z","status":"active"}},{"id":"3ceb6404-75ed-4be7-a022-e4afdf078749","product":{"id":"bae8372a-4325-4c5c-b58d-57e8f0a891ad","name":"Artisan Snack Box","brand":{"id":"7141fe00-a619-41c5-ac6a-b54342412f6d","name":"Cookie Company","logo_image":null,"shipping_price":1000,"free_shipping_minimum":null,"brand_values":[]},"subtitle":null,"subtitle_short":null,"recipient_description":"","variants_label":null,"variants_num_selectable":null,"variants":[],"variant_groups":[],"images":[],"price":1000,"price_is_variable":false,"restricted_states":[],"attributes":[],"updated_at":"2026-06-03T12:24:04Z","status":"active"}}]}]}}}},"schema":{"type":"object","description":"A collection is a curated group of products that recipients can select from.","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"workspace_id":{"type":"string","format":"uuid","description":"Workspace that owns this collection.","isRequired":true,"uniqueKey":"workspace_id","typeLabel":"string\u003cuuid>"},"is_published":{"type":"boolean","description":"Indicates whether the collection currently has a published version.","isRequired":true,"uniqueKey":"is_published","typeLabel":"boolean"},"title":{"oneOf":[{"type":"string","uniqueKey":"title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"title.oneOf.1","typeLabel":"null"}],"uniqueKey":"title","typeLabel":"string | null"},"published_price":{"oneOf":[{"type":"integer","description":"Price for the published collection in cents, including shipping.","uniqueKey":"published_price.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Price for the published collection in cents, including shipping.","uniqueKey":"published_price.oneOf.1","typeLabel":"null"}],"uniqueKey":"published_price","typeLabel":"integer | null"},"product":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"product.oneOf.0.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","isRequired":true,"uniqueKey":"product.oneOf.0.name","typeLabel":"string"},"brand":{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"product.oneOf.0.brand.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","isRequired":true,"uniqueKey":"product.oneOf.0.brand.name","typeLabel":"string"},"logo_image":{"oneOf":[{"type":"object","properties":{"url":{"type":"string","isRequired":true,"uniqueKey":"product.oneOf.0.brand.logo_image.oneOf.0.url","typeLabel":"string"},"width":{"type":"integer","uniqueKey":"product.oneOf.0.brand.logo_image.oneOf.0.width","typeLabel":"integer"},"height":{"type":"integer","uniqueKey":"product.oneOf.0.brand.logo_image.oneOf.0.height","typeLabel":"integer"}},"required":["url"],"description":"The logo image for this brand.","uniqueKey":"product.oneOf.0.brand.logo_image.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"],"description":"The logo image for this brand.","uniqueKey":"product.oneOf.0.brand.logo_image.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.oneOf.0.brand.logo_image","typeLabel":"object | null"},"shipping_price":{"type":"integer","description":"The price of shipping for this brand, in cents.","uniqueKey":"product.oneOf.0.brand.shipping_price","typeLabel":"integer"},"free_shipping_minimum":{"oneOf":[{"type":"integer","description":"When set and when the product price is above this amount, shipping is free. In cents. Products in a cart for this brand can combine to reach this threshold.","uniqueKey":"product.oneOf.0.brand.free_shipping_minimum.oneOf.0","typeLabel":"integer"},{"type":"null","description":"When set and when the product price is above this amount, shipping is free. In cents. Products in a cart for this brand can combine to reach this threshold.","uniqueKey":"product.oneOf.0.brand.free_shipping_minimum.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.oneOf.0.brand.free_shipping_minimum","typeLabel":"integer | null"},"commerce_revshare_excluded":{"oneOf":[{"type":"boolean","description":"Whether this brand is excluded from the commerce revenue share. Only displayed on the products endpoint when using a commerce app.","uniqueKey":"product.oneOf.0.brand.commerce_revshare_excluded.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether this brand is excluded from the commerce revenue share. Only displayed on the products endpoint when using a commerce app.","uniqueKey":"product.oneOf.0.brand.commerce_revshare_excluded.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.oneOf.0.brand.commerce_revshare_excluded","typeLabel":"boolean | null"},"brand_values":{"type":"array","items":{"type":"string","uniqueKey":"product.oneOf.0.brand.brand_values.items.[INDEX]","typeLabel":"string"},"description":"An array of brand values for this brand. Potential values are USA Made, Social Impact Driven, Sustainable, Gluten Free, Vegan, Kosher Certified, Female Founded, AAPI Founded, BIPOC Founded, Black Founded, LGBTQ+ Founded, and Hispanic Founded.","uniqueKey":"product.oneOf.0.brand.brand_values","typeLabel":"string[]"},"brand_sets":{"oneOf":[{"type":"array","items":{"type":"object","description":"A brand set represents a collection of products from a brand.","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"product.oneOf.0.brand.brand_sets.oneOf.0.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","isRequired":true,"uniqueKey":"product.oneOf.0.brand.brand_sets.oneOf.0.items.[INDEX].name","typeLabel":"string"},"images":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"product.oneOf.0.brand.brand_sets.oneOf.0.items.[INDEX].images.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"image_large":{"type":"object","properties":{"url":{"type":"string","isRequired":true,"uniqueKey":"product.oneOf.0.brand.brand_sets.oneOf.0.items.[INDEX].images.items.[INDEX].image_large.url","typeLabel":"string"},"width":{"type":"integer","uniqueKey":"product.oneOf.0.brand.brand_sets.oneOf.0.items.[INDEX].images.items.[INDEX].image_large.width","typeLabel":"integer"},"height":{"type":"integer","uniqueKey":"product.oneOf.0.brand.brand_sets.oneOf.0.items.[INDEX].images.items.[INDEX].image_large.height","typeLabel":"integer"}},"required":["url"],"isRequired":true,"uniqueKey":"product.oneOf.0.brand.brand_sets.oneOf.0.items.[INDEX].images.items.[INDEX].image_large","typeLabel":"object"}},"required":["id","image_large"],"uniqueKey":"product.oneOf.0.brand.brand_sets.oneOf.0.items.[INDEX].images.items.[INDEX]","typeLabel":"object"},"description":"An array of images for this brand set.","uniqueKey":"product.oneOf.0.brand.brand_sets.oneOf.0.items.[INDEX].images","typeLabel":"object[]"},"products":{"type":"array","items":{"$circularRef":"9d9f25a7-f907-4624-9ed1-9a9845688bbf"},"description":"An array of products in this brand set.","uniqueKey":"product.oneOf.0.brand.brand_sets.oneOf.0.items.[INDEX].products","typeLabel":"array"},"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"product.oneOf.0.brand.brand_sets.oneOf.0.items.[INDEX].categories.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","isRequired":true,"uniqueKey":"product.oneOf.0.brand.brand_sets.oneOf.0.items.[INDEX].categories.items.[INDEX].name","typeLabel":"string"},"subcategories":{"type":"array","items":{"type":"string","uniqueKey":"product.oneOf.0.brand.brand_sets.oneOf.0.items.[INDEX].categories.items.[INDEX].subcategories.items.[INDEX]","typeLabel":"string"},"description":"An array of subcategory names within this category.","uniqueKey":"product.oneOf.0.brand.brand_sets.oneOf.0.items.[INDEX].categories.items.[INDEX].subcategories","typeLabel":"string[]"}},"required":["id","name"],"uniqueKey":"product.oneOf.0.brand.brand_sets.oneOf.0.items.[INDEX].categories.items.[INDEX]","typeLabel":"object"},"description":"An array of categories this brand set belongs to.","uniqueKey":"product.oneOf.0.brand.brand_sets.oneOf.0.items.[INDEX].categories","typeLabel":"object[]"}},"required":["id","name"],"uniqueKey":"product.oneOf.0.brand.brand_sets.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"An array of brand sets for this brand. Only included when using the brands endpoint.","uniqueKey":"product.oneOf.0.brand.brand_sets.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","description":"A brand set represents a collection of products from a brand.","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"images":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"image_large":{"type":"object","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"]}},"required":["id","image_large"]},"description":"An array of images for this brand set."},"products":{"type":"array","items":{"$circularRef":"9d9f25a7-f907-4624-9ed1-9a9845688bbf"},"description":"An array of products in this brand set."},"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"subcategories":{"type":"array","items":{"type":"string"},"description":"An array of subcategory names within this category."}},"required":["id","name"]},"description":"An array of categories this brand set belongs to."}},"required":["id","name"]},"description":"An array of brand sets for this brand. Only included when using the brands endpoint.","uniqueKey":"product.oneOf.0.brand.brand_sets.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.oneOf.0.brand.brand_sets","typeLabel":"object[] | null"}},"required":["id","name"],"isRequired":true,"uniqueKey":"product.oneOf.0.brand","typeLabel":"object"},"variants":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"product.oneOf.0.variants.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","isRequired":true,"uniqueKey":"product.oneOf.0.variants.items.[INDEX].name","typeLabel":"string"},"image_large":{"oneOf":[{"type":"object","properties":{"url":{"type":"string","isRequired":true,"uniqueKey":"product.oneOf.0.variants.items.[INDEX].image_large.oneOf.0.url","typeLabel":"string"},"width":{"type":"integer","uniqueKey":"product.oneOf.0.variants.items.[INDEX].image_large.oneOf.0.width","typeLabel":"integer"},"height":{"type":"integer","uniqueKey":"product.oneOf.0.variants.items.[INDEX].image_large.oneOf.0.height","typeLabel":"integer"}},"required":["url"],"uniqueKey":"product.oneOf.0.variants.items.[INDEX].image_large.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"],"uniqueKey":"product.oneOf.0.variants.items.[INDEX].image_large.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.oneOf.0.variants.items.[INDEX].image_large","typeLabel":"object | null"},"subtitle":{"oneOf":[{"type":"string","uniqueKey":"product.oneOf.0.variants.items.[INDEX].subtitle.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"product.oneOf.0.variants.items.[INDEX].subtitle.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.oneOf.0.variants.items.[INDEX].subtitle","typeLabel":"string | null"}},"required":["id","name"],"uniqueKey":"product.oneOf.0.variants.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"product.oneOf.0.variants","typeLabel":"object[]"},"images":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"product.oneOf.0.images.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"image_large":{"type":"object","properties":{"url":{"type":"string","isRequired":true,"uniqueKey":"product.oneOf.0.images.items.[INDEX].image_large.url","typeLabel":"string"},"width":{"type":"integer","uniqueKey":"product.oneOf.0.images.items.[INDEX].image_large.width","typeLabel":"integer"},"height":{"type":"integer","uniqueKey":"product.oneOf.0.images.items.[INDEX].image_large.height","typeLabel":"integer"}},"required":["url"],"isRequired":true,"uniqueKey":"product.oneOf.0.images.items.[INDEX].image_large","typeLabel":"object"}},"required":["id","image_large"],"uniqueKey":"product.oneOf.0.images.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"product.oneOf.0.images","typeLabel":"object[]"},"price":{"type":"integer","description":"The price of the product, in cents.","isRequired":true,"uniqueKey":"product.oneOf.0.price","typeLabel":"integer"},"price_is_variable":{"type":"boolean","description":"Whether the price of this product is variable. If true, then the price can be set by the sender.","isRequired":true,"uniqueKey":"product.oneOf.0.price_is_variable","typeLabel":"boolean"},"restricted_states":{"type":"array","items":{"type":"string","description":"The US states that this product cannot be shipped to.","uniqueKey":"product.oneOf.0.restricted_states.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"product.oneOf.0.restricted_states","typeLabel":"string[]"},"subtitle":{"oneOf":[{"type":"string","description":"A description of this product.","uniqueKey":"product.oneOf.0.subtitle.oneOf.0","typeLabel":"string"},{"type":"null","description":"A description of this product.","uniqueKey":"product.oneOf.0.subtitle.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.oneOf.0.subtitle","typeLabel":"string | null"},"subtitle_short":{"oneOf":[{"type":"string","description":"An optional one-line description of this product. When provided, it overrides the subtitle when displayed in areas with less space. Not always provided.","uniqueKey":"product.oneOf.0.subtitle_short.oneOf.0","typeLabel":"string"},{"type":"null","description":"An optional one-line description of this product. When provided, it overrides the subtitle when displayed in areas with less space. Not always provided.","uniqueKey":"product.oneOf.0.subtitle_short.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.oneOf.0.subtitle_short","typeLabel":"string | null"},"recipient_description":{"oneOf":[{"type":"string","description":"An optional description of this product with custom verbiage for recipients. When provided, it overrides the subtitle for the product when displayed to the recipient. Falls back to the subtitle.","uniqueKey":"product.oneOf.0.recipient_description.oneOf.0","typeLabel":"string"},{"type":"null","description":"An optional description of this product with custom verbiage for recipients. When provided, it overrides the subtitle for the product when displayed to the recipient. Falls back to the subtitle.","uniqueKey":"product.oneOf.0.recipient_description.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.oneOf.0.recipient_description","typeLabel":"string | null"},"variants_label":{"oneOf":[{"type":"string","description":"The label for the variants of this product, e.g. \"Size\" or \"Color\".","uniqueKey":"product.oneOf.0.variants_label.oneOf.0","typeLabel":"string"},{"type":"null","description":"The label for the variants of this product, e.g. \"Size\" or \"Color\".","uniqueKey":"product.oneOf.0.variants_label.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.oneOf.0.variants_label","typeLabel":"string | null"},"variants_num_selectable":{"oneOf":[{"type":"integer","description":"The number of variants that can be selected for this product. For example, if this is a t-shirt, then this would be 1, since you can only select one size. If this were a build-a-box of chocolates, this could be 3 if you could select 3 flavor variants.","uniqueKey":"product.oneOf.0.variants_num_selectable.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of variants that can be selected for this product. For example, if this is a t-shirt, then this would be 1, since you can only select one size. If this were a build-a-box of chocolates, this could be 3 if you could select 3 flavor variants.","uniqueKey":"product.oneOf.0.variants_num_selectable.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.oneOf.0.variants_num_selectable","typeLabel":"integer | null"},"variant_groups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"product.oneOf.0.variant_groups.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","description":"The name of the variant group, e.g. \"Size\" or \"Color\".","isRequired":true,"uniqueKey":"product.oneOf.0.variant_groups.items.[INDEX].name","typeLabel":"string"},"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"product.oneOf.0.variant_groups.items.[INDEX].options.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","description":"The name of the variant group option, e.g. \"Small\" for the \"Size\" variant group.","isRequired":true,"uniqueKey":"product.oneOf.0.variant_groups.items.[INDEX].options.items.[INDEX].name","typeLabel":"string"},"subtitle":{"oneOf":[{"type":"string","uniqueKey":"product.oneOf.0.variant_groups.items.[INDEX].options.items.[INDEX].subtitle.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"product.oneOf.0.variant_groups.items.[INDEX].options.items.[INDEX].subtitle.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.oneOf.0.variant_groups.items.[INDEX].options.items.[INDEX].subtitle","typeLabel":"string | null"},"color":{"oneOf":[{"type":"string","description":"The hex color code for this option, e.g. \"#000000\", if any.","uniqueKey":"product.oneOf.0.variant_groups.items.[INDEX].options.items.[INDEX].color.oneOf.0","typeLabel":"string"},{"type":"null","description":"The hex color code for this option, e.g. \"#000000\", if any.","uniqueKey":"product.oneOf.0.variant_groups.items.[INDEX].options.items.[INDEX].color.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.oneOf.0.variant_groups.items.[INDEX].options.items.[INDEX].color","typeLabel":"string | null"},"image_large":{"oneOf":[{"type":"object","properties":{"url":{"type":"string","isRequired":true,"uniqueKey":"product.oneOf.0.variant_groups.items.[INDEX].options.items.[INDEX].image_large.oneOf.0.url","typeLabel":"string"},"width":{"type":"integer","uniqueKey":"product.oneOf.0.variant_groups.items.[INDEX].options.items.[INDEX].image_large.oneOf.0.width","typeLabel":"integer"},"height":{"type":"integer","uniqueKey":"product.oneOf.0.variant_groups.items.[INDEX].options.items.[INDEX].image_large.oneOf.0.height","typeLabel":"integer"}},"required":["url"],"uniqueKey":"product.oneOf.0.variant_groups.items.[INDEX].options.items.[INDEX].image_large.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"],"uniqueKey":"product.oneOf.0.variant_groups.items.[INDEX].options.items.[INDEX].image_large.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.oneOf.0.variant_groups.items.[INDEX].options.items.[INDEX].image_large","typeLabel":"object | null"}},"required":["id","name"],"uniqueKey":"product.oneOf.0.variant_groups.items.[INDEX].options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"product.oneOf.0.variant_groups.items.[INDEX].options","typeLabel":"object[]"}},"required":["id","name"],"uniqueKey":"product.oneOf.0.variant_groups.items.[INDEX]","typeLabel":"object"},"description":"For products that have multiple types of variants, such as both Color and Size, this array contains each group and the options for each group. All variant group permutations have a variant generated for them, constructed from the options in the order of the groups, separated by ` / `, e.g. `Medium / Black` when the groups are Size and Color.","uniqueKey":"product.oneOf.0.variant_groups","typeLabel":"object[]"},"price_min":{"oneOf":[{"type":"integer","description":"The minimum price of the product, in cents. Only used if price_is_variable is true.","uniqueKey":"product.oneOf.0.price_min.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The minimum price of the product, in cents. Only used if price_is_variable is true.","uniqueKey":"product.oneOf.0.price_min.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.oneOf.0.price_min","typeLabel":"integer | null"},"price_max":{"oneOf":[{"type":"integer","description":"The maximum price of the product, in cents. Only used if price_is_variable is true.","uniqueKey":"product.oneOf.0.price_max.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The maximum price of the product, in cents. Only used if price_is_variable is true.","uniqueKey":"product.oneOf.0.price_max.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.oneOf.0.price_max","typeLabel":"integer | null"},"attributes":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","description":"The label for this attribute, e.g. \"Materials\".","isRequired":true,"uniqueKey":"product.oneOf.0.attributes.items.[INDEX].label","typeLabel":"string"},"content":{"type":"string","description":"The content for this attribute, e.g. \"80% cotton, 20% elastane\". This can be text or sanitized HTML (you might choose to sanitize the HTML as well). Allowed elements are a (href allowed), div, img (src, width height, alt allowed), span, p, br, strong, b, em, i, ol, ul, li, and hr.","isRequired":true,"uniqueKey":"product.oneOf.0.attributes.items.[INDEX].content","typeLabel":"string"}},"required":["label","content"],"uniqueKey":"product.oneOf.0.attributes.items.[INDEX]","typeLabel":"object"},"description":"An array of attributes that describe this product.","uniqueKey":"product.oneOf.0.attributes","typeLabel":"object[]"},"status":{"type":"string","enum":["active","inactive"],"description":"Whether this product is active. Since the product catalog only returns active products by default, this is always `true`, except if you are a Commerce API customer using a custom catalog, and are pulling products with the `custom_catalog_show_inactive` flag.","uniqueKey":"product.oneOf.0.status","typeLabel":"enum\u003cstring>"},"updated_at":{"type":"string","format":"date-time","description":"The date and time this product was last updated, ISO 8601 format. This is bumped when the product, brand, product variants, product attributes, or product images are updated.","uniqueKey":"product.oneOf.0.updated_at","typeLabel":"string\u003cdate-time>"},"reserved_options":{"oneOf":[{"type":"object","description":"For approved API partners only.","properties":{"custom_price_tier":{"oneOf":[{"type":"integer","description":"For approved API partners only. A custom price tier for this product.","uniqueKey":"product.oneOf.0.reserved_options.oneOf.0.custom_price_tier.oneOf.0","typeLabel":"integer"},{"type":"null","description":"For approved API partners only. A custom price tier for this product.","uniqueKey":"product.oneOf.0.reserved_options.oneOf.0.custom_price_tier.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.oneOf.0.reserved_options.oneOf.0.custom_price_tier","typeLabel":"integer | null"}},"uniqueKey":"product.oneOf.0.reserved_options.oneOf.0","typeLabel":"object"},{"type":"null","description":"For approved API partners only.","properties":{"custom_price_tier":{"oneOf":[{"type":"integer","description":"For approved API partners only. A custom price tier for this product."},{"type":"null","description":"For approved API partners only. A custom price tier for this product."}]}},"uniqueKey":"product.oneOf.0.reserved_options.oneOf.1","typeLabel":"null"}],"uniqueKey":"product.oneOf.0.reserved_options","typeLabel":"object | null"}},"required":["id","name","brand","variants","images","price","price_is_variable","restricted_states"],"description":"The product that represents the collection when published. Null for unpublished collections. To send this collection, send the product ID in the cart","uniqueKey":"product.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"brand":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"logo_image":{"oneOf":[{"type":"object","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"],"description":"The logo image for this brand."},{"type":"null","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"],"description":"The logo image for this brand."}]},"shipping_price":{"type":"integer","description":"The price of shipping for this brand, in cents."},"free_shipping_minimum":{"oneOf":[{"type":"integer","description":"When set and when the product price is above this amount, shipping is free. In cents. Products in a cart for this brand can combine to reach this threshold."},{"type":"null","description":"When set and when the product price is above this amount, shipping is free. In cents. Products in a cart for this brand can combine to reach this threshold."}]},"commerce_revshare_excluded":{"oneOf":[{"type":"boolean","description":"Whether this brand is excluded from the commerce revenue share. Only displayed on the products endpoint when using a commerce app."},{"type":"null","description":"Whether this brand is excluded from the commerce revenue share. Only displayed on the products endpoint when using a commerce app."}]},"brand_values":{"type":"array","items":{"type":"string"},"description":"An array of brand values for this brand. Potential values are USA Made, Social Impact Driven, Sustainable, Gluten Free, Vegan, Kosher Certified, Female Founded, AAPI Founded, BIPOC Founded, Black Founded, LGBTQ+ Founded, and Hispanic Founded."},"brand_sets":{"oneOf":[{"type":"array","items":{"type":"object","description":"A brand set represents a collection of products from a brand.","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"images":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"image_large":{"type":"object","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"]}},"required":["id","image_large"]},"description":"An array of images for this brand set."},"products":{"type":"array","items":{"$circularRef":"9d9f25a7-f907-4624-9ed1-9a9845688bbf"},"description":"An array of products in this brand set."},"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"subcategories":{"type":"array","items":{"type":"string"},"description":"An array of subcategory names within this category."}},"required":["id","name"]},"description":"An array of categories this brand set belongs to."}},"required":["id","name"]},"description":"An array of brand sets for this brand. Only included when using the brands endpoint."},{"type":"null","items":{"type":"object","description":"A brand set represents a collection of products from a brand.","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"images":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"image_large":{"type":"object","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"]}},"required":["id","image_large"]},"description":"An array of images for this brand set."},"products":{"type":"array","items":{"$circularRef":"9d9f25a7-f907-4624-9ed1-9a9845688bbf"},"description":"An array of products in this brand set."},"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"subcategories":{"type":"array","items":{"type":"string"},"description":"An array of subcategory names within this category."}},"required":["id","name"]},"description":"An array of categories this brand set belongs to."}},"required":["id","name"]},"description":"An array of brand sets for this brand. Only included when using the brands endpoint."}]}},"required":["id","name"]},"subtitle":{"oneOf":[{"type":"string","description":"A description of this product."},{"type":"null","description":"A description of this product."}]},"subtitle_short":{"oneOf":[{"type":"string","description":"An optional one-line description of this product. When provided, it overrides the subtitle when displayed in areas with less space. Not always provided."},{"type":"null","description":"An optional one-line description of this product. When provided, it overrides the subtitle when displayed in areas with less space. Not always provided."}]},"recipient_description":{"oneOf":[{"type":"string","description":"An optional description of this product with custom verbiage for recipients. When provided, it overrides the subtitle for the product when displayed to the recipient. Falls back to the subtitle."},{"type":"null","description":"An optional description of this product with custom verbiage for recipients. When provided, it overrides the subtitle for the product when displayed to the recipient. Falls back to the subtitle."}]},"variants_label":{"oneOf":[{"type":"string","description":"The label for the variants of this product, e.g. \"Size\" or \"Color\"."},{"type":"null","description":"The label for the variants of this product, e.g. \"Size\" or \"Color\"."}]},"variants_num_selectable":{"oneOf":[{"type":"integer","description":"The number of variants that can be selected for this product. For example, if this is a t-shirt, then this would be 1, since you can only select one size. If this were a build-a-box of chocolates, this could be 3 if you could select 3 flavor variants."},{"type":"null","description":"The number of variants that can be selected for this product. For example, if this is a t-shirt, then this would be 1, since you can only select one size. If this were a build-a-box of chocolates, this could be 3 if you could select 3 flavor variants."}]},"variants":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"image_large":{"oneOf":[{"type":"object","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"]},{"type":"null","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"]}]},"subtitle":{"oneOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name"]}},"variant_groups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","description":"The name of the variant group, e.g. \"Size\" or \"Color\"."},"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","description":"The name of the variant group option, e.g. \"Small\" for the \"Size\" variant group."},"subtitle":{"oneOf":[{"type":"string"},{"type":"null"}]},"color":{"oneOf":[{"type":"string","description":"The hex color code for this option, e.g. \"#000000\", if any."},{"type":"null","description":"The hex color code for this option, e.g. \"#000000\", if any."}]},"image_large":{"oneOf":[{"type":"object","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"]},{"type":"null","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"]}]}},"required":["id","name"]}}},"required":["id","name"]},"description":"For products that have multiple types of variants, such as both Color and Size, this array contains each group and the options for each group. All variant group permutations have a variant generated for them, constructed from the options in the order of the groups, separated by ` / `, e.g. `Medium / Black` when the groups are Size and Color."},"images":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"image_large":{"type":"object","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"]}},"required":["id","image_large"]}},"price":{"type":"integer","description":"The price of the product, in cents."},"price_is_variable":{"type":"boolean","description":"Whether the price of this product is variable. If true, then the price can be set by the sender."},"price_min":{"oneOf":[{"type":"integer","description":"The minimum price of the product, in cents. Only used if price_is_variable is true."},{"type":"null","description":"The minimum price of the product, in cents. Only used if price_is_variable is true."}]},"price_max":{"oneOf":[{"type":"integer","description":"The maximum price of the product, in cents. Only used if price_is_variable is true."},{"type":"null","description":"The maximum price of the product, in cents. Only used if price_is_variable is true."}]},"restricted_states":{"type":"array","items":{"type":"string","description":"The US states that this product cannot be shipped to."}},"attributes":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","description":"The label for this attribute, e.g. \"Materials\"."},"content":{"type":"string","description":"The content for this attribute, e.g. \"80% cotton, 20% elastane\". This can be text or sanitized HTML (you might choose to sanitize the HTML as well). Allowed elements are a (href allowed), div, img (src, width height, alt allowed), span, p, br, strong, b, em, i, ol, ul, li, and hr."}},"required":["label","content"]},"description":"An array of attributes that describe this product."},"status":{"type":"string","enum":["active","inactive"],"description":"Whether this product is active. Since the product catalog only returns active products by default, this is always `true`, except if you are a Commerce API customer using a custom catalog, and are pulling products with the `custom_catalog_show_inactive` flag."},"updated_at":{"type":"string","format":"date-time","description":"The date and time this product was last updated, ISO 8601 format. This is bumped when the product, brand, product variants, product attributes, or product images are updated."},"reserved_options":{"oneOf":[{"type":"object","description":"For approved API partners only.","properties":{"custom_price_tier":{"oneOf":[{"type":"integer","description":"For approved API partners only. A custom price tier for this product."},{"type":"null","description":"For approved API partners only. A custom price tier for this product."}]}}},{"type":"null","description":"For approved API partners only.","properties":{"custom_price_tier":{"oneOf":[{"type":"integer","description":"For approved API partners only. A custom price tier for this product."},{"type":"null","description":"For approved API partners only. A custom price tier for this product."}]}}}]}},"required":["id","name","brand","variants","images","price","price_is_variable","restricted_states"],"description":"The product that represents the collection when published. Null for unpublished collections. To send this collection, send the product ID in the cart","uniqueKey":"product.oneOf.1","typeLabel":"null"}],"uniqueKey":"product","typeLabel":"object | null"},"published_version":{"oneOf":[{"type":"object","description":"Details about the published version of this collection. Null for unpublished collections.","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"published_version.oneOf.0.id","typeLabel":"string\u003cuuid>"},"multiple_select_mode":{"type":"string","enum":["disabled","item_count","max_price"],"description":"Controls how many items recipients can select from the collection.","isRequired":true,"uniqueKey":"published_version.oneOf.0.multiple_select_mode","typeLabel":"enum\u003cstring>"},"international_shipping_tier":{"type":"string","description":"Shipping tier applied to the collection (e.g. standard, full).","isRequired":true,"uniqueKey":"published_version.oneOf.0.international_shipping_tier","typeLabel":"string"},"international_gift_cards_enabled":{"type":"boolean","description":"Whether international gift cards are available when swapping products.","isRequired":true,"uniqueKey":"published_version.oneOf.0.international_gift_cards_enabled","typeLabel":"boolean"},"title":{"oneOf":[{"type":"string","uniqueKey":"published_version.oneOf.0.title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"published_version.oneOf.0.title.oneOf.1","typeLabel":"null"}],"uniqueKey":"published_version.oneOf.0.title","typeLabel":"string | null"},"subtitle":{"oneOf":[{"type":"string","uniqueKey":"published_version.oneOf.0.subtitle.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"published_version.oneOf.0.subtitle.oneOf.1","typeLabel":"null"}],"uniqueKey":"published_version.oneOf.0.subtitle","typeLabel":"string | null"},"multiple_select_count":{"oneOf":[{"type":"integer","description":"When multiple_select_mode is item_count, the number of items recipients may choose.","uniqueKey":"published_version.oneOf.0.multiple_select_count.oneOf.0","typeLabel":"integer"},{"type":"null","description":"When multiple_select_mode is item_count, the number of items recipients may choose.","uniqueKey":"published_version.oneOf.0.multiple_select_count.oneOf.1","typeLabel":"null"}],"uniqueKey":"published_version.oneOf.0.multiple_select_count","typeLabel":"integer | null"},"multiple_select_price":{"oneOf":[{"type":"integer","description":"When multiple_select_mode is max_price, the spending limit in cents.","uniqueKey":"published_version.oneOf.0.multiple_select_price.oneOf.0","typeLabel":"integer"},{"type":"null","description":"When multiple_select_mode is max_price, the spending limit in cents.","uniqueKey":"published_version.oneOf.0.multiple_select_price.oneOf.1","typeLabel":"null"}],"uniqueKey":"published_version.oneOf.0.multiple_select_price","typeLabel":"integer | null"},"header_image":{"oneOf":[{"type":"object","properties":{"url":{"type":"string","isRequired":true,"uniqueKey":"published_version.oneOf.0.header_image.oneOf.0.url","typeLabel":"string"},"width":{"type":"integer","uniqueKey":"published_version.oneOf.0.header_image.oneOf.0.width","typeLabel":"integer"},"height":{"type":"integer","uniqueKey":"published_version.oneOf.0.header_image.oneOf.0.height","typeLabel":"integer"}},"required":["url"],"uniqueKey":"published_version.oneOf.0.header_image.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"],"uniqueKey":"published_version.oneOf.0.header_image.oneOf.1","typeLabel":"null"}],"uniqueKey":"published_version.oneOf.0.header_image","typeLabel":"object | null"},"collection_categories":{"oneOf":[{"type":"array","items":{"type":"object","description":"A category of products within a collection version. All products are assigned a category.","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","isRequired":true,"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].name","typeLabel":"string"},"is_featured":{"type":"boolean","description":"Whether this category is considered the \"featured\" category.","isRequired":true,"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].is_featured","typeLabel":"boolean"},"position":{"type":"integer","isRequired":true,"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].position","typeLabel":"integer"},"collection_products":{"type":"array","items":{"type":"object","description":"Represents a product that can be selected within a collection.","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"product":{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","isRequired":true,"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.name","typeLabel":"string"},"brand":{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.brand.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","isRequired":true,"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.brand.name","typeLabel":"string"},"logo_image":{"oneOf":[{"type":"object","properties":{"url":{"type":"string","isRequired":true,"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.brand.logo_image.oneOf.0.url","typeLabel":"string"},"width":{"type":"integer","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.brand.logo_image.oneOf.0.width","typeLabel":"integer"},"height":{"type":"integer","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.brand.logo_image.oneOf.0.height","typeLabel":"integer"}},"required":["url"],"description":"The logo image for this brand.","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.brand.logo_image.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"],"description":"The logo image for this brand.","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.brand.logo_image.oneOf.1","typeLabel":"null"}],"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.brand.logo_image","typeLabel":"object | null"},"shipping_price":{"type":"integer","description":"The price of shipping for this brand, in cents.","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.brand.shipping_price","typeLabel":"integer"},"free_shipping_minimum":{"oneOf":[{"type":"integer","description":"When set and when the product price is above this amount, shipping is free. In cents. Products in a cart for this brand can combine to reach this threshold.","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.brand.free_shipping_minimum.oneOf.0","typeLabel":"integer"},{"type":"null","description":"When set and when the product price is above this amount, shipping is free. In cents. Products in a cart for this brand can combine to reach this threshold.","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.brand.free_shipping_minimum.oneOf.1","typeLabel":"null"}],"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.brand.free_shipping_minimum","typeLabel":"integer | null"},"commerce_revshare_excluded":{"oneOf":[{"type":"boolean","description":"Whether this brand is excluded from the commerce revenue share. Only displayed on the products endpoint when using a commerce app.","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.brand.commerce_revshare_excluded.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether this brand is excluded from the commerce revenue share. Only displayed on the products endpoint when using a commerce app.","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.brand.commerce_revshare_excluded.oneOf.1","typeLabel":"null"}],"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.brand.commerce_revshare_excluded","typeLabel":"boolean | null"},"brand_values":{"type":"array","items":{"type":"string","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.brand.brand_values.items.[INDEX]","typeLabel":"string"},"description":"An array of brand values for this brand. Potential values are USA Made, Social Impact Driven, Sustainable, Gluten Free, Vegan, Kosher Certified, Female Founded, AAPI Founded, BIPOC Founded, Black Founded, LGBTQ+ Founded, and Hispanic Founded.","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.brand.brand_values","typeLabel":"string[]"},"brand_sets":{"oneOf":[{"type":"array","items":{"type":"object","description":"A brand set represents a collection of products from a brand.","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.brand.brand_sets.oneOf.0.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","isRequired":true,"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.brand.brand_sets.oneOf.0.items.[INDEX].name","typeLabel":"string"},"images":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.brand.brand_sets.oneOf.0.items.[INDEX].images.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"image_large":{"type":"object","properties":{"url":{"type":"string","isRequired":true,"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.brand.brand_sets.oneOf.0.items.[INDEX].images.items.[INDEX].image_large.url","typeLabel":"string"},"width":{"type":"integer","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.brand.brand_sets.oneOf.0.items.[INDEX].images.items.[INDEX].image_large.width","typeLabel":"integer"},"height":{"type":"integer","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.brand.brand_sets.oneOf.0.items.[INDEX].images.items.[INDEX].image_large.height","typeLabel":"integer"}},"required":["url"],"isRequired":true,"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.brand.brand_sets.oneOf.0.items.[INDEX].images.items.[INDEX].image_large","typeLabel":"object"}},"required":["id","image_large"],"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.brand.brand_sets.oneOf.0.items.[INDEX].images.items.[INDEX]","typeLabel":"object"},"description":"An array of images for this brand set.","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.brand.brand_sets.oneOf.0.items.[INDEX].images","typeLabel":"object[]"},"products":{"type":"array","items":{"$circularRef":"9d9f25a7-f907-4624-9ed1-9a9845688bbf"},"description":"An array of products in this brand set.","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.brand.brand_sets.oneOf.0.items.[INDEX].products","typeLabel":"array"},"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.brand.brand_sets.oneOf.0.items.[INDEX].categories.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","isRequired":true,"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.brand.brand_sets.oneOf.0.items.[INDEX].categories.items.[INDEX].name","typeLabel":"string"},"subcategories":{"type":"array","items":{"type":"string","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.brand.brand_sets.oneOf.0.items.[INDEX].categories.items.[INDEX].subcategories.items.[INDEX]","typeLabel":"string"},"description":"An array of subcategory names within this category.","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.brand.brand_sets.oneOf.0.items.[INDEX].categories.items.[INDEX].subcategories","typeLabel":"string[]"}},"required":["id","name"],"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.brand.brand_sets.oneOf.0.items.[INDEX].categories.items.[INDEX]","typeLabel":"object"},"description":"An array of categories this brand set belongs to.","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.brand.brand_sets.oneOf.0.items.[INDEX].categories","typeLabel":"object[]"}},"required":["id","name"],"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.brand.brand_sets.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"An array of brand sets for this brand. Only included when using the brands endpoint.","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.brand.brand_sets.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","description":"A brand set represents a collection of products from a brand.","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"images":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"image_large":{"type":"object","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"]}},"required":["id","image_large"]},"description":"An array of images for this brand set."},"products":{"type":"array","items":{"$circularRef":"9d9f25a7-f907-4624-9ed1-9a9845688bbf"},"description":"An array of products in this brand set."},"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"subcategories":{"type":"array","items":{"type":"string"},"description":"An array of subcategory names within this category."}},"required":["id","name"]},"description":"An array of categories this brand set belongs to."}},"required":["id","name"]},"description":"An array of brand sets for this brand. Only included when using the brands endpoint.","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.brand.brand_sets.oneOf.1","typeLabel":"null"}],"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.brand.brand_sets","typeLabel":"object[] | null"}},"required":["id","name"],"isRequired":true,"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.brand","typeLabel":"object"},"variants":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.variants.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","isRequired":true,"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.variants.items.[INDEX].name","typeLabel":"string"},"image_large":{"oneOf":[{"type":"object","properties":{"url":{"type":"string","isRequired":true,"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.variants.items.[INDEX].image_large.oneOf.0.url","typeLabel":"string"},"width":{"type":"integer","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.variants.items.[INDEX].image_large.oneOf.0.width","typeLabel":"integer"},"height":{"type":"integer","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.variants.items.[INDEX].image_large.oneOf.0.height","typeLabel":"integer"}},"required":["url"],"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.variants.items.[INDEX].image_large.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"],"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.variants.items.[INDEX].image_large.oneOf.1","typeLabel":"null"}],"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.variants.items.[INDEX].image_large","typeLabel":"object | null"},"subtitle":{"oneOf":[{"type":"string","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.variants.items.[INDEX].subtitle.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.variants.items.[INDEX].subtitle.oneOf.1","typeLabel":"null"}],"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.variants.items.[INDEX].subtitle","typeLabel":"string | null"}},"required":["id","name"],"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.variants.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.variants","typeLabel":"object[]"},"images":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.images.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"image_large":{"type":"object","properties":{"url":{"type":"string","isRequired":true,"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.images.items.[INDEX].image_large.url","typeLabel":"string"},"width":{"type":"integer","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.images.items.[INDEX].image_large.width","typeLabel":"integer"},"height":{"type":"integer","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.images.items.[INDEX].image_large.height","typeLabel":"integer"}},"required":["url"],"isRequired":true,"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.images.items.[INDEX].image_large","typeLabel":"object"}},"required":["id","image_large"],"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.images.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.images","typeLabel":"object[]"},"price":{"type":"integer","description":"The price of the product, in cents.","isRequired":true,"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.price","typeLabel":"integer"},"price_is_variable":{"type":"boolean","description":"Whether the price of this product is variable. If true, then the price can be set by the sender.","isRequired":true,"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.price_is_variable","typeLabel":"boolean"},"restricted_states":{"type":"array","items":{"type":"string","description":"The US states that this product cannot be shipped to.","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.restricted_states.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.restricted_states","typeLabel":"string[]"},"subtitle":{"oneOf":[{"type":"string","description":"A description of this product.","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.subtitle.oneOf.0","typeLabel":"string"},{"type":"null","description":"A description of this product.","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.subtitle.oneOf.1","typeLabel":"null"}],"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.subtitle","typeLabel":"string | null"},"subtitle_short":{"oneOf":[{"type":"string","description":"An optional one-line description of this product. When provided, it overrides the subtitle when displayed in areas with less space. Not always provided.","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.subtitle_short.oneOf.0","typeLabel":"string"},{"type":"null","description":"An optional one-line description of this product. When provided, it overrides the subtitle when displayed in areas with less space. Not always provided.","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.subtitle_short.oneOf.1","typeLabel":"null"}],"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.subtitle_short","typeLabel":"string | null"},"recipient_description":{"oneOf":[{"type":"string","description":"An optional description of this product with custom verbiage for recipients. When provided, it overrides the subtitle for the product when displayed to the recipient. Falls back to the subtitle.","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.recipient_description.oneOf.0","typeLabel":"string"},{"type":"null","description":"An optional description of this product with custom verbiage for recipients. When provided, it overrides the subtitle for the product when displayed to the recipient. Falls back to the subtitle.","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.recipient_description.oneOf.1","typeLabel":"null"}],"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.recipient_description","typeLabel":"string | null"},"variants_label":{"oneOf":[{"type":"string","description":"The label for the variants of this product, e.g. \"Size\" or \"Color\".","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.variants_label.oneOf.0","typeLabel":"string"},{"type":"null","description":"The label for the variants of this product, e.g. \"Size\" or \"Color\".","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.variants_label.oneOf.1","typeLabel":"null"}],"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.variants_label","typeLabel":"string | null"},"variants_num_selectable":{"oneOf":[{"type":"integer","description":"The number of variants that can be selected for this product. For example, if this is a t-shirt, then this would be 1, since you can only select one size. If this were a build-a-box of chocolates, this could be 3 if you could select 3 flavor variants.","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.variants_num_selectable.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The number of variants that can be selected for this product. For example, if this is a t-shirt, then this would be 1, since you can only select one size. If this were a build-a-box of chocolates, this could be 3 if you could select 3 flavor variants.","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.variants_num_selectable.oneOf.1","typeLabel":"null"}],"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.variants_num_selectable","typeLabel":"integer | null"},"variant_groups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.variant_groups.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","description":"The name of the variant group, e.g. \"Size\" or \"Color\".","isRequired":true,"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.variant_groups.items.[INDEX].name","typeLabel":"string"},"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.variant_groups.items.[INDEX].options.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","description":"The name of the variant group option, e.g. \"Small\" for the \"Size\" variant group.","isRequired":true,"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.variant_groups.items.[INDEX].options.items.[INDEX].name","typeLabel":"string"},"subtitle":{"oneOf":[{"type":"string","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.variant_groups.items.[INDEX].options.items.[INDEX].subtitle.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.variant_groups.items.[INDEX].options.items.[INDEX].subtitle.oneOf.1","typeLabel":"null"}],"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.variant_groups.items.[INDEX].options.items.[INDEX].subtitle","typeLabel":"string | null"},"color":{"oneOf":[{"type":"string","description":"The hex color code for this option, e.g. \"#000000\", if any.","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.variant_groups.items.[INDEX].options.items.[INDEX].color.oneOf.0","typeLabel":"string"},{"type":"null","description":"The hex color code for this option, e.g. \"#000000\", if any.","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.variant_groups.items.[INDEX].options.items.[INDEX].color.oneOf.1","typeLabel":"null"}],"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.variant_groups.items.[INDEX].options.items.[INDEX].color","typeLabel":"string | null"},"image_large":{"oneOf":[{"type":"object","properties":{"url":{"type":"string","isRequired":true,"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.variant_groups.items.[INDEX].options.items.[INDEX].image_large.oneOf.0.url","typeLabel":"string"},"width":{"type":"integer","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.variant_groups.items.[INDEX].options.items.[INDEX].image_large.oneOf.0.width","typeLabel":"integer"},"height":{"type":"integer","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.variant_groups.items.[INDEX].options.items.[INDEX].image_large.oneOf.0.height","typeLabel":"integer"}},"required":["url"],"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.variant_groups.items.[INDEX].options.items.[INDEX].image_large.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"],"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.variant_groups.items.[INDEX].options.items.[INDEX].image_large.oneOf.1","typeLabel":"null"}],"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.variant_groups.items.[INDEX].options.items.[INDEX].image_large","typeLabel":"object | null"}},"required":["id","name"],"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.variant_groups.items.[INDEX].options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.variant_groups.items.[INDEX].options","typeLabel":"object[]"}},"required":["id","name"],"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.variant_groups.items.[INDEX]","typeLabel":"object"},"description":"For products that have multiple types of variants, such as both Color and Size, this array contains each group and the options for each group. All variant group permutations have a variant generated for them, constructed from the options in the order of the groups, separated by ` / `, e.g. `Medium / Black` when the groups are Size and Color.","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.variant_groups","typeLabel":"object[]"},"price_min":{"oneOf":[{"type":"integer","description":"The minimum price of the product, in cents. Only used if price_is_variable is true.","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.price_min.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The minimum price of the product, in cents. Only used if price_is_variable is true.","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.price_min.oneOf.1","typeLabel":"null"}],"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.price_min","typeLabel":"integer | null"},"price_max":{"oneOf":[{"type":"integer","description":"The maximum price of the product, in cents. Only used if price_is_variable is true.","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.price_max.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The maximum price of the product, in cents. Only used if price_is_variable is true.","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.price_max.oneOf.1","typeLabel":"null"}],"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.price_max","typeLabel":"integer | null"},"attributes":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","description":"The label for this attribute, e.g. \"Materials\".","isRequired":true,"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.attributes.items.[INDEX].label","typeLabel":"string"},"content":{"type":"string","description":"The content for this attribute, e.g. \"80% cotton, 20% elastane\". This can be text or sanitized HTML (you might choose to sanitize the HTML as well). Allowed elements are a (href allowed), div, img (src, width height, alt allowed), span, p, br, strong, b, em, i, ol, ul, li, and hr.","isRequired":true,"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.attributes.items.[INDEX].content","typeLabel":"string"}},"required":["label","content"],"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.attributes.items.[INDEX]","typeLabel":"object"},"description":"An array of attributes that describe this product.","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.attributes","typeLabel":"object[]"},"status":{"type":"string","enum":["active","inactive"],"description":"Whether this product is active. Since the product catalog only returns active products by default, this is always `true`, except if you are a Commerce API customer using a custom catalog, and are pulling products with the `custom_catalog_show_inactive` flag.","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.status","typeLabel":"enum\u003cstring>"},"updated_at":{"type":"string","format":"date-time","description":"The date and time this product was last updated, ISO 8601 format. This is bumped when the product, brand, product variants, product attributes, or product images are updated.","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.updated_at","typeLabel":"string\u003cdate-time>"},"reserved_options":{"oneOf":[{"type":"object","description":"For approved API partners only.","properties":{"custom_price_tier":{"oneOf":[{"type":"integer","description":"For approved API partners only. A custom price tier for this product.","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.reserved_options.oneOf.0.custom_price_tier.oneOf.0","typeLabel":"integer"},{"type":"null","description":"For approved API partners only. A custom price tier for this product.","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.reserved_options.oneOf.0.custom_price_tier.oneOf.1","typeLabel":"null"}],"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.reserved_options.oneOf.0.custom_price_tier","typeLabel":"integer | null"}},"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.reserved_options.oneOf.0","typeLabel":"object"},{"type":"null","description":"For approved API partners only.","properties":{"custom_price_tier":{"oneOf":[{"type":"integer","description":"For approved API partners only. A custom price tier for this product."},{"type":"null","description":"For approved API partners only. A custom price tier for this product."}]}},"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.reserved_options.oneOf.1","typeLabel":"null"}],"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product.reserved_options","typeLabel":"object | null"}},"required":["id","name","brand","variants","images","price","price_is_variable","restricted_states"],"isRequired":true,"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX].product","typeLabel":"object"}},"required":["id","product"],"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products.items.[INDEX]","typeLabel":"object"},"description":"Products assigned to this category in their display order.","isRequired":true,"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX].collection_products","typeLabel":"object[]"}},"required":["id","name","is_featured","position","collection_products"],"uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Categories and their products included in this version, ordered by position.","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","description":"A category of products within a collection version. All products are assigned a category.","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"is_featured":{"type":"boolean","description":"Whether this category is considered the \"featured\" category."},"position":{"type":"integer"},"collection_products":{"type":"array","items":{"type":"object","description":"Represents a product that can be selected within a collection.","properties":{"id":{"type":"string","format":"uuid"},"product":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"brand":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"logo_image":{"oneOf":[{"type":"object","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"],"description":"The logo image for this brand."},{"type":"null","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"],"description":"The logo image for this brand."}]},"shipping_price":{"type":"integer","description":"The price of shipping for this brand, in cents."},"free_shipping_minimum":{"oneOf":[{"type":"integer","description":"When set and when the product price is above this amount, shipping is free. In cents. Products in a cart for this brand can combine to reach this threshold."},{"type":"null","description":"When set and when the product price is above this amount, shipping is free. In cents. Products in a cart for this brand can combine to reach this threshold."}]},"commerce_revshare_excluded":{"oneOf":[{"type":"boolean","description":"Whether this brand is excluded from the commerce revenue share. Only displayed on the products endpoint when using a commerce app."},{"type":"null","description":"Whether this brand is excluded from the commerce revenue share. Only displayed on the products endpoint when using a commerce app."}]},"brand_values":{"type":"array","items":{"type":"string"},"description":"An array of brand values for this brand. Potential values are USA Made, Social Impact Driven, Sustainable, Gluten Free, Vegan, Kosher Certified, Female Founded, AAPI Founded, BIPOC Founded, Black Founded, LGBTQ+ Founded, and Hispanic Founded."},"brand_sets":{"oneOf":[{"type":"array","items":{"type":"object","description":"A brand set represents a collection of products from a brand.","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"images":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"image_large":{"type":"object","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"]}},"required":["id","image_large"]},"description":"An array of images for this brand set."},"products":{"type":"array","items":{"$circularRef":"9d9f25a7-f907-4624-9ed1-9a9845688bbf"},"description":"An array of products in this brand set."},"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"subcategories":{"type":"array","items":{"type":"string"},"description":"An array of subcategory names within this category."}},"required":["id","name"]},"description":"An array of categories this brand set belongs to."}},"required":["id","name"]},"description":"An array of brand sets for this brand. Only included when using the brands endpoint."},{"type":"null","items":{"type":"object","description":"A brand set represents a collection of products from a brand.","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"images":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"image_large":{"type":"object","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"]}},"required":["id","image_large"]},"description":"An array of images for this brand set."},"products":{"type":"array","items":{"$circularRef":"9d9f25a7-f907-4624-9ed1-9a9845688bbf"},"description":"An array of products in this brand set."},"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"subcategories":{"type":"array","items":{"type":"string"},"description":"An array of subcategory names within this category."}},"required":["id","name"]},"description":"An array of categories this brand set belongs to."}},"required":["id","name"]},"description":"An array of brand sets for this brand. Only included when using the brands endpoint."}]}},"required":["id","name"]},"subtitle":{"oneOf":[{"type":"string","description":"A description of this product."},{"type":"null","description":"A description of this product."}]},"subtitle_short":{"oneOf":[{"type":"string","description":"An optional one-line description of this product. When provided, it overrides the subtitle when displayed in areas with less space. Not always provided."},{"type":"null","description":"An optional one-line description of this product. When provided, it overrides the subtitle when displayed in areas with less space. Not always provided."}]},"recipient_description":{"oneOf":[{"type":"string","description":"An optional description of this product with custom verbiage for recipients. When provided, it overrides the subtitle for the product when displayed to the recipient. Falls back to the subtitle."},{"type":"null","description":"An optional description of this product with custom verbiage for recipients. When provided, it overrides the subtitle for the product when displayed to the recipient. Falls back to the subtitle."}]},"variants_label":{"oneOf":[{"type":"string","description":"The label for the variants of this product, e.g. \"Size\" or \"Color\"."},{"type":"null","description":"The label for the variants of this product, e.g. \"Size\" or \"Color\"."}]},"variants_num_selectable":{"oneOf":[{"type":"integer","description":"The number of variants that can be selected for this product. For example, if this is a t-shirt, then this would be 1, since you can only select one size. If this were a build-a-box of chocolates, this could be 3 if you could select 3 flavor variants."},{"type":"null","description":"The number of variants that can be selected for this product. For example, if this is a t-shirt, then this would be 1, since you can only select one size. If this were a build-a-box of chocolates, this could be 3 if you could select 3 flavor variants."}]},"variants":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"image_large":{"oneOf":[{"type":"object","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"]},{"type":"null","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"]}]},"subtitle":{"oneOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name"]}},"variant_groups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","description":"The name of the variant group, e.g. \"Size\" or \"Color\"."},"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","description":"The name of the variant group option, e.g. \"Small\" for the \"Size\" variant group."},"subtitle":{"oneOf":[{"type":"string"},{"type":"null"}]},"color":{"oneOf":[{"type":"string","description":"The hex color code for this option, e.g. \"#000000\", if any."},{"type":"null","description":"The hex color code for this option, e.g. \"#000000\", if any."}]},"image_large":{"oneOf":[{"type":"object","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"]},{"type":"null","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"]}]}},"required":["id","name"]}}},"required":["id","name"]},"description":"For products that have multiple types of variants, such as both Color and Size, this array contains each group and the options for each group. All variant group permutations have a variant generated for them, constructed from the options in the order of the groups, separated by ` / `, e.g. `Medium / Black` when the groups are Size and Color."},"images":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"image_large":{"type":"object","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"]}},"required":["id","image_large"]}},"price":{"type":"integer","description":"The price of the product, in cents."},"price_is_variable":{"type":"boolean","description":"Whether the price of this product is variable. If true, then the price can be set by the sender."},"price_min":{"oneOf":[{"type":"integer","description":"The minimum price of the product, in cents. Only used if price_is_variable is true."},{"type":"null","description":"The minimum price of the product, in cents. Only used if price_is_variable is true."}]},"price_max":{"oneOf":[{"type":"integer","description":"The maximum price of the product, in cents. Only used if price_is_variable is true."},{"type":"null","description":"The maximum price of the product, in cents. Only used if price_is_variable is true."}]},"restricted_states":{"type":"array","items":{"type":"string","description":"The US states that this product cannot be shipped to."}},"attributes":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","description":"The label for this attribute, e.g. \"Materials\"."},"content":{"type":"string","description":"The content for this attribute, e.g. \"80% cotton, 20% elastane\". This can be text or sanitized HTML (you might choose to sanitize the HTML as well). Allowed elements are a (href allowed), div, img (src, width height, alt allowed), span, p, br, strong, b, em, i, ol, ul, li, and hr."}},"required":["label","content"]},"description":"An array of attributes that describe this product."},"status":{"type":"string","enum":["active","inactive"],"description":"Whether this product is active. Since the product catalog only returns active products by default, this is always `true`, except if you are a Commerce API customer using a custom catalog, and are pulling products with the `custom_catalog_show_inactive` flag."},"updated_at":{"type":"string","format":"date-time","description":"The date and time this product was last updated, ISO 8601 format. This is bumped when the product, brand, product variants, product attributes, or product images are updated."},"reserved_options":{"oneOf":[{"type":"object","description":"For approved API partners only.","properties":{"custom_price_tier":{"oneOf":[{"type":"integer","description":"For approved API partners only. A custom price tier for this product."},{"type":"null","description":"For approved API partners only. A custom price tier for this product."}]}}},{"type":"null","description":"For approved API partners only.","properties":{"custom_price_tier":{"oneOf":[{"type":"integer","description":"For approved API partners only. A custom price tier for this product."},{"type":"null","description":"For approved API partners only. A custom price tier for this product."}]}}}]}},"required":["id","name","brand","variants","images","price","price_is_variable","restricted_states"]}},"required":["id","product"]},"description":"Products assigned to this category in their display order."}},"required":["id","name","is_featured","position","collection_products"]},"description":"Categories and their products included in this version, ordered by position.","uniqueKey":"published_version.oneOf.0.collection_categories.oneOf.1","typeLabel":"null"}],"uniqueKey":"published_version.oneOf.0.collection_categories","typeLabel":"object[] | null"}},"required":["id","multiple_select_mode","international_shipping_tier","international_gift_cards_enabled"],"uniqueKey":"published_version.oneOf.0","typeLabel":"object"},{"type":"null","description":"Details about the published version of this collection. Null for unpublished collections.","properties":{"id":{"type":"string","format":"uuid"},"title":{"oneOf":[{"type":"string"},{"type":"null"}]},"subtitle":{"oneOf":[{"type":"string"},{"type":"null"}]},"multiple_select_mode":{"type":"string","enum":["disabled","item_count","max_price"],"description":"Controls how many items recipients can select from the collection."},"multiple_select_count":{"oneOf":[{"type":"integer","description":"When multiple_select_mode is item_count, the number of items recipients may choose."},{"type":"null","description":"When multiple_select_mode is item_count, the number of items recipients may choose."}]},"multiple_select_price":{"oneOf":[{"type":"integer","description":"When multiple_select_mode is max_price, the spending limit in cents."},{"type":"null","description":"When multiple_select_mode is max_price, the spending limit in cents."}]},"international_shipping_tier":{"type":"string","description":"Shipping tier applied to the collection (e.g. standard, full)."},"international_gift_cards_enabled":{"type":"boolean","description":"Whether international gift cards are available when swapping products."},"header_image":{"oneOf":[{"type":"object","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"]},{"type":"null","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"]}]},"collection_categories":{"oneOf":[{"type":"array","items":{"type":"object","description":"A category of products within a collection version. All products are assigned a category.","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"is_featured":{"type":"boolean","description":"Whether this category is considered the \"featured\" category."},"position":{"type":"integer"},"collection_products":{"type":"array","items":{"type":"object","description":"Represents a product that can be selected within a collection.","properties":{"id":{"type":"string","format":"uuid"},"product":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"brand":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"logo_image":{"oneOf":[{"type":"object","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"],"description":"The logo image for this brand."},{"type":"null","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"],"description":"The logo image for this brand."}]},"shipping_price":{"type":"integer","description":"The price of shipping for this brand, in cents."},"free_shipping_minimum":{"oneOf":[{"type":"integer","description":"When set and when the product price is above this amount, shipping is free. In cents. Products in a cart for this brand can combine to reach this threshold."},{"type":"null","description":"When set and when the product price is above this amount, shipping is free. In cents. Products in a cart for this brand can combine to reach this threshold."}]},"commerce_revshare_excluded":{"oneOf":[{"type":"boolean","description":"Whether this brand is excluded from the commerce revenue share. Only displayed on the products endpoint when using a commerce app."},{"type":"null","description":"Whether this brand is excluded from the commerce revenue share. Only displayed on the products endpoint when using a commerce app."}]},"brand_values":{"type":"array","items":{"type":"string"},"description":"An array of brand values for this brand. Potential values are USA Made, Social Impact Driven, Sustainable, Gluten Free, Vegan, Kosher Certified, Female Founded, AAPI Founded, BIPOC Founded, Black Founded, LGBTQ+ Founded, and Hispanic Founded."},"brand_sets":{"oneOf":[{"type":"array","items":{"type":"object","description":"A brand set represents a collection of products from a brand.","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"images":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"image_large":{"type":"object","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"]}},"required":["id","image_large"]},"description":"An array of images for this brand set."},"products":{"type":"array","items":{"$circularRef":"9d9f25a7-f907-4624-9ed1-9a9845688bbf"},"description":"An array of products in this brand set."},"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"subcategories":{"type":"array","items":{"type":"string"},"description":"An array of subcategory names within this category."}},"required":["id","name"]},"description":"An array of categories this brand set belongs to."}},"required":["id","name"]},"description":"An array of brand sets for this brand. Only included when using the brands endpoint."},{"type":"null","items":{"type":"object","description":"A brand set represents a collection of products from a brand.","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"images":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"image_large":{"type":"object","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"]}},"required":["id","image_large"]},"description":"An array of images for this brand set."},"products":{"type":"array","items":{"$circularRef":"9d9f25a7-f907-4624-9ed1-9a9845688bbf"},"description":"An array of products in this brand set."},"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"subcategories":{"type":"array","items":{"type":"string"},"description":"An array of subcategory names within this category."}},"required":["id","name"]},"description":"An array of categories this brand set belongs to."}},"required":["id","name"]},"description":"An array of brand sets for this brand. Only included when using the brands endpoint."}]}},"required":["id","name"]},"subtitle":{"oneOf":[{"type":"string","description":"A description of this product."},{"type":"null","description":"A description of this product."}]},"subtitle_short":{"oneOf":[{"type":"string","description":"An optional one-line description of this product. When provided, it overrides the subtitle when displayed in areas with less space. Not always provided."},{"type":"null","description":"An optional one-line description of this product. When provided, it overrides the subtitle when displayed in areas with less space. Not always provided."}]},"recipient_description":{"oneOf":[{"type":"string","description":"An optional description of this product with custom verbiage for recipients. When provided, it overrides the subtitle for the product when displayed to the recipient. Falls back to the subtitle."},{"type":"null","description":"An optional description of this product with custom verbiage for recipients. When provided, it overrides the subtitle for the product when displayed to the recipient. Falls back to the subtitle."}]},"variants_label":{"oneOf":[{"type":"string","description":"The label for the variants of this product, e.g. \"Size\" or \"Color\"."},{"type":"null","description":"The label for the variants of this product, e.g. \"Size\" or \"Color\"."}]},"variants_num_selectable":{"oneOf":[{"type":"integer","description":"The number of variants that can be selected for this product. For example, if this is a t-shirt, then this would be 1, since you can only select one size. If this were a build-a-box of chocolates, this could be 3 if you could select 3 flavor variants."},{"type":"null","description":"The number of variants that can be selected for this product. For example, if this is a t-shirt, then this would be 1, since you can only select one size. If this were a build-a-box of chocolates, this could be 3 if you could select 3 flavor variants."}]},"variants":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"image_large":{"oneOf":[{"type":"object","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"]},{"type":"null","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"]}]},"subtitle":{"oneOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name"]}},"variant_groups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","description":"The name of the variant group, e.g. \"Size\" or \"Color\"."},"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","description":"The name of the variant group option, e.g. \"Small\" for the \"Size\" variant group."},"subtitle":{"oneOf":[{"type":"string"},{"type":"null"}]},"color":{"oneOf":[{"type":"string","description":"The hex color code for this option, e.g. \"#000000\", if any."},{"type":"null","description":"The hex color code for this option, e.g. \"#000000\", if any."}]},"image_large":{"oneOf":[{"type":"object","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"]},{"type":"null","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"]}]}},"required":["id","name"]}}},"required":["id","name"]},"description":"For products that have multiple types of variants, such as both Color and Size, this array contains each group and the options for each group. All variant group permutations have a variant generated for them, constructed from the options in the order of the groups, separated by ` / `, e.g. `Medium / Black` when the groups are Size and Color."},"images":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"image_large":{"type":"object","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"]}},"required":["id","image_large"]}},"price":{"type":"integer","description":"The price of the product, in cents."},"price_is_variable":{"type":"boolean","description":"Whether the price of this product is variable. If true, then the price can be set by the sender."},"price_min":{"oneOf":[{"type":"integer","description":"The minimum price of the product, in cents. Only used if price_is_variable is true."},{"type":"null","description":"The minimum price of the product, in cents. Only used if price_is_variable is true."}]},"price_max":{"oneOf":[{"type":"integer","description":"The maximum price of the product, in cents. Only used if price_is_variable is true."},{"type":"null","description":"The maximum price of the product, in cents. Only used if price_is_variable is true."}]},"restricted_states":{"type":"array","items":{"type":"string","description":"The US states that this product cannot be shipped to."}},"attributes":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","description":"The label for this attribute, e.g. \"Materials\"."},"content":{"type":"string","description":"The content for this attribute, e.g. \"80% cotton, 20% elastane\". This can be text or sanitized HTML (you might choose to sanitize the HTML as well). Allowed elements are a (href allowed), div, img (src, width height, alt allowed), span, p, br, strong, b, em, i, ol, ul, li, and hr."}},"required":["label","content"]},"description":"An array of attributes that describe this product."},"status":{"type":"string","enum":["active","inactive"],"description":"Whether this product is active. Since the product catalog only returns active products by default, this is always `true`, except if you are a Commerce API customer using a custom catalog, and are pulling products with the `custom_catalog_show_inactive` flag."},"updated_at":{"type":"string","format":"date-time","description":"The date and time this product was last updated, ISO 8601 format. This is bumped when the product, brand, product variants, product attributes, or product images are updated."},"reserved_options":{"oneOf":[{"type":"object","description":"For approved API partners only.","properties":{"custom_price_tier":{"oneOf":[{"type":"integer","description":"For approved API partners only. A custom price tier for this product."},{"type":"null","description":"For approved API partners only. A custom price tier for this product."}]}}},{"type":"null","description":"For approved API partners only.","properties":{"custom_price_tier":{"oneOf":[{"type":"integer","description":"For approved API partners only. A custom price tier for this product."},{"type":"null","description":"For approved API partners only. A custom price tier for this product."}]}}}]}},"required":["id","name","brand","variants","images","price","price_is_variable","restricted_states"]}},"required":["id","product"]},"description":"Products assigned to this category in their display order."}},"required":["id","name","is_featured","position","collection_products"]},"description":"Categories and their products included in this version, ordered by position."},{"type":"null","items":{"type":"object","description":"A category of products within a collection version. All products are assigned a category.","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"is_featured":{"type":"boolean","description":"Whether this category is considered the \"featured\" category."},"position":{"type":"integer"},"collection_products":{"type":"array","items":{"type":"object","description":"Represents a product that can be selected within a collection.","properties":{"id":{"type":"string","format":"uuid"},"product":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"brand":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"logo_image":{"oneOf":[{"type":"object","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"],"description":"The logo image for this brand."},{"type":"null","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"],"description":"The logo image for this brand."}]},"shipping_price":{"type":"integer","description":"The price of shipping for this brand, in cents."},"free_shipping_minimum":{"oneOf":[{"type":"integer","description":"When set and when the product price is above this amount, shipping is free. In cents. Products in a cart for this brand can combine to reach this threshold."},{"type":"null","description":"When set and when the product price is above this amount, shipping is free. In cents. Products in a cart for this brand can combine to reach this threshold."}]},"commerce_revshare_excluded":{"oneOf":[{"type":"boolean","description":"Whether this brand is excluded from the commerce revenue share. Only displayed on the products endpoint when using a commerce app."},{"type":"null","description":"Whether this brand is excluded from the commerce revenue share. Only displayed on the products endpoint when using a commerce app."}]},"brand_values":{"type":"array","items":{"type":"string"},"description":"An array of brand values for this brand. Potential values are USA Made, Social Impact Driven, Sustainable, Gluten Free, Vegan, Kosher Certified, Female Founded, AAPI Founded, BIPOC Founded, Black Founded, LGBTQ+ Founded, and Hispanic Founded."},"brand_sets":{"oneOf":[{"type":"array","items":{"type":"object","description":"A brand set represents a collection of products from a brand.","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"images":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"image_large":{"type":"object","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"]}},"required":["id","image_large"]},"description":"An array of images for this brand set."},"products":{"type":"array","items":{"$circularRef":"9d9f25a7-f907-4624-9ed1-9a9845688bbf"},"description":"An array of products in this brand set."},"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"subcategories":{"type":"array","items":{"type":"string"},"description":"An array of subcategory names within this category."}},"required":["id","name"]},"description":"An array of categories this brand set belongs to."}},"required":["id","name"]},"description":"An array of brand sets for this brand. Only included when using the brands endpoint."},{"type":"null","items":{"type":"object","description":"A brand set represents a collection of products from a brand.","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"images":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"image_large":{"type":"object","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"]}},"required":["id","image_large"]},"description":"An array of images for this brand set."},"products":{"type":"array","items":{"$circularRef":"9d9f25a7-f907-4624-9ed1-9a9845688bbf"},"description":"An array of products in this brand set."},"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"subcategories":{"type":"array","items":{"type":"string"},"description":"An array of subcategory names within this category."}},"required":["id","name"]},"description":"An array of categories this brand set belongs to."}},"required":["id","name"]},"description":"An array of brand sets for this brand. Only included when using the brands endpoint."}]}},"required":["id","name"]},"subtitle":{"oneOf":[{"type":"string","description":"A description of this product."},{"type":"null","description":"A description of this product."}]},"subtitle_short":{"oneOf":[{"type":"string","description":"An optional one-line description of this product. When provided, it overrides the subtitle when displayed in areas with less space. Not always provided."},{"type":"null","description":"An optional one-line description of this product. When provided, it overrides the subtitle when displayed in areas with less space. Not always provided."}]},"recipient_description":{"oneOf":[{"type":"string","description":"An optional description of this product with custom verbiage for recipients. When provided, it overrides the subtitle for the product when displayed to the recipient. Falls back to the subtitle."},{"type":"null","description":"An optional description of this product with custom verbiage for recipients. When provided, it overrides the subtitle for the product when displayed to the recipient. Falls back to the subtitle."}]},"variants_label":{"oneOf":[{"type":"string","description":"The label for the variants of this product, e.g. \"Size\" or \"Color\"."},{"type":"null","description":"The label for the variants of this product, e.g. \"Size\" or \"Color\"."}]},"variants_num_selectable":{"oneOf":[{"type":"integer","description":"The number of variants that can be selected for this product. For example, if this is a t-shirt, then this would be 1, since you can only select one size. If this were a build-a-box of chocolates, this could be 3 if you could select 3 flavor variants."},{"type":"null","description":"The number of variants that can be selected for this product. For example, if this is a t-shirt, then this would be 1, since you can only select one size. If this were a build-a-box of chocolates, this could be 3 if you could select 3 flavor variants."}]},"variants":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"image_large":{"oneOf":[{"type":"object","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"]},{"type":"null","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"]}]},"subtitle":{"oneOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name"]}},"variant_groups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","description":"The name of the variant group, e.g. \"Size\" or \"Color\"."},"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string","description":"The name of the variant group option, e.g. \"Small\" for the \"Size\" variant group."},"subtitle":{"oneOf":[{"type":"string"},{"type":"null"}]},"color":{"oneOf":[{"type":"string","description":"The hex color code for this option, e.g. \"#000000\", if any."},{"type":"null","description":"The hex color code for this option, e.g. \"#000000\", if any."}]},"image_large":{"oneOf":[{"type":"object","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"]},{"type":"null","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"]}]}},"required":["id","name"]}}},"required":["id","name"]},"description":"For products that have multiple types of variants, such as both Color and Size, this array contains each group and the options for each group. All variant group permutations have a variant generated for them, constructed from the options in the order of the groups, separated by ` / `, e.g. `Medium / Black` when the groups are Size and Color."},"images":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"image_large":{"type":"object","properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"]}},"required":["id","image_large"]}},"price":{"type":"integer","description":"The price of the product, in cents."},"price_is_variable":{"type":"boolean","description":"Whether the price of this product is variable. If true, then the price can be set by the sender."},"price_min":{"oneOf":[{"type":"integer","description":"The minimum price of the product, in cents. Only used if price_is_variable is true."},{"type":"null","description":"The minimum price of the product, in cents. Only used if price_is_variable is true."}]},"price_max":{"oneOf":[{"type":"integer","description":"The maximum price of the product, in cents. Only used if price_is_variable is true."},{"type":"null","description":"The maximum price of the product, in cents. Only used if price_is_variable is true."}]},"restricted_states":{"type":"array","items":{"type":"string","description":"The US states that this product cannot be shipped to."}},"attributes":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","description":"The label for this attribute, e.g. \"Materials\"."},"content":{"type":"string","description":"The content for this attribute, e.g. \"80% cotton, 20% elastane\". This can be text or sanitized HTML (you might choose to sanitize the HTML as well). Allowed elements are a (href allowed), div, img (src, width height, alt allowed), span, p, br, strong, b, em, i, ol, ul, li, and hr."}},"required":["label","content"]},"description":"An array of attributes that describe this product."},"status":{"type":"string","enum":["active","inactive"],"description":"Whether this product is active. Since the product catalog only returns active products by default, this is always `true`, except if you are a Commerce API customer using a custom catalog, and are pulling products with the `custom_catalog_show_inactive` flag."},"updated_at":{"type":"string","format":"date-time","description":"The date and time this product was last updated, ISO 8601 format. This is bumped when the product, brand, product variants, product attributes, or product images are updated."},"reserved_options":{"oneOf":[{"type":"object","description":"For approved API partners only.","properties":{"custom_price_tier":{"oneOf":[{"type":"integer","description":"For approved API partners only. A custom price tier for this product."},{"type":"null","description":"For approved API partners only. A custom price tier for this product."}]}}},{"type":"null","description":"For approved API partners only.","properties":{"custom_price_tier":{"oneOf":[{"type":"integer","description":"For approved API partners only. A custom price tier for this product."},{"type":"null","description":"For approved API partners only. A custom price tier for this product."}]}}}]}},"required":["id","name","brand","variants","images","price","price_is_variable","restricted_states"]}},"required":["id","product"]},"description":"Products assigned to this category in their display order."}},"required":["id","name","is_featured","position","collection_products"]},"description":"Categories and their products included in this version, ordered by position."}]}},"required":["id","multiple_select_mode","international_shipping_tier","international_gift_cards_enabled"],"uniqueKey":"published_version.oneOf.1","typeLabel":"null"}],"uniqueKey":"published_version","typeLabel":"object | null"}},"required":["id","workspace_id","is_published"],"uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"exampleType":"examples"},"1974125a-cffc-420f-a332-3525b0257d63":{"description":"Collection not found","content":{"application/json":{"examples":{"Collection not found":{"title":"Collection not found","value":{"error":"Collection not found"}}},"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"096d6789-7d32-4a51-b3e7-7b56b6f14f7f":{"bearer":{"type":"http","scheme":"bearer","description":"Your Goody API key.","scopes":[],"schemeName":"bearer"}}},"servers":{"4a853b92-1c76-4ffd-85bf-5a5539f2953d":{"url":"https://api.ongoody.com","description":"Production"},"dd210492-7675-40b8-833a-2901e08fdf59":{"url":"https://api.sandbox.ongoody.com","description":"Sandbox"}},"schemas":{"9d9f25a7-f907-4624-9ed1-9a9845688bbf":{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true},"name":{"type":"string","isRequired":true},"brand":{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true},"name":{"type":"string","isRequired":true},"logo_image":{"oneOf":[{"type":"object","description":"The logo image for this brand.","required":["url"],"properties":{"url":{"type":"string","isRequired":true},"width":{"type":"integer"},"height":{"type":"integer"}}},{"type":"null","description":"The logo image for this brand.","required":["url"],"properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}}}]},"shipping_price":{"type":"integer","description":"The price of shipping for this brand, in cents."},"free_shipping_minimum":{"oneOf":[{"type":"integer","description":"When set and when the product price is above this amount, shipping is free. In cents. Products in a cart for this brand can combine to reach this threshold."},{"type":"null","description":"When set and when the product price is above this amount, shipping is free. In cents. Products in a cart for this brand can combine to reach this threshold."}]},"commerce_revshare_excluded":{"oneOf":[{"type":"boolean","description":"Whether this brand is excluded from the commerce revenue share. Only displayed on the products endpoint when using a commerce app."},{"type":"null","description":"Whether this brand is excluded from the commerce revenue share. Only displayed on the products endpoint when using a commerce app."}]},"brand_values":{"type":"array","items":{"type":"string"},"description":"An array of brand values for this brand. Potential values are USA Made, Social Impact Driven, Sustainable, Gluten Free, Vegan, Kosher Certified, Female Founded, AAPI Founded, BIPOC Founded, Black Founded, LGBTQ+ Founded, and Hispanic Founded."},"brand_sets":{"oneOf":[{"type":"array","items":{"type":"object","description":"A brand set represents a collection of products from a brand.","properties":{"id":{"type":"string","format":"uuid","isRequired":true},"name":{"type":"string","isRequired":true},"images":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true},"image_large":{"type":"object","properties":{"url":{"type":"string","isRequired":true},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"],"isRequired":true}},"required":["id","image_large"]},"description":"An array of images for this brand set."},"products":{"type":"array","items":{"$circularRef":"9d9f25a7-f907-4624-9ed1-9a9845688bbf"},"description":"An array of products in this brand set."},"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true},"name":{"type":"string","isRequired":true},"subcategories":{"type":"array","items":{"type":"string"},"description":"An array of subcategory names within this category."}},"required":["id","name"]},"description":"An array of categories this brand set belongs to."}},"required":["id","name"]},"description":"An array of brand sets for this brand. Only included when using the brands endpoint."},{"type":"null","description":"An array of brand sets for this brand. Only included when using the brands endpoint."}]}},"required":["id","name"],"isRequired":true},"variants":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true},"name":{"type":"string","isRequired":true},"image_large":{"oneOf":[{"type":"object","required":["url"],"properties":{"url":{"type":"string","isRequired":true},"width":{"type":"integer"},"height":{"type":"integer"}}},{"type":"null","required":["url"],"properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}}}]},"subtitle":{"oneOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name"]},"isRequired":true},"images":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true},"image_large":{"type":"object","properties":{"url":{"type":"string","isRequired":true},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["url"],"isRequired":true}},"required":["id","image_large"]},"isRequired":true},"price":{"type":"integer","description":"The price of the product, in cents.","isRequired":true},"price_is_variable":{"type":"boolean","description":"Whether the price of this product is variable. If true, then the price can be set by the sender.","isRequired":true},"restricted_states":{"type":"array","items":{"type":"string","description":"The US states that this product cannot be shipped to."},"isRequired":true},"subtitle":{"oneOf":[{"type":"string","description":"A description of this product."},{"type":"null","description":"A description of this product."}]},"subtitle_short":{"oneOf":[{"type":"string","description":"An optional one-line description of this product. When provided, it overrides the subtitle when displayed in areas with less space. Not always provided."},{"type":"null","description":"An optional one-line description of this product. When provided, it overrides the subtitle when displayed in areas with less space. Not always provided."}]},"recipient_description":{"oneOf":[{"type":"string","description":"An optional description of this product with custom verbiage for recipients. When provided, it overrides the subtitle for the product when displayed to the recipient. Falls back to the subtitle."},{"type":"null","description":"An optional description of this product with custom verbiage for recipients. When provided, it overrides the subtitle for the product when displayed to the recipient. Falls back to the subtitle."}]},"variants_label":{"oneOf":[{"type":"string","description":"The label for the variants of this product, e.g. \"Size\" or \"Color\"."},{"type":"null","description":"The label for the variants of this product, e.g. \"Size\" or \"Color\"."}]},"variants_num_selectable":{"oneOf":[{"type":"integer","description":"The number of variants that can be selected for this product. For example, if this is a t-shirt, then this would be 1, since you can only select one size. If this were a build-a-box of chocolates, this could be 3 if you could select 3 flavor variants."},{"type":"null","description":"The number of variants that can be selected for this product. For example, if this is a t-shirt, then this would be 1, since you can only select one size. If this were a build-a-box of chocolates, this could be 3 if you could select 3 flavor variants."}]},"variant_groups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true},"name":{"type":"string","description":"The name of the variant group, e.g. \"Size\" or \"Color\".","isRequired":true},"options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true},"name":{"type":"string","description":"The name of the variant group option, e.g. \"Small\" for the \"Size\" variant group.","isRequired":true},"subtitle":{"oneOf":[{"type":"string"},{"type":"null"}]},"color":{"oneOf":[{"type":"string","description":"The hex color code for this option, e.g. \"#000000\", if any."},{"type":"null","description":"The hex color code for this option, e.g. \"#000000\", if any."}]},"image_large":{"oneOf":[{"type":"object","required":["url"],"properties":{"url":{"type":"string","isRequired":true},"width":{"type":"integer"},"height":{"type":"integer"}}},{"type":"null","required":["url"],"properties":{"url":{"type":"string"},"width":{"type":"integer"},"height":{"type":"integer"}}}]}},"required":["id","name"]}}},"required":["id","name"]},"description":"For products that have multiple types of variants, such as both Color and Size, this array contains each group and the options for each group. All variant group permutations have a variant generated for them, constructed from the options in the order of the groups, separated by ` / `, e.g. `Medium / Black` when the groups are Size and Color."},"price_min":{"oneOf":[{"type":"integer","description":"The minimum price of the product, in cents. Only used if price_is_variable is true."},{"type":"null","description":"The minimum price of the product, in cents. Only used if price_is_variable is true."}]},"price_max":{"oneOf":[{"type":"integer","description":"The maximum price of the product, in cents. Only used if price_is_variable is true."},{"type":"null","description":"The maximum price of the product, in cents. Only used if price_is_variable is true."}]},"attributes":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","description":"The label for this attribute, e.g. \"Materials\".","isRequired":true},"content":{"type":"string","description":"The content for this attribute, e.g. \"80% cotton, 20% elastane\". This can be text or sanitized HTML (you might choose to sanitize the HTML as well). Allowed elements are a (href allowed), div, img (src, width height, alt allowed), span, p, br, strong, b, em, i, ol, ul, li, and hr.","isRequired":true}},"required":["label","content"]},"description":"An array of attributes that describe this product."},"status":{"type":"string","enum":["active","inactive"],"description":"Whether this product is active. Since the product catalog only returns active products by default, this is always `true`, except if you are a Commerce API customer using a custom catalog, and are pulling products with the `custom_catalog_show_inactive` flag."},"updated_at":{"type":"string","format":"date-time","description":"The date and time this product was last updated, ISO 8601 format. This is bumped when the product, brand, product variants, product attributes, or product images are updated."},"reserved_options":{"oneOf":[{"type":"object","description":"For approved API partners only.","properties":{"custom_price_tier":{"oneOf":[{"type":"integer","description":"For approved API partners only. A custom price tier for this product."},{"type":"null","description":"For approved API partners only. A custom price tier for this product."}]}}},{"type":"null","description":"For approved API partners only.","properties":{"custom_price_tier":{"oneOf":[{"type":"integer","description":"For approved API partners only. A custom price tier for this product."},{"type":"null","description":"For approved API partners only. A custom price tier for this product."}]}}}]}},"required":["id","name","brand","variants","images","price","price_is_variable","restricted_states"]}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Your Goody API key.","scopes":[],"schemeName":"bearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Your Goody API key.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearer","name":"Authorization"}],"title":"bearer"}]},"originalFileLocation":"goody-api-openapi.json"},"subdomain":"goody","siteName":"Goody Developers","title":"Retrieve a collection - Goody Developers","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-08T14:28:25.832Z","originalFileLocation":"api-reference/collections/retrieve-a-collection.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=\"keywords\" content=\"Goody API, Goody MCP server, gifting API, gift API, MCP server, send gifts with AI, Claude gifting connector, business gifting, autogift\">\u003cmeta data-mint-head name=\"application-name\" content=\"Goody Developers\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/goody/cgM3s1zMuye1hA-n/_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/goody/cgM3s1zMuye1hA-n/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/goody/cgM3s1zMuye1hA-n/_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/goody/cgM3s1zMuye1hA-n/_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/goody/cgM3s1zMuye1hA-n/_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/goody/cgM3s1zMuye1hA-n/_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/goody/cgM3s1zMuye1hA-n/_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/goody/cgM3s1zMuye1hA-n/_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/goody/cgM3s1zMuye1hA-n/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retrieve a collection - Goody Developers\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Goody Developers\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.ongoody.com/api-reference/collections/retrieve-a-collection\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://goody.mintlify.app/_mintlify/api/og/v2?division=Collections\u0026amp;title=Retrieve+a+collection\u0026amp;theme=9ccd498c0c106549735ac92d\u0026amp;signature=15a2ec8ca7a87e3ef61959eb022d392c252714ada286bca61d1fbf512c612ffc\">\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=\"Retrieve a collection - Goody Developers\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://goody.mintlify.app/_mintlify/api/og/v2?division=Collections\u0026amp;title=Retrieve+a+collection\u0026amp;theme=9ccd498c0c106549735ac92d\u0026amp;signature=15a2ec8ca7a87e3ef61959eb022d392c252714ada286bca61d1fbf512c612ffc\">\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/goody/cgM3s1zMuye1hA-n/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Goody Developers\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#9159D6\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.ongoody.com/api-reference/collections/retrieve-a-collection\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/collections/retrieve-a-collection.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.ongoody.com/#organization\",\"name\":\"Goody Developers\",\"url\":\"https://developer.ongoody.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/goody/UtvUnxw3LhFrdzGW/logo.svg?fit=max\u0026auto=format\u0026n=UtvUnxw3LhFrdzGW\u0026q=85\u0026s=271862d59190ae3cec0a504caf00f0dc\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.ongoody.com#website\",\"name\":\"Goody Developers\",\"url\":\"https://developer.ongoody.com\",\"publisher\":{\"@id\":\"https://developer.ongoody.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.ongoody.com/api-reference/collections/retrieve-a-collection#webpage\",\"url\":\"https://developer.ongoody.com/api-reference/collections/retrieve-a-collection\",\"name\":\"Retrieve a collection\",\"dateModified\":\"2026-10-08T14:28:25.832Z\",\"isPartOf\":{\"@id\":\"https://developer.ongoody.com#website\"},\"breadcrumb\":{\"@id\":\"https://developer.ongoody.com/api-reference/collections/retrieve-a-collection#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.ongoody.com/api-reference/collections/retrieve-a-collection#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Collections\",\"item\":\"https://developer.ongoody.com/api-reference/collections/list-all-collections\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Retrieve a collection\",\"item\":\"https://developer.ongoody.com/api-reference/collections/retrieve-a-collection\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.ongoody.com/api-reference/collections/retrieve-a-collection#apireference\",\"headline\":\"Retrieve a collection\",\"name\":\"Retrieve a collection\",\"url\":\"https://developer.ongoody.com/api-reference/collections/retrieve-a-collection\",\"mainEntityOfPage\":{\"@id\":\"https://developer.ongoody.com/api-reference/collections/retrieve-a-collection#webpage\"},\"dateModified\":\"2026-10-08T14:28:25.832Z\",\"publisher\":{\"@id\":\"https://developer.ongoody.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.ongoody.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Goody Developers\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Goody Developers","nav":{"global":null,"anchors":[{"anchor":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/introduction/overview"}]},{"anchor":"API Reference","icon":"square-terminal","groups":[{"group":"Order Batches","pages":[{"openapi":"POST /v1/order_batches","title":"Create an order batch","href":"/api-reference/order-batches/create-an-order-batch"},{"openapi":"GET /v1/order_batches","title":"List all order batches","href":"/api-reference/order-batches/list-all-order-batches"},{"openapi":"GET /v1/order_batches/{id}","title":"Retrieve an order batch","href":"/api-reference/order-batches/retrieve-an-order-batch"},{"openapi":"GET /v1/order_batches/{id}/orders","title":"Retrieve orders for an order batch","href":"/api-reference/order-batches/retrieve-orders-for-an-order-batch"},{"openapi":"GET /v1/order_batches/{id}/recipients","title":"Retrieve recipients for an order batch","href":"/api-reference/order-batches/retrieve-recipients-for-an-order-batch"},{"openapi":"POST /v1/order_batches/price","title":"Calculate the price for an order batch","href":"/api-reference/order-batches/calculate-the-price-for-an-order-batch"}]},{"group":"Orders","pages":[{"openapi":"GET /v1/orders","title":"List all orders","href":"/api-reference/orders/list-all-orders"},{"openapi":"GET /v1/orders/{id}","title":"Retrieve an order","href":"/api-reference/orders/retrieve-an-order"},{"openapi":"POST /v1/orders/{id}/cancel","title":"Cancel an order","href":"/api-reference/orders/cancel-an-order"},{"openapi":"POST /v1/orders/{id}/update_expiration","title":"Update expiration for an order","href":"/api-reference/orders/update-expiration-for-an-order"}]},{"group":"Brands","pages":[{"openapi":"GET /v1/brands","title":"List all active brands","href":"/api-reference/brands/list-all-active-brands"}]},{"group":"Products","pages":[{"openapi":"GET /v1/products","title":"List all active products","href":"/api-reference/products/list-all-active-products"},{"openapi":"GET /v1/products/{id}","title":"Retrieve a product","href":"/api-reference/products/retrieve-a-product"}]},{"group":"Payment Methods","pages":[{"openapi":"GET /v1/payment_methods","title":"List all payment methods","href":"/api-reference/payment-methods/list-all-payment-methods"}]},{"group":"Commerce User Payment Methods","pages":[{"openapi":"POST /v1/commerce_user_payment_methods","title":"Create a commerce user payment method","href":"/api-reference/commerce-user-payment-methods/create-a-commerce-user-payment-method"}]},{"group":"Workspaces","pages":[{"openapi":"GET /v1/workspaces","title":"List all workspaces","href":"/api-reference/workspaces/list-all-workspaces"}]},{"group":"Cards","pages":[{"openapi":"GET /v1/cards","title":"List all active cards","href":"/api-reference/cards/list-all-active-cards"}]},{"group":"Collections","pages":[{"openapi":"GET /v1/collections","title":"List all collections","description":null,"href":"/api-reference/collections/list-all-collections"},{"openapi":"GET /v1/collections/{id}","title":"Retrieve a collection","href":"/api-reference/collections/retrieve-a-collection"}]},{"group":"Order Activities","pages":[{"openapi":"GET /v1/order_activities","title":"List all order activities","description":null,"href":"/api-reference/order-activities/list-all-order-activities"}]},{"group":"Me","pages":[{"openapi":"GET /v1/me","title":"Retrieve current user","href":"/api-reference/retrieve-current-user"}]},{"group":"Schemas","pages":[{"group":"Schemas","pages":[{"title":"Error","icon":"cube","href":"/api-reference/schemas/error"},{"title":"ListMeta","icon":"cube","href":"/api-reference/schemas/listmeta"},{"title":"OrderBatch","icon":"cube","href":"/api-reference/schemas/orderbatch"},{"title":"Order","icon":"cube","href":"/api-reference/schemas/order"},{"title":"OrderBatchRecipient","icon":"cube","href":"/api-reference/schemas/orderbatchrecipient"},{"title":"Cart","icon":"cube","href":"/api-reference/schemas/cart"},{"title":"CartItem","icon":"cube","href":"/api-reference/schemas/cartitem"},{"title":"OrderBatchSendStatus","icon":"cube","href":"/api-reference/schemas/orderbatchsendstatus"},{"title":"OrderStatus","icon":"cube","href":"/api-reference/schemas/orderstatus"},{"title":"Shipment","icon":"cube","href":"/api-reference/schemas/shipment"},{"title":"Product","icon":"cube","href":"/api-reference/schemas/product"},{"title":"Brand","icon":"cube","href":"/api-reference/schemas/brand"},{"title":"ProductImage","icon":"cube","href":"/api-reference/schemas/productimage"},{"title":"ProductVariant","icon":"cube","href":"/api-reference/schemas/productvariant"},{"title":"Image","icon":"cube","href":"/api-reference/schemas/image"},{"title":"MailingAddress","icon":"cube","href":"/api-reference/schemas/mailingaddress"},{"title":"Me","icon":"cube","href":"/api-reference/schemas/me"},{"title":"Sender","icon":"cube","href":"/api-reference/schemas/sender"},{"title":"OrderBatchInput","icon":"cube","href":"/api-reference/schemas/orderbatchinput"},{"title":"CartInput","icon":"cube","href":"/api-reference/schemas/cartinput"},{"title":"CartItemInput","icon":"cube","href":"/api-reference/schemas/cartiteminput"},{"title":"OrderBatchSendMethod","icon":"cube","href":"/api-reference/schemas/orderbatchsendmethod"},{"title":"RecipientInput","icon":"cube","href":"/api-reference/schemas/recipientinput"},{"title":"RecipientInput","icon":"cube","href":"/api-reference/schemas/recipientinput"}]}]}]},{"anchor":"MCP Reference","icon":"robot","pages":[{"title":"MCP Reference","href":"/mcp-reference/capabilities"}]}]},"title":"Retrieve a collection - Goody Developers","buildId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","deploymentId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-WRhTSUDL.js","utils-ChMov4Kr.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-_REmC2bI.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp6nVRCu.js","snippetPresets-DZadmXoU.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-R3M_BF4L.js","ApiExamples-CY2WdoTl.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DwYG-Q4l.js","shallow-BXQIGwv4.js","getApiPlaygroundDisplay-CK5nK5B9.js","CodeSnippet-TH4a2aGW.js","CodeSnippets-DwsQiOFS.js","getPastedJson-DD7kUzi_.js","icon-holE3QoJ.js","MethodPill-DUW0T8us.js","DuplicateIcon-CI_p4be-.js","createIcon-BdbRvavb.js","DynamicMarkdown-DN96a4Ur.js","SectionHeading-SCu36A9d.js","axios-vUo_bRtp.js","Markdown-CCeGv-zI.js","clsx-BGBGWFTt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-Cv_O2fky.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-2C5OB2eV.js"]}