Getting Started
Quickstart
Make your first Vantemo API call in 5 minutes.
Quickstart
This guide walks you through making your first API call to Vantemo. By the end, you'll have fetched products from a storefront and created an API key for programmatic access.
Prerequisites
- A Vantemo account with at least one shop created
- An API key (you'll create one below)
curlor any HTTP client
Step 1: Create an API Key
- Log in to your Vantemo Admin Dashboard
- Navigate to Settings → API Keys
- Click Create API Key
- Choose Secret key type (full admin + storefront access)
- Copy the key — it's shown only once!
Your key will look like: vt_sk_live_a1b2c3d4e5f6...
Step 2: List Products
Fetch your storefront products using the API key as a Bearer token:
curl -s https://your-shop.vantemo.com/v1/storefront/products \
-H "Authorization: Bearer vt_sk_live_YOUR_KEY_HERE" | jqconst response = await fetch(
'https://your-shop.vantemo.com/v1/storefront/products',
{
headers: {
Authorization: 'Bearer vt_sk_live_YOUR_KEY_HERE',
},
}
);
const { data } = await response.json();
console.log(data);
// [{ id: "prod_...", title: "Heavyweight Hoodie", ... }]The response follows our standard envelope format:
{
"object": "list",
"data": [
{
"id": "prod_8x9a",
"title": "Heavyweight Hoodie",
"slug": "heavyweight-hoodie",
"price": 7000,
"currency": "EUR",
"status": "ACTIVE"
}
],
"hasMore": false,
"totalCount": 1
}Step 3: Get a Single Product
curl -s https://your-shop.vantemo.com/v1/storefront/products/prod_8x9a \
-H "Authorization: Bearer vt_sk_live_YOUR_KEY_HERE" | jqStep 4: Create a Cart
curl -s -X POST https://your-shop.vantemo.com/v1/storefront/cart \
-H "Authorization: Bearer vt_sk_live_YOUR_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{
"items": [
{
"productId": "prod_8x9a",
"quantity": 2
}
]
}' | jqAPI Key Types
| Type | Prefix | Access | Use Case |
|---|---|---|---|
| Publishable | vt_pk_ | Storefront read-only | Browser-safe, public |
| Secret | vt_sk_ | Full admin + storefront | Server-side only |
| Restricted | vt_rk_ | Custom scope selection | Third-party integrations |
Rate Limits
All API keys are rate-limited to 60 requests per minute by default (configurable per key). Rate limit headers are included in every response:
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 57
X-RateLimit-Reset: 1709164800Next Steps
- Authentication — Deep dive into API key scopes
- Storefront Kit — Build a full Next.js storefront
- API Reference — Explore all available endpoints