Docs For Class ItemType

## Class ItemType

Description

ItemType

Located in /PayPal/Type/ItemType.php (line 16)

    XSDType
       |
       --ItemType

Variable Summary
mixed $ApplicationData
mixed $AutoPay
mixed $BuyerProtection
mixed $BuyItNowPrice
mixed $Charity
mixed $Country
mixed $CrossPromotion
mixed $Currency
mixed $Description
mixed $Escrow
mixed $GiftIcon
mixed $GiftServices
mixed $HitCounter
mixed $ItemID
mixed $ListingDesigner
mixed $ListingDetails
mixed $ListingDuration
mixed $ListingEnhancement
mixed $ListingType
mixed $ListOfAttributeSets
mixed $Location
mixed $PartnerCode
mixed $PartnerName
mixed $PaymentMethods
mixed $PayPalEmailAddress
mixed $PrimaryCategory
mixed $PrivateListing
mixed $Quantity
mixed $RegionID
mixed $RelistLink
mixed $ReservePrice
mixed $ReviseStatus
mixed $ScheduleTime
mixed $SecondaryCategory
mixed $Seller
mixed $SellingStatus
mixed $ShippingDetails
mixed $ShippingOption
mixed $ShippingRegions
mixed $ShippingTerms
mixed $Site
mixed $SiteHostedPicture
mixed $StartPrice
mixed $Storefront
mixed $SubTitle
mixed $TimeLeft
mixed $Title
mixed $UUID
mixed $VATDetails
mixed $VendorHostedPicture
Method Summary
ItemType ItemType ()
void getApplicationData ()
void getAutoPay ()
void getBuyerProtection ()
void getBuyItNowPrice ()
void getCharity ()
void getCountry ()
void getCrossPromotion ()
void getCurrency ()
void getDescription ()
void getEscrow ()
void getGiftIcon ()
void getGiftServices ()
void getHitCounter ()
void getItemID ()
void getListingDesigner ()
void getListingDetails ()
void getListingDuration ()
void getListingEnhancement ()
void getListingType ()
void getListOfAttributeSets ()
void getLocation ()
void getPartnerCode ()
void getPartnerName ()
void getPaymentMethods ()
void getPayPalEmailAddress ()
void getPrimaryCategory ()
void getPrivateListing ()
void getQuantity ()
void getRegionID ()
void getRelistLink ()
void getReservePrice ()
void getReviseStatus ()
void getScheduleTime ()
void getSecondaryCategory ()
void getSeller ()
void getSellingStatus ()
void getShippingDetails ()
void getShippingOption ()
void getShippingRegions ()
void getShippingTerms ()
void getSite ()
void getSiteHostedPicture ()
void getStartPrice ()
void getStorefront ()
void getSubTitle ()
void getTimeLeft ()
void getTitle ()
void getUUID ()
void getVATDetails ()
void getVendorHostedPicture ()
void setApplicationData (mixed $ApplicationData, [mixed $charset = 'iso-8859-1'])
void setAutoPay (mixed $AutoPay, [mixed $charset = 'iso-8859-1'])
void setBuyerProtection (mixed $BuyerProtection, [mixed $charset = 'iso-8859-1'])
void setBuyItNowPrice (mixed $BuyItNowPrice, [mixed $charset = 'iso-8859-1'])
void setCharity (mixed $Charity, [mixed $charset = 'iso-8859-1'])
void setCountry (mixed $Country, [mixed $charset = 'iso-8859-1'])
void setCrossPromotion (mixed $CrossPromotion, [mixed $charset = 'iso-8859-1'])
void setCurrency (mixed $Currency, [mixed $charset = 'iso-8859-1'])
void setDescription (mixed $Description, [mixed $charset = 'iso-8859-1'])
void setEscrow (mixed $Escrow, [mixed $charset = 'iso-8859-1'])
void setGiftIcon (mixed $GiftIcon, [mixed $charset = 'iso-8859-1'])
void setGiftServices (mixed $GiftServices, [mixed $charset = 'iso-8859-1'])
void setHitCounter (mixed $HitCounter, [mixed $charset = 'iso-8859-1'])
void setItemID (mixed $ItemID, [mixed $charset = 'iso-8859-1'])
void setListingDesigner (mixed $ListingDesigner, [mixed $charset = 'iso-8859-1'])
void setListingDetails (mixed $ListingDetails, [mixed $charset = 'iso-8859-1'])
void setListingDuration (mixed $ListingDuration, [mixed $charset = 'iso-8859-1'])
void setListingEnhancement (mixed $ListingEnhancement, [mixed $charset = 'iso-8859-1'])
void setListingType (mixed $ListingType, [mixed $charset = 'iso-8859-1'])
void setListOfAttributeSets (mixed $ListOfAttributeSets, [mixed $charset = 'iso-8859-1'])
void setLocation (mixed $Location, [mixed $charset = 'iso-8859-1'])
void setPartnerCode (mixed $PartnerCode, [mixed $charset = 'iso-8859-1'])
void setPartnerName (mixed $PartnerName, [mixed $charset = 'iso-8859-1'])
void setPaymentMethods (mixed $PaymentMethods, [mixed $charset = 'iso-8859-1'])
void setPayPalEmailAddress (mixed $PayPalEmailAddress, [mixed $charset = 'iso-8859-1'])
void setPrimaryCategory (mixed $PrimaryCategory, [mixed $charset = 'iso-8859-1'])
void setPrivateListing (mixed $PrivateListing, [mixed $charset = 'iso-8859-1'])
void setQuantity (mixed $Quantity, [mixed $charset = 'iso-8859-1'])
void setRegionID (mixed $RegionID, [mixed $charset = 'iso-8859-1'])
void setRelistLink (mixed $RelistLink, [mixed $charset = 'iso-8859-1'])
void setReservePrice (mixed $ReservePrice, [mixed $charset = 'iso-8859-1'])
void setReviseStatus (mixed $ReviseStatus, [mixed $charset = 'iso-8859-1'])
void setScheduleTime (mixed $ScheduleTime, [mixed $charset = 'iso-8859-1'])
void setSecondaryCategory (mixed $SecondaryCategory, [mixed $charset = 'iso-8859-1'])
void setSeller (mixed $Seller, [mixed $charset = 'iso-8859-1'])
void setSellingStatus (mixed $SellingStatus, [mixed $charset = 'iso-8859-1'])
void setShippingDetails (mixed $ShippingDetails, [mixed $charset = 'iso-8859-1'])
void setShippingOption (mixed $ShippingOption, [mixed $charset = 'iso-8859-1'])
void setShippingRegions (mixed $ShippingRegions, [mixed $charset = 'iso-8859-1'])
void setShippingTerms (mixed $ShippingTerms, [mixed $charset = 'iso-8859-1'])
void setSite (mixed $Site, [mixed $charset = 'iso-8859-1'])
void setSiteHostedPicture (mixed $SiteHostedPicture, [mixed $charset = 'iso-8859-1'])
void setStartPrice (mixed $StartPrice, [mixed $charset = 'iso-8859-1'])
void setStorefront (mixed $Storefront, [mixed $charset = 'iso-8859-1'])
void setSubTitle (mixed $SubTitle, [mixed $charset = 'iso-8859-1'])
void setTimeLeft (mixed $TimeLeft, [mixed $charset = 'iso-8859-1'])
void setTitle (mixed $Title, [mixed $charset = 'iso-8859-1'])
void setUUID (mixed $UUID, [mixed $charset = 'iso-8859-1'])
void setVATDetails (mixed $VATDetails, [mixed $charset = 'iso-8859-1'])
void setVendorHostedPicture (mixed $VendorHostedPicture, [mixed $charset = 'iso-8859-1'])
Variables
mixed $ApplicationData (line 24)

Returns custom, application-specific data associated with the item. The data in this field is stored with the item in the items table at eBay, but is not used in any way by eBay. Use ApplicationData to store such special information as a part or SKU number. Maximum 32 characters in length.

mixed $AutoPay (line 38)

If true (1), indicates that the seller requested immediate payment for the item.

False (0) if immediate payment was not requested. (Does not indicate whether the item is still a candidate for puchase via immediate payment.) Only applicable for items listed on US and UK sites in categories that support immediate payment, when seller has a Premier or Business PayPal account.

mixed $BuyerProtection (line 50)

Indicates the status of the item's eligibility for the Buyer Protection Program.

Possible values: ItemIneligible - Item is ineligible (e.g., category not applicable) ItemEligible - Item is eligible per standard criteria ItemMarkedIneligible - Item marked ineligible per special criteria (e.g., seller's account closed) ItemMarkedIneligible - Item marked elegible per other criteria Applicable for items listed to the US site and for the Parts and Accessories category (6028) or Everything Else category (10368) (or their subcategories) on the eBay Motors site.

mixed $BuyItNowPrice (line 57)

Amount a Buyer would need to bid to take advantage of the Buy It Now feature.

Not applicable to Fixed-Price items (Type = 7 or 9) or AdFormat-type listings. For Fixed-Price items, see StartPrice instead.

mixed $Charity (line 62)

Charity listing container.

mixed $Country (line 67)

2-letter ISO 3166 Country Code.

mixed $CrossPromotion (line 72)

CrossPromotions container, if applicable shows promoted items

mixed $Currency (line 77)

3-letter ISO Currency Code.

mixed $Description (line 82)

Item Description.

mixed $Escrow (line 92)

Online Escrow paid for by buyer or seller. Cannot use with real estate auctions.

Escrow is recommended for for transactions over $500. Escrow service, available via Escrow.com, protects both buyer and seller by acting as a trusted third-party during the transaction and managing the payment process from start to finish. Also, if escrow by seller option used, then for Motors, this means that Escrow will be negotiated at the end of the auction.

mixed $GiftIcon (line 99)

If set, a generic gift icon displays in the listing's Title. GiftIcon must be set to to be able to use GiftServices options (e.g., GiftExpressShipping, GiftShipToRecipient, or GiftWrap).

mixed $GiftServices (line 104)

Gift service options offered by the seller of the listed item.

mixed $HitCounter (line 110)

Optional hit counter for the item's listing page. Possible values are:

"NoHitCounter" "HonestyStyle" "GreenLED" "Hidden"

mixed $ItemID (line 115)

The ID that uniquely identifies the item listing.

mixed $ListingDesigner (line 131)

When an item is first listed (using AddItem), a Layout template or a Theme

template (or both) can be assigned to the item. A Layout template is assigned to a new item by specifying the Layout template ID (in the AddItem input argument LayoutID). Similarly, a Theme template is assigned to the item using the ThemeID argument.

mixed $ListingDetails (line 122)

Includes listing details in terms of start and end time of listing (in GMT) as well as other details (e.g., orginal item for second chance, converted start price, etc.).

mixed $ListingDuration (line 136)

Describes the number of days the auction will be active.

mixed $ListingEnhancement (line 141)

Describes the types of enhancment supported for the item's listing.

mixed $ListingType (line 147)

Describes the type of listing for the item a seller has chosen (e.g., Chinese, Dutch, FixedPrice, etc.).

mixed $ListOfAttributeSets (line 29)

Carries one or more instances of the AttributeSet in a list.

mixed $Location (line 152)

Indicates the geographical location of the item.

mixed $PartnerCode (line 157)

Needed for add item only for partners.

mixed $PartnerName (line 162)

Needed for add item only for partners.

mixed $PaymentMethods (line 168)

List of payment methods accepted by a seller from a buyer for a (checkout) transaction.

mixed $PayPalEmailAddress (line 174)

Valid PayPal e-mail address if seller has chosen PayPal as a payment method for the listed item.

mixed $PrimaryCategory (line 179)

Container for data on the primary category of listing.

mixed $PrivateListing (line 184)

Private auction. Not applicable to Fixed Price items.

mixed $Quantity (line 189)

Number of items being sold in the auction.

mixed $RegionID (line 196)

Region where the item is listed. See Region Table for values. If the item is listed with a Region of 0 (zero), then this return field denotes no region association with the item, meaning that it is not listing the item regionally.

mixed $RelistLink (line 206)

If true, creates a link from the old listing for the item to the new relist

page, which accommodates users who might still look for the item under its old item ID. Also adds the relist ID to the old listing's record in the eBay database, which can be returned by calling GetItem for the old ItemId. If your application creates the listing page for the user, you need to add the relist link option to your application for your users.

mixed $ReservePrice (line 215)

Indicates the reserve price for a reserve auction. Returned only if DetailLevel

= 4. ReservePrice is only returned for auctions with a reserve price where the user calling GetItem is the item's seller. Returned as null for International Fixed Price items. For more information on reserve price auctions, see http://pages.ebay.com/help/basics/f-format.html#1.

mixed $ReviseStatus (line 220)

Revise Status contains information about the item being revised.

mixed $ScheduleTime (line 222)
mixed $SecondaryCategory (line 228)

Container for data on the secondary category of listing. Secondary category is optional.

mixed $Seller (line 238)

Seller user.

mixed $SellingStatus (line 244)

Container for for selling status information (e.g., BidCount, BidIncrement, HighBidder, MinimimumToBid, etc).

mixed $ShippingDetails (line 257)

Contains the shipping payment related information for the listed item.

mixed $ShippingOption (line 252)

Specifies where the seller is willing to ship the item. Default "SiteOnly".

Valid values are: SiteOnly (the default) WorldWide SitePlusRegions WillNotShip If SitePlusRegions is selected, then at least one regions argument (ShipToNorthAmerica, ShipToEurope, etc.) must also be set.

mixed $ShippingRegions (line 262)

Regions that seller will ship to.

mixed $ShippingTerms (line 267)

Describes who pays for the delivery of an item (e.g., buyer or seller).

mixed $Site (line 272)

eBay site on which item is listed.

mixed $SiteHostedPicture (line 233)

Item picture information for pictures hosted at eBay site.

mixed $StartPrice (line 278)

Starting price for the item. For Type=7 or Type=9 (Fixed Price) items, if the item price (MinimumBid) is revised, this field returns the new price.

mixed $Storefront (line 285)

Storefront is shown for any item that belongs to an eBay Store owner, regardless of whether it is fixed price or auction type. Not returned for International Fixed Price items.

mixed $SubTitle (line 291)

Subtitle to use in addition to the title. Provides more keywords when buyers search in titles and descriptions.

mixed $TimeLeft (line 297)

Time until the the end of the listing (e.g., the amount of time left in an active auction).

mixed $Title (line 302)

Name of the item as it appears for auctions.

mixed $UUID (line 307)

Universally unique constraint tag. The UUID is unique to a category.

mixed $VATDetails (line 312)

VAT info container.

mixed $VendorHostedPicture (line 317)

Item picture information for pictures hosted at vendor (i.e., remote) site.

#### Inherited Variables

Inherited from XSDType

> XSDType::$_attributes
> XSDType::$_attributeValues
> XSDType::$_elements
> XSDType::$_namespace

Methods
Constructor ItemType (line 319)
ItemType ItemType ()
getApplicationData (line 628)
void getApplicationData ()
getAutoPay (line 646)
void getAutoPay ()
getBuyerProtection (line 655)
void getBuyerProtection ()
getBuyItNowPrice (line 664)
void getBuyItNowPrice ()
getCharity (line 673)
void getCharity ()
getCountry (line 682)
void getCountry ()
getCrossPromotion (line 691)
void getCrossPromotion ()
getCurrency (line 700)
void getCurrency ()
getDescription (line 709)
void getDescription ()
getEscrow (line 718)
void getEscrow ()
getGiftIcon (line 727)
void getGiftIcon ()
getGiftServices (line 736)
void getGiftServices ()
getHitCounter (line 745)
void getHitCounter ()
getItemID (line 754)
void getItemID ()
getListingDesigner (line 772)
void getListingDesigner ()
getListingDetails (line 763)
void getListingDetails ()
getListingDuration (line 781)
void getListingDuration ()
getListingEnhancement (line 790)
void getListingEnhancement ()
getListingType (line 799)
void getListingType ()
getListOfAttributeSets (line 637)
void getListOfAttributeSets ()
getLocation (line 808)
void getLocation ()
getPartnerCode (line 817)
void getPartnerCode ()
getPartnerName (line 826)
void getPartnerName ()
getPaymentMethods (line 835)
void getPaymentMethods ()
getPayPalEmailAddress (line 844)
void getPayPalEmailAddress ()
getPrimaryCategory (line 853)
void getPrimaryCategory ()
getPrivateListing (line 862)
void getPrivateListing ()
getQuantity (line 871)
void getQuantity ()
getRegionID (line 880)
void getRegionID ()
getRelistLink (line 889)
void getRelistLink ()
getReservePrice (line 898)
void getReservePrice ()
getReviseStatus (line 907)
void getReviseStatus ()
getScheduleTime (line 916)
void getScheduleTime ()
getSecondaryCategory (line 925)
void getSecondaryCategory ()
getSeller (line 943)
void getSeller ()
getSellingStatus (line 952)
void getSellingStatus ()
getShippingDetails (line 970)
void getShippingDetails ()
getShippingOption (line 961)
void getShippingOption ()
getShippingRegions (line 979)
void getShippingRegions ()
getShippingTerms (line 988)
void getShippingTerms ()
getSite (line 997)
void getSite ()
getSiteHostedPicture (line 934)
void getSiteHostedPicture ()
getStartPrice (line 1006)
void getStartPrice ()
getStorefront (line 1015)
void getStorefront ()
getSubTitle (line 1024)
void getSubTitle ()
getTimeLeft (line 1033)
void getTimeLeft ()
getTitle (line 1042)
void getTitle ()
getUUID (line 1051)
void getUUID ()
getVATDetails (line 1060)
void getVATDetails ()
getVendorHostedPicture (line 1069)
void getVendorHostedPicture ()
setApplicationData (line 632)
void setApplicationData (mixed $ApplicationData, [mixed $charset = 'iso-8859-1'])
setAutoPay (line 650)
void setAutoPay (mixed $AutoPay, [mixed $charset = 'iso-8859-1'])
setBuyerProtection (line 659)
void setBuyerProtection (mixed $BuyerProtection, [mixed $charset = 'iso-8859-1'])
setBuyItNowPrice (line 668)
void setBuyItNowPrice (mixed $BuyItNowPrice, [mixed $charset = 'iso-8859-1'])
setCharity (line 677)
void setCharity (mixed $Charity, [mixed $charset = 'iso-8859-1'])
setCountry (line 686)
void setCountry (mixed $Country, [mixed $charset = 'iso-8859-1'])
setCrossPromotion (line 695)
void setCrossPromotion (mixed $CrossPromotion, [mixed $charset = 'iso-8859-1'])
setCurrency (line 704)
void setCurrency (mixed $Currency, [mixed $charset = 'iso-8859-1'])
setDescription (line 713)
void setDescription (mixed $Description, [mixed $charset = 'iso-8859-1'])
setEscrow (line 722)
void setEscrow (mixed $Escrow, [mixed $charset = 'iso-8859-1'])
setGiftIcon (line 731)
void setGiftIcon (mixed $GiftIcon, [mixed $charset = 'iso-8859-1'])
setGiftServices (line 740)
void setGiftServices (mixed $GiftServices, [mixed $charset = 'iso-8859-1'])
setHitCounter (line 749)
void setHitCounter (mixed $HitCounter, [mixed $charset = 'iso-8859-1'])
setItemID (line 758)
void setItemID (mixed $ItemID, [mixed $charset = 'iso-8859-1'])
setListingDesigner (line 776)
void setListingDesigner (mixed $ListingDesigner, [mixed $charset = 'iso-8859-1'])
setListingDetails (line 767)
void setListingDetails (mixed $ListingDetails, [mixed $charset = 'iso-8859-1'])
setListingDuration (line 785)
void setListingDuration (mixed $ListingDuration, [mixed $charset = 'iso-8859-1'])
setListingEnhancement (line 794)
void setListingEnhancement (mixed $ListingEnhancement, [mixed $charset = 'iso-8859-1'])
setListingType (line 803)
void setListingType (mixed $ListingType, [mixed $charset = 'iso-8859-1'])
setListOfAttributeSets (line 641)
void setListOfAttributeSets (mixed $ListOfAttributeSets, [mixed $charset = 'iso-8859-1'])
setLocation (line 812)
void setLocation (mixed $Location, [mixed $charset = 'iso-8859-1'])
setPartnerCode (line 821)
void setPartnerCode (mixed $PartnerCode, [mixed $charset = 'iso-8859-1'])
setPartnerName (line 830)
void setPartnerName (mixed $PartnerName, [mixed $charset = 'iso-8859-1'])
setPaymentMethods (line 839)
void setPaymentMethods (mixed $PaymentMethods, [mixed $charset = 'iso-8859-1'])
setPayPalEmailAddress (line 848)
void setPayPalEmailAddress (mixed $PayPalEmailAddress, [mixed $charset = 'iso-8859-1'])
setPrimaryCategory (line 857)
void setPrimaryCategory (mixed $PrimaryCategory, [mixed $charset = 'iso-8859-1'])
setPrivateListing (line 866)
void setPrivateListing (mixed $PrivateListing, [mixed $charset = 'iso-8859-1'])
setQuantity (line 875)
void setQuantity (mixed $Quantity, [mixed $charset = 'iso-8859-1'])
setRegionID (line 884)
void setRegionID (mixed $RegionID, [mixed $charset = 'iso-8859-1'])
setRelistLink (line 893)
void setRelistLink (mixed $RelistLink, [mixed $charset = 'iso-8859-1'])
setReservePrice (line 902)
void setReservePrice (mixed $ReservePrice, [mixed $charset = 'iso-8859-1'])
setReviseStatus (line 911)
void setReviseStatus (mixed $ReviseStatus, [mixed $charset = 'iso-8859-1'])
setScheduleTime (line 920)
void setScheduleTime (mixed $ScheduleTime, [mixed $charset = 'iso-8859-1'])
setSecondaryCategory (line 929)
void setSecondaryCategory (mixed $SecondaryCategory, [mixed $charset = 'iso-8859-1'])
setSeller (line 947)
void setSeller (mixed $Seller, [mixed $charset = 'iso-8859-1'])
setSellingStatus (line 956)
void setSellingStatus (mixed $SellingStatus, [mixed $charset = 'iso-8859-1'])
setShippingDetails (line 974)
void setShippingDetails (mixed $ShippingDetails, [mixed $charset = 'iso-8859-1'])
setShippingOption (line 965)
void setShippingOption (mixed $ShippingOption, [mixed $charset = 'iso-8859-1'])
setShippingRegions (line 983)
void setShippingRegions (mixed $ShippingRegions, [mixed $charset = 'iso-8859-1'])
setShippingTerms (line 992)
void setShippingTerms (mixed $ShippingTerms, [mixed $charset = 'iso-8859-1'])
setSite (line 1001)
void setSite (mixed $Site, [mixed $charset = 'iso-8859-1'])
setSiteHostedPicture (line 938)
void setSiteHostedPicture (mixed $SiteHostedPicture, [mixed $charset = 'iso-8859-1'])
setStartPrice (line 1010)
void setStartPrice (mixed $StartPrice, [mixed $charset = 'iso-8859-1'])
setStorefront (line 1019)
void setStorefront (mixed $Storefront, [mixed $charset = 'iso-8859-1'])
setSubTitle (line 1028)
void setSubTitle (mixed $SubTitle, [mixed $charset = 'iso-8859-1'])
setTimeLeft (line 1037)
void setTimeLeft (mixed $TimeLeft, [mixed $charset = 'iso-8859-1'])
setTitle (line 1046)
void setTitle (mixed $Title, [mixed $charset = 'iso-8859-1'])
setUUID (line 1055)
void setUUID (mixed $UUID, [mixed $charset = 'iso-8859-1'])
setVATDetails (line 1064)
void setVATDetails (mixed $VATDetails, [mixed $charset = 'iso-8859-1'])
setVendorHostedPicture (line 1073)
void setVendorHostedPicture (mixed $VendorHostedPicture, [mixed $charset = 'iso-8859-1'])

#### Inherited Methods

Inherited From XSDType

> XSDType::XSDType()
> XSDType::getattr()
> XSDType::getSoapValue()
> XSDType::setattr()
> XSDType::__set_attribute()

Documentation generated on Thu, 11 May 2006 22:39:15 -0400 by phpDocumentor 1.3.0RC3