Storefront API — show your catalogue on another website or app

The Storefront API lets a developer show your store's catalogue on a website or app they build themselves (a "headless" store), while you keep managing everything in Ordexs. It reads what any shopper can already see on your store: products, prices, collections, categories, pages, policies, reviews, offers and delivery prices, and it can price a cart. It never changes anything and never shows cost prices, barcodes, stock counts, customers or orders. Orders from such a site are placed with an API key (see the API keys chunk).

Where. Settings → Developers → Storefront API. It is available on every plan, including Try. The section shows your store's API address, with a copy button, to hand to your developer.

Tokens. A developer's site needs a storefront token (it starts with ordx_sf_). Press New token, give it a name you'll recognise (for example the website it is for) and choose where it may be used:

  • Listed websites — list the website addresses, one per line (for example https://shop.example.com), up to 10. Browsers on any other website are refused. Leave the list empty to use the token only from servers and mobile apps (shown as "Servers and apps only").
  • Any website — any site can use it, and count against your limits.

A store can have 10 active tokens. The store owner and admins create, rename, change and revoke them; other team members who can open settings can see them.

A storefront token is not a secret. It sits in the website's code, where anyone can read it, and it only opens what your store already shows publicly. That is why the full token stays visible in the list and can be copied again at any time, unlike an API key. Use Listed websites so another site can't borrow it.

Revoking. Press the revoke button and confirm. Sites using the token stop working within about a minute. Revoking can't be undone; create a new token if you need one again. Show revoked lists the old ones.

What the list shows. Each token's name, the token itself, which websites may use it, when it was last used and how many requests it served in the last 24 hours.

Limits. Each token handles up to 3,000 requests a minute, and each visitor up to 180. Answers are cached and refresh within seconds of a change you make in the dashboard, so a busy site doesn't slow your store down.

Your own store doesn't need a token. Your Ordexs storefront, and the scripts in a store made with the AI store builder, read the same data on your own store address without one.

Developers find the full guide, with examples, at ordexs.com/docs under Storefront API.

More in Developers

Still need help?

Ask the assistant from the search box in your dashboard. It answers from these same guides, in English, French or Arabic, and can make changes for you. Or write to us and a person will reply.