Fedex Logo
Developer Portal

Postal Code Validation API

Introduction

L’API de validation du code postal FedEx permet aux clients de FedEx de valider les codes postaux et d’obtenir les délais de livraison. Elle prend en charge les recherches et les validations liées à la ville, au code postal, au pays, ainsi qu'à la combinaison origine-destination. Elle renvoie des renseignements validés sur le code postal et la localisation dans la réponse.

Détails sur l’API de validation du code postal

L’API de validation du code postal valide les codes postaux des pays et des villes et fournit le code postal nettoyé comme réponse. Des codes postaux correctement formatés sont obligatoires pour traiter un envoi ou créer des étiquettes d’expédition.

Cette API utilise les renseignements saisis, tels que la date d’expédition, le code postal, le code de pays et d’autres détails, et vérifie si les valeurs de l’État et de la ville correspondent. La ville et l’État sont définis s’il y a incohérence et si le pays correspond au Canada ou aux États-Unis. Exemples : FDXE – FedEx ExpressMD, FDXG – FedEx GroundMD et FXSP – FedEx GroundMD Economy (anciennement connu sous le nom de FedEx SmartPostMD). L’API valide l’entrée saisie et fournit des détails sur la localisation et le code postal nettoyé.

FedEx prend en charge ces services à la fois pour les pays qui fonctionnent avec des codes postaux et pour les pays qui n’en utilisent pas.

Pays qui fonctionnent avec des codes postaux

Il faut inclure les codes postaux sur les bordereaux d’expédition et d'autres documents pour les envois à destination de ces pays afin de réduire les retards et de maximiser l’efficacité. Les clients de FedEx Express doivent être encouragés à inclure des codes postaux valides aux adresses de leurs destinataires situés dans les pays ci-dessous.

Pour de plus amples renseignements sur les pays fonctionnant avec des codes postaux, reportez-vous à la section Pays qui fonctionnent avec des codes postaux.

Pays qui ne fonctionnent pas avec des codes postaux

Comme le nom l’indique, FedEx prend en charge certains pays qui n’utilisent pas les codes postaux et qui ne les exigent donc pas pour les envois. Le code de l’État ou le nom de la ville suffit lorsque le client fait un envoi vers un pays qui n’a pas de système de code postal. Si une erreur de validation survient pour un pays qui n’utilise pas de codes postaux, essayez de forcer le passage de l’adresse en saisissant \"00000\" comme code postal de remplacement. L’utilisation de ce faux code postal ne devrait pas poser de problème, car il n’existe pas.

Voici les avantages d'utiliser l’API de validation du code postal FedEx :

  • Réduit les retards d’expédition et augmente l’efficacité.
  • Augmente le nombre de livraisons à temps et terminées.
  • Améliore le service FedEx dans les zones urbaines, en offrant une certaine flexibilité dans les heures limites de ramassage et la planification des ramassages.

Fonctionnement de l'API de validation du code postal

L’API de validation du code postal FedEx utilise le point de terminaison ci-dessous pour valider les codes postaux des villes, des pays et des combinaisons origine-destination. La section suivante décrit les principales entrées et réponses pour le point de terminaison :

Valider le code postal

Cette demande est utilisée pour renvoyer les détails sur le code postal, le code postal nettoyé et la description du lieu en fonction des renseignements saisis. Les principaux renseignements saisis associés à cette demande sont les suivants :

  • carrierCode
  • countryCode
  • stateOrProvinceCode
  • postalCode
  • shipDate

Les résultats réussis de cette demande sont locationdetails et cleanedpostalcode pour l’entrée fournie. La demande échoue si le code postal n’est pas valide, par exemple, si la combinaison code de pays, État/province et code postal n’est pas valide.

Clarification des idées fausses les plus courantes

  • Il n’est pas possible de croiser l’alignement des territoires avec l’alignement des codes postaux, car il s’agit de résultats distincts du processus d’alignement.
  • Certaines zones géographiques du monde n’ont pas de code postal.

Pour de plus amples renseignements sur la liste par région, reportez-vous à la section Liste des services particuliers à une région.

Règles opérationnelles

  • Combinaison du numéro et du nom de rue, etc. Au moins une ligne est requise pour une adresse physique valide; les lignes vides dans l’adresse ne sont pas autorisées.
  • Un code d’État ou de province à deux lettres est requis si le pays de destination correspond au Canada ou aux États-Unis, ou si l’EEI s’applique et que le pays est le Mexique {MX}.
  • Les données descriptives d’un emplacement physique peuvent être utilisées comme une adresse physique réelle (endroit où l’on peut se rendre) ou comme un conteneur d’éléments d’adresse (\"address parts\") à traiter comme un seul élément (comme une combinaison ville-État-code postal aux États-Unis).
  • Le format et la présence du champ Code postal varient en fonction du pays.

Collection d’API JSON

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
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