ParcelAddress API
Environments and Testing
Overview
You, as an integrating partner, are expected to maintain your own development, test and production environments from which to call the corresponding NZ Post Group environment and to follow the software development lifecycle.
Environment Detail
| Name | Use | Addresses |
|---|---|---|
| User Acceptance Test (UAT) Environment | This environment is available for integration to test customer’s solutions to ensure that calls to the API’s are technically correct and that the responses received are handled as they expect. This environment is available for system, integration and user acceptance testing. | https://api.uat.nzpost.co.nz/parceladdress/2.0/ |
| Production Environment | This environment is for live use and is only available to integrators upon completion of the go-live checklist. | https://api.nzpost.co.nz/parceladdress/2.0/ |
Testing Your Application
NZ Post Group is committed to making integration to its products easy and robust and are available to support your development and testing.
As with any development, NZ Post Group encourages you to test your application with both positive and negative scenarios. The following list of test cases has been provided for your convenience but it is not intended to be comprehensive. Some test cases may not apply to your use of the API. Please extend with test cases specific to your business.
| Suggested Test Cases | Expected Result |
|---|---|
| Retrieve and select valid domestic address with 1 match returned | Domestic address details are retrieved and handled as expected in customer application |
| Retrieve and select valid domestic address with 2 matches returned | Domestic address details are retrieved and handled as expected in customer application |
| Retrieve and select valid domestic address with 5 matches returned | Domestic address details are retrieved and handled as expected in customer application |
| Retrieve and select valid domestic address with 10 matches returned | Domestic address details are retrieved and handled as expected in customer application |
| Retrieve and select valid domestic suburb with 1, 2 or 10 matches returned | Domestic suburb details are retrieved and handled as expected in customer application |
| Retrieve and select valid international address not in Australia | International address details are retrieved and and handled as expected in customer application |
| Retrieve and select valid international address in Australia | Australian address details are retrieved and returned in NZ Post format in customer application |
| Retrieve and select valid international address | International address details are retrieved and handled as expected in customer application |
| Retrieve and select valid collection point as delivery address | Collection point details are retrieved and handled as expected in customer application |
| Attempt to retrieve non existent domestic address | Empty set returned handled as expected in customer application |
| Attempt to retrieve a domestic suburb when there are no suburbs matching a given suburb fragment | Empty set of suburb details returned and handled as expected in customer application |
| Attempt to retrieve address where request is malformed (missing parameter) | 400 error returned handled as expected in customer application |
| Attempt to retrieve address where license key is expired/invalid | 401 error returned handled as expected in customer application |