👋 Introduction

Audience: Partner developers, solution integrators, and technical stakeholders building storefronts, aggregators, and data pipelines on top of Fodista.

The Fodista Public API exposes a curated, access-controlled surface that lets trusted partners:

Pull accounting history for downstream finance.

Read public menus to power customer-facing experiences.

Drive online ordering (cart and checkout) for a specific Online Store.

Every request must include a valid access token issued from Fodista Back Office on the Public API Access document. Tokens constrain who you can see (brand/branch, Online Store) and what you can do (scopes like Invoice History, Public Menu, Online Ordering). Requests without a valid token are rejected.

What’s in this API

Invoice History (read-only): export POS Invoice summaries for a date range; ideal for accounting, audits, and analytics.

Public Menu (read-only): categories, products, options, and modifiers intended for storefronts or catalog views.

Online Ordering: create/update a cart, apply modifiers, manage customer details, and checkout.

ℹ️ The API descriptions are written in plain language to be clear to non-technical stakeholders while remaining precise for engineers.

Base URL

Use the base URL for your deployment:

https://new-fodista

Replace with your tenant’s public hostname if different (e.g., https://yourbrand.fodista.com). All examples assume HTTPS.

Authentication

Include your token via the required header:

X-Access-Token: <your_token_here>

Legacy clients may instead send the token in the JSON body as access_token, but the header method is recommended.

Example (cURL)

Scope & Visibility rules (important)

Some endpoints require a visibility query parameter. Your token’s scope determines which value you may use:

If your token has Public Menu scope → use visibility=public

If your token has Online Ordering scope (only) → use visibility=online

Attempting to mix scopes and visibility values will result in 403 (forbidden).

Error model (high level)

The API returns structured errors with a human message and optional debugging info.

401 — Missing or invalid token

403 — Token is valid, but the requested scope/data is not allowed

404 — Resource not found (for example, get-address with unknown coordinates)

See the OpenAPI for the ErrorResponse schema.

Versioning

This document tracks API v1.0.0. Changes are additive and backwards-compatible whenever possible. When breaking changes are unavoidable, they’re introduced under a new version and communicated beforehand.

Support

If you need additional scopes, token rotation, or have security questions, contact your Fodista success channel or administrator for your tenant.

What’s in this API#

Base URL#

Authentication#

Example (cURL)#

Scope & Visibility rules (important)#

Error model (high level)#

Versioning#

Support#