/ 
Net-Easypost-0.05
River stage zero No dependents
/ Net::Easypost

NAME

Net::Easypost - Perl client for the Easypost web service

VERSION

version 0.05

SYNOPSIS

use 5.014;
use Net::Easypost;

my $ezp = Net::Easypost->new(
      access_code => 'sekrit'
);

$addr = $ezp->verify_address( {
      street1 => '101 Spear St',
      city => 'San Francisco',
      zip => '94107'
} );

my $to = $addr->clone;
$to->role('to');
$to->name('Mr Spacely');

my $from = Net::Easypost::Address->new(
      role => 'from',
      name => 'George Jetson',
      street1 => '1060 W Addison',
      city => 'Chicago',
      state => 'IL',
      phone => '3125559797',
      zip => '60657'
);

my $parcel = Net::Easypost::Parcel->new(
      length => 10.0, # dimensions in inches
      width => 12.0,  
      height => 5.0, 
      weight => 13.0, # weight in ounces
);

my $service = Net::Easypost::Rate->new(
      service => 'Priority',
);

my $label = $ezp->buy_label(
      $to,
      $from,
      $parcel,
      $service
);

printf("You paid $0.2f for your label to %s\n", $label->rate->rate, $to);
$label->save;
say ("Your postage label has been saved to ", $label->filename);

OVERVIEW

This is a Perl client for the postage API at Easypost. Consider this API at beta quality mostly because some of these library calls have an inconsistent input parameter interface which I'm not super happy about. Still, there's enough here to get meaningful work done, and any future changes will be fairly cosmetic.

At this time, Easypost only supports United States based addresses.

Please note! All API errors are fatal via croak. If you need to catch errors more gracefully, I recommend using Try::Tiny in your implementation.

ATTRIBUTES

access_code

This is the Easypost API access code which the client will use to authenticate calls to various endpoints. This is a required attribute which must be supplied at object instantiation time.

METHODS

verify_address

This method attempts to validate an address. This call expects to take the same parameters (in a hashref) or an instance of Net::Easypost::Address, namely:

  • street1

  • street2

  • city

  • state

  • zip

You may omit some of these attributes like city, state if you supply a zip, or zip if you supply a city, state.

This call returns a new Net::Easypost::Address object.

Along with the validated address, the phone and name fields will be copied from the input parameters, if they're set.

get_rate

This method will get postage rates between two zip codes. It takes the following input parameters:

This call returns an array of Net::Easypost::Rate objects in an arbitrary order.

buy_label

This method will attempt to purchase postage and generate a shipping label.

It takes as input:

It returns a Net::Easypost::Label object.

get_label

This method retrieves a label from a past purchase. It takes the label filename as its only input parameter. It returns a Net::Easypost::Label object.

list_labels

This method returns an arrayref with all past purchased label filenames. It takes no input parameters.

SUPPORT

Please report any bugs or feature requests to "bug-net-easypost at rt.cpan.org", or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Net-Easypost. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

Or, if you wish, you may report bugs/features on Github's Issue Tracker. https://github.com/mrallen1/Net-Easypost/issues

SEE ALSO

AUTHOR

Mark Allen <mrallen1@yahoo.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2012 by Mark Allen.

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