ParcelLabel 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 |
|---|---|---|
| NZ Post Group 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/parcellabel/v3/ |
| 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/parcellabel/v3/ |
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 |
|---|---|
| Create consignment labels where the carrier is Pace | Labels are created in PDF format |
| Create consignment labels where the carrier is Pace and a notification endpoint is provided in the request | Labels are created in PDF format and notification received |
| Create consignment labels where the carrier is CourierPost | Labels are created in PDF format |
| Create international consignment labels where the carrier is blank | Labels are created in PDF format |
| Create a ParcelPost Domestic Return label | Label is created in PDF format |
| Get status of labels within a consignment | Status of all labels within the consignment are returned |
| Get status of labels within a consignment and related consignments within the same order | Status of all labels within the consignment and related are returned |
| Download labels of a consignment | The images of all labels within the consignment are downloaded in PDF format |
| Download a label of a consignment | The images of the label within the consignment is downloaded in PNG format |