Fedex Logo
Developer Portal

Postal Code Validation API

Introduzione

L'API convalida codice postale di FedEx consente ai clienti FedEx di convalidare i codici postali e ottenere impegni di servizio. Supporta la convalida e le ricerche inerenti città, codici postali, paesi e origine/destinazione. Nella risposta restituisce informazioni postali e relative alla località verificate.

Dettagli dell'API convalida codice postale

La convalida del codice postale verifica i codici postali per paesi e città oltre a fornire come risposta il codice postale pulito. I codici postali provvisti di una corretta formattazione sono obbligatori per elaborare una spedizione o creare etichette di spedizione.

Questa API utilizza le informazioni di input fornite (data di spedizione, codice postale, codice paese e diverse altre informazioni) e verifica eventuali incongruenze tra i valori di stati e città. In caso di incongruenze vengono impostati Città e Stato, stabilendo se si tratta di Stati Uniti o Canada. Ad esempio: FDXE - FedEx Express®, FDXG - FedEx Ground® e FXSP - FedEx Ground® Economy (precedentemente noto come FedEx SmartPost®). L'API convalida l'input e fornisce le informazioni sulla località oltre al codice postale pulito.

FedEx fornisce il servizio sia per paesi che comportano il codice postale sia per paesi che non lo prevedono.

Paesi che comportano il codice postale

Le spedizioni a questi paesi dovrebbero includere i codici postali nelle lettere di vettura e in altri documenti al fine di ridurre i ritardi e massimizzare l'efficienza. I clienti FedEx Express dovrebbero essere incoraggiati a includere codici postali validi nei propri indirizzi per destinatari situati nei paesi seguenti.

Per maggiori informazioni sui paesi che comportano il codice postale fare riferimento a Paesi che comportano il codice postale.

Paesi che non prevedono il codice postale

Come suggerito dal nome, esistono Paesi serviti da FedEx che non prevedono il codice postale e non lo richiedono per le loro spedizioni. Il codice dello stato o il nome della città è sufficiente per i clienti che effettuano spedizioni verso un Paese privo di codice postale. Se si verifica un errore di convalida per un Paese che non utilizza il CAP, provate a forzare l'indirizzo inserendo \"00000\" come codice postale sostitutivo. Utilizzando questo codice postale falso non dovreste incontrare problemi, dal momento che non esiste.

Di seguito sono riportati i vantaggi dell'utilizzo dell'API convalida codice postale di FedEx:

  • Riduce i ritardi e massimizza l'efficienza.
  • Aumenta il numero di consegne puntuali e complete.
  • Migliora il servizio FedEx nelle aree urbane, offrendo flessibilità in termini di orari e prenotazioni di ritiro.

Come funziona l'API convalida codice postale

La convalida del codice postale di FedEx utilizza l'endpoint sottostante per convalidare i codici postali per città, paesi e origine/destinazione. La sezione seguente descrive gli input chiave e le risposte per l'endpoint:

Convalida postale

Questa richiesta è utilizzata per restituire informazioni postali, codice postale pulito e descrizione della località sulla base di informazioni di input. Le informazioni di input chiave associate a questa richiesta sono le seguenti:

  • codiceVettore
  • codicePaese
  • codiceStatoOProvincia
  • codicePostale
  • dataSpedizione

Il risultato soddisfacente di questa richiesta consiste nelle informazionilocalità e nel codicepostalepulito per l'input fornito. La richiesta è destinata a fallire se il codicepostale non è valido, per esempio la combinazione CodicePaese, Stato/Provincia e CAP/Codice postale non è valida.

Chiarimento in merito a falsi preconcetti

  • Non è possibile incrociare l'allineamento del territorio con l'allineamento del CAP/codice postale perché si tratta di risultati di un processo di allineamento ben distinti.
  • Non tutte le località geografiche al mondo sono dotate di codici postali o CAP.

Per maggiori informazioni sulla lista specifica per regione, fare riferimento alla Lista di servizio specifica per regione.

Regole aziendali

  • Combinazione di numero civico, nome della via ecc. È obbligatoria almeno una riga per un indirizzo fisico valido; non sono ammesse righe vuote nell'indirizzo.
  • Il codice di stato o provincia di due lettere è obbligatorio se il paese di destinazione sono gli USA o il Canada o se si applica l'EEI e il paese è il Messico {MX}.
  • I dati descrittivi per una località fisica possono essere usati come indirizzo effettivo (un luogo in cui ci si potrebbe recare) o come contenitore di \"parti indirizzo\" che dovrebbe essere gestito nel suo insieme (come una combinazione di città e stato/ZIP code negli USA).
  • Formato e presenza di un campo per il codice postale variano a seconda del paese.

Ritiro API JSON

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