Does FreshStore have an API for building your own tools?
Yes. Every FreshStore store has its own REST API. You can use it to read and update your store from your own code: products, offers, categories, brands, articles, pages, settings and analytics.
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 store'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 store.
What you can do with it
The API covers most of what you can do by hand in your store 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.
- Store: store info, stats, warnings, locales and IndexNow status, plus jobs such as Clean Store and Clear Cache.
- Settings: read and update your store 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 store.
How to get access
- Open the store admin area of the store you want to use. This is your store's own dashboard, not your FreshStore account area at my.freshstore.com.
- Go to Settings > API Keys in the store admin area.
- Click Create API Key, give it a name, and choose the permissions it needs.
- 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_KEYThe base URL is your own store 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 store and each API key.
- Your store sits behind a web application firewall. Send a normal browser User-Agent header, because generic ones such as
curlorpython-requestsare blocked. - 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 store is online.
The full list of endpoints, fields and example responses is in the FreshStore Store API endpoint reference.