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
Setting up NZ Post Domestic
1. Request commercial access to use NZ Post with Starshipit
To use NZ Post on Starshipit, you need to have a commercial access to the NZ Post API. If you already have a commercial access, please proceed to Step 2. If not, please follow the steps in this guide to request commercial access to use NZ Post with Starshipit.
Note
The process to request commercial access only needs to be completed once if you are setting up all three couriers in Starshipit and using the same account number for all three.2. Enter your API details in Starshipit
Typically, this setup will be completed by the Starshipit team on your behalf. We will reach out to the NZ Post team to obtain your respective API Key (Client ID) and API Secret (Client Secret). However, if you already have your API Key and API Secret and wish to complete the setup yourself, follow the steps below:
- Go to Settings > Couriers > Add New Courier > NZ Post Domestic.
- Tick Enable NZ Post Domestic.
- Under the Location dropdown select your location.
- Enter your Account Number, Client ID (API Key), and Client Secret (API Secret).
- Click Save.
- Navigate to the Advanced tab and select Print domestic Labels using API.
- Click Save.
3. Set your default products
Once Starshipit has confirmed NZ Post Domestic is available on your account, you should check that your preferred services are configured.
- Go to Settings > Couriers > NZ Post Domestic > Settings.
- Click the Advanced tab.
- Under Default North Island Product and Default South Island Product, select your preferred default products.
If you wish to use different products with each order you can choose in each order what product to use, or you can configure rules to automatically assign products.
For more information on configuring rules see this guide.
4. Returns with NZ Post Domestic
NZ Post offers multiple returns services such as Economy Returns, Courier Returns and Easy Returns. If you want to use NZ Post Domestic for returns the easiest way to have this enabled is to contact your account manager at NZ Post. Alternatively, you can reach out to our support team who can help in getting this process underway.
If you aren't using Economy Returns or Courier returns, NZPost returns use the same product codes as their outbound orders.
To set the return code you would like to use:
- Go to Settings > Couriers > NZ Post Domestic > Advanced.
- Enter the code in the field Return Label Code.
- Click Save.
If you are using Economy Returns or Courier returns, you will need to set up your returns address and default returns service, these can be found in your NZ Post Domestic advanced settings. For assistance setting this up please reach out to our support team.
Troubleshooting
Error message Could not authenticate comes up upon clicking the test
This is most likely due to your account not having been fully set up yet.
Error in getting access token
The remote server returned an error: (401) Unauthorized.
Please double-check your credentials and check for incorrect spacing. If it is still happening contact our support team.
NZ Post not showing on the checkout
If you have completed the set up in both courier configuration and in your eCommerce platform but NZ Post is still not showing as an option on your checkout, ensure you have Print domestic Labels using API enabled:
- In Starshipit, navigate to Settings > Couriers > NZ Post Domestic Settings > Advanced
When uploading a logo to display logo on labels, I get an error "No logo uploaded"
To upload a logo to NZ Post domestic labels, you must first:
- In Starshipit, navigate to Settings > Couriers > NZ Post Domestic Settings.
- Go to the Advanced tab and tick the Print domestic Labels using API option.
- The Onboard-MerchantLogos API endpoint on Anypoint must be required and approved on your account. Please reach out to our team to get this approved.
Other relevant information for you
To know more about NZ Post's eShip services, click here
For more information on NZ Post eShip and Starshipit, click here
Starshipit now supports Economy returns and Courier Returns with NZ Post for more information please reach out to our support team.
