# Introduction

**Welcome to the Flow Retail API — your gateway to integrating with the Flow Retail platform.**

Our API is built using REST principles, with a clear, resource-based structure, and communicates using JSON for both requests and responses. You can expect standard HTTP status codes in all responses.

## Before you begin

To start using the API, you need a Client in Flow Retail.

* If you’re already a Flow Retail customer, your clientId (company identifier) is available in Flow Retail Admin.
* If you’re not yet a customer, contact us to set up an account.

***

## Core Concepts

Understanding the resource structure is key to working with the API effectively.

### Client

The top-level identifier in Flow Retail, representing:

* A chain of stores
* Or the owner of a single store

### Stores

A store resource represents either:

* A physical store
* Or an online store

Flow Retail supports multiple stores under a single client, which can be set up as individual or shared legal entities.

***

## Resource Hierarchy

* Client-level resources — shared across all stores under the client:
  * Stores
  * Users
  * Products

    (Access can be limited by user roles and permissions.)
* Store-level resources — specific to a single store:
  * Warehouses
  * Purchase orders
  * Orders

***

## Integration Guide Structure

With a wide variety of resources and relationships, integration can seem complex at first.

To help, we provide:

* Task-focused articles explaining common integration scenarios.
* Reference documentation for each endpoint.
* Guides to help you choose the right authentication flow and resource strategy.<br>

If something is missing, or you have a specific integration need, reach out to us at <integration@flowretail.no> — we’re here to help.

***

## Next Steps

1. Learn how authentication works.
2. Get your clientId from [Flow Retail Admin](https://admin.flowretail.com/)
3. Explore the API Reference to understand available endpoints and required permissions.
4. Start making requests with your preferred HTTP client or integration framework.


---

# Agent Instructions: 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:

```
GET https://docs.flowretail.com/api/introduction.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.