ParcelLabel API

Download
โ˜…โ˜…โ˜…โ˜…โ˜…
(2 reviews)

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

NameUseAddresses
NZ Post Group User Acceptance Test (UAT) EnvironmentThis 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 EnvironmentThis 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 CasesExpected Result
Create consignment labels where the carrier is PaceLabels are created in PDF format
Create consignment labels where the carrier is Pace and a notification endpoint is provided in the requestLabels are created in PDF format and notification received
Create consignment labels where the carrier is CourierPostLabels are created in PDF format
Create international consignment labels where the carrier is blankLabels are created in PDF format
Create a ParcelPost Domestic Return labelLabel is created in PDF format
Get status of labels within a consignmentStatus of all labels within the consignment are returned
Get status of labels within a consignment and related consignments within the same orderStatus of all labels within the consignment and related are returned
Download labels of a consignmentThe images of all labels within the consignment are downloaded in PDF format
Download a label of a consignmentThe images of the label within the consignment is downloaded in PNG format

Reviews