1
API keyを取得
Zonosアカウントを取得: Zonos APIを使用するにはAPI keyが必要です。keyを取得するにはサインアップフォームを完了してください。アカウント契約が成立するとオンボーディングが開始されます。オンボーディング中、担当者がアカウントを正しく設定し、最も正確なAPIレスポンスを得られるよう支援します。
Zonosアカウントをお持ちの場合は、こちらからAPI keyにアクセスできます。これによりZonos APIで認証できます。アカウントをお持ちでない場合は、上記の注記をご覧ください。
2
取得する詳細を決定
GraphQLの accountOrderId の類似性に基づいて注文リストをクエリするか、注文が公開された日付範囲を指定できます。利用可能なフィールドの完全なリストについては、GraphQL APIリファレンスをご確認ください。
クエリする各個別の注文で、通常の Order フィールドがすべて利用可能です（国、配送情報、Landed Cost合計など）。すべての可能なフィールドはGraphQL APIリファレンスに記載されています。
1
query orders($ordersFilter: OrdersFilter, $first: Int) {2
orders(filter: $ordersFilter, first )3
edges4
node5
id3
取得するページ数を送信
リストを取得するすべてのクエリはRelay-style paginationをサポートしています。first 変数で返されるオブジェクト数を指定できます。
1
query orders($ordersFilter: OrdersFilter, $first: Int) {2
orders(filter: $ordersFilter, first: $first) {3
edges {4
node {5
id6
}7
}8
pageInfo {9
hasNextPage10
endCursor11
}12
}13
}4
リクエストを送信
リクエストを構築して設定したら、Zonos APIに POST リクエストを送信できます。API keyで認証し、リクエストに正しいバージョンヘッダーを提供してください。
POST https://api.zonos.com/graphql
1
query orders($ordersFilter: OrdersFilter, $first: Int) {2
orders(filter: $ordersFilter, first: $first) {3
edges {4
node {5
id6
items {7
description8
hsCode9
quantity10
}11
}12
}13
}14
}GraphQL API ReferenceTypes, inputs, and operations used in this guide
INPUTS
注文を検索・フィルタリング
GraphQLで注文リストを取得します。GraphQLの
ordersクエリを使用すると、さまざまな条件でページ分割された注文リストを取得できます。国別の注文リスト、特定の日付間の注文、検索の構築などに便利です。