1
APIキーを取得する
Zonos アカウントを取得する: Zonos APIを使用するには、APIキーが必要です。キーを取得するにはサインアップフォームに記入する必要があります。アカウント契約が整い次第、オンボーディングが始まります。オンボーディング中に、担当者がアカウントを正しく設定する手助けをし、最も正確なAPIレスポンスを得られるようにします。
Zonos アカウントをお持ちの場合は、こちらかAPIキーにアクセスできます。これにより、Zonos APIで認証できます。アカウントをお持ちでない場合は、上記の注意事項を参照してください。
2
取得する詳細を決定する
同様の accountOrderId に基づいて注文のリストをクエリするか、公開された注文の間の日付範囲を指定することができます。利用可能なフィールドの完全なリストについてはGraphQL APIリファレンスを参照してください。
クエリする各個別の注文には、国、配送情報、landed cost 合計など、すべての通常の Order フィールドが利用可能です。すべての可能なフィールドはGraphQL APIリファレンスにリストされています。
クエリ
1
2
3
4
5
6
7
8
9
10
query orders($ordersFilter: OrdersFilter, $first: Int) {
orders(filter: $ordersFilter, first: $first) {
edges {
node {
id
# ... field names here
}
}
}
}
変数
1
2
3
4
5
6
7
8
{
"ordersFilter": {
"between": {
"before": "2022-10-01",
"after": "2022-09-01"
}
}
}
3
ページを取得するために送信する
リストを取得するすべてのクエリはRelayスタイルのページネーションをサポートしています。first変数を使用すると、返されるオブジェクトの数を指定できます。
クエリ
1
2
3
4
5
query orders($filter: OrderFilter!, $first: Int) {
orders(orderFilter: $filter, first: $first) {
# ... field names here
}
}
変数
1
2
3
{
"first": 20
}
4
リクエストを送信する
リクエストを構築し、設定したので、Zonos API に POST リクエストを送信できます。API キーで認証し、リクエストに正しいバージョンヘッダーを提供してください。
POST https://api.zonos.com/graphql/
クエリ
1
2
3
4
5
6
7
8
9
10
11
12
13
14
query orders($ordersFilter: OrdersFilter, $first: Int) {
orders(filter: $ordersFilter, first: $first) {
edges {
node {
id
items {
description
hsCode
quantity
}
}
}
}
}
変数
1
2
3
4
5
6
7
8
9
{
"ordersFilter": {
"between": {
"before": "2022-10-01",
"after": "2022-09-01"
}
},
"first": 20
}
応答
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
"data": [
{
"order": {
"id": "1000753",
"items": [
{
"description": "Blue Snorkle Set",
"hsCode": "9506290000",
"quantity": 2
}
]
}
}
]
}
注文の検索とフィルタリング
GraphQLを使用して注文のリストを取得します。GraphQLの
ordersクエリを使用すると、さまざまな基準でページネートされた注文のリストを取得できます。これは、国別、特定の日付の範囲内での注文リストを構築する必要がある場合に便利です。