Quick Start

Prerequisites

• A Storelayer account at app.storelayer.io
• An API key from your project settings

Setup

1. Create a project

   After signing in, create a new project from the dashboard. Each project is an isolated environment with its own customers, wallets, and promotions.

2. Get your API key

   Navigate to Settings → API Keys in your project dashboard and create a new API key. You’ll need this for all API requests.

3. Make your first API call

   cURL

   curl -X GET https://api.storelayer.io/v1/customers \
     -H "Authorization: Bearer YOUR_API_KEY" \
     -H "Content-Type: application/json"

   JavaScript

   const response = await fetch('https://api.storelayer.io/v1/customers', {
     headers: {
       'Authorization': 'Bearer YOUR_API_KEY',
       'Content-Type': 'application/json',
     },
   })
   const data = await response.json()
   console.log(data)

4. Create a customer

   curl -X POST https://api.storelayer.io/v1/customers \
     -H "Authorization: Bearer YOUR_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
       "email": "customer@example.com",
       "name": "Jane Doe",
       "metadata": {
         "source": "website"
       }
     }'

5. Credit points to a customer’s wallet

   curl -X POST https://api.storelayer.io/v1/wallets/{customerId}/credit \
     -H "Authorization: Bearer YOUR_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
       "amount": 500,
       "reason": "Welcome bonus"
     }'

Response Format

All API responses follow a consistent format:

// Success
{
  "success": true,
  "data": { ... }
}

// Error
{
  "success": false,
  "error": {
    "code": 400,
    "message": "Validation error: email is required"
  }
}

Next Steps

• Authentication — Learn about API keys and JWT tokens
• Core Concepts — Understand the Storelayer data model
• API Reference — Full API documentation