Fedex Logo
Developer Portal

Postal Code Validation API

Bevezetés

A FedEx irányítószám-hitelesítési API lehetővé teszi a FedEx-ügyfelek számára, hogy hitelesítsék az irányítószámokat, valamint lekérdezzék a szolgáltatási kötelezettségvállalásokat. Támogatja a várossal, postai címmel, országgal és származási országgal, valamint a célállomással kapcsolatos kereséseket és az érvényesítéseket. A válaszban ellenőrzött postai és helymeghatározási adatokat küld vissza.

Az irányítószám-hitelesítési API adatai

Az irányítószám-hitelesítés érvényesíti az országok és városok postai irányítószámait, és válaszként a rendszerben megtisztított postai irányítószámot adja meg. A helyesen formázott postai irányítószámok kötelezőek a küldemény feldolgozásához vagy a fuvarozási címkék létrehozásához.

Ez az API a megadott bemeneti adatokat, például a fuvarozási dátumot, az irányítószámot, az országkódot és más különböző információkat használja, és ellenőrzi az állam és a város értékei közötti eltérést. A város és az állam akkor kerül beállításra, ha nem egyezik, és ha az ország U.S. vagy CA. Például: FDXE – FedEx Express®, FDXG – FedEx Ground® és FXSP – FedEx Ground® Economy (korábbi nevén FedEx SmartPost®). Az API érvényesíti a megadott bemenetet, és megadja a hely adatait és a rendszerben megtisztított irányítószámot.

A FedEx támogatja mind a postai szolgáltatásokat támogató, mind a postai szolgáltatásokat nem támogató országokat is.

Postai szolgáltatásokat támogató országok

Az ezekbe az országokba irányuló küldeményeknek tartalmazniuk kell a postai irányítószámokat a légi fuvarleveleken és egyéb dokumentációkon a késedelmek csökkentése és a hatékonyság maximalizálása érdekében. A FedEx Express ügyfeleinek azt javasoljuk, hogy az alábbi országokban található címzettek esetében érvényes postai irányítószámokat tüntessenek fel a címükben.

További információt a postai szolgáltatásokat támogató országokról a Postai szolgáltatásokat támogató országok című dokumentumban olvashat.

Postai szolgáltatásokat nem támogató országok

Ahogy a nevük is mutatja, vannak olyan, a FedEx által támogatott, postai szolgáltatásokat nem támogató országok, amelyek nem írják elő a postai irányítószámokat a küldemények esetén. Az államkód vagy a város neve elegendő, ha az ügyfél olyan országba szállít, ahol nincs postai irányítószám. Ha olyan ország esetében, ahol nem használnak irányítószámot, érvényesítési hiba lép fel, próbálja meg úgy érvényesíteni a címet, hogy a \"00000\" számsorral helyettesíti az irányítószámot. Ennek a nem valós irányítószámnak a használata nem okozhat problémát, mivel nem létezik.

A következők az előnyei annak, ha a FedEx irányítószám-hitelesítési API-t használja:

  • Csökkenti a fuvarozási késedelmeket és növeli a hatékonyságot.
  • Növeli a valós idejű és teljesített fuvarozások számát.
  • Javítja a FedEx szolgáltatásait a városi területeken, rugalmasságot kínálva a zárási időpontok és az átvételi menetrendek tekintetében.

Hogyan működik az irányítószám-hitelesítési API?

A FedEx irányítószám-hitelesítési API az alábbi végpontot használja az irányítószámok hitelesítéséhez a városok, országok, származási országok és célországok esetében. A következő szakasz a végpont legfontosabb bemeneteit és válaszait ismerteti:

Irányítószám hitelesítése

Ez a kérés a postai adatok, a rendszerben megtisztított irányítószám és a helyleírás visszaküldésére szolgál a megadott adatok alapján. A kérelemhez kapcsolódó legfontosabb bemeneti adatok a következők:

  • carrierCode (fuvarozói kód)
  • countryCode (országkód)
  • stateOrProvinceCode (állam vagy tartomány kódja)
  • postalCode (postai irányítószám)
  • shipDate (fuvarozás dátuma)

A kérés sikeres eredménye a következő: locationdetails és cleanedpostalcode a megadott bemenethez. A kérés sikertelen, ha az irányítószám nem érvényes, például a CountryCode, az állam/tartomány és az irányítószám/postai irányítószám kombinációja nem érvényes.

A gyakori félreértések tisztázása

  • Nem lehetséges a területi- és az irányítószám/postai irányítószám-összehangolás kereszthivatkozása, mivel ezek az összehangolási folyamatok különálló kimenetei.
  • A világon nem minden földrajzi hely rendelkezik postai irányítószámmal vagy irányítószámmal.

A régióspecifikus listára vonatkozó információkért olvassa el a Régispecifikus lista című dokumentumot.

Üzleti szabályok

  • Szám, utcanév stb. kombinációja. Legalább egy sor megadása szükséges az érvényes fizikai címre vonatkozóan; a címen belüli üres sorok nem engedélyezettek.
  • 2 betűs állam- vagy tartománykód szükséges, ha a fogadó ország az Egyesült Államok vagy Kanada, vagy ha EEI-t kell alkalmazni, és az ország Mexikó {MX}.
  • A fizikai hely leíró adatai használhatók tényleges fizikai címként (olyan hely, ahová el lehet menni), vagy a(z) \"address parts\" tárolójaként, amelyeket egységként kell kezelni (például egy város, állam és irányítószám kombinációja az Egyesült Államokban).
  • Az irányítószám mezőformátuma és jelenléte országonként eltérő.

JSON API-gyűjtemény

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