Overview
Get started with the Sheloommom API and learn the basics of our dropshipping integration.
Base URL
All API requests should be made to the following base URL:
https://api.sheloommom.com/v1API Versioning
The Sheloommom API is versioned to ensure backward compatibility. The current version is v1. We recommend always specifying the version in your API calls to ensure consistent behavior.
Subscribe to our developer newsletter to stay updated on API changes and new features.
Rate Limits
To ensure fair usage and platform stability, API requests are rate-limited based on your plan:
| Plan | Requests per minute | Requests per day |
|---|---|---|
| Starter | 60 | 10,000 |
| Professional | 300 | 100,000 |
| Enterprise | Unlimited | Unlimited |
Authentication
Learn how to authenticate your API requests using API keys.
API Key Authentication
Sheloommom uses API keys to authenticate requests. You can view and manage your API keys in the Dashboard Settings.
Include your API key in the Authorization header of all API requests:
Authorization: Bearer YOUR_API_KEYKeep your API keys secure and never expose them in client-side code or public repositories. If you suspect your key has been compromised, regenerate it immediately from your dashboard.
Example Request
Here's an example of an authenticated request using cURL:
curl -X GET "https://api.sheloommom.com/v1/products" \
-H "Authorization: Bearer sk_live_1234567890abcdef" \
-H "Content-Type: application/json"JavaScript Example
Using the Fetch API in JavaScript:
const fetchProducts = async () => {
const response = await fetch('https://api.sheloommom.com/v1/products', {
method: 'GET',
headers: {
'Authorization': 'Bearer sk_live_1234567890abcdef',
'Content-Type': 'application/json'
}
});
const data = await response.json();
return data;
};Products
Access our catalog of 2,000+ dropshipping products.
Retrieve a list of all available products with optional filtering and pagination.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| category | string | Optional | Filter by category (lifestyle, electronics) |
| limit | integer | Optional | Number of results per page (default: 20, max: 100) |
| page | integer | Optional | Page number for pagination (default: 1) |
| search | string | Optional | Search products by name or keyword |
Response Example
{
"data": [
{
"id": "prod_123456",
"name": "LED Smart Makeup Mirror",
"category": "lifestyle",
"price": 12.50,
"retail_price": 28.00,
"stock": 150,
"images": [
"https://cdn.sheloommom.com/images/mirror-1.jpg"
],
"description": "Professional LED mirror with 3 lighting modes",
"sku": "VEL-MR-001"
}
],
"meta": {
"total": 2048,
"page": 1,
"limit": 20
}
}Retrieve detailed information about a specific product.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | Required | The unique product ID |
Orders
Create and manage dropshipping orders through the API.
Create a new dropshipping order. We'll handle fulfillment and shipping automatically.
Request Body
| Parameter | Type | Required | Description |
|---|---|---|---|
| items | array | Required | Array of order items with product_id and quantity |
| shipping_address | object | Required | Customer shipping address details |
| customer_email | string | Required | Customer email for notifications |
| reference_id | string | Optional | Your internal order reference |
Request Example
{
"items": [
{
"product_id": "prod_123456",
"quantity": 2
}
],
"shipping_address": {
"name": "Jane Smith",
"line1": "123 Main Street",
"city": "New York",
"state": "NY",
"postal_code": "10001",
"country": "US"
},
"customer_email": "jane@example.com",
"reference_id": "ORDER-12345"
}Retrieve order details including status, tracking information, and shipping updates.
Response Example
{
"id": "ord_789012",
"status": "shipped",
"items": [
{
"product_id": "prod_123456",
"name": "LED Smart Makeup Mirror",
"quantity": 2,
"price": 12.50
}
],
"shipping": {
"carrier": "DHL",
"tracking_number": "1234567890",
"tracking_url": "https://dhl.com/tracking/1234567890"
},
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T14:20:00Z"
}Webhooks
Receive real-time notifications for order and inventory events.
Webhook Events
Sheloommom can send webhook notifications to your server when specific events occur. Configure your webhook URL in the dashboard.
| Event | Description |
|---|---|
| order.created | Triggered when a new order is created |
| order.shipped | Triggered when an order is shipped |
| order.delivered | Triggered when an order is delivered |
| product.stock_low | Triggered when product stock is running low |
| product.updated | Triggered when product details are updated |
Webhook Payload Example
{
"event": "order.shipped",
"timestamp": "2024-01-15T14:20:00Z",
"data": {
"order_id": "ord_789012",
"tracking_number": "1234567890",
"carrier": "DHL",
"tracking_url": "https://dhl.com/tracking/1234567890"
}
}Always verify webhook signatures to ensure the request came from Sheloommom. Use the webhook secret provided in your dashboard to validate the signature.
Error Codes
Reference for API error responses and troubleshooting.
HTTP Status Codes
Error Response Format
{
"error": {
"code": "invalid_api_key",
"message": "The provided API key is invalid",
"type": "authentication_error"
}
}Ready to Start Building?
Get your API key and start integrating Sheloommom's dropshipping platform with your store today.