Does FreshStore have an API for building your own tools?

Yes. Every FreshStore site has its own REST API. You can use it to read and update your site from your own code: products, offers, categories, brands, articles, pages, settings and analytics.

You do not have to write code to use it. You can connect Claude, ChatGPT, Codex, Cursor and all AI agents to your site with a key. See How to connect Claude, ChatGPT and other AI tools to your site.

This is not the Amazon Creators API. The Amazon Creators API is Amazon's own product data service, and FreshStore already handles that for you. The API on this page is your own site's API, built and hosted by FreshStore. It is the one to use if you want to build your own management tool, dashboard, script or integration on top of your site.

What you can do with it

The API covers most of what you can do by hand in your site admin area:

  • Products: list, create, read, update and delete products, and read their offers, categories and analytics.
  • Offers: list, create, read, update and delete offers, and see which merchants are enabled.
  • Categories and brands: full read and write access, including the category tree.
  • Articles, article categories and pages: full read and write access.
  • Site: site info, stats, warnings, locales and IndexNow status, plus jobs such as Clean Site and Clear Cache.
  • Settings: read and update your site settings, either all at once or one group at a time.
  • Analytics: visits, visitors, pages, countries, devices, sources, clicks and checkouts.
  • Users: list, create, read and update the users of your site.

How to get access

  1. Open the site admin area of the site you want to use. This is your site's own dashboard, not your FreshStore account area at my.freshstore.com.
  2. Go to Settings > API Keys in the site admin area.
  3. Click Create API Key, give it a name, and choose the permissions it needs.
  4. Copy the key straight away. It is shown once and cannot be retrieved later.

Send the key as a bearer token on every request:

Authorization: Bearer YOUR_API_KEY

The base URL is your own site domain, so a request looks like https://your-store-domain.com/api/products.

Limits and requirements

  • Requests are limited to 60 per minute, counted separately for each site and each API key.
  • Your site sits behind a web application firewall. Send a User-Agent header that names your tool, for example MyStoreScript/1.0. Requests that carry an API key get through with the default User-Agent of curl, python-requests and other common libraries.
  • Using the API needs some technical knowledge. It is a developer feature, and there is no no-code builder for it.

One endpoint needs no key at all. GET /api/store/status tells you whether a site is online.

The full list of endpoints, fields and example responses is in the FreshStore Site API endpoint reference.

Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.