{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Getting Started","description":"Final commerce public API for Final POS system","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"getting-started","__idx":0},"children":["Getting Started"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Final POS Public API lets you programmatically manage the core resources that power your point-of-sale system — products, customers, orders, taxes, outlets, and more."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"base-url","__idx":1},"children":["Base URL"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All requests are made against a single base URL:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"https://api.finalpos.com\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"request--response-format","__idx":2},"children":["Request & Response Format"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Content type:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/json"]}," for both requests and responses."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Character encoding:"]}," UTF-8."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"api-structure","__idx":3},"children":["API Structure"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The API is organized into three areas (paths use your deployment’s API prefix, e.g. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1/api"]},"):"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Area"},"children":["Area"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Convention"},"children":["Convention"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Example"},"children":["Example"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["CRUD"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Singular endpoints for single-record operations (create, read, update, delete)."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST …/customer"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET …/customer/{id}"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Bulk"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Plural endpoints for multi-record operations (bulk create, list, bulk update, bulk delete)."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST …/customers"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET …/customers"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Workflows"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Multi-step operations composed across domains; all live under ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["…/workflows/<segment>"]},"."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST …/workflows/outlet-product"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET …/workflows/tax/by-tax-rate/{taxRateId}"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"next-steps","__idx":4},"children":["Next Steps"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/authentication"},"children":["Authentication"]}]}," — Create an API key and learn how permissions work."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi-reference/"},"children":["API Reference"]}]}," — Browse all available endpoints grouped by domain."]}]}]},"headings":[{"value":"Getting Started","id":"getting-started","depth":1},{"value":"Base URL","id":"base-url","depth":2},{"value":"Request & Response Format","id":"request--response-format","depth":2},{"value":"API Structure","id":"api-structure","depth":2},{"value":"Next Steps","id":"next-steps","depth":2}],"frontmatter":{"seo":{"title":"Getting Started"}},"lastModified":"2026-05-18T15:43:15.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/getting-started","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}