Powerful API for developers
Build custom integrations, automate workflows, and extend your store's functionality with our comprehensive REST API.
Everything you need to integrate
RESTful API, webhooks, SDKs, and comprehensive documentation
REST API
Simple, predictable REST endpoints for all your eCommerce data
Webhooks
Real-time notifications for orders, payments, and inventory changes
SDKs
Official SDKs for Python, Node.js, PHP, and more
Documentation
Comprehensive guides, examples, and interactive API explorer
Quick Start
Get up and running with our API in minutes
Authentication
API Authentication
curl -H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
https://api.yoursite.biz/v1/productsCreate a Product
POST /v1/products
{
"name": "Awesome T-Shirt",
"description": "Super comfortable cotton t-shirt",
"price": "29.99",
"inventory": 100,
"images": [
"https://example.com/image1.jpg"
],
"categories": ["clothing", "t-shirts"]
}Retrieve Orders
GET /v1/orders
GET /v1/orders?status=completed&limit=10
Response:
{
"orders": [
{
"id": "ord_123456",
"status": "completed",
"total": "89.97",
"customer": {
"email": "customer@example.com"
},
"items": [...]
}
],
"pagination": {...}
}Webhook Example
Order Created Webhook
{
"event": "order.created",
"data": {
"id": "ord_789012",
"status": "pending",
"total": "49.99",
"created_at": "2024-01-15T10:30:00Z"
}
}API Endpoints
Complete reference for all available endpoints
Products
GET
List all products
/v1/products
GET
Retrieve a product
/v1/products/{id}
POST
Create a product
/v1/products
PUT
Update a product
/v1/products/{id}
Orders
GET
List all orders
/v1/orders
GET
Retrieve an order
/v1/orders/{id}
PUT
Update order status
/v1/orders/{id}
Customers
GET
List all customers
/v1/customers
GET
Retrieve a customer
/v1/customers/{id}
POST
Create a customer
/v1/customers