New API Docs Are Here

We are excited to officially announce the launch of our brand new API documentation at https://api.foxycart.com/!

Whether you’re building custom checkout flows, integrating third-party tools, or developing complex backend automations with Foxy, clear and accessible documentation is vital. While the underlying core API data and functionality remain the same, we’ve completely revamped the documentation interface to make finding and using what you need faster and easier.

Here is a look at what’s new and improved:

Modern, Easier Navigation & Search

Finding the right endpoint or resource shouldn't feel like a treasure hunt. The new theme introduces a streamlined navigation structure alongside enhanced, full-text search capabilities so you can jump straight to the code and properties you care about.

Clearer Link Relations & Example Representations

Hypermedia/HAL resources thrive on clear relationships. We’ve overhauled how link relations and example JSON representations are displayed, giving you immediate, practical context on how resources connect and what payload structures to expect.

AI Agent Ready

As development workflows evolve, structured machine readability becomes just as important as human readability. The new docs are structured specifically to make it easier for AI agents and LLMs to navigate, parse, and assist you in writing integration code.

Scope Visibility (coming soon)

We are rolling out clearer visibility for OAuth scopes directly within the documentation. You'll soon be able to see exact permission requirements at a glance for every endpoint and resource.

Dark Mode

Better late than never! You can now toggle dark mode to keep your eyes happy during those late-night integration sessions.

Check It Out Today

Head over to https://api.foxycart.com/ to explore the new experience.

Have feedback, questions, or spot something that could be improved? Please don't hesitate to contact us.