> For the complete documentation index, see [llms.txt](https://docs.flowretail.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flowretail.com/docs/developers.md). # Developers - [Introduction](https://docs.flowretail.com/docs/developers/introduction.md): Flow Retail is API-first. This is where integrating with it starts. - [For AI agents](https://docs.flowretail.com/docs/developers/for-ai-agents.md): Point your AI coding agent at this page before it writes a line of Flow Retail integration code. - [Authentication](https://docs.flowretail.com/docs/developers/authentication.md): The three token types, how to get one, and what permissions they need. - [Quantity & price representation](https://docs.flowretail.com/docs/developers/quantity-and-price-representation.md): Every amount, percentage and quantity is an integer with two implied decimals. - [Field naming & data structure](https://docs.flowretail.com/docs/developers/field-naming-and-data-structure.md): How fields are named, how references work, and how to clear a value. - [Pagination & sorting](https://docs.flowretail.com/docs/developers/pagination-and-sorting.md): How list endpoints page, how to know when you are done, and how to sort. - [Errors & troubleshooting](https://docs.flowretail.com/docs/developers/errors-and-troubleshooting.md): The error envelope, what each status code means, and the codes you will hit most. - [Webhooks](https://docs.flowretail.com/docs/developers/webhooks.md): Receive events instead of polling — and the two delivery rules that surprise people. - [Field deprecation & removal policy](https://docs.flowretail.com/docs/developers/field-deprecation-and-removal-policy.md): How we retire a field, and how much notice you get. - [API documentation](https://docs.flowretail.com/docs/developers/api-documentation.md) - [Accounting Configs](https://docs.flowretail.com/docs/developers/api-documentation/accounting-configs.md) - [Accounting Reports](https://docs.flowretail.com/docs/developers/api-documentation/accounting-reports.md) - [AI](https://docs.flowretail.com/docs/developers/api-documentation/ai.md) - [Asset](https://docs.flowretail.com/docs/developers/api-documentation/asset.md) - [Broadcast](https://docs.flowretail.com/docs/developers/api-documentation/broadcast.md) - [Budget](https://docs.flowretail.com/docs/developers/api-documentation/budget.md) - [Caching](https://docs.flowretail.com/docs/developers/api-documentation/caching.md) - [Campaign](https://docs.flowretail.com/docs/developers/api-documentation/campaign.md) - [Categories](https://docs.flowretail.com/docs/developers/api-documentation/categories.md) - [Company Registry](https://docs.flowretail.com/docs/developers/api-documentation/company-registry.md) - [Compensation](https://docs.flowretail.com/docs/developers/api-documentation/compensation.md) - [Config](https://docs.flowretail.com/docs/developers/api-documentation/config.md) - [Currency](https://docs.flowretail.com/docs/developers/api-documentation/currency.md) - [Customer](https://docs.flowretail.com/docs/developers/api-documentation/customer.md) - [Customer Address](https://docs.flowretail.com/docs/developers/api-documentation/customer-address.md) - [Customer Consent](https://docs.flowretail.com/docs/developers/api-documentation/customer-consent.md) - [Customer Contact](https://docs.flowretail.com/docs/developers/api-documentation/customer-contact.md) - [Customer Group](https://docs.flowretail.com/docs/developers/api-documentation/customer-group.md) - [Delivery Method](https://docs.flowretail.com/docs/developers/api-documentation/delivery-method.md) - [Delivery Provider](https://docs.flowretail.com/docs/developers/api-documentation/delivery-provider.md) - [Device](https://docs.flowretail.com/docs/developers/api-documentation/device.md) - [Extensions](https://docs.flowretail.com/docs/developers/api-documentation/extensions.md) - [Flowbox](https://docs.flowretail.com/docs/developers/api-documentation/flowbox.md) - [Giftcard](https://docs.flowretail.com/docs/developers/api-documentation/giftcard.md) - [Handling](https://docs.flowretail.com/docs/developers/api-documentation/handling.md) - [Import](https://docs.flowretail.com/docs/developers/api-documentation/import.md) - [Internal](https://docs.flowretail.com/docs/developers/api-documentation/internal.md) - [Internal Purchase Order](https://docs.flowretail.com/docs/developers/api-documentation/internal-purchase-order.md) - [Loyalty Program](https://docs.flowretail.com/docs/developers/api-documentation/loyalty-program.md) - [Notifications](https://docs.flowretail.com/docs/developers/api-documentation/notifications.md) - [Order](https://docs.flowretail.com/docs/developers/api-documentation/order.md) - [Order Delivery](https://docs.flowretail.com/docs/developers/api-documentation/order-delivery.md) - [Order Discount](https://docs.flowretail.com/docs/developers/api-documentation/order-discount.md) - [Order Handling](https://docs.flowretail.com/docs/developers/api-documentation/order-handling.md) - [Order Settlement](https://docs.flowretail.com/docs/developers/api-documentation/order-settlement.md) - [Organization](https://docs.flowretail.com/docs/developers/api-documentation/organization.md) - [Payment Method](https://docs.flowretail.com/docs/developers/api-documentation/payment-method.md) - [Payment Method Mappings](https://docs.flowretail.com/docs/developers/api-documentation/payment-method-mappings.md) - [Payment Method Parameters](https://docs.flowretail.com/docs/developers/api-documentation/payment-method-parameters.md) - [Permission](https://docs.flowretail.com/docs/developers/api-documentation/permission.md) - [Poster](https://docs.flowretail.com/docs/developers/api-documentation/poster.md) - [Pre Payment](https://docs.flowretail.com/docs/developers/api-documentation/pre-payment.md) - [Prices](https://docs.flowretail.com/docs/developers/api-documentation/prices.md) - [Printer](https://docs.flowretail.com/docs/developers/api-documentation/printer.md) - [Product](https://docs.flowretail.com/docs/developers/api-documentation/product.md) - [Product Group](https://docs.flowretail.com/docs/developers/api-documentation/product-group.md) - [Product Media](https://docs.flowretail.com/docs/developers/api-documentation/product-media.md) - [Product Package](https://docs.flowretail.com/docs/developers/api-documentation/product-package.md) - [Product Properties](https://docs.flowretail.com/docs/developers/api-documentation/product-properties.md) - [Product Warranty](https://docs.flowretail.com/docs/developers/api-documentation/product-warranty.md) - [Profrakt](https://docs.flowretail.com/docs/developers/api-documentation/profrakt.md) - [Properties](https://docs.flowretail.com/docs/developers/api-documentation/properties.md) - [Purchase](https://docs.flowretail.com/docs/developers/api-documentation/purchase.md) - [Reasons](https://docs.flowretail.com/docs/developers/api-documentation/reasons.md) - [Receipt](https://docs.flowretail.com/docs/developers/api-documentation/receipt.md) - [Receivement](https://docs.flowretail.com/docs/developers/api-documentation/receivement.md) - [Reports](https://docs.flowretail.com/docs/developers/api-documentation/reports.md) - [Reports External](https://docs.flowretail.com/docs/developers/api-documentation/reports-external.md) - [RMA Order](https://docs.flowretail.com/docs/developers/api-documentation/rma-order.md) - [Service](https://docs.flowretail.com/docs/developers/api-documentation/service.md) - [Service Shipment](https://docs.flowretail.com/docs/developers/api-documentation/service-shipment.md) - [SOA](https://docs.flowretail.com/docs/developers/api-documentation/soa.md) - [Stock Info](https://docs.flowretail.com/docs/developers/api-documentation/stock-info.md) - [Stocktaking](https://docs.flowretail.com/docs/developers/api-documentation/stocktaking.md) - [Store](https://docs.flowretail.com/docs/developers/api-documentation/store.md) - [Store Printer](https://docs.flowretail.com/docs/developers/api-documentation/store-printer.md) - [Supplier](https://docs.flowretail.com/docs/developers/api-documentation/supplier.md) - [Templates](https://docs.flowretail.com/docs/developers/api-documentation/templates.md) - [Tenant](https://docs.flowretail.com/docs/developers/api-documentation/tenant.md) - [Till](https://docs.flowretail.com/docs/developers/api-documentation/till.md) - [Timeslots](https://docs.flowretail.com/docs/developers/api-documentation/timeslots.md) - [User](https://docs.flowretail.com/docs/developers/api-documentation/user.md) - [Warehouse](https://docs.flowretail.com/docs/developers/api-documentation/warehouse.md) - [Webhooks](https://docs.flowretail.com/docs/developers/api-documentation/webhooks.md) - [Models](https://docs.flowretail.com/docs/developers/api-documentation/models.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.flowretail.com/docs/developers.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.