Everything you need to start integrating with the Buylo API.
Overview
The Buylo API gives you programmatic access to your retail management platform. Use it to register products, manage RFID tag assignments, sync inventory, and integrate Buylo into your existing systems and workflows.The API is built around standard HTTP conventions and returns JSON responses. It is designed to be predictable and easy to integrate — whether you are connecting a WMS, an ERP, or building a custom automation.Base URL
https://api.buylo.app/
What you can do with the API
Register and update products in your Buylo
Assign and manage RFID tags linked to specific products
Query inventory state and tag read history
Trigger and monitor antenna hooks and RFID events
Sync data with external ERP or WMS systems
Authentication
All API requests must be authenticated using an API token. Tokens are generated and managed from the Buylo administration panel under Settings → API Tokens. There is no OAuth flow — authentication is straightforward Bearer token auth.
Generating a token
Log in to your Buylo administration account.
Navigate to Settings → API Tokens.
Click Generate new token and give it a descriptive name (e.g. Production ERP, Staging test).
Copy the token immediately — it will not be shown again.
Set an expiration date and store the token securely.
Token lifecycle
Tokens are scoped to your tenant — they cannot access data from other organizations.
Each token has a configurable expiration date. Expired tokens are rejected immediately.
You can create multiple tokens for different systems or environments.
Revoke a token at any time from the admin panel. Revocation takes effect instantly.
If you delete a token, any system still using it will receive a 401 Unauthorized response. Make sure to update all dependent systems before deleting.
Never commit API tokens to source control. Use environment variables or a secrets manager. Create separate tokens for production, staging, and development environments, and name them clearly so you can identify which system is using each one.
Errors
The Buylo API uses standard HTTP status codes. Errors always return a JSON body with a machine-readable code and a human-readable message to help you debug quickly.
Error response format
{ "error": { "code": "validation_error", "message": "The field 'ean' must be a valid EAN-13 barcode.", "field": "ean" }}
Status codes
Status
Code
Description
200
ok
Request was successful.
400
validation_error
Missing or invalid request parameters.
401
unauthorized
API token is missing, invalid, or expired.
403
forbidden
Token does not have permission for this resource.
404
not_found
The requested resource does not exist.
409
conflict
Resource already exists (e.g. tag already assigned).
422
unprocessable
Request is well-formed but cannot be processed.
500
server_error
Something went wrong on our end. Try again later.
Recommended error handling
Always check the HTTP status code before parsing the response body.
On 401 errors, verify your token has not expired in the admin panel.
On 409 conflicts for tag assignment, unassign the existing tag first.
On 5xx errors, implement exponential backoff with a retry limit of 3 attempts.
Log the full error response body — the message field often pinpoints the exact issue.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Buylo documentation","colors":{"primary":"#62C5C7","light":"#f3ffff","dark":"#4A9999"},"logo":{"light":"https://mintcdn.com/buylo-67b82834/tY0qEQ0MlqSg_ptg/logo/logo-buylo.svg?fit=max\u0026auto=format\u0026n=tY0qEQ0MlqSg_ptg\u0026q=85\u0026s=7c4aa0e4f0f2b0cfbade52769d1419a3","dark":"https://mintcdn.com/buylo-67b82834/tY0qEQ0MlqSg_ptg/logo/logo-buylo.svg?fit=max\u0026auto=format\u0026n=tY0qEQ0MlqSg_ptg\u0026q=85\u0026s=7c4aa0e4f0f2b0cfbade52769d1419a3"},"favicon":"https://mintcdn.com/buylo-67b82834/xAN8S_u7UMqE_ZrD/favicon.ico?fit=max\u0026auto=format\u0026n=xAN8S_u7UMqE_ZrD\u0026q=85\u0026s=0a32b2334efa6bf1bda9b522257a1435","navbar":{"links":[{"href":"mailto:support@buylo.ai","label":"Support"}]},"footer":{"socials":{"x":"https://x.com/mintlify","github":"https://github.com/mintlify","linkedin":"https://linkedin.com/company/mintlify"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"buylo-67b82834","hasAudioNarration":false,"actualSubdomain":"buylo-67b82834","customDomains":["docs.buylo.ai"],"gitSource":{"type":"github","owner":"industrial-it-s-r-o","repo":"buylo-mintlify-doc","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae9486f2b3cf0697cfe0a32:success","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Buylo API","count":18},{"language":"default","tag":"API","count":17},{"language":"default","tag":"Inventories","count":5},{"language":"default","tag":"Product EPC","count":4},{"language":"default","tag":"Products","count":4},{"language":"default","tag":"Buylo documentation","count":1},{"language":"default","tag":"Antennas","count":1},{"language":"default","tag":"EAN Registry","count":1},{"language":"default","tag":"Locations","count":1},{"language":"default","tag":"Packing Stations","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"index","slug":"/","pageMetadata":{"title":"Introduction","description":"Everything you need to start integrating with the Buylo API.","href":"/index","hidden":true},"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: \"Everything you need to start integrating with the Buylo 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={code:`code`,hr:`hr`,li:`li`,ol:`ol`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Table,Tip}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`overview`,children:`Overview`}),`\n`,_jsx(_components.p,{children:`The Buylo API gives you programmatic access to your retail management platform. Use it to register products, manage RFID tag assignments, sync inventory, and integrate Buylo into your existing systems and workflows.`}),`\n`,_jsx(_components.p,{children:`The API is built around standard HTTP conventions and returns JSON responses. It is designed to be predictable and easy to integrate — whether you are connecting a WMS, an ERP, or building a custom automation.`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Base URL`})}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`https://api.buylo.app/`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(Heading,{level:`3`,id:`what-you-can-do-with-the-api`,children:`What you can do with the API`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Register and update products in your Buylo`}),`\n`,_jsx(_components.li,{children:`Assign and manage RFID tags linked to specific products`}),`\n`,_jsx(_components.li,{children:`Query inventory state and tag read history`}),`\n`,_jsx(_components.li,{children:`Trigger and monitor antenna hooks and RFID events`}),`\n`,_jsx(_components.li,{children:`Sync data with external ERP or WMS systems`}),`\n`]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`authentication`,children:`Authentication`}),`\n`,_jsxs(_components.p,{children:[`All API requests must be authenticated using an API token. Tokens are generated and managed from the Buylo administration panel under `,_jsx(_components.strong,{children:`Settings → API Tokens`}),`. There is no OAuth flow — authentication is straightforward Bearer token auth.`]}),`\n`,_jsx(Heading,{level:`3`,id:`generating-a-token`,children:`Generating a token`}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsx(_components.li,{children:`Log in to your Buylo administration account.`}),`\n`,_jsxs(_components.li,{children:[`Navigate to `,_jsx(_components.strong,{children:`Settings → API Tokens`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`Click `,_jsx(_components.strong,{children:`Generate new token`}),` and give it a descriptive name (e.g. `,_jsx(_components.code,{children:`Production ERP`}),`, `,_jsx(_components.code,{children:`Staging test`}),`).`]}),`\n`,_jsx(_components.li,{children:`Copy the token immediately — it will not be shown again.`}),`\n`,_jsx(_components.li,{children:`Set an expiration date and store the token securely.`}),`\n`]}),`\n`,_jsx(Heading,{level:`3`,id:`token-lifecycle`,children:`Token lifecycle`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Tokens are scoped to your tenant — they cannot access data from other organizations.`}),`\n`,_jsx(_components.li,{children:`Each token has a configurable expiration date. Expired tokens are rejected immediately.`}),`\n`,_jsx(_components.li,{children:`You can create multiple tokens for different systems or environments.`}),`\n`,_jsx(_components.li,{children:`Revoke a token at any time from the admin panel. Revocation takes effect instantly.`}),`\n`,_jsxs(_components.li,{children:[`If you delete a token, any system still using it will receive a `,_jsx(_components.code,{children:`401 Unauthorized`}),` response. Make sure to update all dependent systems before deleting.`]}),`\n`]}),`\n`,_jsx(Tip,{children:_jsx(_components.p,{children:`Never commit API tokens to source control. Use environment variables or a secrets manager. Create separate tokens for production, staging, and development environments, and name them clearly so you can identify which system is using each one.`})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`errors`,children:`Errors`}),`\n`,_jsxs(_components.p,{children:[`The Buylo API uses standard HTTP status codes. Errors always return a JSON body with a machine-readable `,_jsx(_components.code,{children:`code`}),` and a human-readable `,_jsx(_components.code,{children:`message`}),` to help you debug quickly.`]}),`\n`,_jsx(Heading,{level:`3`,id:`error-response-format`,children:`Error response format`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`7`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`7`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"error\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"code\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"validation_error\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"The field 'ean' must be a valid EAN-13 barcode.\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"field\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"ean\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`status-codes`,children:`Status codes`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Status`}),_jsx(_components.th,{children:`Code`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`200`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`ok`})}),_jsx(_components.td,{children:`Request was successful.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`validation_error`})}),_jsx(_components.td,{children:`Missing or invalid request parameters.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`401`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`unauthorized`})}),_jsx(_components.td,{children:`API token is missing, invalid, or expired.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`403`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`forbidden`})}),_jsx(_components.td,{children:`Token does not have permission for this resource.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`404`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`not_found`})}),_jsx(_components.td,{children:`The requested resource does not exist.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`409`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`conflict`})}),_jsx(_components.td,{children:`Resource already exists (e.g. tag already assigned).`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`422`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`unprocessable`})}),_jsx(_components.td,{children:`Request is well-formed but cannot be processed.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`500`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`server_error`})}),_jsx(_components.td,{children:`Something went wrong on our end. Try again later.`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`recommended-error-handling`,children:`Recommended error handling`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Always check the HTTP status code before parsing the response body.`}),`\n`,_jsxs(_components.li,{children:[`On `,_jsx(_components.code,{children:`401`}),` errors, verify your token has not expired in the admin panel.`]}),`\n`,_jsxs(_components.li,{children:[`On `,_jsx(_components.code,{children:`409`}),` conflicts for tag assignment, unassign the existing tag first.`]}),`\n`,_jsxs(_components.li,{children:[`On `,_jsx(_components.code,{children:`5xx`}),` errors, implement exponential backoff with a retry limit of 3 attempts.`]}),`\n`,_jsxs(_components.li,{children:[`Log the full error response body — the `,_jsx(_components.code,{children:`message`}),` field often pinpoints the exact issue.`]}),`\n`]})]})}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":"Introduction","description":"Everything you need to start integrating with the Buylo API.","href":"/index","hidden":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Overview","slug":"overview","depth":2,"children":[{"title":"What you can do with the API","slug":"what-you-can-do-with-the-api","depth":3,"children":[]}]},{"title":"Authentication","slug":"authentication","depth":2,"children":[{"title":"Generating a token","slug":"generating-a-token","depth":3,"children":[]},{"title":"Token lifecycle","slug":"token-lifecycle","depth":3,"children":[]}]},{"title":"Errors","slug":"errors","depth":2,"children":[{"title":"Error response format","slug":"error-response-format","depth":3,"children":[]},{"title":"Status codes","slug":"status-codes","depth":3,"children":[]},{"title":"Recommended error handling","slug":"recommended-error-handling","depth":3,"children":[]}]}],"codeExamples":{}},"jsLinks":[],"subdomain":"buylo-67b82834","siteName":"Buylo documentation","title":"Introduction - Buylo documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-02-25T11:23:49.113Z","originalFileLocation":"index.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=\"Everything you need to start integrating with the Buylo API.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Buylo documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"noindex\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/buylo-67b82834/n9MgASwVGmyqyCBg/_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/buylo-67b82834/n9MgASwVGmyqyCBg/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/buylo-67b82834/n9MgASwVGmyqyCBg/_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/buylo-67b82834/n9MgASwVGmyqyCBg/_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/buylo-67b82834/n9MgASwVGmyqyCBg/_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/buylo-67b82834/n9MgASwVGmyqyCBg/_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/buylo-67b82834/n9MgASwVGmyqyCBg/_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/buylo-67b82834/n9MgASwVGmyqyCBg/_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/buylo-67b82834/n9MgASwVGmyqyCBg/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Introduction - Buylo documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Everything you need to start integrating with the Buylo API.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Buylo documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.buylo.ai\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://buylo-67b82834.mintlify.site/_mintlify/api/og/v2?division=Getting+started\u0026amp;title=Introduction\u0026amp;description=Everything+you+need+to+start+integrating+with+the+Buylo+API.\u0026amp;theme=fe5ee8f1c1370ac717da28aa\u0026amp;signature=f3b4855d9c8e88f9202633ea5533cde94cacae3a720d15061999ffa41044a085\">\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=\"Introduction - Buylo documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Everything you need to start integrating with the Buylo API.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://buylo-67b82834.mintlify.site/_mintlify/api/og/v2?division=Getting+started\u0026amp;title=Introduction\u0026amp;description=Everything+you+need+to+start+integrating+with+the+Buylo+API.\u0026amp;theme=fe5ee8f1c1370ac717da28aa\u0026amp;signature=f3b4855d9c8e88f9202633ea5533cde94cacae3a720d15061999ffa41044a085\">\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/buylo-67b82834/n9MgASwVGmyqyCBg/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Buylo documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#62C5C7\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.buylo.ai\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/index.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.buylo.ai/#organization\",\"name\":\"Buylo documentation\",\"url\":\"https://docs.buylo.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/buylo-67b82834/tY0qEQ0MlqSg_ptg/logo/logo-buylo.svg?fit=max\u0026auto=format\u0026n=tY0qEQ0MlqSg_ptg\u0026q=85\u0026s=7c4aa0e4f0f2b0cfbade52769d1419a3\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.buylo.ai#website\",\"name\":\"Buylo documentation\",\"url\":\"https://docs.buylo.ai\",\"publisher\":{\"@id\":\"https://docs.buylo.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.buylo.ai/#webpage\",\"url\":\"https://docs.buylo.ai/\",\"name\":\"Introduction\",\"description\":\"Everything you need to start integrating with the Buylo API.\",\"dateModified\":\"2026-02-25T11:23:49.113Z\",\"isPartOf\":{\"@id\":\"https://docs.buylo.ai#website\"}},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.buylo.ai/#article\",\"headline\":\"Introduction\",\"name\":\"Introduction\",\"description\":\"Everything you need to start integrating with the Buylo API.\",\"url\":\"https://docs.buylo.ai/\",\"mainEntityOfPage\":{\"@id\":\"https://docs.buylo.ai/#webpage\"},\"dateModified\":\"2026-02-25T11:23:49.113Z\",\"publisher\":{\"@id\":\"https://docs.buylo.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.buylo.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Buylo documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Buylo documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/index.md","siteName":"Buylo documentation","nav":{"global":null,"tabs":[{"tab":"Guides","hidden":true,"groups":[{"group":"Getting started","pages":[{"title":"Introduction","href":""},{"title":"Quickstart","description":"Start building awesome documentation in minutes","href":"/quickstart"},{"title":"Development","description":"Preview changes locally to update your docs","href":"/development"}]},{"group":"Customization","pages":[{"title":"Global Settings","description":"Mintlify gives you complete control over the look and feel of your documentation using the docs.json file","icon":"gear","href":"/essentials/settings"},{"title":"Navigation","description":"The navigation field in docs.json defines the pages that go in the navigation menu","icon":"map","href":"/essentials/navigation"}]},{"group":"Writing content","pages":[{"title":"Markdown syntax","description":"Text, title, and styling in standard markdown","icon":"text-size","href":"/essentials/markdown"},{"title":"Code blocks","description":"Display inline code and code blocks","icon":"code","href":"/essentials/code"},{"title":"Images and embeds","description":"Add image, video, and other HTML elements","icon":"image","href":"/essentials/images"},{"title":"Reusable snippets","description":"Reusable, custom snippets to keep content in sync","icon":"recycle","href":"/essentials/reusable-snippets"}]},{"group":"AI tools","pages":[{"title":"Cursor setup","description":"Configure Cursor for your documentation workflow","icon":"arrow-pointer","href":"/ai-tools/cursor"},{"title":"Claude Code setup","description":"Configure Claude Code for your documentation workflow","icon":"asterisk","href":"/ai-tools/claude-code"},{"title":"Windsurf setup","description":"Configure Windsurf for your documentation workflow","icon":"water","href":"/ai-tools/windsurf"}]}]},{"tab":"Buylo documentation","pages":[{"title":"Buylo documentation","href":"/buylo-database-synchronization-bridge-external-integration-guide"}]},{"tab":"Buylo API","pages":[{"title":"Buylo API","href":"/api-reference/introduction"}]}]},"basePath":"","title":"Introduction - Buylo documentation","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":[],"chunks":[]}