Open Ship API

Einleitung

Mit dieser API können Sie eine offene Sendung erstellen und zu dieser Sendung auch nachträglich Pakete hinzufügen. So müssen Sie nicht alle Sendungs- und Paketinformationen gleichzeitig eingeben. Der Sendung können fünf Tage lang weitere Pakete hinzugefügt werden. Ebenso lassen sich in diesem Zeitraum andere Änderungen vornehmen. Nach Bestätigung der Sendung können die entsprechenden Dokumente wie Etiketten, AWBs oder Berichte erstellt werden Nach Ablauf der fünf Tage muss die Sendung bestätigt werden, andernfalls wird sie gelöscht.

Hinweis: Offene Sendungen, die nicht spätestens fünf Tage nach ihrer Erstellung bestätigt werden, werden gelöscht.

Informationen zur API für offene Sendungen

Mithilfe der API für offene Sendungen können Sie einer Sendung innerhalb eines bestimmten Zeitraums mehrere Pakete hinzufügen. Dies ist von Vorteil, wenn Sie nicht genau wissen, aus wie vielen Paketen die Sendung bestehen wird oder wann Sie diese fertigstellen. So können Sie Ihre Sendung im Laufe des Tages bis zum Versand flexibel zusammenstellen.

Offene Sendungen bestehen meist aus mehreren Paketen. Es kann sich jedoch auch um Einpaketsendungen handeln.

Wenn Sie Mehrpaketsendungen (MPS) an einen einzigen Empfänger versenden möchten, können Sie mithilfe der API für offene Sendungen einzelne Pakete hinzufügen. Sie können auch mehrere Pakete hinzufügen, sofern diese an denselben Empfänger gesendet werden.

Im Folgenden sind die Services für offene Sendungen aufgeführt:

FedEx Express^® intra-U.S. und intra-Canada
FedEx Ground^® intra-U.S. und intra-Canada
FedEx Home Delivery^®
FedEx International Priority^®
FedEx International Priority^® Express (IPE)
FedEx International Economy^®
FedEx Priority Overnight^™
FedEx® Regional Economy
FedEx® Regional Economy Freight
FedEx International Connect Plus®
FedEx® First
FedEx Priority Express
FedEx Priority
FedEx Priority Express Freight
FedEx Priority Freight
FedEx Economy (nur Vereinigtes Königreich)

Im Folgenden finden Sie die mit der API für offene Sendungen verknüpften Funktionen:

Offene Sendungen verwalten

Mit dieser Funktion können Versender offene Sendungen erstellen, bearbeiten und löschen. Außerdem können sie bereits erstellte Sendungen erneut anzeigen und überprüfen. Fertiggestellte Sendungen können bestätigt, die Sendungsdaten an FedEx übertragen und die erforderlichen Sendungsdokumente erstellt werden. Außerdem werden für die Transaktion eventuelle Fehler ermittelt, entsprechende Fehlerberichte erstellt und der Status angezeigt.

Das Master-Paket der Sendung wird mit den Hauptangaben accountNumber, Shipment Data, groupPackageCount, index festgelegt. Über die Funktion wird sichergestellt, dass die Sendungsdaten in die FedEx Systeme hochgeladen sowie die korrekten Sendungsverfolgungsnummern, Etiketten und Sendungsberichte erstellt werden.

Pakete der offenen Sendung verwalten

Über diese Funktion können Sie für eine bereits erstellte offene Sendung Pakete hinzufügen, bearbeiten und löschen. Es kann auch ein vorhandenes Paket einer vorhandenen offenen Sendung abgerufen werden.

Ergebnisse der offenen Sendung abrufen (asynchron)

Mit dieser Funktion können die Ergebnisse einer bestätigten offenen Sendung asynchron abgerufen werden. Nach Bestätigung einer offenen Sendung mit 40 oder mehr Paketen wird die Sendung von der API asynchron verarbeitet.

Bei der asynchronen Verarbeitung der Sendung wird mit der Antwort lediglich bestätigt, dass die Anfrage erfolgreich in die Warteschlange gestellt wurde. Dies heißt jedoch nicht, dass auch die Sendung selbst erfolgreich verarbeitet wird. In der Antwort wird außerdem die jobId zurückgegeben, mit der das Ergebnis zu einem späteren Zeitpunkt abgerufen werden kann. Diese Funktion ruft mithilfe der jobId die OpenShipment-Ergebnisse (ERSTELLEN, ÄNDERN, BESTÄTIGEN) auf, wobei es sich beispielsweise um Etiketten oder Sendungsberichte handeln kann. Außerdem werden für die Sendung eventuelle Fehler ermittelt, entsprechende Berichte erstellt und der Status angezeigt.

Hinweis: Wenn die Antwort auf die Anfrage zur asynchronen Sendungsverarbeitung Fehler enthält, beheben Sie diese und senden Sie eine neue Sendungsanfrage.

Workflow der API für offene Sendungen

In diesem Abschnitt wird der Workflow der API für offene Sendungen ausführlich beschrieben. Der Workflow lässt sich auf zwei Arten bzw. über zwei Verarbeitungsoptionen verwalten:

Workflow für maximal 40 Pakete

Mit dem Endpunkt Offene Sendung erstellen können Sie eine offene Sendung mit allen erforderlichen Sendungs- und Verpackungsinformationen, accountNumber und index erstellen.
Mit dem Endpunkt Pakete zur offenen Sendung hinzufügen können Sie der bereits erstellten offenen Sendung zwischen einem und 40 Pakete hinzufügen. Die wichtigsten Eingaben sind index und accountNumber der offenen Sendung, der die Pakete hinzugefügt werden sollen.
Mit dem Endpunkt Offene Sendung bestätigen bestätigen Sie abschließend, dass alle Pakete zur Sendung hinzugefügt wurden und die Sendung vollständig ist. Die wichtigsten Eingaben sind index und accountNumber der zu bestätigenden Sendung.

Der Endpunkt Offene Sendung bestätigen ist der letzte Endpunkt in diesem Workflow. Sendung und Paketinformationen werden überprüft und es werden die Etiketten und sämtliche Berichte für die Sendung erstellt. Außerdem werden Informationen zu den während der Prüfung zurückgegebenen Fehlern bereitgestellt. Diese Fehler können mithilfe des Endpunkts Offene Sendung bearbeiten oder Pakete der offenen Sendung bearbeiten behoben werden. Anschließend wird die Sendung erneut für eine Anfrage bestätigt.

Workflow für mehr als 40 Pakete

Mit dem Endpunkt Offene Sendung erstellen können Sie eine offene Sendung mit allen erforderlichen Sendungs- und Verpackungsinformationen, accountNumber und index erstellen.
Mit dem Endpunkt Pakete zur offenen Sendung hinzufügen können Sie der bereits erstellten offenen Sendung zwischen einem und 40 Pakete hinzufügen. Die wichtigsten Eingaben sind index und accountNumber der offenen Sendung, der die Pakete hinzugefügt werden sollen.
Mit dem Endpunkt Offene Sendung bestätigen bestätigen Sie, dass alle Pakete hinzugefügt wurden und die Sendung vollständig ist. Die wichtigsten Eingaben sind index und accountNumber der zu bestätigenden Sendung. Da in diesem Fall die Sendung aus über 40 Paketen besteht, verarbeitet die API die Sendung asynchron und gibt jobId zurück, damit zu einem späteren Zeitpunkt die Sendungsergebnisse abgerufen werden können. Wenn die Antwort Fehler beinhaltet, müssen diese über den Endpunkt Offene Sendung bearbeiten oder Pakete der offenen Sendung bearbeiten behoben und die Sendung mit dem Endpunkt Offene Sendung bestätigen bestätigt werden.
Mit dem Menüpunkt „Ergebnisse der offenen Sendung“ können Sie die Ergebnisse der Erstellung, Änderung oder Bestätigung offener Sendungen wie beispielsweise Etiketten und Sendungsdokumente abrufen.Die wichtigsten Eingaben sind jobId und accountNumber der bestätigten Sendung.

Ergebnisse der offenen Sendung abrufen ist der abschließende Endpunkt in diesem Workflow. Mit ihm werden die Ergebnisse der bestätigten offenen Sendung wie Etiketten und alle weiteren Berichte abgerufen. Wenn in der Antwort Fehler zurückgegeben werden, können diese mithilfe des Endpunkts Offene Sendung bearbeiten oder Pakete der offenen Sendung bearbeiten behoben werden. Anschließend können Sie die Sendung über den Endpunkt Offene Sendung bestätigen bestätigen und schließlich mit dem Endpunkt Ergebnisse der offenen Sendung abrufen die Ergebnisse der bestätigten offenen Sendung für die erfolgreiche Anfrage abrufen.

So funktioniert die API für offene Sendungen

Im Folgenden sind die Funktionen der API für offene Sendungen aufgeführt:

Offene Sendung erstellen

Mit diesem Endpunkt erstellen Sie eine offene Sendung mit den erforderlichen Sendungsinformationen und mindestens einem Paket.

Im Folgenden sind die erforderlichen Eingaben für die Erstellung einer offenen Sendung aufgeführt:

openShipmentAction – dies ist die Aktion für offene Sendungen. Verwenden Sie in diesem Fall den Wert CREATE_PACKAGE.
accountNumber – die FedEx Kundennummer.
requestedShipment – die Sendungsangaben für die offene Sendung.
index – dieser eindeutige Wert für die offene Sendung unterstützt die Bearbeitung der Sendung bzw. des Pakets. Diese Eingabe ist optional. Wird kein Wert angegeben, kann die Sendung anhand der Master-Sendungsverfolgungsnummer eindeutig identifiziert werden.

Ist die Anfrage erfolgreich, wird die Sendung verarbeitet und die Sendungsverfolgungsnummmer erstellt. Für das erste Paket ist dies die Master-Sendungsverfolgungsnummer. In der Antwort werden keine Etiketten erstellt.

Pakete zur offenen Sendung hinzufügen

Mit diesem Endpunkt können Sie der Anfrage für eine vorhandene offene Sendung vor deren Bestätigung ein oder mehrere Pakete hinzufügen. Während Sie im Laufe des Tages Ihre Sendung vorbereiten, können Sie für jedes Ihrer Pakete eine separate „Paket hinzufügen“-Anfrage senden. Mit einer „Paket hinzufügen“-Anfrage können Sie auch mehrere Pakete hinzufügen.

Hinweis: Die Gesamtzahl der Pakete der Sendung darf den für die offene Sendung festgelegten Maximalwert nicht überschreiten.

Im Folgenden sind die erforderlichen Eingaben für das Hinzufügen von Paketen zur offenen Sendung aufgeführt:

index – es handelt sich um einen eindeutigen Wert, der der bereits erstellten offenen Sendung zugewiesen ist. Wenn dieser Wert nicht verfügbar ist, geben Sie die Master-Sendungsverfolgungsnummer an.
requestedPackageLineItem – ausführliche Informationen zu den Paketen, die hinzugefügt werden sollen.
accountNumber – die FedEx Kundennummer.

Ist die Anfrage erfolgreich, wird für das neu hinzugefügte Paket eine Sendungsverfolgungsnummer erstellt.

Pakete der offenen Sendung bearbeiten

Mit diesem Endpunkt können Sie ein oder mehrere Pakete einer vorhandenen offenen Sendung vor deren Bestätigung bearbeiten. Dies gilt auch für das Master-Paket. Hierbei handelt es sich um das erste der offenen Sendung hinzugefügte Paket.

Nachfolgend finden Sie die wichtigsten Eingabeinformationen, die dieser Anfrage zugeordnet sind:

index – es handelt sich um einen eindeutigen Wert, der der bereits erstellten offenen Sendung zugewiesen ist. Wenn dieser Wert nicht verfügbar ist, geben Sie die Master-Sendungsverfolgungsnummer an.
accountNumber – die FedEx Kundennummer.
trackingId – eine oder mehrere Sendungsverfolgungsnummern der zu bearbeitenden Pakete der offenen Sendung.
requestedPackageLineItem – ausführliche Informationen zu den Paketen, die bearbeitet werden sollen.

Bei erfolgreicher Anfrage werden die entsprechenden Pakete aktualisiert und die aktualisierten Sendungsinformationen zurückgegeben.

Pakete der offenen Sendung löschen

Mit diesem Endpunkt können Sie ein oder mehrere Pakete einer vorhandenen offenen Sendung vor deren Bestätigung löschen.

Nachfolgend finden Sie die wichtigsten Eingabeinformationen, die dieser Anfrage zugeordnet sind:

index – es handelt sich um einen eindeutigen Wert, der der bereits erstellten offenen Sendung zugewiesen ist. Wenn dieser Wert nicht verfügbar ist, geben Sie die Master-Sendungsverfolgungsnummer an.
accountNumber – die FedEx Kundennummer.
trackingId – eine oder mehrere Sendungsverfolgungsnummern der zu löschenden Pakete der offenen Sendung.

Bei erfolgreicher Anfrage werden die entsprechenden Pakete gelöscht. Für das Element deletedPackagesFromOpenshipment wird true zurückgegeben.

Hinweis: Wird das Master-Paket der Sendung gelöscht, werden dem nächsten Paket in der Reihenfolge dieser Status und die Master-Sendungsverfolgungsnummer zugewiesen. Die Nummerierungsfolge wird um die Zahl der gelöschten Pakete verringert.

Pakete der offenen Sendung abrufen

Mit diesem Endpunkt können Sie ein oder mehrere Pakete aus der vorhandenen offenen Sendung zur Prüfung abrufen.

Nachfolgend finden Sie die wichtigsten Eingabeinformationen, die dieser Anfrage zugeordnet sind:

index – es handelt sich um einen eindeutigen Wert, der der bereits erstellten offenen Sendung zugewiesen ist. Wenn dieser Wert nicht verfügbar ist, geben Sie die Master-Sendungsverfolgungsnummer an.
accountNumber – die FedEx Kundennummer.
trackingId – die Sendungsverfolgungsnummer für ein oder mehrere Pakete einer offenen Sendung, deren Informationen abgerufen werden sollen.

Bei erfolgreicher Anfrage werden die gewünschten Pakete abgerufen.

Offene Sendung bearbeiten

Mit diesem Endpunkt können Sie vor der Bestätigung die erforderlichen Sendungsinformationen einer Anfrage für eine offene Sendung bearbeiten.

Nachfolgend finden Sie die wichtigsten Eingabeinformationen, die dieser Anfrage zugeordnet sind:

index – es handelt sich um einen eindeutigen Wert, der der bereits erstellten offenen Sendung zugewiesen ist. Wenn dieser Wert nicht verfügbar ist, geben Sie die Master-Sendungsverfolgungsnummer an.
accountNumber – die FedEx Kundennummer.
requestedShipment – die Sendungsinformationen der zu bearbeitenden offenen Sendung.

Bei erfolgreicher Anfrage werden die Sendungsinformationen der bereits erstellten offenen Sendung aktualisiert. Es werden die Sendungsverfolgungsnummer für die bearbeiteten Pakete sowie die aktualisierten Transaktionsinformationen für die Sendung ausgegeben.

Offene Sendung abrufen

Mit diesem Endpunkt können Sie die bereits erstellte offene Sendung zur Prüfung abrufen.

Nachfolgend finden Sie die wichtigsten Eingabeinformationen, die dieser Anfrage zugeordnet sind:

index – es handelt sich um einen eindeutigen Wert, der der bereits erstellten offenen Sendung zugewiesen ist. Wenn dieser Wert nicht verfügbar ist, geben Sie die Master-Sendungsverfolgungsnummer an.
accountNumber – die FedEx Kundennummer.

Bei erfolgreicher Anfrage werden die gewünschten Informationen der offenen Sendung abgerufen.

Offene Sendung löschen

Mit diesem Endpunkt können Sie die Anfrage für eine offene Sendung vor deren Bestätigung löschen.

Nachfolgend finden Sie die wichtigsten Eingabeinformationen, die dieser Anfrage zugeordnet sind:

index – es handelt sich um einen eindeutigen Wert, der der bereits erstellten offenen Sendung zugewiesen ist. Wenn dieser Wert nicht verfügbar ist, geben Sie die Master-Sendungsverfolgungsnummer an.
accountNumber – die FedEx Kundennummer.

Bei erfolgreicher Anfrage werden die offene Sendung und alle zugehörigen Pakete gelöscht. Für das Element deletedOpenshipment wird true zurückgegeben.

Offene Sendung bestätigen

Wenn der Sendungsanfrage alle Pakete hinzugefügt wurden, können Sie mit diesem Endpunkt die Informationen der offenen Sendung prüfen und in die FedEx Systeme hochladen.

Nachfolgend finden Sie die wichtigsten Eingabeinformationen, die dieser Anfrage zugeordnet sind:

index – es handelt sich um einen eindeutigen Wert, der der bereits erstellten offenen Sendung zugewiesen ist. Wenn dieser Wert nicht verfügbar ist, geben Sie die Master-Sendungsverfolgungsnummer an.
accountNumber – die FedEx Kundennummer.
labelResponseOptions – Geben Sie an, ob in der Antwort der Bytecode oder die Etiketten-URL zurückgegeben werden soll.
Hinweis: Das Element labelResponseOptions steht nur in der Anfrage Offene Sendung bestätigen zur Verfügung und nach der Bestätigung der Sendung werden Etiketten generiert.

Bei erfolgreicher Anfrage für bis zu 40 Pakete werden die Sendungsdaten in die FedEx Systeme hochgeladen sowie die Paketetiketten und alle weiteren Sendungsberichte erstellt.

Bei erfolgreicher Anfrage für über 40 Pakete erhalten Sie eine Bestätigung, dass die Anfrage in die Warteschlange verschoben wurde. Mit der zurückgegebenen jobId können Sie die Ergebnisse zu einem späteren Zeitpunkt abrufen.

Hinweis: Um eine offene Sendung bestätigen zu können, müssen Sie dieser mindestens ein Paket zuweisen.

Ergebnisse der offenen Sendung abrufen

Mit diesem Endpunkt können Sie die Sendungsdaten bestätigter offener Sendungen abrufen. Verwenden Sie diesen Endpunkt nur, wenn die Sendung mehr als 40 Pakete beinhaltet und in der Bestätigung für die offene Sendung jobId zurückgegeben wird.

Nachfolgend finden Sie die wichtigsten Eingabeinformationen, die dieser Anfrage zugeordnet sind:

resultMethodType – legen Sie für den Wert CREATE fest.
accountNumber – die FedEx Kundennummer.
jobId – die mit der Bestätigung der offenen Sendung erhaltene jobId.

Bei erfolgreicher Anfrage werden die Ergebnisse der bestätigten offenen Sendung wie Paketetiketten und sämtliche weiteren Sendungsberichte zurückgegeben. Wenn in der Antwort Fehler zurückgegeben werden, können diese mithilfe des Endpunkts Offene Sendung bearbeiten oder Pakete der offenen Sendung bearbeiten behoben werden. Anschließend können Sie die Sendung über den Endpunkt Offene Sendung bestätigen bestätigen und schließlich mit dem Endpunkt Ergebnisse der offenen Sendung abrufen die Ergebnisse der bestätigten offenen Sendung für die erfolgreiche Anfrage abrufen.

Offene Mehrpaketsendungen (MPS)

Eine offene Mehrpaketsendung (MPS) besteht aus zwei oder mehr Paketen, die an dieselbe Empfängeradresse versendet werden. Das erste Paket im Sendungsauftrag ist das Master-Paket.

So erstellen Sie eine Mehrpaketsendung:

Geben Sie Sendungsinformationen wie serviceType, packagingType, totalWeight, totalPackageCount und requestedPackageLineItems für das Master-Paket an.
Hinweis: Die sequenceNumber für das Master-Paket muss 1 sein..
Fügen Sie alle Pakete zur Sendung hinzu.
Bestätigen Sie die Sendung.

Nach Bestätigung der Sendung wird eine der folgenden Verarbeitungsoptionen verwendet:

Synchrone Sendungsverarbeitung

Die synchrone Verarbeitung ist eine optimale Methode, die intern für Sendungen mit bis zu 40 Paketen (Gesamtpaketanzahl/grouppackagecount<=40) und begrenzten Waren verwendet wird.

Sendungsanfragen mit maximal 40 Paketen werden nach Bestätigung synchron verarbeitet und die Etiketten sowie andere Versanddokumente/Berichte werden unmittelbar erstellt. Dieser Prozess ist optimal für Versender mit eingeschränktem Zeitrahmen und wenn Etiketten unmittelbar nach der Bestätigung gedruckt werden müssen.

Hinweis: Der Maximalwert von 40 Paketen ist ein Richtwert und keine feste Grenze. Der Maximalwert hängt auch von der Kombination von Paketen und Waren in der Sendung ab. Weitere Informationen erhalten Sie vom FedEx Kundendienst.

Beispiel: Ihre Anfrage für offene Sendungen umfasst 10 Pakete. Nachdem alle 10 Pakete der Sendung hinzugefügt wurden und die Sendung bestätigt wurde, wird diese synchron verarbeitet. Es werden 10 Etiketten erstellt und entweder wie angefordert Etiketten-URLs oder Etiketten als Dateien zurückgegeben.

Der folgende allgemeine Workflow veranschaulicht die synchrone Verarbeitung offener Sendungen:

Verwenden Sie den Endpunkt Offene Sendung erstellen.
Fügen Sie über den Endpunkt Pakete zur offenen Sendung hinzufügen bis zu 40 Pakete hinzu.
Bestätigen Sie die offene Sendung über den Endpunkt Offene Sendung bestätigen.
Ist die Anfrage erfolgreich, werden Etiketten generiert und je nach Anforderung entweder Etiketten-URLs oder Etiketten als Dateien zurückgegeben.
Wenn die Sendung Fehler aufweist, werden die Fehlerdetails zurückgegeben.
Verwenden Sie nach Korrektur sämtlicher Fehler den Endpunkt Offene Sendung bestätigen und übermitteln Sie sie erneut.

Hinweis:

Bei dieser Methode können maximal 40 Pakete zu einer vorhandenen Sendung hinzugefügt werden.

Asynchrone Sendungsverarbeitung

Die API verarbeitet Sendungen mit mehr als 40 Paketen (totalPackageCount>40) intern asynchron. Diese Methode ist besonders praktisch, wenn das Paketaufkommen hoch ist und Massensendungen regelmäßig in Auftrag gegeben werden sollen. Massensendungen, die auf einmal eingereicht werden, nehmen mehrere kostenintensive FedEx Ressourcen und Betriebskapazitäten in Anspruch. Mit dieser Verarbeitungsoption stellt FedEx intern sicher, dass diese Massensendungen problemlos verarbeitet werden und Sie außerdem regelmäßig Etikettendaten erhalten.

Hinweis: Dieser Prozess kann einige Zeit in Anspruch nehmen. Sie können das Ergebnis abrufen, sobald die Sendung erfolgreich verarbeitet wurde.

Um die Ergebnisse der asynchronen Sendungsverarbeitung abzurufen, verwenden Sie den Endpunkt Ergebnisse der offenen Sendung abrufen und geben in der Anfrage jobId und accountNumber an. Die Antwort auf diese Anfrage gibt entweder Sendungsergebnisdaten mit Etikettendetails oder die Fehlerdetails zur Sendung zurück.

Beispiel: Ihre Sendung umfasst 45 Pakete, die nach der Bestätigung asynchron verarbeitet werden. In der Antwort wird eine jobId zurückgegeben. Verwenden Sie nun den Endpunkt Ergebnisse der offenen Sendung abrufen, um die Ergebnisse und Etiketten für die Sendung abzurufen.

Der folgende allgemeine Workflow veranschaulicht die asynchrone Sendungsverarbeitung:

Verwenden Sie den Endpunkt Offene Sendung erstellen.
Fügen Sie mithilfe des Endpunkts Pakete zur offenen Sendung hinzufügen 40 oder mehr Pakete hinzu.
Bestätigen Sie die Sendung mit dem Endpunkt Offene Sendung bestätigen.
Bei erfolgreicher Übermittlung wird die jobId zurückgegeben.
Rufen Sie mithilfe der jobId und der accountNumber über den Endpunkt Ergebnisse der offenen Sendung abrufen die Ausgabeergebnisse ab.
In diese Ausgabe werden Ihnen die Ergebnisdaten und Etiketten bereitgestellt.
Wenn das Ergebnis Fehler enthält, werden die Fehlerdetails zurückgegeben.

Hinweis:

Bei dieser Methode darf eine einzelne Anfrage maximal 300 Pakete oder bis zu 999 Waren enthalten.
Bei dieser Methode können nach dem Absenden der Anfrage keine neuen Pakete zur ursprünglichen Anfrage hinzugefügt bzw. keine Pakete in dieser geändert oder aus dieser gelöscht werden. Wenn in der Antwort Fehler zurückgegeben werden, können diese mithilfe des Endpunkts Pakete der offenen Sendung bearbeiten behoben werden. Bestätigen Sie anschließend die Sendung über Offene Sendung bestätigen und rufen Sie mit dem Endpunkt Ergebnisse der offenen Sendung abrufen die Ausgabeergebnisse ab.

FedEx Versandetiketten

Die FedEx API unterstützt eine breite Auswahl an Etiketten. Die FedEx API unterstützt drei Arten von Etiketten: Thermo-, Normalpapier- und anpassbare Etiketten. Mithilfe der Endpunkte der API für offene Sendungen können Sie eine Vielzahl von Etiketten erstellen.

FedEx bietet 2 Etikettenformate für den Versand:

Thermo-Etiketten
Laser-Etiketten

Thermo-Etiketten

Mit der FedEx API können Sie Versandetiketten für alle Versandarten wie FedEx Express^®, FedEx Ground^® und FedEx International Ground^® mit verschiedenen Thermo-Etikettendruckern ausdrucken.

Die FedEx API unterstützt folgende Formate von Thermo-Etiketten:

15 cm (6") x 10 cm (4") – ohne konfigurierbares Doc-Tab
10 cm (4") x 17, cm (6,75") – mit oder ohne Doc-Tab
10 cm (4") x 20 cm (8") – bietet Platz zum Einfügen einer Grafik- oder Textdatei Ihrer Wahl
10,16 cm x 21,59 cm – mit einem konfigurierbaren Doc-Tab (speziell für die Kennzeichnung auf dem Etikett von Reifen)
10 cm (4") x 23 (9") – bietet Platz für Grafiken oder Text sowie ein Doc-Tab
10,16 cm x 26,67 cm – mit einem konfigurierbaren Doc-Tab (speziell für die Kennzeichnung auf dem Etikett von Reifen)

Die Etikettenmaterial-Typen 10,16 cm x 21,59 cm und 10,16 cm x 26,67 cm enthalten ein hinzugefügtes Doc-Tab mit identischen Barcodes. Ein Barcode wird auf dem Hauptetikett und der andere auf dem Doc-Tab angezeigt. Dieser Wert des Etikettenmaterial-Typs ist hilfreich bei Paketen mit Reifen. Ein Etikett kann auf dem Reifenprofil angebracht werden. Das zusätzliche Doc-Tab mit einer Kopie des Barcodes und optionalen Anweisungen ist für die Reifenflanke gedacht. Dank dieser Etikettenmaterial-Typen kann die Anzahl der Neuetikettierungen reduziert werden. Durch die Abmessungskontrolle wird die Wiederverwertung verbessert. Weitere Informationen zum Etikettenmaterial finden Sie unter Etikettenmaterial-Typen.

Hinweis: Bei einem Doc-Tab handelt es sich um eine abziehbare Klebelasche mit zusätzlichen Versandinformationen, die beim Drucken von Versandetiketten mit einem Thermodrucker für ein Etikettenmaterial ausgewählt werden kann.

Elemente von Thermo-Etiketten

Thermo-Versandetiketten enthalten drei grundlegende Elemente:

Inhalt in Klarschrift: Dieser Teil des Etiketts enthält die Versandinformationen.
Ground Klarschrift-Barcode wird standardmäßig verschlüsselt.
Zweidimensionaler (2D) Barcode: Mit dem zweidimensionalen alphanumerischen Barcode werden sowohl bei FedEx Express als auch bei FedEx Ground Sendungen Daten unter Verwendung von ANSI (Standards American National Standards Institute) MH10.8.3 gespeichert. Der 2D-Barcode wird unter Verwendung der Symbologie Portable Data File (PDF) 417 erstellt.
FedEx spezifischer Barcode:
- ASTRA (Advanced Sorting Tracking Routing Assistance) für FedEx Express Sendungen bis zur vollständigen Einführung des FDX 1D Barcodes; Barcode „96“ für FedEx Ground und FedEx Home Delivery Sendungen. Bei FedEx Ground ist auch der SSCC-18 „00“ Barcode zulässig.
- Der FedEx 1D (FDX1D) Barcode für FedEx Express Sendungen wird unter Verwendung von ANSI/AIM BC4-1995 (Uniform Symbology Specification CODE-128C) erstellt.

Wichtige Informationen zum Erstellen von Thermo-Etiketten

Im Folgenden sind die wichtigsten Informationen aufgeführt, die zum Erstellen von Thermo-Etiketten erforderlich sind:

LabelFormatType: erforderlich, um das richtige Etikettenbild in der Antwort-API für offene Sendungen zu erhalten:
- COMMON2D: der Etikettenformat-Typ zum Abrufen des Etiketts.
- LABEL_DATA_ONLY: Der Wert zum Abrufen der Barcode-Daten beim Erstellen eines benutzerdefinierten Etiketts.

Gültige Werte:

BildTyp: erforderlich, um das Thermo-Etikett für den von Ihnen verwendeten Drucker zu formatieren; gibt den Typ des zurückzugebenden Datenstroms oder Bitmaps an.
- EPL2 – Eltron (Etikettenmaterial-Arten)
- ZPLII – Zebra (Etikettenmaterial-Arten)

Gültige Werte:

Hinweis: Alle für eine Sendung erforderlichen Etiketten werden in einem einzigen Puffer generiert und zurückgegeben.

Unterstützte Thermodrucker

Die folgenden Thermodrucker werden für die FedEx API empfohlen:

Unimark
Eltron
- Orion (EPL2)
- Eclipse (EPL2)
Zebra
- LP2443 (EPL2)
- LP2844 (EPL2)
- Gk420 (ZPL)
- LP2348 Plus (EPL2/ZPL)
- Z4M Plus (ZPL or EPL)
- ZP500/ZP505 (EPL2/ZPL)
- Z4M/Z4M+ (EPL2/ZPL)
- ZM400 (EPL2/ZPL)
- ZT410 (EPL2/ZPL)
- Andere Drucker der ZT4xx Serie (EPL2/ZPL)

Hinweis: All diese Drucker sind mit dem Seitenmodus ASCII Eltron Programming Language (EPL2) kompatibel. Thermodrucker können sowohl zum direkten Druck über eine serielle Schnittstelle als auch als nativ unter Windows installierte Drucker für LPT-, serielle oder USB-Anschlüsse verwendet werden. Die Firmware-Versionen der von FedEx bereitgestellten Drucker können sich je nach Region unterscheiden.

Anzahl der pro Service gedruckten Thermo-Etiketten

In der folgenden Tabelle ist die Anzahl der einzelnen Etiketten-Arten angegeben, die für einen bestimmten Sonderservice benötigt werden. Alle erforderlichen Etiketten werden durch einen Befehl an den FedEx Common Label Server (CLS) generiert. Der CLS gibt einen einzigen Puffer zurück (ausgenommen Nachnahme-Rücksendeetiketten).

Anzahl der pro US-Service gedruckten Thermo-Etiketten

Serviceart	Thermo-Etiketten (FedEx CLS gibt die entsprechende Anzahl von Etiketten in der Antwort zurück.)
FedEx Express U.S.	1 Versandetikett
FedEx Ground U.S./FedEx Home Delivery	1 Versandetikett

Anzahl der pro U.S. Export International Service gedruckten Thermo-Etiketten

Serviceart	Thermo-Etiketten (FedEx CLS gibt die entsprechende Anzahl von Etiketten in der Antwort zurück.)
FedEx Express U.S. Export International	1 Versandetikett 2 Versandetiketten
FedEx Express U.S. Export International Broker Select Option	1 Versandetikett 2 Versandetiketten
FedEx Ground U.S. Export International	1 Versandetikett
FedEx Ground U.S. Export International C.O.D.	1 Versandetikett 2 Nachnahme-Rücksendeetiketten

Anzahl der pro Service innerhalb Kanadas gedruckten Thermo-Etiketten

Serviceart	Thermo-Etiketten (FedEx CLS gibt die entsprechende Anzahl von Etiketten in der Antwort zurück.)
FedEx Express intra-Canada	Kein Gefahrgut/Sendung mit Trockeneis: 1 Versandetikett
FedEx Ground intra-Canada	1 Versandetikett
FedEx Ground intra-Canada C.O.D.	1 Versandetikett 2 Nachnahme-Rücksendeetiketten

Anzahl der pro Canada Export International Service gedruckten Thermo-Etiketten

Serviceart	Thermo-Etiketten (FedEx CLS gibt die entsprechende Anzahl von Etiketten in der Antwort zurück.)
FedEx Express Canada Export International	Non-DG/Dry ice shipment: 1 Versandetikett 2 Versandetiketten
FedEx Express Canada Export International Broker Select	Non-DG/Dry ice shipment: 1 Versandetikett 2 Versandetiketten
FedEx Ground Canada (CA) Export International	1 Versandetikett

Anzahl der pro in den Philippinen und in Thailand eingehenden Sendungen gedruckten Thermo-Etiketten

Serviceart	Thermo-Etiketten (FedEx CLS gibt die entsprechende Anzahl von Etiketten in der Antwort zurück.)
Eingehende Sendungen (Philippinen)	Gedruckt werden 2 Versandetiketten mit Kontonummer Gedruckt wird 1 Belegetikett ohne Kontonummer 3 Exemplare der Handelsrechnung
Eingehende Warensendungen (Thailand)	Gedruckt werden 3 Versandetiketten mit Kontonummer Gedruckt wird 1 Belegetikett ohne Kontonummer
Eingehende Dokumentensendungen (Thailand)	Gedruckt werden 2 Versandetiketten mit Kontonummer Gedruckt wird 1 Belegetikett ohne Kontonummer

Doc-Tab

Wenn Sie Versandetiketten mit einem Thermodrucker drucken, können Sie Etikettenmaterial mit Doc-Tab verwenden. Hierbei handelt es sich um eine abziehbare Klebelasche mit zusätzlichen Versandinformationen. Sie können diese Versandinformationen anhand ihrer Versanddaten konfigurieren oder konfigurierbare Daten drucken, die den jeweiligen Versandanforderungen entsprechen.

Laser-Etiketten

Die FedEx API unterstützt den Druck von Etiketten mit einem Laserdrucker. Diese Etiketten werden in der Regel auf U.S. Letter- oder A4-Papier gedruckt und in der Hälfte gefaltet, damit sie in die FedEx Standard-Dokumententasche passen. Etiketten für den Druck mit einem Laserdrucker werden im PDF-Format generiert und müssen nicht skaliert oder in der Größe verändert werden. Weitere Informationen zum Etikettenmaterial finden Sie unter Etikettenmaterial-Typen.

Grundvoraussetzungen

Für PDF-Etiketten gelten folgende Anforderungen:

Adobe Reader 6.0 oder höher ist erforderlich, um das Etikett zu verarbeiten.
In der Druckertreiber-Konfiguration muss die Druckerskalierung auf „Keine“ eingestellt sein.
Für die Anzeige eines Normalpapier-PDF-Etiketts in einem Browser ist kein HTML-Wrapper erforderlich.
Acrobat empfiehlt die folgenden Browser für die Anzeige von PDF-Dokumenten:
- Microsoft Internet Explorer 10 oder höher
- Firefox 1.0 oder höher
- Mozilla 1.7 oder höher

Bei der Option für PDF-Etiketten müssen keine Parameter für die Bildausrichtung (Breite und Höhe) oder die Bildschirmauflösung angegeben werden, damit das Etikett im Browser korrekt angezeigt wird.

Elemente von Laser-Etiketten

Laser-Versandetiketten enthalten drei grundlegende Elemente:

Inhalt in Klarschrift – dieser Teil des Etiketts enthält die Versandinformationen.
Ground Klarschrift-Barcode wird standardmäßig verschlüsselt.
Zweidimensionaler (2D) Barcode: Mit dem zweidimensionalen alphanumerischen Barcode werden sowohl bei FedEx Express als auch bei FedEx Ground Sendungen Daten unter Verwendung von ANSI (Standards American National Standards Institute) MH10.8.3 gespeichert. Der 2D-Barcode wird unter Verwendung des Formats Portable Data File (PDF) 417 erstellt.
FedEx spezifischer Barcode:
- ASTRA (Advanced Sorting Tracking Routing Assistance) für FedEx Express Sendungen bis zur vollständigen Einführung des FDX 1D Barcodes; Barcode „96“ für FedEx Ground und FedEx Home Delivery Sendungen. Bei FedEx Ground ist ggf. auch der SSCC-18 „00“ Barcode zulässig.
- Der FedEx 1D (FDX1D) Barcode für FedEx Express Sendungen wird unter Verwendung von ANSI/AIM BC4-1995 (Uniform Symbology Specification CODE-128C) erstellt.

Wichtige Informationen zum Erstellen von Laser-Etiketten

Die folgenden FedEx API-Elemente sind erforderlich, um ein Laser-Etikett zu generieren:

LabelSpecification/LabelFormatType: erforderlich, um das richtige Etikettenbild in der Antwort-API für offene Sendungen zu erhalten. Gültige Werte sind:
- COMMON2D – Etikettenformat-Typ zum Abrufen des Etiketts.
- LABEL_DATA_ONLY – Wert zum Abrufen der Barcode-Daten beim Erstellen eines benutzerdefinierten Etiketts.

LabelSpecification/ImageType: erforderlich zur Angabe des Etikettenformats. Typ des zurückzugebenden Datenstroms oder Bitmaps:
Gültige Werte sind:
- PDF – Normalpapier
- PNG – Normalpapier

LabelSpecification/LabelStockType: erforderlich für alle Etikettentypen. Geben Sie an, ob sich beim Etikettenmaterial das Doc-Tab ggf. am vorderen oder hinteren Ende der Etiketten befindet bzw. ob kein Doc-Tab vorhanden ist. Wenn der ImageType PDF oder PNG verwendet wird, geben diese Werte ein Etikett im Laserformat an:
- PAPER_4X6
- PAPER_4X8
- PAPER_4X9
- PAPER_4X675
  Diese Werte geben ein Versandetikett im Normalpapierformat an:
- PAPER_7X47
- PAPER_85X11_BOTTOM_HALF_LABEL
- PAPER_85X11_TOP_HALF_LABEL
- PAPER_LETTER

Hinweis: Wenn Sie ein Normalpapieretikett anfordern, handelt es sich bei den zurückgegebenen Daten um ein Base64-kodiertes Etikettenbild, das vor der Anzeige der Etikettendatei entsprechend dekodiert werden muss.

Unterstützte Laserdrucker

Die meisten Laserdrucker werden für diesen Etikettentyp unterstützt. Etiketten werden jedoch nicht akzeptiert, wenn sie auf einem Tintenstrahldrucker gedruckt werden.
Hinweis: Wenn Sie einen Farblaserdrucker verwenden, muss die Farbdefinition auf Schwarz gesetzt werden, selbst wenn sich nur eine schwarze Patrone im Drucker befindet.

Anzahl der pro Service erforderlichen Laser-Etiketten

Anzahl der pro US-Service gedruckten Laser-Etiketten

Serviceart	Laser-Etikett – PDF-Format
FedEx Ground/FedEx Home Delivery U.S.	1 Versandetikett

Anzahl der pro U.S. Export International Service gedruckten Laser-Etiketten

Serviceart	Laser-Etikett – PDF-Format
FedEx Express U.S. Export International	1 Versandetikett in der Antwort. Es müssen mindestens 3 Etiketten gedruckt werden: 1 Etikett für das Paket und 2 für die Dokumententasche.
FedEx Express U.S. Export International Broker Select	1 Versandetikett in der Antwort. Es müssen mindestens 3 Etiketten gedruckt werden: 1 Etikett für das Paket und 2 für die Dokumententasche.
FedEx Ground U.S. Export International	1 Versandetikett
FedEx Ground U.S. Export International C.O.D.	1 Versandetikett 2 Nachnahme-Rücksendeetiketten

Anzahl der pro Service innerhalb Mexikos gedruckten Laser-Etiketten

Serviceart

Laser-Etikett – PDF-Format

FedEx Express Intra-Mexico

Kein Gefahrgut/Sendung mit Trockeneis:

1 Versandetikett

Anzahl der pro Service innerhalb Kanadas gedruckten Laser-Etiketten

Serviceart	Laser-Etikett – PDF-Format
FedEx Express Intra-Canada	FedEx Express Intra-Canada Kein Gefahrgut/Sendung mit Trockeneis: 1 Versandetikett
FedEx Ground Intra-Canada	1 Versandetikett
FedEx Ground Intra-Canada C.O.D.	1 Versandetikett 2 Nachnahme-Rücksendeetiketten

Anzahl der pro Canada Export International Service gedruckten Laser-Etiketten

Serviceart	Laser-Etikett – PDF-Format
FedEx Express Canada Export International	FedEx Express Canada Export International Non-DG/Dry ice shipment: 1 Versandetikett 2 Versandetiketten
FedEx Express Canada Export International Broker Select	FedEx Express Canada Export International Broker Select Non-DG/Dry ice shipment: 1 Versandetikett 2 Versandetiketten
FedEx Ground Canada (CA) Export International	1 Versandetikett

Anzahl der pro Canada Export International Service gedruckten Laser-Etiketten

Serviceart	Laser-Etikett – PDF-Format
FedEx Express Canada Export International	FedEx Express Canada Export International Non-DG/Dry ice shipment: 1 Versandetikett 2 Versandetiketten
FedEx Express Canada Export International Broker Select	FedEx Express Canada Export International Broker Select Non-DG/Dry ice shipment: 1 Versandetikett 2 Versandetiketten
FedEx Ground Canada (CA) Export International	1 Versandetikett

Anzahl der pro in den Philippinen und in Thailand eingehenden Sendungen gedruckten Laser-Etiketten

Serviceart	Thermo-Etiketten (FedEx CLS gibt die entsprechende Anzahl von Etiketten in der Antwort zurück.)
Eingehende Sendungen (Philippinen)	Gedruckt werden 2 Versandetiketten mit Kontonummer Gedruckt wird 1 Belegetikett ohne Kontonummer 3 Exemplare der Handelsrechnung
Eingehende Warensendungen (Thailand)	Gedruckt werden 3 Versandetiketten mit Kontonummer Gedruckt wird 1 Belegetikett ohne Kontonummer
Eingehende Dokumentensendungen (Thailand)	Gedruckt werden 2 Versandetiketten mit Kontonummer Gedruckt wird 1 Belegetikett ohne Kontonummer

Benutzerdefiniertes Etikett

FedEx ermöglicht die individuelle Anpassung der von FedEx generierten Etiketten. Im anpassbaren Abschnitt von Thermo-Etiketten können Sie unternehmenseigenen Text hinzufügen und den Typ des Barcodes (Symbologie) auswählen, der auf FedEx Dokumenten und entsprechenden Etiketten verwendet wird.

Die FedEx API für offene Sendungen bietet zwei Optionen zur Anpassung Ihres Versandetiketts:

Sie können die Grafik PNG PAPER (17 x 12 cm) auf Ihrem Etikettenmaterial platzieren. Beispiel: Sie erstellen eine Packliste auf einem Formular (21,5 x 28 cm). Sie können die Grafik PNG PAPER (17 x 12 cm) in diesem Formular platzieren, statt ein eigenes Etikett zu erstellen.
Sie können eine Grafik- oder Textdatei auf Thermo-Etiketten (10 x 20 cm/4" x 8" oder 10 x 23 cm/4" x 9") hinzufügen. Diese Etikettengröße bietet 5 cm (2") Platz für Ihre Grafik oder Ihren Text.

Hinweis: Der Klarschrift-Inhalt des Etiketts und der Barcode im allgemeinen Teil des Etiketts können nicht geändert werden.

Benutzerdefiniertes Prüfetikett

Sie können sowohl auf Paket- als auch auf Sendungsebene benutzerdefinierte, nicht für den Versand vorgesehene Etiketten erstellen, indem Sie die gewünschten benutzerdefinierten Informationen, deren Formatierung sowie die Platzierung auf dem benutzerdefinierten Etikett angeben. Nur Thermo-Etiketten können vom Benutzer angepasst werden.

Anpassen eines Thermo-Etiketts

FedEx API bietet zwei Thermo-Etikettenformate, die Sie entweder mit einer Grafik- oder Textdatei anpassen können, sodass Sie kein benutzerdefiniertes Etikett erstellen müssen. Diese Etiketten sind für alle FedEx Versand-Services geeignet. Die Formate sind:

10 x 20 cm (4" x 8") Thermo-Etikett ohne Doc-Tab
10 x 23 cm (4" x 9") Thermo-Etikett mit Doc-Tab

Diese Etikettentypen enthalten eine 5 cm (2") großen anpassbaren Abschnitt. Diese Funktion steht nur für Thermo-Etiketten zur Verfügung, die auf einem Thermodrucker mit 203 DPI oder 300 DPI gedruckt werden.

Vorgaben für benutzerdefinierte Etiketten

Folgende Vorgaben gelten für die Verwendung der Etikettenformate:

Nur das Versandetikett kann angepasst werden. Wenn Sie z. B. ein 10 x 20 cm (4" x 8") großes Express Versandetikett mit Ihrem Logo drucken, wird dieses nicht auf die sekundären Belegetiketten gedruckt.
Die anpassbare Grafik oder der Text darf nicht größer als 5 cm (2") hoch und 11,5 cm (4,5") breit sein.
FedEx nimmt keine Korrekturen vor. Die Grafik und/oder der Text werden gedruckt, wie beim Versand-Service eingereicht.
Wenn nicht alle erforderlichen Daten für den Druck der Grafik und/oder des Textes bereitgestellt werden (z. B.: X- und Y-Koordinaten), wird ein gültiges Versandetikett ohne die angepassten Daten zurückgegeben. Sie müssen die Sendung stornieren, für die das Etikett vorgesehen ist, wenn Sie ein weiteres Etikett mit der Grafik und/oder dem Text erstellen möchten.
Bei einer Druckerauflösung von 203 DPI (8 Punkte/mm) ist hinsichtlich der Platzierung der X- und Y-Koordinaten der Bezugspunkt des Einfügepunkts der Schnittpunkt der oberen und linken Kante des 10 x 17 cm (4,00" x 6,75") großen Thermo-Etiketts mit Doc-Tab am unteren Rand. Addieren Sie bei einem 10 x 17 cm (4,00" x 6,75") großen Thermo-Etikett mit Doc-Tab am oberen Rand 164 Punkte zur Y-Koordinate des Einfügepunkts. Addieren Sie bei einem 10 x 15 cm (4,00" x 6,00") großen Etikett ohne Doc-Tab 8 Punkte zur Y-Koordinate des Einfügepunkts. Die Elementattribute für Thermo-Etiketten basieren auf einer Druckerauflösung von 203 DPI (8 Punkte/mm).
Bei einer Druckerauflösung von 300 DPI (12 Punkte/mm) ist hinsichtlich der Platzierung der X- und Y-Koordinaten der Bezugspunkt des Einfügepunkts der Schnittpunkt der oberen und linken Kante des 10 x 17 cm (4,00" x 6,75") großen Thermo-Etiketts mit Doc-Tab am unteren Rand. Addieren Sie bei einem 10 x 17 cm (4,00" x 6,75") großen Thermo-Etikett mit Doc-Tab am oberen Rand 264 Punkte zur Y-Koordinate des Einfügepunkts. Addieren Sie bei einem 10 x 15 cm (4,00" x 6,00") großen Etikett ohne Doc-Tab 12 Punkte zur Y-Koordinate des Einfügepunkts. Die Elementattribute für Thermo-Etiketten basieren auf einer Druckerauflösung von 300 DPI (8 Punkte/mm).
Hinweis:
- Für den FXD1D-Barcode beträgt die X-Dimension (Breite des schmalsten Balkens im Symbol) 0,381 mm (3 Punkte) für Drucker mit 203 DPI und 0,33782 mm (4 Punkte) für Drucker mit 300 DPI.
- Für den 2D-PDF-417-Barcode beträgt die X-Dimension 0,254 mm (2 Punkte) bei einem Drucker mit 203 DPI. Um die nächstgelegene äquivalente X-Dimension für einen Drucker mit 300 DPI zu erhalten, müssen 0,253746 mm (3 Punkte) verwendet werden.
- Für den Block für Versender*in/Sonstiges am oberen Rand des Etiketts und den Block „Referenz Versender*in“ unter den Empfängerinformationen, in denen sehr kleine Schriftarten verwendet werden, müssen die Etikettenentwickler anhand des ZPL-Programmierhandbuchs die Schriftartenmerkmale vergleichen, um eine gleichwertige Schriftart für verschiedene andere Druckkopfauflösungen auszuwählen.
Der Zeicheneinfügepunkt ist die obere linke Ecke des ersten Zeichens in der Zeichenfolge auf der H-Linie.
Drucker erfordern, dass der Ursprung der Positionskoordinaten im oberen linken Quadranten der Vorderseite liegt. Daher ist es möglich, dass die Daten über den anpassbaren Abschnitt des Etiketts hinaus in den FedEx Abschnitt des Etiketts reichen (eigentliche Daten des Thermo-Etiketts). In diesem Fall wird Ihr Logo oder Text mit den FedEx Etiketteninformationen überschrieben. Sie müssen diese Positionierung korrigieren, um das Versandetikett verwenden zu können.
Beim Hinzufügen von Doc-Tab-Informationen zum 10 x 23 cm (4" x 9") großen Etikett ist dasselbe Verfahren anzuwenden wie bei einem standardmäßigen 10 x 15 cm (4" x 6") großen Thermo-Etikett mit Doc-Tab.

Hinweis: Es dürfen nur einfarbige Bilder hinzugefügt werden, da die Etiketten in schwarz-weiß gedruckt werden.

Benutzerdefinierte Grafikelemente für Etiketten

Die API stellt PNG-Bilder (Portable Network Graphic) für FedEx Express und FedEx Ground Etiketten bereit. Bei der PNG-Etikettengrafik handelt es sich um eine Abbildung der von der API unterstützten Thermo- oder Normalpapier-Etiketten. Mit dieser Etikettenoption können Sie die PNG-Etikettengrafik auf Ihrem Etikettenmaterial platzieren, sodass Sie kein benutzerdefiniertes Etikett erstellen müssen.

Die folgenden Anforderungen gelten, wenn Sie die 10 x 15 cm (4" x 6") große PNG-Grafik in Ihrem Versanddokument einbetten:

Etikettenmaterial
Drucker
Skalierung

Etikettenmaterial

PNG-Etiketten im Format 10 x 15 cm (4" x 6") dürfen nur mit selbstklebendem Etikettenmaterial verwendet werden. Die Etikettenzertifizierungs-Teams von FedEx Ground und FedEx Express lehnen PNG-Etiketten im Format 10 x 15 cm (4" x 6") ab, die nicht auf abziehbarem Etikettenmaterial gedruckt sind, einschließlich aller Etiketten auf Normalpapier.

Drucker

Für den Druck von Etiketten werden Laser-Drucker empfohlen. Tintenstrahldrucker dürfen nicht verwendet werden, da mit diesen gedruckte Barcodes nicht immer lesbar sind. PNG-Etiketten im Format 10 x 15 cm (4" x 6") dürfen nur mit einem Farbdrucker gedruckt werden, wenn die Farbdefinition auf Schwarz eingestellt ist. Dies gilt auch, wenn sich nur eine schwarze Patrone im Drucker befindet. Diese Einstellung ist erforderlich, damit die korrekte Barcode-Definition für das Scannen an FedEx Hubs erzielt wird.

Skalierung

Das in Ihrer Versandtransaktion zurückgegebene Bild hat eine Auflösung von 200 Punkten pro Zoll (DPI) und misst 10 cm (4") (B) x 15 cm (6") (H) bzw. 800 x 1200 Pixel. Dieses Etikett weißt das Hochformat auf und ist für den Druck in einem 10 x 15 cm (4" x 6") großen Etikettenbereich vorgesehen. Im gedruckten Zustand muss das Etikett 10 x 15 cm (4" x 6") groß sein.

Um das Etikett und die Barcodes in der erforderlichen DPI-Auflösung zu generieren, müssen Sie das Bild vor dem Druck skalieren (oder die Größe ändern). Wie Sie das Bild skalieren, hängt von der Anwendung ab, die Sie zum Anzeigen und Drucken des Etiketts verwenden. So skalieren Sie das PNG-Bild für ein 10 x 15 cm (4" x 6") großes Etikett in Zoll: Verwenden Sie genau 4" für die Breite und 6" für die Länge.

Prüfliste für Etiketten

Alle Barcodes

Für die Validierung erforderlich:

Ruhezone: mindestens 0,25 mm Leerraum über und unter dem Barcode
Ruhezone: mindestens 0,5 mm Leerraum links und rechts vom Barcode
Überprüfen Sie, ob alle Barcodes die Mindesthöhe ausweisen.

Druckqualität

Häufige Probleme, die zur Ablehnung von Etiketten führen:

Unterbrochene Striche
Verblichener Druck/weiße Leerräume
Sich wiederholende weiße Leerräume (Walzenproblem)
Verschmieren (Thermotransfer)
Abblättern (Laser), weist auf ein Problem mit der Tonerbindung hin
Faltenbildung im Druck (Thermotransfer)
Druckkontrast bei Thermodirekt-Etiketten unter 90 %

Klarschrift-Angaben auf Ground Etiketten

Für die Klarschrift-Angaben auf FedEx Ground Etiketten müssen für die Validierung folgende Voraussetzungen erfüllt sein:

Daten stimmen mit Barcode überein
FedEx Ground Logo: Logos stehen auf der FedEx Identity Website unter fedex.com zum Download bereit.
FedEx Home Delivery Logo: Etiketten müssen ein großes „H“ in einem Kasten in einem Abstand von maximal 2,5 cm (1") von der Lieferadresse aufweisen. Das „H“ muss mindestens 0,6 cm (0,25") x 1,7 cm (0,70") groß sein.
Service-Beschreibung
Absenderinformationen
Empfängerinformationen
Postleitzahl und Routing-Informationen
Versanddatum
Tatsächliches Gewicht
Informationen zum Kundenautomatisierungsgerät (FedEx ID, Anwendung/System, Version)
Abmessungen
Verschiedene Referenzinformationen
Sendungsverfolgungsnummer und Formular-ID (Sendungsverfolgungsnummer muss 14-stellig sein)
ID der Flughafen-Frachtrampe
Postleitzahl

Klarschrift-Angaben auf Express Etiketten

Die folgenden Elemente müssen auf dem Etikett aufgedruckt sein, damit dieses die Zertifizierung erhält:

FedEx Express Logo: Logos stehen auf der FedEx Identity Website unter fedex.com zum Download bereit.
Service-Beschreibung
Pakettyp, falls international
Wochentag der Zustelltag (Beispiel: MON für Montag)
Zustelldatum
FedEx ID-Nummer
Versanddatum
Format der Stückzahl, Master-Etiketttext, CRN-Etiketttext auf allen MPS
ID der Flughafen-Frachtrampe
Postleitzahl und Routing-Informationen
URSA (Universal Routing and Sorting Aid) Routing-Präfix und -Suffix
Bearbeitungscode
Servicebereich-Zusage
Telefonnummern des Empfängers und Versenders
Gewicht
Abmessungen, falls zutreffend
Referenzfeld (bei Alkoholsendungen)
Sendungsverfolgungsnummer und Formular-ID (Sendungsverfolgungsnummer muss 14-stellig sein)
Auf dem ASTRA-Etikett befindet sich die 12-stellige Sendungsverfolgungsnummer an den Positionen 17 bis 28 des 32-stelligen Barcodes. Im neuen FDX 1D-Barcode befindet sich die Sendungsverfolgungsnummer an den Positionen 21 bis 34. Die FedEx Express Sendungsverfolgungsnummer bleibt 12-stellig. Die ersten beiden Stellen enthalten Nullen.

Geschäftsregeln

Die folgenden Vorgaben gelten für die API für offene Sendungen:

Eine offene Sendung kann auch mit einem Paket erstellt und bestätigt werden.
Offene Sendungen, die nicht spätestens fünf Tage nach ihrer Erstellung bestätigt werden, werden gelöscht.
Nach Bestätigung einer offenen Sendung können zu dieser keine Pakete mehr hinzugefügt werden.

JSON API-Sammlung

Open Ship API (1.0)

Create Open Shipment

This endpoint helps you to create an openn shipment request with the required shipping information.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters

x-customer-transaction-id	string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
x-locale	string Example: en_US This indicates the combination of language code and country code. Click here to see Locales
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

FullSchema-createOpenShipment
MinimumSamplePayload-CreateOpenshipment
MinimumSamplePayload-CreateOpenshipmentAsynchronous

requestedShipment required	object (OpenshipmentRequestedShipment) The detailed transaction data for the requested Open Shipment.
accountNumber required	object (AccountNumber) The account number associated with the shipment. Example: Your account number
openShipmentAction	string (OpenShipAction) Enum: "STRONG_VALIDATION" "WEAK_VALIDATION" "CREATE_PACKAGE" Indicates the optional actions that can be performed during the modification of packages in Open Shipment. Here are the values: CREATE_PACKAGE - Use CREATE_PACKAGE option to create Open Shipment. STRONG_VALIDATION – Full shipment edits: any edit that fails will cause the transaction to fail. If the transaction is successful, a tracking number may be returned and the transaction will be saved to the database (committed). WEAK_VALIDATION - Full shipment edits: any edit that fails will return errors but the transaction does not fail. The tracking number is returned and the transaction is saved in the database if the core edits are passed. Fix errors with the ModifyRequests transaction using the Index and returned tracking number.
index	string This is a unique value assigned to the already created Open Shipment. If this isn’t available then provide the master tracking number. Note: If index is not provided while create open shipment then the master tracking id of create open ship will act as index for the shipment. Example: Test1234

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /ship/v1/openshipments/create

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/openshipments/create

Production Server

https://apis.fedex.com/ship/v1/openshipments/create

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"requestedShipment":
{
- "shipDatestamp": "2019-10-14",
- "pickupType": "USE_SCHEDULED_PICKUP",
- "serviceType": "PRIORITY_OVERNIGHT",
- "packagingType": "YOUR_PACKAGING",
- "totalWeight": 20.6,
- "shipper":
  {
  - "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
  - "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "91",
    "phoneNumber": "1234567890",
    "companyName": "Fedex"
    },
  - "tins":
    [
    {
    "number": "XXX567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ]
  },
- "recipients":
  [
  - {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "000",
    "phoneNumber": "XXXX345671",
    "companyName": "FedEx"
    },
    "tins":
    [
    {
    "number": "123567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ],
    "deliveryInstructions": "Delivery Instructions"
    }
  ],
- "soldTo":
  {
  - "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
  - "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "91",
    "phoneNumber": "1234567890",
    "companyName": "Fedex"
    },
  - "tins":
    [
    {
    "number": "123567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ],
  - "accountNumber":
    {
    "value": "Your account number"
    }
  },
- "origin":
  {
  - "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
  - "contact":
    {
    "personName": "person name",
    "emailAddress": "email address",
    "phoneNumber": "phone number",
    "phoneExtension": "phone extension",
    "companyName": "company name",
    "faxNumber": "fax number"
    }
  },
- "shippingChargesPayment":
  {
  - "paymentType": "SENDER",
  - "payor":
    {
    "responsibleParty":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "XXXX567890",
    "phoneExtension": "phone extension",
    "companyName": "Fedex",
    "faxNumber": "fax number"
    },
    "accountNumber":
    {
    "value": "Your account number"
    }
    }
    }
  },
- "shipmentSpecialServices":
  {
  - "specialServiceTypes":
    [
    "THIRD_PARTY_CONSIGNEE",
    "PROTECTION_FROM_FREEZING"
    ],
  - "etdDetail":
    {
    "attributes":
    [
    "POST_SHIPMENT_UPLOAD_REQUESTED"
    ],
    "attachedDocuments":
    [
    {
    "documentType": "PRO_FORMA_INVOICE",
    "documentReference": "DocumentReference",
    "description": "PRO FORMA INVOICE",
    "documentId": "090927d680038c61"
    }
    ],
    "requestedDocumentTypes":
    [
    "VICS_BILL_OF_LADING",
    "GENERAL_AGENCY_AGREEMENT"
    ]
    },
  - "deliveryOnInvoiceAcceptanceDetail":
    {
    "recipient":
    {
    "address":
    {
    "streetLines":
    [
    "23, RUE JOSEPH-DE MA",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "000",
    "phoneNumber": "1234567890",
    "companyName": "Fedex"
    },
    "tins":
    [
    {
    "number": "123567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ],
    "deliveryInstructions": "Delivery Instructions"
    }
    },
  - "internationalTrafficInArmsRegulationsDetail":
    {
    "licenseOrExemptionNumber": "9871234"
    },
  - "holdAtLocationDetail":
    {
    "locationId": "YBZA",
    "locationContactAndAddress":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "person name",
    "emailAddress": "email address",
    "phoneNumber": "phone number",
    "phoneExtension": "phone extension",
    "companyName": "company name",
    "faxNumber": "fax number"
    }
    },
    "locationType": "FEDEX_ONSITE"
    },
  - "shipmentCODDetail":
    {
    "addTransportationChargesDetail":
    {
    "rateType": "ACCOUNT",
    "rateLevelType": "BUNDLED_RATE",
    "chargeLevelType": "CURRENT_PACKAGE",
    "chargeType": "COD_SURCHARGE"
    },
    "codRecipient":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "000",
    "phoneNumber": "XXXX345671",
    "companyName": "Fedex"
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "tins":
    [
    {
    "number": "123567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ]
    },
    "remitToName": "remitToName",
    "codCollectionType": "ANY",
    "financialInstitutionContactAndAddress":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "person name",
    "emailAddress": "email address",
    "phoneNumber": "phone number",
    "phoneExtension": "phone extension",
    "companyName": "company name",
    "faxNumber": "fax number"
    }
    },
    "codCollectionAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "returnReferenceIndicatorType": "INVOICE",
    "shipmentCodAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    },
  - "shipmentDryIceDetail":
    {
    "totalWeight":
    {
    "units": "KG",
    "value": 68.25
    },
    "packageCount": 12
    },
  - "internationalControlledExportDetail":
    {
    "licenseOrPermitExpirationDate": "2019-12-03",
    "licenseOrPermitNumber": "11",
    "entryNumber": "125",
    "foreignTradeZoneCode": "US",
    "type": "WAREHOUSE_WITHDRAWAL"
    },
  - "homeDeliveryPremiumDetail":
    {
    "phoneNumber":
    {
    "areaCode": "901",
    "localNumber": "3575012",
    "extension": "200",
    "personalIdentificationNumber": "98712345"
    },
    "deliveryDate": "2019-06-26",
    "homedeliveryPremiumType": "APPOINTMENT"
    }
  },
- "emailNotificationDetail":
  {
  - "aggregationType": "PER_PACKAGE",
  - "emailNotificationRecipients":
    [
    {
    "name": "Joe Smith",
    "emailNotificationRecipientType": "SHIPPER",
    "emailAddress": "jsmith3@aol.com",
    "notificationFormatType": "TEXT",
    "notificationType": "EMAIL",
    "locale": "en_US",
    "notificationEventType":
    [
    "ON_PICKUP_DRIVER_ARRIVED",
    "ON_SHIPMENT"
    ]
    }
    ],
  - "personalMessage": "your personal message here"
  },
- "expressFreightDetail":
  {
  - "bookingConfirmationNumber": "123456789812",
  - "shippersLoadAndCount": 123,
  - "packingListEnclosed": true
  },
- "variableHandlingChargeDetail":
  {
  - "rateType": "PREFERRED_CURRENCY",
  - "percentValue": 12.45,
  - "rateLevelType": "INDIVIDUAL_PACKAGE_RATE",
  - "fixedValue":
    {
    "amount": 24.45,
    "currency": "USD"
    },
  - "rateElementBasis": "NET_CHARGE_EXCLUDING_TAXES"
  },
- "customsClearanceDetail":
  {
  - "regulatoryControls": "NOT_IN_FREE_CIRCULATION",
  - "brokers":
    [
    {
    "broker":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": 91,
    "companyName": "Fedex",
    "faxNumber": 1234567
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "tins":
    [
    {
    "number": "number",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ],
    "deliveryInstructions": "deliveryInstructions"
    },
    "type": "IMPORT"
    }
    ],
  - "commercialInvoice":
    {
    "originatorName": "originator Name",
    "comments":
    [
    "optional comments for the commercial invoice"
    ],
    "customerReferences":
    [
    {
    "customerReferenceType": "INVOICE_NUMBER",
    "value": "3686"
    }
    ],
    "taxesOrMiscellaneousCharge":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "taxesOrMiscellaneousChargeType": "COMMISSIONS",
    "freightCharge":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "packingCosts":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "handlingCosts":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "declarationStatement": "declarationStatement",
    "termsOfSale": "FCA",
    "specialInstructions": "specialInstructions\"",
    "shipmentPurpose": "REPAIR_AND_RETURN",
    "emailNotificationDetail":
    {
    "emailAddress": "neena@fedex.com",
    "type": "EMAILED",
    "recipientType": "SHIPPER"
    }
    },
  - "freightOnValue": "OWN_RISK",
  - "dutiesPayment":
    {
    "payor":
    {
    "responsibleParty":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": "phone extension",
    "companyName": "Fedex",
    "faxNumber": "fax number"
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "tins":
    [
    {
    "number": "number",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    },
    {
    "number": "number",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ]
    }
    },
    "billingDetails":
    {
    "billingCode": "billingCode",
    "billingType": "billingType",
    "aliasId": "aliasId",
    "accountNickname": "accountNickname",
    "accountNumber": "Your account number",
    "accountNumberCountryCode": "US"
    },
    "paymentType": "SENDER"
    },
  - "commodities":
    [
    {
    "unitPrice":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "additionalMeasures":
    [
    {
    "quantity": 12.45,
    "units": "KG"
    }
    ],
    "numberOfPieces": 12,
    "quantity": 125,
    "quantityUnits": "Ea",
    "customsValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "countryOfManufacture": "US",
    "cIMarksAndNumbers": "87123",
    "harmonizedCode": "0613",
    "description": "description",
    "name": "non-threaded rivets",
    "weight":
    {
    "units": "KG",
    "value": 68.25
    },
    "exportLicenseNumber": "26456",
    "exportLicenseExpirationDate": "2025-04-02T16:22:55Z",
    "partNumber": "167",
    "purpose": "BUSINESS",
    "usmcaDetail":
    {
    "originCriterion": "A"
    }
    }
    ],
  - "isDocumentOnly": true,
  - "recipientCustomsId":
    {
    "type": "PASSPORT",
    "value": "123"
    },
  - "customsOption":
    {
    "description": "Description",
    "type": "COURTESY_RETURN_LABEL"
    },
  - "importerOfRecord":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "000",
    "phoneNumber": "XXXX345671",
    "companyName": "Fedex"
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "tins":
    [
    {
    "number": "123567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ]
    },
  - "generatedDocumentLocale": "en_US",
  - "exportDetail":
    {
    "destinationControlDetail":
    {
    "endUser": "dest country user",
    "statementTypes": "DEPARTMENT_OF_COMMERCE",
    "destinationCountries":
    [
    "USA",
    "India"
    ]
    },
    "b13AFilingOption": "NOT_REQUIRED",
    "exportComplianceStatement": "12345678901234567",
    "permitNumber": "12345"
    },
  - "totalCustomsValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
  - "partiesToTransactionAreRelated": true,
  - "declarationStatementDetail":
    {
    "usmcaLowValueStatementDetail":
    {
    "countryOfOriginLowValueDocumentRequested": true,
    "customsRole": "EXPORTER"
    }
    },
  - "insuranceCharge":
    {
    "amount": 12.45,
    "currency": "USD"
    }
  },
- "smartPostInfoDetail":
  {
  - "ancillaryEndorsement": "RETURN_SERVICE",
  - "hubId": "5015",
  - "indicia": "PRESORTED_STANDARD",
  - "specialServices": "USPS_DELIVERY_CONFIRMATION"
  },
- "blockInsightVisibility": true,
- "rateRequestType":
  [
  - "LIST",
  - "PREFERRED"
  ],
- "preferredCurrency": "USD",
- "requestedPackageLineItems":
  [
  - {
    "sequenceNumber": "1",
    "subPackagingType": "BUCKET",
    "customerReferences":
    [
    {
    "customerReferenceType": "INVOICE_NUMBER",
    "value": "3686"
    }
    ],
    "declaredValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "weight":
    {
    "units": "KG",
    "value": 68.25
    },
    "dimensions":
    {
    "length": 100,
    "width": 50,
    "height": 30,
    "units": "CM"
    },
    "groupPackageCount": 2,
    "itemDescriptionForClearance": "description",
    "contentRecord":
    [
    {
    "itemNumber": "2876",
    "receivedQuantity": 256,
    "description": "Description",
    "partNumber": "456"
    }
    ],
    "itemDescription": "item description for the package",
    "variableHandlingChargeDetail":
    {
    "rateType": "PREFERRED_CURRENCY",
    "percentValue": 12.45,
    "rateLevelType": "INDIVIDUAL_PACKAGE_RATE",
    "fixedValue":
    {
    "amount": 24.45,
    "currency": "USD"
    },
    "rateElementBasis": "NET_CHARGE_EXCLUDING_TAXES"
    },
    "packageSpecialServices":
    {
    "specialServiceTypes":
    [
    "ALCOHOL",
    "NON_STANDARD_CONTAINER"
    ],
    "signatureOptionType": "SERVICE_DEFAULT",
    "priorityAlertDetail":
    {
    "enhancementTypes":
    [
    "PRIORITY_ALERT_PLUS"
    ],
    "content":
    [
    "string"
    ]
    },
    "signatureOptionDetail":
    {
    "signatureReleaseNumber": "23456"
    },
    "alcoholDetail":
    {
    "alcoholRecipientType": "LICENSEE",
    "shipperAgreementType": "Retailer"
    },
    "dangerousGoodsDetail":
    {
    "accessibility": "INACCESSIBLE",
    "cargoAircraftOnly": false,
    "regulation": "ADR",
    "options":
    [
    "LIMITED_QUANTITIES_COMMODITIES",
    "ORM_D"
    ]
    },
    "packageCODDetail":
    {
    "codCollectionAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    },
    "pieceCountVerificationBoxCount": 0,
    "batteryDetails":
    [
    {
    "batteryPackingType": "CONTAINED_IN_EQUIPMENT",
    "batteryRegulatoryType": "IATA_SECTION_II",
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ],
    "dryIceWeight":
    {
    "units": "KG",
    "value": 68.25
    },
    "standaloneBatteryDetails":
    [
    {
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ]
    }
    }
  ]
},
"accountNumber":
{
- "value": "Your account number"
},
"openShipmentAction": "CREATE_PACKAGE",
"index": "Test1234"

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "624dxxx6-b709-470c-8c39-4b55xxxxx492",
"customerTransactionId": "order123xxxx89",
"output":
{
- "asynchronousProcessingResultsDetail": "SYNCHRONOUSLY_PROCESSED",
- "jobId": "abc123456",
- "transactionShipments":
  [
  - {
    "serviceType": "FEDEX_2_DAY_FREIGHT",
    "shipDatestamp": "2010-03-04",
    "serviceCategory": "EXPRESS",
    "serviceName": "FedEx 2 Day Freight",
    "alerts":
    [
    {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
    ],
    "completedShipmentDetail":
    {
    "completedPackageDetails":
    [
    {
    "sequenceNumber": 256,
    "operationalDetail":
    {
    "astraHandlingText": "astraHandlingText",
    "barcodes":
    {
    "binaryBarcodes":
    [
    {
    "type": "COMMON-2D",
    "value": "string"
    }
    ],
    "stringBarcodes":
    [
    {
    "type": "ADDRESS",
    "value": "1010062512241535917900794953544894"
    }
    ]
    },
    "operationalInstructions":
    [
    {
    "number": 17,
    "content": "content"
    }
    ]
    },
    "signatureOption": "DIRECT",
    "trackingIds":
    [
    {
    "formId": "0201",
    "trackingIdType": "EXPRESS",
    "uspsApplicationId": "92",
    "trackingNumber": "49092000070120032835"
    }
    ],
    "groupNumber": 567,
    "oversizeClass": "OVERSIZE_1, OVERSIZE_2, OVERSIZE_3",
    "packageRating":
    {
    "effectiveNetDiscount": 0,
    "actualRateType": "PAYOR_ACCOUNT_PACKAGE",
    "packageRateDetails":
    [
    {
    "ratedWeightMethod": "DIM",
    "totalFreightDiscounts": 44.55,
    "totalTaxes": 3.45,
    "minimumChargeType": "minimumChargeType",
    "baseCharge": 45.67,
    "totalRebates": 4.56,
    "rateType": "PAYOR_RETAIL_PACKAGE",
    "billingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "netFreight": 4.89,
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "totalSurcharges": 22.56,
    "netFedExCharge": 12.56,
    "netCharge": 121.56,
    "currency": "USD"
    }
    ]
    },
    "dryIceWeight":
    {
    "units": "KG",
    "value": 68
    },
    "hazardousPackageDetail":
    {
    "regulation": "IATA",
    "accessibility": "ACCESSIBLE",
    "labelType": "II_YELLOW",
    "containers":
    [
    {
    "qvalue": 2,
    "hazardousCommodities":
    [
    {
    "quantity":
    {
    "quantityType": "GROSS",
    "amount": 24.56,
    "units": "Kg"
    },
    "options":
    {
    "quantity":
    {
    "quantityType": "GROSS",
    "amount": 24.56,
    "units": "Kg"
    },
    "innerReceptacles":
    [
    {
    "quantity":
    {
    "quantityType": "NET",
    "amount": 34.56,
    "units": "Kg"
    }
    }
    ],
    "options":
    {
    "labelTextOption": "APPEND",
    "customerSuppliedLabelText": "Customer Supplied Label Text."
    },
    "description":
    {
    "sequenceNumber": 9812,
    "processingOptions":
    [
    "INCLUDE_SPECIAL_PROVISIONS"
    ],
    "subsidiaryClasses":
    [
    "Subsidiary Classes"
    ],
    "labelText": "labelText",
    "technicalName": "technicalName",
    "packingDetails":
    {
    "packingInstructions": "packing Instructions",
    "cargoAircraftOnly": true
    },
    "authorization": "authorization",
    "reportableQuantity": true,
    "percentage": 12.45,
    "id": "123",
    "packingGroup": "I",
    "properShippingName": "properShippingName",
    "hazardClass": "hazard Class"
    }
    },
    "description":
    {
    "sequenceNumber": 876,
    "packingInstructions": "packingInstructions",
    "subsidiaryClasses":
    [
    "Subsidiary Classes"
    ],
    "labelText": "labelText",
    "tunnelRestrictionCode": "UN2919",
    "specialProvisions": "specialProvisions",
    "properShippingNameAndDescription": "properShippingNameAndDescription",
    "technicalName": "technicalName",
    "symbols": "symbols",
    "authorization": "authorization",
    "attributes":
    [
    "attributes"
    ],
    "id": "1234",
    "packingGroup": "packingGroup",
    "properShippingName": "properShippingName",
    "hazardClass": "hazardClass"
    },
    "netExplosiveDetail":
    {
    "amount": 10,
    "units": "units",
    "type": "NET_EXPLOSIVE_WEIGHT"
    },
    "massPoints": 2
    }
    ]
    }
    ],
    "cargoAircraftOnly": true,
    "referenceId": "123456",
    "radioactiveTransportIndex": 2.45
    }
    }
    ],
    "operationalDetail":
    {
    "originServiceArea": "A1",
    "serviceCode": "010",
    "airportId": "DFW",
    "postalCode": "38010",
    "scac": "scac",
    "deliveryDay": "TUE",
    "originLocationId": "678",
    "countryCode": "US",
    "astraDescription": "SMART POST",
    "originLocationNumber": 243,
    "deliveryDate": "2001-04-05",
    "deliveryEligibilities":
    [
    "deliveryEligibilities"
    ],
    "ineligibleForMoneyBackGuarantee": true,
    "maximumTransitTime": "SEVEN_DAYS",
    "destinationLocationStateOrProvinceCode": "GA",
    "astraPlannedServiceLevel": "TUE - 15 OCT 10:30A",
    "destinationLocationId": "DALA",
    "transitTime": "TWO_DAYS",
    "stateOrProvinceCode": "GA",
    "destinationLocationNumber": 876,
    "packagingCode": "03",
    "commitDate": "2019-10-15",
    "publishedDeliveryTime": "10:30A",
    "ursaSuffixCode": "Ga",
    "ursaPrefixCode": "XH",
    "destinationServiceArea": "A1",
    "commitDay": "TUE",
    "customTransitTime": "ONE_DAY"
    },
    "carrierCode": "FDXE",
    "completedHoldAtLocationDetail":
    {
    "holdingLocationType": "FEDEX_STAFFED",
    "holdingLocation":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "tollFreePhoneNumber": "6127812",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": "91",
    "faxNumber": "1234567890",
    "pagerNumber": "6127812",
    "companyName": "Fedex",
    "title": "title"
    }
    }
    },
    "completedEtdDetail":
    {
    "folderId": "0b0493e580dc1a1b",
    "type": "COMMERCIAL_INVOICE",
    "uploadDocumentReferenceDetails":
    [
    {
    "documentType": "PRO_FORMA_INVOICE",
    "documentReference": "DocumentReference",
    "description": "PRO FORMA INVOICE",
    "documentId": "090927d680038c61"
    }
    ]
    },
    "packagingDescription": "description",
    "masterTrackingId":
    {
    "formId": "0201",
    "trackingIdType": "EXPRESS",
    "uspsApplicationId": "92",
    "trackingNumber": "49092000070120032835"
    },
    "serviceDescription":
    {
    "serviceType": "FEDEX_1_DAY_FREIGHT",
    "code": "80",
    "names":
    [
    {
    "type": "long",
    "encoding": "UTF-8",
    "value": "F-2"
    }
    ],
    "operatingOrgCodes":
    [
    "FXE"
    ],
    "astraDescription": "2 DAY FRT",
    "description": "description",
    "serviceId": "EP1000000027",
    "serviceCategory": "freight"
    },
    "usDomestic": true,
    "hazardousShipmentDetail":
    {
    "hazardousSummaryDetail":
    {
    "smallQuantityExceptionPackageCount": 10
    },
    "adrLicense":
    {
    "licenseOrPermitDetail":
    {
    "number": "12345",
    "effectiveDate": "2019-08-09",
    "expirationDate": "2019-04-09"
    }
    },
    "dryIceDetail":
    {
    "totalWeight":
    {
    "units": "KG",
    "value": 68
    },
    "packageCount": 10,
    "processingOptions":
    {
    "options":
    [
    "options"
    ]
    }
    }
    },
    "shipmentRating":
    {
    "actualRateType": "PAYOR_LIST_SHIPMENT",
    "shipmentRateDetails":
    [
    {
    "rateZone": "US001O",
    "ratedWeightMethod": "ACTUAL",
    "totalDutiesTaxesAndFees": 24.56,
    "pricingCode": "LTL_FREIGHT",
    "totalFreightDiscounts": 1.56,
    "totalTaxes": 3.45,
    "totalDutiesAndTaxes": 6.78,
    "totalAncillaryFeesAndTaxes": 5.67,
    "taxes":
    [
    {
    "amount": 10,
    "level": "level",
    "description": "description",
    "type": "type"
    }
    ],
    "totalRebates": 1.98,
    "fuelSurchargePercent": 4.56,
    "currencyExchangeRate":
    {
    "rate": 25.6,
    "fromCurrency": "Rupee",
    "intoCurrency": "USD"
    },
    "totalNetFreight": 9.56,
    "totalNetFedExCharge": 88.56,
    "shipmentLegRateDetails":
    [
    {
    "rateZone": "rateZone",
    "pricingCode": "pricingCode",
    "taxes":
    [
    {
    "amount": 10,
    "level": "level",
    "description": "description",
    "type": "type"
    }
    ],
    "totalDimWeight":
    {
    "units": "KG",
    "value": 68
    },
    "totalRebates": 2,
    "fuelSurchargePercent": 6,
    "currencyExchangeRate":
    {
    "rate": 25.6,
    "fromCurrency": "Rupee",
    "intoCurrency": "USD"
    },
    "dimDivisor": 6,
    "rateType": "PAYOR_RETAIL_PACKAGE",
    "legDestinationLocationId": "legDestinationLocationId",
    "dimDivisorType": "dimDivisorType",
    "totalBaseCharge": 6,
    "ratedWeightMethod": "ratedWeightMethod",
    "totalFreightDiscounts": 9,
    "totalTaxes": 12.6,
    "minimumChargeType": "minimumChargeType",
    "totalDutiesAndTaxes": 17.78,
    "totalNetFreight": 6,
    "totalNetFedExCharge": 3.2,
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "totalSurcharges": 5,
    "totalBillingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "freightDiscounts":
    [
    {
    "amount": 8.9,
    "rateDiscountType": "COUPON",
    "percent": 28.9,
    "description": "description"
    }
    ],
    "rateScale": "6702",
    "totalNetCharge": 25.3,
    "totalNetChargeWithDutiesAndTaxes": 25.67,
    "currency": "USD"
    }
    ],
    "dimDivisor": 0,
    "rateType": "RATED_ACCOUNT_SHIPMENT",
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "totalSurcharges": 9.88,
    "totalBillingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "freightDiscounts":
    [
    {
    "amount": 8.9,
    "rateDiscountType": "COUPON",
    "percent": 28.9,
    "description": "description"
    }
    ],
    "rateScale": "00000",
    "totalNetCharge": 3.78,
    "totalBaseCharge": 234.56,
    "totalNetChargeWithDutiesAndTaxes": 222.56,
    "currency": "USD"
    }
    ]
    },
    "documentRequirements":
    {
    "requiredDocuments":
    [
    "COMMERCIAL_OR_PRO_FORMA_INVOICE",
    "AIR_WAYBILL"
    ],
    "prohibitedDocuments":
    [
    "CERTIFICATE_OF_ORIGIN"
    ],
    "generationDetails":
    [
    {
    "type": "COMMERCIAL_INVOICE",
    "minimumCopiesRequired": 3,
    "letterhead": "OPTIONAL",
    "electronicSignature": "OPTIONAL"
    }
    ]
    },
    "exportComplianceStatement": "12345678901234567",
    "accessDetail":
    {
    "accessorDetails":
    [
    {
    "password": "password",
    "role": "role",
    "emailLabelUrl": "emailLabelUrl",
    "userId": "userId"
    }
    ]
    }
    },
    "shipmentAdvisoryDetails":
    {
    "regulatoryAdvisory":
    {
    "commodityClarifications":
    [
    {
    "commodityIndex": 25,
    "suggestions":
    [
    {
    "description": "description",
    "harmonizedCode": "harmonized Code"
    }
    ]
    }
    ],
    "prohibitions":
    [
    {
    "derivedHarmonizedCode": "01",
    "advisory":
    {
    "code": "code",
    "text": "Text",
    "parameters":
    [
    {
    "id": "message ID",
    "value": "Message value"
    }
    ],
    "localizedText": "localizedText"
    },
    "commodityIndex": 12,
    "source": "source",
    "categories":
    [
    "categories"
    ],
    "type": "type",
    "waiver":
    {
    "advisories":
    [
    {
    "code": "code",
    "text": "Text",
    "parameters":
    [
    {
    "id": "message ID",
    "value": "Message value"
    }
    ],
    "localizedText": "localizedText"
    }
    ],
    "description": "description",
    "id": "id"
    },
    "status": "status"
    }
    ]
    }
    },
    "masterTrackingNumber": "794953535000"
    }
  ],
- "alerts":
  [
  - {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
  ]
}

}

Modify Open Shipment

This endpoint helps you to modify an Open shipment request with the required shipping information before the shipment is confirmed.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters

x-customer-transaction-id	string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
x-locale	string Example: en_US This indicates the combination of language code and country code. Click here to see Locales
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

FullSchema-modifyOpenShipment
MinimumSamplePayload-modifyOpenShipment

index required	string This is a unique value assigned to the already created Open Shipment. If this isn’t available then provide the master tracking number. Example: Test1234
requestedShipment required	object (OpenshipmentRequestedShipment) The detailed transaction data for the requested Open Shipment.
openShipmentAction	string (OpenShipAction) Enum: "STRONG_VALIDATION" "WEAK_VALIDATION" "CREATE_PACKAGE" Indicates the optional actions that can be performed during the modification of packages in Open Shipment. Here are the values: CREATE_PACKAGE - Use CREATE_PACKAGE option to create Open Shipment. STRONG_VALIDATION – Full shipment edits: any edit that fails will cause the transaction to fail. If the transaction is successful, a tracking number may be returned and the transaction will be saved to the database (committed). WEAK_VALIDATION - Full shipment edits: any edit that fails will return errors but the transaction does not fail. The tracking number is returned and the transaction is saved in the database if the core edits are passed. Fix errors with the ModifyRequests transaction using the Index and returned tracking number.
accountNumber required	object (AccountNumber) The account number associated with the shipment. Example: Your account number

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

put /ship/v1/openshipments/

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/openshipments/

Production Server

https://apis.fedex.com/ship/v1/openshipments/

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"index": "Test1234",
"requestedShipment":
{
- "shipDatestamp": "2019-10-14",
- "pickupType": "USE_SCHEDULED_PICKUP",
- "serviceType": "PRIORITY_OVERNIGHT",
- "packagingType": "YOUR_PACKAGING",
- "totalWeight": 20.6,
- "shipper":
  {
  - "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
  - "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "91",
    "phoneNumber": "1234567890",
    "companyName": "Fedex"
    },
  - "tins":
    [
    {
    "number": "XXX567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ]
  },
- "recipients":
  [
  - {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "000",
    "phoneNumber": "XXXX345671",
    "companyName": "FedEx"
    },
    "tins":
    [
    {
    "number": "123567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ],
    "deliveryInstructions": "Delivery Instructions"
    }
  ],
- "soldTo":
  {
  - "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
  - "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "91",
    "phoneNumber": "1234567890",
    "companyName": "Fedex"
    },
  - "tins":
    [
    {
    "number": "123567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ],
  - "accountNumber":
    {
    "value": "Your account number"
    }
  },
- "origin":
  {
  - "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
  - "contact":
    {
    "personName": "person name",
    "emailAddress": "email address",
    "phoneNumber": "phone number",
    "phoneExtension": "phone extension",
    "companyName": "company name",
    "faxNumber": "fax number"
    }
  },
- "shippingChargesPayment":
  {
  - "paymentType": "SENDER",
  - "payor":
    {
    "responsibleParty":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "XXXX567890",
    "phoneExtension": "phone extension",
    "companyName": "Fedex",
    "faxNumber": "fax number"
    },
    "accountNumber":
    {
    "value": "Your account number"
    }
    }
    }
  },
- "shipmentSpecialServices":
  {
  - "specialServiceTypes":
    [
    "THIRD_PARTY_CONSIGNEE",
    "PROTECTION_FROM_FREEZING"
    ],
  - "etdDetail":
    {
    "attributes":
    [
    "POST_SHIPMENT_UPLOAD_REQUESTED"
    ],
    "attachedDocuments":
    [
    {
    "documentType": "PRO_FORMA_INVOICE",
    "documentReference": "DocumentReference",
    "description": "PRO FORMA INVOICE",
    "documentId": "090927d680038c61"
    }
    ],
    "requestedDocumentTypes":
    [
    "VICS_BILL_OF_LADING",
    "GENERAL_AGENCY_AGREEMENT"
    ]
    },
  - "deliveryOnInvoiceAcceptanceDetail":
    {
    "recipient":
    {
    "address":
    {
    "streetLines":
    [
    "23, RUE JOSEPH-DE MA",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "000",
    "phoneNumber": "1234567890",
    "companyName": "Fedex"
    },
    "tins":
    [
    {
    "number": "123567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ],
    "deliveryInstructions": "Delivery Instructions"
    }
    },
  - "internationalTrafficInArmsRegulationsDetail":
    {
    "licenseOrExemptionNumber": "9871234"
    },
  - "holdAtLocationDetail":
    {
    "locationId": "YBZA",
    "locationContactAndAddress":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "person name",
    "emailAddress": "email address",
    "phoneNumber": "phone number",
    "phoneExtension": "phone extension",
    "companyName": "company name",
    "faxNumber": "fax number"
    }
    },
    "locationType": "FEDEX_ONSITE"
    },
  - "shipmentCODDetail":
    {
    "addTransportationChargesDetail":
    {
    "rateType": "ACCOUNT",
    "rateLevelType": "BUNDLED_RATE",
    "chargeLevelType": "CURRENT_PACKAGE",
    "chargeType": "COD_SURCHARGE"
    },
    "codRecipient":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "000",
    "phoneNumber": "XXXX345671",
    "companyName": "Fedex"
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "tins":
    [
    {
    "number": "123567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ]
    },
    "remitToName": "remitToName",
    "codCollectionType": "ANY",
    "financialInstitutionContactAndAddress":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "person name",
    "emailAddress": "email address",
    "phoneNumber": "phone number",
    "phoneExtension": "phone extension",
    "companyName": "company name",
    "faxNumber": "fax number"
    }
    },
    "codCollectionAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "returnReferenceIndicatorType": "INVOICE",
    "shipmentCodAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    },
  - "shipmentDryIceDetail":
    {
    "totalWeight":
    {
    "units": "KG",
    "value": 68.25
    },
    "packageCount": 12
    },
  - "internationalControlledExportDetail":
    {
    "licenseOrPermitExpirationDate": "2019-12-03",
    "licenseOrPermitNumber": "11",
    "entryNumber": "125",
    "foreignTradeZoneCode": "US",
    "type": "WAREHOUSE_WITHDRAWAL"
    },
  - "homeDeliveryPremiumDetail":
    {
    "phoneNumber":
    {
    "areaCode": "901",
    "localNumber": "3575012",
    "extension": "200",
    "personalIdentificationNumber": "98712345"
    },
    "deliveryDate": "2019-06-26",
    "homedeliveryPremiumType": "APPOINTMENT"
    }
  },
- "emailNotificationDetail":
  {
  - "aggregationType": "PER_PACKAGE",
  - "emailNotificationRecipients":
    [
    {
    "name": "Joe Smith",
    "emailNotificationRecipientType": "SHIPPER",
    "emailAddress": "jsmith3@aol.com",
    "notificationFormatType": "TEXT",
    "notificationType": "EMAIL",
    "locale": "en_US",
    "notificationEventType":
    [
    "ON_PICKUP_DRIVER_ARRIVED",
    "ON_SHIPMENT"
    ]
    }
    ],
  - "personalMessage": "your personal message here"
  },
- "expressFreightDetail":
  {
  - "bookingConfirmationNumber": "123456789812",
  - "shippersLoadAndCount": 123,
  - "packingListEnclosed": true
  },
- "variableHandlingChargeDetail":
  {
  - "rateType": "PREFERRED_CURRENCY",
  - "percentValue": 12.45,
  - "rateLevelType": "INDIVIDUAL_PACKAGE_RATE",
  - "fixedValue":
    {
    "amount": 24.45,
    "currency": "USD"
    },
  - "rateElementBasis": "NET_CHARGE_EXCLUDING_TAXES"
  },
- "customsClearanceDetail":
  {
  - "regulatoryControls": "NOT_IN_FREE_CIRCULATION",
  - "brokers":
    [
    {
    "broker":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": 91,
    "companyName": "Fedex",
    "faxNumber": 1234567
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "tins":
    [
    {
    "number": "number",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ],
    "deliveryInstructions": "deliveryInstructions"
    },
    "type": "IMPORT"
    }
    ],
  - "commercialInvoice":
    {
    "originatorName": "originator Name",
    "comments":
    [
    "optional comments for the commercial invoice"
    ],
    "customerReferences":
    [
    {
    "customerReferenceType": "INVOICE_NUMBER",
    "value": "3686"
    }
    ],
    "taxesOrMiscellaneousCharge":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "taxesOrMiscellaneousChargeType": "COMMISSIONS",
    "freightCharge":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "packingCosts":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "handlingCosts":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "declarationStatement": "declarationStatement",
    "termsOfSale": "FCA",
    "specialInstructions": "specialInstructions\"",
    "shipmentPurpose": "REPAIR_AND_RETURN",
    "emailNotificationDetail":
    {
    "emailAddress": "neena@fedex.com",
    "type": "EMAILED",
    "recipientType": "SHIPPER"
    }
    },
  - "freightOnValue": "OWN_RISK",
  - "dutiesPayment":
    {
    "payor":
    {
    "responsibleParty":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": "phone extension",
    "companyName": "Fedex",
    "faxNumber": "fax number"
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "tins":
    [
    {
    "number": "number",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    },
    {
    "number": "number",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ]
    }
    },
    "billingDetails":
    {
    "billingCode": "billingCode",
    "billingType": "billingType",
    "aliasId": "aliasId",
    "accountNickname": "accountNickname",
    "accountNumber": "Your account number",
    "accountNumberCountryCode": "US"
    },
    "paymentType": "SENDER"
    },
  - "commodities":
    [
    {
    "unitPrice":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "additionalMeasures":
    [
    {
    "quantity": 12.45,
    "units": "KG"
    }
    ],
    "numberOfPieces": 12,
    "quantity": 125,
    "quantityUnits": "Ea",
    "customsValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "countryOfManufacture": "US",
    "cIMarksAndNumbers": "87123",
    "harmonizedCode": "0613",
    "description": "description",
    "name": "non-threaded rivets",
    "weight":
    {
    "units": "KG",
    "value": 68.25
    },
    "exportLicenseNumber": "26456",
    "exportLicenseExpirationDate": "2025-04-02T16:22:55Z",
    "partNumber": "167",
    "purpose": "BUSINESS",
    "usmcaDetail":
    {
    "originCriterion": "A"
    }
    }
    ],
  - "isDocumentOnly": true,
  - "recipientCustomsId":
    {
    "type": "PASSPORT",
    "value": "123"
    },
  - "customsOption":
    {
    "description": "Description",
    "type": "COURTESY_RETURN_LABEL"
    },
  - "importerOfRecord":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "000",
    "phoneNumber": "XXXX345671",
    "companyName": "Fedex"
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "tins":
    [
    {
    "number": "123567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ]
    },
  - "generatedDocumentLocale": "en_US",
  - "exportDetail":
    {
    "destinationControlDetail":
    {
    "endUser": "dest country user",
    "statementTypes": "DEPARTMENT_OF_COMMERCE",
    "destinationCountries":
    [
    "USA",
    "India"
    ]
    },
    "b13AFilingOption": "NOT_REQUIRED",
    "exportComplianceStatement": "12345678901234567",
    "permitNumber": "12345"
    },
  - "totalCustomsValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
  - "partiesToTransactionAreRelated": true,
  - "declarationStatementDetail":
    {
    "usmcaLowValueStatementDetail":
    {
    "countryOfOriginLowValueDocumentRequested": true,
    "customsRole": "EXPORTER"
    }
    },
  - "insuranceCharge":
    {
    "amount": 12.45,
    "currency": "USD"
    }
  },
- "smartPostInfoDetail":
  {
  - "ancillaryEndorsement": "RETURN_SERVICE",
  - "hubId": "5015",
  - "indicia": "PRESORTED_STANDARD",
  - "specialServices": "USPS_DELIVERY_CONFIRMATION"
  },
- "blockInsightVisibility": true,
- "rateRequestType":
  [
  - "LIST",
  - "PREFERRED"
  ],
- "preferredCurrency": "USD",
- "requestedPackageLineItems":
  [
  - {
    "sequenceNumber": "1",
    "subPackagingType": "BUCKET",
    "customerReferences":
    [
    {
    "customerReferenceType": "INVOICE_NUMBER",
    "value": "3686"
    }
    ],
    "declaredValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "weight":
    {
    "units": "KG",
    "value": 68.25
    },
    "dimensions":
    {
    "length": 100,
    "width": 50,
    "height": 30,
    "units": "CM"
    },
    "groupPackageCount": 2,
    "itemDescriptionForClearance": "description",
    "contentRecord":
    [
    {
    "itemNumber": "2876",
    "receivedQuantity": 256,
    "description": "Description",
    "partNumber": "456"
    }
    ],
    "itemDescription": "item description for the package",
    "variableHandlingChargeDetail":
    {
    "rateType": "PREFERRED_CURRENCY",
    "percentValue": 12.45,
    "rateLevelType": "INDIVIDUAL_PACKAGE_RATE",
    "fixedValue":
    {
    "amount": 24.45,
    "currency": "USD"
    },
    "rateElementBasis": "NET_CHARGE_EXCLUDING_TAXES"
    },
    "packageSpecialServices":
    {
    "specialServiceTypes":
    [
    "ALCOHOL",
    "NON_STANDARD_CONTAINER"
    ],
    "signatureOptionType": "SERVICE_DEFAULT",
    "priorityAlertDetail":
    {
    "enhancementTypes":
    [
    "PRIORITY_ALERT_PLUS"
    ],
    "content":
    [
    "string"
    ]
    },
    "signatureOptionDetail":
    {
    "signatureReleaseNumber": "23456"
    },
    "alcoholDetail":
    {
    "alcoholRecipientType": "LICENSEE",
    "shipperAgreementType": "Retailer"
    },
    "dangerousGoodsDetail":
    {
    "accessibility": "INACCESSIBLE",
    "cargoAircraftOnly": false,
    "regulation": "ADR",
    "options":
    [
    "LIMITED_QUANTITIES_COMMODITIES",
    "ORM_D"
    ]
    },
    "packageCODDetail":
    {
    "codCollectionAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    },
    "pieceCountVerificationBoxCount": 0,
    "batteryDetails":
    [
    {
    "batteryPackingType": "CONTAINED_IN_EQUIPMENT",
    "batteryRegulatoryType": "IATA_SECTION_II",
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ],
    "dryIceWeight":
    {
    "units": "KG",
    "value": 68.25
    },
    "standaloneBatteryDetails":
    [
    {
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ]
    }
    }
  ]
},
"openShipmentAction": "CREATE_PACKAGE",
"accountNumber":
{
- "value": "Your account number"
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "string",
"customerTransactionId": "AnyCo_order123456789",
"output":
{
- "asynchronousProcessingResultsDetail": "SYNCHRONOUSLY_PROCESSED",
- "jobId": "abc123456",
- "transactionShipments":
  [
  - {
    "serviceType": "FEDEX_2_DAY_FREIGHT",
    "shipDatestamp": "2010-03-04",
    "serviceCategory": "EXPRESS",
    "serviceName": "FedEx 2 Day Freight",
    "alerts":
    [
    {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
    ],
    "completedShipmentDetail":
    {
    "completedPackageDetails":
    [
    {
    "sequenceNumber": 256,
    "operationalDetail":
    {
    "astraHandlingText": "astraHandlingText",
    "barcodes":
    {
    "binaryBarcodes":
    [
    {
    "type": "COMMON-2D",
    "value": "string"
    }
    ],
    "stringBarcodes":
    [
    {
    "type": "ADDRESS",
    "value": "1010062512241535917900794953544894"
    }
    ]
    },
    "operationalInstructions":
    [
    {
    "number": 17,
    "content": "content"
    }
    ]
    },
    "signatureOption": "DIRECT",
    "trackingIds":
    [
    {
    "formId": "0201",
    "trackingIdType": "EXPRESS",
    "uspsApplicationId": "92",
    "trackingNumber": "49092000070120032835"
    }
    ],
    "groupNumber": 567,
    "oversizeClass": "OVERSIZE_1, OVERSIZE_2, OVERSIZE_3",
    "packageRating":
    {
    "effectiveNetDiscount": 0,
    "actualRateType": "PAYOR_ACCOUNT_PACKAGE",
    "packageRateDetails":
    [
    {
    "ratedWeightMethod": "DIM",
    "totalFreightDiscounts": 44.55,
    "totalTaxes": 3.45,
    "minimumChargeType": "minimumChargeType",
    "baseCharge": 45.67,
    "totalRebates": 4.56,
    "rateType": "PAYOR_RETAIL_PACKAGE",
    "billingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "netFreight": 4.89,
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "totalSurcharges": 22.56,
    "netFedExCharge": 12.56,
    "netCharge": 121.56,
    "currency": "USD"
    }
    ]
    },
    "dryIceWeight":
    {
    "units": "KG",
    "value": 68
    },
    "hazardousPackageDetail":
    {
    "regulation": "IATA",
    "accessibility": "ACCESSIBLE",
    "labelType": "II_YELLOW",
    "containers":
    [
    {
    "qvalue": 2,
    "hazardousCommodities":
    [
    {
    "quantity":
    {
    "quantityType": "GROSS",
    "amount": 24.56,
    "units": "Kg"
    },
    "options":
    {
    "quantity":
    {
    "quantityType": "GROSS",
    "amount": 24.56,
    "units": "Kg"
    },
    "innerReceptacles":
    [
    {
    "quantity":
    {
    "quantityType": "NET",
    "amount": 34.56,
    "units": "Kg"
    }
    }
    ],
    "options":
    {
    "labelTextOption": "APPEND",
    "customerSuppliedLabelText": "Customer Supplied Label Text."
    },
    "description":
    {
    "sequenceNumber": 9812,
    "processingOptions":
    [
    "INCLUDE_SPECIAL_PROVISIONS"
    ],
    "subsidiaryClasses":
    [
    "Subsidiary Classes"
    ],
    "labelText": "labelText",
    "technicalName": "technicalName",
    "packingDetails":
    {
    "packingInstructions": "packing Instructions",
    "cargoAircraftOnly": true
    },
    "authorization": "authorization",
    "reportableQuantity": true,
    "percentage": 12.45,
    "id": "123",
    "packingGroup": "I",
    "properShippingName": "properShippingName",
    "hazardClass": "hazard Class"
    }
    },
    "description":
    {
    "sequenceNumber": 876,
    "packingInstructions": "packingInstructions",
    "subsidiaryClasses":
    [
    "Subsidiary Classes"
    ],
    "labelText": "labelText",
    "tunnelRestrictionCode": "UN2919",
    "specialProvisions": "specialProvisions",
    "properShippingNameAndDescription": "properShippingNameAndDescription",
    "technicalName": "technicalName",
    "symbols": "symbols",
    "authorization": "authorization",
    "attributes":
    [
    "attributes"
    ],
    "id": "1234",
    "packingGroup": "packingGroup",
    "properShippingName": "properShippingName",
    "hazardClass": "hazardClass"
    },
    "netExplosiveDetail":
    {
    "amount": 10,
    "units": "units",
    "type": "NET_EXPLOSIVE_WEIGHT"
    },
    "massPoints": 2
    }
    ]
    }
    ],
    "cargoAircraftOnly": true,
    "referenceId": "123456",
    "radioactiveTransportIndex": 2.45
    }
    }
    ],
    "operationalDetail":
    {
    "originServiceArea": "A1",
    "serviceCode": "010",
    "airportId": "DFW",
    "postalCode": "38010",
    "scac": "scac",
    "deliveryDay": "TUE",
    "originLocationId": "678",
    "countryCode": "US",
    "astraDescription": "SMART POST",
    "originLocationNumber": 243,
    "deliveryDate": "2001-04-05",
    "deliveryEligibilities":
    [
    "deliveryEligibilities"
    ],
    "ineligibleForMoneyBackGuarantee": true,
    "maximumTransitTime": "SEVEN_DAYS",
    "destinationLocationStateOrProvinceCode": "GA",
    "astraPlannedServiceLevel": "TUE - 15 OCT 10:30A",
    "destinationLocationId": "DALA",
    "transitTime": "TWO_DAYS",
    "stateOrProvinceCode": "GA",
    "destinationLocationNumber": 876,
    "packagingCode": "03",
    "commitDate": "2019-10-15",
    "publishedDeliveryTime": "10:30A",
    "ursaSuffixCode": "Ga",
    "ursaPrefixCode": "XH",
    "destinationServiceArea": "A1",
    "commitDay": "TUE",
    "customTransitTime": "ONE_DAY"
    },
    "carrierCode": "FDXE",
    "completedHoldAtLocationDetail":
    {
    "holdingLocationType": "FEDEX_STAFFED",
    "holdingLocation":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "tollFreePhoneNumber": "6127812",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": "91",
    "faxNumber": "1234567890",
    "pagerNumber": "6127812",
    "companyName": "Fedex",
    "title": "title"
    }
    }
    },
    "completedEtdDetail":
    {
    "folderId": "0b0493e580dc1a1b",
    "type": "COMMERCIAL_INVOICE",
    "uploadDocumentReferenceDetails":
    [
    {
    "documentType": "PRO_FORMA_INVOICE",
    "documentReference": "DocumentReference",
    "description": "PRO FORMA INVOICE",
    "documentId": "090927d680038c61"
    }
    ]
    },
    "packagingDescription": "description",
    "masterTrackingId":
    {
    "formId": "0201",
    "trackingIdType": "EXPRESS",
    "uspsApplicationId": "92",
    "trackingNumber": "49092000070120032835"
    },
    "serviceDescription":
    {
    "serviceType": "FEDEX_1_DAY_FREIGHT",
    "code": "80",
    "names":
    [
    {
    "type": "long",
    "encoding": "UTF-8",
    "value": "F-2"
    }
    ],
    "operatingOrgCodes":
    [
    "FXE"
    ],
    "astraDescription": "2 DAY FRT",
    "description": "description",
    "serviceId": "EP1000000027",
    "serviceCategory": "freight"
    },
    "usDomestic": true,
    "hazardousShipmentDetail":
    {
    "hazardousSummaryDetail":
    {
    "smallQuantityExceptionPackageCount": 10
    },
    "adrLicense":
    {
    "licenseOrPermitDetail":
    {
    "number": "12345",
    "effectiveDate": "2019-08-09",
    "expirationDate": "2019-04-09"
    }
    },
    "dryIceDetail":
    {
    "totalWeight":
    {
    "units": "KG",
    "value": 68
    },
    "packageCount": 10,
    "processingOptions":
    {
    "options":
    [
    "options"
    ]
    }
    }
    },
    "shipmentRating":
    {
    "actualRateType": "PAYOR_LIST_SHIPMENT",
    "shipmentRateDetails":
    [
    {
    "rateZone": "US001O",
    "ratedWeightMethod": "ACTUAL",
    "totalDutiesTaxesAndFees": 24.56,
    "pricingCode": "LTL_FREIGHT",
    "totalFreightDiscounts": 1.56,
    "totalTaxes": 3.45,
    "totalDutiesAndTaxes": 6.78,
    "totalAncillaryFeesAndTaxes": 5.67,
    "taxes":
    [
    {
    "amount": 10,
    "level": "level",
    "description": "description",
    "type": "type"
    }
    ],
    "totalRebates": 1.98,
    "fuelSurchargePercent": 4.56,
    "currencyExchangeRate":
    {
    "rate": 25.6,
    "fromCurrency": "Rupee",
    "intoCurrency": "USD"
    },
    "totalNetFreight": 9.56,
    "totalNetFedExCharge": 88.56,
    "shipmentLegRateDetails":
    [
    {
    "rateZone": "rateZone",
    "pricingCode": "pricingCode",
    "taxes":
    [
    {
    "amount": 10,
    "level": "level",
    "description": "description",
    "type": "type"
    }
    ],
    "totalDimWeight":
    {
    "units": "KG",
    "value": 68
    },
    "totalRebates": 2,
    "fuelSurchargePercent": 6,
    "currencyExchangeRate":
    {
    "rate": 25.6,
    "fromCurrency": "Rupee",
    "intoCurrency": "USD"
    },
    "dimDivisor": 6,
    "rateType": "PAYOR_RETAIL_PACKAGE",
    "legDestinationLocationId": "legDestinationLocationId",
    "dimDivisorType": "dimDivisorType",
    "totalBaseCharge": 6,
    "ratedWeightMethod": "ratedWeightMethod",
    "totalFreightDiscounts": 9,
    "totalTaxes": 12.6,
    "minimumChargeType": "minimumChargeType",
    "totalDutiesAndTaxes": 17.78,
    "totalNetFreight": 6,
    "totalNetFedExCharge": 3.2,
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "totalSurcharges": 5,
    "totalBillingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "freightDiscounts":
    [
    {
    "amount": 8.9,
    "rateDiscountType": "COUPON",
    "percent": 28.9,
    "description": "description"
    }
    ],
    "rateScale": "6702",
    "totalNetCharge": 25.3,
    "totalNetChargeWithDutiesAndTaxes": 25.67,
    "currency": "USD"
    }
    ],
    "dimDivisor": 0,
    "rateType": "RATED_ACCOUNT_SHIPMENT",
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "totalSurcharges": 9.88,
    "totalBillingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "freightDiscounts":
    [
    {
    "amount": 8.9,
    "rateDiscountType": "COUPON",
    "percent": 28.9,
    "description": "description"
    }
    ],
    "rateScale": "00000",
    "totalNetCharge": 3.78,
    "totalBaseCharge": 234.56,
    "totalNetChargeWithDutiesAndTaxes": 222.56,
    "currency": "USD"
    }
    ]
    },
    "documentRequirements":
    {
    "requiredDocuments":
    [
    "COMMERCIAL_OR_PRO_FORMA_INVOICE",
    "AIR_WAYBILL"
    ],
    "prohibitedDocuments":
    [
    "CERTIFICATE_OF_ORIGIN"
    ],
    "generationDetails":
    [
    {
    "type": "COMMERCIAL_INVOICE",
    "minimumCopiesRequired": 3,
    "letterhead": "OPTIONAL",
    "electronicSignature": "OPTIONAL"
    }
    ]
    },
    "exportComplianceStatement": "12345678901234567",
    "accessDetail":
    {
    "accessorDetails":
    [
    {
    "password": "password",
    "role": "role",
    "emailLabelUrl": "emailLabelUrl",
    "userId": "userId"
    }
    ]
    }
    },
    "shipmentAdvisoryDetails":
    {
    "regulatoryAdvisory":
    {
    "commodityClarifications":
    [
    {
    "commodityIndex": 25,
    "suggestions":
    [
    {
    "description": "description",
    "harmonizedCode": "harmonized Code"
    }
    ]
    }
    ],
    "prohibitions":
    [
    {
    "derivedHarmonizedCode": "01",
    "advisory":
    {
    "code": "code",
    "text": "Text",
    "parameters":
    [
    {
    "id": "message ID",
    "value": "Message value"
    }
    ],
    "localizedText": "localizedText"
    },
    "commodityIndex": 12,
    "source": "source",
    "categories":
    [
    "categories"
    ],
    "type": "type",
    "waiver":
    {
    "advisories":
    [
    {
    "code": "code",
    "text": "Text",
    "parameters":
    [
    {
    "id": "message ID",
    "value": "Message value"
    }
    ],
    "localizedText": "localizedText"
    }
    ],
    "description": "description",
    "id": "id"
    },
    "status": "status"
    }
    ]
    }
    },
    "masterTrackingNumber": "794953535000"
    }
  ],
- "alerts":
  [
  - {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
  ]
}

}

Confirm Open Shipment

Use this endpoint to validate and upload the Open Ship shipment data to FedEx Systems once all packages are added in the Shipment request.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters

x-customer-transaction-id	string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
x-locale	string Example: en_US This indicates the combination of language code and country code. Click here to see Locales
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

FullSchema-confirmOpenShipment
MinimumSamplePayload-confirmOpenShipment

labelResponseOptions required	string (LABELRESPONSEOPTIONS) Enum: "URL_ONLY" "LABEL" Specify whether the encoded bytecode or the label URL to be returned in the response. Valid values: LABEL – Indicates request is for encoded bytecode. URL_ONLY – Indicates label URL request. Note: For asynchronous shipment (More than 40 packages) request only the value LABEL is suported. Note: With URL_ONLY option, the URL once created will be active for 12 hours.
edtRequestType	string Enum: "ALL" "NONE" Indicate whether to have estimated duties and taxes provided with the rate quotes on this shipment. Only applies for International Shipment.
labelSpecification required	object (LabelSpecification) These are label specification details includes the image type, printer format, and label stock for label. Can also specify specific details such as doc-tab content, regulatory labels, and masking data on the label.
index required	string This is a unique value assigned to the already created Open Shipment. If this isn’t available then provide the master tracking number. Example: Test1234
shippingDocumentSpecification	object (ShippingDocumentSpecification) Use this object to provide all data required for additional (non-label) shipping documents to be produced.
accountNumber required	object (AccountNumber) The account number associated with the shipment. Example: Your account number

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /ship/v1/openshipments/

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/openshipments/

Production Server

https://apis.fedex.com/ship/v1/openshipments/

Request samples

Payload

Content type

application/json

Example

Copy

Expand all Collapse all

{

"labelResponseOptions": "LABEL",
"edtRequestType": "ALL",
"labelSpecification":
{
- "labelFormatType": "COMMON2D",
- "labelOrder": "SHIPPING_LABEL_FIRST",
- "customerSpecifiedDetail":
  {
  - "maskedData":
    [
    "[\"CUSTOMS_VALUE\",\"TOTAL_WEIGHT\"]"
    ],
  - "regulatoryLabels":
    [
    {
    "generationOptions": "CONTENT_ON_SHIPPING_LABEL_ONLY",
    "type": "ALCOHOL_SHIPMENT_LABEL"
    }
    ],
  - "additionalLabels":
    [
    {
    "type": "CONSIGNEE",
    "count": 1
    }
    ],
  - "docTabContent":
    {
    "docTabContentType": "BARCODED",
    "zone001":
    {
    "docTabZoneSpecifications":
    [
    {
    "zoneNumber": 0,
    "header": "string",
    "dataField": "string",
    "literalValue": "string",
    "justification": "RIGHT"
    }
    ]
    },
    "barcoded":
    {
    "symbology": "UCC128",
    "specification":
    {
    "zoneNumber": 0,
    "header": "string",
    "dataField": "string",
    "literalValue": "string",
    "justification": "RIGHT"
    }
    }
    }
  },
- "printedLabelOrigin":
  {
  - "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
  - "contact":
    {
    "personName": "person name",
    "emailAddress": "email address",
    "phoneNumber": "phone number",
    "phoneExtension": "phone extension",
    "companyName": "company name",
    "faxNumber": "fax number"
    }
  },
- "labelStockType": "PAPER_85X11_TOP_HALF_LABEL",
- "labelRotation": "UPSIDE_DOWN",
- "imageType": "PDF",
- "labelPrintingOrientation": "TOP_EDGE_OF_TEXT_FIRST",
- "returnedDispositionDetail": true,
- "resolution": 300
},
"index": "Test1234",
"shippingDocumentSpecification":
{
- "generalAgencyAgreementDetail":
  {
  - "documentFormat":
    {
    "provideInstructions": true,
    "optionsRequested":
    {
    "options":
    [
    "SUPPRESS_ADDITIONAL_LANGUAGES",
    "SHIPPING_LABEL_LAST"
    ]
    },
    "stockType": "PAPER_LETTER",
    "dispositions":
    [
    {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THIRD_PARTY"
    }
    ],
    "locale": "en_US",
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED"
    }
    ],
    "locale": "en_US",
    "docType": "PDF"
    }
  },
- "returnInstructionsDetail":
  {
  - "customText": "This is additional text printed on Return instr",
  - "documentFormat":
    {
    "provideInstructions": true,
    "optionsRequested":
    {
    "options":
    [
    "SUPPRESS_ADDITIONAL_LANGUAGES",
    "SHIPPING_LABEL_LAST"
    ]
    },
    "stockType": "PAPER_LETTER",
    "dispositions":
    [
    {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THIRD_PARTY"
    }
    ],
    "locale": "en_US",
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED"
    }
    ],
    "locale": "en_US\"",
    "docType": "PNG"
    }
  },
- "op900Detail":
  {
  - "customerImageUsages":
    [
    {
    "id": "IMAGE_5",
    "type": "SIGNATURE",
    "providedImageType": "LETTER_HEAD"
    }
    ],
  - "signatureName": "Signature Name",
  - "documentFormat":
    {
    "provideInstructions": true,
    "optionsRequested":
    {
    "options":
    [
    "SUPPRESS_ADDITIONAL_LANGUAGES",
    "SHIPPING_LABEL_LAST"
    ]
    },
    "stockType": "PAPER_LETTER",
    "dispositions":
    [
    {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THIRD_PARTY"
    }
    ],
    "locale": "en_US",
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED"
    }
    ],
    "locale": "en_US",
    "docType": "PDF"
    }
  },
- "usmcaCertificationOfOriginDetail":
  {
  - "customerImageUsages":
    [
    {
    "id": "IMAGE_5",
    "type": "SIGNATURE",
    "providedImageType": "LETTER_HEAD"
    }
    ],
  - "documentFormat":
    {
    "provideInstructions": true,
    "optionsRequested":
    {
    "options":
    [
    "SUPPRESS_ADDITIONAL_LANGUAGES",
    "SHIPPING_LABEL_LAST"
    ]
    },
    "stockType": "PAPER_LETTER",
    "dispositions":
    [
    {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THIRD_PARTY"
    }
    ],
    "locale": "en_US",
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED"
    }
    ],
    "locale": "en_US",
    "docType": "PDF"
    },
  - "certifierSpecification": "EXPORTER",
  - "importerSpecification": "UNKNOWN",
  - "producerSpecification": "SAME_AS_EXPORTER",
  - "producer":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "000",
    "phoneNumber": "XXXX345671",
    "companyName": "Fedex"
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "tins":
    [
    {
    "number": "123567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ]
    },
  - "blanketPeriod":
    {
    "begins": "22-01-2020",
    "ends": "2-01-2020"
    },
  - "certifierJobTitle": "Manager"
  },
- "usmcaCommercialInvoiceCertificationOfOriginDetail":
  {
  - "customerImageUsages":
    [
    {
    "id": "IMAGE_5",
    "type": "SIGNATURE",
    "providedImageType": "LETTER_HEAD"
    }
    ],
  - "documentFormat":
    {
    "provideInstructions": true,
    "optionsRequested":
    {
    "options":
    [
    "SUPPRESS_ADDITIONAL_LANGUAGES",
    "SHIPPING_LABEL_LAST"
    ]
    },
    "stockType": "PAPER_LETTER",
    "dispositions":
    [
    {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THIRD_PARTY"
    }
    ],
    "locale": "en_US",
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED"
    }
    ],
    "locale": "en_US",
    "docType": "PDF"
    },
  - "certifierSpecification": "EXPORTER",
  - "importerSpecification": "UNKNOWN",
  - "producerSpecification": "SAME_AS_EXPORTER",
  - "producer":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "000",
    "phoneNumber": "XXXX345671",
    "companyName": "Fedex"
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "tins":
    [
    {
    "number": "123567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ]
    },
  - "certifierJobTitle": "Manager"
  },
- "shippingDocumentTypes":
  [
  - "RETURN_INSTRUCTIONS"
  ],
- "certificateOfOrigin":
  {
  - "customerImageUsages":
    [
    {
    "id": "IMAGE_5",
    "type": "SIGNATURE",
    "providedImageType": "LETTER_HEAD"
    }
    ],
  - "documentFormat":
    {
    "provideInstructions": true,
    "optionsRequested":
    {
    "options":
    [
    "SUPPRESS_ADDITIONAL_LANGUAGES",
    "SHIPPING_LABEL_LAST"
    ]
    },
    "stockType": "PAPER_LETTER",
    "dispositions":
    [
    {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THIRD_PARTY"
    }
    ],
    "locale": "en_US",
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED"
    }
    ],
    "locale": "en_US",
    "docType": "PDF"
    }
  },
- "commercialInvoiceDetail":
  {
  - "customerImageUsages":
    [
    {
    "id": "IMAGE_5",
    "type": "SIGNATURE",
    "providedImageType": "LETTER_HEAD"
    }
    ],
  - "documentFormat":
    {
    "provideInstructions": true,
    "optionsRequested":
    {
    "options":
    [
    "SUPPRESS_ADDITIONAL_LANGUAGES",
    "SHIPPING_LABEL_LAST"
    ]
    },
    "stockType": "PAPER_LETTER",
    "dispositions":
    [
    {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THIRD_PARTY"
    }
    ],
    "locale": "en_US",
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED"
    }
    ],
    "locale": "en_US",
    "docType": "PDF"
    }
  }
},
"accountNumber":
{
- "value": "Your account number"
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "string",
"customerTransactionId": "AnyCo_order123456789",
"output":
{
- "jobId": "abc123456",
- "transactionShipments":
  [
  - {
    "serviceType": "STANDARD_OVERNIGHT",
    "shipDatestamp": "2010-03-04",
    "serviceCategory": "EXPRESS",
    "shipmentDocuments":
    [
    {
    "contentKey": "content key",
    "copiesToPrint": 10,
    "contentType": "COMMERCIAL_INVOICE",
    "trackingNumber": "794953535000",
    "docType": "PDF",
    "alerts":
    [
    {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
    ],
    "encodedLabel": "encoded label",
    "url": "https://wwwdev.idev.fedex.com/document/v2/document/retrieve/SH,794810209259_SHIPPING_P/isLabel=true&autoPrint=false"
    }
    ],
    "pieceResponses":
    [
    {
    "netChargeAmount": 21.45,
    "transactionDetails":
    [
    {
    "transactionDetails": "transactionDetails",
    "transactionId": "12345"
    }
    ],
    "packageDocuments":
    [
    {
    "contentKey": "content key",
    "copiesToPrint": 10,
    "contentType": "COMMERCIAL_INVOICE",
    "trackingNumber": "794953535000",
    "docType": "PDF",
    "alerts":
    [
    {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
    ],
    "encodedLabel": "encoded label",
    "url": "https://wwwdev.idev.fedex.com/document/v2/document/retrieve/SH,794810209259_SHIPPING_P/isLabel=true&autoPrint=false"
    }
    ],
    "acceptanceTrackingNumber": "794953535000",
    "serviceCategory": "EXPRESS",
    "listCustomerTotalCharge": "listCustomerTotalCharge",
    "deliveryTimestamp": "2012-09-23",
    "trackingIdType": "FEDEX",
    "additionalChargesDiscount": 621.45,
    "netListRateAmount": 1.45,
    "baseRateAmount": 321.45,
    "packageSequenceNumber": 215,
    "netDiscountAmount": 121.45,
    "codcollectionAmount": 231.45,
    "masterTrackingNumber": "794953535000",
    "acceptanceType": "acceptanceType",
    "trackingNumber": "794953535000",
    "successful": true,
    "customerReferences":
    [
    {
    "customerReferenceType": "INVOICE_NUMBER",
    "value": "3686"
    }
    ]
    }
    ],
    "serviceName": "FedEx 2 Day Freight",
    "alerts":
    [
    {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
    ],
    "completedShipmentDetail":
    {
    "completedPackageDetails":
    [
    {
    "sequenceNumber": 256,
    "operationalDetail":
    {
    "astraHandlingText": "astraHandlingText",
    "barcodes":
    {
    "binaryBarcodes":
    [
    {
    "type": "COMMON-2D",
    "value": "string"
    }
    ],
    "stringBarcodes":
    [
    {
    "type": "ADDRESS",
    "value": "1010062512241535917900794953544894"
    }
    ]
    },
    "operationalInstructions":
    [
    {
    "number": 17,
    "content": "content"
    }
    ]
    },
    "signatureOption": "DIRECT",
    "trackingIds":
    [
    {
    "formId": "0201",
    "trackingIdType": "EXPRESS",
    "uspsApplicationId": "92",
    "trackingNumber": "49092000070120032835"
    }
    ],
    "groupNumber": 567,
    "oversizeClass": "OVERSIZE_1, OVERSIZE_2, OVERSIZE_3",
    "packageRating":
    {
    "effectiveNetDiscount": 0,
    "actualRateType": "PAYOR_ACCOUNT_PACKAGE",
    "packageRateDetails":
    [
    {
    "ratedWeightMethod": "DIM",
    "totalFreightDiscounts": 44.55,
    "totalTaxes": 3.45,
    "minimumChargeType": "minimumChargeType",
    "baseCharge": 45.67,
    "totalRebates": 4.56,
    "rateType": "PAYOR_RETAIL_PACKAGE",
    "billingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "netFreight": 4.89,
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "totalSurcharges": 22.56,
    "netFedExCharge": 12.56,
    "netCharge": 121.56,
    "currency": "USD"
    }
    ]
    },
    "dryIceWeight":
    {
    "units": "KG",
    "value": 68
    },
    "hazardousPackageDetail":
    {
    "regulation": "IATA",
    "accessibility": "ACCESSIBLE",
    "labelType": "II_YELLOW",
    "containers":
    [
    {
    "qvalue": 2,
    "hazardousCommodities":
    [
    {
    "quantity":
    {
    "quantityType": "GROSS",
    "amount": 24.56,
    "units": "Kg"
    },
    "options":
    {
    "quantity":
    {
    "quantityType": "GROSS",
    "amount": 24.56,
    "units": "Kg"
    },
    "innerReceptacles":
    [
    {
    "quantity":
    {
    "quantityType": "NET",
    "amount": 34.56,
    "units": "Kg"
    }
    }
    ],
    "options":
    {
    "labelTextOption": "APPEND",
    "customerSuppliedLabelText": "Customer Supplied Label Text."
    },
    "description":
    {
    "sequenceNumber": 9812,
    "processingOptions":
    [
    "INCLUDE_SPECIAL_PROVISIONS"
    ],
    "subsidiaryClasses":
    [
    "Subsidiary Classes"
    ],
    "labelText": "labelText",
    "technicalName": "technicalName",
    "packingDetails":
    {
    "packingInstructions": "packing Instructions",
    "cargoAircraftOnly": true
    },
    "authorization": "authorization",
    "reportableQuantity": true,
    "percentage": 12.45,
    "id": "123",
    "packingGroup": "I",
    "properShippingName": "properShippingName",
    "hazardClass": "hazard Class"
    }
    },
    "description":
    {
    "sequenceNumber": 876,
    "packingInstructions": "packingInstructions",
    "subsidiaryClasses":
    [
    "Subsidiary Classes"
    ],
    "labelText": "labelText",
    "tunnelRestrictionCode": "UN2919",
    "specialProvisions": "specialProvisions",
    "properShippingNameAndDescription": "properShippingNameAndDescription",
    "technicalName": "technicalName",
    "symbols": "symbols",
    "authorization": "authorization",
    "attributes":
    [
    "attributes"
    ],
    "id": "1234",
    "packingGroup": "packingGroup",
    "properShippingName": "properShippingName",
    "hazardClass": "hazardClass"
    },
    "netExplosiveDetail":
    {
    "amount": 10,
    "units": "units",
    "type": "NET_EXPLOSIVE_WEIGHT"
    },
    "massPoints": 2
    }
    ]
    }
    ],
    "cargoAircraftOnly": true,
    "referenceId": "123456",
    "radioactiveTransportIndex": 2.45
    }
    }
    ],
    "operationalDetail":
    {
    "originServiceArea": "A1",
    "serviceCode": "010",
    "airportId": "DFW",
    "postalCode": "38010",
    "scac": "scac",
    "deliveryDay": "TUE",
    "originLocationId": "678",
    "countryCode": "US",
    "astraDescription": "SMART POST",
    "originLocationNumber": 243,
    "deliveryDate": "2001-04-05",
    "deliveryEligibilities":
    [
    "deliveryEligibilities"
    ],
    "ineligibleForMoneyBackGuarantee": true,
    "maximumTransitTime": "SEVEN_DAYS",
    "destinationLocationStateOrProvinceCode": "GA",
    "astraPlannedServiceLevel": "TUE - 15 OCT 10:30A",
    "destinationLocationId": "DALA",
    "transitTime": "TWO_DAYS",
    "stateOrProvinceCode": "GA",
    "destinationLocationNumber": 876,
    "packagingCode": "03",
    "commitDate": "2019-10-15",
    "publishedDeliveryTime": "10:30A",
    "ursaSuffixCode": "Ga",
    "ursaPrefixCode": "XH",
    "destinationServiceArea": "A1",
    "commitDay": "TUE",
    "customTransitTime": "ONE_DAY"
    },
    "carrierCode": "FDXE",
    "completedHoldAtLocationDetail":
    {
    "holdingLocationType": "FEDEX_STAFFED",
    "holdingLocation":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "tollFreePhoneNumber": "6127812",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": "91",
    "faxNumber": "1234567890",
    "pagerNumber": "6127812",
    "companyName": "Fedex",
    "title": "title"
    }
    }
    },
    "completedEtdDetail":
    {
    "folderId": "0b0493e580dc1a1b",
    "type": "COMMERCIAL_INVOICE",
    "uploadDocumentReferenceDetails":
    [
    {
    "documentType": "PRO_FORMA_INVOICE",
    "documentReference": "DocumentReference",
    "description": "PRO FORMA INVOICE",
    "documentId": "090927d680038c61"
    }
    ]
    },
    "packagingDescription": "description",
    "masterTrackingId":
    {
    "formId": "0201",
    "trackingIdType": "EXPRESS",
    "uspsApplicationId": "92",
    "trackingNumber": "49092000070120032835"
    },
    "serviceDescription":
    {
    "serviceType": "FEDEX_1_DAY_FREIGHT",
    "code": "80",
    "names":
    [
    {
    "type": "long",
    "encoding": "UTF-8",
    "value": "F-2"
    }
    ],
    "operatingOrgCodes":
    [
    "FXE"
    ],
    "astraDescription": "2 DAY FRT",
    "description": "description",
    "serviceId": "EP1000000027",
    "serviceCategory": "freight"
    },
    "usDomestic": true,
    "hazardousShipmentDetail":
    {
    "hazardousSummaryDetail":
    {
    "smallQuantityExceptionPackageCount": 10
    },
    "adrLicense":
    {
    "licenseOrPermitDetail":
    {
    "number": "12345",
    "effectiveDate": "2019-08-09",
    "expirationDate": "2019-04-09"
    }
    },
    "dryIceDetail":
    {
    "totalWeight":
    {
    "units": "KG",
    "value": 68
    },
    "packageCount": 10,
    "processingOptions":
    {
    "options":
    [
    "options"
    ]
    }
    }
    },
    "shipmentRating":
    {
    "actualRateType": "PAYOR_LIST_SHIPMENT",
    "shipmentRateDetails":
    [
    {
    "rateZone": "US001O",
    "ratedWeightMethod": "ACTUAL",
    "totalDutiesTaxesAndFees": 24.56,
    "pricingCode": "LTL_FREIGHT",
    "totalFreightDiscounts": 1.56,
    "totalTaxes": 3.45,
    "totalDutiesAndTaxes": 6.78,
    "totalAncillaryFeesAndTaxes": 5.67,
    "taxes":
    [
    {
    "amount": 10,
    "level": "level",
    "description": "description",
    "type": "type"
    }
    ],
    "totalRebates": 1.98,
    "fuelSurchargePercent": 4.56,
    "currencyExchangeRate":
    {
    "rate": 25.6,
    "fromCurrency": "Rupee",
    "intoCurrency": "USD"
    },
    "totalNetFreight": 9.56,
    "totalNetFedExCharge": 88.56,
    "shipmentLegRateDetails":
    [
    {
    "rateZone": "rateZone",
    "pricingCode": "pricingCode",
    "taxes":
    [
    {
    "amount": 10,
    "level": "level",
    "description": "description",
    "type": "type"
    }
    ],
    "totalDimWeight":
    {
    "units": "KG",
    "value": 68
    },
    "totalRebates": 2,
    "fuelSurchargePercent": 6,
    "currencyExchangeRate":
    {
    "rate": 25.6,
    "fromCurrency": "Rupee",
    "intoCurrency": "USD"
    },
    "dimDivisor": 6,
    "rateType": "PAYOR_RETAIL_PACKAGE",
    "legDestinationLocationId": "legDestinationLocationId",
    "dimDivisorType": "dimDivisorType",
    "totalBaseCharge": 6,
    "ratedWeightMethod": "ratedWeightMethod",
    "totalFreightDiscounts": 9,
    "totalTaxes": 12.6,
    "minimumChargeType": "minimumChargeType",
    "totalDutiesAndTaxes": 17.78,
    "totalNetFreight": 6,
    "totalNetFedExCharge": 3.2,
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "totalSurcharges": 5,
    "totalBillingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "freightDiscounts":
    [
    {
    "amount": 8.9,
    "rateDiscountType": "COUPON",
    "percent": 28.9,
    "description": "description"
    }
    ],
    "rateScale": "6702",
    "totalNetCharge": 25.3,
    "totalNetChargeWithDutiesAndTaxes": 25.67,
    "currency": "USD"
    }
    ],
    "dimDivisor": 0,
    "rateType": "RATED_ACCOUNT_SHIPMENT",
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "totalSurcharges": 9.88,
    "totalBillingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "freightDiscounts":
    [
    {
    "amount": 8.9,
    "rateDiscountType": "COUPON",
    "percent": 28.9,
    "description": "description"
    }
    ],
    "rateScale": "00000",
    "totalNetCharge": 3.78,
    "totalBaseCharge": 234.56,
    "totalNetChargeWithDutiesAndTaxes": 222.56,
    "currency": "USD"
    }
    ]
    },
    "documentRequirements":
    {
    "requiredDocuments":
    [
    "COMMERCIAL_OR_PRO_FORMA_INVOICE",
    "AIR_WAYBILL"
    ],
    "prohibitedDocuments":
    [
    "CERTIFICATE_OF_ORIGIN"
    ],
    "generationDetails":
    [
    {
    "type": "COMMERCIAL_INVOICE",
    "minimumCopiesRequired": 3,
    "letterhead": "OPTIONAL",
    "electronicSignature": "OPTIONAL"
    }
    ]
    },
    "exportComplianceStatement": "12345678901234567",
    "accessDetail":
    {
    "accessorDetails":
    [
    {
    "password": "password",
    "role": "role",
    "emailLabelUrl": "emailLabelUrl",
    "userId": "userId"
    }
    ]
    }
    },
    "shipmentAdvisoryDetails":
    {
    "regulatoryAdvisory":
    {
    "commodityClarifications":
    [
    {
    "commodityIndex": 25,
    "suggestions":
    [
    {
    "description": "description",
    "harmonizedCode": "harmonized Code"
    }
    ]
    }
    ],
    "prohibitions":
    [
    {
    "derivedHarmonizedCode": "01",
    "advisory":
    {
    "code": "code",
    "text": "Text",
    "parameters":
    [
    {
    "id": "message ID",
    "value": "Message value"
    }
    ],
    "localizedText": "localizedText"
    },
    "commodityIndex": 12,
    "source": "source",
    "categories":
    [
    "categories"
    ],
    "type": "type",
    "waiver":
    {
    "advisories":
    [
    {
    "code": "code",
    "text": "Text",
    "parameters":
    [
    {
    "id": "message ID",
    "value": "Message value"
    }
    ],
    "localizedText": "localizedText"
    }
    ],
    "description": "description",
    "id": "id"
    },
    "status": "status"
    }
    ]
    }
    },
    "masterTrackingNumber": "794953535000"
    }
  ],
- "alerts":
  [
  - {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
  ]
}

}

Modify Open Shipment Packages

This endpoint helps you to modify packages in Open Shipment request with the required shipping information before the shipment is confirmed.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters

x-customer-transaction-id	string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
x-locale	string Example: en_US This indicates the combination of language code and country code. Click here to see Locales
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

FullSchema-modifyPackageInOpenShipment
MinimumSamplePayload-modifyPackageInOpenShipment

requestedPackageLineItem required	object Contains the data for the package that is to be modified in the open shipment.
index required	string This is a unique value assigned to the already created Open Shipment. If this isn’t available then provide the master tracking number. Example: Test1234
shipAction	string Enum: "STRONG_VALIDATION" "WEAK_VALIDATION" "CREATE_PACKAGE" Allowed values are STRONG_VALIDATION
accountNumber required	object (AccountNumber) The account number associated with the shipment. Example: Your account number
trackingId required	object (TrackingId) Indicates the tracking details for the package.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

put /ship/v1/openshipments/packages

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/openshipments/packages

Production Server

https://apis.fedex.com/ship/v1/openshipments/packages

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"requestedPackageLineItem":
{
- "sequenceNumber": "1",
- "subPackagingType": "BUCKET",
- "customerReferences":
  [
  - {
    "customerReferenceType": "INVOICE_NUMBER",
    "value": "3686"
    }
  ],
- "declaredValue":
  {
  - "amount": 12.45,
  - "currency": "USD"
  },
- "weight":
  {
  - "units": "KG",
  - "value": 68.25
  },
- "dimensions":
  {
  - "length": 100,
  - "width": 50,
  - "height": 30,
  - "units": "CM"
  },
- "groupPackageCount": 2,
- "itemDescriptionForClearance": "description",
- "contentRecord":
  [
  - {
    "itemNumber": "2876",
    "receivedQuantity": 256,
    "description": "Description",
    "partNumber": "456"
    }
  ],
- "itemDescription": "item description for the package",
- "variableHandlingChargeDetail":
  {
  - "rateType": "PREFERRED_CURRENCY",
  - "percentValue": 12.45,
  - "rateLevelType": "INDIVIDUAL_PACKAGE_RATE",
  - "fixedValue":
    {
    "amount": 24.45,
    "currency": "USD"
    },
  - "rateElementBasis": "NET_CHARGE_EXCLUDING_TAXES"
  },
- "packageSpecialServices":
  {
  - "specialServiceTypes":
    [
    "ALCOHOL",
    "NON_STANDARD_CONTAINER"
    ],
  - "signatureOptionType": "SERVICE_DEFAULT",
  - "priorityAlertDetail":
    {
    "enhancementTypes":
    [
    "PRIORITY_ALERT_PLUS"
    ],
    "content":
    [
    "string"
    ]
    },
  - "signatureOptionDetail":
    {
    "signatureReleaseNumber": "23456"
    },
  - "alcoholDetail":
    {
    "alcoholRecipientType": "LICENSEE",
    "shipperAgreementType": "Retailer"
    },
  - "dangerousGoodsDetail":
    {
    "accessibility": "INACCESSIBLE",
    "cargoAircraftOnly": false,
    "regulation": "ADR",
    "options":
    [
    "LIMITED_QUANTITIES_COMMODITIES",
    "ORM_D"
    ]
    },
  - "packageCODDetail":
    {
    "codCollectionAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    },
  - "pieceCountVerificationBoxCount": 0,
  - "batteryDetails":
    [
    {
    "batteryPackingType": "CONTAINED_IN_EQUIPMENT",
    "batteryRegulatoryType": "IATA_SECTION_II",
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ],
  - "dryIceWeight":
    {
    "units": "KG",
    "value": 68.25
    },
  - "standaloneBatteryDetails":
    [
    {
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ]
  }
},
"index": "Test1234",
"shipAction": "STRONG_VALIDATION",
"accountNumber":
{
- "value": "Your account number"
},
"trackingId":
{
- "formId": "0201",
- "trackingIdType": "EXPRESS",
- "uspsApplicationId": "92",
- "trackingNumber": "49092000070120032835"
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "624deea6-b709-470c-8c39-4b5511281492",
"customerTransactionId": "AnyCo_order123456789",
"output":
{
- "transactionShipments":
  [
  - {
    "serviceType": "STANDARD_OVERNIGHT",
    "shipDatestamp": "2010-03-04",
    "serviceCategory": "EXPRESS",
    "shipmentDocuments":
    [
    {
    "contentKey": "content key",
    "copiesToPrint": 10,
    "contentType": "COMMERCIAL_INVOICE",
    "trackingNumber": "794953535000",
    "docType": "PDF",
    "alerts":
    [
    {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
    ],
    "encodedLabel": "encoded label",
    "url": "https://wwwdev.idev.fedex.com/document/v2/document/retrieve/SH,794810209259_SHIPPING_P/isLabel=true&autoPrint=false"
    }
    ],
    "pieceResponses":
    [
    {
    "netChargeAmount": 21.45,
    "transactionDetails":
    [
    {
    "transactionDetails": "transactionDetails",
    "transactionId": "12345"
    }
    ],
    "packageDocuments":
    [
    {
    "contentKey": "content key",
    "copiesToPrint": 10,
    "contentType": "COMMERCIAL_INVOICE",
    "trackingNumber": "794953535000",
    "docType": "PDF",
    "alerts":
    [
    {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
    ],
    "encodedLabel": "encoded label",
    "url": "https://wwwdev.idev.fedex.com/document/v2/document/retrieve/SH,794810209259_SHIPPING_P/isLabel=true&autoPrint=false"
    }
    ],
    "acceptanceTrackingNumber": "794953535000",
    "serviceCategory": "EXPRESS",
    "listCustomerTotalCharge": "listCustomerTotalCharge",
    "deliveryTimestamp": "2012-09-23",
    "trackingIdType": "FEDEX",
    "additionalChargesDiscount": 621.45,
    "netListRateAmount": 1.45,
    "baseRateAmount": 321.45,
    "packageSequenceNumber": 215,
    "netDiscountAmount": 121.45,
    "codcollectionAmount": 231.45,
    "masterTrackingNumber": "794953535000",
    "acceptanceType": "acceptanceType",
    "trackingNumber": "794953535000",
    "successful": true,
    "customerReferences":
    [
    {
    "customerReferenceType": "INVOICE_NUMBER",
    "value": "3686"
    }
    ]
    }
    ],
    "serviceName": "FedEx 2 Day Freight",
    "alerts":
    [
    {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
    ],
    "completedShipmentDetail":
    {
    "completedPackageDetails":
    [
    {
    "sequenceNumber": 256,
    "operationalDetail":
    {
    "astraHandlingText": "astraHandlingText",
    "barcodes":
    {
    "binaryBarcodes":
    [
    {
    "type": "COMMON-2D",
    "value": "string"
    }
    ],
    "stringBarcodes":
    [
    {
    "type": "ADDRESS",
    "value": "1010062512241535917900794953544894"
    }
    ]
    },
    "operationalInstructions":
    [
    {
    "number": 17,
    "content": "content"
    }
    ]
    },
    "signatureOption": "DIRECT",
    "trackingIds":
    [
    {
    "formId": "0201",
    "trackingIdType": "EXPRESS",
    "uspsApplicationId": "92",
    "trackingNumber": "49092000070120032835"
    }
    ],
    "groupNumber": 567,
    "oversizeClass": "OVERSIZE_1, OVERSIZE_2, OVERSIZE_3",
    "packageRating":
    {
    "effectiveNetDiscount": 0,
    "actualRateType": "PAYOR_ACCOUNT_PACKAGE",
    "packageRateDetails":
    [
    {
    "ratedWeightMethod": "DIM",
    "totalFreightDiscounts": 44.55,
    "totalTaxes": 3.45,
    "minimumChargeType": "minimumChargeType",
    "baseCharge": 45.67,
    "totalRebates": 4.56,
    "rateType": "PAYOR_RETAIL_PACKAGE",
    "billingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "netFreight": 4.89,
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "totalSurcharges": 22.56,
    "netFedExCharge": 12.56,
    "netCharge": 121.56,
    "currency": "USD"
    }
    ]
    },
    "dryIceWeight":
    {
    "units": "KG",
    "value": 68
    },
    "hazardousPackageDetail":
    {
    "regulation": "IATA",
    "accessibility": "ACCESSIBLE",
    "labelType": "II_YELLOW",
    "containers":
    [
    {
    "qvalue": 2,
    "hazardousCommodities":
    [
    {
    "quantity":
    {
    "quantityType": "GROSS",
    "amount": 24.56,
    "units": "Kg"
    },
    "options":
    {
    "quantity":
    {
    "quantityType": "GROSS",
    "amount": 24.56,
    "units": "Kg"
    },
    "innerReceptacles":
    [
    {
    "quantity":
    {
    "quantityType": "NET",
    "amount": 34.56,
    "units": "Kg"
    }
    }
    ],
    "options":
    {
    "labelTextOption": "APPEND",
    "customerSuppliedLabelText": "Customer Supplied Label Text."
    },
    "description":
    {
    "sequenceNumber": 9812,
    "processingOptions":
    [
    "INCLUDE_SPECIAL_PROVISIONS"
    ],
    "subsidiaryClasses":
    [
    "Subsidiary Classes"
    ],
    "labelText": "labelText",
    "technicalName": "technicalName",
    "packingDetails":
    {
    "packingInstructions": "packing Instructions",
    "cargoAircraftOnly": true
    },
    "authorization": "authorization",
    "reportableQuantity": true,
    "percentage": 12.45,
    "id": "123",
    "packingGroup": "I",
    "properShippingName": "properShippingName",
    "hazardClass": "hazard Class"
    }
    },
    "description":
    {
    "sequenceNumber": 876,
    "packingInstructions": "packingInstructions",
    "subsidiaryClasses":
    [
    "Subsidiary Classes"
    ],
    "labelText": "labelText",
    "tunnelRestrictionCode": "UN2919",
    "specialProvisions": "specialProvisions",
    "properShippingNameAndDescription": "properShippingNameAndDescription",
    "technicalName": "technicalName",
    "symbols": "symbols",
    "authorization": "authorization",
    "attributes":
    [
    "attributes"
    ],
    "id": "1234",
    "packingGroup": "packingGroup",
    "properShippingName": "properShippingName",
    "hazardClass": "hazardClass"
    },
    "netExplosiveDetail":
    {
    "amount": 10,
    "units": "units",
    "type": "NET_EXPLOSIVE_WEIGHT"
    },
    "massPoints": 2
    }
    ]
    }
    ],
    "cargoAircraftOnly": true,
    "referenceId": "123456",
    "radioactiveTransportIndex": 2.45
    }
    }
    ],
    "operationalDetail":
    {
    "originServiceArea": "A1",
    "serviceCode": "010",
    "airportId": "DFW",
    "postalCode": "38010",
    "scac": "scac",
    "deliveryDay": "TUE",
    "originLocationId": "678",
    "countryCode": "US",
    "astraDescription": "SMART POST",
    "originLocationNumber": 243,
    "deliveryDate": "2001-04-05",
    "deliveryEligibilities":
    [
    "deliveryEligibilities"
    ],
    "ineligibleForMoneyBackGuarantee": true,
    "maximumTransitTime": "SEVEN_DAYS",
    "destinationLocationStateOrProvinceCode": "GA",
    "astraPlannedServiceLevel": "TUE - 15 OCT 10:30A",
    "destinationLocationId": "DALA",
    "transitTime": "TWO_DAYS",
    "stateOrProvinceCode": "GA",
    "destinationLocationNumber": 876,
    "packagingCode": "03",
    "commitDate": "2019-10-15",
    "publishedDeliveryTime": "10:30A",
    "ursaSuffixCode": "Ga",
    "ursaPrefixCode": "XH",
    "destinationServiceArea": "A1",
    "commitDay": "TUE",
    "customTransitTime": "ONE_DAY"
    },
    "carrierCode": "FDXE",
    "completedHoldAtLocationDetail":
    {
    "holdingLocationType": "FEDEX_STAFFED",
    "holdingLocation":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "tollFreePhoneNumber": "6127812",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": "91",
    "faxNumber": "1234567890",
    "pagerNumber": "6127812",
    "companyName": "Fedex",
    "title": "title"
    }
    }
    },
    "completedEtdDetail":
    {
    "folderId": "0b0493e580dc1a1b",
    "type": "COMMERCIAL_INVOICE",
    "uploadDocumentReferenceDetails":
    [
    {
    "documentType": "PRO_FORMA_INVOICE",
    "documentReference": "DocumentReference",
    "description": "PRO FORMA INVOICE",
    "documentId": "090927d680038c61"
    }
    ]
    },
    "packagingDescription": "description",
    "masterTrackingId":
    {
    "formId": "0201",
    "trackingIdType": "EXPRESS",
    "uspsApplicationId": "92",
    "trackingNumber": "49092000070120032835"
    },
    "serviceDescription":
    {
    "serviceType": "FEDEX_1_DAY_FREIGHT",
    "code": "80",
    "names":
    [
    {
    "type": "long",
    "encoding": "UTF-8",
    "value": "F-2"
    }
    ],
    "operatingOrgCodes":
    [
    "FXE"
    ],
    "astraDescription": "2 DAY FRT",
    "description": "description",
    "serviceId": "EP1000000027",
    "serviceCategory": "freight"
    },
    "usDomestic": true,
    "hazardousShipmentDetail":
    {
    "hazardousSummaryDetail":
    {
    "smallQuantityExceptionPackageCount": 10
    },
    "adrLicense":
    {
    "licenseOrPermitDetail":
    {
    "number": "12345",
    "effectiveDate": "2019-08-09",
    "expirationDate": "2019-04-09"
    }
    },
    "dryIceDetail":
    {
    "totalWeight":
    {
    "units": "KG",
    "value": 68
    },
    "packageCount": 10,
    "processingOptions":
    {
    "options":
    [
    "options"
    ]
    }
    }
    },
    "shipmentRating":
    {
    "actualRateType": "PAYOR_LIST_SHIPMENT",
    "shipmentRateDetails":
    [
    {
    "rateZone": "US001O",
    "ratedWeightMethod": "ACTUAL",
    "totalDutiesTaxesAndFees": 24.56,
    "pricingCode": "LTL_FREIGHT",
    "totalFreightDiscounts": 1.56,
    "totalTaxes": 3.45,
    "totalDutiesAndTaxes": 6.78,
    "totalAncillaryFeesAndTaxes": 5.67,
    "taxes":
    [
    {
    "amount": 10,
    "level": "level",
    "description": "description",
    "type": "type"
    }
    ],
    "totalRebates": 1.98,
    "fuelSurchargePercent": 4.56,
    "currencyExchangeRate":
    {
    "rate": 25.6,
    "fromCurrency": "Rupee",
    "intoCurrency": "USD"
    },
    "totalNetFreight": 9.56,
    "totalNetFedExCharge": 88.56,
    "shipmentLegRateDetails":
    [
    {
    "rateZone": "rateZone",
    "pricingCode": "pricingCode",
    "taxes":
    [
    {
    "amount": 10,
    "level": "level",
    "description": "description",
    "type": "type"
    }
    ],
    "totalDimWeight":
    {
    "units": "KG",
    "value": 68
    },
    "totalRebates": 2,
    "fuelSurchargePercent": 6,
    "currencyExchangeRate":
    {
    "rate": 25.6,
    "fromCurrency": "Rupee",
    "intoCurrency": "USD"
    },
    "dimDivisor": 6,
    "rateType": "PAYOR_RETAIL_PACKAGE",
    "legDestinationLocationId": "legDestinationLocationId",
    "dimDivisorType": "dimDivisorType",
    "totalBaseCharge": 6,
    "ratedWeightMethod": "ratedWeightMethod",
    "totalFreightDiscounts": 9,
    "totalTaxes": 12.6,
    "minimumChargeType": "minimumChargeType",
    "totalDutiesAndTaxes": 17.78,
    "totalNetFreight": 6,
    "totalNetFedExCharge": 3.2,
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "totalSurcharges": 5,
    "totalBillingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "freightDiscounts":
    [
    {
    "amount": 8.9,
    "rateDiscountType": "COUPON",
    "percent": 28.9,
    "description": "description"
    }
    ],
    "rateScale": "6702",
    "totalNetCharge": 25.3,
    "totalNetChargeWithDutiesAndTaxes": 25.67,
    "currency": "USD"
    }
    ],
    "dimDivisor": 0,
    "rateType": "RATED_ACCOUNT_SHIPMENT",
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "totalSurcharges": 9.88,
    "totalBillingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "freightDiscounts":
    [
    {
    "amount": 8.9,
    "rateDiscountType": "COUPON",
    "percent": 28.9,
    "description": "description"
    }
    ],
    "rateScale": "00000",
    "totalNetCharge": 3.78,
    "totalBaseCharge": 234.56,
    "totalNetChargeWithDutiesAndTaxes": 222.56,
    "currency": "USD"
    }
    ]
    },
    "documentRequirements":
    {
    "requiredDocuments":
    [
    "COMMERCIAL_OR_PRO_FORMA_INVOICE",
    "AIR_WAYBILL"
    ],
    "prohibitedDocuments":
    [
    "CERTIFICATE_OF_ORIGIN"
    ],
    "generationDetails":
    [
    {
    "type": "COMMERCIAL_INVOICE",
    "minimumCopiesRequired": 3,
    "letterhead": "OPTIONAL",
    "electronicSignature": "OPTIONAL"
    }
    ]
    },
    "exportComplianceStatement": "12345678901234567",
    "accessDetail":
    {
    "accessorDetails":
    [
    {
    "password": "password",
    "role": "role",
    "emailLabelUrl": "emailLabelUrl",
    "userId": "userId"
    }
    ]
    }
    },
    "shipmentAdvisoryDetails":
    {
    "regulatoryAdvisory":
    {
    "commodityClarifications":
    [
    {
    "commodityIndex": 25,
    "suggestions":
    [
    {
    "description": "description",
    "harmonizedCode": "harmonized Code"
    }
    ]
    }
    ],
    "prohibitions":
    [
    {
    "derivedHarmonizedCode": "01",
    "advisory":
    {
    "code": "code",
    "text": "Text",
    "parameters":
    [
    {
    "id": "message ID",
    "value": "Message value"
    }
    ],
    "localizedText": "localizedText"
    },
    "commodityIndex": 12,
    "source": "source",
    "categories":
    [
    "categories"
    ],
    "type": "type",
    "waiver":
    {
    "advisories":
    [
    {
    "code": "code",
    "text": "Text",
    "parameters":
    [
    {
    "id": "message ID",
    "value": "Message value"
    }
    ],
    "localizedText": "localizedText"
    }
    ],
    "description": "description",
    "id": "id"
    },
    "status": "status"
    }
    ]
    }
    },
    "masterTrackingNumber": "794953535000"
    }
  ],
- "alerts":
  [
  - {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
  ]
}

}

Add Open Shipment Packages

This endpoint helps you to add packages to Open Shipment request with the required shipping information before the shipment is confirmed.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters

x-customer-transaction-id	string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
x-locale	string Example: en_US This indicates the combination of language code and country code. Click here to see Locales
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

FullSchema-addPackagesToOpenShipment
MinimumSamplePayload-addPackagesInOpenShipment

index required	string This is a unique value assigned to the already created Open Shipment. If this isn’t available then provide the master tracking number. Example: Test1234
shipAction	string Enum: "CONFIRM" "TRANSFER" There are Ship actions as part of processing the shipment.
accountNumber required	object (AccountNumber) The account number associated with the shipment. Example: Your account number
requestedPackageLineItems required	Array of objects (RequestedPackageLineItem) These are package line item details in the shipment.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /ship/v1/openshipments/packages

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/openshipments/packages

Production Server

https://apis.fedex.com/ship/v1/openshipments/packages

Request samples

Payload

Content type

application/json

Example

Copy

Expand all Collapse all

{

"index": "Test1234",
"shipAction": "STRONG_VALIDATION",
"accountNumber":
{
- "value": "Your account number"
},
"requestedPackageLineItems":
[
- {
  - "sequenceNumber": "1",
  - "subPackagingType": "BUCKET",
  - "customerReferences":
    [
    {
    "customerReferenceType": "INVOICE_NUMBER",
    "value": "3686"
    }
    ],
  - "declaredValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
  - "weight":
    {
    "units": "KG",
    "value": 68.25
    },
  - "dimensions":
    {
    "length": 100,
    "width": 50,
    "height": 30,
    "units": "CM"
    },
  - "groupPackageCount": 2,
  - "itemDescriptionForClearance": "description",
  - "contentRecord":
    [
    {
    "itemNumber": "2876",
    "receivedQuantity": 256,
    "description": "Description",
    "partNumber": "456"
    }
    ],
  - "itemDescription": "item description for the package",
  - "variableHandlingChargeDetail":
    {
    "rateType": "PREFERRED_CURRENCY",
    "percentValue": 12.45,
    "rateLevelType": "INDIVIDUAL_PACKAGE_RATE",
    "fixedValue":
    {
    "amount": 24.45,
    "currency": "USD"
    },
    "rateElementBasis": "NET_CHARGE_EXCLUDING_TAXES"
    },
  - "packageSpecialServices":
    {
    "specialServiceTypes":
    [
    "ALCOHOL",
    "NON_STANDARD_CONTAINER"
    ],
    "signatureOptionType": "SERVICE_DEFAULT",
    "priorityAlertDetail":
    {
    "enhancementTypes":
    [
    "PRIORITY_ALERT_PLUS"
    ],
    "content":
    [
    "string"
    ]
    },
    "signatureOptionDetail":
    {
    "signatureReleaseNumber": "23456"
    },
    "alcoholDetail":
    {
    "alcoholRecipientType": "LICENSEE",
    "shipperAgreementType": "Retailer"
    },
    "dangerousGoodsDetail":
    {
    "accessibility": "INACCESSIBLE",
    "cargoAircraftOnly": false,
    "regulation": "ADR",
    "options":
    [
    "LIMITED_QUANTITIES_COMMODITIES",
    "ORM_D"
    ]
    },
    "packageCODDetail":
    {
    "codCollectionAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    },
    "pieceCountVerificationBoxCount": 0,
    "batteryDetails":
    [
    {
    "batteryPackingType": "CONTAINED_IN_EQUIPMENT",
    "batteryRegulatoryType": "IATA_SECTION_II",
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ],
    "dryIceWeight":
    {
    "units": "KG",
    "value": 68.25
    },
    "standaloneBatteryDetails":
    [
    {
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ]
    }
  }
]

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "624deea6-b709-470c-8c39-4b5511281492",
"customerTransactionId": "AnyCo_order123456789",
"output":
{
- "transactionShipments":
  [
  - {
    "serviceType": "STANDARD_OVERNIGHT",
    "shipDatestamp": "2010-03-04",
    "serviceCategory": "EXPRESS",
    "shipmentDocuments":
    [
    {
    "contentKey": "content key",
    "copiesToPrint": 10,
    "contentType": "COMMERCIAL_INVOICE",
    "trackingNumber": "794953535000",
    "docType": "PDF",
    "alerts":
    [
    {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
    ],
    "encodedLabel": "encoded label",
    "url": "https://wwwdev.idev.fedex.com/document/v2/document/retrieve/SH,794810209259_SHIPPING_P/isLabel=true&autoPrint=false"
    }
    ],
    "pieceResponses":
    [
    {
    "netChargeAmount": 21.45,
    "transactionDetails":
    [
    {
    "transactionDetails": "transactionDetails",
    "transactionId": "12345"
    }
    ],
    "packageDocuments":
    [
    {
    "contentKey": "content key",
    "copiesToPrint": 10,
    "contentType": "COMMERCIAL_INVOICE",
    "trackingNumber": "794953535000",
    "docType": "PDF",
    "alerts":
    [
    {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
    ],
    "encodedLabel": "encoded label",
    "url": "https://wwwdev.idev.fedex.com/document/v2/document/retrieve/SH,794810209259_SHIPPING_P/isLabel=true&autoPrint=false"
    }
    ],
    "acceptanceTrackingNumber": "794953535000",
    "serviceCategory": "EXPRESS",
    "listCustomerTotalCharge": "listCustomerTotalCharge",
    "deliveryTimestamp": "2012-09-23",
    "trackingIdType": "FEDEX",
    "additionalChargesDiscount": 621.45,
    "netListRateAmount": 1.45,
    "baseRateAmount": 321.45,
    "packageSequenceNumber": 215,
    "netDiscountAmount": 121.45,
    "codcollectionAmount": 231.45,
    "masterTrackingNumber": "794953535000",
    "acceptanceType": "acceptanceType",
    "trackingNumber": "794953535000",
    "successful": true,
    "customerReferences":
    [
    {
    "customerReferenceType": "INVOICE_NUMBER",
    "value": "3686"
    }
    ]
    }
    ],
    "serviceName": "FedEx 2 Day Freight",
    "alerts":
    [
    {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
    ],
    "completedShipmentDetail":
    {
    "completedPackageDetails":
    [
    {
    "sequenceNumber": 256,
    "operationalDetail":
    {
    "astraHandlingText": "astraHandlingText",
    "barcodes":
    {
    "binaryBarcodes":
    [
    {
    "type": "COMMON-2D",
    "value": "string"
    }
    ],
    "stringBarcodes":
    [
    {
    "type": "ADDRESS",
    "value": "1010062512241535917900794953544894"
    }
    ]
    },
    "operationalInstructions":
    [
    {
    "number": 17,
    "content": "content"
    }
    ]
    },
    "signatureOption": "DIRECT",
    "trackingIds":
    [
    {
    "formId": "0201",
    "trackingIdType": "EXPRESS",
    "uspsApplicationId": "92",
    "trackingNumber": "49092000070120032835"
    }
    ],
    "groupNumber": 567,
    "oversizeClass": "OVERSIZE_1, OVERSIZE_2, OVERSIZE_3",
    "packageRating":
    {
    "effectiveNetDiscount": 0,
    "actualRateType": "PAYOR_ACCOUNT_PACKAGE",
    "packageRateDetails":
    [
    {
    "ratedWeightMethod": "DIM",
    "totalFreightDiscounts": 44.55,
    "totalTaxes": 3.45,
    "minimumChargeType": "minimumChargeType",
    "baseCharge": 45.67,
    "totalRebates": 4.56,
    "rateType": "PAYOR_RETAIL_PACKAGE",
    "billingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "netFreight": 4.89,
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "totalSurcharges": 22.56,
    "netFedExCharge": 12.56,
    "netCharge": 121.56,
    "currency": "USD"
    }
    ]
    },
    "dryIceWeight":
    {
    "units": "KG",
    "value": 68
    },
    "hazardousPackageDetail":
    {
    "regulation": "IATA",
    "accessibility": "ACCESSIBLE",
    "labelType": "II_YELLOW",
    "containers":
    [
    {
    "qvalue": 2,
    "hazardousCommodities":
    [
    {
    "quantity":
    {
    "quantityType": "GROSS",
    "amount": 24.56,
    "units": "Kg"
    },
    "options":
    {
    "quantity":
    {
    "quantityType": "GROSS",
    "amount": 24.56,
    "units": "Kg"
    },
    "innerReceptacles":
    [
    {
    "quantity":
    {
    "quantityType": "NET",
    "amount": 34.56,
    "units": "Kg"
    }
    }
    ],
    "options":
    {
    "labelTextOption": "APPEND",
    "customerSuppliedLabelText": "Customer Supplied Label Text."
    },
    "description":
    {
    "sequenceNumber": 9812,
    "processingOptions":
    [
    "INCLUDE_SPECIAL_PROVISIONS"
    ],
    "subsidiaryClasses":
    [
    "Subsidiary Classes"
    ],
    "labelText": "labelText",
    "technicalName": "technicalName",
    "packingDetails":
    {
    "packingInstructions": "packing Instructions",
    "cargoAircraftOnly": true
    },
    "authorization": "authorization",
    "reportableQuantity": true,
    "percentage": 12.45,
    "id": "123",
    "packingGroup": "I",
    "properShippingName": "properShippingName",
    "hazardClass": "hazard Class"
    }
    },
    "description":
    {
    "sequenceNumber": 876,
    "packingInstructions": "packingInstructions",
    "subsidiaryClasses":
    [
    "Subsidiary Classes"
    ],
    "labelText": "labelText",
    "tunnelRestrictionCode": "UN2919",
    "specialProvisions": "specialProvisions",
    "properShippingNameAndDescription": "properShippingNameAndDescription",
    "technicalName": "technicalName",
    "symbols": "symbols",
    "authorization": "authorization",
    "attributes":
    [
    "attributes"
    ],
    "id": "1234",
    "packingGroup": "packingGroup",
    "properShippingName": "properShippingName",
    "hazardClass": "hazardClass"
    },
    "netExplosiveDetail":
    {
    "amount": 10,
    "units": "units",
    "type": "NET_EXPLOSIVE_WEIGHT"
    },
    "massPoints": 2
    }
    ]
    }
    ],
    "cargoAircraftOnly": true,
    "referenceId": "123456",
    "radioactiveTransportIndex": 2.45
    }
    }
    ],
    "operationalDetail":
    {
    "originServiceArea": "A1",
    "serviceCode": "010",
    "airportId": "DFW",
    "postalCode": "38010",
    "scac": "scac",
    "deliveryDay": "TUE",
    "originLocationId": "678",
    "countryCode": "US",
    "astraDescription": "SMART POST",
    "originLocationNumber": 243,
    "deliveryDate": "2001-04-05",
    "deliveryEligibilities":
    [
    "deliveryEligibilities"
    ],
    "ineligibleForMoneyBackGuarantee": true,
    "maximumTransitTime": "SEVEN_DAYS",
    "destinationLocationStateOrProvinceCode": "GA",
    "astraPlannedServiceLevel": "TUE - 15 OCT 10:30A",
    "destinationLocationId": "DALA",
    "transitTime": "TWO_DAYS",
    "stateOrProvinceCode": "GA",
    "destinationLocationNumber": 876,
    "packagingCode": "03",
    "commitDate": "2019-10-15",
    "publishedDeliveryTime": "10:30A",
    "ursaSuffixCode": "Ga",
    "ursaPrefixCode": "XH",
    "destinationServiceArea": "A1",
    "commitDay": "TUE",
    "customTransitTime": "ONE_DAY"
    },
    "carrierCode": "FDXE",
    "completedHoldAtLocationDetail":
    {
    "holdingLocationType": "FEDEX_STAFFED",
    "holdingLocation":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "tollFreePhoneNumber": "6127812",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": "91",
    "faxNumber": "1234567890",
    "pagerNumber": "6127812",
    "companyName": "Fedex",
    "title": "title"
    }
    }
    },
    "completedEtdDetail":
    {
    "folderId": "0b0493e580dc1a1b",
    "type": "COMMERCIAL_INVOICE",
    "uploadDocumentReferenceDetails":
    [
    {
    "documentType": "PRO_FORMA_INVOICE",
    "documentReference": "DocumentReference",
    "description": "PRO FORMA INVOICE",
    "documentId": "090927d680038c61"
    }
    ]
    },
    "packagingDescription": "description",
    "masterTrackingId":
    {
    "formId": "0201",
    "trackingIdType": "EXPRESS",
    "uspsApplicationId": "92",
    "trackingNumber": "49092000070120032835"
    },
    "serviceDescription":
    {
    "serviceType": "FEDEX_1_DAY_FREIGHT",
    "code": "80",
    "names":
    [
    {
    "type": "long",
    "encoding": "UTF-8",
    "value": "F-2"
    }
    ],
    "operatingOrgCodes":
    [
    "FXE"
    ],
    "astraDescription": "2 DAY FRT",
    "description": "description",
    "serviceId": "EP1000000027",
    "serviceCategory": "freight"
    },
    "usDomestic": true,
    "hazardousShipmentDetail":
    {
    "hazardousSummaryDetail":
    {
    "smallQuantityExceptionPackageCount": 10
    },
    "adrLicense":
    {
    "licenseOrPermitDetail":
    {
    "number": "12345",
    "effectiveDate": "2019-08-09",
    "expirationDate": "2019-04-09"
    }
    },
    "dryIceDetail":
    {
    "totalWeight":
    {
    "units": "KG",
    "value": 68
    },
    "packageCount": 10,
    "processingOptions":
    {
    "options":
    [
    "options"
    ]
    }
    }
    },
    "shipmentRating":
    {
    "actualRateType": "PAYOR_LIST_SHIPMENT",
    "shipmentRateDetails":
    [
    {
    "rateZone": "US001O",
    "ratedWeightMethod": "ACTUAL",
    "totalDutiesTaxesAndFees": 24.56,
    "pricingCode": "LTL_FREIGHT",
    "totalFreightDiscounts": 1.56,
    "totalTaxes": 3.45,
    "totalDutiesAndTaxes": 6.78,
    "totalAncillaryFeesAndTaxes": 5.67,
    "taxes":
    [
    {
    "amount": 10,
    "level": "level",
    "description": "description",
    "type": "type"
    }
    ],
    "totalRebates": 1.98,
    "fuelSurchargePercent": 4.56,
    "currencyExchangeRate":
    {
    "rate": 25.6,
    "fromCurrency": "Rupee",
    "intoCurrency": "USD"
    },
    "totalNetFreight": 9.56,
    "totalNetFedExCharge": 88.56,
    "shipmentLegRateDetails":
    [
    {
    "rateZone": "rateZone",
    "pricingCode": "pricingCode",
    "taxes":
    [
    {
    "amount": 10,
    "level": "level",
    "description": "description",
    "type": "type"
    }
    ],
    "totalDimWeight":
    {
    "units": "KG",
    "value": 68
    },
    "totalRebates": 2,
    "fuelSurchargePercent": 6,
    "currencyExchangeRate":
    {
    "rate": 25.6,
    "fromCurrency": "Rupee",
    "intoCurrency": "USD"
    },
    "dimDivisor": 6,
    "rateType": "PAYOR_RETAIL_PACKAGE",
    "legDestinationLocationId": "legDestinationLocationId",
    "dimDivisorType": "dimDivisorType",
    "totalBaseCharge": 6,
    "ratedWeightMethod": "ratedWeightMethod",
    "totalFreightDiscounts": 9,
    "totalTaxes": 12.6,
    "minimumChargeType": "minimumChargeType",
    "totalDutiesAndTaxes": 17.78,
    "totalNetFreight": 6,
    "totalNetFedExCharge": 3.2,
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "totalSurcharges": 5,
    "totalBillingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "freightDiscounts":
    [
    {
    "amount": 8.9,
    "rateDiscountType": "COUPON",
    "percent": 28.9,
    "description": "description"
    }
    ],
    "rateScale": "6702",
    "totalNetCharge": 25.3,
    "totalNetChargeWithDutiesAndTaxes": 25.67,
    "currency": "USD"
    }
    ],
    "dimDivisor": 0,
    "rateType": "RATED_ACCOUNT_SHIPMENT",
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "totalSurcharges": 9.88,
    "totalBillingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "freightDiscounts":
    [
    {
    "amount": 8.9,
    "rateDiscountType": "COUPON",
    "percent": 28.9,
    "description": "description"
    }
    ],
    "rateScale": "00000",
    "totalNetCharge": 3.78,
    "totalBaseCharge": 234.56,
    "totalNetChargeWithDutiesAndTaxes": 222.56,
    "currency": "USD"
    }
    ]
    },
    "documentRequirements":
    {
    "requiredDocuments":
    [
    "COMMERCIAL_OR_PRO_FORMA_INVOICE",
    "AIR_WAYBILL"
    ],
    "prohibitedDocuments":
    [
    "CERTIFICATE_OF_ORIGIN"
    ],
    "generationDetails":
    [
    {
    "type": "COMMERCIAL_INVOICE",
    "minimumCopiesRequired": 3,
    "letterhead": "OPTIONAL",
    "electronicSignature": "OPTIONAL"
    }
    ]
    },
    "exportComplianceStatement": "12345678901234567",
    "accessDetail":
    {
    "accessorDetails":
    [
    {
    "password": "password",
    "role": "role",
    "emailLabelUrl": "emailLabelUrl",
    "userId": "userId"
    }
    ]
    }
    },
    "shipmentAdvisoryDetails":
    {
    "regulatoryAdvisory":
    {
    "commodityClarifications":
    [
    {
    "commodityIndex": 25,
    "suggestions":
    [
    {
    "description": "description",
    "harmonizedCode": "harmonized Code"
    }
    ]
    }
    ],
    "prohibitions":
    [
    {
    "derivedHarmonizedCode": "01",
    "advisory":
    {
    "code": "code",
    "text": "Text",
    "parameters":
    [
    {
    "id": "message ID",
    "value": "Message value"
    }
    ],
    "localizedText": "localizedText"
    },
    "commodityIndex": 12,
    "source": "source",
    "categories":
    [
    "categories"
    ],
    "type": "type",
    "waiver":
    {
    "advisories":
    [
    {
    "code": "code",
    "text": "Text",
    "parameters":
    [
    {
    "id": "message ID",
    "value": "Message value"
    }
    ],
    "localizedText": "localizedText"
    }
    ],
    "description": "description",
    "id": "id"
    },
    "status": "status"
    }
    ]
    }
    },
    "masterTrackingNumber": "794953535000"
    }
  ],
- "alerts":
  [
  - {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
  ]
}

}

Delete Open Shipment Packages

This endpoint helps you to delete packages from Open Shipment request with the required shipping information before the shipment is confirmed.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters

x-customer-transaction-id	string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
x-locale	string Example: en_US This indicates the combination of language code and country code. Click here to see Locales
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

FullSchema-deletePackagesFromOpenShipment
MinimumSamplePayload-deletePackagesOpenShipment

index required	string This is a unique value assigned to the already created Open Shipment. If this isn’t available then provide the master tracking number. Example: Test1234
accountNumber required	object (AccountNumber) The account number associated with the shipment. Example: Your account number
trackingIds required	Array of objects (TrackingId) One or more tracking IDs, for which the packages to be removed from the shipment.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

put /ship/v1/openshipments/packages/delete

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/openshipments/packages/delete

Production Server

https://apis.fedex.com/ship/v1/openshipments/packages/delete

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"index": "Test1234",
"accountNumber":
{
- "value": "Your account number"
},
"trackingIds":
[
- {
  - "formId": "0201",
  - "trackingIdType": "EXPRESS",
  - "uspsApplicationId": "92",
  - "trackingNumber": "49092000070120032835"
  }
]

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "624xxxxx-b709-470c-8c39-4b55112xxxxx",
"customerTransactionId": "AnyCo_order123456789",
"output":
{
- "deletedPackagesFromOpenshipment": true,
- "alerts":
  [
  - {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
  ]
}

}

Retrieve Open Shipment Package

This endpoint helps the user to RETRIEVE specific package request details of the Open Shipment that is created.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters

x-customer-transaction-id	string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
x-locale	string Example: en_US This indicates the combination of language code and country code. Click here to see Locales
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

FullSchema-retrievePackageInOpenShipment
MinimumSamplePayload-retrievePackageInOpenShipment

index required	string This is a unique value assigned to the already created Open Shipment. If this isn’t available then provide the master tracking number. Example: Test1234
accountNumber required	object (AccountNumber) The account number associated with the shipment. Example: Your account number
trackingId required	object (TrackingId) Indicates the tracking details for the package.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /ship/v1/openshipments/packages/retrieve

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/openshipments/packages/retrieve

Production Server

https://apis.fedex.com/ship/v1/openshipments/packages/retrieve

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"index": "Test1234",
"accountNumber":
{
- "value": "Your account number"
},
"trackingId":
{
- "formId": "0201",
- "trackingIdType": "EXPRESS",
- "uspsApplicationId": "92",
- "trackingNumber": "49092000070120032835"
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "624xxxxx-b709-470c-8c39-4b55112xxxxx",
"customerTransactionId": "AnyCo_order123456789",
"output":
{
- "requestedpackageLineItem":
  {
  - "sequenceNumber": "1",
  - "subPackagingType": "BUCKET",
  - "customerReferences":
    [
    {
    "customerReferenceType": "INVOICE_NUMBER",
    "value": "3686"
    }
    ],
  - "declaredValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
  - "weight":
    {
    "units": "KG",
    "value": 68.25
    },
  - "dimensions":
    {
    "length": 100,
    "width": 50,
    "height": 30,
    "units": "CM"
    },
  - "groupPackageCount": 2,
  - "itemDescriptionForClearance": "description",
  - "contentRecord":
    [
    {
    "itemNumber": "2876",
    "receivedQuantity": 256,
    "description": "Description",
    "partNumber": "456"
    }
    ],
  - "itemDescription": "item description for the package",
  - "variableHandlingChargeDetail":
    {
    "rateType": "PREFERRED_CURRENCY",
    "percentValue": 12.45,
    "rateLevelType": "INDIVIDUAL_PACKAGE_RATE",
    "fixedValue":
    {
    "amount": 24.45,
    "currency": "USD"
    },
    "rateElementBasis": "NET_CHARGE_EXCLUDING_TAXES"
    },
  - "packageSpecialServices":
    {
    "specialServiceTypes":
    [
    "ALCOHOL",
    "NON_STANDARD_CONTAINER"
    ],
    "signatureOptionType": "SERVICE_DEFAULT",
    "priorityAlertDetail":
    {
    "enhancementTypes":
    [
    "PRIORITY_ALERT_PLUS"
    ],
    "content":
    [
    "string"
    ]
    },
    "signatureOptionDetail":
    {
    "signatureReleaseNumber": "23456"
    },
    "alcoholDetail":
    {
    "alcoholRecipientType": "LICENSEE",
    "shipperAgreementType": "Retailer"
    },
    "dangerousGoodsDetail":
    {
    "accessibility": "INACCESSIBLE",
    "cargoAircraftOnly": false,
    "regulation": "ADR",
    "options":
    [
    "LIMITED_QUANTITIES_COMMODITIES",
    "ORM_D"
    ]
    },
    "packageCODDetail":
    {
    "codCollectionAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    },
    "pieceCountVerificationBoxCount": 0,
    "batteryDetails":
    [
    {
    "batteryPackingType": "CONTAINED_IN_EQUIPMENT",
    "batteryRegulatoryType": "IATA_SECTION_II",
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ],
    "dryIceWeight":
    {
    "units": "KG",
    "value": 68.25
    },
    "standaloneBatteryDetails":
    [
    {
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ]
    }
  },
- "alerts":
  [
  - {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
  ]
}

}

OpenShipmentDelete V1

This endpoint helps you to delete a Openshipment request with the required shipping information before the shipment is confirmed.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters

x-customer-transaction-id	string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
x-locale	string Example: en_US This indicates the combination of language code and country code. Click here to see Locales
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

FullSchema-deleteOpenShipment
MinimumSamplePayload-deleteOpenShipment

index required	string This is a unique value for the shipment (must be unique for stand-alone open shipments, or unique within consolidation if consolidation key is provide). Example: Test1234
accountNumber required	object (AccountNumber) The account number associated with the shipment. Example: Your account number

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

put /ship/v1/openshipments/delete

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/openshipments/delete

Production Server

https://apis.fedex.com/ship/v1/openshipments/delete

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"index": "Test1234",
"accountNumber":
{
- "value": "Your account number"
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "624xxxxx-b709-470c-8c39-4b55112xxxxx",
"customerTransactionId": "AnyCo_order123456789",
"output":
{
- "deletedOpenshipment": true,
- "alerts":
  [
  - {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
  ]
}

}

Retrieve Open Shipment

This endpoint helps the user to RETRIEVE the entire shipment request details of the OpenShipment that is created.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters

x-customer-transaction-id	string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
x-locale	string Example: en_US This indicates the combination of language code and country code. Click here to see Locales
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

FullSchema-RetrieveOpenShipment
MinimumSamplePayload-RetrieveOpenShipment

index required	string This is a unique value assigned to the already created Open Shipment. If this isn’t available then provide the master tracking number. Example: Test1234
accountNumber required	object (AccountNumber) The account number associated with the shipment. Example: Your account number

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

post /ship/v1/openshipments/retrieve

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/openshipments/retrieve

Production Server

https://apis.fedex.com/ship/v1/openshipments/retrieve

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"index": "Test1234",
"accountNumber":
{
- "value": "Your account number"
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "XXX_ORDERXXXX789",
"customerTransactionId": "AnyCo_order123456789",
"output":
{
- "requestedShipment":
  {
  - "shipDatestamp": "2019-10-14",
  - "totalDeclaredValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
  - "shipper":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "91",
    "phoneNumber": "XXXX567890",
    "companyName": "Fedex"
    },
    "tins":
    [
    {
    "number": "XXX567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ]
    },
  - "recipients":
    [
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "000",
    "phoneNumber": "XXXX345671",
    "companyName": "FedEx"
    },
    "tins":
    [
    {
    "number": "123567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ],
    "deliveryInstructions": "Delivery Instructions"
    }
    ],
  - "recipientLocationNumber": "1234567",
  - "pickupType": "USE_SCHEDULED_PICKUP",
  - "serviceType": "PRIORITY_OVERNIGHT",
  - "packagingType": "YOUR_PACKAGING",
  - "totalWeight": 20.6,
  - "origin":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "person name",
    "emailAddress": "email address",
    "phoneNumber": "phone number",
    "phoneExtension": "phone extension",
    "companyName": "company name",
    "faxNumber": "fax number"
    }
    },
  - "shippingChargesPayment":
    {
    "paymentType": "SENDER",
    "payor":
    {
    "responsibleParty":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "XXXX567890",
    "phoneExtension": "phone extension",
    "companyName": "Fedex",
    "faxNumber": "fax number"
    },
    "accountNumber":
    {
    "value": "Your account number"
    }
    }
    }
    },
  - "shipmentSpecialServices":
    {
    "specialServiceTypes":
    [
    "THIRD_PARTY_CONSIGNEE",
    "PROTECTION_FROM_FREEZING"
    ],
    "etdDetail":
    {
    "attributes":
    [
    "POST_SHIPMENT_UPLOAD_REQUESTED"
    ],
    "attachedDocuments":
    [
    {
    "documentType": "PRO_FORMA_INVOICE",
    "documentReference": "DocumentReference",
    "description": "PRO FORMA INVOICE",
    "documentId": "090927d680038c61"
    }
    ],
    "requestedDocumentTypes":
    [
    "VICS_BILL_OF_LADING",
    "GENERAL_AGENCY_AGREEMENT"
    ]
    },
    "returnShipmentDetail":
    {
    "returnEmailDetail":
    {
    "merchantPhoneNumber": "19012635656",
    "allowedSpecialService":
    [
    "SATURDAY_DELIVERY"
    ]
    },
    "rma":
    {
    "reason": "Wrong Size or Color"
    },
    "returnAssociationDetail":
    {
    "shipDatestamp": "2019-10-01",
    "trackingNumber": "123456789"
    },
    "returnType": "PRINT_RETURN_LABEL"
    },
    "deliveryOnInvoiceAcceptanceDetail":
    {
    "recipient":
    {
    "address":
    {
    "streetLines":
    [
    "23, RUE JOSEPH-DE MA",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "000",
    "phoneNumber": "1234567890",
    "companyName": "Fedex"
    },
    "tins":
    [
    {
    "number": "123567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ],
    "deliveryInstructions": "Delivery Instructions"
    }
    },
    "internationalTrafficInArmsRegulationsDetail":
    {
    "licenseOrExemptionNumber": "9871234"
    },
    "pendingShipmentDetail":
    {
    "pendingShipmentType": "EMAIL",
    "processingOptions":
    {
    "options":
    [
    "ALLOW_MODIFICATIONS"
    ]
    },
    "recommendedDocumentSpecification":
    {
    "types": "ANTIQUE_STATEMENT_EUROPEAN_UNION"
    },
    "emailLabelDetail":
    {
    "recipients":
    [
    {
    "emailAddress": "neena@fedex.com",
    "optionsRequested":
    {
    "options":
    [
    "PRODUCE_PAPERLESS_SHIPPING_FORMAT",
    "SUPPRESS_ACCESS_EMAILS"
    ]
    },
    "role": "SHIPMENT_COMPLETOR",
    "locale": "en_US"
    }
    ],
    "message": "your optional message"
    },
    "attachedDocuments":
    [
    {
    "documentType": "PRO_FORMA_INVOICE",
    "documentReference": "DocumentReference",
    "description": "PRO FORMA INVOICE",
    "documentId": "090927d680038c61"
    }
    ],
    "expirationTimeStamp": "2020-01-01"
    },
    "holdAtLocationDetail":
    {
    "locationId": "YBZA",
    "locationContactAndAddress":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "person name",
    "emailAddress": "email address",
    "phoneNumber": "phone number",
    "phoneExtension": "phone extension",
    "companyName": "company name",
    "faxNumber": "fax number"
    }
    },
    "locationType": "FEDEX_ONSITE"
    },
    "shipmentCODDetail":
    {
    "addTransportationChargesDetail":
    {
    "rateType": "ACCOUNT",
    "rateLevelType": "BUNDLED_RATE",
    "chargeLevelType": "CURRENT_PACKAGE",
    "chargeType": "COD_SURCHARGE"
    },
    "codRecipient":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "000",
    "phoneNumber": "XXXX345671",
    "companyName": "Fedex"
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "tins":
    [
    {
    "number": "123567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ]
    },
    "remitToName": "remitToName",
    "codCollectionType": "ANY",
    "financialInstitutionContactAndAddress":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "person name",
    "emailAddress": "email address",
    "phoneNumber": "phone number",
    "phoneExtension": "phone extension",
    "companyName": "company name",
    "faxNumber": "fax number"
    }
    },
    "codCollectionAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "returnReferenceIndicatorType": "INVOICE",
    "shipmentCodAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    },
    "shipmentDryIceDetail":
    {
    "totalWeight":
    {
    "units": "KG",
    "value": 68.25
    },
    "packageCount": 12
    },
    "internationalControlledExportDetail":
    {
    "licenseOrPermitExpirationDate": "2019-12-03",
    "licenseOrPermitNumber": "11",
    "entryNumber": "125",
    "foreignTradeZoneCode": "US",
    "type": "WAREHOUSE_WITHDRAWAL"
    },
    "homeDeliveryPremiumDetail":
    {
    "phoneNumber":
    {
    "areaCode": "901",
    "localNumber": "3575012",
    "extension": "200",
    "personalIdentificationNumber": "98712345"
    },
    "deliveryDate": "2019-06-26",
    "homedeliveryPremiumType": "APPOINTMENT"
    }
    },
  - "emailNotificationDetail":
    {
    "aggregationType": "PER_PACKAGE",
    "emailNotificationRecipients":
    [
    {
    "name": "Joe Smith",
    "emailNotificationRecipientType": "SHIPPER",
    "emailAddress": "jsmith3@aol.com",
    "notificationFormatType": "TEXT",
    "notificationType": "EMAIL",
    "locale": "en_US",
    "notificationEventType":
    [
    "ON_PICKUP_DRIVER_ARRIVED",
    "ON_SHIPMENT"
    ]
    }
    ],
    "personalMessage": "your personal message here"
    },
  - "expressFreightDetail":
    {
    "bookingConfirmationNumber": "123456789812",
    "shippersLoadAndCount": 123,
    "packingListEnclosed": true
    },
  - "variableHandlingChargeDetail":
    {
    "rateType": "PREFERRED_CURRENCY",
    "percentValue": 12.45,
    "rateLevelType": "INDIVIDUAL_PACKAGE_RATE",
    "fixedValue":
    {
    "amount": 24.45,
    "currency": "USD"
    },
    "rateElementBasis": "NET_CHARGE_EXCLUDING_TAXES"
    },
  - "customsClearanceDetail":
    {
    "regulatoryControls": "NOT_IN_FREE_CIRCULATION",
    "brokers":
    [
    {
    "broker":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": 91,
    "companyName": "Fedex",
    "faxNumber": 1234567
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "tins":
    [
    {
    "number": "number",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ],
    "deliveryInstructions": "deliveryInstructions"
    },
    "type": "IMPORT"
    }
    ],
    "commercialInvoice":
    {
    "originatorName": "originator Name",
    "comments":
    [
    "optional comments for the commercial invoice"
    ],
    "customerReferences":
    [
    {
    "customerReferenceType": "INVOICE_NUMBER",
    "value": "3686"
    }
    ],
    "taxesOrMiscellaneousCharge":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "taxesOrMiscellaneousChargeType": "COMMISSIONS",
    "freightCharge":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "packingCosts":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "handlingCosts":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "declarationStatement": "declarationStatement",
    "termsOfSale": "FCA",
    "specialInstructions": "specialInstructions\"",
    "shipmentPurpose": "REPAIR_AND_RETURN",
    "emailNotificationDetail":
    {
    "emailAddress": "neena@fedex.com",
    "type": "EMAILED",
    "recipientType": "SHIPPER"
    }
    },
    "freightOnValue": "OWN_RISK",
    "dutiesPayment":
    {
    "payor":
    {
    "responsibleParty":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": "phone extension",
    "companyName": "Fedex",
    "faxNumber": "fax number"
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "tins":
    [
    {
    "number": "number",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    },
    {
    "number": "number",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ]
    }
    },
    "billingDetails":
    {
    "billingCode": "billingCode",
    "billingType": "billingType",
    "aliasId": "aliasId",
    "accountNickname": "accountNickname",
    "accountNumber": "Your account number",
    "accountNumberCountryCode": "US"
    },
    "paymentType": "SENDER"
    },
    "commodities":
    [
    {
    "unitPrice":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "additionalMeasures":
    [
    {
    "quantity": 12.45,
    "units": "KG"
    }
    ],
    "numberOfPieces": 12,
    "quantity": 125,
    "quantityUnits": "Ea",
    "customsValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "countryOfManufacture": "US",
    "cIMarksAndNumbers": "87123",
    "harmonizedCode": "0613",
    "description": "description",
    "name": "non-threaded rivets",
    "weight":
    {
    "units": "KG",
    "value": 68.25
    },
    "exportLicenseNumber": "26456",
    "exportLicenseExpirationDate": "2025-04-02T16:22:55Z",
    "partNumber": "167",
    "purpose": "BUSINESS",
    "usmcaDetail":
    {
    "originCriterion": "A"
    }
    }
    ],
    "isDocumentOnly": true,
    "recipientCustomsId":
    {
    "type": "PASSPORT",
    "value": "123"
    },
    "customsOption":
    {
    "description": "Description",
    "type": "COURTESY_RETURN_LABEL"
    },
    "importerOfRecord":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "000",
    "phoneNumber": "XXXX345671",
    "companyName": "Fedex"
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "tins":
    [
    {
    "number": "123567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ]
    },
    "generatedDocumentLocale": "en_US",
    "exportDetail":
    {
    "destinationControlDetail":
    {
    "endUser": "dest country user",
    "statementTypes": "DEPARTMENT_OF_COMMERCE",
    "destinationCountries":
    [
    "USA",
    "India"
    ]
    },
    "b13AFilingOption": "NOT_REQUIRED",
    "exportComplianceStatement": "12345678901234567",
    "permitNumber": "12345"
    },
    "totalCustomsValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "partiesToTransactionAreRelated": true,
    "declarationStatementDetail":
    {
    "usmcaLowValueStatementDetail":
    {
    "countryOfOriginLowValueDocumentRequested": true,
    "customsRole": "EXPORTER"
    }
    },
    "insuranceCharge":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    },
  - "smartPostInfoDetail":
    {
    "ancillaryEndorsement": "RETURN_SERVICE",
    "hubId": "5015",
    "indicia": "PRESORTED_STANDARD",
    "specialServices": "USPS_DELIVERY_CONFIRMATION"
    },
  - "blockInsightVisibility": true,
  - "labelSpecification":
    {
    "labelFormatType": "COMMON2D",
    "labelOrder": "SHIPPING_LABEL_FIRST",
    "customerSpecifiedDetail":
    {
    "maskedData":
    [
    "[\"CUSTOMS_VALUE\",\"TOTAL_WEIGHT\"]"
    ],
    "regulatoryLabels":
    [
    {
    "generationOptions": "CONTENT_ON_SHIPPING_LABEL_ONLY",
    "type": "ALCOHOL_SHIPMENT_LABEL"
    }
    ],
    "additionalLabels":
    [
    {
    "type": "CONSIGNEE",
    "count": 1
    }
    ],
    "docTabContent":
    {
    "docTabContentType": "BARCODED",
    "zone001":
    {
    "docTabZoneSpecifications":
    [
    {
    "zoneNumber": 0,
    "header": "string",
    "dataField": "string",
    "literalValue": "string",
    "justification": "RIGHT"
    }
    ]
    },
    "barcoded":
    {
    "symbology": "UCC128",
    "specification":
    {
    "zoneNumber": 0,
    "header": "string",
    "dataField": "string",
    "literalValue": "string",
    "justification": "RIGHT"
    }
    }
    }
    },
    "printedLabelOrigin":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "person name",
    "emailAddress": "email address",
    "phoneNumber": "phone number",
    "phoneExtension": "phone extension",
    "companyName": "company name",
    "faxNumber": "fax number"
    }
    },
    "labelStockType": "PAPER_85X11_TOP_HALF_LABEL",
    "labelRotation": "UPSIDE_DOWN",
    "imageType": "PDF",
    "labelPrintingOrientation": "TOP_EDGE_OF_TEXT_FIRST",
    "returnedDispositionDetail": true,
    "resolution": 300
    },
  - "shippingDocumentSpecification":
    {
    "generalAgencyAgreementDetail":
    {
    "documentFormat":
    {
    "provideInstructions": true,
    "optionsRequested":
    {
    "options":
    [
    "SUPPRESS_ADDITIONAL_LANGUAGES",
    "SHIPPING_LABEL_LAST"
    ]
    },
    "stockType": "PAPER_LETTER",
    "dispositions":
    [
    {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THIRD_PARTY"
    }
    ],
    "locale": "en_US",
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED"
    }
    ],
    "locale": "en_US",
    "docType": "PDF"
    }
    },
    "returnInstructionsDetail":
    {
    "customText": "This is additional text printed on Return instr",
    "documentFormat":
    {
    "provideInstructions": true,
    "optionsRequested":
    {
    "options":
    [
    "SUPPRESS_ADDITIONAL_LANGUAGES",
    "SHIPPING_LABEL_LAST"
    ]
    },
    "stockType": "PAPER_LETTER",
    "dispositions":
    [
    {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THIRD_PARTY"
    }
    ],
    "locale": "en_US",
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED"
    }
    ],
    "locale": "en_US\"",
    "docType": "PNG"
    }
    },
    "op900Detail":
    {
    "customerImageUsages":
    [
    {
    "id": "IMAGE_5",
    "type": "SIGNATURE",
    "providedImageType": "LETTER_HEAD"
    }
    ],
    "signatureName": "Signature Name",
    "documentFormat":
    {
    "provideInstructions": true,
    "optionsRequested":
    {
    "options":
    [
    "SUPPRESS_ADDITIONAL_LANGUAGES",
    "SHIPPING_LABEL_LAST"
    ]
    },
    "stockType": "PAPER_LETTER",
    "dispositions":
    [
    {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THIRD_PARTY"
    }
    ],
    "locale": "en_US",
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED"
    }
    ],
    "locale": "en_US",
    "docType": "PDF"
    }
    },
    "usmcaCertificationOfOriginDetail":
    {
    "customerImageUsages":
    [
    {
    "id": "IMAGE_5",
    "type": "SIGNATURE",
    "providedImageType": "LETTER_HEAD"
    }
    ],
    "documentFormat":
    {
    "provideInstructions": true,
    "optionsRequested":
    {
    "options":
    [
    "SUPPRESS_ADDITIONAL_LANGUAGES",
    "SHIPPING_LABEL_LAST"
    ]
    },
    "stockType": "PAPER_LETTER",
    "dispositions":
    [
    {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THIRD_PARTY"
    }
    ],
    "locale": "en_US",
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED"
    }
    ],
    "locale": "en_US",
    "docType": "PDF"
    },
    "certifierSpecification": "EXPORTER",
    "importerSpecification": "UNKNOWN",
    "producerSpecification": "SAME_AS_EXPORTER",
    "producer":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "000",
    "phoneNumber": "XXXX345671",
    "companyName": "Fedex"
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "tins":
    [
    {
    "number": "123567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ]
    },
    "blanketPeriod":
    {
    "begins": "22-01-2020",
    "ends": "2-01-2020"
    },
    "certifierJobTitle": "Manager"
    },
    "usmcaCommercialInvoiceCertificationOfOriginDetail":
    {
    "customerImageUsages":
    [
    {
    "id": "IMAGE_5",
    "type": "SIGNATURE",
    "providedImageType": "LETTER_HEAD"
    }
    ],
    "documentFormat":
    {
    "provideInstructions": true,
    "optionsRequested":
    {
    "options":
    [
    "SUPPRESS_ADDITIONAL_LANGUAGES",
    "SHIPPING_LABEL_LAST"
    ]
    },
    "stockType": "PAPER_LETTER",
    "dispositions":
    [
    {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THIRD_PARTY"
    }
    ],
    "locale": "en_US",
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED"
    }
    ],
    "locale": "en_US",
    "docType": "PDF"
    },
    "certifierSpecification": "EXPORTER",
    "importerSpecification": "UNKNOWN",
    "producerSpecification": "SAME_AS_EXPORTER",
    "producer":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "90210",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneExtension": "000",
    "phoneNumber": "XXXX345671",
    "companyName": "Fedex"
    },
    "accountNumber":
    {
    "value": "Your account number"
    },
    "tins":
    [
    {
    "number": "123567",
    "tinType": "FEDERAL",
    "usage": "usage",
    "effectiveDate": "2000-01-23T04:56:07.000+00:00",
    "expirationDate": "2000-01-23T04:56:07.000+00:00"
    }
    ]
    },
    "certifierJobTitle": "Manager"
    },
    "shippingDocumentTypes":
    [
    "RETURN_INSTRUCTIONS"
    ],
    "certificateOfOrigin":
    {
    "customerImageUsages":
    [
    {
    "id": "IMAGE_5",
    "type": "SIGNATURE",
    "providedImageType": "LETTER_HEAD"
    }
    ],
    "documentFormat":
    {
    "provideInstructions": true,
    "optionsRequested":
    {
    "options":
    [
    "SUPPRESS_ADDITIONAL_LANGUAGES",
    "SHIPPING_LABEL_LAST"
    ]
    },
    "stockType": "PAPER_LETTER",
    "dispositions":
    [
    {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THIRD_PARTY"
    }
    ],
    "locale": "en_US",
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED"
    }
    ],
    "locale": "en_US",
    "docType": "PDF"
    }
    },
    "commercialInvoiceDetail":
    {
    "customerImageUsages":
    [
    {
    "id": "IMAGE_5",
    "type": "SIGNATURE",
    "providedImageType": "LETTER_HEAD"
    }
    ],
    "documentFormat":
    {
    "provideInstructions": true,
    "optionsRequested":
    {
    "options":
    [
    "SUPPRESS_ADDITIONAL_LANGUAGES",
    "SHIPPING_LABEL_LAST"
    ]
    },
    "stockType": "PAPER_LETTER",
    "dispositions":
    [
    {
    "eMailDetail":
    {
    "eMailRecipients":
    [
    {
    "emailAddress": "email@fedex.com",
    "recipientType": "THIRD_PARTY"
    }
    ],
    "locale": "en_US",
    "grouping": "NONE"
    },
    "dispositionType": "CONFIRMED"
    }
    ],
    "locale": "en_US",
    "docType": "PDF"
    }
    }
    },
  - "rateRequestType":
    [
    "LIST",
    "PREFERRED"
    ],
  - "preferredCurrency": "USD",
  - "totalPackageCount": 25,
  - "masterTrackingId":
    {
    "formId": "0201",
    "trackingIdType": "EXPRESS",
    "uspsApplicationId": "92",
    "trackingNumber": "49092000070120032835"
    },
  - "requestedPackageLineItems":
    [
    {
    "sequenceNumber": "1",
    "subPackagingType": "BUCKET",
    "customerReferences":
    [
    {
    "customerReferenceType": "INVOICE_NUMBER",
    "value": "3686"
    }
    ],
    "declaredValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "weight":
    {
    "units": "KG",
    "value": 68.25
    },
    "dimensions":
    {
    "length": 100,
    "width": 50,
    "height": 30,
    "units": "CM"
    },
    "groupPackageCount": 2,
    "itemDescriptionForClearance": "description",
    "contentRecord":
    [
    {
    "itemNumber": "2876",
    "receivedQuantity": 256,
    "description": "Description",
    "partNumber": "456"
    }
    ],
    "itemDescription": "item description for the package",
    "variableHandlingChargeDetail":
    {
    "rateType": "PREFERRED_CURRENCY",
    "percentValue": 12.45,
    "rateLevelType": "INDIVIDUAL_PACKAGE_RATE",
    "fixedValue":
    {
    "amount": 24.45,
    "currency": "USD"
    },
    "rateElementBasis": "NET_CHARGE_EXCLUDING_TAXES"
    },
    "packageSpecialServices":
    {
    "specialServiceTypes":
    [
    "ALCOHOL",
    "NON_STANDARD_CONTAINER"
    ],
    "signatureOptionType": "SERVICE_DEFAULT",
    "priorityAlertDetail":
    {
    "enhancementTypes":
    [
    "PRIORITY_ALERT_PLUS"
    ],
    "content":
    [
    "string"
    ]
    },
    "signatureOptionDetail":
    {
    "signatureReleaseNumber": "23456"
    },
    "alcoholDetail":
    {
    "alcoholRecipientType": "LICENSEE",
    "shipperAgreementType": "Retailer"
    },
    "dangerousGoodsDetail":
    {
    "accessibility": "INACCESSIBLE",
    "cargoAircraftOnly": false,
    "regulation": "ADR",
    "options":
    [
    "LIMITED_QUANTITIES_COMMODITIES",
    "ORM_D"
    ]
    },
    "packageCODDetail":
    {
    "codCollectionAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    },
    "pieceCountVerificationBoxCount": 0,
    "batteryDetails":
    [
    {
    "batteryPackingType": "CONTAINED_IN_EQUIPMENT",
    "batteryRegulatoryType": "IATA_SECTION_II",
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ],
    "dryIceWeight":
    {
    "units": "KG",
    "value": 68.25
    },
    "standaloneBatteryDetails":
    [
    {
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ]
    }
    }
    ]
  },
- "alerts":
  [
  - {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
  ]
}

}

Get Open Shipment Results

This endpoint enables you to finalize the Open Shipment. Once an Open Shipment is confirmed, no further changes can be done.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters

x-customer-transaction-id	string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
x-locale	string Example: en_US This indicates the combination of language code and country code. Click here to see Locales
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

FullSchema-getOpenShipmentResults
MinimumSamplePayload-getConfirmOpenShipmentResults
MinimumSamplePayload-getCreateOpenShipmentResults
MinimumSamplePayload-getModifyOpenShipmentResults

resultMethodType required	string Enum: "CREATE" "MODIFY" "CONFIRM" The use of this method is to retrieve the results of the CREATE, MODIFY and CONFIRM events of Asynchronous flow. CREATE- Customer will create Async shipment and will get jobId. Using the generated jobId in Get OpenShipment Results endpoint customer can retrieve the result of Create OpenShipment. MODIFY- Customer will modify Async shipment and will get jobId. Using the generated jobId in Get OpenShipment Results endpoint customer can retrieve the result of Modify OpenShipment. CONFIRM- Customer will confirm Async shipment and will get jobId. Using the generated jobId in Get OpenShipment Results endpoint customer can retrieve the result of Confirm OpenShipment.
jobId required	string Indicates the job under which the deferred shipment artifacts must be identified in the subsequent retrieval request. Example: '89sxxxxx233ae24ff31xxxxx'
accountNumber required	object (AccountNumber) The account number associated with the shipment. Example: Your account number

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /ship/v1/openshipments/results

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/openshipments/results

Production Server

https://apis.fedex.com/ship/v1/openshipments/results

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"resultMethodType": "CREATE",
"jobId": "89sxxxxx233ae24ff31xxxxx",
"accountNumber":
{
- "value": "Your account number"
}

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "624xxxxx-b709-470c-8c39-4b55112xxxxx",
"customerTransactionId": "AnyCo_order123456789",
"output":
{
- "transactionShipments":
  [
  - {
    "serviceType": "STANDARD_OVERNIGHT",
    "shipDatestamp": "2010-03-04",
    "serviceCategory": "EXPRESS",
    "shipmentDocuments":
    [
    {
    "contentKey": "content key",
    "copiesToPrint": 10,
    "contentType": "COMMERCIAL_INVOICE",
    "trackingNumber": "794953535000",
    "docType": "PDF",
    "alerts":
    [
    {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
    ],
    "encodedLabel": "encoded label",
    "url": "https://wwwdev.idev.fedex.com/document/v2/document/retrieve/SH,794810209259_SHIPPING_P/isLabel=true&autoPrint=false"
    }
    ],
    "pieceResponses":
    [
    {
    "netChargeAmount": 21.45,
    "transactionDetails":
    [
    {
    "transactionDetails": "transactionDetails",
    "transactionId": "12345"
    }
    ],
    "packageDocuments":
    [
    {
    "contentKey": "content key",
    "copiesToPrint": 10,
    "contentType": "COMMERCIAL_INVOICE",
    "trackingNumber": "794953535000",
    "docType": "PDF",
    "alerts":
    [
    {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
    ],
    "encodedLabel": "encoded label",
    "url": "https://wwwdev.idev.fedex.com/document/v2/document/retrieve/SH,794810209259_SHIPPING_P/isLabel=true&autoPrint=false"
    }
    ],
    "acceptanceTrackingNumber": "794953535000",
    "serviceCategory": "EXPRESS",
    "listCustomerTotalCharge": "listCustomerTotalCharge",
    "deliveryTimestamp": "2012-09-23",
    "trackingIdType": "FEDEX",
    "additionalChargesDiscount": 621.45,
    "netListRateAmount": 1.45,
    "baseRateAmount": 321.45,
    "packageSequenceNumber": 215,
    "netDiscountAmount": 121.45,
    "codcollectionAmount": 231.45,
    "masterTrackingNumber": "794953535000",
    "acceptanceType": "acceptanceType",
    "trackingNumber": "794953535000",
    "successful": true,
    "customerReferences":
    [
    {
    "customerReferenceType": "INVOICE_NUMBER",
    "value": "3686"
    }
    ]
    }
    ],
    "serviceName": "FedEx 2 Day Freight",
    "alerts":
    [
    {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
    ],
    "completedShipmentDetail":
    {
    "completedPackageDetails":
    [
    {
    "sequenceNumber": 256,
    "operationalDetail":
    {
    "astraHandlingText": "astraHandlingText",
    "barcodes":
    {
    "binaryBarcodes":
    [
    {
    "type": "COMMON-2D",
    "value": "string"
    }
    ],
    "stringBarcodes":
    [
    {
    "type": "ADDRESS",
    "value": "1010062512241535917900794953544894"
    }
    ]
    },
    "operationalInstructions":
    [
    {
    "number": 17,
    "content": "content"
    }
    ]
    },
    "signatureOption": "DIRECT",
    "trackingIds":
    [
    {
    "formId": "0201",
    "trackingIdType": "EXPRESS",
    "uspsApplicationId": "92",
    "trackingNumber": "49092000070120032835"
    }
    ],
    "groupNumber": 567,
    "oversizeClass": "OVERSIZE_1, OVERSIZE_2, OVERSIZE_3",
    "packageRating":
    {
    "effectiveNetDiscount": 0,
    "actualRateType": "PAYOR_ACCOUNT_PACKAGE",
    "packageRateDetails":
    [
    {
    "ratedWeightMethod": "DIM",
    "totalFreightDiscounts": 44.55,
    "totalTaxes": 3.45,
    "minimumChargeType": "minimumChargeType",
    "baseCharge": 45.67,
    "totalRebates": 4.56,
    "rateType": "PAYOR_RETAIL_PACKAGE",
    "billingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "netFreight": 4.89,
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "totalSurcharges": 22.56,
    "netFedExCharge": 12.56,
    "netCharge": 121.56,
    "currency": "USD"
    }
    ]
    },
    "dryIceWeight":
    {
    "units": "KG",
    "value": 68
    },
    "hazardousPackageDetail":
    {
    "regulation": "IATA",
    "accessibility": "ACCESSIBLE",
    "labelType": "II_YELLOW",
    "containers":
    [
    {
    "qvalue": 2,
    "hazardousCommodities":
    [
    {
    "quantity":
    {
    "quantityType": "GROSS",
    "amount": 24.56,
    "units": "Kg"
    },
    "options":
    {
    "quantity":
    {
    "quantityType": "GROSS",
    "amount": 24.56,
    "units": "Kg"
    },
    "innerReceptacles":
    [
    {
    "quantity":
    {
    "quantityType": "NET",
    "amount": 34.56,
    "units": "Kg"
    }
    }
    ],
    "options":
    {
    "labelTextOption": "APPEND",
    "customerSuppliedLabelText": "Customer Supplied Label Text."
    },
    "description":
    {
    "sequenceNumber": 9812,
    "processingOptions":
    [
    "INCLUDE_SPECIAL_PROVISIONS"
    ],
    "subsidiaryClasses":
    [
    "Subsidiary Classes"
    ],
    "labelText": "labelText",
    "technicalName": "technicalName",
    "packingDetails":
    {
    "packingInstructions": "packing Instructions",
    "cargoAircraftOnly": true
    },
    "authorization": "authorization",
    "reportableQuantity": true,
    "percentage": 12.45,
    "id": "123",
    "packingGroup": "I",
    "properShippingName": "properShippingName",
    "hazardClass": "hazard Class"
    }
    },
    "description":
    {
    "sequenceNumber": 876,
    "packingInstructions": "packingInstructions",
    "subsidiaryClasses":
    [
    "Subsidiary Classes"
    ],
    "labelText": "labelText",
    "tunnelRestrictionCode": "UN2919",
    "specialProvisions": "specialProvisions",
    "properShippingNameAndDescription": "properShippingNameAndDescription",
    "technicalName": "technicalName",
    "symbols": "symbols",
    "authorization": "authorization",
    "attributes":
    [
    "attributes"
    ],
    "id": "1234",
    "packingGroup": "packingGroup",
    "properShippingName": "properShippingName",
    "hazardClass": "hazardClass"
    },
    "netExplosiveDetail":
    {
    "amount": 10,
    "units": "units",
    "type": "NET_EXPLOSIVE_WEIGHT"
    },
    "massPoints": 2
    }
    ]
    }
    ],
    "cargoAircraftOnly": true,
    "referenceId": "123456",
    "radioactiveTransportIndex": 2.45
    }
    }
    ],
    "operationalDetail":
    {
    "originServiceArea": "A1",
    "serviceCode": "010",
    "airportId": "DFW",
    "postalCode": "38010",
    "scac": "scac",
    "deliveryDay": "TUE",
    "originLocationId": "678",
    "countryCode": "US",
    "astraDescription": "SMART POST",
    "originLocationNumber": 243,
    "deliveryDate": "2001-04-05",
    "deliveryEligibilities":
    [
    "deliveryEligibilities"
    ],
    "ineligibleForMoneyBackGuarantee": true,
    "maximumTransitTime": "SEVEN_DAYS",
    "destinationLocationStateOrProvinceCode": "GA",
    "astraPlannedServiceLevel": "TUE - 15 OCT 10:30A",
    "destinationLocationId": "DALA",
    "transitTime": "TWO_DAYS",
    "stateOrProvinceCode": "GA",
    "destinationLocationNumber": 876,
    "packagingCode": "03",
    "commitDate": "2019-10-15",
    "publishedDeliveryTime": "10:30A",
    "ursaSuffixCode": "Ga",
    "ursaPrefixCode": "XH",
    "destinationServiceArea": "A1",
    "commitDay": "TUE",
    "customTransitTime": "ONE_DAY"
    },
    "carrierCode": "FDXE",
    "completedHoldAtLocationDetail":
    {
    "holdingLocationType": "FEDEX_STAFFED",
    "holdingLocation":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName": "John Taylor",
    "tollFreePhoneNumber": "6127812",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": "91",
    "faxNumber": "1234567890",
    "pagerNumber": "6127812",
    "companyName": "Fedex",
    "title": "title"
    }
    }
    },
    "completedEtdDetail":
    {
    "folderId": "0b0493e580dc1a1b",
    "type": "COMMERCIAL_INVOICE",
    "uploadDocumentReferenceDetails":
    [
    {
    "documentType": "PRO_FORMA_INVOICE",
    "documentReference": "DocumentReference",
    "description": "PRO FORMA INVOICE",
    "documentId": "090927d680038c61"
    }
    ]
    },
    "packagingDescription": "description",
    "masterTrackingId":
    {
    "formId": "0201",
    "trackingIdType": "EXPRESS",
    "uspsApplicationId": "92",
    "trackingNumber": "49092000070120032835"
    },
    "serviceDescription":
    {
    "serviceType": "FEDEX_1_DAY_FREIGHT",
    "code": "80",
    "names":
    [
    {
    "type": "long",
    "encoding": "UTF-8",
    "value": "F-2"
    }
    ],
    "operatingOrgCodes":
    [
    "FXE"
    ],
    "astraDescription": "2 DAY FRT",
    "description": "description",
    "serviceId": "EP1000000027",
    "serviceCategory": "freight"
    },
    "usDomestic": true,
    "hazardousShipmentDetail":
    {
    "hazardousSummaryDetail":
    {
    "smallQuantityExceptionPackageCount": 10
    },
    "adrLicense":
    {
    "licenseOrPermitDetail":
    {
    "number": "12345",
    "effectiveDate": "2019-08-09",
    "expirationDate": "2019-04-09"
    }
    },
    "dryIceDetail":
    {
    "totalWeight":
    {
    "units": "KG",
    "value": 68
    },
    "packageCount": 10,
    "processingOptions":
    {
    "options":
    [
    "options"
    ]
    }
    }
    },
    "shipmentRating":
    {
    "actualRateType": "PAYOR_LIST_SHIPMENT",
    "shipmentRateDetails":
    [
    {
    "rateZone": "US001O",
    "ratedWeightMethod": "ACTUAL",
    "totalDutiesTaxesAndFees": 24.56,
    "pricingCode": "LTL_FREIGHT",
    "totalFreightDiscounts": 1.56,
    "totalTaxes": 3.45,
    "totalDutiesAndTaxes": 6.78,
    "totalAncillaryFeesAndTaxes": 5.67,
    "taxes":
    [
    {
    "amount": 10,
    "level": "level",
    "description": "description",
    "type": "type"
    }
    ],
    "totalRebates": 1.98,
    "fuelSurchargePercent": 4.56,
    "currencyExchangeRate":
    {
    "rate": 25.6,
    "fromCurrency": "Rupee",
    "intoCurrency": "USD"
    },
    "totalNetFreight": 9.56,
    "totalNetFedExCharge": 88.56,
    "shipmentLegRateDetails":
    [
    {
    "rateZone": "rateZone",
    "pricingCode": "pricingCode",
    "taxes":
    [
    {
    "amount": 10,
    "level": "level",
    "description": "description",
    "type": "type"
    }
    ],
    "totalDimWeight":
    {
    "units": "KG",
    "value": 68
    },
    "totalRebates": 2,
    "fuelSurchargePercent": 6,
    "currencyExchangeRate":
    {
    "rate": 25.6,
    "fromCurrency": "Rupee",
    "intoCurrency": "USD"
    },
    "dimDivisor": 6,
    "rateType": "PAYOR_RETAIL_PACKAGE",
    "legDestinationLocationId": "legDestinationLocationId",
    "dimDivisorType": "dimDivisorType",
    "totalBaseCharge": 6,
    "ratedWeightMethod": "ratedWeightMethod",
    "totalFreightDiscounts": 9,
    "totalTaxes": 12.6,
    "minimumChargeType": "minimumChargeType",
    "totalDutiesAndTaxes": 17.78,
    "totalNetFreight": 6,
    "totalNetFedExCharge": 3.2,
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "totalSurcharges": 5,
    "totalBillingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "freightDiscounts":
    [
    {
    "amount": 8.9,
    "rateDiscountType": "COUPON",
    "percent": 28.9,
    "description": "description"
    }
    ],
    "rateScale": "6702",
    "totalNetCharge": 25.3,
    "totalNetChargeWithDutiesAndTaxes": 25.67,
    "currency": "USD"
    }
    ],
    "dimDivisor": 0,
    "rateType": "RATED_ACCOUNT_SHIPMENT",
    "surcharges":
    [
    {
    "amount": null,
    "surchargeType": "APPOINTMENT_DELIVERY",
    "level": "PACKAGE, or SHIPMENT",
    "description": "description"
    }
    ],
    "totalSurcharges": 9.88,
    "totalBillingWeight":
    {
    "units": "KG",
    "value": 68
    },
    "freightDiscounts":
    [
    {
    "amount": 8.9,
    "rateDiscountType": "COUPON",
    "percent": 28.9,
    "description": "description"
    }
    ],
    "rateScale": "00000",
    "totalNetCharge": 3.78,
    "totalBaseCharge": 234.56,
    "totalNetChargeWithDutiesAndTaxes": 222.56,
    "currency": "USD"
    }
    ]
    },
    "documentRequirements":
    {
    "requiredDocuments":
    [
    "COMMERCIAL_OR_PRO_FORMA_INVOICE",
    "AIR_WAYBILL"
    ],
    "prohibitedDocuments":
    [
    "CERTIFICATE_OF_ORIGIN"
    ],
    "generationDetails":
    [
    {
    "type": "COMMERCIAL_INVOICE",
    "minimumCopiesRequired": 3,
    "letterhead": "OPTIONAL",
    "electronicSignature": "OPTIONAL"
    }
    ]
    },
    "exportComplianceStatement": "12345678901234567",
    "accessDetail":
    {
    "accessorDetails":
    [
    {
    "password": "password",
    "role": "role",
    "emailLabelUrl": "emailLabelUrl",
    "userId": "userId"
    }
    ]
    }
    },
    "shipmentAdvisoryDetails":
    {
    "regulatoryAdvisory":
    {
    "commodityClarifications":
    [
    {
    "commodityIndex": 25,
    "suggestions":
    [
    {
    "description": "description",
    "harmonizedCode": "harmonized Code"
    }
    ]
    }
    ],
    "prohibitions":
    [
    {
    "derivedHarmonizedCode": "01",
    "advisory":
    {
    "code": "code",
    "text": "Text",
    "parameters":
    [
    {
    "id": "message ID",
    "value": "Message value"
    }
    ],
    "localizedText": "localizedText"
    },
    "commodityIndex": 12,
    "source": "source",
    "categories":
    [
    "categories"
    ],
    "type": "type",
    "waiver":
    {
    "advisories":
    [
    {
    "code": "code",
    "text": "Text",
    "parameters":
    [
    {
    "id": "message ID",
    "value": "Message value"
    }
    ],
    "localizedText": "localizedText"
    }
    ],
    "description": "description",
    "id": "id"
    },
    "status": "status"
    }
    ]
    }
    },
    "masterTrackingNumber": "794953535000"
    }
  ],
- "alerts":
  [
  - {
    "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
    "alertType": "NOTE",
    "message": "Recipient Postal-City Mismatch."
    }
  ]
}

}

Request
Response

Response

Copy

Developer Portal

Open Ship API

Einleitung

Informationen zur API für offene Sendungen

Workflow der API für offene Sendungen

So funktioniert die API für offene Sendungen

Offene Mehrpaketsendungen (MPS)

FedEx Versandetiketten

Geschäftsregeln

JSON API-Sammlung

Open Ship API (1.0)

Create Open Shipment

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Modify Open Shipment

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Confirm Open Shipment

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Modify Open Shipment Packages

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Add Open Shipment Packages

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Delete Open Shipment Packages

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Retrieve Open Shipment Package

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

OpenShipmentDelete V1

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Retrieve Open Shipment

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Get Open Shipment Results

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Enter your user ID and password to log in