ParcelLabel API

Download
Opens request access modal
(2 reviews)

Getting Started

Applying for access to the New Zealand Post Shipping APIs is a simple three step process.

Step 1. Register for a https://www.nzpost.co.nz account

You can do this by navigating here.

Step 2. Complete the commercial access form

This form provides us with the required billing information which is attached to your API key. This form only needs to be filled out once for your organization and must be completed in order for us to approve your application. You can access the form here.

Step 3. Request API access for an application

(Please note that you will need to repeat this step for each API you're wanting access to)

Navigate to the technical documentation for the API you're wanting to access. You can find links to our technical documentation on this page (simply click on the name of the API you're after).

At the top of the technical documentation page, click the "Request API access" button:

164036ad-063f-41f5-86fe-b84da4dc743d-Request access.PNG

Either:

  1. Select one of your existing applications (if you have already requested access for other APIs) or

  2. Add a “new application”.

When registering a new application, include OAuth 2.0 grant type "Client Credentials Grant".

497ca4f8-d823-4994-be53-911217dd0ebc-create new application.PNG

Select the SLA tier you would like to use.

Read the Terms & Conditions and check the box to accept these.

b757ac6e-9016-48b3-abbc-0eb3c0779875-SLA Tier.PNG

Hit request access.

b4ca2b3f-6e80-4ebf-bb55-afde9dcfc466-request received.PNG

Your access request will be assessed and approved within 2-3 working days. You will receive an e-mail upon approval.

If you require access to our UAT environment, please get in touch with our support team at api@nzpost.co.nz. Make sure you provide us with the name of your application.

Retrieving your client_id/client_secret

You can retrieve your client_id/client_secret by navigating to the following page, these keys are used for accessing our APIs:

https://anypoint.mulesoft.com/exchange/portals/nz-post-group/applications/

e5397b30-c476-479f-a835-1f3fe6c2c9fa-my applications.PNG

From here, simply click on the name of your application:

2c327a30-b5f9-4ae9-bcc4-e0f98ba86471-my ecommerce application.PNG


Reviews