Mock Food Ordering API
  1. Orders
Mock Food Ordering API
  • General
    • API Information
      GET
    • Health Check
      GET
  • Orders
    • List Orders
      GET
    • Create Order
      POST
    • Get Order by ID
      GET
    • Update Order
      PATCH
    • Delete Order
      DELETE
    • Cancel Order (Convenience Endpoint)
      PATCH
  • Schemas
    • Schemas
      • OrderStatus
      • OrderItem
      • Receipt
      • Order
      • CreateOrderRequest
      • UpdateOrderRequest
      • Pagination
      • OrderListData
      • ApiResponse
      • OrderResponse
      • OrderListResponse
      • DeleteResponse
      • HealthResponse
      • ApiInfoResponse
      • ErrorResponse
    • Response
      • BadRequest
      • NotFound
      • ValidationError
      • InternalServerError
  1. Orders

List Orders

GET
/orders
Retrieve a list of all orders with optional filtering and pagination.
Supports filtering by order status and pagination through limit/offset or page-based parameters.

Request

Query Params

Responses

🟢200OK
application/json
Orders retrieved successfully
Body

🟠400Bad Request
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/orders'
Response Response Example
200 - Success
{
    "success": true,
    "data": {
        "orders": [
            {
                "id": "ORD-1705312200000-001",
                "customerName": "John Doe",
                "customerEmail": "john@example.com",
                "status": "pending",
                "items": [
                    {
                        "id": "item-1",
                        "orderId": "ORD-1705312200000-001",
                        "name": "Burger",
                        "quantity": 1,
                        "price": 8.99,
                        "subtotal": 8.99
                    },
                    {
                        "id": "item-2",
                        "orderId": "ORD-1705312200000-001",
                        "name": "Fries",
                        "quantity": 1,
                        "price": 3.99,
                        "subtotal": 3.99
                    }
                ],
                "total": 12.98,
                "createdAt": "2024-01-15T10:30:00.000Z",
                "updatedAt": "2024-01-15T10:30:00.000Z"
            }
        ],
        "pagination": {
            "total": 1,
            "page": 1,
            "limit": 10,
            "offset": 0
        }
    }
}
Modified at 2025-09-17 13:22:25
Previous
Health Check
Next
Create Order
Built with