ParcelLabel API

Download
(2 reviews)

Printing GoAustralia (eParcel) Labels

Description

There is a way to generate e-Parcel labels using ParcelLabel API v3.0. These provide a method for customers who want to send parcels from Australia to Australia.

NOTE: Pickup address and Delivery address must be both Australia addresses. For Australian addresses, Street, Suburb, City, State and Postcode fields are required.

How do I generate eParcel labels using ParcelLabel API?

Simply change the service code to either "TDEAUS" (eParcel Sig with ATL) or "TDEAUT" (eParcel Tracked) in the request body when calling the Create Label endpoint, i.e. https://api.nzpost.co.nz/parcellabel/v3/labels.

Value service codes are:

  • TDEAUT (GoAustralia Tracked)
  • TDEAUS (GoAustralia Signature Required – with ATL)
  • TDEAUN (GoAustralia Signature Requried – No ATL)
  • TDEAXS (GoAustralia Express Signature Required – with ATL)
  • TDEAXN (GoAustralia Express Signature Requried – No ATL)
How do I get service codes enabled or set up for international services?

To get service codes enabled, you will need to contact your account manager. He/she will enable the service code(s) for you.
To gain access for international services, you will need to contact your account manager. International services require a 5 series account number and a redclick API key. Your account manager will provide you with a 5 series account number and escalate to the appropriate team to acquire a redclick API key.

Service code TDEAUS

When the service code is TDEAUS, the instructions field value within the delivery_address array MUST be empty.

Create Label(s) - International

resources/TDEAUS%20service%20code-9ff79bc1-b656-4100-9582-a1f2b40e16c0.PNG

Download Label(s)

resources/TDEAUS%20Label-7ef440d3-4902-4d38-88f2-49e939ce1460.PNG

Service code TDEAUT

When the service code is TDEAUT, the instructions field value within the delivery_address array MUST NOT be empty.

Create Label(s) - International

resources/TDEAUT%20service%20code-2ed978a3-859d-423b-9459-11e759505fff.PNG

Download Label(s)

resources/TDEAUT%20Label-4500c7a7-b481-4c48-bdca-45284b33c1eb.PNG


Reviews