MEQRA API Endpoints Documentation

Endpoint Method Description Parameters Response Notes Updated At
/api/v1/shipping/create POST Create a new shipping order 
{"order_id": "int", "address": "string", "delivery_date": "date"}
 
{"status": "success", "shipping_id": 123}
 Requires authentication 2025-07-18 10:19:14
/api/v1/shipping/status GET Get shipping status by shipping ID 
{"shipping_id": "int"}
 
{"shipping_id": 123, "status": "In Transit"}
 Requires authentication 2025-07-18 10:19:14
/api/v1/sales/orders GET Retrieve list of sales orders 
{"page": "int", "limit": "int"}
 
{"orders": [{"id": 1, "total": 100.00}], "total": 50}
 Requires authentication 2025-07-18 10:19:14
/api/v1/sales/order/create POST Create a new sales order 
{"customer_id": "int", "products": "array"}
 
{"status": "success", "order_id": 456}
 Requires authentication 2025-07-18 10:19:14
/api/v1/payments/process POST Process a payment 
{"order_id": "int", "amount": "float", "payment_method": "string"}
 
{"status": "success", "payment_id": 789}
 Supports multiple payment gateways 2025-07-18 10:19:14
/api/v1/payments/status GET Get payment status 
{"payment_id": "int"}
 
{"payment_id": 789, "status": "Completed"}
 Requires authentication 2025-07-18 10:19:14
/api/v1/customers/list GET List all customers 
{"page": "int", "limit": "int"}
 
{"customers": [{"id": 1, "name": "Alice"}], "total": 200}
 Supports filtering by status 2025-07-18 10:19:14
/api/v1/customers/create POST Create new customer 
{"name": "string", "email": "string"}
 
{"status": "success", "customer_id": 321}
 Validates email 2025-07-18 10:19:14
/api/v1/products/list GET List all products 
{"page": "int", "limit": "int"}
 
{"products": [{"id": 1, "name": "Laptop"}], "total": 150}
 Supports category filter 2025-07-18 10:19:14
/api/v1/products/update PUT Update product details 
{"product_id": "int", "price": "float"}
 
{"status": "success"}
 Requires admin role 2025-07-18 10:19:14
/api/v1/reports/sales GET Generate sales report 
{"start_date": "date", "end_date": "date"}
 
{"total_sales": 10000, "orders": 200}
 Requires admin 2025-07-18 10:19:14
/api/v1/reports/inventory GET Generate inventory report 
{"category": "string"}
 
{"products": [{"id": 1, "stock": 50}]}
 — 2025-07-18 10:19:14
/api/users GET Retrieve a list of all users. 
page:int (optional), limit:int (optional)
 
{ "users": [ { "id": 1, "username": "johndoe" } ], "total": 100 }
 Supports pagination and filtering by role. 2025-07-18 10:02:37
/api/users/{id} GET Retrieve detailed information about a single user. 
id:int (required)
 
{ "id": 1, "username": "johndoe", "email": "john@example.com" }
 Returns 404 if user not found. 2025-07-18 10:02:37
/api/users POST Create a new user. 
{ "username": "string", "email": "string", "password": "string" }
 
{ "id": 10, "message": "User created successfully" }
 Validates email and password strength. 2025-07-18 10:02:37
/api/products GET Get list of products. 
category_id:int (optional), page:int, limit:int
 
{ "products": [ { "id": 1, "name": "Product A" } ], "total": 50 }
 — 2025-07-18 10:02:37
/api/products/{id} GET Get product details by ID. 
id:int
 
{ "id": 1, "name": "Product A", "price": 99.99 }
 — 2025-07-18 10:02:37
/api/orders POST Create a new order. 
{ "customer_id": "int", "items": [ { "product_id": "int", "quantity": "int" } ] }
 
{ "order_id": 123, "status": "pending" }
 Requires authentication. 2025-07-18 10:02:37
/api/orders/{id} GET Get order details. 
id:int
 
{ "order_id": 123, "status": "shipped", "items": [...] }
 — 2025-07-18 10:02:37
/api/invoices GET List all invoices. 
page:int, limit:int
 
{ "invoices": [ { "id": 1, "amount": 100.00 } ], "total": 30 }
 — 2025-07-18 10:02:37
/api/invoices/{id} GET Get invoice details. 
id:int
 
{ "id": 1, "amount": 100.00, "paid": true }
 — 2025-07-18 10:02:37
/api/auth/login POST Authenticate user and obtain token. 
{ "username": "string", "password": "string" }
 
{ "token": "abcdef123456" }
 Returns JWT token on success. 2025-07-18 10:02:37
/api/auth/logout POST Invalidate current authentication token. 
None
 
{ "message": "Logged out successfully" }
 — 2025-07-18 10:02:37