List Orders
取得組織的訂單資料，單次資料上限為 100 筆。
Endpoint
| Item | Value |
|---|---|
| Method | GET |
| Path | /platform/order |
Authentication
資訊
此 endpoint 需要在 request header 帶入 x-api-key。private key 請聯繫客服申請。
Request
Headers
| Header | Required | Description |
|---|---|---|
x-api-key | Yes | 請聯繫客服申請 private key。 |
Query Parameters
| Field | Type | Required | Description |
|---|---|---|---|
$filter | string | No | 允許欄位：id, order_number, payment_type, order_status, payment_status, create_date_time。支援函數：contains()、cast()、any()、all()。 |
$orderby | string | No | 允許欄位：payment_type, order_status, payment_status, create_date_time。 |
$skip | integer | No | 要跳過的資料筆數。最小值 0。 |
$top | integer | No | 要取得的資料筆數。範圍 1 到 100。 |
Response
Success Response
成功時回傳 200 OK 與 OrderResponsePagedResponse。
{
"value": [
{
"order_id": "2fe533a2-8787-4a61-a4a4-5ce049d59658",
"order_number": "ORD-202606020001",
"payment_type": "credit",
"order_status": "establish",
"payment_status": "complete",
"total": 120,
"order_detail": [],
"create_date_time": "2026-06-02T12:30:00+08:00",
"update_date_time": null
}
],
"@odata.count": 1
}
Error Responses
| HTTP Status | Code | Meaning | How to Fix |
|---|---|---|---|
400 | o_data_failed | OData query 語法、欄位或函數不符合限制。 | 檢查 $filter、$orderby 欄位是否在允許清單中。 |
401 | token_validation_failed | private key 缺漏或無效。 | 確認 x-api-key header，必要時聯繫客服重新申請。 |
Examples
curl "https://api.guo-guo.com/platform/order?\$top=20&\$skip=0&\$orderby=create_date_time" \
-H "x-api-key: <private_key>"