Fedex Logo
Developer Portal

Postal Code Validation API

Inleiding

De postcodevalidatie-API van FedEx stelt klanten van FedEx in staat om postcodes te valideren en de serviceverplichtingen te verkrijgen. De API ondersteunt zoekopdrachten en validaties gerelateerd aan plaats, postcode, land, herkomst en bestemming. De API geeft geverifieerde post- en locatiegegevens weer in het antwoord.

Gegevens postcodevalidatie-API

De postcodevalidatie valideert de postcodes voor landen en steden en geeft als respons de opgeschoonde postcode. De op de juiste manier opgemaakte postcodes zijn vereist om een zending te verwerken of verzendlabels te maken.

Deze API gebruikt de verstrekte invoerinformatie, zoals verzenddatum, postcode, landcode en andere verschillende gegevens, en controleert of er een discrepantie is tussen staats- en stadswaarden. De stad en staat worden ingesteld als er een discrepantie wordt gevonden en als het land VS of CA is. Bijvoorbeeld: FDXE - FedEx Express®, FDXG - FedEx Ground® en FXSP - FedEx Ground® Economy (voorheen bekend als FedEx SmartPost®. De API valideert de opgegeven invoer en verstrekt locatiegegevens en de opgeschoonde postcode.

FedEx ondersteunt diensten aan zowel postbewuste landen als niet-postbewuste landen.

Postbewuste landen

Zendingen naar deze landen dienen te zijn voorzien van de postcodes op de luchtvrachtbrieven en andere documentatie. Dit helpt vertragingen te verminderen en de efficiëntie te maximaliseren. Klanten van FedEx Express moeten worden gestimuleerd om geldige postcodes op te geven bij adressen voor ontvangers in de onderstaande landen.

Zie voor meer informatie over de postbewuste-landen Postbewuste landen.

Niet-postbewuste landen

Zoals de naam al doet vermoeden, ondersteunt FedEx ook niet-postbewuste landen die geen postcodes verplicht stellen in hun zendingen. Wanneer de klant verzendt naar een land dat geen postcode heeft, is de staatcode of plaatsnaam voldoende. Als er een validatiefout optreedt voor een land dat geen postcodes gebruikt, probeer dan het adres te forceren door \"00000\" in te voeren als vervangende postcode. Het gebruik van deze valse postcode zou geen problemen moeten veroorzaken aangezien deze niet bestaat.

Dit zijn de voordelen van het gebruik van de postcodevalidatie-API van FedEx:

  • Vermindert vertragingen bij verzending en verhoogt de efficiëntie.
  • Verhoogt het aantal tijdige en volledige leveringen.
  • Verbetert de FedEx-service naar stedelijke gebieden en biedt flexibiliteit in sluitingstijden en ophaalschema's.

Hoe werkt de postcodevalidatie-API?

De postcodevalidatie van FedEx gebruikt het onderstaande eindpunt om de postcodes voor steden, landen en oorsprong/bestemming te valideren. In de volgende sectie worden de belangrijkste invoeren en responsen voor het eindpunt beschreven:

Postgegevens valideren

Dit verzoek wordt gebruikt om op basis van invoergegevens postgegevens, de opgeschoonde postcode en locatiebeschrijving op te vragen. De belangrijkste invoergegevens die bij dit verzoek horen, zijn als volgt:

  • carrierCode
  • countryCode
  • stateOrProvinceCode
  • postalCode
  • shipDate

Het succesvolle resultaat van dit verzoek zijn locationdetails en cleanedpostalcode voor de opgegeven invoer. Het verzoek zou mislukken als de postcode niet geldig is. De combinatie van CountryCode, staat/provincie en postcode is bijvoorbeeld niet geldig.

Verduidelijking van veelvoorkomende misvattingen

  • Het is niet mogelijk om territoriumuitlijning te kruisverwijzen naar postcode-uitlijning, omdat dit duidelijk gescheiden outputs zijn van het uitlijnproces.
  • Niet alle geografische locaties in de wereld hebben postcodes.

Zie voor meer informatie over de regiospecifieke lijst Regiospecifieke servicelijst.

Bedrijfsregels

  • Combinatie van nummer, straatnaam, etc. Er is minimaal één regel vereist voor een geldig fysiek adres; lege regels binnen het adres zijn niet toegestaan.
  • 2-letterige staat- of provinciecode is vereist als het ontvangende land de VS of Canada is, of als EEI van toepassing is en het land Mexico {MX} is.
  • Beschrijvende gegevens voor een fysieke locatie kunnen worden gebruikt als een daadwerkelijk fysiek adres (plaats waarheen men zou kunnen gaan) of als een container met \"adresdelen\" die als een eenheid moet worden behandeld (zoals een stad, staat, postcode combinatie binnen de VS).
  • Opmaak en aanwezigheid van het postcodeveld zijn afhankelijk van het land.

JSON API-verzameling

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