API Documentation
Developer resources for integrating Completeful into your custom applications using our REST API.
Completeful API Overview
The Completeful API allows you to programmatically manage products, orders, and inventory. Build custom integrations, automate workflows, or create your own applications on top of our platform.
API Endpoint:
https://api.completeful.com/v1Getting Started
1. Generate API Keys
Navigate to Settings → API in your dashboard and create a new API key. Keep this secure - it provides full access to your account.
2. Authentication
All API requests require authentication using Bearer tokens:
Authorization: Bearer YOUR_API_KEY3. Make Your First Request
Test your connection by fetching your account information:
curl -H "Authorization: Bearer YOUR_API_KEY" https://api.completeful.com/v1/accountCore API Endpoints
Products
GET /products- List all productsGET /products/:id- Get product detailsPOST /products- Create a new productPUT /products/:id- Update a productDELETE /products/:id- Delete a product
Orders
GET /orders- List all ordersGET /orders/:id- Get order detailsPOST /orders- Create a new orderPUT /orders/:id- Update order status
Webhooks
GET /webhooks- List webhooksPOST /webhooks- Create a webhookDELETE /webhooks/:id- Delete a webhook
Example: Create a Product
Here's an example of creating a new product via the API:
POST /v1/products
Content-Type: application/json
Authorization: Bearer YOUR_API_KEY
{
"title": "Awesome T-Shirt",
"description": "A really cool t-shirt design",
"base_product_id": "tshirt-unisex-crew",
"variants": [
{
"size": "M",
"color": "black",
"price": 29.99
}
],
"images": [
{
"url": "https://yoursite.com/design.png",
"position": "front"
}
]
}Webhooks
Subscribe to real-time events from Completeful using webhooks:
Available Events:
order.created- New order placedorder.fulfilled- Order shippedorder.cancelled- Order cancelledproduct.updated- Product modifiedinventory.low- Low inventory alert
Rate Limits
To ensure fair usage and system stability, API requests are rate-limited:
| Plan | Requests per Minute | Requests per Hour |
|---|---|---|
| Free | 60 | 1,000 |
| Pro | 120 | 5,000 |
| Enterprise | Custom | Custom |
Rate Limit Headers:
Each API response includes headers showing your rate limit status:
X-RateLimit-LimitX-RateLimit-RemainingX-RateLimit-Reset
Error Handling
The API uses standard HTTP status codes and returns detailed error messages:
200 OK- Request successful400 Bad Request- Invalid parameters401 Unauthorized- Invalid API key404 Not Found- Resource not found429 Too Many Requests- Rate limit exceeded500 Server Error- Internal error
Additional Resources
Full API Reference
Complete documentation with all endpoints, parameters, and examples.
View Full Documentation →SDK Libraries
Official SDKs for popular programming languages.
- • Node.js / JavaScript
- • Python
- • PHP
- • Ruby
Need help with the API? Contact our developer support team.