Net::Simplify::Product - A Simplify Commerce Product object
use Net::Simplify; use Net::Simplify::Product; $Net::Simplify::public_key = 'YOUR PUBLIC KEY'; $Net::Simplify::private_key = 'YOUR PRIVATE KEY'; # Create a new Product. my $product = Net::Simplify::Product->create{ {...}); # Retrieve a Product given its ID. my $product = Net::Simplify::Product->find('a7e41'); # Update existing Product. my $product = Net::Simplify::Product->find('a7e41'); $product->{PROPERTY} = "NEW VALUE"; $product->update(); # Delete my $product = Net::Simplify::Product->find('a7e41'); $product->delete(); # Retrieve a list of objects my $products = Net::Simplify::Product->list({max => 10}); foreach my $v ($products->list) { # ... }
Creates a Net::Simplify::Product
object. The parameters are:
%params
Hash map containing initial values for the object. Valid keys are:
Product in stock. [default: true] (required)
Currency code (ISO-4217) for the product. Must match the currency associated with your account. [default: USD] (required)
Description of the product. [max length: 255]
Product enabled to view in store. [default: true] (required)
The image used to display your product. [max length: 255]
The maximum quantity allowed per purchase [min value: 1, max value: 99]
Name of the product. [max length: 255, min length: 2] (required)
Price of the product.
Shipping Required [default: false] (required)
Type [valid values: Product, Donation, default: Product]
$auth
Authentication object for accessing the API. If no value is passed the global keys $Net::Simplify::public_key
and $Net::Simplify::private_key
are used.
Deletes the Net::Simplify::Product
object. Authentication is done using the same credentials used when the AccessToken was created.
Retrieve a list of Net::Simplify::Product
objects. The parameters are:
%criteria
Hash map representing the criteria to limit the results of the list operation. Valid keys are:
filter
Filters to apply to the list.
max
Allows up to a max of 50 list items to return. [max value: 50, default: 20]
offset
Used in paging of the list. This is the start offset of the page. [default: 0]
sorting
Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either asc
for ascending or desc
for descending). Sortable properties are:
id
name
type
Retrieve a Net::Simplify::Product
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_key
and $Net::Simplify::private_key
are used.
Update Net::Simplify::Product
object. The properties that can be updated are:
available
Available (in stock) flag.
currency
Currency code (ISO-4217) for the product. Must match the currency associated with your account.
description
Description of the product. [max length: 4000]
enabled
Enabled flag.
imageUrl
URL of the image of the product.
maxQuantity
The maximum quantity allowed per purchase [min value: 1, max value: 99]
name
Name of the product. [max length: 255, min length: 2]
price
Price of the product (in the smallest unit of your currency). Example: 100 = $1.00USD
shippingRequired
Shipping flag.
type
Type [valid values: Product, Donation]
Authentication is done using the same credentials used when the AccessToken was created.
Net::Simplify, Net::Simplify::Domain, Net::Simplify::DomainList, Net::Simplify::Authentication, Net::Simplify::ApiException, http://www.simplify.com
1.1.0
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.