‹ Vantemo Docs
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)
  • curl or any HTTP client

Step 1: Create an API Key

  1. Log in to your Vantemo Admin Dashboard
  2. Navigate to Settings → API Keys
  3. Click Create API Key
  4. Choose Secret key type (full admin + storefront access)
  5. 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
curl -s https://your-shop.vantemo.com/v1/storefront/products \
  -H "Authorization: Bearer vt_sk_live_YOUR_KEY_HERE" | jq
TypeScript (fetch)
const 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:

Response
{
  "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
curl -s https://your-shop.vantemo.com/v1/storefront/products/prod_8x9a \
  -H "Authorization: Bearer vt_sk_live_YOUR_KEY_HERE" | jq

Step 4: Create a Cart

curl
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
      }
    ]
  }' | jq

API Key Types

TypePrefixAccessUse Case
Publishablevt_pk_Storefront read-onlyBrowser-safe, public
Secretvt_sk_Full admin + storefrontServer-side only
Restrictedvt_rk_Custom scope selectionThird-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: 1709164800

Next Steps

On this page