πŸ“š API Documentation

RESTful API for the This Warm is for Profit e-commerce platform.

πŸ”— Base URL

https://warm.platphormnews.com/api/v1

πŸ₯ Health Check

GET/api/health

Check service health and status.

🍫 Products

GET/api/v1/products

List all products. Supports filtering by category and featured status.

Query Parameters:

  • category - Filter by: classic, mushroom, sprout
  • featured - Boolean to get featured products
GET/api/v1/products/{slug}

Get a single product by its slug.

πŸ“‹ Kanban Integration

GET/api/v1/kanban

Get kanban project info for order fulfillment workflow.

POST/api/v1/kanban

Create a fulfillment task (procurement, fulfillment, or success).

Request Body:

{
  "title": "Order #123 Fulfillment",
  "description": "Prepare and ship order",
  "type": "fulfillment",
  "order_id": "ord_123",
  "priority": "high"
}

🌱 Suppliers

GET/api/v1/suppliers/greens

Get supplier info and ingredient inventory from greens.platphormnews.com.

POST/api/v1/suppliers/greens

Create a supply order for microgreen ingredients.

Request Body:

{
  "ingredient_id": "sunflower-sprouts",
  "quantity_kg": 5,
  "delivery_date": "2026-03-01"
}

πŸ”„ Orders Sync

POST/api/v1/orders/sync

Sync offline orders from localStorage to database when connection is restored.

Request Body:

{
  "orders": [
    {
      "local_id": "local_123",
      "email": "customer@example.com",
      "items": [...],
      "created_at": "2026-02-26T12:00:00Z"
    }
  ],
  "device_id": "device_abc123"
}

πŸ“„ OpenAPI Specification

Full OpenAPI 3.1.0 specification available at:

πŸ”— /api/docs

πŸ€– LLM Discovery

🌐 Integrations

πŸ“‹ Kanban: kanban.platphormnews.com - Order fulfillment workflow

🎨 ASCII Art: ascii.platphormnews.com - Graphics generation

πŸ’³ Stripe: Secure payment processing