.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Net::Amazon::Property 3pm"
.TH Net::Amazon::Property 3pm "2021-01-02" "perl v5.32.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Net::Amazon::Property \- Baseclass for products on amazon.com
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Net::Amazon;
\&
\&  # ...
\&
\&  if($resp\->is_success()) {
\&      for my $prop ($resp\->properties) {
\&          print $_\->ProductName(), " ",
\&                $_\->Manufacturer(), " ",
\&                $_\->OurPrice(), "\en";
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`Net::Amazon::Property\*(C'\fR is the baseclass for results returned
from Amazon web service queries. The term 'properties' is used as 
a generic description for an item on amazon.com.
.PP
Typically, the \f(CW\*(C`properties()\*(C'\fR method of a \f(CW\*(C`Net::Amazon::Response::*\*(C'\fR object
will return one or more objects of class \f(CW\*(C`Net::Amazon::Property\*(C'\fR or
one of its subclasses, e.g. \f(CW\*(C`Net::Amazon::Property::Book\*(C'\fR or
\&\f(CW\*(C`Net::Amazon::Property::CD\*(C'\fR.
.PP
While \f(CW\*(C`Net::Amazon::Property\*(C'\fR objects expose accessors for all 
fields returned in the \s-1XML\s0 response (like \f(CW\*(C`OurPrice()\*(C'\fR, \f(CW\*(C`ListPrice()\*(C'\fR,
\&\f(CW\*(C`Manufacturer()\*(C'\fR, \f(CW\*(C`Asin()\*(C'\fR, \f(CW\*(C`Catalog()\*(C'\fR, \f(CW\*(C`ProductName()\*(C'\fR, subclasses
might define their own accessors to more class-specific fields
(like the i\f(CW\*(C`Net::Amazon::Property::Book\*(C'\fR's \f(CW\*(C`authors()\*(C'\fR method returning
a list of authors, while \f(CW\*(C`Net::Amazon::Property\*(C'\fR's \f(CW\*(C`Authors()\*(C'\fR method
will return a reference to a sub-hash containing a \f(CW\*(C`Author\*(C'\fR field, just like
the response's \s-1XML\s0 contained it).
.SS "\s-1METHODS\s0"
.IX Subsection "METHODS"
Methods vary, depending on the item returned from a query. Here's the most
common ones. They're all accessors, meaning they can be used like \f(CW\*(C`Method()\*(C'\fR
to retrieve the value or like \f(CW\*(C`Method($value)\*(C'\fR to set the value of the
field.
.IP "\fBAsin()\fR" 4
.IX Item "Asin()"
The item's \s-1ASIN\s0 number.  This option is deprecated, please use \s-1ASIN.\s0
.IP "\s-1\fBASIN\s0()\fR" 4
.IX Item "ASIN()"
The item's \s-1ASIN\s0 number.
.IP "\fBProductName()\fR" 4
.IX Item "ProductName()"
Book title, \s-1CD\s0 album name or item name.  This option is actually an alias for
the method title, and is actually dependent upon the type of item returned.
.IP "\fBAvailability()\fR" 4
.IX Item "Availability()"
Text string describing if the item is available. Examples:
\&\f(CW"Usually ships within 24 hours"\fR or
\&\f(CW"Out of Print\-\-Limited Availability"\fR.
.IP "\fBCatalog()\fR" 4
.IX Item "Catalog()"
Shows the catalog the item was found in: \f(CW\*(C`Book\*(C'\fR, \f(CW\*(C`Music\*(C'\fR, \f(CW\*(C`Classical\*(C'\fR,
\&\f(CW\*(C`Electronics\*(C'\fR etc.
.IP "\fBAuthors()\fR" 4
.IX Item "Authors()"
Returns a sub-hash with a \f(CW\*(C`Author\*(C'\fR key, which points to either a single
\&\f(CW$scalar\fR or to a reference of an array containing author names as scalars.
.IP "\fBReleaseDate()\fR" 4
.IX Item "ReleaseDate()"
Item's release date, format is \*(L"\s-1NN\s0 Monthname, Year\*(R".
.IP "\fBManufacturer()\fR" 4
.IX Item "Manufacturer()"
Music label, publishing company or manufacturer
.IP "\fBImageUrlSmall()\fR" 4
.IX Item "ImageUrlSmall()"
\&\s-1URL\s0 to a small (thumbnail) image of the item
.IP "\fBImageUrlMedium()\fR" 4
.IX Item "ImageUrlMedium()"
\&\s-1URL\s0 to a medium-size image of the item
.IP "\fBImageUrlLarge()\fR" 4
.IX Item "ImageUrlLarge()"
\&\s-1URL\s0 to a large image of the item
.IP "\fBListPrice()\fR" 4
.IX Item "ListPrice()"
List price of the item
.IP "\fBOurPrice()\fR" 4
.IX Item "OurPrice()"
Amazon price of the item
.IP "\fBUsedPrice()\fR" 4
.IX Item "UsedPrice()"
Used price of the item
.IP "\fBRawListPrice()\fR" 4
.IX Item "RawListPrice()"
Unformatted list price as an integer, without currency symbol.
.IP "\fBCurrencyCode()\fR" 4
.IX Item "CurrencyCode()"
The currency code for the \*(L"\fBListPrice()\fR\*(R", e.g. \f(CW\*(C`USD\*(C'\fR.
.IP "\fBSalesRank()\fR" 4
.IX Item "SalesRank()"
Sales rank of the item (contains digits and commas, like 1,000,001)
.IP "\fBMedia()\fR" 4
.IX Item "Media()"
Type of media (Paperback, etc.).
.IP "\fBNumMedia()\fR" 4
.IX Item "NumMedia()"
Number of media the item carries (1,2 CDs etc.).
.IP "\fBProductDescription()\fR" 4
.IX Item "ProductDescription()"
Lengthy textual description of the product.
.IP "\fBCollectiblePrice()\fR" 4
.IX Item "CollectiblePrice()"
Lowest price in \*(L"Collectible\*(R" category.
.IP "\fBCollectibleCount()\fR" 4
.IX Item "CollectibleCount()"
Number of offerings in \*(L"Collectible\*(R" category.
.IP "\fBNumberOfOfferings()\fR" 4
.IX Item "NumberOfOfferings()"
Total number of offerings in all categories.
.IP "\fBUsedCount()\fR" 4
.IX Item "UsedCount()"
Number of offerings in \*(L"Used\*(R" category.
.IP "\fBTotalOffers()\fR" 4
.IX Item "TotalOffers()"
Number of offerings of the product.
.IP "\fBThirdPartyNewPrice()\fR" 4
.IX Item "ThirdPartyNewPrice()"
Lowest price in \*(L"Third Party New\*(R" category.
.IP "\fBThirdPartyNewCount()\fR" 4
.IX Item "ThirdPartyNewCount()"
Number of offerings in \*(L"Third Party New\*(R" category.
.IP "\fBSmallImageWidth()\fR" 4
.IX Item "SmallImageWidth()"
Return the width of the small image in pixels.
.IP "\fBSmallImageHeight()\fR" 4
.IX Item "SmallImageHeight()"
Return the height of the small image in pixels.
.IP "\fBMediumImageWidth()\fR" 4
.IX Item "MediumImageWidth()"
Return the width of the medium image in pixels.
.IP "\fBMediumImageHeight()\fR" 4
.IX Item "MediumImageHeight()"
Return the height of the medium image in pixels.
.IP "\fBLargeImageWidth()\fR" 4
.IX Item "LargeImageWidth()"
Return the width of the large image in pixels.
.IP "\fBLargeImageHeight()\fR" 4
.IX Item "LargeImageHeight()"
Return the height of the large image in pixels.
.IP "\fBSuperSaverShipping()\fR" 4
.IX Item "SuperSaverShipping()"
Boolean value that indicates if the product is eligible for super saver
shipping.
.IP "\fByear()\fR" 4
.IX Item "year()"
The release year extracted from \fBReleaseDate()\fR.
.IP "\fBbrowse_nodes()\fR" 4
.IX Item "browse_nodes()"
Returns a list of browse nodes (text string categories) for this item.
.IP "\fBsimilar_asins()\fR" 4
.IX Item "similar_asins()"
Returns a list of ASINs of similar items for this item.
.IP "\fBSimilarProducts()\fR" 4
.IX Item "SimilarProducts()"
Returns a list of ASINs and titles of similar items for this item.
.PP
Please check the subclasses of \f(CW\*(C`Net::Amazon::Property\*(C'\fR for specialized 
methods.
.SH "AUTHOR"
.IX Header "AUTHOR"
Mike Schilli, <m@perlmeister.com>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 2003 by Mike Schilli <m@perlmeister.com>
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.