API Overview

​

Introduction

​

API at No Extra Cost

• Full REST API - Create, update, delete products; manage orders programmatically
• Real-time Webhooks - Get instant notifications when orders are placed
• No API Fees - API access is included in our 10% flat fee (no usage limits)
• Complete Control - Automate everything from inventory to order fulfillment

​

TribeMade API Capabilities

​

Base URL

https://api.tribemade.in

​

API Capabilities

​

📦 Product Management

• Get Product - Retrieve complete product information
• Create Product - Add new products with complete details
• Edit Product - Update any product field including prices, stock, images
• Delete Product - Remove products (with safety checks for active orders)

• Support for variations, sizes, colors
• Multiple images (up to 10 per product)
• Custom questions for customer input
• Categories and metadata
• Internal notes (seller-only)
• Stock management
• Sale pricing

​

🛍️ Order Management

• Get Order Details - Retrieve complete order information
• Update Order Status - Change status and add tracking

started → processing → dispatched → delivered
            ↘ cancelled (from any status)

• Complete customer information
• Delivery address details
• Order items with variations
• Special instructions
• Custom question responses
• Customer ratings and reviews
• Tracking URLs

​

🔔 Real-time Webhooks

• order.created - New order placed
• Push notifications to your server
• No polling required
• Up to 5 webhook URLs

​

Authentication

​

API Key Format

tb-xxxx-xxx-xxxx

​

How to Authenticate

curl https://api.tribemade.in/api/orders/ORDER_ID \
  -H "X-API-Key: tb-a1b2-c3d-e4f5"

​

Get Your API Key

1. Log in to TribeMade Dashboard
2. Navigate to Developer section
3. Click “Generate API Key”
4. Copy and store securely

​

Rate Limits

​

HTTP Status Codes

​

Request Format

​

Content Type

Content-Type: application/json

​

Request Body

{
  "name": "Product Name",
  "price": 499,
  "description": "Product description",
  "stock": 50
}

​

Response Format

​

Success Response

{
  "product_id": "660e8400-e29b-41d4-a716-446655440123"
}

{
  "message": "Product updated successfully"
}

{
  "id": "770e8400-...",
  "status": "processing",
  // ... full object
}

​

Error Response

{
  "error": "Error message describing what went wrong"
}

{
  "error": "All categories must be in store categories",
  "invalid": ["InvalidCategory"]
}

​

Data Formats

​

Dates and Times

2024-11-16T10:30:45.123456Z

​

Currency

{
  "price": 1299,
  "current_price": 999,
  "amount": 2048.00
}

​

UUIDs

770e8400-e29b-41d4-a716-446655440789

​

Phone Numbers

9876543210

​

Pincodes

400001

​

Field Constraints

​

Product Fields

​

Custom Question Format

{
  "question": "Question text (1-200 characters)",
  "type": "text"  // or "image"
}

• text - Customer provides text answer
• image - Customer uploads image

​

Order Status Values

​

Best Practices

​

1. Use Environment Variables

import os
api_key = os.environ.get('TRIBEMADE_API_KEY')

​

2. Use Webhooks, Not Polling

while True:
    check_for_orders()  # Wastes API calls
    time.sleep(60)

@app.route('/webhook', methods=['POST'])
def handle_order():
    process_order(request.json)
    return '', 200

​

3. Respect Rate Limits

• Implement exponential backoff
• Monitor X-RateLimit-Remaining header
• Space out bulk operations
• Handle 429 errors gracefully

​

4. Handle Errors Properly

• Check HTTP status codes
• Parse error messages
• Implement retry logic for 500 errors
• Don’t retry 400/401/403/404 errors

​

5. Validate Before Sending

• Check field lengths
• Validate data types
• Ensure categories exist
• Compress images to ≤ 5MB

​

Quick Start Checklist

• Get API key from dashboard
• Store API key in environment variable
• Test authentication with a GET request
• Create a test product
• Set up webhook endpoint (optional)
• Configure webhook URL in dashboard
• Test webhook with real order
• Implement error handling
• Add retry logic for failures
• Monitor API usage and errors

​

Support and Resources

​

Documentation

• Authentication - API key setup and security
• Rate Limits - Detailed rate limit information
• Error Handling - Complete error reference
• Products - Product management APIs
• Orders - Order management APIs
• Webhooks - Real-time notifications

​

Need Help?

• Dashboard: https://tribemade.in/dashboard
• API Base URL: https://api.tribemade.in
• Support: Contact through your dashboard

​

API Versioning

​

Security

​

What TribeMade Does

• ✅ All API traffic over HTTPS
• ✅ API keys are hashed in database
• ✅ Rate limiting to prevent abuse
• ✅ Input validation on all fields
• ✅ Authentication on all endpoints

​

What You Should Do

• ✅ Store API keys securely
• ✅ Use HTTPS for webhooks
• ✅ Validate webhook payloads
• ✅ Implement proper error handling
• ✅ Monitor for unusual activity
• ✅ Rotate API keys if compromised

​

API Endpoint Summary

​

Products

GET    /api/products/<id>            Get product details
POST   /api/products/create          Create new product
PUT    /api/products/<id>/edit       Update product
DELETE /api/products/<id>            Delete product

​

Orders

GET    /api/orders/<id>              Get order details
PUT    /api/orders/<id>/status       Update order status

​

Webhooks

POST   https://your-domain.com/webhook  Receive order.created events

​

Next Steps