NAME
Net::Simplify::Order - A Simplify Commerce Order object
SYNOPSIS
use Net::Simplify;
use Net::Simplify::Order;
$Net::Simplify::public_key = 'YOUR PUBLIC KEY';
$Net::Simplify::private_key = 'YOUR PRIVATE KEY';
# Create a new Order.
my $order = Net::Simplify::Order->create{ {...});
# Retrieve a Order given its ID.
my $order = Net::Simplify::Order->find('a7e41');
# Update existing Order.
my $order = Net::Simplify::Order->find('a7e41');
$order->{PROPERTY} = "NEW VALUE";
$order->update();
# Delete
my $order = Net::Simplify::Order->find('a7e41');
$order->delete();
# Retrieve a list of objects
my $orders = Net::Simplify::Order->list({max => 10});
foreach my $v ($orders->list) {
# ...
}DESCRIPTION
METHODS
create(%params, $auth)
Creates a Net::Simplify::Order object. The parameters are:
%params-
Hash map containing initial values for the object. Valid keys are:
- customer
-
Description (required)
- customerEmail
-
Description (required)
- customerName
-
Description (required)
- customerNote
-
Description [max length: 255]
- invoice
-
Description
- items.amount
-
Description
- items.description
-
Description
- items.name
-
Description
- items.product
-
Description
- items.quantity
-
Description [min value: 1, max value: 999999, default: 1] (required)
- items.reference
-
Description [max length: 255]
- items.tax
-
Description
- merchantNote
-
Description [max length: 255]
- payment
-
Description (required)
- reference
-
Description [max length: 255]
- shippingAddress
- shippingAddressCity
-
Description [max length: 255, min length: 2]
- shippingAddressCountry
-
Description [max length: 2, min length: 2, default: US] (required)
- shippingAddressLine1
-
Description [max length: 255]
- shippingAddressLine2
-
Description [max length: 255]
- shippingAddressState
-
Description [max length: 2]
- shippingAddressZip
-
Description [max length: 32]
- shippingName
-
Description (required)
- source
-
Description [default: WEB] (required)
- status
-
Description [default: INCOMPLETE] (required)
$auth-
Authentication object for accessing the API. If no value is passed the global keys
$Net::Simplify::public_keyand$Net::Simplify::private_keyare used.
delete()
Deletes the Net::Simplify::Order object. Authentication is done using the same credentials used when the AccessToken was created.
list(%criteria, $auth)
Retrieve a list of Net::Simplify::Order objects. The parameters are:
%criteria-
Hash map representing the criteria to limit the results of the list operation. Valid keys are:
filter-
Description
max-
Description [max value: 50, default: 20]
offset-
Description [default: 0]
sorting-
Description The value maps properties to the sort direction (either
ascfor ascending ordescfor descending). Sortable properties are:iddateCreatedlastUpdated
find($id, $auth)
Retrieve a Net::Simplify::Order object from the API. Parameters are:
$id-
Identifier of the object to retrieve.
$auth-
Authentication object for accessing the API. If no value is passed the global keys
$Net::Simplify::public_keyand$Net::Simplify::private_keyare used.
update()
Update Net::Simplify::Order object. The properties that can be updated are:
customerNote-
Description [max length: 255]
invoice-
Description
merchantNote-
Description [max length: 255]
payment-
Description (required)
reference-
Description [max length: 255]
status-
Description (required)
Authentication is done using the same credentials used when the AccessToken was created.
SEE ALSO
Net::Simplify, Net::Simplify::Domain, Net::Simplify::DomainList, Net::Simplify::Authentication, Net::Simplify::ApiException, http://www.simplify.com
VERSION
1.1.0
LICENSE
Copyright (c) 2013, 2014 MasterCard International Incorporated All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of the MasterCard International Incorporated nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.