Documentation

Diseller provides a comprehensive API and dashboard for managing your online marketplace. Whether you're building a new application or integrating with an existing system, this documentation will guide you through the process.

To get started with Diseller, you can install our SDK or make direct API calls. We provide SDKs for multiple programming languages.

Using npm (JavaScript/TypeScript)

Using pip (Python)

Using composer (PHP)

All API requests require authentication using API keys. You can generate API keys from your dashboard.

Obtaining API Keys

1. Log in to your Diseller dashboard
2. Navigate to Settings → API Keys
3. Click "Generate New API Key"
4. Copy and securely store your API key

Using API Keys

Include your API key in the Authorization header of all requests:

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

The Diseller API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes.

Base URL

HTTP Methods

• GET - Retrieve resources
• POST - Create new resources
• PUT - Update existing resources
• DELETE - Delete resources
• PATCH - Partially update resources

Manage your product catalog using the Products API.

List Products

GET /products
Query Parameters:
  - page: integer (default: 1)
  - limit: integer (default: 20)
  - category: string (optional)

Create Product

POST /products
Body:
{
  "name": "Product Name",
  "description": "Product description",
  "price": 29.99,
  "category": "electronics",
  "stock": 100
}

Get Product

GET /products/:id

Manage customer orders and track their status.

Create Order

POST /orders
Body:
{
  "customer_id": "cust_123",
  "items": [
    {
      "product_id": "prod_456",
      "quantity": 2,
      "price": 29.99
    }
  ],
  "shipping_address": {
    "street": "123 Main St",
    "city": "New York",
    "state": "NY",
    "zip": "10001"
  }
}

Order Status Values

• pending - Order created but not paid
• processing - Payment received, being processed
• shipped - Order has been shipped
• delivered - Order delivered to customer
• cancelled - Order cancelled

Process payments securely through our payment gateway integration.

Create Payment Intent

POST /payments/intent
Body:
{
  "amount": 2999,
  "currency": "usd",
  "order_id": "order_123"
}

Webhooks allow you to receive real-time notifications about events in your Diseller account.

Setting Up Webhooks

1. Go to Dashboard → Settings → Webhooks
2. Click "Add Webhook Endpoint"
3. Enter your endpoint URL
4. Select the events you want to receive
5. Save and copy your webhook secret

Webhook Events

• order.created - New order created
• order.updated - Order status changed
• payment.succeeded - Payment successful
• payment.failed - Payment failed
• product.updated - Product information changed

The Diseller API uses standard HTTP response codes to indicate success or failure.

HTTP Status Codes

Error Response Format

{
  "error": {
    "code": "invalid_request",
    "message": "Missing required parameter: name",
    "param": "name"
  }
}

To ensure fair usage and system stability, our API implements rate limiting.

Rate Limits

• Standard: 100 requests per minute
• Premium: 500 requests per minute
• Enterprise: Custom limits available

Rate Limit Headers

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1640995200

• Always use HTTPS for API requests
• Store API keys securely and rotate them regularly
• Implement proper error handling and retry logic
• Use webhooks for real-time updates instead of polling
• Cache responses when appropriate
• Implement exponential backoff for retries
• Validate data before sending requests
• Monitor your API usage and rate limits

Need help? We're here to assist you.