Welcome to the Avory Docs. Here you will find documentation for all products and public API endpoints.
Coming in v2
This documentation is currently provisional and will be fully maintained starting with the v2 update of CafePOS Lite. New products will also be released following the v2 launch.
{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"Avory Docs","colors":{"primary":"#a481f5","light":"#4a3175","dark":"#552d99"},"logo":{"light":"https://mintcdn.com/nextgenretailsystems/6tpvP9DDdA66qQzO/images/Avory-Logo.black.svg?fit=max\u0026auto=format\u0026n=6tpvP9DDdA66qQzO\u0026q=85\u0026s=5d249295d720683ee483bdbdca5d8281","dark":"https://mintcdn.com/nextgenretailsystems/6tpvP9DDdA66qQzO/images/Avory-Logo.white.svg?fit=max\u0026auto=format\u0026n=6tpvP9DDdA66qQzO\u0026q=85\u0026s=96ed7bb813e26ee1f72ae59a0f253507"},"favicon":{"light":"https://mintcdn.com/nextgenretailsystems/6tpvP9DDdA66qQzO/images/Avory-Logo.black.svg?fit=max\u0026auto=format\u0026n=6tpvP9DDdA66qQzO\u0026q=85\u0026s=5d249295d720683ee483bdbdca5d8281","dark":"https://mintcdn.com/nextgenretailsystems/6tpvP9DDdA66qQzO/images/Avory-Logo.white.svg?fit=max\u0026auto=format\u0026n=6tpvP9DDdA66qQzO\u0026q=85\u0026s=96ed7bb813e26ee1f72ae59a0f253507"},"api":{"playground":{"proxy":false}},"background":{"decoration":"grid","color":{"light":"#ffffff","dark":"#000000"}},"footer":{"socials":{"discord":"https://discord.gg/s4k6VgNw"}},"fonts":{"family":"SF Pro Display","source":"https://cdn.jsdelivr.net/npm/sf-font@1.0.0/SFProDisplay-Regular.woff","format":"woff"},"styling":{"codeblocks":{"theme":{"light":"github-light","dark":"github-dark"}},"latex":false},"errors":{"404":{"redirect":false,"title":"Page Not Found","description":"The page you are looking for does not exist."}},"contextual":{"options":["copy","chatgpt","claude"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"nextgenretailsystems","hasAudioNarration":false,"actualSubdomain":"nextgenretailsystems","customDomains":["docs.avory.group"],"gitSource":{"type":"github","owner":"avory-group","repo":"avory-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"feedback":{"thumbs":true,"issues":true,"edits":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6a93cf1ad4cdecabe46ce547","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"v1 Documentations","count":7},{"language":"default","tag":"NGS CafePOS Lite","count":5}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"welcome","slug":"/welcome","pageMetadata":{"title":"Welcome","icon":"hand-wave","description":"Welcome to the Avory Docs. Here you will find documentation for all products and public API endpoints.","href":"/welcome"},"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: \"Welcome to the Avory Docs. Here you will find documentation for all products and public API endpoints.\"\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={hr:`hr`,p:`p`,..._provideComponents(),...props.components},{Card}=_components;if(!Card)_missingMdxReference(`Card`,true);return _jsxs(_Fragment,{children:[_jsx(Card,{title:`Coming in v2`,icon:`sparkles`,children:_jsx(_components.p,{children:`This documentation is currently provisional and will be fully maintained starting with the v2 update of CafePOS Lite. New products will also be released following the v2 launch.`})}),`\n`,_jsx(_components.hr,{})]})}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":{"codeStyling":{"theme":{"light":"github-light","dark":"github-dark"}},"config":{},"pageMetadata":{"title":"Welcome","icon":"hand-wave","description":"Welcome to the Avory Docs. Here you will find documentation for all products and public API endpoints.","href":"/welcome"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"nextgenretailsystems","siteName":"Avory Docs","title":"Welcome - Avory Docs","navMaps":{"firstHrefInVersion":{"v1":{"href":"/welcome","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-05-18T19:07:15.829Z","originalFileLocation":"welcome.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=\"Welcome to the Avory Docs. Here you will find documentation for all products and public API endpoints.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Avory 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/nextgenretailsystems/w56RRxoo7HITbEIF/_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/nextgenretailsystems/w56RRxoo7HITbEIF/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/nextgenretailsystems/w56RRxoo7HITbEIF/_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/nextgenretailsystems/w56RRxoo7HITbEIF/_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/nextgenretailsystems/w56RRxoo7HITbEIF/_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/nextgenretailsystems/w56RRxoo7HITbEIF/_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/nextgenretailsystems/w56RRxoo7HITbEIF/_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/nextgenretailsystems/w56RRxoo7HITbEIF/_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/nextgenretailsystems/w56RRxoo7HITbEIF/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Welcome - Avory Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Welcome to the Avory Docs. Here you will find documentation for all products and public API endpoints.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Avory Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.avory.group/welcome\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://nextgenretailsystems.mintlify.site/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Welcome\u0026amp;description=Welcome+to+the+Avory+Docs.+Here+you+will+find+documentation+for+all+products+and+public+API+endpoints.\u0026amp;theme=4f15cde209791178ffb70886\u0026amp;signature=9d5e37c4196c13e96fa2b40ca7a5d48e2eb7aa163cc1361ba997224ba0ab53d0\">\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=\"Welcome - Avory Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Welcome to the Avory Docs. Here you will find documentation for all products and public API endpoints.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://nextgenretailsystems.mintlify.site/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Welcome\u0026amp;description=Welcome+to+the+Avory+Docs.+Here+you+will+find+documentation+for+all+products+and+public+API+endpoints.\u0026amp;theme=4f15cde209791178ffb70886\u0026amp;signature=9d5e37c4196c13e96fa2b40ca7a5d48e2eb7aa163cc1361ba997224ba0ab53d0\">\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/nextgenretailsystems/w56RRxoo7HITbEIF/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Avory Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#a481f5\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.avory.group/welcome\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/welcome.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.avory.group/#organization\",\"name\":\"Avory Docs\",\"url\":\"https://docs.avory.group\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/nextgenretailsystems/6tpvP9DDdA66qQzO/images/Avory-Logo.black.svg?fit=max\u0026auto=format\u0026n=6tpvP9DDdA66qQzO\u0026q=85\u0026s=5d249295d720683ee483bdbdca5d8281\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.avory.group#website\",\"name\":\"Avory Docs\",\"url\":\"https://docs.avory.group\",\"publisher\":{\"@id\":\"https://docs.avory.group/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.avory.group/welcome#webpage\",\"url\":\"https://docs.avory.group/welcome\",\"name\":\"Welcome\",\"description\":\"Welcome to the Avory Docs. Here you will find documentation for all products and public API endpoints.\",\"dateModified\":\"2026-05-18T19:07:15.829Z\",\"isPartOf\":{\"@id\":\"https://docs.avory.group#website\"}},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.avory.group/welcome#article\",\"headline\":\"Welcome\",\"name\":\"Welcome\",\"description\":\"Welcome to the Avory Docs. Here you will find documentation for all products and public API endpoints.\",\"url\":\"https://docs.avory.group/welcome\",\"mainEntityOfPage\":{\"@id\":\"https://docs.avory.group/welcome#webpage\"},\"dateModified\":\"2026-05-18T19:07:15.829Z\",\"publisher\":{\"@id\":\"https://docs.avory.group/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.avory.group#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Avory Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Avory Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/welcome.md","siteName":"Avory Docs","nav":{"global":null,"versions":[{"version":"v1","tabs":[{"tab":"v1 Documentations","icon":"airplay","pages":[{"title":"Welcome","icon":"hand-wave","href":"/welcome"},{"title":"Terms Of Service","icon":"book-bookmark","description":"Avory Group Terms of Service","href":"/terms-of-service"},{"group":"NGS CafePOS Lite","icon":"coffee-pot","expanded":true,"pages":[{"title":"Installation","icon":"screwdriver-wrench","href":"/ngs_cafepos_lite/installation"},{"title":"Configuration","icon":"gear-code","href":"/ngs_cafepos_lite/configuration"},{"title":"Updating","icon":"arrows-rotate","href":"/ngs_cafepos_lite/updating"},{"title":"API","icon":"server","href":"/ngs_cafepos_lite/api"},{"title":"Global Config","icon":"globe-wifi","href":"/ngs_cafepos_lite/gconfig"}]}]},{"tab":"API reference","icon":"server","hidden":true,"pages":[{"title":"API reference","href":"/api-reference/introduction"}]},{"tab":"Test Tab"}]},{"version":"v2","hidden":true}]},"basePath":"","title":"Welcome - Avory Docs","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":[],"chunks":[]}