Overview
- Starshipit's integration with NZ Post allows you to use all of Starshipit's features including generation of packing slips and shipping labels, auto-correction of addresses, branded tracking and notifications and many more.
- Starshipit is fully integrated with NZ Post services including their domestic, international and express offerings. These three services are represented as three different couriers in Starshipit:
- NZ Post Domestic
- NZ Post International
- NZ Post Express
Before you begin
To use any of these couriers on Starshipit you will need to request commercial access to the NZ Post API.
Once this has been completed you will need a Client ID and Client Secret to finish the set-up. These credentials are requested on your behalf by the Starshipit team. We will just need your Account Number, Site ID, and Permit Post Number (if applicable).
Note
An account number starting with a 9 can be used for Domestic and International. An account number starting with a 5 can only be used for International.If you have two account numbers, check with NZ Post if one of the account numbers has a discounted pricing set up on it as this one should be used with Starshipit.
1. Request commercial access
- Create an account here if you haven't already.
- Log into your NZ Post account.
- Go to this link and fill in the form to register for API commercial access.
- Add Starshipit Support and support@starshipit.com as your developer contact.
- Designate Domestic and International services as the services you want.
- Click Submit.
After you apply for the above, you will get an email from the NZ Post API team within 2-3 business days. It will include the steps for requesting your Client ID and Client secret, however, you should not follow these steps and instead proceed with the next steps below.
2. Send account information to Starshipit
Once your application for commercial access has been processed, send the following information to our Starshipit support team:
- Account Number(s)
- Site ID (CourierPost)
- Permit Post Number (NZ Post International, optional)
We will process an application to get your Client ID and Client secret from NZ Post on your behalf. Our team will inform you once we hear back from NZ Post.
3. Set up your couriers
Once Starshipit has your Client ID and Client Secret, we will also set up your required couriers on your behalf provided you have been in contact with our team.
Otherwise, if you have been given your Client ID and Client Secret by our team, you can set up each courier by yourself using the following guides:
Other relevant information for you
To learn more about NZ Post's eShip services, click here.
For more information on NZ Post eShip and Starshipit, click here.
