Um unter Verwendung der Advanced Integrated Visibility Tracking Number Subscription API zu Ihrem Webhook-Abonnement eine Sendungsverfolgungsnummer hinzuzufügen, führen Sie folgende Schritte aus:

1. Erstellen Sie ein Projekt für ein Advanced Integrated Visibility-Abonnement auf Basis der Sendungsverfolgungsnummer. Verwenden Sie dazu die Schritte aus dem vorherigen Abschnitt oder die Schritte im Leitfaden mit den ersten Schritten.
2. Sie benötigen ein OAuth-Token, um Advanced Integrated Visibility Tracking Number Subscription API-Aufrufe zu initiieren. Verwenden Sie die Authorization API, um ein OAUTH-Token zu generieren. In der Dokumentation zur Authorization API im API-Katalog finden Sie ausführliche Anweisungen zum Generieren eines OAUTH-Tokens.
3. Klicken Sie im linken Navigationsmenü auf die Option „Projektdetails“. Scrollen Sie auf der Registerkarte „Produktionsschlüssel“ nach unten zur Dokumentation der Advanced Integrated Visibility Tracking Number Subscription API.

In der Dokumentation der Advanced Integrated Visibility Tracking Number Subscription API finden Sie drei Endpunkte:

Endpunkt „Track Number Association“

• Verwenden Sie diesen Endpunkt, um Sendungsverfolgungsnummern zu einem vorhandenen Webhook-Abonnement hinzuzufügen oder daraus zu entfernen. Weitere Einzelheiten finden Sie in der Dokumentation zur Advanced Integrated Visibility Tracking Number Subscription API.
• Bei allen Hinzufügungen oder Entfernungen von Sendungsverfolgungsnummern handelt es sich um asynchrone Aufträge. Als Antwort auf einen API-Aufruf zum Hinzufügen oder Entfernen der Tracking Number Association API wird eine Auftrags-ID zurückgegeben.

Endpunkt „Track Number Job Details“

Dieser Endpunkt liefert Details zu einer bestimmten Auftrags-ID, z. B. wie viele von allen übermittelten Sendungsverfolgungsnummern erfolgreich zu einem bestimmten Webhook-Abonnement hinzugefügt wurden oder wie viele noch in Bearbeitung sind.

Endpunkt „Track Number Job Status“

Dieser Endpunkt ruft eine aktuelle Zusammenfassung aller in Bearbeitung befindlichen Aufträge ab.

1. Verwenden Sie das in Schritt 2 generierte AUTH-Token mit dem Endpunkt „Track Number Association“, um Ihrem Webhook-Abonnement Sendungsverfolgungsnummern hinzuzufügen.

Validierungsregeln:

• Der Webhook-Name muss eindeutig sein.
• Die Ziel-URL des Webhooks muss im Standardformat vorliegen.
• Alle Pflichtfelder zum Erstellen eines Webhooks müssen ausgefüllt sein.
• Es muss mindestens eine verfügbare Versandkontonummer verknüpft werden, um einen Webhook erstellen zu können.
• Erfolgreiche Validierung:
  • Wurde der Webhook erfolgreich erstellt, erhält der*die Kund*in eine Bestätigungsnachricht.

    Beispiel einer Bestätigungsnachricht: <<Webhook name>> erfolgreich erstellt. Es kann bis zu 10 Minuten dauern, bis Änderungen in Kraft treten.

• Nicht erfolgreiche/Fehlgeschlagene Validierung:
  • Wenn FedEx eine andere Antwort (und nicht «200 (OK)» oder «202» (Akzeptiert)) erhält, ist die Validierung der Ziel-URL des Webhooks fehlgeschlagen.