API anahtarınızı alın
Bir Zonos hesabı edinin: Zonos API'sini kullanmak için bir API anahtarına ihtiyacınız olacak. Anahtarınızı almak için kayıt formumuzu doldurmanız gerekecek. Hesap anlaşmanız tamamlandığında, onboarding süreci başlayacaktır. Onboarding sırasında, bir temsilci hesabınızı doğru bir şekilde ayarlamanıza yardımcı olacak, böylece en doğru API yanıtlarını alabilirsiniz.
Eğer bir Zonos hesabınız varsa, API anahtarınıza buradan erişebilirsiniz. Bu, Zonos API'si ile kimlik doğrulamanızı sağlayacaktır. Eğer bir hesabınız yoksa, yukarıdaki notu kontrol edin.
Hangi detayları alacağınıza karar verin
Sipariş listelerini benzer accountOrderId
'lere göre veya siparişlerin yayınlandığı tarih aralığını belirterek sorgulayabilirsiniz. Mevcut alanların tam listesi için GraphQL API referansına başvurun.
Sorguladığınız her bir sipariş için, tüm normal Order
alanları mevcuttur; örneğin, ülke, gönderim bilgileri, landed cost toplamları vb. Tüm olası alanlar GraphQL API referansında listelenmiştir.
Sorgu
query orders($ordersFilter: OrdersFilter, $first: Int) {
orders(filter: $ordersFilter, first: $first) {
edges {
node {
id
# ... field names here
}
}
}
}
Değişkenler
{
"ordersFilter": {
"between": {
"before": "2022-10-01",
"after": "2022-09-01"
}
}
}
Sayfaları almak için gönderin
Listeyi geri getiren tüm sorgular Relay tarzı sayfalama destekler. first
değişkeni, kaç nesnenin döndürüleceğini belirtmenizi sağlar.
Sorgu
query orders($filter: OrderFilter!, $first: Int) {
orders(orderFilter: $filter, first: $first) {
# ... field names here
}
}
Değişkenler
{
"first": 20
}
Talebinizi gönderin
Artık talebinizi oluşturduğunuza ve yapılandırdığınıza göre, Zonos API'sine bir POST
isteği gönderebilirsiniz. API anahtarınızla kimlik doğrulaması yaptığınızdan ve isteğinizde doğru sürüm başlığını sağladığınızdan emin olun.
POST https://api.zonos.com/graphql/
Sorgu
query orders($ordersFilter: OrdersFilter, $first: Int) {
orders(filter: $ordersFilter, first: $first) {
edges {
node {
id
items {
description
hsCode
quantity
}
}
}
}
}
Değişkenler
{
"ordersFilter": {
"between": {
"before": "2022-10-01",
"after": "2022-09-01"
}
},
"first": 20
}
Yanıt
{
"data": [
{
"order": {
"id": "1000753",
"items": [
{
"description": "Blue Snorkle Set",
"hsCode": "9506290000",
"quantity": 2
}
]
}
}
]
}
Siparişleri arama ve filtreleme
GraphQL ile sipariş listelerini alın.orders
sorgusunu GraphQL'de kullanarak, çeşitli kriterlere göre sayfalı sipariş listeleri alabilirsiniz. Bu, belirli bir ülkeye göre, belirli tarihler arasında veya bir arama oluşturmak için sipariş listesine ihtiyaç duyduğunuzda faydalıdır.