DOCS

Searching and filtering orders

/

搜索和过滤订单

使用 GraphQL 检索订单列表。

使用 orders 查询在 GraphQL 中,您可以根据各种标准检索分页的订单列表。这在您需要按国家、特定日期之间的订单列表、构建搜索等时非常有用。

1

获取您的 API 密钥

获取 Zonos 账户: 为了使用 Zonos API,您需要一个 API 密钥。要获取您的密钥,您需要完成我们的 注册表单。一旦您达成账户协议,入职将开始。在入职期间,代表将帮助您正确设置账户,以便您获得最准确的 API 响应。

如果您拥有 Zonos 账户,可以在此访问您的 API 密钥。这将允许您与 Zonos API 进行身份验证。如果您没有账户,请参见上面的说明。

2

决定要检索哪些详细信息

您可以根据相似的 accountOrderId 查询订单列表,或通过提供订单发布的日期范围。有关可用字段的完整列表,请查阅 GraphQL API 参考

在您查询的每个单独订单中,所有正常的 Order 字段均可用,例如国家、运输信息、landed cost 总计等。所有可能的字段在 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
          }
        ]
      }
    }
  ]
}

这个页面有帮助吗?


有问题吗?

联系我们。