NAME

VendorAPI::2Checkout::Client - an OO interface to the 2Checkout.com Vendor API

VERSION

Version 0.06

SYNOPSIS

    use VendorAPI::2Checkout::Client;

    my $tco = VendorAPI::2Checkout::Client->new($username, $password);
    $sales = $tco->list_sales();

    $sale = $tco->detail_sale(sale_id => 1234554323);

    ...

DESCRIPTION

This module is an OO interface to the 2Checkout.com Vendor API.

This modules uses Params::Validate which likes to die() when the parameters do not pass validation, so wrap your code in evals, etc.

Presently only implements list_sales (no params), and detail_sale( sale_id => $sale_id ).

Return data is in XML. Requesting JSON not implemented yet.

Please refer to 2Checkout's Back Office Admin API Documentation for input parameters and expexted return values.

CONSTRUCTORS AND METHODS

$c = VendorAPI::2Checkout::Client->new($username, $password)

Contructs a new VendorAPI::2Checkout::Client object to comminuncate with the 2Checkout Back Office Admin API. You must pass your Vendor API username and password or the constructor will return undef;

$sales = $c->list_sales();

Retrieves the list of sales for the vendor

$sale = $c->detail_sale(sale_id => $sale_id);

Retrieves the details for the named sale.

AUTHOR

Len Jaffe, <lenjaffe at jaffesystems.com>

BUGS

Please report any bugs or feature requests to bug-vendorapi-2checkout-client at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=VendorAPI-2Checkout-Client. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc VendorAPI::2Checkout::Client

You can also look for information at:

• RT: CPAN's request tracker (report bugs here)

  http://rt.cpan.org/NoAuth/Bugs.html?Dist=VendorAPI-2Checkout-Client

• AnnoCPAN: Annotated CPAN documentation

  http://annocpan.org/dist/VendorAPI-2Checkout-Client

• CPAN Ratings

  http://cpanratings.perl.org/d/VendorAPI-2Checkout-Client

• Search CPAN

  http://search.cpan.org/dist/VendorAPI-2Checkout-Client/

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2011 Len Jaffe.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.