DOCS

搜尋及篩選訂單

搜尋及篩選訂單

使用 GraphQL 擷取訂單清單。

使用 GraphQL 中的 orders 查詢,您可以擷取符合各種條件的分頁訂單清單。當您需要按國家、特定日期範圍取得訂單清單,或建立搜尋功能等情況時,這非常有用。

1

取得您的 API 金鑰

取得 Zonos 帳戶: 為使用 Zonos API,您需要一個 API 金鑰。如要取得金鑰,您需要填妥我們的登記表格。一旦帳戶協議生效,登記程序便會展開。在登記期間,代表將協助您正確設定帳戶,確保您取得最準確的 API 回應。

如果您已有 Zonos 帳戶,可在此存取您的 API 金鑰。這將讓您能夠向 Zonos API 進行身份驗證。如果您還沒有帳戶,請參閱上方的說明。

您可以根據相似的 accountOrderId 或提供訂單發佈的日期範圍來查詢訂單清單。如需完整的可用欄位清單,請參閱 GraphQL API 參考資料

在您查詢的每一筆訂單中,所有一般的 Order 欄位均可使用,例如:國家、運送資訊、落地成本總額等。所有可能的欄位均列於 GraphQL API 參考資料 中。

1query orders($ordersFilter: OrdersFilter, $first: Int) {
2 orders(filter: $ordersFilter, first: $first) {
3 edges {
4 node {
5 id

所有擷取清單的查詢均支援 Relay 式分頁first 變數可讓您指定要傳回的物件數量。

1query orders($ordersFilter: OrdersFilter, $first: Int) {
2 orders(filter: $ordersFilter, first: $first) {
3 edges {
4 node {
5 id
6 }
7 }
8 pageInfo {
9 hasNextPage
10 endCursor
11 }
12 }
13}

現在您已建立並設定好請求,即可向 Zonos API 傳送 POST 請求。請確保使用您的 API 金鑰進行身份驗證,並在請求中提供正確的版本標頭。

POST https://api.zonos.com/graphql

1query orders($ordersFilter: OrdersFilter, $first: Int) {
2 orders(filter: $ordersFilter, first: $first) {
3 edges {
4 node {
5 id
6 items {
7 description
8 hsCode
9 quantity
10 }
11 }
12 }
13 }
14}
GraphQL API ReferenceTypes, inputs, and operations used in this guide
預約演示

這個頁面有幫助嗎?