E-Commerce REST API
Complete REST API documentation for an e-commerce platform covering customers, products, categories, and orders. Demonstrates OAuth2 with granular scopes, webhook signature security, and ERD lineage tracking.
The E-Commerce API provides 11 endpoints for managing customers, products, categories, and orders. This example demonstrates OAuth2 authentication with granular scopes, webhook signature security for callbacks, and full schema lineage to database entities.
Customer Endpoints
Manage customer accounts and retrieve customer information.
Product Endpoints
Browse and manage the product catalogue.
Retrieve a paginated list of products. Supports filtering by category, price range, and availability.
Category Endpoints
Manage product categories and category hierarchies.
Retrieve the product category hierarchy. Returns root categories with nested children.
Order Endpoints
Create and manage customer orders.
Create a new order with items. Validates product availability and calculates totals.
Add a new item to an existing order. Only allowed while order is in Pending status.
Update the status of an order. Validates status transitions (e.g., cannot ship before payment).