Lấy khóa API của bạn
Tạo một tài khoản Zonos: Để sử dụng API Zonos, bạn sẽ cần một khóa API. Để lấy khóa của bạn, bạn sẽ cần hoàn thành mẫu đăng ký. Quá trình hướng dẫn sẽ bắt đầu khi bạn có thỏa thuận tài khoản. Trong quá trình hướng dẫn, một đại diện sẽ giúp bạn thiết lập tài khoản của mình một cách chính xác để bạn nhận được phản hồi API chính xác nhất.
Truy cập khóa API của bạn tại đây nếu bạn có tài khoản Zonos. Điều này sẽ cho phép bạn xác thực với API Zonos. Nếu bạn không có tài khoản, hãy xem ghi chú ở trên.
Quyết định chi tiết nào cần lấy
Bạn có thể truy vấn danh sách đơn hàng dựa trên các accountOrderId
tương tự hoặc bằng cách cung cấp một khoảng thời gian mà trong đó các đơn hàng được công bố. Để có danh sách đầy đủ các trường có sẵn, hãy tham khảo tài liệu tham khảo API GraphQL.
Trên mỗi đơn hàng riêng lẻ mà bạn truy vấn, tất cả các trường Order
thông thường đều có sẵn, ví dụ: quốc gia, thông tin vận chuyển, tổng chi phí landed cost, v.v. Tất cả các trường có thể có đều được liệt kê trong tài liệu tham khảo API GraphQL.
Truy vấn
query orders($ordersFilter: OrdersFilter, $first: Int) {
orders(filter: $ordersFilter, first: $first) {
edges {
node {
id
# ... field names here
}
}
}
}
Biến
{
"ordersFilter": {
"between": {
"before": "2022-10-01",
"after": "2022-09-01"
}
}
}
Gửi các trang để lấy
Tất cả các truy vấn lấy danh sách hỗ trợ phân trang theo kiểu Relay. Biến first
cho phép bạn chỉ định số lượng đối tượng được trả về.
Truy vấn
query orders($filter: OrderFilter!, $first: Int) {
orders(orderFilter: $filter, first: $first) {
# ... field names here
}
}
Biến
{
"first": 20
}
Gửi yêu cầu của bạn
Bây giờ bạn đã xây dựng yêu cầu của mình và cấu hình nó, bạn có thể gửi một yêu cầu POST
đến API Zonos. Hãy chắc chắn xác thực bằng khóa API của bạn và cung cấp tiêu đề phiên bản chính xác trong yêu cầu của bạn.
POST https://api.zonos.com/graphql/
Truy vấn
query orders($ordersFilter: OrdersFilter, $first: Int) {
orders(filter: $ordersFilter, first: $first) {
edges {
node {
id
items {
description
hsCode
quantity
}
}
}
}
}
Biến
{
"ordersFilter": {
"between": {
"before": "2022-10-01",
"after": "2022-09-01"
}
},
"first": 20
}
Phản hồi
{
"data": [
{
"order": {
"id": "1000753",
"items": [
{
"description": "Blue Snorkle Set",
"hsCode": "9506290000",
"quantity": 2
}
]
}
}
]
}
Tìm kiếm và lọc đơn hàng
Lấy danh sách đơn hàng với GraphQL.Sử dụng truy vấn
orders
trong GraphQL, bạn có thể lấy danh sách phân trang của các đơn hàng với nhiều tiêu chí khác nhau. Điều này rất hữu ích khi bạn cần danh sách đơn hàng theo quốc gia, trong khoảng thời gian cụ thể, để xây dựng một tìm kiếm, v.v.