Documentation

Everything you need to use Mocksy, from getting started to API integration.

Getting Started

New to Mocksy? Start here to learn the basics.

What is Mocksy?

Mocksy generates realistic mock data for testing workflows. Create customers, products (SKUs), and orders that look real but contain no personal information. Perfect for testing integrations, demos, and staging environments without using production data.

When to Use Mocksy

  • Testing e-commerce integrations
  • Populating staging or QA environments
  • Creating demo data for stakeholders
  • Running automated tests in CI/CD pipelines
  • Developing features without production data

Create Your Account

  1. Sign up with your email address
  2. Create your first organisation
  3. Invite team members (optional)
  4. Set role-based permissions (Admin or Member)

Each organisation has isolated data and separate API keys.

Generating Mock Data

Mocksy generates three types of data:

  • Customers: Mock profiles with names, emails, addresses, and phone numbers
  • SKUs: Products with names, descriptions, prices, and stock levels
  • Orders: Purchase records linking customers to SKUs with quantities and totals

Orders automatically reference existing customers and SKUs in your organisation.

Using the Web App

Manage your mock data through the web interface:

  • View, search, and filter customers, SKUs, and orders
  • Generate data in bulk with configurable options
  • Import your own customers and SKUs (Pro/Teams)
  • Export data as JSON or CSV
  • Schedule automated data generation (Pro/Teams)

Common Use Cases

  • E-commerce testing: Test checkout flows, inventory management, and order processing
  • QA environments: Populate staging with realistic data that's safe to modify
  • Demos: Show features to stakeholders without exposing real customer data
  • CI/CD: Generate fresh test data for each pipeline run
  • Development: Build features against realistic data structures
For Developers

API Documentation

Integrate Mocksy into your applications and workflows.

Authentication

Mocksy uses API key authentication. Each organisation can create multiple API keys with different scopes.

Managing API keys: Navigate to Integrations → API Keys in the web app. You can create keys with specific scopes (customers:read, skus:read, orders:read) to limit access. Keep your API keys secure and never commit them to version control.

Include your API key in the Authorization header: 

Authorization: Bearer YOUR_API_KEY_HERE

If your API key doesn't have the required scope for an endpoint, you'll receive a 403 Forbidden response.

Base URL

All API endpoints are relative to:

https://www.mocksyapp.com/app/v1

Example: https://www.mocksyapp.com/app/v1/customers/

Customers

GET /customers/

List customers in your organisation. Use the web app to create and manage customers.

Example Response:

{
  "count": 1,
  "limit": 200,
  "customers": [
    {
      "id": 1,
      "first_name": "Alice",
      "last_name": "Johnson",
      "email": "alice.johnson@example.com",
      "phone": "+44 20 7946 0958",
      "created_at": "2026-01-15T10:30:00Z"
    }
  ]
}

SKUs (Products)

GET /skus/

List SKUs in your organisation. Use the web app to create and manage SKUs.

Example Response:

{
  "count": 1,
  "limit": 200,
  "skus": [
    {
      "id": 1,
      "name": "Wireless Mouse",
      "sku_code": "WM-001",
      "price": "29.99",
      "stock_level": 150,
      "created_at": "2026-01-15T10:30:00Z"
    }
  ]
}

Orders

GET /orders/

List orders in your organisation. Use the web app to generate orders.

Query Parameters:

  • since (optional): ISO 8601 datetime to filter orders created after this time
  • limit (optional): Number of results to return (max 200)

Example Response:

{
  "count": 1,
  "limit": 200,
  "orders": [
    {
      "id": 1,
      "external_id": "ord_abc123",
      "customer": {
        "id": 1,
        "first_name": "Alice",
        "last_name": "Johnson"
      },
      "total": "59.98",
      "created_at": "2026-01-15T14:20:00Z",
      "lines": [
        {
          "sku_id": 1,
          "quantity": 2,
          "unit_price": "29.99"
        }
      ]
    }
  ]
}

Webhooks

Webhooks allow you to receive real-time notifications when events occur in your organisation.

Pro/Teams feature: Webhooks are available on Pro and Teams plans.

Supported Events

  • order.created: Triggered when a new order is created

Configuration

  1. Navigate to Integrations → Webhooks in the web app
  2. Click "New webhook"
  3. Enter your endpoint URL (must be HTTPS)
  4. Select the events you want to subscribe to
  5. Save and copy your signing secret

Delivery

Webhook payloads are delivered via HTTP POST with a JSON body. Mocksy uses best-effort delivery and will retry failed deliveries with exponential backoff.

Example Webhook Payload:

{
  "event": "order.created",
  "data": {
    "id": 1,
    "customer_id": 1,
    "order_number": "ORD-2026-001",
    "total": "119.97",
    "created_at": "2026-01-15T14:20:00Z"
  },
  "timestamp": "2026-01-15T14:20:01Z"
}

Limits & Rate Limiting

Each plan has limits on the number of customers, SKUs, and orders you can store. API keys also have monthly request quotas and rate limits to ensure fair usage.

Plan limits: See the Pricing page for detailed limits by plan.

If you exceed your rate limit or monthly quota, API requests will return a 429 Too Many Requests response. Wait a moment and retry, or upgrade your plan for higher limits.

Result Limits

List endpoints return up to 200 results by default. Use the limit query parameter to request fewer results. 

GET /customers/?limit=50

All list responses include count (number of items returned) and limit (maximum items requested).

Ready to start?

Create your account and start generating mock data in minutes.

Create account