Understanding the Magento REST API
Understanding the Magento REST API
~12 Min. Lesezeit Zuletzt aktualisiert am August 8, 2026
Before we write a single line of React, let's get clear on the Magento REST API itself – its URL structure, how to test its reachability without logging in, and where to find its complete documentation.
Base URL structure
EVERY Magento REST API call follows the same pattern:
https://YOUR-SHOP.com/rest/<store_code>/V1/<endpoint>
# Example with the default store code 'default':
https://your-shop.com/rest/default/V1/products
# Without a store code, the website's DEFAULT store applies:
https://your-shop.com/rest/V1/products<store_code> determines which LANGUAGE/STORE CONTEXT product names and descriptions are returned in (relevant if your shop runs multiple languages, like our own Mironsoft shop with de and en). You'll find your shop's store code in the Magento admin under Stores → All Stores, in the "Store View Code" column.
V1: API versioning
The V1 in the path is the API version – Magento sticks with V1 for compatibility reasons, even as the internal implementation has evolved over the years. For this tutorial, it's enough to know: V1 is currently the only relevant version, you don't need to worry about versioning further.
A connectivity test WITHOUT logging in
Not EVERY endpoint requires an access token. Some are deliberately marked as anonymous, because they're also needed by a non-logged-in storefront visitor – general store configuration, for instance. Perfect as a FIRST step to check whether your shop address and the API are reachable at all, BEFORE authentication even enters the picture:
curl -s https://YOUR-SHOP.com/rest/V1/store/storeConfigs | head -c 300A successful response is a JSON array of configuration objects (base URL, store code, currency, language, ...) – if you see an HTML error page or "Connection refused" instead, either the address is wrong, or the REST API isn't reachable on your Magento installation (e.g. due to a firewall or .htaccess restriction).
Achtung: Throughout this tutorial, we use https://YOUR-SHOP.com as a placeholder. Replace it in EVERY code example with your own Magento shop's actual address – without a reachable shop of your own, this tutorial cannot be followed with real results (see chapter 1).
Your own shop's built-in API documentation
Every Magento installation ships its COMPLETE, interactive REST API documentation itself – reachable at:
https://YOUR-SHOP.com/swaggerTipp: This Swagger interface lists EVERY endpoint available on YOUR SPECIFIC Magento version, including all parameters and example responses – the best place to explore further endpoints (categories, cart, customers) beyond this tutorial later on.
The endpoints we use in this tutorial
POST /V1/integration/admin/token– request an admin token (chapter 3),anonymous.GET /V1/products– product list with filters/pagination (chapters 7-8, 13), needs a token.GET /V1/products/{sku}– a single product by SKU (chapter 10), needs a token.
We'll get to know all three in detail over the coming chapters – first with the fast admin token, then with the integration token better suited for production apps.