Fedex Logo
Developer Portal

Postal Code Validation API

Úvod

Rozhraní API pro ověřování poštovních směrovacích čísel FedEx umožňuje zákazníkům společnosti FedEx ověřovat poštovní směrovací čísla a zjišťovat dostupnosti služeb. Podporuje vyhledávání a ověřování podle města, PSČ, země a místa určení. Jako odpověď vrátí ověřené poštovní údaje a údaje o poloze.

Podrobné informace o rozhraní API pro ověření PSČ

Rozhraní pro ověření PSČ ověřuje PSČ zemí a měst a jako odpověď poskytuje správné poštovní směrovací číslo. PSČ musí mít pro účely zpracování zásilky nebo vytvoření přepravních štítků správný formát.

Toto rozhraní API používá zadané vstupní informace, jako je datum odeslání, PSČ, kód země a další informace, a kontroluje případný nesoulad mezi hodnotami státu a města. Pokud je nalezen nesoulad a pokud je země USA nebo Kanada (CA), nastaví se město a stát. Například: FDXE – FedEx Express®, FDXG – FedEx Ground® a FXSP – FedEx Ground® Economy (dříve pod názvem Fedex SmartPost ®). Rozhraní API ověří zadaný vstup a poskytne údaje o poloze a správné poštovní směrovací číslo.

Společnost FedEx poskytuje služby jak do zemí používajících PSČ, tak do zemí, které PSČ nepoužívají.

Země používající PSČ

Zásilky do těchto zemí by měly na leteckých nákladních listech a dalších dokumentech obsahovat poštovní směrovací čísla, aby se snížilo zpoždění a zvýšila efektivita. Zákazníci společnosti FedEx Express by měli v adresách příjemců z níže uvedených zemí uvádět platná poštovní směrovací čísla.

Další informace o zemích používajících PSČ naleznete v části Země používající PSČ.

Země, které PSČ nepoužívají

Jak již nadpis napovídá, existují země, které PSČ nepoužívají PSČ, a společnost FedEx do nich služby poskytuje. U těchto zemí se u poštovních zásilek poštovní směrovací čísla nepoužívají. Pokud zákazník odesílá zboží do země, která nepoužívá PSČ, stačí zadat kód státu nebo jméno města. Pokud dojde při ověřování této země k chybě, zkuste vynutit adresu tak, že místo PSČ zadáte \„00000\“. Vzhledem k tomu, že toto PSČ neexistuje, nemělo by se po vložení nic stát.

Níže jsou uvedeny výhody používání rozhraní API pro ověřování PSČ společnosti FedEx:

  • Snižuje zpoždění přepravy a zvyšuje efektivitu.
  • Zvyšuje počet včasných a kompletních dodávek.
  • Zlepšuje služby společnosti FedEx v městech a nabízí flexibilitu v časech odjezdu a plánu vyzvednutí.

Jak rozhraní API pro ověření PSČ funguje

Služba FedEx pro ověření PSČ používá níže uvedenou funkci k ověření poštovních směrovacích čísel měst, zemí a míst původu a určení. V následující části jsou popsány klíčové vstupní údaje a reakce této funkce:

Ověření PSČ

Tento požadavek slouží k vrácení poštovních údajů, správného PSČ a popisu místa na základě zadaných údajů. Klíčové vstupní údaje pro tento požadavek jsou následující:

  • carrierCode
  • countryCode
  • stateOrProvinceCode
  • postalCode
  • shipDate

Po úspěšném dokončení tohoto požadavku jsou pro zadaný vstup poskytnuty údaje locationdetails a cleanedpostalcode. Požadavek selže, například pokud není pro PSČ zadána platná kombinace kódu země, státu/oblasti a kódu PSČ.

Vysvětlení častých omylů

  • Nelze vzájemně porovnávat zadané území a zadané PSČ, protože se na základě zadaných údajů jedná o zcela oddělené výstupy.
  • Na světě existují místa, která nemají své poštovní směrovací číslo.

Další informace o seznamu služeb pro jednotlivé regiony naleznete v části Seznam služeb pro jednotlivé regiony.

Obchodní pravidla

  • Kombinace čísla, názvu ulice atd. Pro platnou fyzickou adresu je vyžadován alespoň jeden řádek; prázdné řádky v adrese nejsou povoleny.
  • Pokud je zemí příjemce USA nebo Kanada, nebo pokud se použije EEI a zemí je Mexiko {MX}, je vyžadován dvoupísmenný kód země nebo provincie.
  • Popisné údaje pro fyzické umístění lze použít jako skutečnou fyzickou adresu (veřejně přístupné místo) nebo jako \„část adresy\“, která představuje jednotku (například kombinace město, stát, PSČ v USA).
  • Formát a přítomnost pole pro PSČ se liší v závislosti na zemi.

Kolekce JSON API

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