Dapatkan kunci API Anda
Dapatkan akun Zonos: Untuk menggunakan API Zonos Anda memerlukan kunci API. Untuk mendapatkan kunci Anda, Anda perlu menyelesaikan formulir pendaftaran. Proses onboarding akan dimulai setelah Anda memiliki kesepakatan akun. Selama onboarding, seorang perwakilan akan membantu Anda mengatur akun Anda dengan benar sehingga Anda mendapatkan respons API yang paling akurat.
Akses kunci API Anda di sini jika Anda memiliki akun Zonos. Ini akan memungkinkan Anda untuk mengautentikasi dengan API Zonos. Jika Anda tidak memiliki akun, lihat catatan di atas.
Tentukan detail yang ingin diambil
Anda dapat mengkueri daftar pesanan berdasarkan accountOrderId
yang serupa atau dengan memberikan rentang tanggal di mana pesanan diterbitkan. Untuk daftar lengkap bidang yang tersedia, konsultasikan referensi API GraphQL.
Pada setiap pesanan individu yang Anda kueri, semua bidang Order
normal tersedia, misalnya, negara, informasi pengiriman, total landed cost, dll. Semua bidang yang mungkin terdaftar dalam referensi API GraphQL.
Kueri
query orders($ordersFilter: OrdersFilter, $first: Int) {
orders(filter: $ordersFilter, first: $first) {
edges {
node {
id
# ... field names here
}
}
}
}
Variabels
{
"ordersFilter": {
"between": {
"before": "2022-10-01",
"after": "2022-09-01"
}
}
}
Kirim halaman untuk diambil
Semua kueri yang mengambil daftar mendukung paginasi gaya Relay. Variabel first
memungkinkan Anda untuk menentukan berapa banyak objek yang dikembalikan.
Kueri
query orders($filter: OrderFilter!, $first: Int) {
orders(orderFilter: $filter, first: $first) {
# ... field names here
}
}
Variabels
{
"first": 20
}
Kirim permintaan Anda
Sekarang setelah Anda membangun permintaan Anda dan mengonfigurasinya, Anda dapat mengirim permintaan POST
ke API Zonos. Pastikan untuk mengautentikasi dengan kunci API Anda dan memberikan header versi yang benar dalam permintaan Anda.
POST https://api.zonos.com/graphql/
Kueri
query orders($ordersFilter: OrdersFilter, $first: Int) {
orders(filter: $ordersFilter, first: $first) {
edges {
node {
id
items {
description
hsCode
quantity
}
}
}
}
}
Variabels
{
"ordersFilter": {
"between": {
"before": "2022-10-01",
"after": "2022-09-01"
}
},
"first": 20
}
Respon
{
"data": [
{
"order": {
"id": "1000753",
"items": [
{
"description": "Blue Snorkle Set",
"hsCode": "9506290000",
"quantity": 2
}
]
}
}
]
}
Mencari dan menyaring pesanan
Ambil daftar pesanan dengan GraphQL.Dengan menggunakan kueri
orders
dalam GraphQL, Anda dapat mengambil daftar pesanan yang dipaginasi dengan berbagai kriteria. Ini berguna ketika Anda memerlukan daftar pesanan berdasarkan negara, antara tanggal tertentu, untuk membangun pencarian, dll.