Fedex Logo
Developer Portal

Postal Code Validation API

Introdução

A API de Validação de Códigos Postais FedEx permite que os clientes FedEx validem os códigos postais e obtenham os compromissos de serviço. Suporta cidade, código postal, país, pesquisas e validações relacionadas com origem e destino. Devolve os detalhes de localização e código postal verificados na resposta.

Detalhes da API de Validação de Códigos Postais

A Validação de Códigos Postais valida os códigos postais de países e cidades e fornece um código postal sem erros como resposta. São necessários os códigos postais formatados corretamente para processar uma expedição ou criar etiquetas de expedição.

Esta API utiliza as informações introduzidas como a data de expedição, código postal, indicativo de país e outras informações, e verifica a existência de inconsistências entre os valores de estado e cidade. A Cidade e o Estado são definidos se for encontrada uma inconsistência e se o país for os EUA ou Canadá. Por exemplo: FDXE – FedEx Express®, FDXG – FedEx Ground® e FXSP – FedEx Ground® Economy (Anteriormente denominada Fedex SmartPost ®). A API valida a entrada dada e fornece detalhes da localização e o código postal sem erros.

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

Países com código postal

As expedições para estes países devem incluir os códigos postais nas cartas de porte e outra documentação para ajudar a reduzir os atrasos e maximizar a eficiência. Os clientes FedEx Express devem incluir códigos postais válidos nos endereços para os destinatários localizados nos países abaixo.

Para obter 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 suportados pela FedEx que não exigem códigos postais nas suas expedições. O código do estado ou nome da cidade é suficiente quando o cliente expede para um país sem código postal. Se ocorrer um erro de validação num país que não utilize códigos postais, tente forçar o endereço ao introduzir \"00000\" como código postal de substituição. A utilização deste código postal falso não deve causar problemas, pois não existe.

Seguem-se os benefícios de utilizar a API de Validação de Códigos Postais FedEx:

  • Reduz os atrasos das expedições e aumenta a eficiência.
  • Aumenta o número de entregas pontuais e completas.
  • Melhora o serviço FedEx em áreas urbanas ao permitir uma flexibilidade na hora limite e nos horários de recolha.

Como funciona a API de Validação de Códigos Postais

A Validação de Códigos Postais FedEx utiliza o ponto final abaixo para validar os códigos postais em cidades, países, origem e destino. A secção seguinte descreve as principais entradas e respostas do ponto final:

Validar Código Postal

Este pedido é utilizado para devolver detalhes do código postal, código postal sem erros e descrição da localização com base nos detalhes introduzidos. As informações-chave introduzidas e associadas a este pedido são as seguintes:

  • carrierCode
  • countryCode
  • stateOrProvinceCode
  • postalCode
  • shipDate

O resultado bem-sucedido deste pedido é locationdetails e cleanedpostalcode na entrada fornecida. O pedido não será efetuado se o código postal não for válido. Por exemplo, se a combinação Indicativo de País, Estado/Província e Código Postal não for válida.

Esclarecimento de Equívocos Comuns

  • Não é possível fazer uma referência cruzada do alinhamento do território com o alinhamento do código postal porque são resultados de processos de alinhamento distintamente separados.
  • Nem todas as localizações geográficas no mundo têm códigos postais.

Para obter mais informações sobre a lista de Serviços Específicos da Região, consulte a Lista de Serviços Específicos da Região.

Regras Empresariais

  • Combinação de número, nome da rua, etc. É necessária, pelo menos, uma linha de um endereço físico válido. As linhas vazias no endereço não são permitidas.
  • É necessário o estado (2 letras) ou o código da província se o país destinatário for os EUA ou Canadá, ou se a EEI se aplicar e o país for o México {MX}.
  • Os dados descritivos de uma localização física podem ser utilizados como endereço físico real (local para onde se pode ir) ou como contentor de \"partes de endereço\" que deve ser tratado como unidade (como a combinação de cidade, estado e código postal nos EUA).
  • O formato e a presença do campo de código postal irá variar consoante o país.

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