Gelişmiş Entegre Görünürlük (AIV) Gönderi Takip Numarası Abonelik API'si, Gelişmiş Entegre Görünürlük abonelerinin API uç noktalarını kullanarak gönderi takip numaralarını bir AIV web kancası projesiyle ilişkilendirmesini sağlar. Gönderi Takip Numarası İlişkilendirme özelliği iki işlem yöntemini destekler:

• Gönderi Takip Numarası İlişkilendirme – Senkronize, işlem sonuçlarını aynı HTTP yanıtı içinde döndürür. Bu seçenek, daha az sayıda gönderi takip numarası ilişkilendirilirken anında onay gerektiren uygulamalar için en uygundur. 
• Gönderi Takip Numarası İlişkilendirme – Asenkronize isteği arka planda işlenmesi için gönderir ve işleme durumunu ve sonuçları daha sonra almak için kullanılabilecek bir iş kimliği döndürür. Bu seçenek, fazla sayıda gönderi takip numarasının işlenmesi için en uygun seçimdir. 

Uygulamanızın performans ve iş yükü gereksinimlerini en iyi karşılayan işleme yöntemini seçin.

Not:

• Gelişmiş Entegre Görünürlük projeniz için yönetici veya katılımcı erişimine sahip olmanız gereklidir
• Gelişmiş Entegre Görünürlük ve özellikleri ile ilgili daha fazla bilgi edinmek için Gelişmiş Entegre Görünürlük belgeleri sayfasını ziyaret edin.

Gelişmiş Entegre Görünürlük Gönderi Takip Numarası Aboneliği API'si aşağıdaki avantajları sağlar:

• Gelişmiş Entegre Görünürlük web kancası projenizin gönderi takip numaralarını API uç noktalarını kullanarak kolayca ilişkilendirebilir, güncelleyebilir ve yönetebilirsiniz.
• Her bir gönderi takip numarasını ayrı ayrı işlemek yerine, birden fazla gönderi takip numarasını tek bir API isteğinde birleştirin.
• Anında sonuç almak için senkronize işleme veya daha büyük toplu işlemler için asenkronize işleme arasında seçim yapın.

Gelişmiş Entegre Görünürlük projenizi yönetmek için aşağıdaki uç noktaları kullanın:

• Gönderi Takip Numarası İlişkilendirme – Senkronize: Gönderi takip numaralarını bir web kancası ile ilişkilendirmenize ve nihai işlem durumunu aynı HTTP yanıtı içinde almanıza olanak tanır.
• Gönderi Takip Numarası İlişkilendirme – Asenkronize: Gönderi takip numaralarını bir web kancası ile ilişkilendirmenize ve daha sonra döndürülen jobId kullanarak asenkron işin durumunu kontrol etmenize veya ilgili uç noktaları kullanarak ayrıntıları indirmenize olanak tanır:    
  • Takip Numarası İş Durumu
  • Takip Numarası İş Ayrıntıları

Bu API'lere Gelişmiş Entegre Görünürlük projenizin genel bakışından ulaşabilirsiniz.

Bu API'lere yalnızca, yukarıdaki ekran görüntüsünde de gösterildiği gibi projenize ait genel bakış üzerinden erişilebilir.

Aşağıdaki tabloda senkronize ve asenkronize Gönderi Takip Numarası İlişkilendirme uç noktaları arasındaki farklar özetlenmiştir.
 

Hemen onay almanızı gerektiren az sayıda gönderi takip numarası grupları için senkronize uç noktayı kullanınız. Acil yanıt gerektirmeyen daha büyük partileri işlerken asenkronize uç noktayı kullanınız.

Bu uç noktayı kullanarak bir veya daha fazla gönderi takip numarasını Gelişmiş Entegre Görünürlük web kancası projesiyle ilişkilendirebilir ve işlem sonuçlarını aynı HTTP yanıtı içinde alabilirsiniz.

Bu uç nokta, anında onay gerektiren uygulamalar için tasarlanmıştır ve 150 adede kadar gönderi takip numarası içeren istekleri destekler.

Gerekli girdi: 

• subscriptionID
• trackingNumber

Avantajları

Senkronize uç nokta aşağıdaki avantajları sağlar:

• Anında işleme sonuçları
• Tek bir yanıtta ayrıntılı başarı ve başarısızlık bilgileri
• İstek başına 150 adede kadar gönderi takip numarası desteği
• İşlem öncesinde istek doğrulaması ve iş kuralı uygulanması
• Makine tarafından okunabilir hata kodları ve açıklayıcı hata mesajları
• İstek takibi ve sorun giderme için işlem kimlikleri

Gönderi Takip Numarası İlişkilendirme – Senkronize uç noktası, aşağıdakiler dahil olmak üzere birden fazla doğrulama kuralını uygular:

• Geçerli ve aktif bir subscriptionId gereklidir
• Her istek için yalnızca bir subscriptionId kullanılabilir
• trackingNumber gereklidir
• Gönderi takip numaralarının FedEx gereksinimlerini, maksimum 6 ila 22 hane gönderi takip numarası sınırı da dahil olmak üzere, karşılamasını sağlamak

Hata yanıtları, kolay ayrıştırma için kod ve mesaj içeren hatalar [] içeren tutarlı bir yapı izler.

"errors": [

{

"code": "ERROR.CODE",

"message": "Açıklayıcı hata mesajı"

}

İşlem Numarası İlişkilendirme – Senkronize uç noktası, kısmi başarılara olanak tanır. Bazı gönderi takip numaraları başarısız olduğunda, Senkronize API yine de 200 OK yanıtı döndürür ve aşağıdakileri gösterir:

• failedTrackingNumbers
• Açıklayıcı bir mesaj

{

"transactionId":

   "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",

   "output": {

      "failedTrackingNumbers":

         [ "XXXXX",

         " YYYYY"

         ],

      "message": "Aşağıdaki gönderi takip numaraları doğrulama ya da sistem hatası sebebiyle yüklenemedi."

      }

    }

Daha fazla ayrıntı ve kural için iş kuralları bölümüne bakınız.

Bu uç noktayı kullanarak bir veya daha fazla abone olunan takip numarasını arka planda işlenmek üzere gönderebilirsiniz.

Bu istek, işlemeyi izlemek için Gönderi Takip Numarası İş Durumu uç noktasıyla ve iş tamamlandıktan sonra işleme sonuçlarını indirmek için Gönderi Takip Numarası İş Ayrıntıları uç noktasıyla kullanabileceğiniz bir iş kimliği döndürür.

Gerekli girdi:

• Eylem
• Gönderi takip numarası detayları

Tek bir istekte en fazla 1.000 adet gönderi takip numarası ilişkilendirebilirsiniz.

Avantajları

Asenkronize uç nokta aşağıdaki avantajları sağlar:

• 1.000 adede kadar takip numarasının toplu olarak gönderilmesini destekler
• Uzun süren isteklerin arka planda işlenmesine olanak tanır
• İş durumunun izlenmesini ve indirilebilir işlem raporlarının oluşturulmasını sağlar
• Büyük iş yükleri için istek zaman aşımı endişelerini ortadan kaldırır

Bu uç noktayı, asenkron bir işin (sırayla bir veya daha fazla ardışık istek) veya gönderilen tüm işlerin durumunu görmek için kullanın.

Bu istek için gerekli olan bilgi girişleri şöyledir:

• jobID– Durum bilgisini almak istediğiniz iş kimliğini belirtin.

Not: İş Kimliği bu uç nokta için isteğe bağlı bir giriştir. İş Kimliğini belirtmezseniz gönderilen tüm işlerin durumuna ilişkin bilgileri alırsınız.

Bu isteğe verilen başarılı yanıt ile iş kimliği, güncel iş durumu, iş oluşturma ve iş tamamlama zaman damgası bilgileri sunulacaktır. Yanıtta, işlerin güncel durumu gösterilecektir. Yanıtta ayrıca, kullanıcıların görüntüleyebilmesi ve gerektiğinde sorunları giderebilmesi için başarı mesajları, hatalar veya uyarılar da yer alacaktır.

• İş durumunun TAMAMLANDI olarak görüntülenmesi, tüm takip numaralarının doğrulandığı ve başarıyla işlendiği anlamına gelir.
  • TAMAMLANDI durumu, takip numaralarının doğrulandığını ve başarıyla işlendiğini ifade eder. Bu, tüm takip numaralarının Gelişmiş Entegre Görünürlük projesine başarıyla eklendiği anlamına gelmez.
  • Birden fazla gönderi takip numarasına sahip işler için, bazı numaralar projeyle ilişkilendirilemese bile diğerleri başarılı olsa da durum TAMAMLANDI olarak sayılabilir. Orijinal ortak talepteki her bir gönderi takip numarasının durumunu teyit etmek için toplu raporun indirilmesi gerekir.

Not: İş durumunun BAŞARISIZ olarak görüntülenmesi, çeşitli nedenlerden/hatalardan dolayı isteğin işlenemediği ve kullanıcının tekrar denemesi gerektiği anlamına gelir.

Aşağıdaki tabloda iş durumları ve bunların açıklamaları gösterilmektedir:

TAMAMLANDI durumunda olan asenkron bir işe ilişkin JSON raporunu indirmek için bu uç noktayı kullanın.

Bu istekle ilişkili gerekli girdi bilgileri aşağıdaki gibidir:

• jobID– Durum bilgisini almak istediğiniz iş kimliğini belirtin. Bu uç nokta için bir iş kimliği zorunludur.

Not:

• Aynı anda yalnızca tek bir asenkronize işin raporunu indirebilirsiniz.
• İş TAMAMLANMADIYSA ve raporu indirmeye çalışıyorsanız bir hata mesajı görüntülenir.

Bu isteğe gelen başarılı yanıt, işe ilişkin raporu size JSON biçiminde sağlar.

Ortak İş Kuralları

• Gelişmiş Entegre Görünürlük projesiyle ilişkilendirebileceğiniz maksimum gönderi takip numarası sayısı için herhangi bir sınırlama yoktur.
• Gelişmiş Entegre Görünürlük projesiyle ilişkili takip numaraları, web kancasıyla başarılı bir şekilde ilişkilendirildikten 40 gün sonra kaldırılır.
• Alıcı adresi, alıcı imzası ve hassas teslimat bilgileri gibi güvenli takip bilgileri, gönderi takip numarası abonelik API'si aracılığıyla erişilebilir değildir.

Senkronize Uç Nokta için İş Kuralları

• İstek başına en fazla 150 gönderi takip numarası.
• Tüm gönderi takip numaraların sahip olduğu subscriptionId aynı olmalıdır.
• Belirtilen Gelişmiş Entegre Görünürlük web kancası aboneliği geçerli ve aktif olmalıdır.
• İstekler 30 saniyelik bir zaman aşımına tabidir.

Asenkronize Uç Nokta için İş Kuralları

• İstek başına en fazla 1.000 gönderi takip numarası.
• Asenkronize bir isteğin iş durumu ve iş detayları, gönderi takip numaraları Gelişmiş Entegre Görünürlük web kancasıyla başarıyla ilişkilendirildikten sonra 90 gün boyunca saklanır.