Fedex Logo
Developer Portal

Postal Code Validation API

Einleitung

Mit der FedEx Postleitzahlprüfungs-API können FedEx Kunden Postleitzahlen validieren und Service-Zusagen abrufen. Es werden Suchen und Überprüfungen anhand von Ort, Postleitzahl, Land und Ursprungs-/Bestimmungsort unterstützt. In der Antwort werden verifizierte Postleitzahl- und Ortsangaben zurückgegeben.

Details zur Postleitzahlprüfungs-API

Bei der Postleitzahlprüfung werden die Postleitzahlen für Länder und Orte validiert. Als Antwort wird die bereinigte Postleitzahl zurückgegeben. Damit eine Sendung bearbeitet oder Versandetiketten erstellt werden können, müssen Postleitzahlen korrekt formatiert sein.

Diese API prüft anhand bereitgestellter Eingabeinformationen wie Versanddatum, Postleitzahl, Ländercode sowie anderer Daten, ob die Werte für Bundesstaat und Ort übereinstimmen. Bundesstaat und Ort werden festgelegt, wenn die Werte nicht übereinstimmen (nur für USA oder Kanada). Beispiele: FDXE – FedEx Express®, FDXG – FedEx Ground® und FXSP – FedEx Ground® Economy (früher FedEx SmartPost®). Die API prüft die Eingabe und gibt Ortsangaben und die bereinigte Postleitzahl zurück.

FedEx Express bietet Services in Ländern an, die mit und ohne Postleitzahlen arbeiten.

Länder mit Postleitzahlen

Bei Sendungen in diese Länder muss die Postleitzahl auf dem Luftfrachtbrief und anderen Dokumenten angegeben werden, um Verzögerungen zu vermeiden und den Versand so effizient wie möglich zu gestalten. Fordern Sie FedEx Express-Kunden auf, für Sendungen an Empfänger in den unten aufgeführten Ländern gültige Postleitzahlen anzugeben.

Weitere Informationen über Länder mit Postleitzahlen finden Sie unter Länder mit Postleitzahlen.

Länder ohne Postleitzahlen

Wie der Name schon sagt, gibt es Länder, die keine Postleitzahlen für Sendungen vorschreiben. FedEx bietet auch Services in diesen Ländern an. Beim Versand in diese Länder ist der Bundesstaatencode oder Ort ausreichend. Wenn ein Validierungsfehler für ein Land auftritt, das ohne Postleitzahlen arbeitet, kann die Annahme der Adresse durch die Eingabe von \"00000\" als Ersatzpostleitzahl erzwungen werden. Die Verwendung dieser falschen Postleitzahl verursacht keine Probleme, da sie nicht existiert.

Die FedEx Postleitzahlprüfungs-API bietet folgende Vorteile:

  • Weniger Versandverzögerungen und mehr Effizienz
  • Mehr pünktliche und vollständige Lieferungen
  • Verbesserter FedEx Service in Ballungsräumen und mehr Flexibilität durch Spätabholung und Abholungsbuchungen

So funktioniert die Postleitzahlprüfungs-API

Bei der FedEx Postleitzahlprüfung wird die Postleitzahl für Orte, Länder und Ursprungs-/Bestimmungsort anhand des unten stehenden Endpunkts validiert. Im folgenden Abschnitt werden die wichtigsten Eingaben und Antworten für den Endpunkt beschrieben:

Postleitzahlprüfung

Diese Abfrage dient der Rückgabe von PLZ-Details, der bereinigten Postleitzahl und der Ortsbeschreibung anhand der Eingaben. Nachfolgend finden Sie die wichtigsten Eingabeinformationen, die dieser Abfrage zugeordnet sind:

  • carrierCode
  • countryCode
  • stateOrProvinceCode
  • postalCode
  • shipDate

Auf diese Abfrage werden locationdetails und cleanedpostalcode für die bereitgestellte Eingabe zurückgegeben. Die Abfrage schlägt fehl, wenn die Postleitzahl ungültig ist, z. B. wenn die Kombination aus Länder-Code, Bundesstaat/Provinz und Postleitzahl nicht gültig ist.

Klärung von häufigen Missverständnissen

  • Es ist nicht möglich, einen Querverweis zwischen der Gebietszuordnung und der Postleitzahlzuordnung herzustellen, da es sich hierbei um getrennte Zuordnungen handelt.
  • Nicht überall auf der Welt werden Postleitzahlen verwendet.

Weitere Informationen über die Liste der Regionen mit und ohne Postleitzahl finden Sie unter Regionsspezifische Service-Liste.

Geschäftsregeln

  • Kombination aus Nummer, Straße usw. Eine gültige physische Adresse umfasst mindestens eine Zeile. Leerzeilen innerhalb der Adresse sind nicht zulässig.
  • Wenn die Adresse des Empfängers in den USA oder in Kanada liegt, muss der richtige 2-Buchstaben-Code für den Bundesstaat oder die Provinz angegeben werden. Dies ist auch in Mexiko {MX} für bereitzustellende EEIs erforderlich.
  • Beschreibungen für einen physischen Standort können als tatsächliche physische Adresse (ein realer Ort) oder als Container von \"Adressteilen\" verwendet werden, die als Einheit behandelt werden sollten (z. B. eine Kombination aus Ort-Bundesstaat-PLZ innerhalb der USA).
  • Format und Vorhandensein des Felds für Postleitzahlen sind je nach Land verschieden.

JSON API-Sammlung

Documentation Powered by ReDoc

Postal Code Validation API (1.0.0)

Validate Postal

Use this endpoint to validate postal codes and service commitments. Supports city, postal, country and origin-destination related lookups and validations.
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-ValidatePostal
  • MinimumSamplePayload
carrierCode
required
string
Enum: "FDXE" "FDXG" "FXSP" "FDXC" "FXCC"

Specify the four letter code of a FedEx operating company that meets your requirements
Examples of FedEx Operating Companies are:

  • FDXE - FedEx Express
  • FDXG - FedEx Ground
  • FXSP - FedEx SmartPost
  • FXCC - FedEx Custom Critical.

countryCode
required
string

The two-letter code used to identify a country.
Example:US
Click here to see Country Codes

stateOrProvinceCode
required
string

This is the state or province code. Format and presence of this field will vary, depending on country.
Example: US
Click here to see State Or Province Code

postalCode
required
string

Identification code of a region (usally small) for easier and accurate mail/package delivery. The format and presence of this field may vary depending on the country.
Example: 75063-8659
Click here to see Postal aware countries

shipDate
required
string

Specify the date on which the package is to be shipped. The specified date should not be the current date or any date, 10 days after the current date. The date format must be YYYY-MM-DD.
Example: 2019-10-04

routingCode
string

Specify the routing code for the shipment. Routing code is the information that identifies the route the package or shipment may take.
Example: Memphis 38017 - HKA/NQA

checkForMismatch
boolean

This element checks for mismatch between State/Province Code and Postal Code.

  • When the checkForMismatch is set TRUE, for U.S. and Canada: The values in State/Province Code are checked with respect to Postal Code provided. If these entries are valid, the response provides respective State/Province Code and Postal Code. In case of mismatch of Postal Code and State/Province Code an error message is displayed.
  • When the checkForMismatch is set FALSE, for U.S. and Canada: The values in State/Province Code are not checked with respect to Postal Code provided. Instead the given data is reflected in the response.

For regions other than U.S and Canada regardless of the value of checkForMismatch the State/Province Code are checked with respect to the Postal Code and the response provides the respective State/Province Code and Postal Code.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /country/v1/postal/validate

Sandbox Server

https://apis-sandbox.fedex.com/country/v1/postal/validate

Production Server

https://apis.fedex.com/country/v1/postal/validate

Request samples

Content type
application/json
Example
FullSchema-ValidatePostal
Copy
 Expand all Collapse all
{
  • "carrierCode": "FDXG",
  • "countryCode": "US",
  • "stateOrProvinceCode": "US",
  • "postalCode": "502267",
  • "shipDate": "2019-10-04",
  • "routingCode": "Memphis 38017 - HKA/NQA",
  • "checkForMismatch": true
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
  • "customerTransactionId": "AnyCo_order123456789",
  • "output":
    {
    }
}
CLOSE

Response

Copy