Global Trade API
Einleitung
Mit der API für weltweiten Handel können Sie die Liste der Rechtsdokumente abrufen, die Sie für den Versand Ihrer Sendung benötigen. Rechtsdokumente sind erforderlich, um Probleme bei der Einhaltung von Vorschriften zu vermeiden, die in der Regel zu Verzögerungen bei der Zollabfertigung, Strafzuschlägen und Problemen mit der Kundenzufriedenheit führen.
DIE API stellt außerdem Folgendes bereit:
- Wichtige Informationen von FedEx, behördliche Mitteilungen sowie Empfehlungen speziell für Ihre Sendung. Beispiele:
- Aktuelle Situationen, die sich ggf. auf den Versand auswirken
- Wetter- und andere Verzögerungen
- Regulatorische Neuigkeiten und Updates
- Möglichkeit, zu ermitteln, ob für Ihre Sendung elektronische Ausfuhrinformationen (EEI) beim US-Zoll eingereicht werden müssen.
- Möglichkeit, EEI beim US-Zoll mit FedEx als Zollagenten einzureichen.
- Möglichkeit, die interne Transaktionsnummer (ITN) abzurufen, um sie dann bei der nachfolgenden Sendungstransaktion zum Zuordnen zu den entsprechenden EEI zu nutzen.
Weitere Informationen zu EEI finden Sie auf den folgenden Seiten:
- FedEx Seite für den internationalen Versand
- FedEx Global Trade Manager
- Einreichung von AES exportieren
Details zur API für weltweiten Handel
Mit dieser API können Sie die Liste der für die Sendung erforderlichen Rechtsdokumente und Empfehlungen abrufen. Sie können auch ermitteln, ob für Ihre Sendung elektronische Ausfuhrinformationen (EEI) beim US-Zoll eingereicht werden müssen. Ist dies der Fall, erhalten Sie Hilfe beim Einreichen. Sie können auch die ITN für Ihre Sendung abrufen.
Die folgenden Funktionen sind mit der API für weltweiten Handel verknüpft:
Rechtliche Informationen abrufen
Diese Funktion hilft Ihnen, die Liste der für Ihre internationalen Sendungen erforderlichen Dokumente abzurufen, und gestaltet die Zollabfertigung so möglichst reibungslos.
Alle Dossiers, Unterlagen, Anträge, Änderungen, Ergänzungen, Revisionen, Berichte, Einreichungen, Genehmigungen und Zulassungen sowie alle Berichte oder Änderungen, die zum Erhalt von behördlichen Genehmigungen in der Frühphase des internationalen Versands erforderlich sind.
Die folgenden Arten von Rechtsdokumenten werden unterstützt:
- FEDEX_GENERATED: Gibt an, dass das Dokument über ein internes FedEx System konfiguriert und erstellt wurde. Dieses Dokument kann von dem*der Kunden*in nicht konfiguriert oder geändert werden. Beispiel: Von FedEx Express erstellte Handelsrechnung, Von FedEx Express erstellte Pro-forma Rechnung.
- FILLABLE: Gibt die Formulare und Dokumente an, die entweder online oder nach dem Herunterladen von den FedEx Webseiten aufgefüllt werden können. Diese Formulare stehen auch in FedEx Ship Center Stationen zur Verfügung. Beispiel: CN 22 – Formular für die Zollanmeldung per Post.
- PRINT_ONLY: Gibt die Dokumente und Formulare an, die nur in gedruckter Form akzeptiert werden. Beispiel: Rechnungen.
- SAMPLE: Gibt die von FedEx Express generierten Musterdokumente an. Beispiel: Muster-Handelsrechnung.
Empfehlungen abrufen
Mit dieser Funktion können Sie wichtige Rechtsdokumente, FedEx Empfehlungen oder Behördenempfehlungen für Ihre Sendung abrufen. Empfehlungen können sich auf Wettervorhersagen, Service-Unterbrechungen oder auf offizielle Warnungen von Behörden beziehen, z. B. zur relativen Sicherheit von Reisen in bestimmte Länder bzw. zu bestimmten Bestimmungsorten.
Die folgenden Empfehlungstypen werden von FedEx Express unterstützt:
- APPLICATION
- DOCUMENT_SPECIFIC
- FEDEX
- GOVERNMENT
- INSPECTION
- LICENSE_OR_PERMIT
- MAYBE_DOCUMENT
- MAYBE_STATEMENT
- PROHIBIT
- UNIT_OF_MEASURE
- WAIVER
Elektronische Ausfuhrinformationen (EEI)
Elektronische Ausfuhrinformationen (EEI) sind erforderlich, wenn der Wert der unter jeder einzelnen Schedule-B-Nummer klassifizierten Ware mehr als 2.500 US$ beträgt oder wenn für die Ausfuhr der Ware eine validierte Exportlizenz erforderlich ist.
EEI sind die Daten, die über das Automatisierte Ausfuhrsystem (AES) für Waren eingereicht werden müssen, die von den USA aus ins Ausland versendet werden. Die Einreichung enthält Informationen über den*die Versender*in und den*die Empfänger*in der Waren sowie über die auszuführenden Waren. Das Census Bureau greift beim Berechnen der US-Handelsstatistiken auf diese Einreichungen zurück. Customs and Border Protection (CBP) und das Bureau of Industry and Security (BIS) nutzen die Daten, um die Einhaltung der US-Ausfuhrvorschriften zu gewährleisten.
Der*Die Exporteur*in ist für die Vorbereitung der EEI verantwortlich. Der Frachtführer reicht sie über das Automated Commercial Environment (ACE) und innerhalb dieses Systems über AES Direct bei U.S. Customs and Border Protection (CBP) ein. Für jeden EEI-Datensatz generiert das AES eine eindeutige ITN, die bestätigt, dass die EEI-Transaktion akzeptiert wurde und im AES gespeichert ist.
Anforderungen
Der*Die Kund*in muss eine US-basierte Kundennummer verwenden.
Transitanforderungen:
- Von den USA, Puerto Rico oder der US-amerikanischen Jungferninseln zu Bestimmungsorten im Ausland,
- Zwischen den USA und Puerto Rico,
- Von den USA oder Puerto Rico zu den US-amerikanischen Jungferninseln.
Die Sendung wird unter demselben Schedule B oder derselben Zolltarifnummer im Wert von mehr als 2.500 US$ von dem*derselben Exporteur*in an den*dieselbe*n Empfänger*in am selben Tag versendet.
(Hinweis: Davon ausgenommen sind Sendungen aus den USA nach Kanada.)
- Die Sendung enthält Rohdiamanten (HTS 7102.10, 7102.21 und 7102.31).
- Es ist eine Exportlizenz oder Ausfuhrgenehmigung der US-Regierung erforderlich.
- Unterliegt den U.S. International Traffic in Arms Regulations (ITAR).
- Unterliegt den in den US-Außenhandelsbestimmungen aufgeführten Anforderungen an die Ware, den*die Endbenutzer*in oder den Bestimmungsort.
So funktioniert die API für weltweiten Handel
Rechtliche Informationen abrufen
Über diesen Endpunkt können Sie die erforderlichen Rechtsdokumente sowie Empfehlungen vor dem Versand abrufen.
Nachfolgend finden Sie die für diesen Endpunkt erforderlichen Informationen.
- Ursprungsadresse: Geben Sie die Details zur Ursprungsadresse an, z. B. Land, Postleitzahl und ggf. Code für Bundesstaat/Provinz.
- Bestimmungsadresse: Geben Sie die Details zur Bestimmungsadresse an, z. B. Land, Postleitzahl und ggf. Code für Bundesstaat/Provinz.
- Zollabfertigungsdetail: Geben Sie die Zollabfertigungszuschläge, die Zolltarifnummer (HS-Code) und weitere Maße der Sendung an.
- Frachtführer-Code: Geben Sie den für die Sendung erforderlichen FedEx Frachtführer an.
- Gesamtgewicht: Geben Sie das Gesamtgewicht der Sendung in der entsprechenden Maßeinheit an.
Ist die Anfrage erfolgreich, wird eine Liste aller verfügbaren Rechtsdokumente und Empfehlungen für die Eingabe zurückgegeben. Ist die Anfrage fehlerhaft, werden im Fehlerobjekt Fehlermeldungen und -codes bereitgestellt.
Suche nach regulatorischen Vorschriften
Verwenden Sie diesen Endpunkt, um zu ermitteln, ob für die Sendung Ausfuhr- und/oder Einfuhrbestimmungen gelten.
Die folgenden Compliancetypen werden bis dato unterstützt:
Ausfuhr:
- EEI-Einreichung beim US-Zoll ist für eine Sendung erforderlich.
Einfuhr:
- Keine
Nachfolgend finden Sie die für diesen Endpunkt erforderlichen Informationen:
- shipDate: Geben Sie das Versanddatum an.
- carrierCode: Geben Sie den FedEx Frachtführercode an. Beispiel: FXE.
- originAddress:
- countryCode: Geben Sie den Ursprungsort-Ländercode für die Sendung an.
- destinationAddress:
- countryCode: Geben Sie den Bestimmungsort-Ländercode für die Sendung an.
- serviceType: Geben Sie den ausgewählten Servicetyp der FedEx Betriebsgesellschaft an. Beispiel: IP, SG, PO usw.
- serviceOptionTypes: Geben Sie die Funktion des Servicetyps an. Beispiel: FICE, ITAR.
- totalWeight: Geben Sie das Gesamtgewicht der Sendung an.
- units: Geben Sie die Gewichtseinheit an. Beispiel: kg, lbs usw.
- value: Geben Sie das Gewicht der Sendung an. Beispiel: 68,50
- consolidationType: Geben Sie den Konsolidierungstyp an. Beispiel: IPD
- consolidationRole: Geben Sie die Rollen der Sendung innerhalb der Konsolidierung an. Beispiel: CRN_SHIPMENT
- totalCommodityValue: Geben Sie den Gesamtwert der Sendung an.
- regulatoryCustomsClearanceDetail: Geben Sie die regulatorischen Zölle an.
Ist die Antwort auf diese Anfrage erfolgreich, können Sie ermitteln, ob für Ihre Sendung EEI eingereicht werden müssen oder nicht.
EEI einreichen
Verwenden Sie diesen Endpunkt, um EEI beim US-Zoll einzureichen oder vorhandene EEI zu aktualisieren oder zu stornieren.
Nachfolgend finden Sie die für diesen Endpunkt erforderlichen Informationen:
- processingOption: Geben Sie die Bearbeitungsoption für Ihre EEI-Anfrage an. Beispiel: ADD, UDPATE, CANCEL
- eeiControlDetail:
- shipDate: Geben Sie das Versanddatum an.
- accountNumber: Geben Sie Ihre FedEx Kundennummer an.
- eeiPartyDetails: Geben Sie die Details zum Spediteur an.
- eeiShipmentPartyType
- eeiContactAndAddress
- contact:
- companyName: Geben Sie den Namen des Unternehmens an.
- address:
- streetlines: Geben Sie Straße und Hausnummer des Unternehmens an. Beispiel: BUILDING
- city: Geben Sie den Ort des Unternehmens an. Beispiel: PARIS
- countryCode: Geben Sie den Ländercode an. Beispiel: US
- contact:
- eeiCommodities
- commodity: Geben Sie die Warenposition innerhalb der Sendung an.
- description: Stellen Sie eine Beschreibung der Waren bereit.
- harmonizedCode: Geben Sie die Zolltarifnummer (HS-Code) an.
- quantityUnits: Geben Sie den Maßeinheitencode an wie von der gemeldeten B/HTS-Nummer vorgeschrieben.
- Weight: Geben Sie das Gewicht der Waren an.
- Units: Geben Sie die Gewichtseinheit an. Beispiel: kg
- HarmonizedCode: Geben Sie die Zolltarifnummer (HS-Code) an.
- quantityUnits: Geben Sie den Maßeinheitencode an wie von der gemeldeten B/HTS-Nummer vorgeschrieben.
- weight: Geben Sie das Gewicht der Waren an.
- Units: Geben Sie die Gewichtseinheit an. Beispiel: kg
- exportInformationCode: Geben Sie den Code für die Ausfuhrinformationen an. Beispiel: GP
- eeiCommodityLicenseDetail:
- licenseCode: Geben Sie den Lizenzcode an.
- commodity: Geben Sie die Warenposition innerhalb der Sendung an.
Ist die Antwort auf diese Anfrage erfolgreich, werden die EEI Ihrer Sendung beim US-Zoll eingereicht und eine Sendungsreferenznummer (SRN) vergeben. Die in der Antwort erhaltene Sendungsreferenznummer (SRN) ist erforderlich, um die interne Transaktionsnummer (ITN) abzurufen.
ITN abrufen
Verwenden Sie diesen Endpunkt, um die interne Transaktionsnummer (ITN) für EEI abzurufen, die bereits beim US-Zoll eingereicht wurden.
Nachfolgend finden Sie die für diesen Endpunkt erforderlichen Informationen:
- shipmentReferenceNumber: Geben Sie die Sendungsreferenznummer an, die Sie über die FileEEI-Transaktion erhalten haben.
Ist die Anfrage erfolgreich, wird die ITN der eingereichten EEI zurückgegeben. Diese ITN muss in der entsprechenden Sendungstransaktionsanfrage angegeben werden.
Zum Beispiel müssen in der Ship API die folgenden Elemente ausgefüllt werden, um Ihre ITN oder EEI-Steuerbefreiungsnummer an FedEx zu übermitteln.
Element | Beschreibung |
---|---|
Sender/Tins/TinType |
Versender*innen müssen Steuer-Identifikationsangaben für EEI-Sendungen bei FedEx hochladen. Geben Sie die EIN (Employer Identification Number, Arbeitgeber-Identifikationsnummer) an. Gültige Werte:
|
Sender/Tins/Number |
Geben Sie die Identifikationsnummer des*der Steuerzahler*in mit der entsprechenden ID-Nummer für „TinType“ an. |
CustomsClearanceDetail/ExportDetail/ ExportComplianceStatement |
Geben Sie für Sendungen, für die elektronische Ausfuhrinformationen (EEI) erforderlich sind, die ITN an, die Sie nach dem Einreichen Ihrer Sendung oder der FTR-Steuerbefreiungsnummer über das AES erhalten haben, oder die ITN, die Sie über die Einreichung der EEI mit/über FedEx erhalten haben. Das gültige Format zur Eingabe einer ITN ist: AES XJJJJMMTTNNNNNN, wobei JJJJMMTT das Datum und NNNNNN eine vom AES generierte Nummer ist. |
Hinweis: Die ITN oder FTR-Steuerbefreiungsnummer, die Sie während der Versandanfrage übermitteln, wird auf das internationale Versandetikett gedruckt.
Versanddokumente
Eine genaue Dokumentation ist sowohl bei nationalen als auch internationalen Sendungen erforderlich, um die Beschlagnahmung oder Verzögerungen beim Zoll zu vermeiden und eine reibungslose Paketzustellung zu gewährleisten.
Im Folgenden sind die verschiedenen Typen von Versand- und Zolldokumenten aufgeführt, die über die FedEx Global Trade Manager API verfügbar sind.
Hinweis:
- Möglicherweise sind für Ihre Sendung andere, an dieser Stelle nicht aufgeführte Handelsdokumente erforderlich. Dies ist abhängig von der Art der Waren. Informationen über die für eine reibungslose Zollabfertigung Ihrer Sendung erforderlichen Dokumente erhalten Sie auch vom FedEx Kundendienst.
Ursprungszeugnis
Ein COO ist ein internationales Dokument, das bestätigt, in welchem Land/Gebiet ein Produkt hergestellt wurde. In einigen Ländern ist die Einfuhr von Produkten aus bestimmten Ländern untersagt, in vielen Ländern ist die zulässige Menge eingeführter Waren beschränkt und in einigen Ländern erfolgt für aus bestimmten Ländern eingeführte Waren eine Präferenzbehandlung.
[Service ENUM : CERTIFICATE_OF_ORIGIN]
Handelsrechnung
Hierbei handelt es sich um ein von dem*der Verkäufer*in/Exporteur vorgelegtes Dokument, das die am Versandgeschäft beteiligten Parteien und die transportierten Waren beschreibt. Es ist das vom Zoll primär genutzte Dokument. Es sollte möglichst unter Verwendung der offiziellen Sprache des Lands/Gebiets erstellt werden, in das die Waren ausgeführt werden (diese Option besteht bei von FedEx Express erstellten Rechnungen nicht). Die Handelsrechnung sollte eine detaillierte Aufschlüsselung aller Artikel umfassen, die in der Sendung enthalten sind: einschließlich einer ordnungsgemäßen Beschreibung der Waren (Worum handelt es sich? Woraus sind die Waren gefertigt? Was ist der vorgesehene Verwendungszweck?), der Menge, des Herstellungslands/-gebiets, des Preises oder der Kosten, der verwendeten Währung, des HS-Codes für jede Ware und der Lieferbedingungen. Einige Länder verlangen, dass eine Originalrechnung mit dem Briefkopf des*der Versender*in erstellt wird. Die Rechnung sollte immer von dem der Exporteur unterzeichnet und datiert werden, wobei dieser bescheinigt, dass die angegebenen Einzelheiten wahre und richtige Darstellungen des Inhalts sind, der von der Handelsrechnung erfasst wird. [Service ENUM: COMMERCIAL_INVOICE]
Weitere Informationen finden Sie im FedEx Global Trade Manager.
Gefahrguterklärung des Versenders
Dies ist eine Erklärung des*der Absender*in für Sendungen, die laut Safety Data Guide (SDG), International Air Transport Association (IATA) und International Civil Aviation Organization (ICAO) als Gefahrgut eingestuft sind. Das Formular FX 18 verlangt von den von FedEx Express anerkannten Anbietern die Vorlage der Gefahrguterklärung des*der Absender*in für Sendungen, die als Gefahrgut eingestuft sind und aus den USA stammen.
[Service ENUM : DANGEROUS_GOODS_SHIPPERS_DECLARATION]
Ausfuhrerklärung
Die Elektronischen Ausfuhrinformationen (EEI), ehemals Exportversanderklärung (SED), werden vom US Department of Census (US-Statistikamt) zur Beschaffung statistischer Daten und vom Bureau of Industry and Security (BIS – Industrie- und Sicherheitsbehörde) als Unterstützung für die Durchsetzung von Ausfuhrkontrollen benötigt. Die SED/EEI ist/sind erforderlich, wenn der Gesamtwert der Waren, die unter einer einzelnen Nummer der Schedule-B klassifiziert sind, 2.500 US$ übersteigt oder wenn für die Waren eine Ausfuhrgenehmigung erforderlich ist. Diese Informationen können vom Exporteur oder seinem*r Vertreter*in elektronisch übermittelt werden. Die Informationen müssen für Waren, die auf der Commerce Control List (CCL) oder der U.S. Munitions List (USML) aufgeführt sind, elektronisch über das Automatisierte Ausfuhrsystem (AES) übermittelt werden.
Hinweis: Dies ist nur für Ausfuhrsendungen aus den USA erforderlich.
[Service ENUM : EXPORT_DECLARATION]
General Agency Agreement
Eine Vertretungsvereinbarung oder Vollmacht (POA) ist die rechtliche Befugnis, die vom Importeur einem Zollagenten übertragen wird, um ihm die Freigabe und/oder Erfassung von Sendungen bei der Canada Revenue Agency (CRA) im Namen des Unternehmens des Importeurs zu ermöglichen. Wenn ein in Kanada ansässiger Importeur möchte, dass Federal Express dauerhaft als sein Zollagent in Kanada tätig wird, müssen diese Formulare vor dem Versand nach Kanada entsprechend den Anweisungen ausgefüllt und zurückgeschickt werden. Dieses Vollmachtsformular (POA) ist eine eingeschränkte Vertretungsvereinbarung und gilt nur für Federal Express Sendungen. Das Formular finden Sie in einem Format, das einfach ausgefüllt und verwendet werden kann, im Bereich der Dokumentenbibliothek auf dieser Webseite.
[Service ENUM : GENERAL_AGENCY_AGREEMENT]
OP900
Das DOT erfordert dieses Formular für den Versand von Gefahrgut. Der*die Kund*in erhält ein spezifisches OP-900-Formular, das je nach Sendung auszufüllen ist.
Beispiele:
- OP-900LL bei Sendung eines Laserdruckers
- OP-900LG bei Sendung eines Matrixdruckers
Hinweis: Handschriftlich ausgefüllte Formulare werden nicht mehr akzeptiert, daher müssen Sie das Formular ausfüllen und uns eine digitale Kopie zukommen lassen.
[Service ENUM : OP_900]
Pro-forma-Rechnung
Die Pro-forma-Rechnung wird vor dem Verkauf ausgestellt. Nach Erhalt der Pro-forma-Rechnung vom Lieferanten sendet der*die Käufer*in eine Bestellung oder eröffnet ein Akkreditiv für den Lieferanten. Der*die Verkäufer*in veranlasst zum vereinbarten Versandtermin den Versand der Waren.
[Service ENUM: PRO_FORMA_INVOICE]
VICS-Konnossement
Das VICS-Konnossementformular der VICS (Voluntary Inter-Industry Commerce Standards) Association wird hauptsächlich für allgemeine Warensendungen im Einzelhandel verwendet.
[Service ENUM: VICS_BILL_OF_LADING]
USMCA-Handelsrechnung und -Ursprungszeugnis
Das Formular „USMCA/T-MEC/CUSMA Handelsrechnung – Ursprungszeugnis“ umfasst eine Handelsrechnung, die erforderlichen Datenelemente des Ursprungszeugnisses sowie die Erklärung für den Versand von Waren, die unter das USMCA-Abkommen zwischen den USA, Mexiko und Kanada fallen und für die Beantragung der entsprechenden Zollpräferenzbehandlung. Waren, die für eine Zollpräferenzbehandlung in Frage kommen, müssen aus den USA, Mexiko oder Kanada stammen und aus einem dieser Länder ausgeführt werden. [Service ENUM: USMCA_COMMERCIAL_INVOICE_CERTIFICATION_OF_ORIGIN]
USMCA-Ursprungszeugnis
Das USMCA/T-MEC/CUSMA-Ursprungszeugnis ist ein Formular zur Beantragung der Zollpräferenzbehandlung im Rahmen des USMCA-Abkommens zwischen den USA, Mexiko und Kanada. Das Ursprungszeugnis umfasst eine Reihe von Datenelementen sowie eine Erklärung und muss vom Exporteur, Hersteller oder Importeur für Waren, welche die Voraussetzungen erfüllen, zertifiziert werden. Die eingeführten Waren müssen aus den USA, Mexiko oder Kanada stammen und aus einem dieser Länder ausgeführt werden. Dieses Formular kann entweder für eine einzelne Sendung oder für einen „Pauschalzeitraum“ von bis zu zwölf Monaten genutzt werden.
[Service ENUM: USMCA_CERTIFICATION_OF_ORIGIN]
Geschäftsregeln
- Die Handelsrechnung sollte möglichst in der offiziellen Sprache des Lands/Gebiets verfasst werden, in das die Waren ausgeführt werden. Diese Option besteht bei von FedEx Express erstellten Rechnungen nicht. Daher müssen Kund*innen ihre eigene Handelsrechnung drucken.
- FedEx Express akzeptiert nur digitale Exemplare des OP-900-Formulars. Handschriftlich ausgefüllte Formulare werden nicht akzeptiert.
JSON API-Sammlung
Global Trade - API (1.0)
Retrieve Regulatory Details
Use this endpoint to retrieve regulatory document and advisories for your shipment.
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
- FullSchema
- MinimumSamplePayload
serviceType | string Specify the type of service that is used to ship the package. |
totalCommodityValue | object Specify the total commodity value. Either customsClearenceDetail or totalCommodityValue is required. |
originAddress required | object Provide the shipment origin address details. |
destinationAddress required | object Provide the shipment destination address details. |
serviceOptionType | Array of strings Items Enum: "FEDEX_ONE_RATE" "FREIGHT_GUARANTEE" "SATURDAY_DELIVERY" "SMART_POST_ALLOWED_INDICIA" "SMART_POST_HUB_ID" Specify attributes to filter location types. If more than one value is specified, only those locations that have all the specified attributes will be returned. |
customsClearanceDetail | object Specify the Customs clearance details.Either customsClearenceDetail or totalCommodityValue is required. |
shipDate | string Specify shipment date. |
carrierCode required | string Specify the four letter code of a FedEx operating company that meets your requirements.
Example: FDXE |
totalWeight | object Provide the total weight for the shipment. |
includeURLReferences | boolean Specify if the url references to be included in the output. These are regulatory reference data urls specific to document, agency. |
consolidationType | string Specify the type of consolidation that contains this shipment.
|
consolidationRole | string Specify the role this shipment plays within the consolidation.
|
Responses
Success
Bad Request
Unauthorized
Not Found
UnProcessable Entity
Failure
Sandbox Server
Production Server
Request samples
- Payload
- C#
- JAVA
- JAVASCRIPT
- PHP
- PYTHON
- RUST
- SWIFT
- "serviceType": "FEDEX_FREIGHT_ECONOMY",
- "totalCommodityValue": {
- "amount": 12.45,
- "currency": "USD"
- "originAddress": {
- "countryCode": "US",
- "postalCode": "75063",
- "stateOrProvinceCode": "TX"
- "destinationAddress": {
- "countryCode": "US",
- "postalCode": "75063",
- "stateOrProvinceCode": "TX"
- "serviceOptionType": [
- "FEDEX_ONE_RATE",
- "SATURDAY_DELIVERY"
- "customsClearanceDetail": {
- "regulatoryControls": "NOT_IN_FREE_CIRCULATION",
- "insuranceCharges": {
- "amount": 12.45,
- "currency": "USD"
- "importerOfRecordAccountNumber": {
- "0": "8",
- "1": "9",
- "2": "7",
- "3": "6",
- "4": "5",
- "5": "4",
- "6": "5",
- "7": "6",
- "8": "4"
- "customsValue": {
- "amount": 12.45,
- "currency": "USD"
- "commercialInvoice": {
- "freightCharge": {
- "amount": 12.45,
- "currency": "USD"
- "purpose": "SOLD"
- "commodities": [
- {
- "quantity": "string",
- "quantityUOM": "string",
- "customsValue": {
- "amount": 12.45,
- "currency": "USD"
- "countryOfManufacture": "US",
- "name": "string",
- "harmonizedCode": "0613",
- "description": "string",
- "weight": {
- "units": "KG",
- "value": 68
- "commodityId": 0,
- "additionalMeasures": {
- "uom": "string",
- "quantity": 0
- "documentContent": "DOCUMENT"
- "shipDate": "2019-10-14",
- "carrierCode": "FDXE",
- "totalWeight": {
- "units": "KG",
- "value": 68
- "includeURLReferences": true,
- "consolidationType": "INTERNATIONAL_DISTRIBUTION_FREIGHT",
- "consolidationRole": "CONSOLIDATION_DOCUMENTS_SHIPMENT"
Response samples
- 200
- 400
- 401
- 404
- 422
- 500
- "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
- "customerTransactionId": "AnyCo_order123456789",
- "output": {
- "userMessages": [
- {
- "code": "1028",
- "messageParameters": [
- {
- "id": "1",
- "value": "Based on shipment information provided, only non-document/commodity type is permitted for this shipment"
- "index": 1,
- "text": "Based on shipment information provided, only non-document/commodity type is permitted for this shipment",
- "localizedText": "Selon les informations fournies sur l envoi, seul le type de produit / document est autorisé pour cet envo"
- "countryDetails": {
- "shipmentDetails": {
- "regulatoryStatements": {
- "userMessage": {
- "code": "1028",
- "messageParameters": [
- {
- "id": "1",
- "value": "Based on shipment information provided, only non-document/commodity type is permitted for this shipment"
- "index": 1,
- "text": "Based on shipment information provided, only non-document/commodity type is permitted for this shipment",
- "localizedText": "Selon les informations fournies sur l envoi, seul le type de produit / document est autorisé pour cet envo"
- "supportType": "FEDEX_GENERATED",
- "allowability": "string",
- "fileName": "string",
- "agencyUrl": "string",
- "documentUrl": "string",
- "id": "string",
- "completionType": "COMPLETE",
- "agencyName": "string",
- "localizedAttributes": {
- "localization": {
- "localization": "EN",
- "localeCode": "us"
- "name": "string",
- "description": "string"
- "documentIds": [
- "string"
- "statementUrl": "string"
- "requiredCommodityUnitsOfMeasure": [
- "string"
- "level": "string",
- "commodityIndex": 0,
- "regulatoryDocuments": {
- "userMessage": {
- "code": "1028",
- "messageParameters": [
- {
- "id": "1",
- "value": "Based on shipment information provided, only non-document/commodity type is permitted for this shipment"
- "index": 1,
- "text": "Based on shipment information provided, only non-document/commodity type is permitted for this shipment",
- "localizedText": "Selon les informations fournies sur l envoi, seul le type de produit / document est autorisé pour cet envo"
- "supportType": "FEDEX_GENERATED",
- "allowability": "string",
- "fileName": "string",
- "documentType": "string",
- "agencyUrl": "string",
- "documentUrl": "string",
- "id": "string",
- "agencyName": "string",
- "localizedAttributes": {
- "localization": {
- "localization": "EN",
- "localeCode": "us"
- "name": "string",
- "description": "string"
- "regulatoryCountryAdvisories": {
- "types": "string",
- "messages": [
- {
- "code": "string",
- "text": "string",
- "parameters": [
- {
- "id": "string",
- "value": "string"
- "localizedText": "string"
- "countryCode": "string",
- "category": "string"
- "cxsalerts": [
- {
- "code": "string",
- "alertType": "NOTE",
- "parameterList": [
- {
- "value": "string",
- "key": "string"
- "message": "string"
Retrieve ITN
Use this endpoint to retrieve the ITN(internal tracking number) of an EEI(Electronic Export Information) which was already filed with US Customs.
header Parameters
x-locale | string Example: en_US This indicates the combination of language code and country code. |
content-type | 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. |
authorization required | string Example: Bearer XXXXX This indicates the authorization token for the input request |
x-customer-transaction-id | string Example: 0e671149-016f-1000-941f-ef4dbabadd2e 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. |
Request Body schema: application/json
version | object (version) |
shipmentReferenceNumber required | string This is the shipment reference number which is needed in order to retrieve the ITN (Internal Tracking Number). |
Responses
Success
Bad Request
Unauthorized
Forbidden
Not Found
Failure
Service Unavailable
Sandbox Server
Production Server
Request samples
- Payload
- C#
- JAVA
- JAVASCRIPT
- PHP
- PYTHON
- RUST
- SWIFT
- "version": {
- "major": 1,
- "minor": 1,
- "patch": 1
- "shipmentReferenceNumber": "24091060018"
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
- 503
- "transactionId": "0e671149-016f-1000-941f-ef4dbabadd2e",
- "customerTransactionId": "0e671149-016f-1000-941f-ef4dbabadd2e",
- "output": {
- "internalTrackingNumber": "X20241011791496",
- "status": "A1",
- "statusDescription": "EEI Approved",
- "alert": {
- "alertType": "NOTE",
- "message": "VALUE/QUANTITY 1 OUT OF RANGE - LOW"
File EEI
Use this endpoint to file an Electronic Export Information(EEI) with US Customs.
header Parameters
x-locale | string Example: en_US This indicates the combination of language code and country code. |
authorization required | string Example: Bearer XXXXX This indicates the authorization token for the input request. |
x-customer-transaction-id | string Example: 0e671149-016f-1000-941f-ef4dbabadd2e 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. |
Request Body schema: application/json
- FullSchema_FileEEIInputVO
- SamplePayload_CancelFiling
- SamplePayload_UpdateFiling
- Minimum_Payload
version | object (version) |
processingOption required | Array of strings Items Enum: "ADD" "CANCEL" "UPDATE" processingOption for ADD Cancel Update |
eeiControlDetail | object (FullSchema_FileEEIInputVO_eeiControlDetail) Object of EEIControlDetail |
eeiPartyDetails required | Array of objects (FullSchema_FileEEIInputVO_eeiPartyDetails) Both USPPI and ULTIMATE_CONSIGNEE are mandatory. |
eeiCommodities | Array of objects (FullSchema_FileEEIInputVO_eeiCommodities) commodity US Customs code, a high level explanation of type of export. |
Responses
Success
Bad Request
Unauthorized
Forbidden
Not Found
Failure
Sandbox Server
Production Server
Request samples
- Payload
- C#
- JAVA
- JAVASCRIPT
- PHP
- PYTHON
- RUST
- SWIFT
- "version": {
- "major": 1,
- "minor": 1,
- "patch": 1
- "processingOption": "ADD",
- "eeiControlDetail": {
- "shipDate": "2024-09-04",
- "accountNumber": {
- "value": "602345XXX"
- "portOfExportCode": "2095",
- "shipmentReferenceNumber": "24102960001",
- "hazardousMaterial": false,
- "mode": "AIR",
- "customerReferenceNumber": "410",
- "trackingNumber": "1372",
- "partiesToTransactionAreRelated": false,
- "internationalControlledExportDetail": {
- "foreignTradeZoneCode": "string",
- "entryNumber": "string"
- "eeiPartyDetails": [
- {
- "eeiShipmentPartyType": "USPPI,ULTIMATE_CONSIGNEE",
- "ultimateConsigneeType": "DIRECT_CONSUMER",
- "eeiContactAndAddress": {
- "contact": {
- "personName": {
- "firstName": "Surya",
- "lastName": "Kumar"
- "title": "Mr",
- "companyName": "MARK PVT LIMITED",
- "phoneNumber": "6127812999",
- "eMailAddress": "maneesh.nv@fedex.com"
- "address": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "TX",
- "postalCode": "26150",
- "countryCode": "US"
- "einTaxId": "456736452"
- "eeiCommodities": [
- {
- "commodity": {
- "commodityId": "12",
- "description": "REGISTERS, ACCOUNT BOOKS, NOTEBOOKS, ORDER BOOKS, RECEIPT BOOKS, LETTER PADS, MEMORANDUM PADS, DIARIES AND SIMILAR ARTICLES [REGISTERS, ACCOUNT BOOKS, NOTE BOOKS, ORDER BOOKS, RECEIPT BOOKS, LETTER PADS, MEMORANDUM PAD S, DIARIES AND SIMILAR ARTICLES, EXERCISE BOOKS, BLOTTING-PADS, BINDERS (LOOSELEAF OR OTHER)]",
- "countryOfManufacture": "US",
- "harmonizedCode": "4820100000",
- "weight": {
- "units": "KG",
- "value": 68
- "quantity": 1,
- "quantityUnits": "NO",
- "customsValue": {
- "currency": "USD",
- "amount": 2700
- "exportLicenseNumber": "26456"
- "scheduleBCode": "482010",
- "exportInformationCode": "GP",
- "eeiCommodityLicenseDetail": {
- "exportControlClassificationNumber": "0A018",
- "licenseCode": "C33",
- "licenseValue": {
- "currency": "USD",
- "amount": 0
- "inbondCode": "36",
- "usDomestic": false,
- "ddtcDetail": {
- "ddtcITARExemptionNumber": "123.11B",
- "ddtcRegistrationNumber": "C6754",
- "ddtcSignificantMilitarySMEIndicator": false,
- "ddtcEligibleParty": false,
- "usmlCategoryCode": "17",
- "ddtcXXIDeterminationNumber": "string",
- "ddtcUnitOfMeasure": {
- "units": "BBL",
- "quantity": 0
- "vehicleDetail": {
- "vinNumber": "string",
- "titleNumber": "string",
- "titleState": "string"
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
- "transactionId": "0e671149-016f-1000-941f-ef4dbabadd2e",
- "customerTransactionId": "0e671149-016f-1000-941f-ef4dbabadd2e",
- "output": {
- "shipmentReferenceNumber": "24102960001"
RegulatoryComplianceLookup V1
This endpoint is to determine the compliance regulations applied for Shipment for EEI Filings.
cookie Parameters
fdx_login | string Example: fdx_login=fdx_login%3Dssoxdev2.df9e.6b52a541 It is the login cookie.It is required for online clients. |
header Parameters
X-clientid | string Example: MAGS Registered client ids with FedEx API. i.e. MAGS, CAFE , INET, ISHP, etc. |
X-locale | string Example: en_US ISO locale |
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. |
Authorization required | string Example: Bearer XXX Specifies the authorization token. |
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. |
Request Body schema: application/json
Contains the Materials Input object to be applied.
version | object (version_optional) |
shipDate required | string <YYYY-MM-DD> String date format to indicate the date to be used for importing. Default to next day if not present in the request. This date can’t be greater than 120 days this includes weekends. The date format should be ISO8601Date, YYYY-MM-DD. |
carrierCode required | string The shipment type abbreviation for a FedEx operating company. EX: FXE for FedEx Express. Supported Values: FXE, FXG, FXF or any value supported in the DOM element CarrierCodeType. |
originAddress required | object (RegulatoryAddressVO) AddressVO V3 Model |
destinationAddress required | object (RegulatoryAddressVO) AddressVO V3 Model |
serviceType required | string String value to indicate a FedEx operating company’s type of service. Valid values from the authoritative data source (ADS) are listed in the example. Default value is “IP” if not present in the request. Valid values are also DOM ServiceType values. |
serviceOptionTypes required | Array of strings |
totalWeight required | object (Weight) Specify the Dry Ice weight details. Note:
|
consolidationType required | string String value to identify the type of consolidation containing this shipment. |
consolidationRole required | string A String value to identify the role of this shipment within the consolidation. |
totalCommodityValue required | object (Money_2) |
regulatoryCustomsClearanceDetail required | object (RegulatoryCustomsClearanceDetail) |
Responses
Success
Bad Request
Unauthorized
Forbidden
Not Found
Failure
Sandbox Server
Production Server
Request samples
- Payload
- C#
- JAVA
- JAVASCRIPT
- PHP
- PYTHON
- RUST
- SWIFT
- "version": {
- "major": 1,
- "minor": 1,
- "patch": 1
- "shipDate": "2022-10-05",
- "carrierCode": "FXE",
- "originAddress": {
- "countryCode": "US",
- "stateOrProvinceCode": "TX",
- "postalCode": "75024"
- "destinationAddress": {
- "countryCode": "US",
- "stateOrProvinceCode": "TX",
- "postalCode": "75024"
- "serviceType": "[\"IP\",\"SG\",\"PO\",\"XS\",\"FR\",\"FL\"]",
- "serviceOptionTypes": [
- "FICE",
- "ITAR"
- "totalWeight": {
- "units": "KG",
- "value": 68
- "consolidationType": "INTERNATIONAL_PRIORITY_DISTRIBUTION",
- "consolidationRole": "CRN_SHIPMENT",
- "totalCommodityValue": {
- "amount": 12.45,
- "currency": "USD"
- "regulatoryCustomsClearanceDetail": {
- "regulatoryControls": "NOT_IN_FREE_CIRCULATION",
- "documentContent": "NON_DOCUMENTS",
- "customsValue": {
- "amount": 12.45,
- "currency": "USD"
- "commercialInvoice": {
- "freightCharge": {
- "amount": 12.45,
- "currency": "USD"
- "purpose": "SOLD"
- "commodities": [
- {
- "commodityID": "12",
- "scheduleBCode": "500000",
- "harmonizedCode": "611692",
- "name": "Papers",
- "description": "Theragem Power Supply Unit",
- "exportControlClassificationNumber": "10",
- "commodityLicenseOrPermit": "10",
- "countryOfManufacture": "GB",
- "weight": {
- "units": "KG",
- "value": 68
- "quantity": 15,
- "quantityUnits": "Ea",
- "customsValue": {
- "amount": 12.45,
- "currency": "USD"
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
- "transactionId": "0e671149-016f-1000-941f-ef4dbabadd2e",
- "customerTransactionId": "AnyCo_order123456789",
- "output": {
- "regulatoryComplianceCountryDetails": [
- {
- "countryCode": "US",
- "category": "ProductType",
- "regulatoryComplianceCommodityDetails": [
- {
- "commodityComplianceTypeDetail": {
- "commodityIndexes": 1,
- "regulatoryComplianceTypeDetail": {
- "type": "EEI",
- "description": "Shipments to your selected country require an EEI filing"
- "shipmentRegulatoryComplianceDetails": [
- {
- "type": "EEI",
- "description": "Shipments to your selected country require an EEI filing"
- "code": "INVALID.INPUT.EXCEPTION",
- "alertType": "WARNING",
- "parameterList": [
- {
- "value": "packagingType can not be null",
- "key": "NotNull.specialServicesOptionsInputVO.requestedShipment.packagingType"
- "message": "Validation failed for object. Error count: 1"
Response