Skip to main content

Future Ordering API — AI Documentation Bundle

A single zip containing all developer documentation, the full OpenAPI spec, and an endpoint index — ready to use as context for any AI coding assistant.

Download fo-devdocs.zip

What's included

  • Full REST API usage guides (authentication, conventions, versioning)
  • Order integration documentation
  • Custom kiosk shell development reference
  • Frontend plugin system docs
  • External payment provider integration
  • Loyalty and delivery integration guides
  • Event subscription reference
  • Master data importing documentation
  • API endpoint index (all endpoints grouped by tag)
  • Full OpenAPI specification

Using the documentation bundle

Download and extract the zip, then load the files from fo-devdocs/references/ as context in your AI assistant of choice.

unzip fo-devdocs.zip

The reference files are plain Markdown and work with any AI tool — GitHub Copilot, Gemini, Codex, Cursor, or others. For endpoint questions, start with references/api-index.md for a quick lookup, then references/openapi.json for full request/response schemas.

Auto-install for Claude Code

If you use Claude Code, the bundle includes an auto-discovery configuration so the documentation is loaded automatically without attaching files manually.

  1. 1

    Extract to the skills directory

    unzip fo-devdocs.zip -d ~/.claude/skills/

    This creates ~/.claude/skills/fo-devdocs/ and fo-devdocs-update/.

    Optional: to avoid permission prompts when reading reference files or running updates, add these to ~/.claude/settings.json:

    "permissions": {
      "allow": [
        "Read(~/.claude/skills/fo-devdocs/references/*)",
        "Bash(bash ~/.claude/skills/fo-devdocs-update/update.sh)"
      ]
    }
  2. 2

    Start a new session

    The documentation is auto-discovered — no further configuration needed.

  3. 3

    Try it

    How do I register an external order in Future Ordering?
    What webhook events does FO emit when a user is created?
    Show me how to implement a custom kiosk shell.

Keeping the bundle up to date

Run /fo-devdocs:update to pull the latest version from the server. Possible outcomes:

  • Already up to date — your local version matches the server.
  • Updated to <timestamp> — a newer version was downloaded and extracted. Takes effect in the next session.
  • Could not reach server — no network access to developer.futureordering.com. Your existing files are unchanged.