ParcelAddress API
Get International Address Detail
Resource URL
UAT:
https://api.uat.nzpost.co.nz/parceladdress/2.0/international/addresses/{address_id}https://api.nzpost.co.nz/parceladdress/2.0/international/addresses/{address_id}Resource Description
Returns the detailed information for a single international address identifier. This resource is .
Merchants should consider the use of the Australian Address Lookup resource available in this API in addition to Get International Address Detail resource. The Australian Address Lookup resource is useful when the merchant sends a regular volume of parcel to Australian destinations and also consumes the ParcelLabel functionality. The Australian Address Lookup resource maps the Google Places address data to the ParcelLabel request fields for easier consumption.
Resource Information
| Attribute | Detail |
|---|---|
| Response Format | JSON |
| Requires Authentication | Yes |
| Rate Limited | 15 calls per second. If rate limit is exceeded, calls will be queued. Calls unprocessed for over 60 seconds will time out. |
Please note that all request parameters should be in lower case.
Request Parameters
| Field Name | Description | Mand | Example |
|---|---|---|---|
| address_id | International address identifier used by Google Places. | Yes | EjAzODAwIExhIFBhc2FkYSBBdmUsIExhcyBWZWdhcywgTlYsIFVuaXRlZCBTdGF0ZXM |
Sample Request
https://api.nzpost.co.nz/parceladdress/2.0/international/addresses/ChIJN1t_tDeuEmsRUsoyG83frY4%26key%3DAIzaSyAC711805j5JJgCpY7RV662jayqffVS-jYResponse Parameters
Response parameters and their descriptions can be found in the Google Developers pages for Google Places here: https://developers.google.com/places/webservice/details.