Collection and Drop Off 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/collectionaddress/v1/address/{address_id} https://api.uat.nzpost.co.nz/collectionaddress/v1/dropoff/all https://api.uat.nzpost.co.nz/collectionaddress/v1/dropoff/{address_id} |
| 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/collectionaddress/v1/address/{address_id} https://api.nzpost.co.nz/collectionaddress/v1/dropoff/all https://api.nzpost.co.nz/collectionaddress/v1/dropoff/{address_id} |
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 for Obtaining Collection and Drop Off | Expected Result |
|---|---|
| Request submitted using valid address_id and count = 1 | Success - message received |
| Request submitted with address_id = null | Bad Request - incorrect or missing parameters |
| Request is submitted with an invalid address_id | Success - message received |
| Collection and Drop Off Locations API not available | System unavailable - Server availability issue |
NOTE:
- When users need to retrieve nearby drop off addresses, the request optionally includes two parameters: "count" and "max_distance." By default, these parameters are set to 10 and 5, respectively.
- No parameters are required when users want to retrieve all drop-off locations.