Add Smile to your custom platform website using the JavaScript SDK or Smile UI.
Adding Smile to your website can be accomplished in a couple of different ways. The first is to use the JavaScript SDK (Smile.js), which is a lightweight JavaScript library that allows you to build a fully custom rewards & loyalty experience, without needing to manage complex API logic yourself. The second is to use Smile UI, which is Smile’s pre-built loyalty panel and launcher whose branding and customization is managed entirely via Smile Admin.
JavaScript SDK
Build a fully custom rewards & loyalty UI.
Smile UI
Use Smile’s pre-built loyalty panel and launcher.
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Smile.io Developer Documentation","description":"Documentation and guides for using Smile's full-stack developer tooling, including the REST API and JavaScript SDK.","colors":{"primary":"#FFC419","light":"#FFC419","dark":"#1E38FB"},"logo":{"light":"https://mintcdn.com/smileio/VRZup3pt_A0wJgq4/images/logo-light.svg?fit=max\u0026auto=format\u0026n=VRZup3pt_A0wJgq4\u0026q=85\u0026s=2ece8527648f4f7eeb076ce9a821f04e","dark":"https://mintcdn.com/smileio/VRZup3pt_A0wJgq4/images/logo-dark.svg?fit=max\u0026auto=format\u0026n=VRZup3pt_A0wJgq4\u0026q=85\u0026s=a0220ce60be88afca90042a3b8b3071a"},"favicon":"https://mintcdn.com/smileio/MiB8uy9lSdXlgs7f/images/favicon.png?fit=max\u0026auto=format\u0026n=MiB8uy9lSdXlgs7f\u0026q=85\u0026s=579525865d082a1a8c53c139ad14ae11","api":{"playground":{"proxy":false},"examples":{"languages":["bash","go","java","node","php","powershell","python","ruby"]}},"navbar":{"links":[{"href":"/changelog","label":"Changelog"}],"primary":{"type":"button","label":"Install Smile","href":"https://apps.shopify.com/smile-io"}},"footer":{"socials":{"website":"https://smile.io","linkedin":"https://www.linkedin.com/company/smile.io","youtube":"https://www.youtube.com/c/smilerewards"},"links":[{"header":"Guides","items":[{"label":"Fundamentals","href":"/guides/fundamentals"},{"label":"Common use cases","href":"/guides/use-cases/common"},{"label":"How to integrate","href":"/guides/apps/integrate"}]},{"header":"Documentation","items":[{"label":"API Reference","href":"/api/introduction"},{"label":"JavaScript SDK","href":"/js/introduction"},{"label":"Smile UI","href":"/ui/introduction"}]},{"header":"Company","items":[{"label":"Careers","href":"https://smile.io/careers"},{"label":"Partners","href":"https://smile.io/partners"},{"label":"Contact us","href":"https://smile.io/contact-us"}]},{"header":"Resources","items":[{"label":"Changelog","href":"/changelog"},{"label":"Help docs","href":"https://help.smile.io"},{"label":"Status page","href":"https://status.smile.io"}]}]},"seo":{"metatags":{"canonical":"https://dev.smile.io"}},"fonts":{"family":"Inter"},"styling":{"latex":false},"integrations":{"posthog":{"apiKey":"phc_bmeJEeepMfRdoeOXjeD5LQ1XaCMdFUdn3tNB830NPvG","apiHost":"https://p.smile.io","sessionRecording":false}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"smileio","hasAudioNarration":false,"actualSubdomain":"smileio","customDomains":["dev.smile.io"],"gitSource":{"type":"github","owner":"smile-io","repo":"dev-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":false,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aee064f6bf90855ba599d09","clientVersion":"0.0.4087","searchFilterCounts":[{"language":"default","tag":"Libraries \u0026 SDKs","count":80},{"language":"default","tag":"JavaScript SDK","count":52},{"language":"default","tag":"Guides","count":42},{"language":"default","tag":"SDK resources","count":38},{"language":"default","tag":"API Reference","count":35},{"language":"default","tag":"Deprecated","count":35},{"language":"default","tag":"API resources","count":29},{"language":"default","tag":"Smile UI","count":28},{"language":"default","tag":"Apps \u0026 integrations","count":13},{"language":"default","tag":"Custom platform","count":12}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":true,"enableContextualStarterQuestions":true,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"@media (max-width: 640px){#home-cards .card-group{grid-template-columns:1fr!important}}@media (min-width: 641px) and (max-width: 1023px){#home-cards .card-group{grid-template-columns:repeat(2, 1fr)!important}}@media (max-width: 640px){:not(#home-cards)>.card-group{grid-template-columns:1fr!important}}@media (min-width: 641px) and (max-width: 1280px){:not(#home-cards)>.card-group{grid-template-columns:repeat(2, 1fr)!important}}ul.contains-task-list{list-style:none;padding-left:0!important}li.task-list-item{list-style:none;padding-left:0!important}li.task-list-item::before{content:none!important}li.task-list-item>input[type=\"checkbox\"]{margin-right:0.5em!important}"}],"page":{"pagePath":"guides/deprecated/custom-platform/custom-frontend-int/overview","slug":"/guides/deprecated/custom-platform/custom-frontend-int/overview","pageMetadata":{"title":"Overview","description":"Add Smile to your custom platform website using the JavaScript SDK or Smile UI.","href":"/guides/deprecated/custom-platform/custom-frontend-int/overview"},"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: \"Add Smile to your custom platform website using the JavaScript SDK or Smile UI.\"\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`,p:`p`,..._provideComponents(),...props.components},{Card,CardGroup}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CardGroup)_missingMdxReference(`CardGroup`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Adding Smile to your website can be accomplished in a couple of different ways. The first is to use the `,_jsx(_components.a,{href:`/js/introduction`,children:`JavaScript SDK`}),` (Smile.js), which is a lightweight JavaScript library that allows you to build a fully custom rewards \u0026 loyalty experience, without needing to manage complex API logic yourself. The second is to use `,_jsx(_components.a,{href:`/ui/including`,children:`Smile UI`}),`, which is Smile’s pre-built loyalty panel and launcher whose branding and customization is managed entirely via Smile Admin.`]}),`\n`,_jsxs(CardGroup,{children:[_jsx(Card,{title:`JavaScript SDK`,icon:`display-code`,href:`/js/introduction`,arrow:`true`,children:_jsx(_components.p,{children:`Build a fully custom rewards \u0026 loyalty UI.`})}),_jsx(Card,{title:`Smile UI`,icon:`browsers`,href:`/ui/introduction`,arrow:`true`,children:_jsx(_components.p,{children:`Use Smile’s pre-built loyalty panel and launcher.`})})]})]})}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":"Overview","description":"Add Smile to your custom platform website using the JavaScript SDK or Smile UI.","href":"/guides/deprecated/custom-platform/custom-frontend-int/overview"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"smileio","siteName":"Smile.io Developer Documentation","title":"Overview - Smile.io Developer Documentation","contextualStarterQuestions":[{"_id":"6aa430ce2872b6741e05d891","deploymentId":"6963e7ff1f9d23b4780f9c32","questionText":"What is Smile UI customization?","status":"active","generatedBy":"contextual","path":"guides/deprecated/custom-platform/custom-frontend-int/overview","createdAt":"2026-09-11T16:48:14.805Z","updatedAt":"2026-09-11T16:48:14.805Z","__v":0},{"_id":"6aa430ce2872b6741e05d890","deploymentId":"6963e7ff1f9d23b4780f9c32","questionText":"How do I add Smile to my website?","status":"active","generatedBy":"contextual","path":"guides/deprecated/custom-platform/custom-frontend-int/overview","createdAt":"2026-09-11T16:48:14.805Z","updatedAt":"2026-09-11T16:48:14.805Z","__v":0},{"_id":"6aa430ce2872b6741e05d88f","deploymentId":"6963e7ff1f9d23b4780f9c32","questionText":"Should I use JavaScript SDK or UI?","status":"active","generatedBy":"contextual","path":"guides/deprecated/custom-platform/custom-frontend-int/overview","createdAt":"2026-09-11T16:48:14.805Z","updatedAt":"2026-09-11T16:48:14.805Z","__v":0}],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-11T16:48:00.926Z","originalFileLocation":"guides/deprecated/custom-platform/custom-frontend-int/overview.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Add Smile to your custom platform website using the JavaScript SDK or Smile UI.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Smile.io Developer Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/smileio/27Cg0i9-pzMj8uaL/_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/smileio/27Cg0i9-pzMj8uaL/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/smileio/27Cg0i9-pzMj8uaL/_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/smileio/27Cg0i9-pzMj8uaL/_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/smileio/27Cg0i9-pzMj8uaL/_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/smileio/27Cg0i9-pzMj8uaL/_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/smileio/27Cg0i9-pzMj8uaL/_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/smileio/27Cg0i9-pzMj8uaL/_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/smileio/27Cg0i9-pzMj8uaL/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Overview - Smile.io Developer Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Add Smile to your custom platform website using the JavaScript SDK or Smile UI.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Smile.io Developer Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://dev.smile.io/guides/deprecated/custom-platform/custom-frontend-int/overview\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://smileio.mintlify.site/_mintlify/api/og/v2?division=Frontend+integration\u0026amp;title=Overview\u0026amp;description=Add+Smile+to+your+custom+platform+website+using+the+JavaScript+SDK+or+Smile+UI.\u0026amp;theme=403a5adfc6df8924e3290bc3\u0026amp;signature=ff14c62e6678d459baf6aebd3a97f9efed88c105aa7dae68c1d6d48f0b4d0544\">\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=\"Overview - Smile.io Developer Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Add Smile to your custom platform website using the JavaScript SDK or Smile UI.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://smileio.mintlify.site/_mintlify/api/og/v2?division=Frontend+integration\u0026amp;title=Overview\u0026amp;description=Add+Smile+to+your+custom+platform+website+using+the+JavaScript+SDK+or+Smile+UI.\u0026amp;theme=403a5adfc6df8924e3290bc3\u0026amp;signature=ff14c62e6678d459baf6aebd3a97f9efed88c105aa7dae68c1d6d48f0b4d0544\">\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/smileio/27Cg0i9-pzMj8uaL/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Smile.io Developer Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FFC419\">\u003clink data-mint-head rel=\"canonical\" href=\"https://dev.smile.io/guides/deprecated/custom-platform/custom-frontend-int/overview\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/guides/deprecated/custom-platform/custom-frontend-int/overview.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://dev.smile.io/#organization\",\"name\":\"Smile.io Developer Documentation\",\"url\":\"https://dev.smile.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/smileio/VRZup3pt_A0wJgq4/images/logo-light.svg?fit=max\u0026auto=format\u0026n=VRZup3pt_A0wJgq4\u0026q=85\u0026s=2ece8527648f4f7eeb076ce9a821f04e\"}},{\"@type\":\"WebSite\",\"@id\":\"https://dev.smile.io#website\",\"name\":\"Smile.io Developer Documentation\",\"url\":\"https://dev.smile.io\",\"publisher\":{\"@id\":\"https://dev.smile.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://dev.smile.io/guides/deprecated/custom-platform/custom-frontend-int/overview#webpage\",\"url\":\"https://dev.smile.io/guides/deprecated/custom-platform/custom-frontend-int/overview\",\"name\":\"Overview\",\"description\":\"Add Smile to your custom platform website using the JavaScript SDK or Smile UI.\",\"dateModified\":\"2026-09-11T16:48:00.926Z\",\"isPartOf\":{\"@id\":\"https://dev.smile.io#website\"},\"breadcrumb\":{\"@id\":\"https://dev.smile.io/guides/deprecated/custom-platform/custom-frontend-int/overview#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://dev.smile.io/guides/deprecated/custom-platform/custom-frontend-int/overview#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Deprecated\",\"item\":\"https://dev.smile.io/guides/deprecated/custom-html-emails/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Custom platform\",\"item\":\"https://dev.smile.io/guides/deprecated/custom-platform/overview\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Overview\",\"item\":\"https://dev.smile.io/guides/deprecated/custom-platform/custom-frontend-int/overview\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://dev.smile.io/guides/deprecated/custom-platform/custom-frontend-int/overview#article\",\"headline\":\"Overview\",\"name\":\"Overview\",\"description\":\"Add Smile to your custom platform website using the JavaScript SDK or Smile UI.\",\"url\":\"https://dev.smile.io/guides/deprecated/custom-platform/custom-frontend-int/overview\",\"mainEntityOfPage\":{\"@id\":\"https://dev.smile.io/guides/deprecated/custom-platform/custom-frontend-int/overview#webpage\"},\"dateModified\":\"2026-09-11T16:48:00.926Z\",\"publisher\":{\"@id\":\"https://dev.smile.io/#organization\"},\"isPartOf\":{\"@id\":\"https://dev.smile.io#website\"}}]}\u003c/script>","siteName":"Smile.io Developer Documentation","nav":{"global":null,"tabs":[{"tab":"Home","pages":[{"title":"Home","href":""}]},{"tab":"Guides","pages":[{"title":"Introduction","mode":"wide","href":"/guides/introduction"},{"title":"Concepts \u0026 fundamentals","href":"/guides/fundamentals"},{"group":"Getting started","icon":"rocket","pages":[{"title":"Common use cases","mode":"wide","href":"/guides/use-cases/common"},{"group":"Custom storefronts","pages":[{"title":"Add Smile to your frontend","href":"/guides/use-cases/custom-frontend"},{"title":"Migrate to the JavaScript SDK","sidebarTitle":"Migrate to the JS SDK","href":"/guides/use-cases/custom-frontend/js-sdk-migration"},{"title":"Shopify Hydrogen","href":"/guides/use-cases/custom-frontend/hydrogen"},{"title":"Headless / Single Page Applications","sidebarTitle":"Headless / SPA","href":"/guides/use-cases/custom-frontend/headless"}]},{"group":"Landing/explainer page","pages":[{"title":"Overview","href":"/guides/use-cases/landing-page/overview"},{"title":"BigCommerce Stencil","href":"/guides/use-cases/landing-page/bigcommerce-stencil"}]},{"title":"Reward for any action","href":"/guides/use-cases/rewarding-for-any-action"},{"group":"Points at checkout","pages":[{"title":"Overview","href":"/guides/use-cases/points-at-checkout/overview"},{"title":"BigCommerce dropdown","href":"/guides/use-cases/points-at-checkout/bigc-points-dropdown"},{"title":"BigCommerce slider","href":"/guides/use-cases/points-at-checkout/bigc-points-slider"}]}]},{"group":"Apps \u0026 integrations","icon":"code","pages":[{"group":"Integrate with Smile","pages":[{"title":"Integration methods","href":"/guides/apps/integrate"},{"title":"Build an app","href":"/guides/apps/build"},{"title":"Use merchant credentials","href":"/guides/apps/merchant-credentials"},{"title":"Migrate from API keys to OAuth","sidebarTitle":"Migrate to OAuth","href":"/guides/apps/migrate-to-oauth"}]},{"title":"Activities","href":"/guides/apps/activities"},{"group":"Authorization","pages":[{"title":"App authorization","mode":"wide","href":"/guides/apps/auth/overview"},{"title":"OAuth flow","href":"/guides/apps/auth/oauth-flow"},{"title":"OAuth errors","href":"/guides/apps/auth/oauth-errors"},{"title":"Access scopes","href":"/guides/apps/auth/access-scopes"},{"title":"Client secret rotation","href":"/guides/apps/auth/oauth-rotation"}]},{"group":"Submission \u0026 review","pages":[{"title":"App submission process","mode":"wide","href":"/guides/apps/submission/process"},{"title":"App requirements","href":"/guides/apps/submission/requirements"}]},{"title":"Webhooks","href":"/guides/apps/webhooks"}]},{"group":"Deprecated","icon":"exclamation-triangle","pages":[{"group":"Custom HTML emails","pages":[{"title":"Overview","href":"/guides/deprecated/custom-html-emails/overview"},{"title":"Handlebar variables","href":"/guides/deprecated/custom-html-emails/custom-email-variables"},{"title":"Object reference","href":"/guides/deprecated/custom-html-emails/custom-email-objects"},{"title":"Example usage","href":"/guides/deprecated/custom-html-emails/custom-email-examples"}]},{"group":"Custom platform","pages":[{"title":"Overview","href":"/guides/deprecated/custom-platform/overview"},{"group":"Backend integration","pages":[{"title":"Overview","href":"/guides/deprecated/custom-platform/custom-backend-int/overview"},{"group":"Customer events","pages":[{"title":"Overview","href":"/guides/deprecated/custom-platform/custom-backend-int/custom-customer-events/overview"},{"title":"Customer object","href":"/guides/deprecated/custom-platform/custom-backend-int/custom-customer-events/custom-customer-object"},{"title":"Customer updated","href":"/guides/deprecated/custom-platform/custom-backend-int/custom-customer-events/custom-customer-updated"},{"title":"Customer deleted","href":"/guides/deprecated/custom-platform/custom-backend-int/custom-customer-events/custom-customer-deleted"}]},{"group":"Order events","pages":[{"title":"Overview","href":"/guides/deprecated/custom-platform/custom-backend-int/custom-order-events/overview"},{"title":"Order object","href":"/guides/deprecated/custom-platform/custom-backend-int/custom-order-events/custom-order-object"},{"title":"Order updated","href":"/guides/deprecated/custom-platform/custom-backend-int/custom-order-events/custom-order-updated"},{"title":"Order deleted","description":"Send this event to Smile any time an order is deleted in your ecommerce system.","href":"/guides/deprecated/custom-platform/custom-backend-int/custom-order-events/custom-order-deleted"}]}]},{"group":"Frontend integration","pages":[{"title":"Overview","href":"/guides/deprecated/custom-platform/custom-frontend-int/overview"}]},{"title":"FAQ","description":"Answers to common questions about building a custom ecommerce platform integration with Smile.","href":"/guides/deprecated/custom-platform/custom-faq"}]}]}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api/introduction"}]},{"tab":"Libraries \u0026 SDKs","dropdowns":[{"dropdown":"JavaScript SDK","icon":"display-code","pages":[{"title":"Introduction","mode":"wide","href":"/js/introduction"},{"title":"Including Smile.js","href":"/js/including"},{"group":"Key concepts","icon":"book","pages":[{"title":"Customer tokens","href":"/js/concepts/customer-tokens"},{"group":"Error management","pages":[{"title":"Error handling","href":"/js/concepts/error-handling"},{"title":"ApiError object","href":"/js/concepts/error-object"}]},{"group":"Lifecycle events","pages":[{"title":"Lifecycle events","href":"/js/concepts/lifecycle-events"},{"title":"Initialized event","href":"/js/concepts/initialized-event"},{"title":"Loaded event","href":"/js/concepts/loaded-event"}]},{"title":"Preloading resources","href":"/js/concepts/preloading"},{"title":"Versioning","href":"/js/concepts/versioning"}]},{"group":"Smile object","icon":"file-code","pages":[{"title":"Initialize the SDK","href":"/js/smile/initialize"},{"title":"Format points","href":"/js/smile/format-points"},{"title":"Preload resources","href":"/js/smile/preload"},{"title":"Reset the SDK","href":"/js/smile/reset"}]},{"group":"SDK resources","icon":"cubes","pages":[{"group":"Activities","pages":[{"title":"Activity object","href":"/js/resources/activities/object"},{"title":"Create an activity","href":"/js/resources/activities/create"}]},{"group":"Customer","pages":[{"title":"Customer object","href":"/js/resources/customer/object"},{"title":"Get current customer","href":"/js/resources/customer/current"},{"title":"Login the customer","href":"/js/resources/customer/login"},{"title":"Logout the customer","href":"/js/resources/customer/logout"}]},{"group":"Customer Points Products","pages":[{"title":"Customer Points Product object","href":"/js/resources/customer-points-products/object"},{"title":"Get customer points products","href":"/js/resources/customer-points-products/get"},{"title":"Preloaded customer points products","href":"/js/resources/customer-points-products/preloaded"}]},{"group":"Customer Points Wallet","pages":[{"title":"Customer Points Wallet object","href":"/js/resources/customer-points-wallet/object"},{"title":"Get customer points wallet","href":"/js/resources/customer-points-wallet/get"},{"title":"Preloaded customer points wallet","href":"/js/resources/customer-points-wallet/preloaded"}]},{"group":"Customer VIP Status","pages":[{"title":"Customer VIP Status object","href":"/js/resources/customer-vip-status/object"},{"title":"Get customer VIP status","href":"/js/resources/customer-vip-status/get"},{"title":"Preloaded customer VIP status","href":"/js/resources/customer-vip-status/preloaded"}]},{"group":"Earning Rules","pages":[{"title":"Earning Rule object","href":"/js/resources/earning-rules/object"},{"title":"Get earning rules","href":"/js/resources/earning-rules/get"},{"title":"Preloaded earning rules","href":"/js/resources/earning-rules/preloaded"}]},{"group":"Points Products","pages":[{"title":"Points Product object","href":"/js/resources/points-products/object"},{"title":"Get a points product","href":"/js/resources/points-products/get-by-id"},{"title":"Get points products","href":"/js/resources/points-products/get"},{"title":"Preloaded points products","href":"/js/resources/points-products/preloaded"},{"title":"Purchase a points product","href":"/js/resources/points-products/purchase"}]},{"group":"Points Purchases","pages":[{"title":"Points Purchase object","href":"/js/resources/points-purchases/object"}]},{"group":"Points Settings","pages":[{"title":"Points Settings object","href":"/js/resources/points-settings/object"},{"title":"Get points settings","href":"/js/resources/points-settings/get"},{"title":"Preloaded points settings","href":"/js/resources/points-settings/preloaded"}]},{"group":"Referral Settings","pages":[{"title":"Referral Settings object","href":"/js/resources/referral-settings/object"},{"title":"Get referral settings","href":"/js/resources/referral-settings/get"},{"title":"Preloaded referral settings","href":"/js/resources/referral-settings/preloaded"}]},{"group":"Rewards","pages":[{"title":"Reward object","href":"/js/resources/rewards/object"}]},{"group":"Reward Fulfillments","pages":[{"title":"Reward Fulfillment object","href":"/js/resources/reward-fulfillments/object"},{"title":"Get reward fulfillments","href":"/js/resources/reward-fulfillments/get"},{"title":"Preloaded reward fulfillments","href":"/js/resources/reward-fulfillments/preloaded"}]},{"group":"VIP Tiers","pages":[{"title":"VIP Tier object","href":"/js/resources/vip-tiers/object"},{"title":"Get a VIP tier","href":"/js/resources/vip-tiers/get-by-id"},{"title":"Get VIP tiers","href":"/js/resources/vip-tiers/get"},{"title":"Preloaded VIP tiers","href":"/js/resources/vip-tiers/preloaded"}]}]}]},{"dropdown":"Smile UI","icon":"browsers","pages":[{"title":"Introduction","mode":"wide","href":"/ui/introduction"},{"title":"Including Smile UI","href":"/ui/including"},{"title":"Initializing Smile UI","href":"/ui/initializing"},{"title":"Customer tokens","href":"/ui/customer-tokens"},{"group":"Panel actions","icon":"hand-pointer","pages":[{"title":"Open panel","href":"/ui/panel/open"},{"title":"Close panel","href":"/ui/panel/close"},{"title":"Deep links","href":"/ui/panel/deep-links"}]},{"group":"Panel events","icon":"square-bolt","pages":[{"title":"Loaded event","href":"/ui/events/ui-loaded"},{"title":"Ready method","href":"/ui/events/ui-ready"}]},{"group":"Deprecated","icon":"exclamation-triangle","pages":[{"title":"Customer ready method","href":"/ui/events/customer-ready"},{"group":"Smile methods","pages":[{"title":"Create an activity","href":"/ui/smile/create-activity"},{"title":"Customer ready","href":"/ui/smile/customer-ready"},{"title":"Format points","href":"/ui/smile/format-points"},{"title":"Load all customer points products","href":"/ui/smile/fetch-all-customer-points-products"},{"title":"Load a points product","href":"/ui/smile/fetch-points-product"},{"title":"Load all points products","href":"/ui/smile/fetch-all-points-products"},{"title":"Load all reward fulfillments","href":"/ui/smile/fetch-all-reward-fulfillments"},{"title":"Purchase a points product","href":"/ui/smile/purchase-points-product"},{"title":"Reload the customer","href":"/ui/smile/fetch-customer"},{"title":"Ready method","href":"/ui/smile/ready"}]},{"group":"Object references","pages":[{"title":"Activity object","href":"/ui/objects/activity"},{"title":"Customer object","href":"/ui/objects/customer"},{"title":"Customer points product object","href":"/ui/objects/customer-points-product"},{"title":"Points product object","href":"/ui/objects/points-product"},{"title":"Points purchase object","href":"/ui/objects/points-purchase"},{"title":"Reward fulfillment object","href":"/ui/objects/reward-fulfillment"},{"title":"Reward object","href":"/ui/objects/reward"},{"title":"VIP Tier object","href":"/ui/objects/vip-tier"}]}]}]}]},{"tab":"Changelog","hidden":true,"pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Overview - Smile.io Developer Documentation","buildId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","deploymentId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","dynamics":[],"chunks":[]}