Collection and Drop Off API

1.0.x
(0 reviews)

Purpose

New Zealand Post offers a network of Collection and drop off locations. Collection locations provide receivers with a convenient alternative to receiving parcels to home or work. The Collection and Drop off API can be used to return Collection or Drop off locations.

This API works in conjunction with the ParcelAddress API to find the customer’s location. Once the location has been confirmed, the Collection and Drop off API makes recommendations for nearby collection or drop off locations based on the customer’s location.

Collection locations

The merchant's customers will be able to choose to have their parcels delivered directly to one of our many collection locations nationwide.

NOTE: When generating your own label, you will need to include "COLLECTION" in the destination address

Step 1 – Validate the customer’s address/location via the ParcelAddress API to obtain an Address ID

Step 2 – Using the Address ID, make a request to the Collection and Drop Off API to find nearby locations that the customer can collect their parcel from

Drop off locations

The merchant can display relevant drop off locations.

NOTE: When users need to find nearby drop off addresses

Step 1 – Validate the customer’s address/location via the ParcelAddress API to obtain an Address ID

Step 2 – Using the Address ID, make a request to the Collection and Drop Off Locations API to find nearby locations where the customer can drop off their parcel

NOTE: When users need to query all drop off locations nationwide

Step 1 – Make a request to the Collection and Drop Off Locations API to find all locations where the customer can drop off their parcel

Restrictions

The following restrictions apply to using the Collection service:

· Parcel Carrier – Courier Post, New Zealand Post (tracked items only), No Pace items

· Maximum Parcel Size – 50cm x 40cm x 30 cm

· Maximum Parcel Weight – 15kgs

· Product restrictions – No Dangerous goods, perishable, prohibited or restricted items (e.g. Alcohol or Tobacco)

· No untracked items

Pre-requisites

In order for you to gain access to the Collection and Drop Off API, you and your organisation must meet the following pre-requisites:

  1. Your organisation must have an active NZ Post or CourierPost account number.
  2. You must be registered with the Developer Portal. You can register here by completing the registration form. The email address you provide on the registration form will be your Developer Portal username.
  3. You must have reviewed and accepted the Terms and Conditions for use of the NZ Post Group APIs.
  4. You must have requested, and received access to the Collection and Drop off API.
  5. You must use address_id to obtain the address details and collection or drop off location from the Collection and Drop off API.
  6. Your system must be sending manifest data for customer’s parcels to ensure efficient delivery to the correct location.

Collection only

  1. Your label generation process must be able to include “COLLECTION” at the front of the address. This will ensure that the parcel is held as a collection item, rather than mail intended for the delivery location. (Merchants using ParcelLabel API will automatically create these labels with collection tags).

For developer integration enquiries, please email techsupport@nzpost.co.nz. Support is available during New Zealand business hours.

Reviews