NAME

WWW::NZPost::Tracking - Perl interface to the New Zealand Post tracking service

SYNOPSIS

  use WWW::NZPost::Tracking;

  my $nzp = WWW::NZPost::Tracking->new(
      license_key     => '12345678',
      user_ip_address => '127.0.0.1',
  );

  my ($package) = $nzp->track( tracking_number => 'XY123456789NZ' );

DESCRIPTION

This module provides an object-oriented Perl interface to the New Zealand Post tracking service.

METHODS

new

Returns a new WWW::NZPost::Tracking object. Takes the following parameters as a hash:

  • license_key

    Your New Zealand Post license key.

  • user_ip_address

    The IP address of the end user.

  • mock

    If set, returns dummy data as documented in the NZ Post API documentation.

track

Tracks a package. Takes the following parameters as a hash, returns an array of WWW::NZPost::Tracking::Package objects.

  • tracking_number

    String representing one tracking number, or an array reference of up to 10 tracking numbers.

  • include_signature_data

    Set if you would like the API to return signature data.

DEPENDENCIES

JSON, LWP::UserAgent, Moose

BUGS

DISCLAIMER

The author of this module is not affiliated in any way with New Zealand Post. It is provided as a courtesy to other users of the services provided by New Zealand Post.

Users must follow all terms and requirements associated with use of the New Zealand Post web services.

Documentation can be found at <http://www.nzpost.co.nz/products-services/iphone-apps-apis/tracking-api/track-method>

LICENSE

This code is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

AUTHOR

Authored by Michael Aquilina <aquilina@cpan.org> for the Bizowie ERP <http://bizowie.com> platform.