Fedex Logo
Developer Portal

Postal Code Validation API

Introdução

A API de validação de código postal FedEx permite que clientes FedEx validem os códigos postais e recebam os compromissos de serviço. Ela aceita pesquisas e validações relacionados a cidade, código postal, país, origem e destino. Envia na resposta os detalhes de código postal e localização validados.

Detalhes da API de validação de código postal

A Validação de código postal valida os códigos postais para países e cidades e oferece como resposta o código postal limpo. Os códigos postais no formato correto são obrigatórios para processar uma remessa ou criar etiquetas de remessa.

Essa API usa as informações inseridas, como data de remessa, código postal, código do país, além de outros dados diversos, e verifica a existência de discrepâncias entre os valores de estado e cidade. Cidade e estado serão ajustados se for encontrada uma discrepância e se o país for EUA ou Canadá. Por exemplo: FDXE - FedEx Express®, FDXG - FedEx Ground® e FXSP - FedEx Ground® Economy (anteriormente conhecido como FedEx SmartPost®). A API valida as informações inseridas e fornece detalhes de localização e o código postal limpo.

A FedEx oferece serviços para países com código postal ou sem código postal.

Países com código postal

Remessas a esses países devem incluir os códigos postais nos manifestos aéreos e em outras documentações, para ajudar a reduzir atrasos e maximizar a eficiência. Os clientes FedEx Express devem ser encorajados a incluir códigos postais válidos em seus endereços para destinatários localizados nos países abaixo.

Para mais informações sobre países com código postal, consulte Países com código postal.

Países sem código postal

Como o nome sugere, existem países sem código postal que são atendidos pela FedEx e que não exigem a presença de código postal na remessa. O código do estado ou nome da cidade é suficiente quando o cliente está enviando uma remessa para um país sem código postal. Se ocorrer um erro de validação para um país que não usa código postal, tente forçar o endereço inserindo \"00000\" como uma substituição do código postal. Usar esse código postal falso não deve causar problemas, já que ele não existe.

Veja abaixo os benefícios de usar a API de validação de código postal FedEx:

  • Reduz os atrasos nas remessas e aumenta a eficiência.
  • Aumenta o número de entregas no prazo e concluídas.
  • Melhora o serviço da FedEx em áreas urbanas, oferecendo flexibilidade nos tempos limite e cronogramas de coleta.

Como a API de validação de código postal funciona

A validação de código postal FedEx usa o endpoint abaixo para validar os códigos postais de cidades, países e origem e destino. A seção a seguir descreve as entradas essenciais e respostas para o endpoint:

Validar código postal

Essa solicitação é usada para obter detalhes de código postal, o código postal limpo e a descrição da localização com base nos detalhes inseridos. As informações essenciais associadas a esta solicitação são as seguintes:

  • carrierCode
  • countryCode
  • stateOrProvinceCode
  • postalCode
  • shipDate

O resultado bem sucedido dessa solicitação é apresentado como locationdetails e cleanedpostalcode para as informações inseridas. A solicitação falhará se postalcode não for válido, por exemplo, se a combinação CountryCode, Estado/Província e CEP/Código postal não for válida.

Esclarecimento de enganos comuns

  • Não é possível fazer a referência cruzada de alinhamento do território com o alinhamento de CEP/Código postal, pois esses são resultados de processos de alinhamento distintamente separados.
  • Nem todas as localizações geográficas no mundo teriam códigos postais ou CEP.

Para mais informações sobre a lista específica por região, consulte a Lista de serviços específicos por região.

Regras do negócio

  • Combinação de número, nome da rua etc. É preciso pelo menos uma linha para um endereço físico válido, não são permitidas linhas vazias dentro do endereço.
  • Um código de 2 letras de estado ou província é necessário se o país de destino for o EUA ou Canadá, ou se o EEI for aplicável e o país for o México {MX}.
  • Dados de descrição para uma localização física podem ser usados como um endereço físico real (um lugar para onde alguém poderia ir) ou como uma caixa de \"pedaços de endereço\" que deve ser tratada como uma unidade (como uma combinação de cidade estado e código postal dentro dos EUA).
  • O formato e a presença do campo de código postal vão variar dependendo do país.

Coleção 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