跳至主要内容

OData 查詢參數

訂單列表、組織信用紀錄列表、產品列表支援 OData v4 query parameters。使用列表 API 時,請用 $top 控制單次取回筆數,並用 $skip 取得下一頁資料。

資訊

列表 endpoint 的單次回傳上限為 100 筆。若要同步完整資料,請用 $skip$top 分頁取得。

Supported Parameters

FieldTypeRequiredDescription
$filterstringNo依 endpoint 允許欄位篩選。支援函數:contains()cast()any()all()
$orderbystringNo依 endpoint 允許欄位排序。
$skipintegerNo要跳過的資料筆數。最小值 0
$topintegerNo要取回的資料筆數。最小值 1,最大值 100

Allowed Fields

Endpoint$filter Fields$orderby Fields
GET /platform/orderid, order_number, payment_type, order_status, payment_status, create_date_timepayment_type, order_status, payment_status, create_date_time
GET /platform/organization/credit/recordquantity, type, create_date_timequantity, type, create_date_time
GET /platform/productid, price, main_product_category, product_category, dynamic_probability, increase_speedprice, min, max, order_no

Example

curl "https://api.guo-guo.com/platform/product?\$top=20&\$skip=0&\$orderby=price" \
-H "x-api-key: <private_key>"