Prerequisites and best practices for integrating with the Voyado Elevate API
The Voyado Elevate API enables server- and client-side integrations through HTTP requests that return raw JSON data, enabling unlimited flexibility and customization. The API handles communication with the Voyado Elevate cluster and includes both automatic load balancing and failover.The API has three main integration areas: imports to bring products and content into Elevate, queries to retrieve results, and notifications to share visitor behavior with Elevate for reporting and behavior analysis.A JavaScript library, including TypeScript models, is available to facilitate client-side integrations to Voyado Elevate using the HTTP API.
Once these have been met, read through Tips and best practices and continue with integrating queries and notifications using the Storefront API. Meanwhile, products and content are imported using the Admin API.
Cross-origin resource sharing (CORS) is a mechanism for controlling what domain Ajax requests to the cluster are allowed to originate from. Voyado can help with the origin host configuration as part of the customer onboarding process, if you provide the necessary information.Default configuration allows Ajax requests originating from all origins, but restricting access to the API is recommended. The following information is needed from the customer to configure the origin host correctly:
A general rule of thumb is to never cache Elevate-generated responses. Caching prevents personalization and can cause notifications to be erroneous due to cached tickets. This does not include static data and resources such as images, which can be cached.
To keep your Elevate usage and analytics accurate, ensure you allow well-known crawlers (for example, Googlebot) but block or throttle unwanted bots. Detect bots early and avoid calling Elevate APIs for them. Learn more in Handling bots and crawlers.
Format of the data being sent, JSON is recommended. To support large requests with unique page configurations, queries can be performed through HTTP POST. Queries return JSON objects as responses, but requests in browsers with application/json as Content-Type automatically trigger a preflight request. To avoid this, text/plain is supported as Content-Type and can be used in client-side integrations.
User-Agent
PostmanRuntime/1.2.3
For internal tracking and troubleshooting, as well as to support potential future features, it is recommended to include a User-Agent header in HTTP API requests.
Each version of each API contains a downloadable OpenAPI specification that can be used with tools such as Swagger UI. The OpenAPI specifications are found under Specifications for the corresponding API version.
Each version of each API contains a downloadable Postman collection that can be tested using the tool Postman. The collections are found under Postman collections.
Note that the file uses environment variables, located under the Variables tab in the Postman interface. To run the requests, the cluster-id variable must first be changed. The cluster-id will automatically be applied to the baseUrl parameter.
Last modified on October 28, 2026
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Product Discovery developer docs","description":"Product Discovery developer docs","colors":{"primary":"#fe4a49","light":"#ff8785","dark":"#4c093e"},"logo":{"light":"https://mintcdn.com/elevatedocs/1uBQSi2ovHREOrJm/assets/logo/voyado-light-logo.svg?fit=max\u0026auto=format\u0026n=1uBQSi2ovHREOrJm\u0026q=85\u0026s=6ab6674fd4ef6d98e2e482644482eaf8","dark":"https://mintcdn.com/elevatedocs/1uBQSi2ovHREOrJm/assets/logo/voyado-dark-logo.svg?fit=max\u0026auto=format\u0026n=1uBQSi2ovHREOrJm\u0026q=85\u0026s=ce9a169f8b3235ef225c95f50b3e3853","href":"/docs/home/about"},"favicon":"https://mintcdn.com/elevatedocs/U2rlNuBdHmV1mTwc/assets/logo/favicon-bw-32x32.png?fit=max\u0026auto=format\u0026n=U2rlNuBdHmV1mTwc\u0026q=85\u0026s=5b0c7f8a7b5c7f1c304eacf65bc6b39d","api":{"playground":{"display":"interactive"},"examples":{"defaults":"all","languages":["curl","javascript","java","csharp","python"],"prefill":true}},"appearance":{"default":"light"},"background":{"color":{"light":"#ffffff","dark":"#1e2129"}},"navbar":{"links":[{"icon":"/assets/icons/help-center-link.png","href":"https://help.elevate.voyado.com/hc/en-gb","label":"Help Center"}],"primary":{"type":"button","label":"Contact us","href":"https://voyado.com/about-voyado/contact-us/"}},"seo":{"metatags":{"og:site_name":"Product Discovery developer docs","og:type":"website"},"organization":{"id":"https://voyado.com/","legalName":"Voyado Lund AB","url":"https://voyado.com/","logo":"https://voyado.com/wp-content/uploads/2023/01/cropped-Favicon-192x192.png","sameAs":["https://www.linkedin.com/company/voyadoab/","https://www.facebook.com/voyado/","https://www.instagram.com/voyado_official/"]},"indexing":"navigable"},"fonts":{"heading":{"family":"Voyado Text","source":"https://mintlify-assets.b-cdn.net/VoyadoText-Medium.woff2","format":"woff2"},"body":{"family":"Voyado Regular","source":"https://mintlify-assets.b-cdn.net/VoyadoText-Regular.woff2","format":"woff2"}},"styling":{"eyebrows":"breadcrumbs","latex":false},"integrations":{"cookies":{"key":"mintlify_telemetry","value":"granted"}},"contextual":{"options":["claude","chatgpt","assistant","copy","view","mcp"],"display":"header"},"metadata":{"timestamp":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"elevatedocs","hasAudioNarration":false,"actualSubdomain":"elevatedocs","customDomains":["product-discovery.developer.voyado.com"],"gitSource":{"type":"github","owner":"voyado","repo":"elevate-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6ae1b640661bff0c6e7268b7","collectionId":"6995d297-6474-4fdf-99f9-16c317ed200c","liveDeploymentHistoryId":"6ae1b640661bff0c6e7268b7","schemaVersion":"v3"},"feedback":{"thumbs":false,"agentFeedback":false},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae1b640661bff0c6e7268b7","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"API","count":69},{"language":"default","tag":"Admin","count":42},{"language":"default","tag":"v3","count":39},{"language":"default","tag":"Guides","count":24},{"language":"default","tag":"v4","count":23},{"language":"default","tag":"Integration","count":23},{"language":"default","tag":"Storefront","count":22},{"language":"default","tag":"Add-ons","count":12},{"language":"default","tag":"Export","count":12},{"language":"default","tag":"Import","count":12}],"searchSettings":{"maxResults":8,"showContentSnippets":false,"isFiltersEnabled":false}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":true,"enableContextualStarterQuestions":true,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"type":"link","url":"https://voyado.com/about-voyado/contact-us/"}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"privacy":{"consentBanner":{"enabled":false}},"googleFontsInlined":false},"customCss":[{"filePath":"styles/style.css","content":".border-b{border-bottom-width:2px;border-color:rgb(var(--gray-200))}html.dark .border-b,html.dark .prose pre{border-color:rgba(255,255,255,.18)}.prose-sm{font-size:.9rem;line-height:1.7}html.dark{--gray-50:222 227 234;--gray-100:213 218 226;--gray-200:197 203 213;--gray-300:176 183 194;--gray-400:145 152 164}html.dark .prose{--tw-prose-body:#b3b9c4;--tw-prose-headings:#d2d7e0;--tw-prose-lead:#a7aeba;--tw-prose-links:#c5cbd5;--tw-prose-bold:#dde2ea;--tw-prose-counters:#8d95a2;--tw-prose-bullets:#626a78;--tw-prose-hr:#363c47;--tw-prose-quotes:#cdd3dc;--tw-prose-quote-borders:#454c58;--tw-prose-captions:#8d95a2;--tw-prose-code:#cdd3dc;--tw-prose-pre-code:#cdd3dc;--tw-prose-th-borders:#5c6474;--tw-prose-td-borders:#4a5162}.prose :where(code):not(:where([class~=not-prose],[class~=not-prose] *)){color:var(--tw-prose-code);font-weight:500;background-color:#f8f8f7;border:1px solid #c7dbe8;border-radius:4px;padding-left:.25em;padding-right:.25em}html.dark .prose :where(code):not(:where([class~=not-prose],[class~=not-prose] *)){color:#cdd3dc;background-color:#272c36;border-color:#3a404b}.prose pre code{background-color:transparent!important;border:0!important;color:inherit!important;font-weight:400;padding-left:0!important}.py-1\\.5{padding-top:1px;padding-bottom:1px}@media (min-width:1024px){.lg\\:mt-8{margin-top:1rem}}html.dark #navigation-items a[aria-current=page]{background-color:rgb(var(--primary)/.14);color:#ff8785}html.dark #navigation-items a[aria-current=page] *{color:inherit}html.dark .code-block.dark\\:bg-white\\/5,html.dark .dark\\:bg-codeblock{background-color:#1e2129}html.dark .dark\\:bg-codeblock\\/50{background-color:rgb(30 33 41/.5)}html.dark .prose table thead tr,html.dark [data-component-part=code-block-header]{background-color:rgba(255,255,255,.06)}html.dark .code-block-background,html.dark [data-fade-overlay],html.dark pre.shiki{--shiki-dark-bg:#1e2129!important;--fade-color-dark:#1e2129!important}.sidebar-title{margin-bottom:-.3rem;font-size:15px}#pagination{display:none!important}.help-center-card [data-component-part=card-icon]{width:2rem;height:2rem;flex-shrink:0;display:flex;align-items:center;justify-content:center}.help-center-card [data-component-part=card-icon] img{width:2rem;height:2rem;object-fit:contain}#topbar-cta-button a>span:first-child{background-color:rgb(var(--primary)/.1);border:1px solid rgb(var(--primary)/.25)}html.dark #topbar-cta-button a>span:first-child{background-color:rgb(var(--primary)/.14);border-color:rgb(var(--primary)/.3)}#topbar-cta-button a:hover>span:first-child{background-color:rgb(var(--primary)/.18);opacity:1}html.dark #topbar-cta-button a:hover>span:first-child{background-color:rgb(var(--primary)/.22)}#topbar-cta-button a span,#topbar-cta-button a svg,#topbar-cta-button a>div{color:rgb(var(--primary))}html.dark #topbar-cta-button a span,html.dark #topbar-cta-button a svg,html.dark #topbar-cta-button a>div{color:#ff8785}.prose table{border-collapse:collapse;width:100%;max-width:100%;table-layout:auto}.prose table td,.prose table th{border:0;padding:.4rem .5rem;white-space:normal;overflow-wrap:anywhere;word-break:break-word}.accordion [data-table-wrapper=true],[data-component-part=accordion-content] [data-table-wrapper=true]{--page-padding:0px;max-width:100%}.prose table thead tr{background-color:rgba(0,0,0,.05)}html.dark .prose table thead{border-color:#4b5261}html.dark .prose table tr{border-color:#3b4250}.prose table thead th{font-weight:600}.prose table tbody td{background-color:#fff}html.dark .prose table tbody td{background-color:transparent}.prose :where(h2):not(:where([class~=not-prose],[class~=not-prose] *)){margin-top:1.6em;margin-bottom:.7em}.prose :where(h3):not(:where([class~=not-prose],[class~=not-prose] *)),.prose :where(h4):not(:where([class~=not-prose],[class~=not-prose] *)){margin-top:1.5em;margin-bottom:.6em}#mobile-nav [data-elevate-tab-dropdown]{display:none}#mobile-nav [data-elevate-tab-list]{padding-bottom:.75rem;border-bottom:1px solid rgb(var(--gray-200)/.7)}html.dark #mobile-nav [data-elevate-tab-list]{border-bottom-color:rgb(255 255 255/.07)}#mobile-nav [data-elevate-tab-list] ul{display:flex;flex-direction:column;gap:.125rem;margin:0;padding:0;list-style:none}#mobile-nav [data-elevate-tab-list] a{display:block;padding:.375rem .75rem .375rem 1rem;border-radius:.75rem;font-size:1rem;font-weight:500;line-height:1.5rem;color:rgb(var(--gray-700));text-decoration:none}html.dark #mobile-nav [data-elevate-tab-list] a{color:rgb(var(--gray-300))}#mobile-nav [data-elevate-tab-list] a:hover{background-color:rgb(var(--gray-600)/.05)}html.dark #mobile-nav [data-elevate-tab-list] a:hover{background-color:rgb(var(--gray-200)/.05)}#mobile-nav [data-elevate-tab-list] a[data-active]{background-color:rgb(var(--primary)/.1);color:rgb(var(--primary))}html.dark #mobile-nav [data-elevate-tab-list] a[data-active]{background-color:rgb(var(--primary-light)/.1);color:rgb(var(--primary-light))}"}],"page":{"pagePath":"docs/api/getting-started","slug":"/docs/api/getting-started","pageMetadata":{"title":"API overview","description":"Prerequisites and best practices for integrating with the Voyado Elevate API","href":"/docs/api/getting-started"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Prerequisites and best practices for integrating with the Voyado Elevate API\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{Heading,Icon,Table}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Icon)_missingMdxReference(`Icon`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`The Voyado Elevate API enables server- and client-side integrations through HTTP requests that return raw JSON data, enabling unlimited flexibility and customization. The API handles communication with the Voyado Elevate cluster and includes both automatic load balancing and failover.`}),`\n`,_jsx(_components.p,{children:`The API has three main integration areas: imports to bring products and content into Elevate, queries to retrieve results, and notifications to share visitor behavior with Elevate for reporting and behavior analysis.`}),`\n`,_jsxs(_components.p,{children:[`A `,_jsx(_components.a,{href:`/docs/api/javascript-library`,children:`JavaScript library`}),`, including TypeScript models, is available to facilitate client-side integrations to Voyado Elevate using the HTTP API.`]}),`\n`,_jsx(Heading,{level:`2`,id:`prerequisites`,children:`Prerequisites`}),`\n`,_jsx(_components.p,{children:`To get started with the Voyado Elevate API integration, a few prerequisites must be met.`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`#origin-host-and-cross-origin-resource-sharing`,children:`Origin host and cross-origin resource sharing`}),` available`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/docs/home/getting-started#credentials`,children:`Cluster credentials`}),` received`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`#connection-requirements`,children:`Connection requirements`}),` met`]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`Once these have been met, read through `,_jsx(_components.a,{href:`#tips-and-best-practices`,children:`Tips and best practices`}),` and continue with integrating queries and notifications using the `,_jsx(_components.a,{href:`/docs/api/storefront/overview`,children:`Storefront API`}),`. Meanwhile, products and content are imported using the `,_jsx(_components.a,{href:`/docs/api/admin/overview`,children:`Admin API`}),`.`]}),`\n`,_jsx(Heading,{level:`3`,id:`origin-host-and-cross-origin-resource-sharing`,children:`Origin host and cross-origin resource sharing`}),`\n`,_jsx(_components.p,{children:`Cross-origin resource sharing (CORS) is a mechanism for controlling what domain Ajax requests to the cluster are allowed to originate from. Voyado can help with the origin host configuration as part of the customer onboarding process, if you provide the necessary information.`}),`\n`,_jsx(_components.p,{children:`Default configuration allows Ajax requests originating from all origins, but restricting access to the API is recommended. The following information is needed from the customer to configure the origin host correctly:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Protocols (HTTP/HTTPS)`}),`\n`,_jsx(_components.li,{children:`Domains (subdomains)`}),`\n`,_jsx(_components.li,{children:`Ports (80, 443)`}),`\n`]}),`\n`,_jsx(Heading,{level:`3`,id:`connection-requirements`,children:`Connection requirements`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`https://en.wikipedia.org/wiki/Transport_Layer_Security`,children:`TLS`}),` `,_jsx(Icon,{icon:`external-link`,size:12}),` version 1.3 is recommended. Version 1.2 is supported.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`https://en.wikipedia.org/wiki/Server_Name_Indication`,children:`Server Name Indication (SNI)`}),` `,_jsx(Icon,{icon:`external-link`,size:12}),` enabled.`]}),`\n`,_jsxs(_components.li,{children:[`A CA certificate store that trusts Amazon root certificates. For more information, see the `,_jsx(_components.a,{href:`https://www.amazontrust.com/repository/`,children:`Amazon Trust Services Repository`}),` `,_jsx(Icon,{icon:`external-link`,size:12}),`.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`https://en.wikipedia.org/wiki/HTTP`,children:`HTTP`}),` `,_jsx(Icon,{icon:`external-link`,size:12}),` version 2 is recommended. Version 1.1 is also supported.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Deprecated:`}),` a CA certificate store that trusts Let’s Encrypt root certificates. For more information, see `,_jsx(_components.a,{href:`https://letsencrypt.org/docs/certificate-compatibility/`,children:`Let’s Encrypt Certificate Compatibility`}),` `,_jsx(Icon,{icon:`external-link`,size:12}),`.`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`tips-and-best-practices`,children:`Tips and best practices`}),`\n`,_jsx(Heading,{level:`3`,id:`caching`,children:`Caching`}),`\n`,_jsx(_components.p,{children:`A general rule of thumb is to never cache Elevate-generated responses. Caching prevents personalization and can cause notifications to be erroneous due to cached tickets. This does not include static data and resources such as images, which can be cached.`}),`\n`,_jsx(Heading,{level:`3`,id:`bots-and-crawlers`,children:`Bots and crawlers`}),`\n`,_jsxs(_components.p,{children:[`To keep your Elevate usage and analytics accurate, ensure you allow well-known crawlers (for example, Googlebot) but block or throttle unwanted bots. Detect bots early and avoid calling Elevate APIs for them. Learn more in `,_jsx(_components.a,{href:`/docs/guides/operations/bots-and-crawlers`,children:`Handling bots and crawlers`}),`.`]}),`\n`,_jsx(Heading,{level:`3`,id:`request-parameters`,children:`Request parameters`}),`\n`,_jsx(_components.p,{children:`Query parameters are case-sensitive.`}),`\n`,_jsx(Heading,{level:`3`,id:`request-headers`,children:`Request headers`}),`\n`,_jsx(_components.p,{children:`The APIs support various request headers.`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Name`}),_jsx(_components.th,{children:`Values`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`Accept-Encoding`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`gzip`})}),_jsxs(_components.td,{children:[`Enables compressed `,_jsx(_components.a,{href:`https://en.wikipedia.org/wiki/Gzip`,children:`gzip`}),` `,_jsx(Icon,{icon:`external-link`,size:12}),` responses. For optimal performance, it is advised to consistently use compressed responses.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`Accept`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`application/json;charset=utf-8`}),`, `,_jsx(_components.code,{children:`application/jsonlines;charset=utf-8`})]}),_jsx(_components.td,{children:`Format that the client can process in the request.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`Content-Type`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`application/json;charset=utf-8`}),`, `,_jsx(_components.code,{children:`text/plain; charset=utf-8`})]}),_jsxs(_components.td,{children:[`Format of the data being sent, JSON is recommended. To support large requests with unique page configurations, queries can be performed through HTTP `,_jsx(_components.code,{children:`POST`}),`. Queries return JSON objects as responses, but requests in browsers with `,_jsx(_components.code,{children:`application/json`}),` as `,_jsx(_components.code,{children:`Content-Type`}),` automatically trigger a preflight request. To avoid this, `,_jsx(_components.code,{children:`text/plain`}),` is supported as `,_jsx(_components.code,{children:`Content-Type`}),` and can be used in client-side integrations.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`User-Agent`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`PostmanRuntime/1.2.3`})}),_jsxs(_components.td,{children:[`For internal tracking and troubleshooting, as well as to support potential future features, it is recommended to include a `,_jsx(_components.code,{children:`User-Agent`}),` header in HTTP API requests.`]})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`utility-resources`,children:`Utility resources`}),`\n`,_jsx(Heading,{level:`3`,id:`openapi-specifications`,children:`OpenAPI specifications`}),`\n`,_jsxs(_components.p,{children:[`Each version of each API contains a downloadable OpenAPI specification that can be used with tools such as `,_jsx(_components.a,{href:`https://swagger.io/tools/swagger-ui/`,children:`Swagger UI`}),` `,_jsx(Icon,{icon:`external-link`,size:12}),`. The OpenAPI specifications are found under `,_jsx(_components.a,{href:`/docs/api/specifications`,children:`Specifications`}),` for the corresponding API version.`]}),`\n`,_jsx(Heading,{level:`3`,id:`postman-collections`,children:`Postman collections`}),`\n`,_jsxs(_components.p,{children:[`Each version of each API contains a downloadable Postman collection that can be tested using the tool `,_jsx(_components.a,{href:`https://www.postman.com/`,children:`Postman`}),` `,_jsx(Icon,{icon:`external-link`,size:12}),`. The collections are found under `,_jsx(_components.a,{href:`/docs/api/postman`,children:`Postman collections`}),`.`]}),`\n`,_jsx(Heading,{level:`4`,id:`setting-environment-variables`,children:`Setting environment variables`}),`\n`,_jsxs(_components.p,{children:[`Note that the file uses environment variables, located under the `,_jsx(_components.strong,{children:`Variables`}),` tab in the Postman interface. To run the requests, the `,_jsx(_components.code,{children:`cluster-id`}),` variable must first be changed. The `,_jsx(_components.code,{children:`cluster-id`}),` will automatically be applied to the `,_jsx(_components.code,{children:`baseUrl`}),` parameter.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"API overview","description":"Prerequisites and best practices for integrating with the Voyado Elevate API","href":"/docs/api/getting-started"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Prerequisites","slug":"prerequisites","depth":2,"children":[{"title":"Origin host and cross-origin resource sharing","slug":"origin-host-and-cross-origin-resource-sharing","depth":3,"children":[]},{"title":"Connection requirements","slug":"connection-requirements","depth":3,"children":[]}]},{"title":"Tips and best practices","slug":"tips-and-best-practices","depth":2,"children":[{"title":"Caching","slug":"caching","depth":3,"children":[]},{"title":"Bots and crawlers","slug":"bots-and-crawlers","depth":3,"children":[]},{"title":"Request parameters","slug":"request-parameters","depth":3,"children":[]},{"title":"Request headers","slug":"request-headers","depth":3,"children":[]}]},{"title":"Utility resources","slug":"utility-resources","depth":2,"children":[{"title":"OpenAPI specifications","slug":"openapi-specifications","depth":3,"children":[]},{"title":"Postman collections","slug":"postman-collections","depth":3,"children":[]},{"title":"Setting environment variables","slug":"setting-environment-variables","depth":4,"children":[]}]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/elevatedocs/e981000376caad84/scripts/disable-accordion-link-copy.js","/_mintlify/custom/elevatedocs/9f72db540c8d3f36/scripts/mobile-nav-tab-list.js","/_mintlify/custom/elevatedocs/3c15ab69a2191b51/scripts/gtm.js"],"subdomain":"elevatedocs","siteName":"Product Discovery developer docs","title":"API overview - Product Discovery developer docs","relatedPagesConfig":{"enabled":false,"limit":5,"mode":"automatic"},"contextualStarterQuestions":[{"_id":"6aaba4351420944c888a0941","deploymentId":"6a638c2b4251baa99ac33cca","questionText":"How do I set up CORS for my domain?","status":"active","generatedBy":"contextual","path":"docs/api/getting-started","createdAt":"2026-09-17T08:26:29.747Z","updatedAt":"2026-09-17T08:26:29.747Z","__v":0},{"_id":"6aaba4351420944c888a0942","deploymentId":"6a638c2b4251baa99ac33cca","questionText":"What prerequisites do I need?","status":"active","generatedBy":"contextual","path":"docs/api/getting-started","createdAt":"2026-09-17T08:26:29.747Z","updatedAt":"2026-09-17T08:26:29.747Z","__v":0},{"_id":"6aaba4351420944c888a0940","deploymentId":"6a638c2b4251baa99ac33cca","questionText":"What are the API integration areas?","status":"active","generatedBy":"contextual","path":"docs/api/getting-started","createdAt":"2026-09-17T08:26:29.747Z","updatedAt":"2026-09-17T08:26:29.747Z","__v":0}],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-17T08:26:01.798Z","gitLastModified":"2026-10-28T07:26:27.000Z","originalFileLocation":"docs/api/getting-started.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=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Prerequisites and best practices for integrating with the Voyado Elevate API\">\u003cmeta data-mint-head name=\"application-name\" content=\"Product Discovery developer docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/elevatedocs/pFLF7Ck4WVv5gLWu/_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/elevatedocs/pFLF7Ck4WVv5gLWu/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/elevatedocs/pFLF7Ck4WVv5gLWu/_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/elevatedocs/pFLF7Ck4WVv5gLWu/_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/elevatedocs/pFLF7Ck4WVv5gLWu/_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/elevatedocs/pFLF7Ck4WVv5gLWu/_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/elevatedocs/pFLF7Ck4WVv5gLWu/_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/elevatedocs/pFLF7Ck4WVv5gLWu/_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/elevatedocs/pFLF7Ck4WVv5gLWu/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"API overview - Product Discovery developer docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Prerequisites and best practices for integrating with the Voyado Elevate API\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Product Discovery developer docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://product-discovery.developer.voyado.com/docs/api/getting-started\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://elevatedocs.mintlify.app/_mintlify/api/og/v2?division=Overview\u0026amp;title=API+overview\u0026amp;description=Prerequisites+and+best+practices+for+integrating+with+the+Voyado+Elevate+API\u0026amp;theme=f58243c8184ccc363977f3a7\u0026amp;signature=8f649daf3e04ff149c665d69fbd029b273a8587edeb37ae09bbbd7d8387d168d\">\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=\"API overview - Product Discovery developer docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Prerequisites and best practices for integrating with the Voyado Elevate API\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://elevatedocs.mintlify.app/_mintlify/api/og/v2?division=Overview\u0026amp;title=API+overview\u0026amp;description=Prerequisites+and+best+practices+for+integrating+with+the+Voyado+Elevate+API\u0026amp;theme=f58243c8184ccc363977f3a7\u0026amp;signature=8f649daf3e04ff149c665d69fbd029b273a8587edeb37ae09bbbd7d8387d168d\">\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/elevatedocs/pFLF7Ck4WVv5gLWu/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Product Discovery developer docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#fe4a49\">\u003clink data-mint-head rel=\"canonical\" href=\"https://product-discovery.developer.voyado.com/docs/api/getting-started\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api/getting-started.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://voyado.com/\",\"name\":\"Product Discovery developer docs\",\"legalName\":\"Voyado Lund AB\",\"url\":\"https://voyado.com/\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://voyado.com/wp-content/uploads/2023/01/cropped-Favicon-192x192.png\"},\"sameAs\":[\"https://www.linkedin.com/company/voyadoab/\",\"https://www.facebook.com/voyado/\",\"https://www.instagram.com/voyado_official/\"]},{\"@type\":\"WebSite\",\"@id\":\"https://product-discovery.developer.voyado.com#website\",\"name\":\"Product Discovery developer docs\",\"url\":\"https://product-discovery.developer.voyado.com\",\"publisher\":{\"@id\":\"https://voyado.com/\"}},{\"@type\":\"WebPage\",\"@id\":\"https://product-discovery.developer.voyado.com/docs/api/getting-started#webpage\",\"url\":\"https://product-discovery.developer.voyado.com/docs/api/getting-started\",\"name\":\"API overview\",\"description\":\"Prerequisites and best practices for integrating with the Voyado Elevate API\",\"dateModified\":\"2026-10-28T07:26:27.000Z\",\"isPartOf\":{\"@id\":\"https://product-discovery.developer.voyado.com#website\"},\"breadcrumb\":{\"@id\":\"https://product-discovery.developer.voyado.com/docs/api/getting-started#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://product-discovery.developer.voyado.com/docs/api/getting-started#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Product Discovery developer docs\",\"item\":\"https://product-discovery.developer.voyado.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API overview\",\"item\":\"https://product-discovery.developer.voyado.com/docs/api/getting-started\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://product-discovery.developer.voyado.com/docs/api/getting-started#article\",\"headline\":\"API overview\",\"name\":\"API overview\",\"description\":\"Prerequisites and best practices for integrating with the Voyado Elevate API\",\"url\":\"https://product-discovery.developer.voyado.com/docs/api/getting-started\",\"mainEntityOfPage\":{\"@id\":\"https://product-discovery.developer.voyado.com/docs/api/getting-started#webpage\"},\"dateModified\":\"2026-10-28T07:26:27.000Z\",\"publisher\":{\"@id\":\"https://voyado.com/\"},\"isPartOf\":{\"@id\":\"https://product-discovery.developer.voyado.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Product Discovery developer docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Product Discovery developer docs","nav":{"global":null,"tabs":[{"tab":"Home","pages":[{"title":"Home","href":"/docs/home/about"}]},{"tab":"Integration","pages":[{"title":"Integration","href":"/docs/integration/overview"}]},{"tab":"API","groups":[{"group":"Overview","pages":[{"title":"API overview","href":"/docs/api/getting-started"},{"title":"API versioning","description":"How Voyado Elevate versions the Admin and Storefront APIs and manages release lifecycles","href":"/docs/api/api-versioning"},{"title":"OpenAPI specifications","href":"/docs/api/specifications"},{"title":"Postman collections","href":"/docs/api/postman"},{"title":"JavaScript library","href":"/docs/api/javascript-library"}]},{"group":"Admin","pages":[{"title":"Overview","href":"/docs/api/admin/overview"},{"group":"v4","expanded":true,"pages":[{"title":"Overview","href":"/docs/api/admin/v4/overview"},{"title":"Catalog upgrade guide","href":"/docs/api/admin/v4/v4-upgrade"},{"group":"Event data","pages":[{"title":"Create Export Customer Job","href":"/docs/api/admin/v4/event-data/create-export-customer-job"},{"title":"Create Remove Customer Job","href":"/docs/api/admin/v4/event-data/create-remove-customer-job"},{"title":"Export Customer Job Result","href":"/docs/api/admin/v4/event-data/export-customer-job-result"},{"title":"Job Status","href":"/docs/api/admin/v4/event-data/job-status"}]},{"group":"Export","pages":[{"title":"Catalog","href":"/docs/api/admin/v4/export/catalog"},{"title":"Configuration","href":"/docs/api/admin/v4/export/configuration"},{"title":"Navigation","href":"/docs/api/admin/v4/export/navigation"},{"title":"Pages","href":"/docs/api/admin/v4/export/pages"},{"title":"Product Sets","href":"/docs/api/admin/v4/export/product-sets"},{"title":"Templates","href":"/docs/api/admin/v4/export/templates"},{"title":"Upgrade Catalog","href":"/docs/api/admin/v4/export/upgrade-catalog"}]},{"group":"Import","pages":[{"title":"Catalog","href":"/docs/api/admin/v4/import/catalog"},{"title":"Configuration","href":"/docs/api/admin/v4/import/configuration"},{"title":"Navigation","href":"/docs/api/admin/v4/import/navigation"},{"title":"Pages","href":"/docs/api/admin/v4/import/pages"},{"title":"Product Sets","href":"/docs/api/admin/v4/import/product-sets"},{"title":"Status","href":"/docs/api/admin/v4/import/status"},{"title":"Templates","href":"/docs/api/admin/v4/import/templates"}]},{"group":"Notifications","pages":[{"title":"Latest","href":"/docs/api/admin/v4/notifications/latest"},{"title":"Payment","href":"/docs/api/admin/v4/notifications/payment"}]},{"title":"Status","href":"/docs/api/admin/v4/status"}]},{"group":"v3","expanded":false,"pages":[{"title":"Overview","href":"/docs/api/admin/v3/overview"},{"group":"Event data","pages":[{"title":"Create Export Customer Job","deprecated":true,"href":"/docs/api/admin/v3/event-data/create-export-customer-job"},{"title":"Create Remove Customer Job","deprecated":true,"href":"/docs/api/admin/v3/event-data/create-remove-customer-job"},{"title":"Export Customer Job Result","deprecated":true,"href":"/docs/api/admin/v3/event-data/export-customer-job-result"},{"title":"Job Status","deprecated":true,"href":"/docs/api/admin/v3/event-data/job-status"}]},{"group":"Export","pages":[{"title":"Data","deprecated":true,"href":"/docs/api/admin/v3/export/data"},{"title":"Navigation","deprecated":true,"href":"/docs/api/admin/v3/export/navigation"},{"title":"Pages","deprecated":true,"href":"/docs/api/admin/v3/export/pages"},{"title":"Product Groups","deprecated":true,"href":"/docs/api/admin/v3/export/product-groups"},{"title":"Templates","deprecated":true,"href":"/docs/api/admin/v3/export/templates"}]},{"group":"Import","pages":[{"title":"Data","deprecated":true,"href":"/docs/api/admin/v3/import/data"},{"title":"Navigation","deprecated":true,"href":"/docs/api/admin/v3/import/navigation"},{"title":"Pages","deprecated":true,"href":"/docs/api/admin/v3/import/pages"},{"title":"Status","deprecated":true,"href":"/docs/api/admin/v3/import/status"},{"title":"Templates","deprecated":true,"href":"/docs/api/admin/v3/import/templates"}]},{"group":"Notifications","pages":[{"title":"Latest","deprecated":true,"href":"/docs/api/admin/v3/notifications/latest"},{"title":"Payment","deprecated":true,"href":"/docs/api/admin/v3/notifications/payment"}]},{"title":"Status","deprecated":true,"href":"/docs/api/admin/v3/status"}]}]},{"group":"Storefront","pages":[{"title":"Overview","href":"/docs/api/storefront/overview"},{"group":"v3","expanded":true,"pages":[{"title":"Overview","href":"/docs/api/storefront/v3/overview"},{"group":"Notifications","pages":[{"title":"Ad Impression","href":"/docs/api/storefront/v3/notifications/ad-impression"},{"title":"Add Favorite","href":"/docs/api/storefront/v3/notifications/add-favorite"},{"title":"Add To Cart","href":"/docs/api/storefront/v3/notifications/add-to-cart"},{"title":"Click","href":"/docs/api/storefront/v3/notifications/click"},{"title":"End","href":"/docs/api/storefront/v3/notifications/end"},{"title":"Remove Favorite","href":"/docs/api/storefront/v3/notifications/remove-favorite"},{"title":"Remove Recent Searches","href":"/docs/api/storefront/v3/notifications/remove-recent-searches"},{"title":"Remove Recently Viewed","href":"/docs/api/storefront/v3/notifications/remove-recently-viewed"}]},{"group":"Queries","pages":[{"title":"Add To Cart Popup","href":"/docs/api/storefront/v3/queries/add-to-cart-popup"},{"title":"Autocomplete","href":"/docs/api/storefront/v3/queries/autocomplete"},{"title":"Cart Page","href":"/docs/api/storefront/v3/queries/cart-page"},{"title":"Content Information","href":"/docs/api/storefront/v3/queries/content-information"},{"title":"Content Search Page","href":"/docs/api/storefront/v3/queries/content-search-page"},{"title":"Discovery Agent Topic","href":"/docs/api/storefront/v3/queries/discovery-agent-topic"},{"title":"Landing Page","href":"/docs/api/storefront/v3/queries/landing-page"},{"title":"Navigation Tree","href":"/docs/api/storefront/v3/queries/navigation-tree"},{"title":"Product Page","href":"/docs/api/storefront/v3/queries/product-page"},{"title":"Search Page","href":"/docs/api/storefront/v3/queries/search-page"},{"title":"Sponsored Page","href":"/docs/api/storefront/v3/queries/sponsored-page"}]},{"group":"Utilities","pages":[{"title":"Product Information","href":"/docs/api/storefront/v3/utilities/product-information"}]}]}]}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/docs/guides/overview"}]},{"tab":"Add-ons","pages":[{"title":"Add-ons","href":"/docs/addons/overview"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/docs/changelog/changelog"}]}]},"basePath":"","title":"API overview - Product Discovery developer docs","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":[],"chunks":[]}