Cancel method

This API method allows you to cancel any watches you have for a single package.

How the cancel method works

Make a GET or POST HTTP request to api.nzpost.co.nz/tracking-notification/api/cancel with the form parameters listed below. An HTML form is available for easy testing of requests.

Parameters for the API request

Parameter Name Description Example
tracking_identifier Tracking Identifier The tracking identifier of the package you wish to cancel. This identifier was returned in the response of the watch API call. 0WuD56wGyTeNekdxtUT3

On success, redirects to a URL (as specified on your license key). See the default New Zealand Post page for an example.

Related information