File Coverage

blib/lib/eBay/API/XML/DataType/ItemType.pm
Criterion Covered Total %
statement 7 9 77.7
branch n/a
condition n/a
subroutine 3 3 100.0
pod n/a
total 10 12 83.3


line stmt bran cond sub pod time code
1             #!/usr/bin/perl
2              
3             package eBay::API::XML::DataType::ItemType;
4              
5 4     4   79148 use strict;
  4         12  
  4         159  
6 4     4   21 use warnings;
  4         9  
  4         153  
7              
8             ##########################################################################
9             #
10             # Module: ............... eBay/API/XML
11             # File: ................. ItemType.pm
12             # Generated by: ......... genEBayApiDataTypes.pl
13             # Last Generated: ....... 08/24/2008 16:44
14             # API Release Number: ... 579
15             #
16             ##########################################################################
17              
18             =head1 NAME
19              
20             eBay::API::XML::DataType::ItemType
21              
22             =head1 DESCRIPTION
23              
24             Contains the data defining one item. A seller populates an object of
25             this type at listing time with the definition of a new item. A seller
26             also uses an object of this type to re-list or revise an item. Calls
27             that retrieve item data (such as the GetSellerList call) return an object of
28             this type, filled with the item's data. Some fields are applicable both
29             to eBay listings and Half.com listings. Some fields are only applicable to eBay listings,
30             and others are only applicable to Half.com listings.
31              
32              
33              
34             =head1 SYNOPSIS
35              
36             =cut
37              
38              
39             =head1 INHERITANCE
40              
41             eBay::API::XML::DataType::ItemType inherits from the L class
42              
43             =cut
44              
45 4     4   2072 use eBay::API::XML::BaseDataType;
  0            
  0            
46             our @ISA = ("eBay::API::XML::BaseDataType");
47              
48             use eBay::API::XML::DataType::AddressType;
49             use eBay::API::XML::DataType::AmountType;
50             use eBay::API::XML::DataType::AttributeArrayType;
51             use eBay::API::XML::DataType::AttributeSetArrayType;
52             use eBay::API::XML::DataType::BestOfferDetailsType;
53             use eBay::API::XML::DataType::BiddingDetailsType;
54             use eBay::API::XML::DataType::BusinessSellerDetailsType;
55             use eBay::API::XML::DataType::BuyerProtectionDetailsType;
56             use eBay::API::XML::DataType::BuyerRequirementDetailsType;
57             use eBay::API::XML::DataType::CategoryType;
58             use eBay::API::XML::DataType::CharityType;
59             use eBay::API::XML::DataType::CrossPromotionsType;
60             use eBay::API::XML::DataType::DistanceType;
61             use eBay::API::XML::DataType::ExtendedContactDetailsType;
62             use eBay::API::XML::DataType::ExternalProductIDType;
63             use eBay::API::XML::DataType::ItemIDType;
64             use eBay::API::XML::DataType::ItemPolicyViolationType;
65             use eBay::API::XML::DataType::ListingCheckoutRedirectPreferenceType;
66             use eBay::API::XML::DataType::ListingDesignerType;
67             use eBay::API::XML::DataType::ListingDetailsType;
68             use eBay::API::XML::DataType::LiveAuctionDetailsType;
69             use eBay::API::XML::DataType::LookupAttributeArrayType;
70             use eBay::API::XML::DataType::NameValueListArrayType;
71             use eBay::API::XML::DataType::PaymentDetailsType;
72             use eBay::API::XML::DataType::PictureDetailsType;
73             use eBay::API::XML::DataType::ProductListingDetailsType;
74             use eBay::API::XML::DataType::ReviseStatusType;
75             use eBay::API::XML::DataType::SKUType;
76             use eBay::API::XML::DataType::SearchDetailsType;
77             use eBay::API::XML::DataType::SellingStatusType;
78             use eBay::API::XML::DataType::ShippingDetailsType;
79             use eBay::API::XML::DataType::StorefrontType;
80             use eBay::API::XML::DataType::UUIDType;
81             use eBay::API::XML::DataType::UserType;
82             use eBay::API::XML::DataType::VATDetailsType;
83             use eBay::API::XML::DataType::Enum::BuyerPaymentMethodCodeType;
84             use eBay::API::XML::DataType::Enum::BuyerProtectionCodeType;
85             use eBay::API::XML::DataType::Enum::CountryCodeType;
86             use eBay::API::XML::DataType::Enum::CurrencyCodeType;
87             use eBay::API::XML::DataType::Enum::DescriptionReviseModeCodeType;
88             use eBay::API::XML::DataType::Enum::GiftServicesCodeType;
89             use eBay::API::XML::DataType::Enum::HitCounterCodeType;
90             use eBay::API::XML::DataType::Enum::ListingEnhancementsCodeType;
91             use eBay::API::XML::DataType::Enum::ListingSubtypeCodeType;
92             use eBay::API::XML::DataType::Enum::ListingTypeCodeType;
93             use eBay::API::XML::DataType::Enum::SiteCodeType;
94             use eBay::API::XML::DataType::Enum::SkypeContactOptionCodeType;
95              
96              
97             my @gaProperties = ( [ 'ApplicationData', 'xs:string', '', '', '' ]
98             , [ 'ApplyBuyerProtection', 'ns:BuyerProtectionDetailsType', ''
99             ,'eBay::API::XML::DataType::BuyerProtectionDetailsType', '1' ]
100             , [ 'ApplyShippingDiscount', 'xs:boolean', '', '', '' ]
101             , [ 'AttributeArray', 'ns:AttributeArrayType', ''
102             ,'eBay::API::XML::DataType::AttributeArrayType', '1' ]
103             , [ 'AttributeSetArray', 'ns:AttributeSetArrayType', ''
104             ,'eBay::API::XML::DataType::AttributeSetArrayType', '1' ]
105             , [ 'AutoPay', 'xs:boolean', '', '', '' ]
106             , [ 'BestOfferDetails', 'ns:BestOfferDetailsType', ''
107             ,'eBay::API::XML::DataType::BestOfferDetailsType', '1' ]
108             , [ 'BestOfferEnabled', 'xs:boolean', '', '', '' ]
109             , [ 'BidGroupItem', 'xs:boolean', '', '', '' ]
110             , [ 'BiddingDetails', 'ns:BiddingDetailsType', ''
111             ,'eBay::API::XML::DataType::BiddingDetailsType', '1' ]
112             , [ 'BusinessSellerDetails', 'ns:BusinessSellerDetailsType', ''
113             ,'eBay::API::XML::DataType::BusinessSellerDetailsType', '1' ]
114             , [ 'BuyItNowPrice', 'ns:AmountType', ''
115             ,'eBay::API::XML::DataType::AmountType', '1' ]
116             , [ 'BuyerGuaranteePrice', 'ns:AmountType', ''
117             ,'eBay::API::XML::DataType::AmountType', '1' ]
118             , [ 'BuyerProtection', 'ns:BuyerProtectionCodeType', ''
119             ,'eBay::API::XML::DataType::Enum::BuyerProtectionCodeType', '' ]
120             , [ 'BuyerRequirementDetails', 'ns:BuyerRequirementDetailsType', ''
121             ,'eBay::API::XML::DataType::BuyerRequirementDetailsType', '1' ]
122             , [ 'BuyerResponsibleForShipping', 'xs:boolean', '', '', '' ]
123             , [ 'CategoryBasedAttributesPrefill', 'xs:boolean', '', '', '' ]
124             , [ 'CategoryMappingAllowed', 'xs:boolean', '', '', '' ]
125             , [ 'Charity', 'ns:CharityType', ''
126             ,'eBay::API::XML::DataType::CharityType', '1' ]
127             , [ 'ClassifiedAdPayPerLeadFee', 'ns:AmountType', ''
128             ,'eBay::API::XML::DataType::AmountType', '1' ]
129             , [ 'Country', 'ns:CountryCodeType', ''
130             ,'eBay::API::XML::DataType::Enum::CountryCodeType', '' ]
131             , [ 'CrossBorderTrade', 'xs:string', '1', '', '' ]
132             , [ 'CrossPromotion', 'ns:CrossPromotionsType', ''
133             ,'eBay::API::XML::DataType::CrossPromotionsType', '1' ]
134             , [ 'Currency', 'ns:CurrencyCodeType', ''
135             ,'eBay::API::XML::DataType::Enum::CurrencyCodeType', '' ]
136             , [ 'Description', 'xs:string', '', '', '' ]
137             , [ 'DescriptionReviseMode', 'ns:DescriptionReviseModeCodeType', ''
138             ,'eBay::API::XML::DataType::Enum::DescriptionReviseModeCodeType', '' ]
139             , [ 'DisableBuyerRequirements', 'xs:boolean', '', '', '' ]
140             , [ 'DispatchTimeMax', 'xs:int', '', '', '' ]
141             , [ 'Distance', 'ns:DistanceType', ''
142             ,'eBay::API::XML::DataType::DistanceType', '1' ]
143             , [ 'ExtendedSellerContactDetails', 'ns:ExtendedContactDetailsType', ''
144             ,'eBay::API::XML::DataType::ExtendedContactDetailsType', '1' ]
145             , [ 'ExternalProductID', 'ns:ExternalProductIDType', ''
146             ,'eBay::API::XML::DataType::ExternalProductIDType', '1' ]
147             , [ 'FreeAddedCategory', 'ns:CategoryType', ''
148             ,'eBay::API::XML::DataType::CategoryType', '1' ]
149             , [ 'GetItFast', 'xs:boolean', '', '', '' ]
150             , [ 'GiftIcon', 'xs:int', '', '', '' ]
151             , [ 'GiftServices', 'ns:GiftServicesCodeType', '1'
152             ,'eBay::API::XML::DataType::Enum::GiftServicesCodeType', '' ]
153             , [ 'GroupCategoryID', 'xs:string', '', '', '' ]
154             , [ 'HitCount', 'xs:long', '', '', '' ]
155             , [ 'HitCounter', 'ns:HitCounterCodeType', ''
156             ,'eBay::API::XML::DataType::Enum::HitCounterCodeType', '' ]
157             , [ 'ItemID', 'ns:ItemIDType', ''
158             ,'eBay::API::XML::DataType::ItemIDType', '1' ]
159             , [ 'ItemPolicyViolation', 'ns:ItemPolicyViolationType', ''
160             ,'eBay::API::XML::DataType::ItemPolicyViolationType', '1' ]
161             , [ 'ItemSpecifics', 'ns:NameValueListArrayType', ''
162             ,'eBay::API::XML::DataType::NameValueListArrayType', '1' ]
163             , [ 'LeadCount', 'xs:int', '', '', '' ]
164             , [ 'LimitedWarrantyEligible', 'xs:boolean', '', '', '' ]
165             , [ 'ListingCheckoutRedirectPreference', 'ns:ListingCheckoutRedirectPreferenceType', ''
166             ,'eBay::API::XML::DataType::ListingCheckoutRedirectPreferenceType', '1' ]
167             , [ 'ListingDesigner', 'ns:ListingDesignerType', ''
168             ,'eBay::API::XML::DataType::ListingDesignerType', '1' ]
169             , [ 'ListingDetails', 'ns:ListingDetailsType', ''
170             ,'eBay::API::XML::DataType::ListingDetailsType', '1' ]
171             , [ 'ListingDuration', 'xs:token', '', '', '' ]
172             , [ 'ListingEnhancement', 'ns:ListingEnhancementsCodeType', '1'
173             ,'eBay::API::XML::DataType::Enum::ListingEnhancementsCodeType', '' ]
174             , [ 'ListingSubtype2', 'ns:ListingSubtypeCodeType', ''
175             ,'eBay::API::XML::DataType::Enum::ListingSubtypeCodeType', '' ]
176             , [ 'ListingType', 'ns:ListingTypeCodeType', ''
177             ,'eBay::API::XML::DataType::Enum::ListingTypeCodeType', '' ]
178             , [ 'LiveAuctionDetails', 'ns:LiveAuctionDetailsType', ''
179             ,'eBay::API::XML::DataType::LiveAuctionDetailsType', '1' ]
180             , [ 'LocalListing', 'xs:boolean', '', '', '' ]
181             , [ 'Location', 'xs:string', '', '', '' ]
182             , [ 'LocationDefaulted', 'xs:boolean', '', '', '' ]
183             , [ 'LookupAttributeArray', 'ns:LookupAttributeArrayType', ''
184             ,'eBay::API::XML::DataType::LookupAttributeArrayType', '1' ]
185             , [ 'LotSize', 'xs:int', '', '', '' ]
186             , [ 'MechanicalCheckAccepted', 'xs:boolean', '', '', '' ]
187             , [ 'MotorsGermanySearchable', 'xs:boolean', '', '', '' ]
188             , [ 'NewLeadCount', 'xs:int', '', '', '' ]
189             , [ 'NowAndNew', 'xs:boolean', '', '', '' ]
190             , [ 'PartnerCode', 'xs:string', '', '', '' ]
191             , [ 'PartnerName', 'xs:string', '', '', '' ]
192             , [ 'PayPalEmailAddress', 'xs:string', '', '', '' ]
193             , [ 'PaymentDetails', 'ns:PaymentDetailsType', ''
194             ,'eBay::API::XML::DataType::PaymentDetailsType', '1' ]
195             , [ 'PaymentMethods', 'ns:BuyerPaymentMethodCodeType', '1'
196             ,'eBay::API::XML::DataType::Enum::BuyerPaymentMethodCodeType', '' ]
197             , [ 'PictureDetails', 'ns:PictureDetailsType', ''
198             ,'eBay::API::XML::DataType::PictureDetailsType', '1' ]
199             , [ 'PostalCode', 'xs:string', '', '', '' ]
200             , [ 'PrimaryCategory', 'ns:CategoryType', ''
201             ,'eBay::API::XML::DataType::CategoryType', '1' ]
202             , [ 'PrivateListing', 'xs:boolean', '', '', '' ]
203             , [ 'PrivateNotes', 'xs:string', '', '', '' ]
204             , [ 'ProductListingDetails', 'ns:ProductListingDetailsType', ''
205             ,'eBay::API::XML::DataType::ProductListingDetailsType', '1' ]
206             , [ 'ProxyItem', 'xs:boolean', '', '', '' ]
207             , [ 'Quantity', 'xs:int', '', '', '' ]
208             , [ 'QuantityAvailable', 'xs:int', '', '', '' ]
209             , [ 'QuestionCount', 'xs:long', '', '', '' ]
210             , [ 'RegionID', 'xs:string', '', '', '' ]
211             , [ 'RelistLink', 'xs:boolean', '', '', '' ]
212             , [ 'Relisted', 'xs:boolean', '', '', '' ]
213             , [ 'ReservePrice', 'ns:AmountType', ''
214             ,'eBay::API::XML::DataType::AmountType', '1' ]
215             , [ 'ReviseStatus', 'ns:ReviseStatusType', ''
216             ,'eBay::API::XML::DataType::ReviseStatusType', '1' ]
217             , [ 'SKU', 'ns:SKUType', ''
218             ,'eBay::API::XML::DataType::SKUType', '1' ]
219             , [ 'ScheduleTime', 'xs:dateTime', '', '', '' ]
220             , [ 'SearchDetails', 'ns:SearchDetailsType', ''
221             ,'eBay::API::XML::DataType::SearchDetailsType', '1' ]
222             , [ 'SecondaryCategory', 'ns:CategoryType', ''
223             ,'eBay::API::XML::DataType::CategoryType', '1' ]
224             , [ 'Seller', 'ns:UserType', ''
225             ,'eBay::API::XML::DataType::UserType', '1' ]
226             , [ 'SellerContactDetails', 'ns:AddressType', ''
227             ,'eBay::API::XML::DataType::AddressType', '1' ]
228             , [ 'SellerInventoryID', 'xs:string', '', '', '' ]
229             , [ 'SellerVacationNote', 'xs:string', '', '', '' ]
230             , [ 'SellingStatus', 'ns:SellingStatusType', ''
231             ,'eBay::API::XML::DataType::SellingStatusType', '1' ]
232             , [ 'ShipToLocations', 'xs:string', '1', '', '' ]
233             , [ 'ShippingDetails', 'ns:ShippingDetailsType', ''
234             ,'eBay::API::XML::DataType::ShippingDetailsType', '1' ]
235             , [ 'ShippingTermsInDescription', 'xs:boolean', '', '', '' ]
236             , [ 'Site', 'ns:SiteCodeType', ''
237             ,'eBay::API::XML::DataType::Enum::SiteCodeType', '' ]
238             , [ 'SkypeContactOption', 'ns:SkypeContactOptionCodeType', '1'
239             ,'eBay::API::XML::DataType::Enum::SkypeContactOptionCodeType', '' ]
240             , [ 'SkypeEnabled', 'xs:boolean', '', '', '' ]
241             , [ 'SkypeID', 'xs:string', '', '', '' ]
242             , [ 'StartPrice', 'ns:AmountType', ''
243             ,'eBay::API::XML::DataType::AmountType', '1' ]
244             , [ 'Storefront', 'ns:StorefrontType', ''
245             ,'eBay::API::XML::DataType::StorefrontType', '1' ]
246             , [ 'SubTitle', 'xs:string', '', '', '' ]
247             , [ 'ThirdPartyCheckout', 'xs:boolean', '', '', '' ]
248             , [ 'ThirdPartyCheckoutIntegration', 'xs:boolean', '', '', '' ]
249             , [ 'TimeLeft', 'xs:duration', '', '', '' ]
250             , [ 'Title', 'xs:string', '', '', '' ]
251             , [ 'TotalQuestionCount', 'xs:long', '', '', '' ]
252             , [ 'UUID', 'ns:UUIDType', ''
253             ,'eBay::API::XML::DataType::UUIDType', '1' ]
254             , [ 'UpdateReturnPolicy', 'xs:boolean', '', '', '' ]
255             , [ 'UpdateSellerInfo', 'xs:boolean', '', '', '' ]
256             , [ 'UseTaxTable', 'xs:boolean', '', '', '' ]
257             , [ 'VATDetails', 'ns:VATDetailsType', ''
258             ,'eBay::API::XML::DataType::VATDetailsType', '1' ]
259             , [ 'WatchCount', 'xs:long', '', '', '' ]
260             , [ 'eBayNotes', 'xs:string', '', '', '' ]
261             );
262             push @gaProperties, @{eBay::API::XML::BaseDataType::getPropertiesList()};
263              
264             my @gaAttributes = (
265             );
266             push @gaAttributes, @{eBay::API::XML::BaseDataType::getAttributesList()};
267              
268             =head1 Subroutines:
269              
270             =cut
271              
272             sub new {
273             my $classname = shift;
274             my %args = @_;
275             my $self = $classname->SUPER::new(%args);
276             return $self;
277             }
278              
279             sub isScalar {
280             return 0;
281             }
282              
283              
284              
285             =head2 setApplicationData()
286              
287             Returns custom, application-specific data associated with the item.
288             The data you specify is stored by eBay with the item for your own reference,
289             but it is not used by eBay in any way. Use ApplicationData to store
290             special information for yourself, such as a part number.
291             For a SKU in an eBay.com listing, use the SKU element instead.
292             To remove this value when revising or relisting an item, use DeletedField.
293             ApplicationData is not applicable to Half.com. For Half.com listings,
294             use SellerInventoryID instead.
295              
296             ExcludeFromDefaultAreas: half
297             MaxLength: 32
298              
299             Calls: AddItem
300             GetItemRecommendations
301             RelistItem
302             ReviseItem
303             VerifyAddItem
304             RequiredInput: No
305              
306             # Argument: 'xs:string'
307              
308             =cut
309              
310             sub setApplicationData {
311             my $self = shift;
312             $self->{'ApplicationData'} = shift
313             }
314              
315             =head2 getApplicationData()
316              
317             Calls: GetSellerList
318             Returned: Conditionally
319             Details: DetailLevel: ItemReturnDescription, ReturnAll
320             GranularityLevel: Coarse, Medium, Fine
321              
322              
323             Calls: GetBidderList
324             Returned: Conditionally
325              
326             Calls: GetItem
327             Returned: Conditionally
328             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
329              
330             Calls: GetItemTransactions
331             GetSellerTransactions
332             Returned: Conditionally
333             Details: DetailLevel: none, ItemReturnDescription, ReturnAll
334              
335             Calls: GetOrderTransactions
336             Returned: Conditionally
337             Details: DetailLevel: none, ItemReturnDescription, ReturnAll
338              
339             # Returns: 'xs:string'
340              
341             =cut
342              
343             sub getApplicationData {
344             my $self = shift;
345             return $self->{'ApplicationData'};
346             }
347              
348              
349             =head2 setApplyBuyerProtection()
350              
351             Different Buyer protection schemes and the various status associated with each one of them.
352              
353             # Argument: 'ns:BuyerProtectionDetailsType'
354              
355             =cut
356              
357             sub setApplyBuyerProtection {
358             my $self = shift;
359             $self->{'ApplyBuyerProtection'} = shift
360             }
361              
362             =head2 getApplyBuyerProtection()
363              
364             Calls: GetItem
365             Returned: Conditionally
366              
367             # Returns: 'ns:BuyerProtectionDetailsType'
368              
369             =cut
370              
371             sub getApplyBuyerProtection {
372             my $self = shift;
373             return $self->_getDataTypeInstance( 'ApplyBuyerProtection'
374             ,'eBay::API::XML::DataType::BuyerProtectionDetailsType');
375             }
376              
377              
378             =head2 setApplyShippingDiscount()
379              
380             Multiple Item Shipping Discount. Seller specifies as input when listing,
381             re-listing, or revising an item to indicate whether a shipping discount is to
382             be applied when the buyer pays for the item in the checkout process and the
383             item's transaction is combined with other transactions into an order. Returned
384             with retrieved item data, indicating a shipping discount is applicable.
385            
386             Not returned by GetItem (see Item.ShippingDetails.ShippingDiscount instead).
387            
388             Not applicable to Half.com.
389              
390             Calls: AddItem
391             GetItemRecommendations
392             RelistItem
393             ReviseItem
394             VerifyAddItem
395             RequiredInput: No
396              
397             # Argument: 'xs:boolean'
398              
399             =cut
400              
401             sub setApplyShippingDiscount {
402             my $self = shift;
403             $self->{'ApplyShippingDiscount'} = shift
404             }
405              
406             =head2 isApplyShippingDiscount()
407              
408             Calls: GetBidderList
409             Returned: Conditionally
410              
411             Calls: GetSellerTransactions
412             Returned: Conditionally
413             Details: DetailLevel: none, ItemReturnDescription, ReturnAll
414              
415             # Returns: 'xs:boolean'
416              
417             =cut
418              
419             sub isApplyShippingDiscount {
420             my $self = shift;
421             return $self->{'ApplyShippingDiscount'};
422             }
423              
424              
425             =head2 setAttributeArray()
426              
427             Used to specify the item condition in AddItem.
428             Only applicable to Half.com (not eBay listings).
429             You can revise this property for Half.com listings.
430             For Half.com, AddItem does not use the same Attributes format as eBay's
431             Item Specifics.
432            
433             Not returned in GetItem. See AttributeSetArray instead.
434              
435             SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=HalfOverview
436             Title: Half.com
437             , URL: GetItem.html#Response.Item.AttributeSetArray
438             Title: (GetItem) Item.AttributeSetArray
439              
440              
441             Calls: AddItem
442             VerifyAddItem
443             RequiredInput: Yes
444              
445             Calls: ReviseItem
446             RequiredInput: No
447              
448             # Argument: 'ns:AttributeArrayType'
449              
450             =cut
451              
452             sub setAttributeArray {
453             my $self = shift;
454             $self->{'AttributeArray'} = shift
455             }
456              
457             =head2 getAttributeArray()
458              
459             Calls: GetOrders
460             Returned: Always
461             Details: DetailLevel: none
462              
463             # Returns: 'ns:AttributeArrayType'
464              
465             =cut
466              
467             sub getAttributeArray {
468             my $self = shift;
469             return $self->_getDataTypeInstance( 'AttributeArray'
470             ,'eBay::API::XML::DataType::AttributeArrayType');
471             }
472              
473              
474             =head2 setAttributeSetArray()
475              
476             Item Specifics (such as new or used condition) in a listing.
477             Item Specifics (attributes) describe category-specific aspects or
478             features of an item in a standardized way.
479             Carries one or more instances of AttributeSet in a list.
480             For ID-based attributes in general, an item will be associated with no more
481             than two full attribute sets (one for the primary category and one for
482             the secondary category). For some international sites, an item can
483             specify additional site-wide attribute sets.
484            
485             Please note that AttributeSetArray does not support the new
486             "custom Item Specifics" model. See the ItemSpecifics node instead.
487            
488             For the AddItem family of calls: Some categories
489             (such as Event Tickets and US Real Estate) require Item Specifics.
490             See the eBay Web Services Guide links below for information on
491             working with Item Specifics. Use GetCategory2CS and GetAttributesCS
492             to determine when attributes are required for a category.
493             Also use attributes to specify the item condition and/or
494             return policy.
495            
496             For a listing to be eligible for eBay Express, the item condition is
497             required in most cases. Use GetCategoryFeatures to determine which
498             categories are exempt from this requirement.
499             See the eBay Web Services Guide links below for details.
500            
501             For ReviseItem only: When you revise a listing, if the
502             listing has bids and ends within 12 hours, you cannot change or add
503             attributes. If the listing has bids but ends in more
504             than 12 hours, you cannot change existing attribute data, but you can add
505             attributes that were not previously specified. The most reliable way to do this is
506             to pass in the entire AttributeSetArray with all the attributes you want
507             in the listing (not just the ones you want to change, because that usually
508             causes the others to be removed). To delete all attributes when
509             you revise or relist, specify Item.AttributeSetArray in DeletedField and don't
510             pass AttributeSetArray in the request. If the original listing's attributes
511             are no longer valid and you get errors when you try to revise the listing,
512             you can try to pass in the entire AttributeSetArray again with corrections.
513             If that doesn't work, you can end the item and relist it with a
514             set of valid attributes.
515            
516             For AddLiveAuctionItem and ReviseLiveAuctionItem
517             only:
518             For AddLiveAuctionItem and ReviseLiveAuctionItem, specify a maximum
519             of one AttributeSet for Item Specifics that are associated with
520             SecondaryCategory (a US eBay site category), plus any number of
521             additional AttributeSet properties for site-wide attributes that are
522             applicable to the US eBay site.
523            
524             For GetCategoryListings only: For GetCategoryListings,
525             AttributeSetArray can return the item condition
526             (not other Item Specifics), if specified.
527            
528             For GetSearchResults only:
529             GetSearchResults can return the item condition when the request either
530             specifies IncludeCondition as true; or specifies a
531             product finder search (and a detail level of ItemReturnAttributes
532             or ReturnAll). If IncludeCondition was true, see the ItemSpecific node
533             for a simpler view of the condition value.
534             Note:
535             AttributeSetArray only returns the condition attribute's ValueID.
536             You would need to use GetAttributesCS to figure out the meaning of this ID.
537             It's easier to just look at the ItemSpecific node.
538            
539             If SearchRequest or TicketFinder was used to perform a
540             product finder search, the list of attributes is limited to
541             Item Specifics that would be included in the
542             summary search results on the Web site, if any.
543             At this time, GetSearchResults only returns event ticket
544             venue name, section, and row (if specified) for eBay US (site 0);
545             and the mileage and year for eBay Motors vehicles (site 100 and
546             international eBay Motors sites that support this feature).
547             In other categories, no summary attributes are returned in
548             search results (even when the item is
549             listed with Item Specifics.)
550            
551             For GetItemRecommendations only:
552             In GetItemRecommendations, if you use the Suggested Attributes engine,
553             the engine interprets attributes you pass in as attributes that
554             do NOT need recommendations (i.e., attributes that the seller has
555             already filled in as desired). The engine only returns
556             recommendations for attributes that you do not specify, and only for
557             attributes associated with the primary category.
558            
559             For Half.com, this is only returned in GetItem. It is not applicable in
560             AddItem and other requests.
561              
562             SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrOverview
563             Title: Working with Attribute-Based Features
564             , URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ItemCondition
565             Title: Specifying an Item's Condition
566             , URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ReturnPolicy
567             Title: Offering a Clear Return Policy
568             , URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ExpressConditionRequired
569             Title: Specify the Item Condition for Express and eBay
570             , URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=LiveAuctions
571             Title: eBay Live Auctions
572             , URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrRevise
573             Title: Revising Items that Include Item Specifics (Attributes)
574             , URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrRelist
575             Title: Relisting Items that Include Item Specifics (Attributes)
576              
577              
578             Calls: AddItem
579             GetItemRecommendations
580             RelistItem
581             AddLiveAuctionItem
582             VerifyAddItem
583             RequiredInput: Conditionally
584              
585             Calls: GetItemRecommendations
586             RelistItem
587             ReviseItem
588             ReviseLiveAuctionItem
589             RequiredInput: No
590              
591             # Argument: 'ns:AttributeSetArrayType'
592              
593             =cut
594              
595             sub setAttributeSetArray {
596             my $self = shift;
597             $self->{'AttributeSetArray'} = shift
598             }
599              
600             =head2 getAttributeSetArray()
601              
602             Calls: GetCategoryListings
603             Returned: Conditionally
604              
605             Calls: GetItem
606             Returned: Conditionally
607             Details: DetailLevel: ItemReturnAttributes, ReturnAll
608              
609             Calls: GetSearchResults
610             Returned: Conditionally
611             Details: DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll
612             GranularityLevel: Coarse
613              
614              
615             # Returns: 'ns:AttributeSetArrayType'
616              
617             =cut
618              
619             sub getAttributeSetArray {
620             my $self = shift;
621             return $self->_getDataTypeInstance( 'AttributeSetArray'
622             ,'eBay::API::XML::DataType::AttributeSetArrayType');
623             }
624              
625              
626             =head2 setAutoPay()
627              
628             If true, the seller requests immediate payment for the item.
629             If false or not specified, immediate payment is not requested.
630             (In responses, does not indicate whether the item is actually still a
631             candidate for purchase via immediate payment.)
632            
633             Only applicable to items listed on PayPal-enabled sites
634             in categories that support immediate payment (see AutoPayEnabled in
635             GetCategories), when seller has a Premier or Business PayPal account (see
636             PayPalAccountType in Getuser). If true, the seller must also accept PayPal as
637             a payment method for the item (see Item.PaymentMethods).
638            
639             Not supported if ThirdPartyCheckout is true.
640            
641             See the eBay Web
642             Services guide section on Immediate Payment for additional
643             requirements and dependencies. Also see the section on working with the
644             eBay Motors site for additional rules. Not applicable to Half.com.
645              
646             SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AutoPay
647             Title: Requiring Immediate Payment
648             , URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=MotorsAutoPay
649             Title: Requiring Immediate Payment of a Vehicle Deposit
650              
651              
652             Calls: AddItem
653             GetItemRecommendations
654             RelistItem
655             ReviseItem
656             VerifyAddItem
657             RequiredInput: Conditionally
658             Default: false
659              
660             # Argument: 'xs:boolean'
661              
662             =cut
663              
664             sub setAutoPay {
665             my $self = shift;
666             $self->{'AutoPay'} = shift
667             }
668              
669             =head2 isAutoPay()
670              
671             Calls: GetBidderList
672             Returned: Always
673              
674             Calls: GetItem
675             Returned: Always
676             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
677              
678             Calls: GetItemTransactions
679             GetSellerTransactions
680             Returned: Always
681             Details: DetailLevel: none, ItemReturnDescription, ReturnAll
682              
683             Calls: GetOrderTransactions
684             Returned: Always
685             Details: DetailLevel: none, ItemReturnDescription, ReturnAll
686              
687             Calls: GetSellerList
688             Returned: Conditionally
689             Details: DetailLevel: ItemReturnDescription, ReturnAll
690             GranularityLevel: Coarse, Medium, Fine
691              
692              
693             # Returns: 'xs:boolean'
694              
695             =cut
696              
697             sub isAutoPay {
698             my $self = shift;
699             return $self->{'AutoPay'};
700             }
701              
702              
703             =head2 setBestOfferDetails()
704              
705             Container for BestOffer properties associated with the item.
706             Not applicable to Half.com.
707              
708             Calls: AddItem
709             GetItemRecommendations
710             RelistItem
711             ReviseItem
712             VerifyAddItem
713             RequiredInput: No
714              
715             # Argument: 'ns:BestOfferDetailsType'
716              
717             =cut
718              
719             sub setBestOfferDetails {
720             my $self = shift;
721             $self->{'BestOfferDetails'} = shift
722             }
723              
724             =head2 getBestOfferDetails()
725              
726             Calls: GetBidderList
727             Returned: Conditionally
728              
729             Calls: GetItem
730             Returned: Conditionally
731             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
732              
733             Calls: GetSellerEvents
734             Returned: Conditionally
735             Details: DetailLevel: none, ReturnAll
736              
737             Calls: GetMyeBayBuying
738             Returned: Conditionally
739             Details: DetailLevel: none, ReturnSummary, ReturnAll
740             Context: BestOfferList
741              
742             # Returns: 'ns:BestOfferDetailsType'
743              
744             =cut
745              
746             sub getBestOfferDetails {
747             my $self = shift;
748             return $self->_getDataTypeInstance( 'BestOfferDetails'
749             ,'eBay::API::XML::DataType::BestOfferDetailsType');
750             }
751              
752              
753             =head2 setBestOfferEnabled()
754              
755             Indicates, when true, that an item is available by Best Offer.
756              
757             # Argument: 'xs:boolean'
758              
759             =cut
760              
761             sub setBestOfferEnabled {
762             my $self = shift;
763             $self->{'BestOfferEnabled'} = shift
764             }
765              
766             =head2 isBestOfferEnabled()
767              
768             Calls: GetSearchResults
769             Returned: Conditionally
770             Details: DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll
771              
772             Calls: GetCategoryListings
773             Returned: Conditionally
774              
775             # Returns: 'xs:boolean'
776              
777             =cut
778              
779             sub isBestOfferEnabled {
780             my $self = shift;
781             return $self->{'BestOfferEnabled'};
782             }
783              
784              
785             =head2 setBidGroupItem()
786              
787             This flag is set to true if a watched item belongs to a bid
788             group. It will only be returned for the Watch container.
789              
790             Calls: GetMyeBayBuying
791             RequiredInput: No
792             Returned: Conditionally
793              
794             # Argument: 'xs:boolean'
795              
796             =cut
797              
798             sub setBidGroupItem {
799             my $self = shift;
800             $self->{'BidGroupItem'} = shift
801             }
802              
803             =head2 isBidGroupItem()
804              
805             Calls: GetMyeBayBuying
806             RequiredInput: No
807             Returned: Conditionally
808              
809             # Returns: 'xs:boolean'
810              
811             =cut
812              
813             sub isBidGroupItem {
814             my $self = shift;
815             return $self->{'BidGroupItem'};
816             }
817              
818              
819             =head2 setBiddingDetails()
820              
821             Detailed information about a bid. For GetMyeBayBuying,
822             returned as a self-closed element if no bids meet the
823             request criteria. Not applicable to Half.com.
824              
825             # Argument: 'ns:BiddingDetailsType'
826              
827             =cut
828              
829             sub setBiddingDetails {
830             my $self = shift;
831             $self->{'BiddingDetails'} = shift
832             }
833              
834             =head2 getBiddingDetails()
835              
836             Calls: GetMyeBayBuying
837             Returned: Conditionally
838             Details: DetailLevel: none, ReturnSummary, ReturnAll
839             Context: BidList
840             LostList
841             WonList
842             DeletedFromWonList
843             DeletedFromLostList
844              
845             Calls: GetMyeBaySelling
846             Returned: Conditionally
847             Details: DetailLevel: none, ReturnSummary, ReturnAll
848             Context: BidList
849              
850             # Returns: 'ns:BiddingDetailsType'
851              
852             =cut
853              
854             sub getBiddingDetails {
855             my $self = shift;
856             return $self->_getDataTypeInstance( 'BiddingDetails'
857             ,'eBay::API::XML::DataType::BiddingDetailsType');
858             }
859              
860              
861             =head2 setBusinessSellerDetails()
862              
863             Returns the seller's information (in a business card format)
864             if the seller's SellerBusinessCodeType is set to 'Commercial'.
865             This is only applicable for sites where Business Seller options
866             are supported.
867              
868             # Argument: 'ns:BusinessSellerDetailsType'
869              
870             =cut
871              
872             sub setBusinessSellerDetails {
873             my $self = shift;
874             $self->{'BusinessSellerDetails'} = shift
875             }
876              
877             =head2 getBusinessSellerDetails()
878              
879             Calls: GetItem
880             Returned: Conditionally
881             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
882              
883             # Returns: 'ns:BusinessSellerDetailsType'
884              
885             =cut
886              
887             sub getBusinessSellerDetails {
888             my $self = shift;
889             return $self->_getDataTypeInstance( 'BusinessSellerDetails'
890             ,'eBay::API::XML::DataType::BusinessSellerDetailsType');
891             }
892              
893              
894             =head2 setBuyItNowPrice()
895              
896             For Chinese auction listings, Buy It Now allows a user to purchase the item at
897             a fixed price and end the auction immediately. Use this field to add Buy It
898             Now and specify the amount a buyer would need to bid to take advantage of the
899             Buy It Now feature.
900            

901             On the main eBay site, not applicable to fixed-price items
902             (ListingType values StoresFixedPrice or FixedPriceItem), AdFormat
903             listings, or Half.com listings. For fixed-price and Half.com listings, see
904             StartPrice instead. See the eBay Web Services Guide for validation rules when
905             revising US eBay Motors listings, including rules for lowering the Buy It Now
906             price of a Motors listing.
907            

908             Once a Chinese auction has bids (and the high bid exceeds the reserve price, if any),
909             the listing is no longer eligible for Buy It Now (with some exceptions noted below).
910             However, calls like GetItem and GetSearchResults still return the BuyItNowPrice that
911             the seller originally set for the listing. You can use Item.SellingStatus.BidCount to
912             determine whether an auction with Buy It Now has bids or not. With
913             GetSearchResults, you can use the Item.SearchDetails.BuyItNowEnabled flag
914             to determine whether the item can still be purchased using Buy It Now. With GetItem,
915             you can use the Item.ListingDetails.BuyItNowAvailable flag to determine
916             whether the item can still be purchased using Buy It Now.
917            

918             On some sites, the Buy It Now price for a Chinese auction may remain available
919             for certain categories even after a bid is placed.
920             See the "Longer Lasting Buy It Now" link below for more details and the
921             latest list of eBay US categories that support this behavior.
922             The eBay Spain site supports this behavior for all categories.
923            

924             For a listing to be eligible for Express, the max Buy It Now Price
925             is USD 10,000.00 for the US.
926             (Additional price limits may be imposed by the seller's PayPal account
927             or the payment method used. Such limits cannot be determined via the
928             eBay API and are not covered in eBay's API
929             documentation, as they may vary for each user.)
930            

931             To remove this value when revising or relisting an item, use DeletedField.
932              
933             SeeLink: URL: http://forums.ebay.com/db1/thread.jspa?threadID=2000449591&anticache=1207252776668
934             Title: Longer Lasting Buy It Now
935             , URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ExpressPrice
936             Title: Specify a Fixed Price for Express and eBay
937             , URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ReviseMotors
938             Title: Revising US eBay Motors Listings
939              
940             MaxLength: 16
941              
942             Calls: AddItem
943             GetItemRecommendations
944             RelistItem
945             ReviseItem
946             VerifyAddItem
947             RequiredInput: No
948              
949             # Argument: 'ns:AmountType'
950              
951             =cut
952              
953             sub setBuyItNowPrice {
954             my $self = shift;
955             $self->{'BuyItNowPrice'} = shift
956             }
957              
958             =head2 getBuyItNowPrice()
959              
960             Calls: GetBestOffers
961             Returned: Conditionally
962             Details: DetailLevel: none, ReturnAll
963              
964             Calls: GetCategoryListings
965             GetProducts
966             Returned: Conditionally
967              
968             Calls: GetSearchResults
969             Returned: Conditionally
970             Details: DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll
971             GranularityLevel: Coarse
972              
973              
974             Calls: GetSellerList
975             Returned: Conditionally
976             Details: DetailLevel: ItemReturnDescription, ReturnAll
977             GranularityLevel: Medium, Fine
978              
979              
980             Calls: GetItemTransactions
981             GetSellerTransactions
982             Returned: Conditionally
983             Details: DetailLevel: ReturnAll
984              
985             Calls: GetOrderTransactions
986             Returned: Conditionally
987             Details: DetailLevel: none, ItemReturnDescription, ReturnAll
988              
989             Calls: GetMyeBayBuying
990             Returned: Conditionally
991             Details: DetailLevel: none, ReturnSummary, ReturnAll
992             Context: WatchList
993              
994             Calls: GetMyeBaySelling
995             Returned: Conditionally
996             Details: DetailLevel: none, ReturnSummary, ReturnAll
997             Context: ActiveList
998             ScheduledList
999             SoldList
1000             UnsoldList
1001             DeletedFromSoldList
1002             DeletedFromUnsoldList
1003              
1004             Calls: GetBidderList
1005             Returned: Always
1006              
1007             Calls: GetItem
1008             Returned: Always
1009             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
1010              
1011             Calls: GetSellerEvents
1012             Returned: Conditionally
1013             Details: DetailLevel: ReturnAll
1014              
1015             # Returns: 'ns:AmountType'
1016              
1017             =cut
1018              
1019             sub getBuyItNowPrice {
1020             my $self = shift;
1021             return $self->_getDataTypeInstance( 'BuyItNowPrice'
1022             ,'eBay::API::XML::DataType::AmountType');
1023             }
1024              
1025              
1026             =head2 setBuyerGuaranteePrice()
1027              
1028             For the Australia site, BuyerGuaranteePrice is the PayPal Buyer Protection coverage,
1029             offered for the item at the time of purchase.
1030             Details of coverage are in the following sections
1031             of the View Item page: the Buy Safely section and the Payment Details section.
1032              
1033             # Argument: 'ns:AmountType'
1034              
1035             =cut
1036              
1037             sub setBuyerGuaranteePrice {
1038             my $self = shift;
1039             $self->{'BuyerGuaranteePrice'} = shift
1040             }
1041              
1042             =head2 getBuyerGuaranteePrice()
1043              
1044             Calls: GetSellerList
1045             Returned: Conditionally
1046             Details: DetailLevel: ItemReturnDescription, ReturnAll
1047             GranularityLevel: Coarse, Medium, Fine
1048              
1049              
1050             Calls: GetBidderList
1051             Returned: Conditionally
1052              
1053             Calls: GetItem
1054             Returned: Conditionally
1055             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
1056              
1057             Calls: GetSearchResults
1058             Returned: Conditionally
1059             Details: DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll
1060             GranularityLevel: Coarse
1061              
1062              
1063             # Returns: 'ns:AmountType'
1064              
1065             =cut
1066              
1067             sub getBuyerGuaranteePrice {
1068             my $self = shift;
1069             return $self->_getDataTypeInstance( 'BuyerGuaranteePrice'
1070             ,'eBay::API::XML::DataType::AmountType');
1071             }
1072              
1073              
1074             =head2 setBuyerProtection()
1075              
1076             Indicates the status of the item's eligibility for the PayPal Buyer Protection
1077             program. Not applicable to Half.com.
1078              
1079             SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=MiscellaneousItemFieldDifferences
1080             Title: Miscellaneous Item Field Differences
1081              
1082             # Argument: 'ns:BuyerProtectionCodeType'
1083              
1084             =cut
1085              
1086             sub setBuyerProtection {
1087             my $self = shift;
1088             $self->{'BuyerProtection'} = shift
1089             }
1090              
1091             =head2 getBuyerProtection()
1092              
1093             Calls: GetSearchResults
1094             Returned: Conditionally
1095             Details: DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll
1096              
1097             Calls: GetSellerList
1098             Returned: Conditionally
1099             Details: DetailLevel: ItemReturnDescription, ReturnAll
1100             GranularityLevel: Coarse, Medium, Fine
1101              
1102              
1103             Calls: GetItem
1104             Returned: Always
1105             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
1106              
1107             Calls: GetBidderList
1108             Returned: Always
1109              
1110             Calls: GetItemTransactions
1111             GetSellerTransactions
1112             Returned: Always
1113             Details: DetailLevel: none, ItemReturnDescription, ReturnAll
1114              
1115             Calls: GetOrderTransactions
1116             Returned: Always
1117             Details: DetailLevel: none, ItemReturnDescription, ReturnAll
1118              
1119             # Returns: 'ns:BuyerProtectionCodeType'
1120              
1121             =cut
1122              
1123             sub getBuyerProtection {
1124             my $self = shift;
1125             return $self->{'BuyerProtection'};
1126             }
1127              
1128              
1129             =head2 setBuyerRequirementDetails()
1130              
1131             New Container for buyer requirements. The old container, BuyerRequirements, has been deprecated. All global MyeBay Buyer Requirements are
1132             over-ridden by the contents of this container. This means that buyer
1133             requirements set in MyeBay cannot be combined with buyer requirements included
1134             in this container. When this container is present in an AddItem call, all
1135             buyer requirements for the resulting listing are set by this container.
1136             Furthermore, individual buyer requirements cannot be modified or added when
1137             including this container in a ReviseItem call. The ReviseItem call needs to
1138             provide the entire set of buyer requirements to modify or add any of the
1139             requirements. Unless otherwise specified, most buyer requirements are only
1140             returned if the caller is the seller. Not applicable to Half.com.
1141              
1142             SeeLink: URL: http://pages.ebay.com/help/sell/buyer-requirements.html
1143             Title: Selecting Buyer Requirements (eBay Web site help)
1144              
1145             Calls: AddItem
1146             GetItemRecommendations
1147             RelistItem
1148             ReviseItem
1149             VerifyAddItem
1150             RequiredInput: No
1151              
1152             # Argument: 'ns:BuyerRequirementDetailsType'
1153              
1154             =cut
1155              
1156             sub setBuyerRequirementDetails {
1157             my $self = shift;
1158             $self->{'BuyerRequirementDetails'} = shift
1159             }
1160              
1161             =head2 getBuyerRequirementDetails()
1162              
1163             Calls: GetBidderList
1164             Returned: Conditionally
1165              
1166             Calls: GetItem
1167             Returned: Conditionally
1168             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
1169              
1170             # Returns: 'ns:BuyerRequirementDetailsType'
1171              
1172             =cut
1173              
1174             sub getBuyerRequirementDetails {
1175             my $self = shift;
1176             return $self->_getDataTypeInstance( 'BuyerRequirementDetails'
1177             ,'eBay::API::XML::DataType::BuyerRequirementDetailsType');
1178             }
1179              
1180              
1181             =head2 setBuyerResponsibleForShipping()
1182              
1183             Applicable for listings in vehicle categories on the US eBay Motors site and
1184             eBay Canada site. (No business effect if specified for other categories or
1185             sites, as the Web site will not display the information to buyers.) If true,
1186             the buyer is responsible for vehicle pickup or shipping. If false, specify
1187             vehicle shipping arrangements in the item description. Default is true. (The
1188             description can also include vehicle shipping arrangements when this value is
1189             true.) If the item has bids or ends within 12 hours, you cannot modify this
1190             flag. Do not specify ShippingDetails.ShippingServiceOptions
1191             for vehicle listings.
1192            

1193             If true and the listing is on the US eBay Motors site, and you want the
1194             listing to be visible on the eBay Canada site, set Item.ShipToLocations to CA.
1195             If true and the listing is on the eBay Canada site , and you want your listing
1196             to be visible on the US eBay Motors site, set Item.ShipToLocations to US. Not
1197             applicable to Half.com.
1198              
1199             Calls: AddItem
1200             GetItemRecommendations
1201             RelistItem
1202             ReviseItem
1203             VerifyAddItem
1204             RequiredInput: No
1205              
1206             # Argument: 'xs:boolean'
1207              
1208             =cut
1209              
1210             sub setBuyerResponsibleForShipping {
1211             my $self = shift;
1212             $self->{'BuyerResponsibleForShipping'} = shift
1213             }
1214              
1215             =head2 isBuyerResponsibleForShipping()
1216              
1217             Calls: GetBidderList
1218             Returned: Conditionally
1219              
1220             Calls: GetItem
1221             Returned: Conditionally
1222             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
1223              
1224             # Returns: 'xs:boolean'
1225              
1226             =cut
1227              
1228             sub isBuyerResponsibleForShipping {
1229             my $self = shift;
1230             return $self->{'BuyerResponsibleForShipping'};
1231             }
1232              
1233              
1234             =head2 setCategoryBasedAttributesPrefill()
1235              
1236             Allows eBay to auto-fill some of a listing's Item Specifics (attribute) values
1237             based on the listing's category (or categories). Auto-filling attributes based
1238             on a category is not the same as using Pre-filled Item Information based on a
1239             catalog product (see ProductListingDetails). If true, also specify
1240             Item.CategoryMappingAllowed with a value of true. (Alternatively, you can
1241             auto-fill attributes on the client side by using mapping meta-data returned by
1242             GetAttributesCS.) See the eBay Web Services guide for more information.
1243             Ignored if the category does not support auto-filling attributes.
1244            
1245             If you also pass in attributes in AttributeSetArray, your values will override
1246             any auto-filled values for the same attributes. Once you have overridden the
1247             value of an auto-filled attribute for a given listing, eBay will not auto-fill
1248             it on subsequent ReviseItem requests (even if you remove the overridden
1249             value).
1250            
1251             Not applicable to Half.com.
1252              
1253             Calls: AddItem
1254             GetItemRecommendations
1255             ReviseItem
1256             RelistItem
1257             VerifyAddItem
1258             RequiredInput: No
1259              
1260             # Argument: 'xs:boolean'
1261              
1262             =cut
1263              
1264             sub setCategoryBasedAttributesPrefill {
1265             my $self = shift;
1266             $self->{'CategoryBasedAttributesPrefill'} = shift
1267             }
1268              
1269             =head2 isCategoryBasedAttributesPrefill()
1270              
1271             # Returns: 'xs:boolean'
1272              
1273             =cut
1274              
1275             sub isCategoryBasedAttributesPrefill {
1276             my $self = shift;
1277             return $self->{'CategoryBasedAttributesPrefill'};
1278             }
1279              
1280              
1281             =head2 setCategoryMappingAllowed()
1282              
1283             Controls how eBay handles cases in which an ID specified in PrimaryCategory
1284             and/or SecondaryCategory no longer exists in the current category structure:
1285             If you pass a value of true in CategoryMappingAllowed, eBay will look up the
1286             current ID that is mapped to the same category and use the new ID for the
1287             listing (if any). The new ID will be returned in the response as CategoryID
1288             (for the primary category) or Category2ID (for the secondary category). If
1289             CategoryMappingAllowed is not set or contains a value of "false" (the
1290             default), an error will be returned if a selected category ID no longer
1291             exists. Not applicable to Half.com.
1292              
1293             Calls: AddItem
1294             GetItemRecommendations
1295             AddLiveAuctionItem
1296             RelistItem
1297             ReviseItem
1298             ReviseLiveAuctionItem
1299             VerifyAddItem
1300             RequiredInput: No
1301             SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=CategoryMapping, Title: Mapping Old Category IDs to Current IDs
1302              
1303             # Argument: 'xs:boolean'
1304              
1305             =cut
1306              
1307             sub setCategoryMappingAllowed {
1308             my $self = shift;
1309             $self->{'CategoryMappingAllowed'} = shift
1310             }
1311              
1312             =head2 isCategoryMappingAllowed()
1313              
1314             # Returns: 'xs:boolean'
1315              
1316             =cut
1317              
1318             sub isCategoryMappingAllowed {
1319             my $self = shift;
1320             return $self->{'CategoryMappingAllowed'};
1321             }
1322              
1323              
1324             =head2 setCharity()
1325              
1326             Identifies a Giving Works listing and the benefiting nonprofit charity
1327             organization selected by the charity seller, if any. If specified, the
1328             seller must also accept PayPal as a payment method for the item (see
1329             Item.PaymentMethods).
1330            
Giving Works listings are not eligible for
1331             some eBay Express sites. (If ExpressListing is false in GetItem or
1332             VerifyAddItem and you specified Charity, check whether
1333             ExpressItemRequirements returns NoCharity as a cause.)
1334            

1335             When you revise an item, you can add a charity to a non-charity listing,
1336             but you cannot remove or change the charity designation. The rules for adding
1337             a charity to a listing depend on the listing type. For an auction listing, you
1338             can revise an item to add a charity if there are more than 12 hours left for
1339             the listing (whether or not the item has bids). For a fixed-price listing, you
1340             can revise an item to add a charity if there are more than 12 hours left for
1341             the listing, and the item has not been sold. For a Store Inventory listing,
1342             you can revise an item to add a charity if the item has not been sold. You
1343             cannot revise listings to add charity for Ad Format listings.
1344            

1345             When you relist an item, use DeletedField to remove charity information.
1346            

1347             Not applicable to Half.com.
1348              
1349             SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=MiscellaneousItemFieldDifferences
1350             Title: Miscellaneous Item Field Differences
1351             , URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=CharityListings
1352             Title: Identifying Listings that Benefit Nonprofits
1353              
1354              
1355             Calls: AddItem
1356             GetItemRecommendations
1357             RelistItem
1358             ReviseItem
1359             VerifyAddItem
1360             RequiredInput: No
1361              
1362             # Argument: 'ns:CharityType'
1363              
1364             =cut
1365              
1366             sub setCharity {
1367             my $self = shift;
1368             $self->{'Charity'} = shift
1369             }
1370              
1371             =head2 getCharity()
1372              
1373             Calls: GetBidderList
1374             Returned: Conditionally
1375              
1376             Calls: GetItem
1377             Returned: Conditionally
1378             Details: DetailLevel: ItemReturnDescription, ReturnAll
1379              
1380             Calls: GetItemTransactions
1381             GetSellerTransactions
1382             Returned: Conditionally
1383             Details: DetailLevel: none, ItemReturnDescription, ReturnAll
1384              
1385             Calls: GetOrderTransactions
1386             Returned: Conditionally
1387             Details: DetailLevel: none, ItemReturnDescription, ReturnAll
1388              
1389             Calls: GetSellerList
1390             Returned: Conditionally
1391             Details: DetailLevel: ItemReturnDescription, ReturnAll
1392             GranularityLevel: Coarse, Medium, Fine
1393              
1394              
1395             # Returns: 'ns:CharityType'
1396              
1397             =cut
1398              
1399             sub getCharity {
1400             my $self = shift;
1401             return $self->_getDataTypeInstance( 'Charity'
1402             ,'eBay::API::XML::DataType::CharityType');
1403             }
1404              
1405              
1406             =head2 setClassifiedAdPayPerLeadFee()
1407              
1408             The email and phone lead fee for a pay-per-lead item.
1409              
1410             # Argument: 'ns:AmountType'
1411              
1412             =cut
1413              
1414             sub setClassifiedAdPayPerLeadFee {
1415             my $self = shift;
1416             $self->{'ClassifiedAdPayPerLeadFee'} = shift
1417             }
1418              
1419             =head2 getClassifiedAdPayPerLeadFee()
1420              
1421             Calls: GetMyeBaySelling
1422             Returned: Conditionally
1423             Details: DetailLevel: ReturnAll
1424              
1425             # Returns: 'ns:AmountType'
1426              
1427             =cut
1428              
1429             sub getClassifiedAdPayPerLeadFee {
1430             my $self = shift;
1431             return $self->_getDataTypeInstance( 'ClassifiedAdPayPerLeadFee'
1432             ,'eBay::API::XML::DataType::AmountType');
1433             }
1434              
1435              
1436             =head2 setCountry()
1437              
1438             Two-letter ISO 3166 country code. In some calls, used with the Location field
1439             to indicate the city and country where the item is located. Also applicable as
1440             input to AddItem and related calls when you list items to Half.com (specify
1441             US).
1442             For English names that correspond to each code (e.g., KY="Cayman Islands"),
1443             call GeteBayDetails or see the
1444             ISO site:http://www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html
1445            
1446            
1447             In GetSearchResultsExpress, only returned when ItemDetails
1448             is set to Fine.
1449              
1450             Calls: AddItem
1451             VerifyAddItem
1452             RequiredInput: Yes
1453              
1454             Calls: RelistItem
1455             ReviseItem
1456             RequiredInput: No
1457              
1458             # Argument: 'ns:CountryCodeType'
1459              
1460             =cut
1461              
1462             sub setCountry {
1463             my $self = shift;
1464             $self->{'Country'} = shift
1465             }
1466              
1467             =head2 getCountry()
1468              
1469             Calls: GetSellerList
1470             Returned: Conditionally
1471             Details: DetailLevel: ItemReturnDescription, ReturnAll
1472             GranularityLevel: Coarse
1473              
1474              
1475             Calls: GetSearchResults
1476             Returned: Conditionally
1477             Details: DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll
1478             GranularityLevel: Coarse
1479              
1480              
1481             Calls: GetItemRecommendations
1482             GetProducts
1483             Returned: Conditionally
1484              
1485             Calls: GetBidderList
1486             Returned: Always
1487              
1488             Calls: GetItem
1489             Returned: Always
1490             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
1491              
1492             Calls: GetSellerTransactions
1493             Returned: Conditionally
1494             Details: DetailLevel: none, ItemReturnDescription, ReturnAll
1495              
1496             # Returns: 'ns:CountryCodeType'
1497              
1498             =cut
1499              
1500             sub getCountry {
1501             my $self = shift;
1502             return $self->{'Country'};
1503             }
1504              
1505              
1506             =head2 setCrossBorderTrade()
1507              
1508             For a fee, enables a listing to be displayed in the default search results
1509             of another eBay site. Use this value if you want to take
1510             advantage of the International Site Visibility listing upgrade.
1511              
1512             SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ListingsAvailableOtherSites
1513             Title: Making Listings Available by Default on Another Site
1514              
1515             Calls: AddItem
1516             VerifyAddItem
1517             ReviseItem
1518             RelistItem
1519             RequiredInput: No
1520              
1521             # Argument: reference to an array
1522             of 'xs:string'
1523              
1524             =cut
1525              
1526             sub setCrossBorderTrade {
1527             my $self = shift;
1528             $self->{'CrossBorderTrade'} =
1529             $self->convertArray_To_RefToArrayIfNeeded(@_);
1530             }
1531              
1532             =head2 getCrossBorderTrade()
1533              
1534             Calls: GetSellerList
1535             Returned: Conditionally
1536             Details: DetailLevel: ItemReturnDescription, ReturnAll
1537             GranularityLevel: Coarse, Medium, Fine
1538              
1539              
1540             Calls: GetItem
1541             Returned: Always
1542             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
1543              
1544             # Returns: reference to an array
1545             of 'xs:string'
1546              
1547             =cut
1548              
1549             sub getCrossBorderTrade {
1550             my $self = shift;
1551             return $self->_getDataTypeArray('CrossBorderTrade');
1552             }
1553              
1554              
1555             =head2 setCrossPromotion()
1556              
1557             Container for cross-promoted items related to a specific item ID.
1558             The items are either upsell or cross-sell, according to the promotion
1559             method passed in the request.
1560             Not applicable to Half.com.
1561              
1562             # Argument: 'ns:CrossPromotionsType'
1563              
1564             =cut
1565              
1566             sub setCrossPromotion {
1567             my $self = shift;
1568             $self->{'CrossPromotion'} = shift
1569             }
1570              
1571             =head2 getCrossPromotion()
1572              
1573             Calls: GetItem
1574             Returned: Conditionally
1575             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
1576              
1577             # Returns: 'ns:CrossPromotionsType'
1578              
1579             =cut
1580              
1581             sub getCrossPromotion {
1582             my $self = shift;
1583             return $self->_getDataTypeInstance( 'CrossPromotion'
1584             ,'eBay::API::XML::DataType::CrossPromotionsType');
1585             }
1586              
1587              
1588             =head2 setCurrency()
1589              
1590             Currency associated with the item's price information. 3-letter ISO 4217
1591             currency code that corresponds to the site specified in the item-listing
1592             request. Also applicable as input to AddItem and related calls when you list
1593             items to Half.com (specify USD). You cannot modify a listing's currency when
1594             you revise or relist an item.
1595              
1596             SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=FieldDifferences
1597             Title: Field Differences for eBay Sites
1598              
1599             Calls: AddItem
1600             GetItemRecommendations
1601             VerifyAddItem
1602             RequiredInput: Yes
1603             OnlyTheseValues: INR, CAD, CNY, HKD, AUD, CHF, MYR, EUR, PHP, PLN, USD, SGD, SEK, TWD, GBP
1604              
1605             # Argument: 'ns:CurrencyCodeType'
1606              
1607             =cut
1608              
1609             sub setCurrency {
1610             my $self = shift;
1611             $self->{'Currency'} = shift
1612             }
1613              
1614             =head2 getCurrency()
1615              
1616             Calls: GetBidderList
1617             Returned: Always
1618              
1619             Calls: GetItem
1620             Returned: Always
1621             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
1622              
1623             Calls: GetItemTransactions
1624             GetSellerTransactions
1625             Returned: Always
1626             Details: DetailLevel: none, ItemReturnDescription, ReturnAll
1627              
1628             Calls: GetSellerList
1629             Returned: Conditionally
1630             Details: DetailLevel: ItemReturnDescription, ReturnAll
1631             GranularityLevel: Coarse, Medium, Fine
1632              
1633              
1634             Calls: GetSearchResults
1635             Returned: Conditionally
1636             Details: DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll
1637             GranularityLevel: Coarse
1638              
1639              
1640             Calls: GetBestOffers
1641             Returned: Conditionally
1642             Details: DetailLevel: none, ReturnAll
1643              
1644             Calls: GetCategoryListings
1645             GetProducts
1646             Returned: Conditionally
1647              
1648             Calls: GetSellerEvents
1649             Returned: Conditionally
1650             Details: DetailLevel: none, ReturnAll
1651              
1652             # Returns: 'ns:CurrencyCodeType'
1653              
1654             =cut
1655              
1656             sub getCurrency {
1657             my $self = shift;
1658             return $self->{'Currency'};
1659             }
1660              
1661              
1662             =head2 setDescription()
1663              
1664             Description of the item. In listing requests, you can submit your description
1665             using CDATA if you want to use HTML or XML-reserved characters in the
1666             description. An error is returned if this contains malicious JavaScript
1667             content. (For related eBay policy, see
1668             http://pages.ebay.com/help/policies/listing-javascript.html.)
1669            

1670             The Description field is required for all listings, except certain listings
1671             that include Pre-filled Item Information. (See "About the Pre- filled Item
1672             Information API." in the eBay Web Services Guide.) Even if your application
1673             does not support listings items with Pre-filled Item Information, you should
1674             be aware that this also means GetItem, GetSellerList, and GetBidderList may
1675             return some items with empty Description fields.
1676            

1677             If you embed pictures in the description (by using IMG tags) instead of using
1678             PictureURL, but you want a camera icon to appear in search and listing pages,
1679             specify the following null-image URL in PictureURL:
1680             http://pics.ebay.com/aw/pics/dot_clear.gif. See "Including Pictures in an Item
1681             Listing" in the eBay Web Services Guide.
1682            

1683             For eBay Live Auctions listings, JavaScript is not allowed.
1684            

1685             Not applicable to Half.com. (For Half.com, use AttributeArray.Attribute with
1686             attributeLabel="Notes" to specify a brief description or note to the buyer.)
1687              
1688             MaxLength: 500000 (some sites may allow more, but the exact number may vary)
1689              
1690             Calls: AddItem
1691             AddLiveAuctionItem
1692             GetItemRecommendations
1693             RelistItem
1694             ReviseItem
1695             ReviseLiveAuctionItem
1696             VerifyAddItem
1697             RequiredInput: Conditionally
1698              
1699             # Argument: 'xs:string'
1700              
1701             =cut
1702              
1703             sub setDescription {
1704             my $self = shift;
1705             $self->{'Description'} = shift
1706             }
1707              
1708             =head2 getDescription()
1709              
1710             Calls: GetSellerList
1711             Returned: Conditionally
1712             Details: DetailLevel: ItemReturnDescription, ReturnAll
1713              
1714             Calls: GetItem
1715             Returned: Always
1716             Details: DetailLevel: ItemReturnDescription, ReturnAll
1717              
1718             # Returns: 'xs:string'
1719              
1720             =cut
1721              
1722             sub getDescription {
1723             my $self = shift;
1724             return $self->{'Description'};
1725             }
1726              
1727              
1728             =head2 setDescriptionReviseMode()
1729              
1730             If you are changing the description of an item, specifies whether
1731             the new next is an addition, a replacement, etc.
1732              
1733             Calls: ReviseItem
1734             RequiredInput: No
1735              
1736             # Argument: 'ns:DescriptionReviseModeCodeType'
1737              
1738             =cut
1739              
1740             sub setDescriptionReviseMode {
1741             my $self = shift;
1742             $self->{'DescriptionReviseMode'} = shift
1743             }
1744              
1745             =head2 getDescriptionReviseMode()
1746              
1747             # Returns: 'ns:DescriptionReviseModeCodeType'
1748              
1749             =cut
1750              
1751             sub getDescriptionReviseMode {
1752             my $self = shift;
1753             return $self->{'DescriptionReviseMode'};
1754             }
1755              
1756              
1757             =head2 setDisableBuyerRequirements()
1758              
1759             If false (or omitted): if BuyerRequirementDetails are present, those requirements are to be used; otherwise, any requirements specified in
1760             My eBay are to be used.
1761             If true: no requirements are considered from any source (and if
1762             BuyerRequirementDetails are present, they are ignored).
1763              
1764             Default: false
1765              
1766             Calls: AddItem
1767             GetItemRecommendations
1768             RelistItem
1769             ReviseItem
1770             VerifyAddItem
1771             RequiredInput: No
1772              
1773             # Argument: 'xs:boolean'
1774              
1775             =cut
1776              
1777             sub setDisableBuyerRequirements {
1778             my $self = shift;
1779             $self->{'DisableBuyerRequirements'} = shift
1780             }
1781              
1782             =head2 isDisableBuyerRequirements()
1783              
1784             Calls: GetSellerList
1785             Returned: Conditionally
1786             Details: DetailLevel: ItemReturnDescription, ReturnAll
1787              
1788             Calls: GetBidderList
1789             Returned: Conditionally
1790              
1791             Calls: GetItem
1792             Returned: Conditionally
1793             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
1794              
1795             # Returns: 'xs:boolean'
1796              
1797             =cut
1798              
1799             sub isDisableBuyerRequirements {
1800             my $self = shift;
1801             return $self->{'DisableBuyerRequirements'};
1802             }
1803              
1804              
1805             =head2 setDispatchTimeMax()
1806              
1807             Specifies the maximum number of business days the seller
1808             commits to for shipping an item to domestic buyers after receiving a
1809             cleared payment. The seller sets this to an integer value (1, 2, 3,
1810             4, 5, 10, 15, or 20) corresponding to the number of days. To add
1811             Get It Fast to listings, in addition to setting GetItFast to true,
1812             DispatchTimeMax must be set to 1 and the seller must specify at least
1813             one qualifying expedited shipping service.
1814             GetItem returns DispatchTimeMax only when shipping service options are
1815             specified for the item and the seller specified a dispatch time.
1816              
1817             Calls: AddItem
1818             GetItemRecommendations
1819             RelistItem
1820             ReviseItem
1821             VerifyAddItem
1822             RequiredInput: No
1823              
1824             # Argument: 'xs:int'
1825              
1826             =cut
1827              
1828             sub setDispatchTimeMax {
1829             my $self = shift;
1830             $self->{'DispatchTimeMax'} = shift
1831             }
1832              
1833             =head2 getDispatchTimeMax()
1834              
1835             Calls: GetBidderList
1836             Returned: Conditionally
1837              
1838             Calls: GetItem
1839             Returned: Conditionally
1840             Details: DetailLevel: none, ItemReturnDescription,
1841             ItemReturnAttributes, ReturnAll
1842              
1843             # Returns: 'xs:int'
1844              
1845             =cut
1846              
1847             sub getDispatchTimeMax {
1848             my $self = shift;
1849             return $self->{'DispatchTimeMax'};
1850             }
1851              
1852              
1853             =head2 setDistance()
1854              
1855             The distance used in a proximity search distance calculation.
1856             Not applicable to Half.com.
1857              
1858             # Argument: 'ns:DistanceType'
1859              
1860             =cut
1861              
1862             sub setDistance {
1863             my $self = shift;
1864             $self->{'Distance'} = shift
1865             }
1866              
1867             =head2 getDistance()
1868              
1869             Calls: GetSearchResults
1870             Returned: Conditionally
1871             Details: DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll
1872              
1873             Calls: GetCategoryListings
1874             Returned: Conditionally
1875              
1876             # Returns: 'ns:DistanceType'
1877              
1878             =cut
1879              
1880             sub getDistance {
1881             my $self = shift;
1882             return $self->_getDataTypeInstance( 'Distance'
1883             ,'eBay::API::XML::DataType::DistanceType');
1884             }
1885              
1886              
1887             =head2 setExtendedSellerContactDetails()
1888              
1889             Extended contact information for sellers using the Classified Ad format.
1890             Specifies the days and hours when the seller can be contacted.
1891             To remove seller contact information when revising or relisting an item, use
1892             DeletedField.
1893              
1894             Calls: AddItem
1895             ReviseItem
1896             VerifyAddItem
1897             RelistItem
1898             RequiredInput: No
1899              
1900             # Argument: 'ns:ExtendedContactDetailsType'
1901              
1902             =cut
1903              
1904             sub setExtendedSellerContactDetails {
1905             my $self = shift;
1906             $self->{'ExtendedSellerContactDetails'} = shift
1907             }
1908              
1909             =head2 getExtendedSellerContactDetails()
1910              
1911             Calls: GetItem
1912             Returned: Conditionally
1913             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
1914              
1915             Calls: GetSellerList
1916             Returned: Conditionally
1917             Details: DetailLevel: none, ItemReturnDescription, ReturnAll
1918              
1919             # Returns: 'ns:ExtendedContactDetailsType'
1920              
1921             =cut
1922              
1923             sub getExtendedSellerContactDetails {
1924             my $self = shift;
1925             return $self->_getDataTypeInstance( 'ExtendedSellerContactDetails'
1926             ,'eBay::API::XML::DataType::ExtendedContactDetailsType');
1927             }
1928              
1929              
1930             =head2 setExternalProductID()
1931              
1932             An ISBN value, UPC value, EAN value, ticket keywords,
1933             or eBay catalog product ID, plus other meta-data that you specify.
1934             Only applicable to certain categories. See
1935             the eBay Web Services Guide for information on the categories
1936             that currently support usage of this field.
1937            
1938             For AddItem and VerifyAddItem only:
1939             Causes eBay to list the item with Pre-filled Item Information
1940             based on the value you specify. If you are listing in a
1941             media category and the primary and secondary category are both
1942             catalog-enabled, the external ID must be for a product associated with
1943             the primary category. If only one category is
1944             catalog-enabled, this external ID must be for a product that is
1945             associated with the catalog-enabled category. If you are listing
1946             an event ticket, the external ID must be associated with the
1947             primary category.
1948            
1949             Either Item.ExternalProductID or Item.ProductListingDetails
1950             can be specified in an AddItem (or VerifyAddItem) request.
1951             Do not specify both.
1952             If you use Item.ExternalProductID instead
1953             of Item.ProductListingDetails, eBay sets IncludeStockPhotoURL
1954             and IncludePrefilledItemInformation to true automatically.
1955            
1956             The stock photo URL satisfies the eBay Express picture requirement.
1957             See the eBay Web Services Guide links below for more details.
1958            
1959             Optional for eBay.com listings. Applicable to Half.com listings.
1960            
1961             For ReviseItem and RelistItem only:
1962             ExternalProductID is not applicable when revising and relisting items
1963             (use Item.ProductListingDetails instead).
1964            
1965             For GetItemRecommendations only:
1966             In GetItemRecommendations, only applicable when the value of
1967             ListingFlow is AddItem. Not applicable when the recommendation engine
1968             is ProductPricing.
1969              
1970             SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=BMMGExternalID
1971             Title: Pre-filling a Listing Based on ISBN, EAN, or UPC Values (ExternalProductID)
1972             , URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=TicketKeywords
1973             Title: Pre-filling a Ticket Listing Based on Keywords (Name, Venue, and Date)
1974             , URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ExpressPictureRequired
1975             Title: Specify a Picture for Express and eBay
1976             , URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=EngineListingAnalyzer
1977             Title: Getting Listing Analyzer Tips on Making a Listing More Effective
1978             , URL: ReviseItem.html#Request.Item.ProductListingDetails
1979             Title: (ReviseItem) Item.ProductListingDetails
1980              
1981              
1982             Calls: AddItem
1983             GetItemRecommendations
1984             VerifyAddItem
1985             RequiredInput: Conditionally
1986              
1987             # Argument: 'ns:ExternalProductIDType'
1988              
1989             =cut
1990              
1991             sub setExternalProductID {
1992             my $self = shift;
1993             $self->{'ExternalProductID'} = shift
1994             }
1995              
1996             =head2 getExternalProductID()
1997              
1998             # Returns: 'ns:ExternalProductIDType'
1999              
2000             =cut
2001              
2002             sub getExternalProductID {
2003             my $self = shift;
2004             return $self->_getDataTypeInstance( 'ExternalProductID'
2005             ,'eBay::API::XML::DataType::ExternalProductIDType');
2006             }
2007              
2008              
2009             =head2 setFreeAddedCategory()
2010              
2011             ID for a second category that eBay added as a free promotion. You cannot add
2012             this yourself. Only returned if the item was listed in a single category and
2013             eBay added a free second category.
2014             Not applicable to Half.com.
2015              
2016             # Argument: 'ns:CategoryType'
2017              
2018             =cut
2019              
2020             sub setFreeAddedCategory {
2021             my $self = shift;
2022             $self->{'FreeAddedCategory'} = shift
2023             }
2024              
2025             =head2 getFreeAddedCategory()
2026              
2027             Calls: GetBidderList
2028             Returned: Conditionally
2029              
2030             Calls: GetItem
2031             Returned: Conditionally
2032             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
2033              
2034             Calls: GetSellerList
2035             Returned: Conditionally
2036             Details: DetailLevel: ItemReturnDescription, ReturnAll
2037              
2038             # Returns: 'ns:CategoryType'
2039              
2040             =cut
2041              
2042             sub getFreeAddedCategory {
2043             my $self = shift;
2044             return $self->_getDataTypeInstance( 'FreeAddedCategory'
2045             ,'eBay::API::XML::DataType::CategoryType');
2046             }
2047              
2048              
2049             =head2 setGetItFast()
2050              
2051             Indicates whether the seller has opted the listing into the Get
2052             It Fast feature. If GetItFast is true and if at least one of
2053             the domestic shipping services offered by the seller is an
2054             expedited shipping service, every shipping service offered by
2055             the seller is considered a Get It Fast service, and the seller
2056             commits to delivering the item to the buyer-selected shipping
2057             service within one day.
2058             Not applicable to Half.com.
2059             GetItFast is not supported for UK Store Inventory format items.
2060              
2061             SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SalesTax
2062             Title: Enabling Multi-jurisdiction Sales Tax
2063             , URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=MiscellaneousItemFieldDifferences
2064             Title: Miscellaneous Item Field Differences
2065              
2066              
2067             Calls: AddItem
2068             GetItemRecommendations
2069             RelistItem
2070             ReviseItem
2071             VerifyAddItem
2072             RequiredInput: No
2073              
2074             # Argument: 'xs:boolean'
2075              
2076             =cut
2077              
2078             sub setGetItFast {
2079             my $self = shift;
2080             $self->{'GetItFast'} = shift
2081             }
2082              
2083             =head2 isGetItFast()
2084              
2085             Calls: GetSellerList
2086             Returned: Conditionally
2087             Details: DetailLevel: ItemReturnDescription, ReturnAll
2088              
2089             Calls: GetBidderList
2090             Returned: Conditionally
2091              
2092             Calls: GetItem
2093             Returned: Conditionally
2094             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
2095              
2096             Calls: GetItemTransactions
2097             GetSellerTransactions
2098             Returned: Conditionally
2099             Details: DetailLevel: ReturnAll
2100              
2101             Calls: GetOrderTransactions
2102             Returned: Conditionally
2103             Details: DetailLevel: none, ItemReturnDescription, ReturnAll
2104              
2105             # Returns: 'xs:boolean'
2106              
2107             =cut
2108              
2109             sub isGetItFast {
2110             my $self = shift;
2111             return $self->{'GetItFast'};
2112             }
2113              
2114              
2115             =head2 setGiftIcon()
2116              
2117             If true, a generic gift icon displays next the listing's title in search and
2118             browse pages. GiftIcon must be set to be able to use GiftServices options.
2119             Note that one/zero is returned instead of true/false. Not applicable to Half.com.
2120              
2121             Calls: AddItem
2122             GetItemRecommendations
2123             RelistItem
2124             ReviseItem
2125             VerifyAddItem
2126             RequiredInput: Conditionally
2127              
2128             # Argument: 'xs:int'
2129              
2130             =cut
2131              
2132             sub setGiftIcon {
2133             my $self = shift;
2134             $self->{'GiftIcon'} = shift
2135             }
2136              
2137             =head2 getGiftIcon()
2138              
2139             Calls: GetSearchResults
2140             Returned: Conditionally
2141             Details: DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll
2142              
2143             Calls: GetBidderList
2144             Returned: Always
2145              
2146             Calls: GetItem
2147             Returned: Always
2148             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
2149              
2150             Calls: GetSellerList
2151             Returned: Conditionally
2152             Details: DetailLevel: ItemReturnDescription, ReturnAll
2153             GranularityLevel: Coarse, Medium, Fine
2154              
2155              
2156             Calls: GetProducts
2157             Returned: Conditionally
2158              
2159             # Returns: 'xs:int'
2160              
2161             =cut
2162              
2163             sub getGiftIcon {
2164             my $self = shift;
2165             return $self->{'GiftIcon'};
2166             }
2167              
2168              
2169             =head2 setGiftServices()
2170              
2171             Optional gift services that the seller is offering if the buyer chooses to
2172             purchase the item as a gift. Only returned if offered by the seller.
2173             Not applicable to Half.com.
2174              
2175             Calls: AddItem
2176             GetItemRecommendations
2177             RelistItem
2178             ReviseItem
2179             VerifyAddItem
2180             RequiredInput: No
2181              
2182             # Argument: reference to an array
2183             of 'ns:GiftServicesCodeType'
2184              
2185             =cut
2186              
2187             sub setGiftServices {
2188             my $self = shift;
2189             $self->{'GiftServices'} =
2190             $self->convertArray_To_RefToArrayIfNeeded(@_);
2191             }
2192              
2193             =head2 getGiftServices()
2194              
2195             Calls: GetBidderList
2196             Returned: Conditionally
2197              
2198             Calls: GetItem
2199             Returned: Conditionally
2200             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
2201              
2202             # Returns: reference to an array
2203             of 'ns:GiftServicesCodeType'
2204              
2205             =cut
2206              
2207             sub getGiftServices {
2208             my $self = shift;
2209             return $self->_getDataTypeArray('GiftServices');
2210             }
2211              
2212              
2213             =head2 setGroupCategoryID()
2214              
2215             GroupCategoryID is returned if there is a value of BestMatchCategoryGroup in the
2216             Order field for the GetSearchResults call. However, the results depend on the
2217             items and groups requested. The Best Match algorithm will try to evenly fit the
2218             items and return groups of 'Best Matching' Categories. A 'category group' can be
2219             a parent category that contains the best-matching items from several of its
2220             subcategories. Within each category group, items will be also sorted by best
2221             match. The only condition when you may not get a GroupCategoryID returned at all
2222             is when the request is for one group and there is more than one category that
2223             has matching items. Very rarely, the same item will appear once in the group for
2224             its primary category and once in another group for its secondary category, in
2225             the same result set. Also very occasionally, a Store Inventory Item can appear
2226             in the results before a regular listing.
2227              
2228             # Argument: 'xs:string'
2229              
2230             =cut
2231              
2232             sub setGroupCategoryID {
2233             my $self = shift;
2234             $self->{'GroupCategoryID'} = shift
2235             }
2236              
2237             =head2 getGroupCategoryID()
2238              
2239             Calls: GetSearchResults
2240             Returned: Conditionally
2241             Details: DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll, None
2242              
2243             # Returns: 'xs:string'
2244              
2245             =cut
2246              
2247             sub getGroupCategoryID {
2248             my $self = shift;
2249             return $self->{'GroupCategoryID'};
2250             }
2251              
2252              
2253             =head2 setHitCount()
2254              
2255             The number of page views for the item. This number is calculated by eBay and
2256             cannot be set via the API. Returned if the hit counter type is BasicStyle,
2257             RetroStyle, or HiddenStyle. For HiddenStyle, HitCount is returned only if the
2258             requestor is the item's seller.
2259              
2260             # Argument: 'xs:long'
2261              
2262             =cut
2263              
2264             sub setHitCount {
2265             my $self = shift;
2266             $self->{'HitCount'} = shift
2267             }
2268              
2269             =head2 getHitCount()
2270              
2271             Calls: GetBidderList
2272             Returned: Conditionally
2273              
2274             Calls: GetItem
2275             Returned: Conditionally
2276             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
2277              
2278             Calls: GetSellerList
2279             Returned: Conditionally
2280             Details: DetailLevel: ItemReturnDescription, ReturnAll
2281             GranularityLevel: Coarse, Medium, Fine
2282              
2283              
2284             Calls: GetSellerEvents
2285             Returned: Conditionally
2286             Details: DetailLevel: none, ReturnAll
2287              
2288             # Returns: 'xs:long'
2289              
2290             =cut
2291              
2292             sub getHitCount {
2293             my $self = shift;
2294             return $self->{'HitCount'};
2295             }
2296              
2297              
2298             =head2 setHitCounter()
2299              
2300             Indicates whether an optional hit counter is displayed on the item's listing
2301             page and, if so, what type. See HitCounterCodeType for specific values.
2302             Not applicable to Half.com.
2303             This field is ignored when Item.ListingType=Express.
2304              
2305             Calls: AddItem
2306             GetItemRecommendations
2307             RelistItem
2308             ReviseItem
2309             VerifyAddItem
2310             RequiredInput: No
2311              
2312             # Argument: 'ns:HitCounterCodeType'
2313              
2314             =cut
2315              
2316             sub setHitCounter {
2317             my $self = shift;
2318             $self->{'HitCounter'} = shift
2319             }
2320              
2321             =head2 getHitCounter()
2322              
2323             Calls: GetBidderList
2324             Returned: Always
2325              
2326             Calls: GetItem
2327             Returned: Always
2328             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
2329              
2330             Calls: GetSellerList
2331             Returned: Always
2332             Details: DetailLevel: ItemReturnDescription, ReturnAll
2333             GranularityLevel: Coarse, Medium, Fine
2334              
2335              
2336             Calls: GetSellerEvents
2337             Returned: Always
2338             Details: DetailLevel: none, ReturnAll
2339              
2340             # Returns: 'ns:HitCounterCodeType'
2341              
2342             =cut
2343              
2344             sub getHitCounter {
2345             my $self = shift;
2346             return $self->{'HitCounter'};
2347             }
2348              
2349              
2350             =head2 setItemID()
2351              
2352             The ID that uniquely identifies the item listing. The ID is generated
2353             by eBay after an item is listed. You cannot choose or revise this
2354             value.
2355            
2356             Also applicable to Half.com. For Half.com, you can specify either ItemID or
2357             SellerInventoryID in a ReviseItem request to uniquely identify the
2358             listing.
2359            
2360             In GetItemRecommendations, the item ID is required when the value of
2361             ListingFlow is ReviseItem or RelistItem, but it is not applicable when the
2362             value of ListingFlow is AddItem.
2363            
2364             In GetSearchResultsExpress, always returned when ItemArray.Item is returned.
2365            
2366             For GetCart/SetCart input, this is only required if the parent container is submitted.
2367              
2368             MaxLength: 19. (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits.)
2369              
2370             Calls: AddOrder
2371             GetBestOffers
2372             RelistItem
2373             ReviseItem
2374             ReviseLiveAuctionItem
2375             RequiredInput: Yes
2376              
2377             Calls: GetItemRecommendations
2378             RequiredInput: Conditionally
2379              
2380             # Argument: 'ns:ItemIDType'
2381              
2382             =cut
2383              
2384             sub setItemID {
2385             my $self = shift;
2386             $self->{'ItemID'} = shift
2387             }
2388              
2389             =head2 getItemID()
2390              
2391             Calls: GetBidderList
2392             GetDispute
2393             Returned: Always
2394              
2395             Calls: GetOrders
2396             Returned: Always
2397             Details: DetailLevel: none
2398              
2399             Calls: GetOrderTransactions
2400             Returned: Always
2401             Details: DetailLevel: none, ItemReturnDescription, ReturnAll
2402              
2403             Calls: GetItem
2404             Returned: Always
2405             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
2406              
2407             Calls: GetItemTransactions
2408             GetSellerTransactions
2409             Returned: Always
2410             Details: DetailLevel: none, ItemReturnDescription, ReturnAll
2411              
2412             Calls: GetOrderTransactions
2413             Returned: Always
2414             Details: DetailLevel: none, ItemReturnDescription, ReturnAll
2415              
2416             Calls: GetSearchResults
2417             Returned: Conditionally
2418             Details: DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll
2419             GranularityLevel: Coarse
2420              
2421              
2422             Calls: GetBestOffers
2423             Returned: Conditionally
2424             Details: DetailLevel: none, ReturnAll
2425              
2426             Calls: GetItemsAwaitingFeedback
2427             GetMemberMessages
2428             GetProducts
2429             Returned: Conditionally
2430              
2431             Calls: GetUserDisputes
2432             Returned: Conditionally
2433             Details: DetailLevel: ReturnSummary, ReturnAll, none
2434              
2435             Calls: GetMyeBayBuying
2436             Returned: Conditionally
2437             Details: DetailLevel: none, ReturnSummary, ReturnAll
2438             Context: BestOfferList
2439             BidList
2440             LostList
2441             SecondChanceOffer
2442             WatchList
2443             WonList
2444             DeletedFromWonList
2445             DeletedFromLostList
2446              
2447             Calls: GetMyeBaySelling
2448             Returned: Conditionally
2449             Details: DetailLevel: none, ReturnSummary, ReturnAll
2450             Context: ActiveList
2451             BidList
2452             ScheduledList
2453             SoldList
2454             UnsoldList
2455             DeletedFromSoldList
2456             DeletedFromUnsoldList
2457              
2458             Calls: GetSellerEvents
2459             Returned: Conditionally
2460             Details: DetailLevel: none, ReturnAll
2461              
2462             Calls: GetSellerEvents
2463             Returned: Conditionally
2464             Details: DetailLevel: none, ReturnAll
2465              
2466             Calls: GetSellerList
2467             Returned: Conditionally
2468             Details: DetailLevel: none, ItemReturnDescription, ReturnAll
2469             GranularityLevel: Coarse, Medium, Fine
2470              
2471              
2472             # Returns: 'ns:ItemIDType'
2473              
2474             =cut
2475              
2476             sub getItemID {
2477             my $self = shift;
2478             return $self->_getDataTypeInstance( 'ItemID'
2479             ,'eBay::API::XML::DataType::ItemIDType');
2480             }
2481              
2482              
2483             =head2 setItemPolicyViolation()
2484              
2485             Specifies the details of policy violations if the item was administratively canceled.
2486              
2487             # Argument: 'ns:ItemPolicyViolationType'
2488              
2489             =cut
2490              
2491             sub setItemPolicyViolation {
2492             my $self = shift;
2493             $self->{'ItemPolicyViolation'} = shift
2494             }
2495              
2496             =head2 getItemPolicyViolation()
2497              
2498             Calls: GetSellerList
2499             Returned: Conditionally
2500             Details: DetailLevel: ItemReturnDescription, ReturnAll
2501              
2502             Calls: GetItem
2503             Returned: Conditionally
2504              
2505             # Returns: 'ns:ItemPolicyViolationType'
2506              
2507             =cut
2508              
2509             sub getItemPolicyViolation {
2510             my $self = shift;
2511             return $self->_getDataTypeInstance( 'ItemPolicyViolation'
2512             ,'eBay::API::XML::DataType::ItemPolicyViolationType');
2513             }
2514              
2515              
2516             =head2 setItemSpecifics()
2517              
2518             A list of attribute or Item Specific name and value pairs that the
2519             seller specified for the item.
2520            
2521             In the AddItem family of calls, use this for specifying
2522             custom Item Specifics. (If you are including an
2523             Item Condition or Return Policy, use AttributeSetArray for these
2524             details as usual instead. You can use AttributeSetArray and
2525             ItemSpecifics in the same request in this case.)
2526            
2527             To determine which categories support
2528             custom Item Specifics, use GetCategoryFeatures.
2529            
2530             Note:
2531             If you are trying to list with ID-based attributes
2532             from GetAttributesCS or GetProductSellingPages,
2533             use AttributeSetArray instead.
2534            
2535             To retrieve recommended Item Specifics, use GetCategorySpecifics or GetItemRecommendations.
2536            
2537             In GetItemRecommendations, pass in the PrimaryCategory and (optionally)
2538             Title to retrieve recommended names and values.
2539            
2540             With GetItem, this is only returned when you specify
2541             IncludeItemSpecifics in the request (and the seller included
2542             custom Item Specifics in their listing).
2543            
2544             For ReviseItem only: When you revise a listing,
2545             if the listing has bids and ends within 12 hours, you cannot change or
2546             add Item Specifics. If the listing has bids but ends in more
2547             than 12 hours, you cannot change existing Item Specifics, but you can
2548             add Item Specifics that were not previously specified.
2549            
2550             To delete all Item Specifics when you revise or relist, specify
2551             Item.ItemSpecifics in DeletedField and don't pass ItemSpecifics in the
2552             request.
2553            
2554             With GetProducts, only the item condition is returned at the item level.
2555             Additional attributes that were pre-filled from the catalog are returned
2556             in Product.ItemSpecifics.
2557              
2558             SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ItemSpecifics
2559             Title: Working with Custom Item Specifics
2560             , URL: GetProducts.html#Response.Product.ItemSpecifics
2561             Title: (GetProducts) Product.ItemSpecifics
2562              
2563              
2564             Calls: AddItem
2565             AddLiveAuctionItem
2566             GetItemRecommendations
2567             RelistItem
2568             ReviseItem
2569             ReviseLiveAuctionItem
2570             VerifyAddItem
2571             RequiredInput: No
2572              
2573             # Argument: 'ns:NameValueListArrayType'
2574              
2575             =cut
2576              
2577             sub setItemSpecifics {
2578             my $self = shift;
2579             $self->{'ItemSpecifics'} = shift
2580             }
2581              
2582             =head2 getItemSpecifics()
2583              
2584             Calls: GetItem
2585             Returned: Conditionally
2586             Details: DetailLevel: none, ItemReturnDescription,
2587             ItemReturnAttributes, ReturnAll
2588              
2589             Calls: GetProducts
2590             Returned: Conditionally
2591              
2592             # Returns: 'ns:NameValueListArrayType'
2593              
2594             =cut
2595              
2596             sub getItemSpecifics {
2597             my $self = shift;
2598             return $self->_getDataTypeInstance( 'ItemSpecifics'
2599             ,'eBay::API::XML::DataType::NameValueListArrayType');
2600             }
2601              
2602              
2603             =head2 setLeadCount()
2604              
2605             Specifies the number of leads (emails) buyers have posted about the item. You must be the seller of the item to retrieve the lead count.
2606              
2607             Calls: GetMyeBaySelling
2608             RequiredInput: Conditionally
2609              
2610             # Argument: 'xs:int'
2611              
2612             =cut
2613              
2614             sub setLeadCount {
2615             my $self = shift;
2616             $self->{'LeadCount'} = shift
2617             }
2618              
2619             =head2 getLeadCount()
2620              
2621             # Returns: 'xs:int'
2622              
2623             =cut
2624              
2625             sub getLeadCount {
2626             my $self = shift;
2627             return $self->{'LeadCount'};
2628             }
2629              
2630              
2631             =head2 setLimitedWarrantyEligible()
2632              
2633             Applicable to US eBay Motors vehicle listings only. If false, the vehicle will
2634             not be considered for a limited warranty by eBay. If your application lists
2635             Motors vehicles, you must provide the seller with an opportunity to indicate
2636             whether the vehicle has not been modified and is not a special type (e.g.,
2637             Corvette ZR1). If LimitedWarrantyEligible is passed in, it means the
2638             application has presented the seller with checkboxes to indicate this
2639             information. If true, the seller has verified that the vehicle has not been
2640             modified and is not a special type. If false, the seller has verified that
2641             vehicle has been modified or it is a special type. Passing a value of true
2642             does not guarantee that eBay will offer a limited warranty. It only makes the
2643             listing eligible for consideration. See the eBay Web Services Guide for more
2644             information about Motors vehicle listings.
2645             Not applicable to Half.com.
2646              
2647             SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=MotorsWarranty
2648             Title: Short-Term Service Agreement (Limited Warranty)
2649              
2650             Calls: AddItem
2651             GetItemRecommendations
2652             RelistItem
2653             ReviseItem
2654             VerifyAddItem
2655             RequiredInput: Conditionally
2656              
2657             # Argument: 'xs:boolean'
2658              
2659             =cut
2660              
2661             sub setLimitedWarrantyEligible {
2662             my $self = shift;
2663             $self->{'LimitedWarrantyEligible'} = shift
2664             }
2665              
2666             =head2 isLimitedWarrantyEligible()
2667              
2668             # Returns: 'xs:boolean'
2669              
2670             =cut
2671              
2672             sub isLimitedWarrantyEligible {
2673             my $self = shift;
2674             return $self->{'LimitedWarrantyEligible'};
2675             }
2676              
2677              
2678             =head2 setListingCheckoutRedirectPreference()
2679              
2680             ProStores listing level preferences regarding the store to which
2681             checkout should be redirected for the listing if ThirdPartyCheckout
2682             is true. If not set (and ThirdPartyCheckout is true), third
2683             party checkout is redirected to the listing application.
2684              
2685             SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ThirdPartyCheckoutRedirectProStores
2686             Title: Third Party Checkout Redirect to ProStores
2687              
2688             Calls: AddItem
2689             RelistItem
2690             ReviseItem
2691             VerifyAddItem
2692             RequiredInput: Conditionally
2693              
2694             # Argument: 'ns:ListingCheckoutRedirectPreferenceType'
2695              
2696             =cut
2697              
2698             sub setListingCheckoutRedirectPreference {
2699             my $self = shift;
2700             $self->{'ListingCheckoutRedirectPreference'} = shift
2701             }
2702              
2703             =head2 getListingCheckoutRedirectPreference()
2704              
2705             Calls: GetSellerList
2706             Returned: Conditionally
2707             Details: DetailLevel: ItemReturnDescription, ReturnAll
2708              
2709             Calls: GetItem
2710             Returned: Conditionally
2711             Details: DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
2712              
2713             # Returns: 'ns:ListingCheckoutRedirectPreferenceType'
2714              
2715             =cut
2716              
2717             sub getListingCheckoutRedirectPreference {
2718             my $self = shift;
2719             return $self->_getDataTypeInstance( 'ListingCheckoutRedirectPreference'
2720             ,'eBay::API::XML::DataType::ListingCheckoutRedirectPreferenceType');
2721             }
2722              
2723              
2724             =head2 setListingDesigner()
2725              
2726             Contains the detail data for the Listing Designer theme and template (if either
2727             are used), which can optionally be used to enhance the appearance of the
2728             description area of an item's description. See ListingDesignerType for its
2729             child elements.
2730             Not applicable to Half.com.
2731              
2732             Calls: AddItem
2733             GetItemRecommendations
2734             RelistItem
2735             ReviseItem
2736             VerifyAddItem
2737             RequiredInput: No
2738              
2739             # Argument: 'ns:ListingDesignerType'
2740              
2741             =cut
2742              
2743             sub setListingDesigner {
2744             my $self = shift;
2745             $self->{'ListingDesigner'} = shift
2746             }
2747              
2748             =head2 getListingDesigner()
2749              
2750             Calls: GetBidderList
2751             Returned: Conditionally
2752              
2753             Calls: GetSellerList
2754             Returned: Conditionally
2755             Details: DetailLevel: ItemReturnDescription, ReturnAll
2756              
2757             Calls: GetItem
2758             Returned: Conditionally
2759             Details: DetailLevel: ItemReturnDescription, ReturnAll
2760              
2761             # Returns: 'ns:ListingDesignerType'
2762              
2763             =cut
2764              
2765             sub getListingDesigner {
2766             my $self = shift;
2767             return $self->_getDataTypeInstance( 'ListingDesigner'
2768             ,'eBay::API::XML::DataType::ListingDesignerType');
2769             }
2770              
2771              
2772             =head2 setListingDetails()
2773              
2774             Various details about a listing, some of which are
2775             calculated or derived after the item is listed. These
2776             include the start and end time, converted (localized)
2777             prices, and certain flags that indicate whether the seller
2778             specified fields whose values are not visible to the
2779             requesting user. For GetMyeBayBuying, returned as a self-
2780             closed element if no listings meet the request criteria.
2781             Not applicable to Half.com.
2782              
2783             Calls: AddItem
2784             GetItemRecommendations
2785             ReviseItem
2786             RelistItem
2787             VerifyAddItem
2788             RequiredInput: No
2789              
2790             # Argument: 'ns:ListingDetailsType'
2791              
2792             =cut
2793              
2794             sub setListingDetails {
2795             my $self = shift;
2796             $self->{'ListingDetails'} = shift
2797             }
2798              
2799             =head2 getListingDetails()
2800              
2801             Calls: GetBestOffers
2802             Returned: Always
2803             Details: DetailLevel: none, ReturnAll
2804              
2805             Calls: GetBidderList
2806             GetDispute
2807             Returned: Always
2808              
2809             Calls: GetItem
2810             Returned: Always
2811             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
2812              
2813             Calls: GetSellerEvents
2814             Returned: Conditionally
2815             Details: DetailLevel: none, ReturnAll
2816              
2817             Calls: GetSearchResults
2818             Returned: Conditionally
2819             Details: DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll
2820             GranularityLevel: Coarse
2821              
2822              
2823             Calls: GetCategoryListings
2824             GetItemsAwaitingFeedback
2825             GetMemberMessages
2826             GetProducts
2827             Returned: Conditionally
2828              
2829             Calls: GetMyeBayBuying
2830             Returned: Conditionally
2831             Details: DetailLevel: none, ReturnSummary, ReturnAll
2832             Context: BestOfferList
2833             BidList
2834             LostList
2835             SecondChanceOffer
2836             WatchList
2837             WonList
2838             DeletedFromWonList
2839             DeletedFromLostList
2840              
2841             Calls: GetMyeBaySelling
2842             Returned: Conditionally
2843             Details: DetailLevel: none, ReturnSummary, ReturnAll
2844             Context: ActiveList
2845             BidList
2846             ScheduledList
2847             SoldList
2848             UnsoldList
2849             DeletedFromSoldList
2850             DeletedFromUnsoldList
2851              
2852             Calls: GetItemTransactions
2853             GetSellerTransactions
2854             Returned: Conditionally
2855             Details: DetailLevel: ReturnAll
2856              
2857             Calls: GetSellerList
2858             Returned: Conditionally
2859             Details: DetailLevel: none, ItemReturnDescription, ReturnAll
2860             GranularityLevel: Coarse, Medium, Fine
2861              
2862              
2863             # Returns: 'ns:ListingDetailsType'
2864              
2865             =cut
2866              
2867             sub getListingDetails {
2868             my $self = shift;
2869             return $self->_getDataTypeInstance( 'ListingDetails'
2870             ,'eBay::API::XML::DataType::ListingDetailsType');
2871             }
2872              
2873              
2874             =head2 setListingDuration()
2875              
2876             Describes the number of days the seller wants the listing to be active
2877             (available for bidding/buying).
2878             The duration specifies the seller's initial
2879             intent at listing time. The end time for a listing is calculated by
2880             adding the duration to the item's start time.
2881             If the listing ends early, the value of the
2882             listing duration does not change. When a listing's duration is changed,
2883             any related fees (e.g., 10-day fee) may be debited or credited
2884             (as applicable).
2885            
2886             The valid choice of values depends on the listing format
2887             (see Item.ListingType).
2888             For a list of valid values, call GetCategoryFeatures with DetailLevel
2889             set to ReturnAll and look for ListingDurations information.
2890            
2891             Also required for Half.com (but only specify GTC).
2892            
2893             When you revise a listing, the duration cannot be reduced if it
2894             will result in ending the listing within 24 hours of the current
2895             date-time.
2896             You are only allowed to increase the duration of the listing if fewer
2897             than 2 hours have passed since you initially listed the item and the listing
2898             has no bids. You can decrease the value of this field only if the listing
2899             has no bids (or no items have sold) and the listing does not end within 12 hours.
2900              
2901             SeeLink: URL: GetCategoryFeatures.html#Response.FeatureDefinitions.ListingDurations
2902             Title: GetCategoryFeatures
2903             , URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=FeesPerSite
2904             Title: Fees per Site
2905              
2906              
2907             Calls: AddItem
2908             VerifyAddItem
2909             RequiredInput: Yes
2910              
2911             Calls: GetItemRecommendations
2912             RelistItem
2913             ReviseItem
2914             RequiredInput: No
2915              
2916             # Argument: 'xs:token'
2917              
2918             =cut
2919              
2920             sub setListingDuration {
2921             my $self = shift;
2922             $self->{'ListingDuration'} = shift
2923             }
2924              
2925             =head2 getListingDuration()
2926              
2927             Calls: GetSearchResults
2928             Returned: Conditionally
2929             Details: DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll
2930             GranularityLevel: Coarse
2931              
2932              
2933             Calls: GetBidderList
2934             GetProducts
2935             Returned: Conditionally
2936              
2937             Calls: GetSellerList
2938             Returned: Conditionally
2939             Details: DetailLevel: ItemReturnDescription, ReturnAll
2940              
2941             Calls: GetItem
2942             Returned: Conditionally
2943             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
2944              
2945             Calls: GetMyeBaySelling
2946             Returned: Conditionally
2947             Details: DetailLevel: none, ReturnSummary, ReturnAll
2948             Context: ScheduledList
2949              
2950             # Returns: 'xs:token'
2951              
2952             =cut
2953              
2954             sub getListingDuration {
2955             my $self = shift;
2956             return $self->{'ListingDuration'};
2957             }
2958              
2959              
2960             =head2 setListingEnhancement()
2961              
2962             Describes listing upgrades that sellers can select for a fee, such as the
2963             BoldTitle upgrade. Also includes feature packs for saving on listing upgrades.
2964             See Listing Upgrades
2965             in the eBay Web site online help.
2966            

2967             You cannot remove listing upgrades when you revise a listing. When you
2968             relist an item, use DeletedField to remove a listing upgrades.
2969            

2970             For AddLiveAuctionItem and ReviseLiveAuctionItem, you can specify a maximum of
2971             10 featured lot items per live auction catalog.
2972             Not applicable to Half.com.
2973             This field is ignored when Item.ListingType=Express.
2974              
2975             Calls: AddItem
2976             GetItemRecommendations
2977             RelistItem
2978             ReviseItem
2979             VerifyAddItem
2980             RequiredInput: No
2981              
2982             Calls: AddLiveAuctionItem
2983             ReviseLiveAuctionItem
2984             RequiredInput: No
2985             OnlyTheseValues: Border, BoldTitle, Featured, Highlight,
2986             HomePageFeatured
2987              
2988             # Argument: reference to an array
2989             of 'ns:ListingEnhancementsCodeType'
2990              
2991             =cut
2992              
2993             sub setListingEnhancement {
2994             my $self = shift;
2995             $self->{'ListingEnhancement'} =
2996             $self->convertArray_To_RefToArrayIfNeeded(@_);
2997             }
2998              
2999             =head2 getListingEnhancement()
3000              
3001             Calls: GetSellerList
3002             Returned: Conditionally
3003             Details: DetailLevel: ItemReturnDescription, ReturnAll
3004              
3005             Calls: GetSearchResults
3006             Returned: Conditionally
3007             Details: DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll
3008              
3009             Calls: GetBidderList
3010             GetCategoryListings
3011             GetProducts
3012             Returned: Conditionally
3013              
3014             Calls: GetItem
3015             Returned: Conditionally
3016             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
3017              
3018             # Returns: reference to an array
3019             of 'ns:ListingEnhancementsCodeType'
3020              
3021             =cut
3022              
3023             sub getListingEnhancement {
3024             my $self = shift;
3025             return $self->_getDataTypeArray('ListingEnhancement');
3026             }
3027              
3028              
3029             =head2 setListingSubtype2()
3030              
3031             Indicates a specific type of lead generation format listing, such as classified
3032             ad or local market best offer listing.
3033             Only applicable when ListingType=LeadGeneration.
3034             Note:
3035             ListingSubtype2 replaces the deprecated ListingSubtype field.
3036             If both are specified in a request, ListingSubtype2 takes precedence.
3037              
3038             SeeLink: URL: http://pages.ebay.com/help/sell/motors-selling-locally.html
3039             Title: About Local Market Listings
3040             , URL: http://pages.ebay.com/help/sell/f-ad.html
3041             Title: Advertising with Classified Ads
3042              
3043              
3044             Calls: AddItem
3045             RelistItem
3046             ReviseItem
3047             RequiredInput: No
3048              
3049             # Argument: 'ns:ListingSubtypeCodeType'
3050              
3051             =cut
3052              
3053             sub setListingSubtype2 {
3054             my $self = shift;
3055             $self->{'ListingSubtype2'} = shift
3056             }
3057              
3058             =head2 getListingSubtype2()
3059              
3060             Calls: GetItem
3061             Returned: Conditionally
3062             Details: DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
3063              
3064             Calls: GetSellerList
3065             Returned: Conditionally
3066             Details: DetailLevel: ItemReturnDescription, ReturnAll
3067              
3068             # Returns: 'ns:ListingSubtypeCodeType'
3069              
3070             =cut
3071              
3072             sub getListingSubtype2 {
3073             my $self = shift;
3074             return $self->{'ListingSubtype2'};
3075             }
3076              
3077              
3078             =head2 setListingType()
3079              
3080             The format of the listing the seller wants to use, such as
3081             Chinese auction or fixed price.
3082            
3083             Optional for eBay.com listings (defaults to Chinese) in AddItem and
3084             VerifyAddItem. On the US, Germany, and UK sites, eligible items listed
3085             in the fixed price, Store Inventory, or (for the US) in the
3086             Chinese auction format with Buy It Now are also included on
3087             eBay Express. Express Germany and UK also support an Express format
3088             for listing only on Express.
3089            
3090             Do not specify ListingType for eBay.com listings in ReviseItem.
3091             (You can't modify the listing type of an active eBay listing.
3092            
3093             Required for Half.com listings (and the value must be Half) in AddItem,
3094             VerifyAddItem, and ReviseItem. If you don't specify Half when revising
3095             Half.com listings, ReviseItem won't use the correct logic and you may
3096             get strange errors (or unwanted side effects in the listing, even if no
3097             errors are returned).
3098              
3099             SeeLink: URL: http://pages.ebay.com/help/sell/ia/formats.html
3100             Title: Different Ways of Selling
3101             , URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ListingTypes
3102             Title: Listing Types (Formats)
3103             , URL: GetCategoryFeatures.html#Response.FeatureDefinitions.ListingDurations
3104             Title: GetCategoryFeatures
3105             , URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=FeesPerSite
3106             Title: Fees per Site
3107             , URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ExpressListingCriteria
3108             Title: Listing Criteria for eBay Express
3109              
3110              
3111             Calls: AddItem
3112             GetItemRecommendations
3113             RelistItem
3114             VerifyAddItem
3115             RequiredInput: Conditionally
3116             AllValuesExcept: Unknown, Live, Auction, PersonalOffer, Shopping
3117              
3118             Calls: ReviseItem
3119             RequiredInput: Conditionally
3120             OnlyTheseValues: Half
3121             TheseAreas: half
3122              
3123             # Argument: 'ns:ListingTypeCodeType'
3124              
3125             =cut
3126              
3127             sub setListingType {
3128             my $self = shift;
3129             $self->{'ListingType'} = shift
3130             }
3131              
3132             =head2 getListingType()
3133              
3134             Calls: GetBidderList
3135             Returned: Always
3136             AllValuesExcept: Unknown, Auction, Half, PersonalOffer
3137              
3138             Calls: GetItem
3139             Returned: Always
3140             AllValuesExcept: Unknown, Auction, Half
3141             Details: DetailLevel: none, ItemReturnDescription,
3142             ItemReturnAttributes, ReturnAll
3143              
3144             Calls: GetSellerList
3145             Returned: Conditionally
3146             AllValuesExcept: Unknown, Auction, Half, PersonalOffer, Shopping
3147             Details: DetailLevel: ItemReturnDescription, ReturnAll
3148              
3149             Calls: GetItemTransactions
3150             GetSellerTransactions
3151             Returned: Always
3152             AllValuesExcept: Unknown, Auction, Half, Shopping
3153             Details: DetailLevel: none, ItemReturnDescription, ReturnAll
3154              
3155             Calls: GetOrderTransactions
3156             Returned: Always
3157             AllValuesExcept: Unknown, Auction, Half, Shopping
3158             Details: DetailLevel: none, ItemReturnDescription, ReturnAll
3159              
3160             Calls: GetSearchResults
3161             Returned: Conditionally
3162             AllValuesExcept: Unknown, Auction, Half, PersonalOffer, Shopping
3163             Details: DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll
3164             GranularityLevel: Coarse
3165              
3166              
3167             Calls: GetCategoryListings
3168             GetProducts
3169             Returned: Conditionally
3170             AllValuesExcept: Unknown, Auction, Half, PersonalOffer
3171              
3172             Calls: GetMyeBayBuying
3173             Returned: Conditionally
3174             AllValuesExcept: Unknown, Auction, Half
3175             Details: DetailLevel: none, ReturnSummary, ReturnAll
3176             Context: BidList
3177             LostList
3178             WatchList
3179             WonList
3180             DeletedFromWonList
3181             DeletedFromLostList
3182              
3183             Calls: GetMyeBaySelling
3184             Returned: Conditionally
3185             AllValuesExcept: Unknown, Auction, Half
3186             Details: DetailLevel: none, ReturnSummary, ReturnAll
3187             Context: ActiveList
3188             ScheduledList
3189             SoldList
3190             UnsoldList
3191             DeletedFromSoldList
3192             DeletedFromUnsoldList
3193              
3194             Calls: GetMyeBaySelling
3195             Returned: Conditionally
3196             AllValuesExcept: Unknown, Auction, Half
3197             Details: DetailLevel: none, ReturnSummary, ReturnAll
3198             Context: BidList
3199              
3200             Calls: GetSellerEvents
3201             Returned: Conditionally
3202             AllValuesExcept: Unknown, Auction, Half, Shopping
3203             Details: DetailLevel: ReturnAll
3204              
3205             # Returns: 'ns:ListingTypeCodeType'
3206              
3207             =cut
3208              
3209             sub getListingType {
3210             my $self = shift;
3211             return $self->{'ListingType'};
3212             }
3213              
3214              
3215             =head2 setLiveAuctionDetails()
3216              
3217             Describes the live auction-specific details of a lot item.
3218             Applicable to eBay Live Auctions only.
3219              
3220             Calls: AddLiveAuctionItem
3221             ReviseLiveAuctionItem
3222             RequiredInput: Yes
3223              
3224             # Argument: 'ns:LiveAuctionDetailsType'
3225              
3226             =cut
3227              
3228             sub setLiveAuctionDetails {
3229             my $self = shift;
3230             $self->{'LiveAuctionDetails'} = shift
3231             }
3232              
3233             =head2 getLiveAuctionDetails()
3234              
3235             # Returns: 'ns:LiveAuctionDetailsType'
3236              
3237             =cut
3238              
3239             sub getLiveAuctionDetails {
3240             my $self = shift;
3241             return $self->_getDataTypeInstance( 'LiveAuctionDetails'
3242             ,'eBay::API::XML::DataType::LiveAuctionDetailsType');
3243             }
3244              
3245              
3246             =head2 setLocalListing()
3247              
3248             Indicates, when true, that an item is available locally.
3249              
3250             # Argument: 'xs:boolean'
3251              
3252             =cut
3253              
3254             sub setLocalListing {
3255             my $self = shift;
3256             $self->{'LocalListing'} = shift
3257             }
3258              
3259             =head2 isLocalListing()
3260              
3261             Calls: GetSearchResults
3262             Returned: Conditionally
3263             Details: DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll
3264              
3265             Calls: GetCategoryListings
3266             Returned: Conditionally
3267              
3268             # Returns: 'xs:boolean'
3269              
3270             =cut
3271              
3272             sub isLocalListing {
3273             my $self = shift;
3274             return $self->{'LocalListing'};
3275             }
3276              
3277              
3278             =head2 setLocation()
3279              
3280             Indicates the geographical location of the item (along with Country).
3281             When you revise a listing, you can add or change this value only if the
3282             listing has no bids (or no items have sold) and it does not end within
3283             12 hours.
3284            

3285             If you do not specify Location, you must specify Item.PostalCode. If you
3286             specify a postal code, but do not specify a location, then the location is
3287             given a default value derived from the postal code.
3288            

3289             For the Classified Ad format for eBay Motors vehicles, the value
3290             provided in the Location is used as item location only if the
3291             SellerContactDetails.Street and the SellerContactDetails.Street2 are empty.
3292             Else, the SellerContactDetails.Street and the SellerContactDetails.Street2
3293             will be used for item location.
3294            

3295             Also applicable as input to AddItem and related calls when you list items
3296             to Half.com.
3297              
3298             MaxLength: 45
3299              
3300             Calls: AddItem
3301             GetItemRecommendations
3302             RelistItem
3303             ReviseItem
3304             VerifyAddItem
3305             RequiredInput: Conditionally
3306              
3307             # Argument: 'xs:string'
3308              
3309             =cut
3310              
3311             sub setLocation {
3312             my $self = shift;
3313             $self->{'Location'} = shift
3314             }
3315              
3316             =head2 getLocation()
3317              
3318             Calls: GetBidderList
3319             Returned: Always
3320              
3321             Calls: GetItem
3322             Returned: Always
3323             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
3324              
3325             Calls: GetSellerList
3326             Returned: Conditionally
3327             Details: DetailLevel: ItemReturnDescription, ReturnAll
3328             GranularityLevel: Coarse, Medium, Fine
3329              
3330              
3331             Calls: GetCategoryListings
3332             GetProducts
3333             Returned: Conditionally
3334              
3335             # Returns: 'xs:string'
3336              
3337             =cut
3338              
3339             sub getLocation {
3340             my $self = shift;
3341             return $self->{'Location'};
3342             }
3343              
3344              
3345             =head2 setLocationDefaulted()
3346              
3347             True if eBay provided a central location as a result of the user
3348             not specifying a location. This typically occurs when the seller
3349             specifies PostalCode without Location.
3350             Not applicable to Half.com.
3351              
3352             # Argument: 'xs:boolean'
3353              
3354             =cut
3355              
3356             sub setLocationDefaulted {
3357             my $self = shift;
3358             $self->{'LocationDefaulted'} = shift
3359             }
3360              
3361             =head2 isLocationDefaulted()
3362              
3363             Calls: GetBidderList
3364             Returned: Conditionally
3365              
3366             Calls: GetItem
3367             Returned: Conditionally
3368             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
3369              
3370             # Returns: 'xs:boolean'
3371              
3372             =cut
3373              
3374             sub isLocationDefaulted {
3375             my $self = shift;
3376             return $self->{'LocationDefaulted'};
3377             }
3378              
3379              
3380             =head2 setLookupAttributeArray()
3381              
3382             Use this as a shortcut for specifying the Condition attribute by name
3383             instead of by ID. Only valid when using AddItem for items in Media categories
3384             (Books, DVD and Movies, Music, and Video Game categories) on the eBay US site (site ID 0).
3385             You can pass either AttributeSetArray or LookupAttributeArray, but you cannot pass
3386             both in the same request. Typically used in combination with ExternalProductID.
3387             Not applicable to Half.com.
3388              
3389             Calls: AddItem
3390             GetItemRecommendations
3391             RelistItem
3392             VerifyAddItem
3393             RequiredInput: No
3394              
3395             # Argument: 'ns:LookupAttributeArrayType'
3396              
3397             =cut
3398              
3399             sub setLookupAttributeArray {
3400             my $self = shift;
3401             $self->{'LookupAttributeArray'} = shift
3402             }
3403              
3404             =head2 getLookupAttributeArray()
3405              
3406             # Returns: 'ns:LookupAttributeArrayType'
3407              
3408             =cut
3409              
3410             sub getLookupAttributeArray {
3411             my $self = shift;
3412             return $self->_getDataTypeInstance( 'LookupAttributeArray'
3413             ,'eBay::API::XML::DataType::LookupAttributeArrayType');
3414             }
3415              
3416              
3417             =head2 setLotSize()
3418              
3419             A lot is a set of two or more similar items that must be purchased together in
3420             a single transaction. A listing can have multiple lots (instead of multiple
3421             items). When LotSize is specified, the listing price reflects the price of
3422             each lot (not each item within the lot). In this case, Quantity indicates the
3423             number of lots being listed, and LotSize indicates the number of items in each
3424             lot. (If a listing has no lots, Quantity indicates the number of separate
3425             items being listed.) Important: Lot items can be listed only in lot-enabled
3426             categories. GetCategories returns LSD (lot size disabled) with a value of true
3427             for categories that do not support lots.
3428             Not applicable to Half.com.
3429             This field is ignored when Item.ListingType=Express.
3430              
3431             Max: 100000
3432              
3433             Calls: AddItem
3434             GetItemRecommendations
3435             RelistItem
3436             ReviseItem
3437             VerifyAddItem
3438             RequiredInput: No
3439              
3440             # Argument: 'xs:int'
3441              
3442             =cut
3443              
3444             sub setLotSize {
3445             my $self = shift;
3446             $self->{'LotSize'} = shift
3447             }
3448              
3449             =head2 getLotSize()
3450              
3451             Calls: GetBidderList
3452             Returned: Conditionally
3453              
3454             Calls: GetItem
3455             Returned: Conditionally
3456             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
3457              
3458             Calls: GetItemTransactions
3459             GetSellerTransactions
3460             Returned: Conditionally
3461             Details: DetailLevel: ReturnAll
3462              
3463             # Returns: 'xs:int'
3464              
3465             =cut
3466              
3467             sub getLotSize {
3468             my $self = shift;
3469             return $self->{'LotSize'};
3470             }
3471              
3472              
3473             =head2 setMechanicalCheckAccepted()
3474              
3475             Indicates whether the seller allows the bidder to request mechanical
3476             inspection services from RAC. For Car category listings on the UK site.
3477              
3478             Default: false
3479              
3480             # Argument: 'xs:boolean'
3481              
3482             =cut
3483              
3484             sub setMechanicalCheckAccepted {
3485             my $self = shift;
3486             $self->{'MechanicalCheckAccepted'} = shift
3487             }
3488              
3489             =head2 isMechanicalCheckAccepted()
3490              
3491             Calls: GetItem
3492             Returned: Conditionally
3493              
3494             # Returns: 'xs:boolean'
3495              
3496             =cut
3497              
3498             sub isMechanicalCheckAccepted {
3499             my $self = shift;
3500             return $self->{'MechanicalCheckAccepted'};
3501             }
3502              
3503              
3504             =head2 setMotorsGermanySearchable()
3505              
3506             Listing upgrade that features the item in eBay search results on
3507             the mobile.de partner site. Applicable to eBay Germany.
3508             If true in listing requests and responses,
3509             the seller is purchasing or has purchased cross-promotional placement on
3510             the mobile.de site.
3511             See the eBay Web Services Guide for applicable categories,
3512             revise and relist rules, and additional information on featuring
3513             vehicles on the Mobile.de Site.
3514             Not applicable to Half.com.
3515              
3516             Calls: AddItem
3517             GetItemRecommendations
3518             RelistItem
3519             ReviseItem
3520             VerifyAddItem
3521             RequiredInput: No
3522              
3523             # Argument: 'xs:boolean'
3524              
3525             =cut
3526              
3527             sub setMotorsGermanySearchable {
3528             my $self = shift;
3529             $self->{'MotorsGermanySearchable'} = shift
3530             }
3531              
3532             =head2 isMotorsGermanySearchable()
3533              
3534             Calls: GetSellerList
3535             Returned: Conditionally
3536             Details: DetailLevel: ItemReturnDescription, ReturnAll
3537              
3538             Calls: GetBidderList
3539             GetCategoryListings
3540             Returned: Conditionally
3541              
3542             Calls: GetItem
3543             Returned: Conditionally
3544             Details: DetailLevel: ItemReturnAttributes, ItemReturnDescription, none, ReturnAll
3545              
3546             Calls: GetSearchResults
3547             Returned: Conditionally
3548             Details: DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll
3549              
3550             # Returns: 'xs:boolean'
3551              
3552             =cut
3553              
3554             sub isMotorsGermanySearchable {
3555             my $self = shift;
3556             return $self->{'MotorsGermanySearchable'};
3557             }
3558              
3559              
3560             =head2 setNewLeadCount()
3561              
3562             Specifies the number of new leads (unanswered emails) buyers have posted
3563             about the item.
3564              
3565             Calls: GetMyeBaySelling
3566             RequiredInput: Conditionally
3567              
3568             # Argument: 'xs:int'
3569              
3570             =cut
3571              
3572             sub setNewLeadCount {
3573             my $self = shift;
3574             $self->{'NewLeadCount'} = shift
3575             }
3576              
3577             =head2 getNewLeadCount()
3578              
3579             # Returns: 'xs:int'
3580              
3581             =cut
3582              
3583             sub getNewLeadCount {
3584             my $self = shift;
3585             return $self->{'NewLeadCount'};
3586             }
3587              
3588              
3589             =head2 setNowAndNew()
3590              
3591             If true in listing requests and responses, the item is listed with
3592             Now and New. Only applicable to Buy It Now, fixed-price, and
3593             Store Inventory listings on certain eBay sites.
3594             See the eBay Web Services guide for details.
3595             In requests that list items, only valid if the seller also specifies
3596             the item condition (as new), predefined return policy attributes,
3597             a buy it now or fixed price, and shipping costs.
3598             To remove Now and New from a listing, set the value to false.
3599             If the listing has bids (or items have been sold) or the listing
3600             ends within 12 hours, you cannot add or remove NowAndNew
3601             when you revise the listing.
3602             Not applicable to Half.com.
3603              
3604             SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=MiscellaneousItemFieldDifferences
3605             Title: Miscellaneous Item Field Differences
3606              
3607             Calls: AddItem
3608             GetItemRecommendations
3609             ReviseItem
3610             RelistItem
3611             VerifyAddItem
3612             RequiredInput: No
3613              
3614             # Argument: 'xs:boolean'
3615              
3616             =cut
3617              
3618             sub setNowAndNew {
3619             my $self = shift;
3620             $self->{'NowAndNew'} = shift
3621             }
3622              
3623             =head2 isNowAndNew()
3624              
3625             Calls: GetBidderList
3626             Returned: Conditionally
3627              
3628             Calls: GetItem
3629             Returned: Conditionally
3630             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
3631              
3632             Calls: GetSellerList
3633             Returned: Conditionally
3634             Details: DetailLevel: ItemReturnDescription, ReturnAll
3635              
3636             # Returns: 'xs:boolean'
3637              
3638             =cut
3639              
3640             sub isNowAndNew {
3641             my $self = shift;
3642             return $self->{'NowAndNew'};
3643             }
3644              
3645              
3646             =head2 setPartnerCode()
3647              
3648             Not currently operational.
3649              
3650             # Argument: 'xs:string'
3651              
3652             =cut
3653              
3654             sub setPartnerCode {
3655             my $self = shift;
3656             $self->{'PartnerCode'} = shift
3657             }
3658              
3659             =head2 getPartnerCode()
3660              
3661             # Returns: 'xs:string'
3662              
3663             =cut
3664              
3665             sub getPartnerCode {
3666             my $self = shift;
3667             return $self->{'PartnerCode'};
3668             }
3669              
3670              
3671             =head2 setPartnerName()
3672              
3673             Not currently operational.
3674              
3675             # Argument: 'xs:string'
3676              
3677             =cut
3678              
3679             sub setPartnerName {
3680             my $self = shift;
3681             $self->{'PartnerName'} = shift
3682             }
3683              
3684             =head2 getPartnerName()
3685              
3686             # Returns: 'xs:string'
3687              
3688             =cut
3689              
3690             sub getPartnerName {
3691             my $self = shift;
3692             return $self->{'PartnerName'};
3693             }
3694              
3695              
3696             =head2 setPayPalEmailAddress()
3697              
3698             Valid PayPal email address for the PayPal account that the seller will use if
3699             they offer PayPal as a payment method for the listing. eBay uses this to
3700             identify the correct PayPal account when the buyer pays via PayPal during the
3701             checkout process. (As a seller can have more than one PayPal account, you
3702             cannot necessarily rely on PayPal account data returned from GetUser for
3703             details about the account associated with the PayPal email address that the
3704             seller specifies.)
3705            
3706             Required if seller has chosen PayPal as a payment method (PaymentMethods) for
3707             the listing.
3708            
3709             For a listing to be eligible for Express US, the seller needs to use an email
3710             address that is in good standing and that is associated with a PayPal Premier
3711             or PayPal business account that is set to ship to unconfirmed addresses. For
3712             Express Germany, PayPalEmailAddress must be specified for Express format
3713             listings, but it is optional for other formats (as
3714             long as an eligible default PayPal account is specified in the seller's
3715             Express preferences). If the specified PayPal account becomes ineligible for
3716             eBay Express payments (because the seller blocked unconfirmed addresses or
3717             some other change occurred), the items associated with that account may become
3718             ineligible for Express and may no longer appear on Express.
3719            

3720             Note:
3721             At the end of April 2008, UK and Germany eBay Express will be shutdown. No
3722             users will be eligible to list on these sites. All users previously registered
3723             on UK and Germany Express will have their registered status revoked. Any
3724             Express only items listed on these sites will be ended and credited the full
3725             insertion fee to their sellers. Please refer to the respective Express sites
3726             for more information.
3727            
3728            

3729             See eBay Express information in the eBay Web Services Guide for more
3730             information.
3731            
3732             For digital listings, the seller needs to use an email address that is
3733             associated with a PayPal Premier or PayPal business account.
3734            
3735             For ReviseItem and RelistItem only:
3736             To remove this value when you revise or relist an item, use DeletedField. When
3737             you revise a listing, if the listing has bids (or items have been sold) or it
3738             ends within 12 hours, you can add PayPalEmailAddress, but you cannot remove
3739             it.
3740            
3741             Not applicable to eBay Motors listings. Also not applicable to Half.com.
3742              
3743             SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ListingAnItem
3744             Title: Listing an Item
3745             , URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ExpressPaymentMethods
3746             Title: Accept PayPal as a Payment Method for Express and eBay
3747             , URL: SetUserPreferences.html#Request.SellerPaymentPreferences
3748             Title: (SetUserPreferences) SellerPaymentPreferences
3749             , URL: SetUserPreferences.html#Request.ExpressPreferences.DefaultPayPalAccount
3750             Title: (SetUserPreferences) ExpressPreferences.DefaultPayPalAccount
3751              
3752              
3753             Calls: AddItem
3754             GetItemRecommendations
3755             RelistItem
3756             ReviseItem
3757             VerifyAddItem
3758             RequiredInput: Conditionally
3759              
3760             # Argument: 'xs:string'
3761              
3762             =cut
3763              
3764             sub setPayPalEmailAddress {
3765             my $self = shift;
3766             $self->{'PayPalEmailAddress'} = shift
3767             }
3768              
3769             =head2 getPayPalEmailAddress()
3770              
3771             Calls: GetBidderList
3772             Returned: Conditionally
3773              
3774             Calls: GetItem
3775             Returned: Conditionally
3776             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
3777              
3778             # Returns: 'xs:string'
3779              
3780             =cut
3781              
3782             sub getPayPalEmailAddress {
3783             my $self = shift;
3784             return $self->{'PayPalEmailAddress'};
3785             }
3786              
3787              
3788             =head2 setPaymentDetails()
3789              
3790             Contains data associated with eBay Motors payments (Durations for deposit and
3791             full payments). Returned for Motors listings. Not applicable to Half.com.
3792              
3793             SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=MotorsPayment
3794             Title: Payment Methods for Motors
3795              
3796             Calls: AddItem
3797             GetItemRecommendations
3798             RelistItem
3799             ReviseItem
3800             VerifyAddItem
3801             RequiredInput: No
3802              
3803             # Argument: 'ns:PaymentDetailsType'
3804              
3805             =cut
3806              
3807             sub setPaymentDetails {
3808             my $self = shift;
3809             $self->{'PaymentDetails'} = shift
3810             }
3811              
3812             =head2 getPaymentDetails()
3813              
3814             Calls: GetBidderList
3815             Returned: Conditionally
3816              
3817             Calls: GetItem
3818             Returned: Conditionally
3819             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
3820              
3821             # Returns: 'ns:PaymentDetailsType'
3822              
3823             =cut
3824              
3825             sub getPaymentDetails {
3826             my $self = shift;
3827             return $self->_getDataTypeInstance( 'PaymentDetails'
3828             ,'eBay::API::XML::DataType::PaymentDetailsType');
3829             }
3830              
3831              
3832             =head2 setPaymentMethods()
3833              
3834             Identifies the payment method (such as credit card or PayPal) the seller will
3835             accept for the buyer to pay for the purchase of the item.

3836             If you specify multiple PaymentMethods fields, the repeating fields must be
3837             contiguous. For example, you can specify PayPalEmailAddress after a list of
3838             repeating PaymentMethods fields, but not between them:
3839            
3840             <PaymentMethods>AmEx</PaymentMethods>
3841             <PaymentMethods>PersonalCheck</PaymentMethods>
3842             <PaymentMethods>PayPal</PaymentMethods>
3843             <PayPalEmailAddress>mypaypalemail@ebay.com</PayPalEmailAddress>

3844             In general, if you separate repeating instances of a field, the results will
3845             be unpredictable. This rule applies to all repeating fields
3846             (maxOccurs="unbounded" or greater than 1) in the schema. See "Overview of the
3847             Schema" in the eBay Web Services guide.
3848            
3849             Note:
3850             Required or allowed payment methods vary by site and category. Refer to
3851            
3852             Payment Method Differences (PaymentMethod) in the eBay Trading
3853             API Guide for information to help you determine which payment methods you
3854             are required or allowed to specify.
3855            
3856            
3857             For a listing to be eligible for Express US, PayPal is a required payment
3858             method. For Express Germany, Express format listings
3859             (Item.ListingType=Express) must include PayPal, but
3860             fixed-price and Store Inventory listings do not require PayPal
3861             as long as a default PayPal account is specified in the seller's Express preferences. See
3862             eBay Express information in the eBay Web Services Guide.
3863            
3864            
3865             Payment methods are not applicable to eBay Real Estate ad format listings,
3866             Classified Ad format listings, or Half.com.
3867            

3868             Note:
3869             At the end of April 2008, UK and Germany eBay Express will be shutdown. No
3870             users will be eligible to list on these sites. All users previously registered
3871             on UK and Germany Express will have their registered status revoked. Any
3872             Express only items listed on these sites will be ended and credited the full
3873             insertion fee to their sellers. Please refer to the respective Express sites
3874             for more information.
3875            
3876            
3877            
3878             For ReviseItem and RelistItem only:
3879             A listing must have at least one valid payment method.
3880             When you revise or relist an item and you specify a payment method
3881             that is invalid for the target site, eBay ignores the
3882             invalid payment method, applies the other valid
3883             changes, and returns a warning to indicate that the
3884             invalid payment method was ignored. If multiple payment methods were
3885             invalid, the warning indicates that they were all ignored.
3886             If you modify the listing so that it includes no valid
3887             payment methods, an error is returned. This situation could occur when
3888             the seller removes all valid payment methods or when all
3889             the payment methods specified for the item are no longer valid
3890             on the target site.
3891            
For GetProducts only: Only PayPal is
3892             returned in product search results.
3893              
3894             SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=PaymentMethodDifferences
3895             Title: Payment Method Differences (PaymentMethod)
3896             , URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ListingAnItem
3897             Title: Listing an Item
3898             , URL: SetUserPreferences.html#Request.SellerPaymentPreferences
3899             Title: (SetUserPreferences) SellerPaymentPreferences
3900             , URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ExpressPaymentMethods
3901             Title: Accept PayPal as a Payment Method for Express and eBay
3902             , URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SchemaOverview
3903             For: rules regarding repeating nodes
3904             Title: Overview of the API Schema
3905              
3906              
3907             Calls: AddItem
3908             VerifyAddItem
3909             RequiredInput: Conditionally
3910              
3911             Calls: GetItemRecommendations
3912             RelistItem
3913             ReviseItem
3914             RequiredInput: Conditionally
3915              
3916             # Argument: reference to an array
3917             of 'ns:BuyerPaymentMethodCodeType'
3918              
3919             =cut
3920              
3921             sub setPaymentMethods {
3922             my $self = shift;
3923             $self->{'PaymentMethods'} =
3924             $self->convertArray_To_RefToArrayIfNeeded(@_);
3925             }
3926              
3927             =head2 getPaymentMethods()
3928              
3929             Calls: GetBidderList
3930             Returned: Always
3931              
3932             Calls: GetItem
3933             Returned: Always
3934             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
3935              
3936             Calls: GetItemTransactions
3937             GetSellerTransactions
3938             Returned: Always
3939             Details: DetailLevel: none, ReturnAll
3940              
3941             Calls: GetSellerList
3942             Returned: Conditionally
3943             Details: DetailLevel: ItemReturnDescription, ReturnAll
3944             GranularityLevel: Fine
3945              
3946              
3947             Calls: GetSearchResults
3948             Returned: Conditionally
3949             Details: DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll
3950              
3951             Calls: GetProducts
3952             Returned: Conditionally
3953             OnlyTheseValues: PayPal
3954              
3955             # Returns: reference to an array
3956             of 'ns:BuyerPaymentMethodCodeType'
3957              
3958             =cut
3959              
3960             sub getPaymentMethods {
3961             my $self = shift;
3962             return $self->_getDataTypeArray('PaymentMethods');
3963             }
3964              
3965              
3966             =head2 setPictureDetails()
3967              
3968             Contains the data for a picture associated with an item.
3969            
3970             For a listing to be eligible for eBay Express, it must include a picture,
3971             gallery, or stock photo URL. Some categories are exempt from this requirement.
3972             See the eBay Web Services Guide links below for details.
3973            
3974             Not applicable to Half.com.
3975            
3976             Note:
3977             PictureDetails replaces the deprecated SiteHostedPicture
3978             and VendorHostedPicture in the response with request version 439
3979             or greater. As SiteHostedPicture and VendorHostedPicture are also
3980             no longer recommended on input, applications should use
3981             PictureDetails in the input as well. If SiteHostedPicture or
3982             VendorHostedPicture are passed in with PictureDetails, PictureDetails takes
3983             precedence.
3984              
3985             SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Pictures
3986             Title: Introduction to Pictures in Item Listings
3987             , URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ExpressPictureRequired
3988             Title: Specify a Picture for Express and eBay
3989              
3990              
3991             Calls: AddItem
3992             AddLiveAuctionItem
3993             GetItemRecommendations
3994             RelistItem
3995             ReviseItem
3996             ReviseLiveAuctionItem
3997             VerifyAddItem
3998             RequiredInput: No
3999              
4000             # Argument: 'ns:PictureDetailsType'
4001              
4002             =cut
4003              
4004             sub setPictureDetails {
4005             my $self = shift;
4006             $self->{'PictureDetails'} = shift
4007             }
4008              
4009             =head2 getPictureDetails()
4010              
4011             Calls: GetBidderList
4012             GetCategoryListings
4013             GetProducts
4014             Returned: Conditionally
4015              
4016             Calls: GetSearchResults
4017             Returned: Conditionally
4018             Details: DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll
4019             GranularityLevel: Coarse
4020              
4021              
4022             Calls: GetMyeBayBuying
4023             Returned: Conditionally
4024             Details: DetailLevel: none, ReturnSummary, ReturnAll
4025             Context: BestOfferList
4026             BidList
4027             SecondChanceOffer
4028             WatchList
4029              
4030             Calls: GetMyeBaySelling
4031             Returned: Conditionally
4032             Details: DetailLevel: none, ReturnSummary, ReturnAll
4033             Context: ActiveList
4034             ScheduledList
4035             SoldList
4036             UnsoldList
4037             DeletedFromSoldList
4038             DeletedFromUnsoldList
4039             BidList
4040              
4041             Calls: GetItem
4042             Returned: Conditionally
4043             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
4044              
4045             # Returns: 'ns:PictureDetailsType'
4046              
4047             =cut
4048              
4049             sub getPictureDetails {
4050             my $self = shift;
4051             return $self->_getDataTypeInstance( 'PictureDetails'
4052             ,'eBay::API::XML::DataType::PictureDetailsType');
4053             }
4054              
4055              
4056             =head2 setPostalCode()
4057              
4058             Postal code of the place where the item is located. This value is used for
4059             proximity searches. To remove this value when revising or relisting an item,
4060             use DeletedField. If you do not specify PostalCode, you must specify
4061             Item.Location. If you specify PostalCode, but do not specify Item.Location,
4062             then Item.Location is given a default value derived from the postal code.
4063             Not applicable to Half.com.
4064              
4065             Calls: AddItem
4066             GetItemRecommendations
4067             ReviseItem
4068             RelistItem
4069             VerifyAddItem
4070             RequiredInput: No
4071              
4072             # Argument: 'xs:string'
4073              
4074             =cut
4075              
4076             sub setPostalCode {
4077             my $self = shift;
4078             $self->{'PostalCode'} = shift
4079             }
4080              
4081             =head2 getPostalCode()
4082              
4083             Calls: GetSearchResults
4084             Returned: Conditionally
4085             Details: DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll
4086             GranularityLevel: Coarse
4087              
4088              
4089             Calls: GetBidderList
4090             GetProducts
4091             Returned: Conditionally
4092              
4093             Calls: GetItem
4094             Returned: Always
4095             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
4096              
4097             # Returns: 'xs:string'
4098              
4099             =cut
4100              
4101             sub getPostalCode {
4102             my $self = shift;
4103             return $self->{'PostalCode'};
4104             }
4105              
4106              
4107             =head2 setPrimaryCategory()
4108              
4109             Category ID for the first (or only) category in which the item is
4110             listed (or will be listed, if the item is new). A number of listing
4111             features have dependencies on the primary category. We have pointed
4112             out a few of the notable dependencies below. See the descriptions of
4113             the fields you are using to determine whether the feature
4114             you're supporting depends on the listing's primary category.
4115            
4116            
4117             For the AddItem family of calls:
4118             Use calls like GetCategories and GetCategoryFeatures to determine
4119             valid values for the site on which you are listing (see the
4120             eBay Web Services Guide for information on
4121             working with categories). Also see Item.CategoryMappingAllowed and
4122             Item.CategoryBasedAttributesPrefill.
4123            
4124             Most eBay.com categories are also eligible for eBay Express.
4125             Categories not covered by PayPal Buyer Protection are excluded.
4126             Also, certain categories that do not support item condition may be
4127             excluded (use GetCategoryFeatures to determine eligible categories).
4128             See "eBay Express" in the eBay Web Services Guide.
4129            
4130             There are a number of categories on some eBay sites that always add
4131             the Gallery feature (for free) when you include a picture in
4132             the listing and you don't specify the Gallery feature yourself.
4133             See GalleryType for information about fees that could be charged
4134             if you change the category in these cases.
4135            
4136            
4137             Not applicable to Half.com.
4138            
4139             For ReviseItem only: When revising a listing,
4140             you can change the primary category only if an item
4141             has no bids (or no items have sold) and the listing does not end
4142             within 12 hours.
4143            
If you change the listing category, any
4144             Item Specifics (attributes) that were previously specified may be
4145             dropped from the listing if they aren't
4146             valid for the new category. See Item.AttributeSetArray.
4147             For the eBay US site, we suggest that you avoid including a category ID
4148             when you use ExternalProductID. See the KB article listed below
4149             for details.
4150            
4151             You cannot change the meta-categories for vehicles
4152             (i.e., you cannot change a truck to a motorcycle), but you can change
4153             the leaf category (e.g., change one
4154             motorcycle subcategory to another motorcycle subcategory).
4155             See the eBay Web Services Guide for additional rules.
4156             International sites (such as the eBay Germany site)
4157             have similar rules for revising vehicle categories.
4158            
4159             For AddLiveAuctionItem only:
4160             For eBay Live Auctions (e.g., in AddLiveAuctionItem), this is the
4161             eBay Live Auctions site category in which to list the item.
4162             This can be different from the category that is associated with the
4163             seller's catalog. See Specifying eBay Live Auctions Categories in the
4164             eBay Web Services guide.
4165            
4166             For GetItemRecommendations only:
4167             For GetItemRecommendations, use this to control the category that
4168             will be searched for recommendations. Specify the category in which
4169             the item will be listed. See the eBay Web Services guide for
4170             differences in validation rules depending on whether you are using
4171             the Listing Analyzer engine, Product
4172             Pricing engine, or Suggested Attributes engine.
4173            
4174             For GetProducts: Use GetCategories if you need to
4175             determine the name of the category.
4176              
4177             SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=CategoryOverview
4178             Title: Categories
4179             , URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ExpressListingCriteria
4180             Title: Listing Criteria for eBay Express
4181             , URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=LiveAuctionCategories
4182             Title: Specifying eBay Live Auctions Categories
4183             , URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=MotorsListing
4184             Title: Listing US and CA eBay Motors Items
4185             , URL: RelistItem.html#Request.Item.PictureDetails.GalleryType
4186             Title: (RelistItem) GalleryType
4187             , URL: https://ebay.custhelp.com/cgi-bin/ebay.cfg/php/enduser/std_adp.php?p_faqid=581
4188             Title: KB Article: Listing with ExternalProductID and CategoryID
4189              
4190              
4191             Calls: AddItem
4192             AddLiveAuctionItem
4193             GetItemRecommendations
4194             VerifyAddItem
4195             RequiredInput: Yes
4196              
4197             Calls: GetItemRecommendations
4198             RequiredInput: Conditionally
4199              
4200             Calls: RelistItem
4201             ReviseItem
4202             ReviseLiveAuctionItem
4203             RequiredInput: No
4204              
4205             # Argument: 'ns:CategoryType'
4206              
4207             =cut
4208              
4209             sub setPrimaryCategory {
4210             my $self = shift;
4211             $self->{'PrimaryCategory'} = shift
4212             }
4213              
4214             =head2 getPrimaryCategory()
4215              
4216             Calls: GetBidderList
4217             Returned: Always
4218              
4219             Calls: GetItem
4220             Returned: Always
4221             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
4222              
4223             Calls: GetProducts
4224             Returned: Conditionally
4225              
4226             Calls: GetSellerList
4227             Returned: Conditionally
4228             Details: DetailLevel: ItemReturnDescription, ReturnAll
4229             GranularityLevel: Coarse, Medium, Fine
4230              
4231              
4232             Calls: GetSearchResults
4233             Returned: Conditionally
4234             Details: DetailLevel: ItemReturnCategories
4235              
4236             # Returns: 'ns:CategoryType'
4237              
4238             =cut
4239              
4240             sub getPrimaryCategory {
4241             my $self = shift;
4242             return $self->_getDataTypeInstance( 'PrimaryCategory'
4243             ,'eBay::API::XML::DataType::CategoryType');
4244             }
4245              
4246              
4247             =head2 setPrivateListing()
4248              
4249             If true, designates the listing as private. When you create a private
4250             listing, a buyer's User ID will not appear in the listing or in the
4251             listing's bid history. Sellers may want to use this option when they believe
4252             that potential bidders for a listing would not want their User IDs disclosed
4253             to others. Not applicable to Half.com.
4254              
4255             Calls: AddItem
4256             AddLiveAuctionItem
4257             GetItemRecommendations
4258             RelistItem
4259             ReviseItem
4260             ReviseLiveAuctionItem
4261             VerifyAddItem
4262             RequiredInput: No
4263              
4264             # Argument: 'xs:boolean'
4265              
4266             =cut
4267              
4268             sub setPrivateListing {
4269             my $self = shift;
4270             $self->{'PrivateListing'} = shift
4271             }
4272              
4273             =head2 isPrivateListing()
4274              
4275             Calls: GetBidderList
4276             Returned: Always
4277              
4278             Calls: GetItem
4279             Returned: Always
4280             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
4281              
4282             Calls: GetItemTransactions
4283             GetSellerTransactions
4284             Returned: Always
4285             Details: DetailLevel: none, ItemReturnDescription, ReturnAll
4286              
4287             Calls: GetOrderTransactions
4288             Returned: Always
4289             Details: DetailLevel: none, ItemReturnDescription, ReturnAll
4290              
4291             Calls: GetSellerList
4292             Returned: Conditionally
4293             Details: DetailLevel: ItemReturnDescription, ReturnAll
4294              
4295             # Returns: 'xs:boolean'
4296              
4297             =cut
4298              
4299             sub isPrivateListing {
4300             my $self = shift;
4301             return $self->{'PrivateListing'};
4302             }
4303              
4304              
4305             =head2 setPrivateNotes()
4306              
4307             A note a user makes on an item in their My eBay account.
4308             The note is prefaced with the words My Note.
4309             For eBay.com, only GetMyeBayBuying and GetMyeBaySelling (not GetItem)
4310             return this field, and only if you pass IncludeNotes in the request.
4311             Only visible to the user who created the note.
4312            
4313             Not supported as input in ReviseItem. Use SetUserNotes
4314             instead
4315            
4316             Not applicable to Half.com (instead, use
4317             Item.AttributeArray.Attribute.Value.ValueLiteral for Half.com notes.)
4318              
4319             Calls: AddItem
4320             GetItemRecommendations
4321             RelistItem
4322             VerifyAddItem
4323             RequiredInput: No
4324              
4325             # Argument: 'xs:string'
4326              
4327             =cut
4328              
4329             sub setPrivateNotes {
4330             my $self = shift;
4331             $self->{'PrivateNotes'} = shift
4332             }
4333              
4334             =head2 getPrivateNotes()
4335              
4336             Calls: GetOrders
4337             Returned: Conditionally
4338             Details: DetailLevel: none
4339              
4340             Calls: GetMyeBayBuying
4341             Returned: Conditionally
4342              
4343             Calls: GetMyeBaySelling
4344             Returned: Conditionally
4345              
4346             # Returns: 'xs:string'
4347              
4348             =cut
4349              
4350             sub getPrivateNotes {
4351             my $self = shift;
4352             return $self->{'PrivateNotes'};
4353             }
4354              
4355              
4356             =head2 setProductListingDetails()
4357              
4358             Specifies stock product information to include in a listing. Only applicable
4359             when listing items with Pre-filled Item Information. If the item's primary and
4360             secondary category are both catalog-enabled, the product listing details must
4361             be applicable to the primary category. If only one category is catalog-
4362             enabled, the product listing details must be applicable to the catalog-enabled
4363             category. Either Item.ExternalProductID or Item.ProductListingDetails can be
4364             specified in an AddItem request, but not both. See the eBay Web Services Guide
4365             for information on listing with Pre-filled Item Information.
4366            
4367             For ReviseItem and RelistItem only: If a
4368             listing includes Pre-filled Item Information and you
4369             change a category, the rules for continuing to include Pre-filled Item
4370             Information depend on whether or not the new category is mapped to a
4371             characteristic set associated with the same product ID. When you revise a
4372             listing, if it has bids or it ends within 12 hours, you cannot change the
4373             product ID and you cannot remove existing product data. However, you can
4374             change or add preferences such as IncludeStockPhotoURL,
4375             UseStockPhotoURLAsGallery, and IncludePrefilledItemInformation. To delete all
4376             catalog data when you revise or relist an item, specify
4377             Item.ProductListingDetails in DeletedField and don't pass
4378             ProductListingDetails in the request.
4379            
4380             For GetItemRecommendations only: For
4381             GetItemRecommendations, see the eBay Web Services guide for
4382             validation rule differences when using the Product Pricing engine.

4383             Not applicable to Half.com.
4384              
4385             SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrProductAPI
4386             Title: The Catalog Product (Pre-filled Item) API
4387             , URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=EngineProductPricing
4388             Title: Getting eBay Pricing Data for Listings with Pre-filled Item Information
4389              
4390              
4391             Calls: AddItem
4392             RelistItem
4393             ReviseItem
4394             VerifyAddItem
4395             RequiredInput: No
4396              
4397             Calls: GetItemRecommendations
4398             RequiredInput: Conditionally
4399              
4400             # Argument: 'ns:ProductListingDetailsType'
4401              
4402             =cut
4403              
4404             sub setProductListingDetails {
4405             my $self = shift;
4406             $self->{'ProductListingDetails'} = shift
4407             }
4408              
4409             =head2 getProductListingDetails()
4410              
4411             Calls: GetBidderList
4412             Returned: Conditionally
4413              
4414             Calls: GetItem
4415             Returned: Conditionally
4416             Details: DetailLevel: ItemReturnAttributes, ReturnAll
4417              
4418             # Returns: 'ns:ProductListingDetailsType'
4419              
4420             =cut
4421              
4422             sub getProductListingDetails {
4423             my $self = shift;
4424             return $self->_getDataTypeInstance( 'ProductListingDetails'
4425             ,'eBay::API::XML::DataType::ProductListingDetailsType');
4426             }
4427              
4428              
4429             =head2 setProxyItem()
4430              
4431             Some listings on the eBay platform originate from eBay affiliates.
4432             Depending on the relationship the affiliate has with eBay, there are times
4433             when the affiliate retains ownership of the listing. When this occurs
4434             the representation of the listing on eBay is considered a proxy item. Proxy
4435             items can only be edited using API requests from the applications that
4436             originally listed them.
4437              
4438             # Argument: 'xs:boolean'
4439              
4440             =cut
4441              
4442             sub setProxyItem {
4443             my $self = shift;
4444             $self->{'ProxyItem'} = shift
4445             }
4446              
4447             =head2 isProxyItem()
4448              
4449             Calls: GetItem
4450             Returned: Conditionally
4451             Details: DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
4452              
4453             Calls: GetSellerList
4454             Returned: Conditionally
4455             Details: DetailLevel: ItemReturnDescription, ReturnAll
4456             GranularityLevel: Coarse, Medium, Fine
4457              
4458              
4459             # Returns: 'xs:boolean'
4460              
4461             =cut
4462              
4463             sub isProxyItem {
4464             my $self = shift;
4465             return $self->{'ProxyItem'};
4466             }
4467              
4468              
4469             =head2 setQuantity()
4470              
4471             For AddItem and related calls, this is the number of items in the listing. For
4472             new listings being defined, this is the initial number of items the seller
4473             offers for sale. Even during a Dutch auction, where one of several items can
4474             be purchased during the auction, this number does not change. Sellers need to
4475             meet certain feedback requirements to specify a quantity greater than 1.
4476            

4477             When you revise a listing, you can add or change this value only if the
4478             listing has no bids (or no items have sold) and it does not end within 12
4479             hours. For auction items, a change in the auction's quantity could result in a
4480             change in the auction type. For example, if the quantity is changed from 1 (a
4481             Chinese auction) to 2, the auction is now a Dutch auction. This may impose new
4482             requirements and fees on the seller.

For GetSellerEvents
4483             calls, Quantity is returned only for listings where item quantity is greater
4484             than 1.
4485            

4486             For SetCart input, this is only required if the parent container is submitted.
4487            

4488             Also applicable to Half.com (valid range 1 to 1000).
4489             You can revise this field for Half.com listings.
4490              
4491             Calls: AddItem
4492             RelistItem
4493             VerifyAddItem
4494             RequiredInput: Yes
4495              
4496             Calls: GetItemRecommendations
4497             ReviseItem
4498             RequiredInput: No
4499              
4500             # Argument: 'xs:int'
4501              
4502             =cut
4503              
4504             sub setQuantity {
4505             my $self = shift;
4506             $self->{'Quantity'} = shift
4507             }
4508              
4509             =head2 getQuantity()
4510              
4511             Calls: GetBidderList
4512             GetDispute
4513             Returned: Always
4514              
4515             Calls: GetItem
4516             Returned: Always
4517             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
4518              
4519             Calls: GetItemTransactions
4520             GetSellerTransactions
4521             Returned: Always
4522             Details: DetailLevel: ReturnAll
4523              
4524             Calls: GetSellerList
4525             Returned: Conditionally
4526             Details: DetailLevel: ItemReturnDescription, ReturnAll
4527             GranularityLevel: Coarse, Medium, Fine
4528              
4529              
4530             Calls: GetMyeBaySelling
4531             Returned: Conditionally
4532             Details: DetailLevel: none, ReturnSummary, ReturnAll
4533             Context: ActiveList
4534             ScheduledList
4535             SoldList
4536             UnsoldList
4537             DeletedFromSoldList
4538             DeletedFromUnsoldList
4539              
4540             Calls: GetSellerEvents
4541             Returned: Conditionally
4542             Details: DetailLevel: none, ReturnAll
4543              
4544             Calls: GetSellerEvents
4545             Returned: Conditionally
4546             Details: DetailLevel: none, ReturnAll
4547              
4548             # Returns: 'xs:int'
4549              
4550             =cut
4551              
4552             sub getQuantity {
4553             my $self = shift;
4554             return $self->{'Quantity'};
4555             }
4556              
4557              
4558             =head2 setQuantityAvailable()
4559              
4560             Specifies how many of a certain item are available.
4561             Not applicable to Half.com.
4562            
4563             For GetSearchResultsExpress, only returned when ItemDetails is set to Fine.
4564              
4565             # Argument: 'xs:int'
4566              
4567             =cut
4568              
4569             sub setQuantityAvailable {
4570             my $self = shift;
4571             $self->{'QuantityAvailable'} = shift
4572             }
4573              
4574             =head2 getQuantityAvailable()
4575              
4576             Calls: GetMyeBayBuying
4577             Returned: Conditionally
4578             Details: DetailLevel: none, ReturnSummary, ReturnAll
4579             Context: BidList
4580             WatchList
4581              
4582             Calls: GetMyeBaySelling
4583             Returned: Conditionally
4584             Details: DetailLevel: none, ReturnSummary, ReturnAll
4585             Context: ActiveList
4586             ScheduledList
4587             SoldList
4588             UnsoldList
4589             DeletedFromSoldList
4590             DeletedFromUnsoldList
4591             BidList
4592              
4593             # Returns: 'xs:int'
4594              
4595             =cut
4596              
4597             sub getQuantityAvailable {
4598             my $self = shift;
4599             return $self->{'QuantityAvailable'};
4600             }
4601              
4602              
4603             =head2 setQuestionCount()
4604              
4605             Specifies the number of questions buyers have posted about the item.
4606             Returned only if greater than 0.
4607             Not applicable to Half.com.
4608              
4609             # Argument: 'xs:long'
4610              
4611             =cut
4612              
4613             sub setQuestionCount {
4614             my $self = shift;
4615             $self->{'QuestionCount'} = shift
4616             }
4617              
4618             =head2 getQuestionCount()
4619              
4620             Calls: GetMyeBaySelling
4621             Returned: Conditionally
4622              
4623             # Returns: 'xs:long'
4624              
4625             =cut
4626              
4627             sub getQuestionCount {
4628             my $self = shift;
4629             return $self->{'QuestionCount'};
4630             }
4631              
4632              
4633             =head2 setRegionID()
4634              
4635             No longer used by any site.
4636              
4637             Ignore:
4638             # Argument: 'xs:string'
4639              
4640             =cut
4641              
4642             sub setRegionID {
4643             my $self = shift;
4644             $self->{'RegionID'} = shift
4645             }
4646              
4647             =head2 getRegionID()
4648              
4649             # Returns: 'xs:string'
4650              
4651             =cut
4652              
4653             sub getRegionID {
4654             my $self = shift;
4655             return $self->{'RegionID'};
4656             }
4657              
4658              
4659             =head2 setRelistLink()
4660              
4661             Applicable only to re-listing an item. If true, creates a link in the item's
4662             old listing for the item that points to the new relist page, which
4663             accommodates users who might still look for the item under its old item ID.
4664             Not applicable to Half.com.
4665              
4666             Calls: RelistItem
4667             RequiredInput: No
4668              
4669             # Argument: 'xs:boolean'
4670              
4671             =cut
4672              
4673             sub setRelistLink {
4674             my $self = shift;
4675             $self->{'RelistLink'} = shift
4676             }
4677              
4678             =head2 isRelistLink()
4679              
4680             # Returns: 'xs:boolean'
4681              
4682             =cut
4683              
4684             sub isRelistLink {
4685             my $self = shift;
4686             return $self->{'RelistLink'};
4687             }
4688              
4689              
4690             =head2 setRelisted()
4691              
4692             Whether or not the item is a relisted item. This value is
4693             determined by eBay and cannot be set. Only returned if the
4694             item was relisted.
4695            

4696             Note that when an item is relisted and is given a new
4697             ItemID, the original item shows Relisted = true, but the new
4698             item does NOT show Relisted = true. In this context, the new
4699             item is a new listing, not a "Relisted" one.
4700              
4701             # Argument: 'xs:boolean'
4702              
4703             =cut
4704              
4705             sub setRelisted {
4706             my $self = shift;
4707             $self->{'Relisted'} = shift
4708             }
4709              
4710             =head2 isRelisted()
4711              
4712             Calls: GetMyeBaySelling
4713             Returned: Conditionally
4714             Context: UnsoldList
4715              
4716             # Returns: 'xs:boolean'
4717              
4718             =cut
4719              
4720             sub isRelisted {
4721             my $self = shift;
4722             return $self->{'Relisted'};
4723             }
4724              
4725              
4726             =head2 setReservePrice()
4727              
4728             The lowest price at which the seller is willing to sell the item. (StartPrice
4729             must be lower than ReservePrice.) Not all categories support reserve prices.
4730             See GetCategories and "Determining Whether a Category Supports Reserve Prices"
4731             in the eBay Web Services guide. In calls that retrieve item data, ReservePrice
4732             only has a non-zero value for listings with a reserve price and where the user
4733             requesting the item data is also the item's seller. Not applicable to fixed-
4734             price items or ad format listings.
4735            
4736             You can remove the reserve price of a US eBay Motors listing if the category
4737             allows it, the current reserve price has not been met, and the reserve price
4738             is at least $2.00 more than the current high bid. In this case, if the item
4739             has bids, the reserve price is set to $1.00 over the current high bid. The
4740             next bid meets the reserve and wins.
4741             See the Fees Overview on the eBay Web site for information about fee credits
4742             that may be available when the reserve price
4743             is removed for a Motors listing. See the eBay Web Services guide for
4744             validation rules when revising US Motors listings.

4745             For AddLiveAuctionItem and ReviseLiveAuctionItem, the seller needs to make
4746             sure they specify the amount in the currency selected for the live auction
4747             event. When you revise a Live Auction item, you can lower an existing reserve
4748             price, but you cannot add a reserve price or remove an existing reserve price
4749             if the item has absentee bids or ends in less than 12
4750             hours.

4751             Not applicable to Half.com.
4752             This field is ignored when Item.ListingType=Express.
4753              
4754             SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ReviseMotors
4755             Title: Revising US eBay Motors Listings
4756             , URL: http://pages.ebay.com/help/sell/reserve.html
4757             Title: Reserve Price (eBay Web site help)
4758             , URL: http://pages.ebay.com/help/sell/fees.html
4759             Title: Fees Overview (eBay Web site help)
4760              
4761             MaxLength: 16
4762              
4763             Calls: AddItem
4764             AddLiveAuctionItem
4765             GetItemRecommendations
4766             RelistItem
4767             ReviseItem
4768             ReviseLiveAuctionItem
4769             VerifyAddItem
4770             RequiredInput: No
4771              
4772             # Argument: 'ns:AmountType'
4773              
4774             =cut
4775              
4776             sub setReservePrice {
4777             my $self = shift;
4778             $self->{'ReservePrice'} = shift
4779             }
4780              
4781             =head2 getReservePrice()
4782              
4783             Calls: GetBidderList
4784             Returned: Conditionally
4785              
4786             Calls: GetSellerList
4787             Returned: Conditionally
4788             Details: DetailLevel: ItemReturnDescription, ReturnAll
4789             GranularityLevel: Fine
4790              
4791              
4792             Calls: GetItem
4793             Returned: Conditionally
4794             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
4795              
4796             Calls: GetMyeBaySelling
4797             Returned: Conditionally
4798             Details: DetailLevel: none, ReturnSummary, ReturnAll
4799             Context: ActiveList
4800             ScheduledList
4801             SoldList
4802             UnsoldList
4803             DeletedFromSoldList
4804             DeletedFromUnsoldList
4805              
4806             # Returns: 'ns:AmountType'
4807              
4808             =cut
4809              
4810             sub getReservePrice {
4811             my $self = shift;
4812             return $self->_getDataTypeInstance( 'ReservePrice'
4813             ,'eBay::API::XML::DataType::AmountType');
4814             }
4815              
4816              
4817             =head2 setReviseStatus()
4818              
4819             Indicates whether an item has been revised since the listing became
4820             active and, if so, which among a subset of properties have been changed
4821             by the revision.
4822             Output only.
4823             Not applicable to Half.com.
4824              
4825             # Argument: 'ns:ReviseStatusType'
4826              
4827             =cut
4828              
4829             sub setReviseStatus {
4830             my $self = shift;
4831             $self->{'ReviseStatus'} = shift
4832             }
4833              
4834             =head2 getReviseStatus()
4835              
4836             Calls: GetSellerList
4837             Returned: Conditionally
4838             Details: DetailLevel: ItemReturnDescription, ReturnAll
4839             GranularityLevel: Coarse, Medium, Fine
4840              
4841              
4842             Calls: GetBidderList
4843             Returned: Always
4844              
4845             Calls: GetItem
4846             Returned: Always
4847             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
4848              
4849             # Returns: 'ns:ReviseStatusType'
4850              
4851             =cut
4852              
4853             sub getReviseStatus {
4854             my $self = shift;
4855             return $self->_getDataTypeInstance( 'ReviseStatus'
4856             ,'eBay::API::XML::DataType::ReviseStatusType');
4857             }
4858              
4859              
4860             =head2 setSKU()
4861              
4862             This element is a SKU (stock-keeping unit) defined by a seller. The seller can
4863             use a SKU to identify one item or use the same SKU for multiple items.
4864             Preferable to ApplicationData for SKUs and inventory tracking. Different
4865             sellers can use the same SKUs. This element can be used by sellers to track
4866             complex flows of products and information. This element preserves a SKU,
4867             enabling a seller to obtain it before and after a transaction is created. To
4868             remove a SKU when you revise or relist an item, use DeletedField. Not
4869             applicable to Half.com.
4870             For GetMyeBaySelling, this is only returned if set.
4871              
4872             MaxLength: 50
4873              
4874             Calls: AddItem
4875             AddLiveAuctionItem
4876             GetItemRecommendations
4877             RelistItem
4878             ReviseItem
4879             VerifyAddItem
4880             RequiredInput: No
4881              
4882             # Argument: 'ns:SKUType'
4883              
4884             =cut
4885              
4886             sub setSKU {
4887             my $self = shift;
4888             $self->{'SKU'} = shift
4889             }
4890              
4891             =head2 getSKU()
4892              
4893             Calls: GetSellerList
4894             Returned: Conditionally
4895             Details: DetailLevel: ItemReturnDescription, ReturnAll
4896              
4897             Calls: GetBidderList
4898             Returned: Conditionally
4899              
4900             Calls: GetOrders
4901             Returned: Conditionally
4902             Details: DetailLevel: none
4903              
4904             Calls: GetItemTransactions
4905             GetSellerTransactions
4906             Returned: Conditionally
4907             Details: DetailLevel: none, ReturnAll
4908              
4909             Calls: GetItem
4910             Returned: Conditionally
4911             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
4912              
4913             Calls: GetMyeBaySelling
4914             Returned: Conditionally
4915              
4916             # Returns: 'ns:SKUType'
4917              
4918             =cut
4919              
4920             sub getSKU {
4921             my $self = shift;
4922             return $self->_getDataTypeInstance( 'SKU'
4923             ,'eBay::API::XML::DataType::SKUType');
4924             }
4925              
4926              
4927             =head2 setScheduleTime()
4928              
4929             Allows a user to schedule a listing to start at the specified time
4930             in the future. Specify the time (in GMT) that the item's listing
4931             is scheduled to be active on eBay. In GetItem and related calls,
4932             the scheduled time is returned in StartTime.
4933             For ReviseItem, you can modify this value if the
4934             current schedule time is in the future.
4935             Not applicable to Half.com.
4936             Also see the following article in the Knowledge Base:
4937             Why
4938             scheduled time is sometimes getting reset.
4939              
4940             Calls: AddItem
4941             GetItemRecommendations
4942             RelistItem
4943             ReviseItem
4944             VerifyAddItem
4945             RequiredInput: No
4946              
4947             # Argument: 'xs:dateTime'
4948              
4949             =cut
4950              
4951             sub setScheduleTime {
4952             my $self = shift;
4953             $self->{'ScheduleTime'} = shift
4954             }
4955              
4956             =head2 getScheduleTime()
4957              
4958             # Returns: 'xs:dateTime'
4959              
4960             =cut
4961              
4962             sub getScheduleTime {
4963             my $self = shift;
4964             return $self->{'ScheduleTime'};
4965             }
4966              
4967              
4968             =head2 setSearchDetails()
4969              
4970             Container for values that indicate whether a listing uses the Buy It Now feature,
4971             whether a listing is no more than one day old, and whether a listing has an image
4972             associated with it. Not applicable to Half.com.
4973              
4974             # Argument: 'ns:SearchDetailsType'
4975              
4976             =cut
4977              
4978             sub setSearchDetails {
4979             my $self = shift;
4980             $self->{'SearchDetails'} = shift
4981             }
4982              
4983             =head2 getSearchDetails()
4984              
4985             Calls: GetSearchResults
4986             Returned: Conditionally
4987             Details: DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll
4988              
4989             Calls: GetProducts
4990             Returned: Conditionally
4991              
4992             # Returns: 'ns:SearchDetailsType'
4993              
4994             =cut
4995              
4996             sub getSearchDetails {
4997             my $self = shift;
4998             return $self->_getDataTypeInstance( 'SearchDetails'
4999             ,'eBay::API::XML::DataType::SearchDetailsType');
5000             }
5001              
5002              
5003             =head2 setSecondaryCategory()
5004              
5005             ID for second category in which the item is listed (also see
5006             Item.PrimaryCategory).
5007            
5008             For the AddItem family of calls: Listing an item in
5009             a second category is optional. Also see Item.CategoryMappingAllowed
5010             and Item.CategoryBasedAttributesPrefill.
5011            
5012             Most eBay.com categories are also eligible for eBay Express.
5013             Categories not covered by PayPal Buyer Protection are excluded. Also,
5014             certain categories that do not support item condition may be excluded.
5015            
5016             Not applicable to Half.com.
5017            
5018             You cannot list US eBay Motors vehicles in two categories.
5019             However, you can list Parts & Accessories in two categories.
5020             The Final Value Fee is based on the primary
5021             category in which the item is listed.
5022             Furthermore, you can list the same item in an eBay Motors
5023             Parts & Accessories category
5024             and in an eligible eBay category, as long as the primary category is
5025             associated with the site on which you are listing.
5026             That is, the two categories can be a mix of Motors
5027             Parts & Accessories and eBay site categories.
5028             (Real Estate, Mature Audience (adult), and Business & Industrial
5029             categories are not eligible for listing in two categories
5030             in this manner.) For example, if
5031             you list on Motors, the primary category could be 6750
5032             (eBay Motors > Parts & Accessories >
5033             Apparel & Merchandise > Motorcycle > Jackets
5034             & Leathers), and the secondary category could be 57988 (eBay >
5035             Clothing, Shoes > Accessories > Men's Clothing > Outerwear).
5036             If you list on the main eBay site, the primary category could be
5037             57988 and the secondary category could be 6750.
5038            
5039             To remove this value when relisting an item, use DeletedField.
5040            

5041             For ReviseItem only: When revising a listing, you
5042             can add, remove, or change the secondary category
5043             only if the listing has no bids (or no items have sold) and it does
5044             not end within 12 hours. If you change the secondary category,
5045             any corresponding Item Specifics (attributes) that were previously
5046             specified may be dropped from the listing if they aren't valid for
5047             the category. See Item.AttributeSetArray.
5048            
5049             When you revise an item, you can change the
5050             secondary category from a Motors Parts & Accessories category
5051             to an eBay category or vice versa if the listing has no bids
5052             (or no items have sold) and it does not end within 12 hours.
5053            
5054             For AddLiveAuctionItem only: For eBay Live Auctions
5055             (e.g., AddLiveAuctionItem), this is the eBay US site
5056             category in which to list the item. (This can be any eBay US category
5057             except Motors or Real Estate categories.) Note that eBay Live Auctions
5058             does not charge a fee to specify an eBay category
5059             (i.e., no List in Two Category fees).
5060             See Specifying eBay Live Auctions Categories in the
5061             eBay Web Services guide.
5062             In AddLiveAuctionItem, you need to specify SecondaryCategory if you are
5063             including Item Specifics (AttributeSetArray).
5064            
5065             For ReviseLiveAuctionItem only:
5066             For eBay Live Auctions, you can add SecondaryCategory when you revise
5067             the lot item, but you cannot change or remove an existing
5068             secondary category if the item has absentee bids or it ends
5069             in less than 12 hours.
5070            
5071             For GetItemRecommendations only:
5072             For GetItemRecommendations, use this to control the category that
5073             will be searched for recommendations. Specify the category in which the
5074             item will be listed. See the eBay Web Services guide for differences in
5075             validation rules depending on whether you are using the
5076             Listing Analyzer engine, Product Pricing engine, or
5077             Suggested Attributes engine.
5078              
5079             SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=CategoryOverview
5080             Title: Categories
5081             , URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ExpressListingCriteria
5082             Title: Listing Criteria for eBay Express
5083             , URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=LiveAuctionCategories
5084             Title: Specifying eBay Live Auctions Categories
5085              
5086             MaxLength: 10
5087              
5088             Calls: AddItem
5089             AddLiveAuctionItem
5090             GetItemRecommendations
5091             RelistItem
5092             ReviseItem
5093             ReviseLiveAuctionItem
5094             VerifyAddItem
5095             RequiredInput: No
5096              
5097             # Argument: 'ns:CategoryType'
5098              
5099             =cut
5100              
5101             sub setSecondaryCategory {
5102             my $self = shift;
5103             $self->{'SecondaryCategory'} = shift
5104             }
5105              
5106             =head2 getSecondaryCategory()
5107              
5108             Calls: GetBidderList
5109             GetProducts
5110             Returned: Conditionally
5111              
5112             Calls: GetSearchResults
5113             Returned: Conditionally
5114             Details: DetailLevel: ItemReturnCategories
5115              
5116             Calls: GetItem
5117             Returned: Conditionally
5118             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
5119              
5120             Calls: GetSellerList
5121             Returned: Conditionally
5122             Details: DetailLevel: ItemReturnDescription, ReturnAll
5123              
5124             # Returns: 'ns:CategoryType'
5125              
5126             =cut
5127              
5128             sub getSecondaryCategory {
5129             my $self = shift;
5130             return $self->_getDataTypeInstance( 'SecondaryCategory'
5131             ,'eBay::API::XML::DataType::CategoryType');
5132             }
5133              
5134              
5135             =head2 setSeller()
5136              
5137             Container for information about this listing's seller.
5138             Not applicable to Half.com.
5139            

5140             In GetSearchResultsExpress, only returned when ItemDetails is set to Fine.
5141            

5142             Returned by GetCart/SetCart only if there are items in the cart.
5143            

5144             Returned by GetItemsAwaitingFeedback if Buyer is making the request.
5145              
5146             Calls: AddItem
5147             ReviseItem
5148             VerifyAddItem
5149             RequiredInput: Conditionally
5150              
5151             # Argument: 'ns:UserType'
5152              
5153             =cut
5154              
5155             sub setSeller {
5156             my $self = shift;
5157             $self->{'Seller'} = shift
5158             }
5159              
5160             =head2 getSeller()
5161              
5162             Calls: GetItem
5163             Returned: Always
5164             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
5165              
5166             Calls: GetItemTransactions
5167             Returned: Conditionally
5168             Details: DetailLevel: none, ReturnAll
5169              
5170             Calls: GetItemsAwaitingFeedback
5171             Returned: Conditionally
5172             Details: DetailLevel: none, ReturnAll
5173              
5174             Calls: GetSearchResults
5175             Returned: Conditionally
5176             Details: DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll
5177              
5178             Calls: GetCategoryListings
5179             GetProducts
5180             Returned: Conditionally
5181              
5182             Calls: GetMyeBayBuying
5183             Returned: Conditionally
5184             Details: DetailLevel: none, ReturnSummary, ReturnAll
5185             Context: BestOfferList
5186             BidList
5187             LostList
5188             WatchList
5189             WonList
5190             DeletedFromWonList
5191             DeletedFromLostList
5192              
5193             Calls: GetMyeBaySelling
5194             Returned: Conditionally
5195             Details: DetailLevel: none, ReturnSummary, ReturnAll
5196             Context: BidList
5197              
5198             Calls: GetBidderList
5199             Returned: Always
5200              
5201             # Returns: 'ns:UserType'
5202              
5203             =cut
5204              
5205             sub getSeller {
5206             my $self = shift;
5207             return $self->_getDataTypeInstance( 'Seller'
5208             ,'eBay::API::XML::DataType::UserType');
5209             }
5210              
5211              
5212             =head2 setSellerContactDetails()
5213              
5214             Contact information for sellers using the Classified Ad format for eBay
5215             Motors vehicles categories.
5216             To remove seller contact information when revising or relisting an item, use
5217             DeletedField. The seller contact details for the primary and secondary
5218             phone numbers cannot be deleted individually.
5219             To provide City, State, and Zip code information in SellerContactDetails use the following field:
5220             Item.SellerContactDetails.Street2
5221             To delete the secondary phone
5222             number, for example, you must delete all of the secondary phone
5223             fields:
5224             Item.SellerContactDetails.Phone2AreaOrCityCode
5225             Item.SellerContactDetails.Phone2CountryCode
5226             Item.SellerContactDetails.Phone2CountryPrefix
5227             Item.SellerContactDetails.Phone2LocalNumber
5228              
5229             SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ClassifiedAdListings
5230             Title: Classified Ad Listings
5231              
5232             Calls: AddItem
5233             ReviseItem
5234             VerifyAddItem
5235             RelistItem
5236             RequiredInput: No
5237              
5238             # Argument: 'ns:AddressType'
5239              
5240             =cut
5241              
5242             sub setSellerContactDetails {
5243             my $self = shift;
5244             $self->{'SellerContactDetails'} = shift
5245             }
5246              
5247             =head2 getSellerContactDetails()
5248              
5249             Calls: GetItem
5250             Returned: Conditionally
5251             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
5252              
5253             Calls: GetSellerList
5254             Returned: Conditionally
5255             Details: DetailLevel: ItemReturnDescription, ReturnAll
5256              
5257             # Returns: 'ns:AddressType'
5258              
5259             =cut
5260              
5261             sub getSellerContactDetails {
5262             my $self = shift;
5263             return $self->_getDataTypeInstance( 'SellerContactDetails'
5264             ,'eBay::API::XML::DataType::AddressType');
5265             }
5266              
5267              
5268             =head2 setSellerInventoryID()
5269              
5270             Unique identifier for a Half.com item. Must be an alphanumeric value (with no
5271             symbols) that is unique across the seller's active (unsold) inventory on
5272             Half.com. For Half.com, you can specify either ItemID or SellerInventoryID in
5273             a ReviseItem request to uniquely identify the listing. Only returned from
5274             GetOrders if the seller specified a value when the item was listed. You cannot
5275             revise this field. Not applicable to eBay.com listings.
5276              
5277             MaxLength: 100
5278              
5279             Calls: AddItem
5280             GetItemRecommendations
5281             VerifyAddItem
5282             ReviseItem
5283             RequiredInput: No
5284              
5285             # Argument: 'xs:string'
5286              
5287             =cut
5288              
5289             sub setSellerInventoryID {
5290             my $self = shift;
5291             $self->{'SellerInventoryID'} = shift
5292             }
5293              
5294             =head2 getSellerInventoryID()
5295              
5296             Calls: GetOrders
5297             Returned: Conditionally
5298             Details: DetailLevel: none
5299              
5300             # Returns: 'xs:string'
5301              
5302             =cut
5303              
5304             sub getSellerInventoryID {
5305             my $self = shift;
5306             return $self->{'SellerInventoryID'};
5307             }
5308              
5309              
5310             =head2 setSellerVacationNote()
5311              
5312             The seller is on vacation (as determined by the seller's store preferences) in
5313             two cases: i.) the item is a Store Inventory item and the seller has chosen to
5314             hide Store Inventory items while on vacation, and ii.) the seller has chosen
5315             to add a message to listed items while on vacation.
5316             Not applicable to Half.com.
5317              
5318             # Argument: 'xs:string'
5319              
5320             =cut
5321              
5322             sub setSellerVacationNote {
5323             my $self = shift;
5324             $self->{'SellerVacationNote'} = shift
5325             }
5326              
5327             =head2 getSellerVacationNote()
5328              
5329             Calls: GetBidderList
5330             Returned: Conditionally
5331              
5332             Calls: GetItem
5333             Returned: Conditionally
5334             Details: DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
5335              
5336             Calls: GetSellerEvents
5337             Returned: Conditionally
5338             Details: DetailLevel: ReturnAll
5339              
5340             # Returns: 'xs:string'
5341              
5342             =cut
5343              
5344             sub getSellerVacationNote {
5345             my $self = shift;
5346             return $self->{'SellerVacationNote'};
5347             }
5348              
5349              
5350             =head2 setSellingStatus()
5351              
5352             Various details about the current status of the listing, such as the current
5353             number of bids and the current high bidder. Not applicable to
5354             Half.com.
5355            

5356             For GetSearchResultsExpress, this is always returned when ItemArray.Item is returned.
5357            

5358             Returned by GetCart/SetCart only if there are items in the cart.
5359              
5360             # Argument: 'ns:SellingStatusType'
5361              
5362             =cut
5363              
5364             sub setSellingStatus {
5365             my $self = shift;
5366             $self->{'SellingStatus'} = shift
5367             }
5368              
5369             =head2 getSellingStatus()
5370              
5371             Calls: GetBidderList
5372             GetDispute
5373             Returned: Always
5374              
5375             Calls: GetSellerEvents
5376             Returned: Always
5377             Details: DetailLevel: none, ReturnAll
5378              
5379             Calls: GetItem
5380             Returned: Always
5381             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
5382              
5383             Calls: GetItemTransactions
5384             GetSellerTransactions
5385             Returned: Always
5386             Details: DetailLevel: none, ReturnAll
5387              
5388             Calls: GetOrderTransactions
5389             Returned: Always
5390             Details: DetailLevel: none, ItemReturnDescription, ReturnAll
5391              
5392             Calls: GetSellerList
5393             Returned: Conditionally
5394             Details: DetailLevel: ItemReturnDescription, ReturnAll
5395             GranularityLevel: Fine
5396              
5397              
5398             Calls: GetSearchResults
5399             Returned: Conditionally
5400             Details: DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll
5401              
5402             Calls: GetCategoryListings
5403             GetMemberMessages
5404             GetProducts
5405             Returned: Conditionally
5406              
5407             Calls: GetMyeBayBuying
5408             Returned: Conditionally
5409             Details: DetailLevel: none, ReturnSummary, ReturnAll
5410             Context: BestOfferList
5411             BidList
5412             LostList
5413             WatchList
5414             WonList
5415             DeletedFromWonList
5416             DeletedFromLostList
5417              
5418             Calls: GetMyeBaySelling
5419             Returned: Conditionally
5420             Details: DetailLevel: none, ReturnSummary, ReturnAll
5421             Context: ActiveList
5422             BidList
5423             ScheduledList
5424             SoldList
5425             UnsoldList
5426             DeletedFromSoldList
5427             DeletedFromUnsoldList
5428              
5429             Calls: GetSellerEvents
5430             Returned: Conditionally
5431             Details: DetailLevel: none, ReturnAll
5432              
5433             # Returns: 'ns:SellingStatusType'
5434              
5435             =cut
5436              
5437             sub getSellingStatus {
5438             my $self = shift;
5439             return $self->_getDataTypeInstance( 'SellingStatus'
5440             ,'eBay::API::XML::DataType::SellingStatusType');
5441             }
5442              
5443              
5444             =head2 setShipToLocations()
5445              
5446             An international location or region to which the seller is willing to ship,
5447             regardless of shipping service. The country of the listing site is added by
5448             eBay. Use GeteBayDetails with a DetailName of ShippingLocationDetails to
5449             determine which international locations are valid for the site. Omit
5450             ShipToLocations if you want to ship only within the country of the listing
5451             site. To state that you do not wish to ship at all, set ShipToLocations to
5452             None. ReviseItem can add a ShipToLocations. On output, ShipToLocations is
5453             the collection of all input item-level ShipToLocations plus international shipping
5454             service-level ShipToLocation values.
5455             Not applicable to Half.com.
5456              
5457             SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ShipToLocation
5458             Title: ShipToLocation
5459             , URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=GeteBayDetails
5460             Title: GeteBayDetails
5461              
5462             MaxLength: length of longest name in ShippingRegionCodeType and CountryCodeType
5463              
5464             Calls: AddItem
5465             GetItemRecommendations
5466             RelistItem
5467             ReviseItem
5468             VerifyAddItem
5469             RequiredInput: No
5470              
5471             # Argument: reference to an array
5472             of 'xs:string'
5473              
5474             =cut
5475              
5476             sub setShipToLocations {
5477             my $self = shift;
5478             $self->{'ShipToLocations'} =
5479             $self->convertArray_To_RefToArrayIfNeeded(@_);
5480             }
5481              
5482             =head2 getShipToLocations()
5483              
5484             Calls: GetBidderList
5485             Returned: Always
5486              
5487             Calls: GetItem
5488             Returned: Always
5489             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
5490              
5491             Calls: GetSellerList
5492             Returned: Conditionally
5493             Details: DetailLevel: ItemReturnDescription, ReturnAll
5494             GranularityLevel: Coarse, Medium, Fine
5495              
5496              
5497             # Returns: reference to an array
5498             of 'xs:string'
5499              
5500             =cut
5501              
5502             sub getShipToLocations {
5503             my $self = shift;
5504             return $self->_getDataTypeArray('ShipToLocations');
5505             }
5506              
5507              
5508             =head2 setShippingDetails()
5509              
5510             The shipping-related details for an item or transaction, including flat and
5511             calculated shipping costs and shipping insurance costs.
5512            
5513             New users who list their first items in selected categories on the US site
5514             must specify at least one domestic shipping service. This applies to a
5515             category if GetCategoryFeatures returns true for Category.ShippingTermsRequired.
5516            
5517            
5518             For multi-quantity Store Inventory Format listings and for multi-quantity
5519             Fixed Price listings, a seller can revise all shipping details of the listing
5520             (except for sales tax and for shipping type of Freight) for all unsold items.
5521             This applies to both domestic and international shipping. Checkout is not
5522             affected for those who bought items prior to the seller's shipping
5523             changes--the shipping details that were in effect at the time of purchase are used for
5524             that buyer at the time of checkout.
5525            
5526            
5527             For a listing to be eligible for eBay Express, shipping details are
5528             required (to support the eBay Express shopping cart).
5529             For flat shipping, this means the shipping service and cost
5530             are required. For calculated shipping, it means all of the
5531             usual parameters (weight, originating postal code, etc.) are required.
5532             See the the eBay Web Services Guide links below for more information.
5533             In GetSearchResultsExpress, always returned when
5534             ItemArray.Item is returned.
5535            
5536             This container is returned by GetCart or SetCart only when a valid postal code
5537             is provided for the country (see SetCart.ShippingAddress) and there is
5538             at least one item in the shopping cart for which calculated shipping is offered.
5539            
5540             Shipping details are not applicable to Real Estate listings and Half.com.
5541              
5542             SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ShippingGettingCosts
5543             Title: Determining Shipping Costs for a Listing
5544             , URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ExpressShippingCosts
5545             Title: Specify Domestic Shipping Costs for Express and eBay
5546             , URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=RevisingItems
5547             For: restrictions on changing item properties with ReviseItem
5548             Title: Revising Items
5549              
5550              
5551             Calls: AddItem
5552             GetItemRecommendations
5553             RelistItem
5554             ReviseItem
5555             VerifyAddItem
5556             RequiredInput: Conditionally
5557              
5558             # Argument: 'ns:ShippingDetailsType'
5559              
5560             =cut
5561              
5562             sub setShippingDetails {
5563             my $self = shift;
5564             $self->{'ShippingDetails'} = shift
5565             }
5566              
5567             =head2 getShippingDetails()
5568              
5569             Calls: GetSellerList
5570             Returned: Conditionally
5571             Details: DetailLevel: ItemReturnDescription, ReturnAll
5572             GranularityLevel: Coarse, Medium, Fine
5573              
5574              
5575             Calls: GetSearchResults
5576             Returned: Conditionally
5577             Details: DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll
5578             GranularityLevel: Coarse
5579              
5580              
5581             Calls: GetBidderList
5582             GetProducts
5583             Returned: Conditionally
5584              
5585             Calls: GetItem
5586             Returned: Conditionally
5587             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
5588              
5589             Calls: GetMyeBayBuying
5590             Returned: Conditionally
5591             Details: DetailLevel: none, ReturnSummary, ReturnAll
5592             Context: BidList
5593             WonList
5594             WatchList
5595             DeletedFromWonList
5596             BestOfferList
5597              
5598             Calls: GetMyeBaySelling
5599             Returned: Conditionally
5600             Details: DetailLevel: none, ReturnSummary, ReturnAll
5601             Context: ActiveList
5602             ScheduledList
5603             BidList
5604              
5605             # Returns: 'ns:ShippingDetailsType'
5606              
5607             =cut
5608              
5609             sub getShippingDetails {
5610             my $self = shift;
5611             return $self->_getDataTypeInstance( 'ShippingDetails'
5612             ,'eBay::API::XML::DataType::ShippingDetailsType');
5613             }
5614              
5615              
5616             =head2 setShippingTermsInDescription()
5617              
5618             Indicates whether details about shipping costs and
5619             arrangements are specified in the item description.
5620             Not applicable to Half.com.
5621              
5622             SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SearchResultsAndShippingCosts
5623             Title: Search Results and Shipping Costs
5624              
5625             Calls: AddItem
5626             GetItemRecommendations
5627             ReviseItem
5628             RelistItem
5629             VerifyAddItem
5630             RequiredInput: No
5631              
5632             # Argument: 'xs:boolean'
5633              
5634             =cut
5635              
5636             sub setShippingTermsInDescription {
5637             my $self = shift;
5638             $self->{'ShippingTermsInDescription'} = shift
5639             }
5640              
5641             =head2 isShippingTermsInDescription()
5642              
5643             Calls: GetSellerList
5644             Returned: Conditionally
5645             Details: DetailLevel: ItemReturnDescription, ReturnAll
5646              
5647             Calls: GetBidderList
5648             Returned: Conditionally
5649              
5650             Calls: GetItem
5651             Returned: Conditionally
5652             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
5653              
5654             # Returns: 'xs:boolean'
5655              
5656             =cut
5657              
5658             sub isShippingTermsInDescription {
5659             my $self = shift;
5660             return $self->{'ShippingTermsInDescription'};
5661             }
5662              
5663              
5664             =head2 setSite()
5665              
5666             The name of the site on which the item is listed.
5667             The listing site affects the
5668             business logic and validation rules that are applied to the request, which in
5669             turn affect the values that are returned in the response, as well as values
5670             that appear on the eBay Web site. For example, the listing site can affect the
5671             validation of Category in listing requests, international business seller
5672             requirements, the values of converted (localized) prices in responses, the
5673             item-related time stamps that are displayed on the eBay Web site, the
5674             visibility of the item in some types of searches (e.g., GetCategoryListings),
5675             and other information. In some cases (such as with listings on eBay Express),
5676             the rules are determined by a combination of the site, the user's registration
5677             address, and other information. You cannot change the site when you revise a
5678             listing.
5679            
5680             When you specify Item.Site in AddItem, it must be consistent with the numeric
5681             site ID that you specify in the request URL (for the SOAP API) or the X-EBAY-
5682             API-SITEID header (for the XML API).
5683             Not applicable to Half.com.
5684             For eBay Live Auctions, pass a value of US.
5685              
5686             SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SitesIntro
5687             Title: The US and International eBay Sites
5688             , URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=TargetSite
5689             Title: Specifying the Target Site
5690             , URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=FieldDifferences
5691             Title: Field Differences for eBay Sites
5692             , URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ExpressSellerCriteria
5693             Title: Seller Criteria for eBay Express
5694              
5695              
5696             Calls: AddItem
5697             AddLiveAuctionItem
5698             GetItemRecommendations
5699             VerifyAddItem
5700             RequiredInput: Yes
5701              
5702             # Argument: 'ns:SiteCodeType'
5703              
5704             =cut
5705              
5706             sub setSite {
5707             my $self = shift;
5708             $self->{'Site'} = shift
5709             }
5710              
5711             =head2 getSite()
5712              
5713             Calls: GetBidderList
5714             GetDispute
5715             Returned: Always
5716              
5717             Calls: GetItem
5718             Returned: Always
5719             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
5720              
5721             Calls: GetItemTransactions
5722             GetSellerTransactions
5723             Returned: Conditionally
5724             Details: DetailLevel: ReturnAll
5725              
5726             Calls: GetCategoryListings
5727             Returned: Conditionally
5728              
5729             Calls: GetSellerList
5730             Returned: Conditionally
5731             Details: DetailLevel: ItemReturnDescription, ReturnAll
5732             GranularityLevel: Coarse, Medium, Fine
5733              
5734              
5735             Calls: GetMyeBayBuying
5736             Returned: Conditionally
5737             Details: DetailLevel: none, ReturnSummary, ReturnAll
5738             Context: BestOfferList
5739             BidList
5740             LostList
5741             SecondChanceOffer
5742             WatchList
5743             WonList
5744             DeletedFromWonList
5745             DeletedFromLostList
5746              
5747             Calls: GetMyeBaySelling
5748             Returned: Conditionally
5749             Details: DetailLevel: none, ReturnSummary, ReturnAll
5750             Context: BidList
5751              
5752             Calls: GetSearchResults
5753             Returned: Always
5754             Details: DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll
5755             GranularityLevel: Coarse
5756              
5757              
5758             Calls: GetSellerEvents
5759             Returned: Conditionally
5760             Details: DetailLevel: none, ReturnAll
5761              
5762             # Returns: 'ns:SiteCodeType'
5763              
5764             =cut
5765              
5766             sub getSite {
5767             my $self = shift;
5768             return $self->{'Site'};
5769             }
5770              
5771              
5772             =head2 setSkypeContactOption()
5773              
5774             Specifies the Skype contact options supported. Requires that SkypeEnabled is
5775             set to true. Available if the seller has a Skype account and has linked it (on
5776             the eBay site) with his or her eBay account.
5777              
5778             Calls: AddItem
5779             RelistItem
5780             ReviseItem
5781             VerifyAddItem
5782             RequiredInput: No
5783              
5784             # Argument: reference to an array
5785             of 'ns:SkypeContactOptionCodeType'
5786              
5787             =cut
5788              
5789             sub setSkypeContactOption {
5790             my $self = shift;
5791             $self->{'SkypeContactOption'} =
5792             $self->convertArray_To_RefToArrayIfNeeded(@_);
5793             }
5794              
5795             =head2 getSkypeContactOption()
5796              
5797             Calls: GetSellerList
5798             Returned: Conditionally
5799             Details: DetailLevel: ItemReturnDescription, ReturnAll
5800              
5801             Calls: GetItem
5802             Returned: Conditionally
5803             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
5804              
5805             # Returns: reference to an array
5806             of 'ns:SkypeContactOptionCodeType'
5807              
5808             =cut
5809              
5810             sub getSkypeContactOption {
5811             my $self = shift;
5812             return $self->_getDataTypeArray('SkypeContactOption');
5813             }
5814              
5815              
5816             =head2 setSkypeEnabled()
5817              
5818             Specifies that Skype-related information is included with an item listing,
5819             including, for example, Skype Voice. Skype-related information provides
5820             buttons that enable potential buyers to contact sellers through Skype.
5821             Information about Skype is available at www.Skype.com. If all of the
5822             prerequisites for adding Skype buttons to listings are met (see the eBay Web
5823             Services Guide), you can make communication through Skype available in
5824             listings. SkypeEnabled must be true if SkypeID and SkypeContactOption are
5825             specified.
5826              
5827             Calls: AddItem
5828             RelistItem
5829             ReviseItem
5830             VerifyAddItem
5831             RequiredInput: No
5832              
5833             # Argument: 'xs:boolean'
5834              
5835             =cut
5836              
5837             sub setSkypeEnabled {
5838             my $self = shift;
5839             $self->{'SkypeEnabled'} = shift
5840             }
5841              
5842             =head2 isSkypeEnabled()
5843              
5844             Calls: GetSellerList
5845             Returned: Conditionally
5846             Details: DetailLevel: ItemReturnDescription, ReturnAll
5847              
5848             Calls: GetItem
5849             Returned: Conditionally
5850             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
5851              
5852             # Returns: 'xs:boolean'
5853              
5854             =cut
5855              
5856             sub isSkypeEnabled {
5857             my $self = shift;
5858             return $self->{'SkypeEnabled'};
5859             }
5860              
5861              
5862             =head2 setSkypeID()
5863              
5864             The Skype name of the seller. Requires that SkypeEnabled is set to true.
5865             Available if the seller has a Skype account and has linked it (on the eBay
5866             site) with his or her eBay account.
5867              
5868             Calls: AddItem
5869             RelistItem
5870             ReviseItem
5871             VerifyAddItem
5872             RequiredInput: No
5873              
5874             # Argument: 'xs:string'
5875              
5876             =cut
5877              
5878             sub setSkypeID {
5879             my $self = shift;
5880             $self->{'SkypeID'} = shift
5881             }
5882              
5883             =head2 getSkypeID()
5884              
5885             Calls: GetItem
5886             Returned: Conditionally
5887             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
5888              
5889             Calls: GetSellerList
5890             Returned: Conditionally
5891             Details: DetailLevel: ItemReturnDescription, ReturnAll
5892              
5893             # Returns: 'xs:string'
5894              
5895             =cut
5896              
5897             sub getSkypeID {
5898             my $self = shift;
5899             return $self->{'SkypeID'};
5900             }
5901              
5902              
5903             =head2 setStartPrice()
5904              
5905             The original price of the item at listing or re-listing time. If this
5906             value changes when the item is revised, the new value becomes the original
5907             price.
5908            

5909             For auction-type listings, competitive bidding starts at this value. Once at
5910             least one bid has been placed, StartPrice remains the same but CurrentPrice is
5911             incremented to the amount of each succeeding bid. If ReservePrice is also
5912             specified, the value of StartPrice must be lower than the value of
5913             ReservePrice.
5914            

5915             For fixed-price listings (FixedPriceItem), Store Inventory (StoresFixedPrice)
5916             listings, and Express format listings, this is the constant price at which a
5917             buyer may purchase the item.
5918            

5919             For a listing to be eligible for Express, the max start price is
5920             USD 10,000.00 for the US, EUR 5000 for Germany, and GBP 5500 for the UK.
5921             (Additional price limits may be imposed
5922             by the seller's PayPal account or the payment method used. Such limits cannot
5923             be determined via the eBay API and are not covered in eBay's API
5924             documentation, as they may vary for each user.)
5925            
5926             Also applicable to Half.com (valid range 0.75 to 9999.99). You can revise this
5927             field for Half.com listings.
5928            
5929             For AddLiveAuctionItem and ReviseLiveAuctionItem, this is the amount at
5930             which absentee Internet bidding for the item begins. Max length was 16
5931             at the time this call was initially developed.
5932             Must be greater than zero. The seller needs to make sure they specify
5933             the amount in the currency selected for the live auction event.
5934             When you revise a Live Auction item, you can change the start price.
5935              
5936             SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ExpressPrice
5937             Title: Specify a Fixed Price for Express and eBay
5938              
5939             Calls: AddItem
5940             AddLiveAuctionItem
5941             VerifyAddItem
5942             RequiredInput: Yes
5943              
5944             Calls: GetItemRecommendations
5945             ReviseItem
5946             ReviseLiveAuctionItem
5947             RelistItem
5948             RequiredInput: No
5949              
5950             # Argument: 'ns:AmountType'
5951              
5952             =cut
5953              
5954             sub setStartPrice {
5955             my $self = shift;
5956             $self->{'StartPrice'} = shift
5957             }
5958              
5959             =head2 getStartPrice()
5960              
5961             Calls: GetBidderList
5962             Returned: Always
5963              
5964             Calls: GetItem
5965             Returned: Always
5966             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
5967              
5968             Calls: GetMyeBayBuying
5969             Returned: Conditionally
5970             Details: DetailLevel: none, ReturnSummary, ReturnAll
5971             Context: BidList
5972             LostList
5973             WatchList
5974             WonList
5975             DeletedFromWonList
5976             DeletedFromLostList
5977              
5978             Calls: GetMyeBaySelling
5979             Returned: Conditionally
5980             Details: DetailLevel: none, ReturnSummary, ReturnAll
5981             Context: ActiveList
5982             ScheduledList
5983             SoldList
5984             UnsoldList
5985             DeletedFromSoldList
5986             DeletedFromUnsoldList
5987             BidList
5988              
5989             Calls: GetSellerList
5990             Returned: Conditionally
5991             Details: DetailLevel: ItemReturnDescription, ReturnAll
5992             GranularityLevel: Fine
5993              
5994              
5995             Calls: GetItemTransactions
5996             GetSellerTransactions
5997             Returned: Conditionally
5998             Details: DetailLevel: ReturnAll
5999              
6000             # Returns: 'ns:AmountType'
6001              
6002             =cut
6003              
6004             sub getStartPrice {
6005             my $self = shift;
6006             return $self->_getDataTypeInstance( 'StartPrice'
6007             ,'eBay::API::XML::DataType::AmountType');
6008             }
6009              
6010              
6011             =head2 setStorefront()
6012              
6013             Contains information related to the item in the context of a seller's eBay
6014             Store. Applicable for auction formats, Basic Fixed Price, and Store Inventory
6015             format items listed by eBay Stores sellers.
6016             Not applicable to Half.com.
6017             This field is ignored when Item.ListingType=Express.
6018             In GetProducts, this node does not return useful data (at the time of
6019             this writing.)
6020              
6021             Calls: AddItem
6022             GetItemRecommendations
6023             RelistItem
6024             ReviseItem
6025             VerifyAddItem
6026             RequiredInput: No
6027              
6028             # Argument: 'ns:StorefrontType'
6029              
6030             =cut
6031              
6032             sub setStorefront {
6033             my $self = shift;
6034             $self->{'Storefront'} = shift
6035             }
6036              
6037             =head2 getStorefront()
6038              
6039             Calls: GetSearchResults
6040             Returned: Conditionally
6041             Details: DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll
6042             GranularityLevel: Coarse
6043              
6044              
6045             Calls: GetBidderList
6046             GetProducts
6047             Returned: Conditionally
6048              
6049             Calls: GetItem
6050             Returned: Conditionally
6051             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
6052              
6053             Calls: GetSellerList
6054             Returned: Conditionally
6055             Details: DetailLevel: ItemReturnDescription, ReturnAll
6056             GranularityLevel: Coarse, Medium, Fine
6057              
6058              
6059             # Returns: 'ns:StorefrontType'
6060              
6061             =cut
6062              
6063             sub getStorefront {
6064             my $self = shift;
6065             return $self->_getDataTypeInstance( 'Storefront'
6066             ,'eBay::API::XML::DataType::StorefrontType');
6067             }
6068              
6069              
6070             =head2 setSubTitle()
6071              
6072             Subtitle to use in addition to the title. Provides more keywords when buyers
6073             search in titles and descriptions. You cannot use HTML in the Subtitle. (HTML
6074             characters will be interpreted literally as plain text.) If you pass any
6075             value, this feature is applied (with applicable fees).
6076            
6077             Not applicable to listings in US eBay Motors passenger vehicle, motorcycle,
6078             and "other vehicle" categories or to listings in CA eBay Motors passenger
6079             vehicle and motorcycle categories. For eBay Motors categories that do
6080             not support this field, use Item Specifics (AttributeSetArray) to specify the
6081             vehicle subtitle.
6082            
6083             Not applicable to Half.com.
6084            
6085             When you revise a item, you can add, change, or remove the subtitle.
6086            
6087             In GetSearchResultsExpress, only returned when ItemDetails is set to Fine
6088             and a subtitle was specified for the item.
6089              
6090             SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=RelistDeletedField
6091             Title: Removing a Field When Relisting an Item
6092             , URL: RelistItem.html#Request.DeletedField
6093             Title: (RelistItem) DeletedField
6094             , URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=MotorsCarAttrs
6095             Title: Valid Item Specifics for Listing eBay Motors US Cars & Trucks
6096             , URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=MotorsSubtitle
6097             Title: Specifying a Subtitle for a Motors Vehicle Listing
6098              
6099             MaxLength: 55
6100              
6101             Calls: AddItem
6102             RelistItem
6103             AddLiveAuctionItem
6104             GetItemRecommendations
6105             ReviseItem
6106             ReviseLiveAuctionItem
6107             VerifyAddItem
6108             RequiredInput: No
6109              
6110             # Argument: 'xs:string'
6111              
6112             =cut
6113              
6114             sub setSubTitle {
6115             my $self = shift;
6116             $self->{'SubTitle'} = shift
6117             }
6118              
6119             =head2 getSubTitle()
6120              
6121             Calls: GetBidderList
6122             GetCategoryListings
6123             GetProducts
6124             Returned: Conditionally
6125              
6126             Calls: GetItem
6127             Returned: Conditionally
6128             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
6129              
6130             # Returns: 'xs:string'
6131              
6132             =cut
6133              
6134             sub getSubTitle {
6135             my $self = shift;
6136             return $self->{'SubTitle'};
6137             }
6138              
6139              
6140             =head2 setThirdPartyCheckout()
6141              
6142             Whether checkout for this is to be handled by a Third-Party Checkout
6143             application. Only for authorized Third-Party Checkout applications. See
6144             "Third-Party Checkout" in the main documentation.
6145            
6146             If you are creating a listing, then for a listing to be eligible
6147             to appear on eBay Express, you also need to agree
6148             to use a Platform Notification (or transaction calls) instead of Third-Party
6149             Checkout to process Express sales. To do this, specify
6150             ThirdPartyCheckoutIntegration with a value of true.
6151             IMPORTANT: If you are not authorized to support Third Party Checkout and your
6152             application is not the original listing application, never specify
6153             ThirdPartyCheckout or ThirdPartyCheckoutIntegration in your request (even if
6154             you revise a listing that already includes these flags). Otherwise, the
6155             listing may be dropped from Express or you may get unexpected results.
6156            
6157             To determine whether an item was listed on Express, call GetItem and
6158             check the value of Item.ListingDetails.ExpressListing.
6159             To determine whether an item sold on Express, use a transaction call
6160             like GetItemTransactions (or the Checkout notification),
6161             and check the value of TransactionPlatform.
6162            
6163             The counterpart in the GetItem family of calls is
6164             Item.ShippingDetails.ThirdPartyCheckout.
6165            
6166            
6167             Not applicable to Half.com. Not supported if AutoPay is true.
6168              
6169             SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ThirdPartyCheckout
6170             Title: Third Party Checkout
6171             , URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ExpressTPCOListing
6172             Title: Integrate Your Third-Party Checkout Process with Express
6173             , URL: GetItem.html#Response.Item.ShippingDetails.ThirdPartyCheckout
6174             Title: (GetItem) Item.ShippingDetails.ThirdPartyCheckout
6175              
6176              
6177             Calls: AddItem
6178             GetItemRecommendations
6179             RelistItem
6180             ReviseItem
6181             VerifyAddItem
6182             RequiredInput: No
6183              
6184             # Argument: 'xs:boolean'
6185              
6186             =cut
6187              
6188             sub setThirdPartyCheckout {
6189             my $self = shift;
6190             $self->{'ThirdPartyCheckout'} = shift
6191             }
6192              
6193             =head2 isThirdPartyCheckout()
6194              
6195             # Returns: 'xs:boolean'
6196              
6197             =cut
6198              
6199             sub isThirdPartyCheckout {
6200             my $self = shift;
6201             return $self->{'ThirdPartyCheckout'};
6202             }
6203              
6204              
6205             =head2 setThirdPartyCheckoutIntegration()
6206              
6207             Only authorized Third-Party Checkout providers can use this flag.
6208            

6209             IMPORTANT: If you are not authorized to support Third Party Checkout and your
6210             application is not the original listing application, never specify
6211             ThirdPartyCheckout or ThirdPartyCheckoutIntegration in your request (even if
6212             you revise a listing that already includes these flags). Otherwise, the
6213             listing may be dropped from Express or you may get unexpected
6214             results.
6215            
6216             A Third-Party Checkout provider uses this flag in two ways:
6217            
6218             1) Set this flag to true to specify that you consent to use the Checkout
6219             notification (or calls like GetSellerTransactions and GetItemTransactions) to
6220             obtain data about eBay Express sales from the item, and to confirm that buyers
6221             will use the Express shopping cart for checkout processing without being
6222             redirected to your Third-Party Checkout site. If ThirdPartyCheckout is true,
6223             the ThirdPartyCheckoutIntegration field must also be true if you want an
6224             eligible listing to be included on eBay Express (and the Third Party Checkout
6225             checkout flow will be then be ignored for Express purchases).
6226             See the eBay Web Services Guide.
6227            
6228             In other words, assuming the seller and item meet all other eligibility
6229             requirements for Express, the seller opts into Express,
6230             and the seller (optionally) subscribes to the Checkout notification:
6231             - If ThirdPartyCheckout == true
6232             and ThirdPartyCheckoutIntegration == true,
6233             the item will be listed on Express
6234             and Checkout notifications will be sent.
6235             - If ThirdPartyCheckout == true
6236             and ThirdPartyCheckoutIntegration == omitted or false,
6237             the item will be disqualified for Express
6238             and no Checkout notification will be sent.
6239             - If ThirdPartyCheckout == omitted or false,
6240             and ThirdPartyCheckoutIntegration == true,
6241             the item will be listed on Express
6242             and Checkout notifications will be sent.
6243             - If ThirdPartyCheckout == omitted or false,
6244             and ThirdPartyCheckoutIntegration == omitted or false,
6245             the item will be listed on Express
6246             but no Checkout notifications will be sent.
6247            
6248             2) If you subscribe to the Checkout notification, set this flag to true to
6249             enable Checkout notifications for a particular listing. These notifications
6250             can be sent for any transaction created from the listing, regardless of
6251             whether the listing is included on Express and regardless of the value of
6252             ThirdPartyCheckout. Checkout notifications are not sent if
6253             ThirdPartyCheckoutIntegration is false.
6254            
6255             Returned only if true for a listing.
6256            
6257             Not applicable to Half.com.
6258            
6259             To determine whether an item was listed on Express, call GetItem and
6260             check the value of Item.ListingDetails.ExpressListing.
6261             To determine whether an item sold on Express, use a transaction call
6262             like GetItemTransactions (or the Checkout notification),
6263             and check the value of TransactionPlatform.
6264              
6265             SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ExpressTPCOListing
6266             Title: Integrate Your Third-Party Checkout Process with Express
6267             , URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ThirdPartyCheckoutIntegration
6268             Title: Third Party Checkout and eBay Express
6269             , URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=PlatformNotifications
6270             Title: Working with Platform Notifications
6271              
6272              
6273             Calls: AddItem
6274             GetItemRecommendations
6275             RelistItem
6276             ReviseItem
6277             VerifyAddItem
6278             RequiredInput: No
6279             Default: false
6280              
6281             # Argument: 'xs:boolean'
6282              
6283             =cut
6284              
6285             sub setThirdPartyCheckoutIntegration {
6286             my $self = shift;
6287             $self->{'ThirdPartyCheckoutIntegration'} = shift
6288             }
6289              
6290             =head2 isThirdPartyCheckoutIntegration()
6291              
6292             Calls: GetBidderList
6293             Returned: Conditionally
6294              
6295             Calls: GetSellerList
6296             Returned: Conditionally
6297             Details: DetailLevel: ItemReturnDescription, ReturnAll
6298              
6299             Calls: GetItem
6300             Returned: Conditionally
6301             Details: DetailLevel: none, ItemReturnDescription,
6302             ItemReturnAttributes, ReturnAll
6303              
6304             # Returns: 'xs:boolean'
6305              
6306             =cut
6307              
6308             sub isThirdPartyCheckoutIntegration {
6309             my $self = shift;
6310             return $self->{'ThirdPartyCheckoutIntegration'};
6311             }
6312              
6313              
6314             =head2 setTimeLeft()
6315              
6316             Time left before the listing ends.
6317             The duration is represented in the ISO 8601 duration format (PnYnMnDTnHnMnS).
6318             See Data Types in the eBay Web Services guide for information about this format.
6319             For ended listings, the time left is PT0S (zero seconds).
6320             Not applicable to Half.com.
6321              
6322             # Argument: 'xs:duration'
6323              
6324             =cut
6325              
6326             sub setTimeLeft {
6327             my $self = shift;
6328             $self->{'TimeLeft'} = shift
6329             }
6330              
6331             =head2 getTimeLeft()
6332              
6333             Calls: GetBidderList
6334             Returned: Always
6335              
6336             Calls: GetItem
6337             Returned: Always
6338             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
6339              
6340             Calls: GetMyeBayBuying
6341             Returned: Conditionally
6342             Details: DetailLevel: none, ReturnSummary, ReturnAll
6343             Context: BestOfferList
6344             BidList
6345             SecondChanceOffer
6346             WatchList
6347              
6348             Calls: GetMyeBaySelling
6349             Returned: Conditionally
6350             Details: DetailLevel: none, ReturnSummary, ReturnAll
6351             Context: ActiveList
6352             ScheduledList
6353             SoldList
6354             UnsoldList
6355             DeletedFromSoldList
6356             DeletedFromUnsoldList
6357             BidList
6358              
6359             Calls: GetSellerList
6360             Returned: Conditionally
6361             Details: DetailLevel: ItemReturnDescription, ReturnAll
6362             GranularityLevel: Coarse, Medium, Fine
6363              
6364              
6365             # Returns: 'xs:duration'
6366              
6367             =cut
6368              
6369             sub getTimeLeft {
6370             my $self = shift;
6371             return $self->{'TimeLeft'};
6372             }
6373              
6374              
6375             =head2 setTitle()
6376              
6377             Name of the item as it appears in the listing or search results.
6378             Required for most items. Optional if you list in Books, Music, Movies,
6379             or Video Games categories and you use Pre-filled Item Information
6380             (as the title can be pre-filled based on the catalog product title).
6381             That is, optional if you specify Item.ExternalProductID or Item.ProductListingDetails.
6382            
6383             You cannot use HTML or JavaScript in the Title. (HTML characters will be
6384             interpreted literally as plain text.)
6385            
6386             For AddItem, not applicable to Half.com. For GetOrders, not returned from eBay.com,
6387             but a title from the Half.com catalog is returned from Half.com instead.
6388            
6389             You can add or change the value of this tag only if an item has no bids
6390             (or no items have sold) and the listing does not end for 12 hours.
6391            
6392            
6393             In GetSearchResultsExpress, always returned when ItemArray.Item is returned.
6394            
6395             In GetItemRecommendations, more keywords in the title usually
6396             results in more relevant recommendations.
6397              
6398             MaxLength: 55
6399              
6400             Calls: AddItem
6401             AddLiveAuctionItem
6402             GetItemRecommendations
6403             VerifyAddItem
6404             RequiredInput: Conditionally
6405              
6406             Calls: RelistItem
6407             ReviseItem
6408             RequiredInput: No
6409              
6410             # Argument: 'xs:string'
6411              
6412             =cut
6413              
6414             sub setTitle {
6415             my $self = shift;
6416             $self->{'Title'} = shift
6417             }
6418              
6419             =head2 getTitle()
6420              
6421             Calls: GetSellerList
6422             Returned: Conditionally
6423             Details: DetailLevel: ItemReturnDescription, ReturnAll
6424             GranularityLevel: Coarse, Medium, Fine
6425              
6426              
6427             Calls: GetCategoryListings
6428             GetItemsAwaitingFeedback
6429             GetMemberMessages
6430             ReviseLiveAuctionItem
6431             Returned: Conditionally
6432              
6433             Calls: GetSearchResults
6434             Returned: Conditionally
6435             Details: DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll
6436             GranularityLevel: Coarse
6437              
6438              
6439             Calls: GetProducts
6440             Returned: Conditionally
6441              
6442             Calls: GetItemTransactions
6443             GetSellerTransactions
6444             Returned: Conditionally
6445             Details: DetailLevel: ReturnAll
6446              
6447             Calls: GetMyeBayBuying
6448             Returned: Conditionally
6449             Details: DetailLevel: none, ReturnSummary, ReturnAll
6450             Context: BestOfferList
6451             BidList
6452             LostList
6453             SecondChanceOffer
6454             WatchList
6455             WonList
6456             DeletedFromWonList
6457             DeletedFromLostList
6458              
6459             Calls: GetMyeBaySelling
6460             Returned: Conditionally
6461             Details: DetailLevel: none, ReturnSummary, ReturnAll
6462             Context: ActiveList
6463             ScheduledList
6464             SoldList
6465             UnsoldList
6466             DeletedFromSoldList
6467             DeletedFromUnsoldList
6468             BidList
6469              
6470             Calls: GetBidderList
6471             GetDispute
6472             Returned: Always
6473              
6474             Calls: GetOrders
6475             Returned: Always
6476             Details: DetailLevel: none
6477              
6478             Calls: GetItem
6479             Returned: Always
6480             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
6481              
6482             Calls: GetSellerEvents
6483             Returned: Conditionally
6484             Details: DetailLevel: none, ReturnAll
6485              
6486             # Returns: 'xs:string'
6487              
6488             =cut
6489              
6490             sub getTitle {
6491             my $self = shift;
6492             return $self->{'Title'};
6493             }
6494              
6495              
6496             =head2 setTotalQuestionCount()
6497              
6498             The number of questions asked about this item. Applies to eBay Motors Pro
6499             applications only.
6500              
6501             # Argument: 'xs:long'
6502              
6503             =cut
6504              
6505             sub setTotalQuestionCount {
6506             my $self = shift;
6507             $self->{'TotalQuestionCount'} = shift
6508             }
6509              
6510             =head2 getTotalQuestionCount()
6511              
6512             Calls: GetSellerList
6513             Returned: Conditionally
6514             Details: DetailLevel: ItemReturnDescription, ReturnAll
6515              
6516             # Returns: 'xs:long'
6517              
6518             =cut
6519              
6520             sub getTotalQuestionCount {
6521             my $self = shift;
6522             return $self->{'TotalQuestionCount'};
6523             }
6524              
6525              
6526             =head2 setUUID()
6527              
6528             Universally unique constraint tag. Use UUID to ensure that you only list a
6529             particular item once, particularly if you are listing many items at once. If
6530             you add an item and do not get a response, resend the request with the same
6531             UUID. If the item was successfully listed the first time, you will receive
6532             an error message for trying to use a UUID that you have already used. The
6533             error will also include the item ID for the duplicated item and a boolean
6534             value indicating whether the duplicate UUID was sent by the same application.
6535            

6536             We recommend you use Item.UUID with calls that add item objects
6537             (for example, AddItem, AddLiveAuctionItem, and RelistItem). For calls that
6538             modify an existing item, such as ReviseItem, use InvocationID instead.
6539            

6540             The UUID can only contain digits from 0-9 and letters from A-F and must be
6541             32 characters long. The UUID value must be unique across all item listings
6542             on all sites.
6543            

6544             Also applicable as input to AddItem and related calls when you list
6545             items to Half.com.
6546              
6547             MaxLength: 32
6548              
6549             Calls: AddItem
6550             AddLiveAuctionItem
6551             RelistItem
6552             VerifyAddItem
6553             RequiredInput: No
6554              
6555             # Argument: 'ns:UUIDType'
6556              
6557             =cut
6558              
6559             sub setUUID {
6560             my $self = shift;
6561             $self->{'UUID'} = shift
6562             }
6563              
6564             =head2 getUUID()
6565              
6566             Calls: GetBidderList
6567             Returned: Conditionally
6568              
6569             Calls: GetItem
6570             Returned: Conditionally
6571             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
6572              
6573             # Returns: 'ns:UUIDType'
6574              
6575             =cut
6576              
6577             sub getUUID {
6578             my $self = shift;
6579             return $self->_getDataTypeInstance( 'UUID'
6580             ,'eBay::API::XML::DataType::UUIDType');
6581             }
6582              
6583              
6584             =head2 setUpdateReturnPolicy()
6585              
6586             Specifies whether the Return Policy Details have been updated
6587             for the item specified in the request.
6588              
6589             Calls: ReviseItem
6590             RequiredInput: No
6591              
6592             # Argument: 'xs:boolean'
6593              
6594             =cut
6595              
6596             sub setUpdateReturnPolicy {
6597             my $self = shift;
6598             $self->{'UpdateReturnPolicy'} = shift
6599             }
6600              
6601             =head2 isUpdateReturnPolicy()
6602              
6603             # Returns: 'xs:boolean'
6604              
6605             =cut
6606              
6607             sub isUpdateReturnPolicy {
6608             my $self = shift;
6609             return $self->{'UpdateReturnPolicy'};
6610             }
6611              
6612              
6613             =head2 setUpdateSellerInfo()
6614              
6615             Specifies whether the following Business Seller fields have been updated for
6616             the item specified in the request: First Name, Last Name, Fax, Email
6617             Address, Additional Contact Information, Trade Registration Number,
6618             VAT Identification Number.
6619              
6620             Calls: ReviseItem
6621             RequiredInput: No
6622              
6623             # Argument: 'xs:boolean'
6624              
6625             =cut
6626              
6627             sub setUpdateSellerInfo {
6628             my $self = shift;
6629             $self->{'UpdateSellerInfo'} = shift
6630             }
6631              
6632             =head2 isUpdateSellerInfo()
6633              
6634             # Returns: 'xs:boolean'
6635              
6636             =cut
6637              
6638             sub isUpdateSellerInfo {
6639             my $self = shift;
6640             return $self->{'UpdateSellerInfo'};
6641             }
6642              
6643              
6644             =head2 setUseTaxTable()
6645              
6646             Indicates whether the seller's tax table is to be used when applying and
6647             calculating taxes. If true, a tax table must exist for the seller, and the
6648             following tags should not be used: SalesTaxState, SalesTaxPercent,
6649             ShippingIncludedInTax.
6650            
6651             If the seller wants to charge sales tax for eBay Express sales, the seller
6652             needs to create a tax table on eBay and use it for their listings. As eBay
6653             Express payments are handled via a shopping cart, you will not be able to
6654             calculate and add sales tax during your own checkout flow.
6655            

6656             Not applicable to Half.com.
6657              
6658             SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SalesTax
6659             Title: Enabling Multi-jurisdiction Sales Tax
6660             , URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ExpressTax
6661             Title: Specify Sales Tax for Express and eBay
6662              
6663              
6664             Calls: AddItem
6665             GetItemRecommendations
6666             RelistItem
6667             ReviseItem
6668             VerifyAddItem
6669             RequiredInput: No
6670              
6671             # Argument: 'xs:boolean'
6672              
6673             =cut
6674              
6675             sub setUseTaxTable {
6676             my $self = shift;
6677             $self->{'UseTaxTable'} = shift
6678             }
6679              
6680             =head2 isUseTaxTable()
6681              
6682             # Returns: 'xs:boolean'
6683              
6684             =cut
6685              
6686             sub isUseTaxTable {
6687             my $self = shift;
6688             return $self->{'UseTaxTable'};
6689             }
6690              
6691              
6692             =head2 setVATDetails()
6693              
6694             Container for eBay's VAT features. A business seller can choose to
6695             offer an item exclusively to bidders and buyers that also represent businesses.
6696             Only applicable when the item is listed in a B2B-enabled category (on a site
6697             that supports B2B business features).
6698             Not applicable to Half.com.
6699              
6700             SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=B2BVAT
6701             Title: Working with Business Features and VAT
6702             , URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=BusinessFeatureFieldDifferences
6703             Title: Business Feature Field Differences
6704              
6705              
6706             Calls: AddItem
6707             GetItemRecommendations
6708             RelistItem
6709             ReviseItem
6710             VerifyAddItem
6711             RequiredInput: Conditionally
6712              
6713             # Argument: 'ns:VATDetailsType'
6714              
6715             =cut
6716              
6717             sub setVATDetails {
6718             my $self = shift;
6719             $self->{'VATDetails'} = shift
6720             }
6721              
6722             =head2 getVATDetails()
6723              
6724             Calls: GetBidderList
6725             Returned: Conditionally
6726              
6727             Calls: GetItem
6728             Returned: Conditionally
6729             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
6730              
6731             # Returns: 'ns:VATDetailsType'
6732              
6733             =cut
6734              
6735             sub getVATDetails {
6736             my $self = shift;
6737             return $self->_getDataTypeInstance( 'VATDetails'
6738             ,'eBay::API::XML::DataType::VATDetailsType');
6739             }
6740              
6741              
6742             =head2 setWatchCount()
6743              
6744             The number of watches placed on this item from buyers' My eBay accounts.
6745             Specify IncludeWatchCount as true in the request.
6746             Returned by GetMyeBaySelling only if greater than 0.
6747             Not applicable to Half.com.
6748              
6749             # Argument: 'xs:long'
6750              
6751             =cut
6752              
6753             sub setWatchCount {
6754             my $self = shift;
6755             $self->{'WatchCount'} = shift
6756             }
6757              
6758             =head2 getWatchCount()
6759              
6760             Calls: GetSellerEvents
6761             Returned: Conditionally
6762             Details: DetailLevel: ReturnAll
6763              
6764             Calls: GetSellerList
6765             Returned: Conditionally
6766             Details: DetailLevel: ItemReturnDescription, ReturnAll
6767              
6768             Calls: GetItem
6769             Returned: Conditionally
6770             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
6771              
6772             Calls: GetMyeBaySelling
6773             Returned: Conditionally
6774              
6775             # Returns: 'xs:long'
6776              
6777             =cut
6778              
6779             sub getWatchCount {
6780             my $self = shift;
6781             return $self->{'WatchCount'};
6782             }
6783              
6784              
6785             =head2 setEBayNotes()
6786              
6787             Returns a note from eBay displayed below items in the user's My eBay account.
6788             Not applicable to Half.com.
6789              
6790             # Argument: 'xs:string'
6791              
6792             =cut
6793              
6794             sub setEBayNotes {
6795             my $self = shift;
6796             $self->{'eBayNotes'} = shift
6797             }
6798              
6799             =head2 getEBayNotes()
6800              
6801             Calls: GetMyeBayBuying
6802             Returned: Conditionally
6803             Details: DetailLevel: none, ReturnSummary, ReturnAll
6804              
6805             # Returns: 'xs:string'
6806              
6807             =cut
6808              
6809             sub getEBayNotes {
6810             my $self = shift;
6811             return $self->{'eBayNotes'};
6812             }
6813              
6814              
6815              
6816              
6817              
6818             ## Attribute and Property lists
6819             sub getPropertiesList {
6820             my $self = shift;
6821             return \@gaProperties;
6822             }
6823              
6824             sub getAttributesList {
6825             my $self = shift;
6826             return \@gaAttributes;
6827             }
6828              
6829              
6830              
6831             1;