ShopVista API Documentation

Integrate ShopVista's powerful e-commerce infrastructure into your application. Our RESTful API provides secure, scalable access to products, orders, customers, and analytics with comprehensive webhook support.

Authentication

ShopVista uses API keys for authentication. Include your secret key in the request header.

Authorization: Bearer sv_live_sk_8x9y2z3a4b5c6d7e8f9g0h1i2j3k4l5m

Key Types

Rate Limiting

Requests are limited to 1,000 requests per minute per API key. Rate limit information is included in response headers:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 942
X-RateLimit-Reset: 1718902345

Products

Manage product catalog, inventory, pricing, and metadata.

{
  "data": [
    {
      "id": "prod_8x7y6z5a4b",
      "name": "Wireless Pro Headphones",
      "sku": "WPH-001",
      "price": 89.99,
      "currency": "USD",
      "inventory": 142,
      "status": "active",
      "created_at": "2025-01-15T08:30:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1584
  }
}

curl -X POST https://api.shopvista.com/v1/products \

  -H "Authorization: Bearer sv_live_sk_..." \

  -H "Content-Type: application/json" \

  -d '{"name":"Smart Watch","sku":"SW-100","price":29900}'

Orders

Process transactions, track fulfillment, and manage refunds.

{
  "id": "ord_9z8y7x6w5v",
  "status": "pending_payment",
  "total": 89.99,
  "currency": "USD",
  "created_at": "2025-03-10T14:22:00Z",
  "payment_url": "https://checkout.shopvista.com/pay/ord_9z8y7x6w5v"
}

Customers

Manage buyer profiles, addresses, and purchase history.

{
  "id": "cus_1a2b3c4d5e",
  "email": "alex.developer@example.com",
  "name": "Alex Chen",
  "phone": "+1-555-0198",
  "total_orders": 14,
  "lifetime_value": 1240.50,
  "metadata": {
    "loyalty_tier": "gold",
    "preferred_payment": "credit_card"
  }
}

Webhooks

Subscribe to real-time events for order updates, inventory changes, and payment confirmations.

Available Events

Webhook Payload Structure

{
  "id": "evt_8x7y6z5a4b3c",
  "type": "order.paid",
  "created": 1710000000,
  "data": {
    "object": {
      "id": "ord_9z8y7x6w5v",
      "status": "paid",
      "amount": 8999
    }
  }
}

Error Handling

ShopVista uses standard HTTP status codes and returns structured error objects.

Error Response Format

{
  "error": {
    "code": "invalid_request_error",
    "message": "Missing required field: customer_id",
    "param": "customer_id",
    "doc_url": "https://docs.shopvista.com/errors#invalid_request"
  }
}

SDKs & Libraries

Official client libraries for rapid integration:

Changelog