Use the store API

Create API keys and use the store API to read and update your catalog, orders, and customers from your own tools.

Everything in your dashboard is also available over an API. That's how your storefront talks to your store — and it's how you, or a developer you hire, can connect YNS to anything else you use.

You don't need this for day-to-day selling. It's here when you want to automate something the dashboard doesn't cover.

Create an API key

  1. Open Settings → API.
  2. On the API keys tab, create a key and give it a name that says what it's for — "Warehouse sync", not "key 2".
  3. Copy the key immediately and store it somewhere safe.

Caution: An API key can read and change your store's data. Treat it like a password: never paste it into a public repository, a shared document, or a support chat.

See what's available

The Endpoints tab documents what you can do — products, variants, inventory, carts, checkout, orders, customers, collections, categories, blog posts, media, and subscribers. Requests support things you'd expect from the dashboard: filtering, pagination, sorting, and choosing a currency or language for the response.

If you've enabled localization, you can ask for translated content by passing a language code.

What people use it for

  • Syncing stock with a warehouse or point-of-sale system
  • Importing products from another platform in bulk
  • Pushing orders into fulfillment or accounting software
  • Building a custom storefront on top of your catalog

Before you build any of these, check Add-ons and Product feeds — plenty of common integrations are already there.

Connected apps

Settings → Connected apps is a separate list: apps you've authorized to reach your account over OAuth, rather than with an API key. Connecting an AI assistant to your store through the MCP connector shows up here.

Each entry shows the app, which store it's connected to, and when you authorized it. Disconnect revokes access immediately — the app has to reconnect to get it back.

Tip: Look through this list occasionally. Anything you don't recognize, or no longer use, should be disconnected.

Keep keys tidy

Create a separate key per integration. When you retire a tool or a contractor's work ends, delete just that key instead of rotating everything. If a key is ever exposed, delete it straight away and issue a new one.

FAQ

Do I need to be a developer to use this?

Yes, realistically. The API is for building integrations. If you just want to connect a common service, look at Add-ons first.

Can I see what a key has been used for?

Keep one key per integration and the name tells you. That's the practical reason to avoid a single shared key.

I lost my API key.

Keys are shown once when created. If you've lost one, delete it and create a replacement, then update whatever was using it.

Is my storefront using the API?

Yes — your storefront reads your catalog through it, which is why catalog changes appear on your store without a rebuild.

What's next