Fedex Logo
Developer Portal

Postal Code Validation API

Johdanto

FedExin postinumeron vahvistus API:n ansiosta FedExin asiakkaat voivat vahvistaa postinumeronsa ja saada palvelusitoumukset. Se tukee kaupunkiin, postinumeroon, maahan, lähetyspaikkaan ja määränpäähän perustuvia hakuja ja vahvistuksia. Tuloksissa on tarkistettuja postinumero- ja sijaintitietoja.

Postinumeron vahvistus API:n tiedot

Postinumeron vahvistus vahvistaa kaupunkien ja maiden postinumerot sekä palauttaa puhdistetun postinumeron. Oikeassa muodossa oleva postinumero on pakollinen, jotta lähetys voidaan käsitellä tai osoitelaput luoda.

Tämä API käyttää syötettyjä tietoja, kuten lähetyspäivämäärää, postinumeroa ja maakoodia, esimerkiksi osavaltion ja kaupungin tietojen ristiriitaisuuksien tarkistukseen. Kaupunki ja osavaltio asetetaan, jos ristiriita löytyy ja maa on Yhdysvallat tai Kanada. Esimerkiksi: FDXE: FedEx Express®, FDXG: FedEx Ground® ja FXSP: FedEx Ground® Economy (ennen FedEx SmartPost®). API vahvistaa syötetyt tiedot ja antaa sijaintitiedot sekä puhdistetun postinumeron.

FedEx tukee sekä postinumeroita käyttävien että käyttämättömien maiden palveluita.

Postinumeroita käyttävät maat

Näihin maihin lähetettävien lähetysten lentorahtikirjoihin ja muihin asiakirjoihin on sisällytettävä postinumerot, jotta viivästyksiä saadaan vähennettyä ja tehokkuus maksimoitua. FedEx Express -asiakkaita kannustetaan sisällyttämään alla olevissa maissa sijaitsevien vastaanottajien osoitteisiin voimassa oleva postinumero.

Katso lisätietoja postinumeroita käyttävistä maista sivulta Postinumeroita käyttävät maat.

Postinumeroita käyttämättömät maat

Kuten otsikosta voi päätellä, FedEx tukee postinumeroita käyttämättömiä maita, jotka eivät vaadi lähetyksiin postinumeroita. Osavaltiokoodi tai kaupungin nimi riittää, kun asiakas lähettää maahan, jossa ei käytetä postinumeroita. Jos vahvistusvirhe tapahtuu sellaisen maan kohdalla, joka ei käytä postinumeroita, yritä pakottaa osoite järjestelmään syöttämällä \"00000\" postinumeron tilalle. Tämän tekaistun postinumeron käyttämisen ei pitäisi aiheuttaa ongelmia, koska sitä ei ole olemassa.

FedExin postinumeron vahvistus API:n käyttämisen hyödyt:

  • Vähentää lähetysviiveitä ja lisää tehokkuutta.
  • Kasvattaa ajoissa olevien ja suoritettujen toimitusten määrää.
  • Parantaa FedEx-palvelua kaupunkialueilla tarjoamalla joustavuutta palveluaikojen päättymiseen ja noutoaikatauluihin.

Näin postinumeron vahvistus API toimii

FedExin postinumeron vahvistus käyttää alla olevaa päätepistettä kaupunkien, maiden, lähetyspaikan ja määränpään postinumeroiden vahvistukseen. Seuraavassa osiossa kerrotaan päätepisteen tärkeimmät syöttötiedot ja niiden vastaukset:

Vahvista postinumero

Tätä pyyntöä käytetään palauttamaan postinumerotietoja, puhdistettuja postinumeroita ja sijaintikuvauksia syötettyjen tietojen perusteella. Tähän pyyntöön liittyvät tärkeimmät syöttötiedot ovat:

  • carrierCode
  • countryCode
  • stateOrProvinceCode
  • postalCode
  • shipDate

Pyynnön onnistuneet tulokset syötetyille tiedoille ovat locationdetails ja cleanedpostalcode. Pyyntö epäonnistuu, jos postinumero ei kelpaa, esimerkiksi CountryCode, osavaltio/provinssi ja postinumero ei ole hyväksytty yhdistelmä.

Selvennyksiä yleisiin väärinkäsityksiin

  • Hallintoalueita ei voi verrata postinumeroalueisiin, koska ne ovat erillisten aluejakoprosessien tuloksia.
  • Kaikilla maailman maantieteellisillä sijainneilla ei ole postinumeroa.

Katso lisätietoja aluekohtaisista luetteloista sivulta Aluekohtainen palveluluettelo.

Yrityssäännöt

  • Numeron, kadunnimen jne. yhdistelmä. Hyväksyttävää osoitetta varten vaaditaan ainakin yksi rivi, tyhjät osoiterivit eivät ole sallittuja.
  • Kaksikirjaiminen osavaltio- tai provinssikoodi on pakollinen, jos vastaanottajan maa on Yhdysvallat tai Kanada tai jos EEI:tä sovelletaan ja maa on Meksiko {MX}.
  • Osoitteen kuvailua voi käyttää todellisena osoitteena (paikka, jonne voi mennä) tai ”osoitteen osien” kokoelmana, jota käsitellään yksikkönä (kuten kaupunki-osavaltio-postinumero-yhdistelmää Yhdysvalloissa).
  • Postinumerokentän muoto ja olemassaolo vaihtelee maasta riippuen.

JSON API -kokoelma

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