Postal Code Validation API

Giới thiệu

API Xác thực mã bưu chính của FedEx cho phép khách hàng FedEx xác thực mã bưu chính và được đảm bảo cam kết dịch vụ. API này hỗ trợ việc tra cứu và xác thực liên quan đến thành phố, mã bưu chính, quốc gia cũng như Nơi gửi hàng – Nơi nhận hàng. API này sẽ trả về chi tiết địa điểm và mã bưu chính đã xác minh trong phần trả lời.

Chi tiết về API Xác thực mã bưu chính

API Xác thực mã bưu chính sẽ xác thực mã bưu chính cho các quốc gia và thành phố, cũng như cung cấp mã bưu chính chuẩn để phản hồi cho người dùng. Cần có mã bưu chính được định dạng đúng để xử lý lô hàng hoặc tạo nhãn vận chuyển.

API này sử dụng thông tin đầu vào được cung cấp như ngày gửi, mã bưu chính, mã quốc gia và các thông tin khác, cũng như kiểm tra sự sai lệch giữa các giá trị tiểu bang và thành phố. Nếu phát hiện sự sai lệch và nếu quốc gia là Hoa Kỳ hoặc CA thì Thành phố và Tiểu bang sẽ được đặt. Ví dụ: FDXE - FedEx Express^®, FDXG - FedEx Ground^® và FXSP - FedEx Ground^® Economy (Trước đây là FedEx SmartPost^®). API sẽ xác thực thông tin đầu vào được cung cấp, đồng thời đưa ra chi tiết vị trí và mã bưu chính chuẩn.

FedEx hỗ trợ dịch vụ cho cả các quốc gia có nhận thức bưu chính và các quốc gia không nhận thức bưu chính.

Các quốc gia có nhận thức bưu chính

Các lô hàng gửi đến các quốc gia này cần có mã bưu chính trên vận đơn hàng không và các chứng từ khác để giúp giảm sự chậm trễ và tăng tối đa hiệu quả. Khách hàng của FedEx Express nên cung cấp mã bưu chính hợp lệ trong địa chỉ người nhận ở các quốc gia dưới đây.

Để biết thêm thông tin về các quốc gia có nhận thức bưu chính, vui lòng tham khảo trang Các quốc gia có nhận thức bưu chính.

Các quốc gia không nhận thức bưu chính

Như tên cho thấy, FedEx cũng hỗ trợ những quốc gia không áp dụng mã bưu chính, tức là không yêu cầu mã bưu chính trong lô hàng gửi đến những nước này. Khách hàng chỉ cần có mã tiểu bang hoặc tên thành phố là đủ khi họ vận chuyển hàng đến một quốc gia không có mã bưu chính. Nếu xảy ra lỗi xác thực đối với quốc gia không sử dụng mã ZIP, hãy thử cố nhập địa chỉ bằng cách nhập \"00000\" làm mã bưu chính. Mã này không tồn tại nên bạn có dùng cũng sẽ không gây ra sự cố.

Sau đây là những lợi ích của việc sử dụng API Xác thực mã bưu chính của FedEx:

Giảm sự chậm trễ trong khâu vận chuyển và tăng hiệu quả.
Tăng số lần hoàn thành giao hàng và giao hàng đúng thời hạn.
Cải thiện dịch vụ FedEx đến các khu vực thành thị, mang lại sự linh hoạt về thời gian chốt sổ và lịch đến lấy hàng.

Cách thức hoạt động của API Xác thực mã bưu chính

API Xác thực mã bưu chính của FedEx sử dụng điểm cuối bên dưới để xác thực mã bưu chính cho các thành phố, quốc gia và nơi gửi hàng-nơi nhận hàng. Phần sau đây mô tả các thông tin đầu vào quan trọng và phản hồi cho điểm cuối:

Xác thực mã bưu chính

Yêu cầu này trả lại thông tin bưu chính chi tiết, mã bưu chính chuẩn và mô tả vị trí dựa trên chi tiết đầu vào. Thông tin đầu vào quan trọng gắn với yêu cầu này như sau:

carrierCode
countryCode
stateOrProvinceCode
postalCode
shipDate

Kết quả thành công của yêu cầu này là locationdetails và cleanedpostalcode cho thông tin đầu vào được cung cấp. Yêu cầu sẽ không thể thực hiện nếu postalcode không hợp lệ, ví dụ: Sự kết hợp CountryCode, Tiểu bang/Tỉnh và mã ZIP/Mã bưu chính không hợp lệ.

Giải thích các quan niệm sai lầm phổ biến

Bạn không thể tham chiếu chéo điều chỉnh vùng lãnh thổ sang điều chỉnh mã ZIP/mã bưu chính vì đây là các kết quả đầu ra của quy trình điều chỉnh hoàn toàn riêng biệt.
Không phải tất cả các vị trí địa lý trên thế giới đều có mã bưu chính hoặc mã ZIP.

Để biết thêm thông tin về danh sách cụ thể của khu vực, hãy tham khảo Danh sách dịch vụ cụ thể của khu vực.

Quy tắc kinh doanh

Cách kết hợp giữa số, tên đường phố, v.v. Cần có ít nhất một dòng cho một địa chỉ thực tế hợp lệ; không được để dòng trống trong địa chỉ.
Cần có mã tiểu bang hoặc tỉnh gồm 2 chữ cái nếu quốc gia người nhận là Hoa Kỳ hoặc Canada, hoặc nếu áp dụng EEI và quốc gia là Mexico {MX}.
Dữ liệu mô tả cho vị trí thực tế có thể được dùng như địa chỉ thực tế (nơi mà một người có thể đến) hoặc như khu vực chứa \"các phần địa chỉ\" và được xử lý như một đơn vị (chẳng hạn như tổ hợp tiểu bang thành phố-mã ZIP trong Hoa Kỳ).
Trường mã bưu chính có thể có hoặc không và định dạng sẽ thay đổi tùy theo quốc gia.

Bộ sưu tập 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":
{
- "countryCode": "US",
- "cityFirstInitials": "string",
- "stateOrProvinceCode": "US",
- "alerts":
  [
  - {
    "code": "CITYNAME.POSTALCODE.REQUIRED",
    "alertType": "NOTE",
    "parameterList":
    [
    {
    "value": "string",
    "key": "string"
    }
    ],
    "message": "We are unable to process this request. Please try again later or contact FedEx Customer Service."
    }
  ],
- "locationDescriptions":
  [
  - {
    "locationId": "MAAPD",
    "locationNumber": "6955",
    "serviceArea": "AA",
    "airportId": "BLR"
    }
  ],
- "cleanedPostalCode": "94267"
}

}

Request
Response

Response

Copy

Developer Portal

Postal Code Validation API

Giới thiệu

Chi tiết về API Xác thực mã bưu chính

Cách thức hoạt động của API Xác thực mã bưu chính

Quy tắc kinh doanh

Bộ sưu tập API JSON

Postal Code Validation API (1.0.0)

Validate Postal

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Enter your user ID and password to log in