Skip to main content
GET
/
orders
List Orders
curl --request GET \
  --url https://api.example.com/orders
{
  "items": [
    {
      "id": "<string>",
      "totalPrice": 123,
      "status": "<string>",
      "createdAt": {},
      "address": {
        "province": "<string>",
        "city": "<string>",
        "detail": "<string>"
      }
    }
  ],
  "pageIndex": 123,
  "pageSize": 123,
  "totalCount": 123,
  "totalPages": 123
}
Retrieves a paginated list of orders.

​
Query Parameters

​
pageIndex
integer
default:"1"
The page number to retrieve (1-based indexing).
​
pageSize
integer
default:"10"
The number of orders to return per page.

​
Response

Returns a paginated resource containing order summaries.
​
items
array
List of order summaries for the requested page.
​
id
string
The unique identifier of the order.
​
totalPrice
decimal
The total price of the order.
​
status
string
The current status of the order.
​
createdAt
timestamp
The timestamp when the order was created.
​
address
object
The delivery address for the order.
​
province
string
Province or state.
​
city
string
City name.
​
detail
string
Detailed address information.
​
pageIndex
integer
The current page number.
​
pageSize
integer
The number of items per page.
​
totalCount
integer
The total number of orders available.
​
totalPages
integer
The total number of pages available.

​
Status Codes

  • 200 OK - Orders retrieved successfully

​
Example Request

curl -X GET "https://api.example.com/orders?pageIndex=1&pageSize=20" \

​
Example Response

{
  "items": [
    {
      "id": "order_abc123def456",
      "totalPrice": 109.97,
      "status": "CREATED",
      "createdAt": "2026-03-04T10:30:00Z",
      "address": {
        "province": "California",
        "city": "San Francisco",
        "detail": "123 Market St, Suite 400"
      }
    },
    {
      "id": "order_xyz789uvw012",
      "totalPrice": 299.99,
      "status": "PAID",
      "createdAt": "2026-03-03T15:45:00Z",
      "address": {
        "province": "New York",
        "city": "New York",
        "detail": "456 Broadway, Apt 12B"
      }
    }
  ],
  "pageIndex": 1,
  "pageSize": 20,
  "totalCount": 42,
  "totalPages": 3
}

Build docs developers (and LLMs) love

Get started for freeTalk to us