File Coverage

lib/eBay/API/XML/DataType/ListingDetailsType.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::ListingDetailsType;
4              
5 1     1   1906 use strict;
  1         3  
  1         168  
6 1     1   6 use warnings;
  1         2  
  1         35  
7              
8             ##########################################################################
9             #
10             # Module: ............... eBay/API/XML
11             # File: ................. ListingDetailsType.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::ListingDetailsType
21              
22             =head1 DESCRIPTION
23              
24             Various details about a listing. Some of the details are calculated or derived after
25             an item is listed. The details in this type include the start and end time and
26             the converted (localized) prices. The details in this type also include
27             input values applicable to the Best Offer feature.
28             Additional details in this type include flags indicating if a seller
29             specified fields whose values are not visible to the requesting user.
30              
31              
32              
33             =head1 SYNOPSIS
34              
35             =cut
36              
37              
38             =head1 INHERITANCE
39              
40             eBay::API::XML::DataType::ListingDetailsType inherits from the L class
41              
42             =cut
43              
44 1     1   44 use eBay::API::XML::BaseDataType;
  0            
  0            
45             our @ISA = ("eBay::API::XML::BaseDataType");
46              
47             use eBay::API::XML::DataType::AmountType;
48             use eBay::API::XML::DataType::ItemIDType;
49             use eBay::API::XML::DataType::Enum::SellerBusinessCodeType;
50              
51              
52             my @gaProperties = ( [ 'Adult', 'xs:boolean', '', '', '' ]
53             , [ 'BestOfferAutoAcceptPrice', 'ns:AmountType', ''
54             ,'eBay::API::XML::DataType::AmountType', '1' ]
55             , [ 'BindingAuction', 'xs:boolean', '', '', '' ]
56             , [ 'BuyItNowAvailable', 'xs:boolean', '', '', '' ]
57             , [ 'CheckoutEnabled', 'xs:boolean', '', '', '' ]
58             , [ 'ConvertedBuyItNowPrice', 'ns:AmountType', ''
59             ,'eBay::API::XML::DataType::AmountType', '1' ]
60             , [ 'ConvertedReservePrice', 'ns:AmountType', ''
61             ,'eBay::API::XML::DataType::AmountType', '1' ]
62             , [ 'ConvertedStartPrice', 'ns:AmountType', ''
63             ,'eBay::API::XML::DataType::AmountType', '1' ]
64             , [ 'EndTime', 'xs:dateTime', '', '', '' ]
65             , [ 'HasPublicMessages', 'xs:boolean', '', '', '' ]
66             , [ 'HasReservePrice', 'xs:boolean', '', '', '' ]
67             , [ 'HasUnansweredQuestions', 'xs:boolean', '', '', '' ]
68             , [ 'LocalListingDistance', 'xs:string', '', '', '' ]
69             , [ 'MinimumBestOfferMessage', 'xs:string', '', '', '' ]
70             , [ 'MinimumBestOfferPrice', 'ns:AmountType', ''
71             ,'eBay::API::XML::DataType::AmountType', '1' ]
72             , [ 'PayPerLeadEnabled', 'xs:boolean', '', '', '' ]
73             , [ 'RelistedItemID', 'ns:ItemIDType', ''
74             ,'eBay::API::XML::DataType::ItemIDType', '1' ]
75             , [ 'SecondChanceOriginalItemID', 'ns:ItemIDType', ''
76             ,'eBay::API::XML::DataType::ItemIDType', '1' ]
77             , [ 'SellerBusinessType', 'ns:SellerBusinessCodeType', ''
78             ,'eBay::API::XML::DataType::Enum::SellerBusinessCodeType', '' ]
79             , [ 'StartTime', 'xs:dateTime', '', '', '' ]
80             , [ 'TCROriginalItemID', 'ns:ItemIDType', ''
81             ,'eBay::API::XML::DataType::ItemIDType', '1' ]
82             , [ 'ViewItemURL', 'xs:anyURI', '', '', '' ]
83             , [ 'ViewItemURLForNaturalSearch', 'xs:anyURI', '', '', '' ]
84             );
85             push @gaProperties, @{eBay::API::XML::BaseDataType::getPropertiesList()};
86              
87             my @gaAttributes = (
88             );
89             push @gaAttributes, @{eBay::API::XML::BaseDataType::getAttributesList()};
90              
91             =head1 Subroutines:
92              
93             =cut
94              
95             sub new {
96             my $classname = shift;
97             my %args = @_;
98             my $self = $classname->SUPER::new(%args);
99             return $self;
100             }
101              
102             sub isScalar {
103             return 0;
104             }
105              
106              
107              
108             =head2 setAdult()
109              
110             If true, the item is listed in a Mature category. Users must accept
111             the Mature Category agreement on the eBay site to retrieve
112             items listed in Mature categories. (Users do not need to sign
113             this agreement to be able to list items in Mature Categories.)
114              
115             # Argument: 'xs:boolean'
116              
117             =cut
118              
119             sub setAdult {
120             my $self = shift;
121             $self->{'Adult'} = shift
122             }
123              
124             =head2 isAdult()
125              
126             Calls: GetBidderList
127             Returned: Always
128              
129             Calls: GetItem
130             Returned: Always
131             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
132              
133             Calls: GetItemTransactions
134             GetSellerTransactions
135             Returned: Conditionally
136             Details: DetailLevel: ReturnAll
137              
138             Calls: GetSellerList
139             Returned: Conditionally
140             Details: DetailLevel: ItemReturnDescription, ReturnAll
141             GranularityLevel: Medium, Fine
142              
143              
144             # Returns: 'xs:boolean'
145              
146             =cut
147              
148             sub isAdult {
149             my $self = shift;
150             return $self->{'Adult'};
151             }
152              
153              
154             =head2 setBestOfferAutoAcceptPrice()
155              
156             The price at which best offers are automatically accepted.
157             Similar in use to MinimumBestOfferPrice.
158             If a buyer submits a best offer that is above this value,
159             the offer is automatically
160             accepted by the seller.
161             Applies only to items listed in categories that
162             support the BestOfferAutoAcceptPrice feature.
163             Best Offer must be enabled
164             for the item, and only the seller who listed the item
165             will see BestOfferAutoAcceptPrice in a call response.
166             On the US eBay Motors site (site ID 100),
167             you cannot use the API to add a minimum best offer price.
168             For a ReviseItem call with site ID 100,
169             prior use of a minimum best offer price on eBay.com is ignored.
170              
171             Calls: AddItem
172             ReviseItem
173             RelistItem
174             VerifyAddItem
175             RequiredInput: No
176              
177             # Argument: 'ns:AmountType'
178              
179             =cut
180              
181             sub setBestOfferAutoAcceptPrice {
182             my $self = shift;
183             $self->{'BestOfferAutoAcceptPrice'} = shift
184             }
185              
186             =head2 getBestOfferAutoAcceptPrice()
187              
188             Calls: GetItem
189             Returned: Conditionally
190             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
191              
192             Calls: GetSellerList
193             Returned: Conditionally
194             Details: DetailLevel: ItemReturnDescription, ReturnAll
195              
196             # Returns: 'ns:AmountType'
197              
198             =cut
199              
200             sub getBestOfferAutoAcceptPrice {
201             my $self = shift;
202             return $self->_getDataTypeInstance( 'BestOfferAutoAcceptPrice'
203             ,'eBay::API::XML::DataType::AmountType');
204             }
205              
206              
207             =head2 setBindingAuction()
208              
209             Applicable for Real Estate auctions only. If true, buyers and sellers
210             are expected to follow through on the sale. If false, bids for the
211             Real Estate auction are only expressions of interest.
212              
213             # Argument: 'xs:boolean'
214              
215             =cut
216              
217             sub setBindingAuction {
218             my $self = shift;
219             $self->{'BindingAuction'} = shift
220             }
221              
222             =head2 isBindingAuction()
223              
224             Calls: GetBidderList
225             Returned: Always
226              
227             Calls: GetItem
228             Returned: Always
229             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
230              
231             Calls: GetItemTransactions
232             GetSellerTransactions
233             Returned: Conditionally
234             Details: DetailLevel: ReturnAll
235              
236             Calls: GetSellerList
237             Returned: Conditionally
238             Details: DetailLevel: ItemReturnDescription, ReturnAll
239             GranularityLevel: Medium, Fine
240              
241              
242             # Returns: 'xs:boolean'
243              
244             =cut
245              
246             sub isBindingAuction {
247             my $self = shift;
248             return $self->{'BindingAuction'};
249             }
250              
251              
252             =head2 setBuyItNowAvailable()
253              
254             Indicates whether Buy It Now is available for the listing (for Chinese and Dutch auctions).
255             As a general rule, once a Chinese auction has bids (and the high bid exceeds the reserve price, if any),
256             the listing is no longer eligible for Buy It Now.
257            

258             On some sites, the Buy It Now price for a Chinese auction may remain available
259             for certain categories even after a bid is placed.
260             See the "Longer Lasting Buy It Now" link below for more details and the
261             latest list of eBay US categories that support this behavior.
262             The eBay Spain site supports this behavior for all categories.
263              
264             SeeLink: URL: http://forums.ebay.com/db1/thread.jspa?threadID=2000449591&anticache=1207252776668
265             Title: Longer Lasting Buy It Now
266              
267             # Argument: 'xs:boolean'
268              
269             =cut
270              
271             sub setBuyItNowAvailable {
272             my $self = shift;
273             $self->{'BuyItNowAvailable'} = shift
274             }
275              
276             =head2 isBuyItNowAvailable()
277              
278             Calls: GetBidderList
279             Returned: Conditionally
280              
281             Calls: GetItem
282             Returned: Conditionally
283             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
284              
285             # Returns: 'xs:boolean'
286              
287             =cut
288              
289             sub isBuyItNowAvailable {
290             my $self = shift;
291             return $self->{'BuyItNowAvailable'};
292             }
293              
294              
295             =head2 setCheckoutEnabled()
296              
297             Indicates whether checkout is enabled for this item. If true, indicates
298             that the seller elects to allow the item purchase to go through the
299             checkout process, if the buyer chooses to do so.
300              
301             SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Checkout
302             Title: Checkout
303              
304             # Argument: 'xs:boolean'
305              
306             =cut
307              
308             sub setCheckoutEnabled {
309             my $self = shift;
310             $self->{'CheckoutEnabled'} = shift
311             }
312              
313             =head2 isCheckoutEnabled()
314              
315             Calls: GetBidderList
316             Returned: Always
317              
318             Calls: GetItem
319             Returned: Always
320             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
321              
322             Calls: GetItemTransactions
323             GetSellerTransactions
324             Returned: Conditionally
325             Details: DetailLevel: ReturnAll
326              
327             Calls: GetSellerList
328             Returned: Conditionally
329             Details: DetailLevel: ItemReturnDescription, ReturnAll
330             GranularityLevel: Medium, Fine
331              
332              
333             # Returns: 'xs:boolean'
334              
335             =cut
336              
337             sub isCheckoutEnabled {
338             my $self = shift;
339             return $self->{'CheckoutEnabled'};
340             }
341              
342              
343             =head2 setConvertedBuyItNowPrice()
344              
345             Converted value of the BuyItNowPrice in the currency of
346             the site that returned this response.
347             For active items, refresh this value every 24 hours to
348             pick up the current conversion rates.
349              
350             # Argument: 'ns:AmountType'
351              
352             =cut
353              
354             sub setConvertedBuyItNowPrice {
355             my $self = shift;
356             $self->{'ConvertedBuyItNowPrice'} = shift
357             }
358              
359             =head2 getConvertedBuyItNowPrice()
360              
361             Calls: GetCategoryListings
362             Returned: Conditionally
363              
364             Calls: GetItemTransactions
365             GetSellerTransactions
366             Returned: Conditionally
367             Details: DetailLevel: ReturnAll
368              
369             Calls: GetSellerList
370             Returned: Conditionally
371             Details: DetailLevel: ItemReturnDescription, ReturnAll
372             GranularityLevel: Medium, Fine
373              
374              
375             Calls: GetMyeBayBuying
376             Returned: Conditionally
377             Details: DetailLevel: none, ReturnSummary, ReturnAll
378             Context: SecondChanceOffer
379              
380             Calls: GetMyeBaySelling
381             Returned: Conditionally
382             Details: DetailLevel: none, ReturnSummary, ReturnAll
383             Context: ScheduledList
384             SoldList
385             UnsoldList
386             DeletedFromSoldList
387             DeletedFromUnsoldList
388              
389             Calls: GetBidderList
390             Returned: Always
391              
392             Calls: GetItem
393             Returned: Always
394             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
395              
396             Calls: GetSearchResults
397             Returned: Conditionally
398             Details: DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll
399             GranularityLevel: Coarse
400              
401              
402             # Returns: 'ns:AmountType'
403              
404             =cut
405              
406             sub getConvertedBuyItNowPrice {
407             my $self = shift;
408             return $self->_getDataTypeInstance( 'ConvertedBuyItNowPrice'
409             ,'eBay::API::XML::DataType::AmountType');
410             }
411              
412              
413             =head2 setConvertedReservePrice()
414              
415             Converted value of the ReservePrice in the currency of the
416             site that returned this response. Only returned for listings with
417             a reserve price when the requesting user is the listing's seller.
418             For active items, refresh this value every 24 hours to
419             pick up the current conversion rates.
420             Not applicable to Fixed Price and Store Inventory listings.
421              
422             # Argument: 'ns:AmountType'
423              
424             =cut
425              
426             sub setConvertedReservePrice {
427             my $self = shift;
428             $self->{'ConvertedReservePrice'} = shift
429             }
430              
431             =head2 getConvertedReservePrice()
432              
433             Calls: GetBidderList
434             Returned: Conditionally
435              
436             Calls: GetMyeBaySelling
437             Returned: Conditionally
438             Details: DetailLevel: none, ReturnSummary, ReturnAll
439             Context: ScheduledList
440             SoldList
441             UnsoldList
442             DeletedFromSoldList
443             DeletedFromUnsoldList
444              
445             Calls: GetItemTransactions
446             GetSellerTransactions
447             Returned: Conditionally
448             Details: DetailLevel: ReturnAll
449              
450             Calls: GetSellerList
451             Returned: Conditionally
452             Details: DetailLevel: ItemReturnDescription, ReturnAll
453             GranularityLevel: Fine
454              
455              
456             Calls: GetItem
457             Returned: Conditionally
458             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
459              
460             # Returns: 'ns:AmountType'
461              
462             =cut
463              
464             sub getConvertedReservePrice {
465             my $self = shift;
466             return $self->_getDataTypeInstance( 'ConvertedReservePrice'
467             ,'eBay::API::XML::DataType::AmountType');
468             }
469              
470              
471             =head2 setConvertedStartPrice()
472              
473             Converted value of the StartPrice in the currency of
474             the site that returned this response.
475             For active items, refresh this value every 24 hours to
476             pick up the current conversion rates.
477              
478             # Argument: 'ns:AmountType'
479              
480             =cut
481              
482             sub setConvertedStartPrice {
483             my $self = shift;
484             $self->{'ConvertedStartPrice'} = shift
485             }
486              
487             =head2 getConvertedStartPrice()
488              
489             Calls: GetSearchResults
490             Returned: Conditionally
491             Details: DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll
492              
493             Calls: GetItemTransactions
494             GetSellerTransactions
495             Returned: Conditionally
496             Details: DetailLevel: ReturnAll
497              
498             Calls: GetSellerList
499             Returned: Conditionally
500             Details: DetailLevel: ItemReturnDescription, ReturnAll
501             GranularityLevel: Fine
502              
503              
504             Calls: GetMyeBayBuying
505             Returned: Conditionally
506             Details: DetailLevel: none, ReturnSummary, ReturnAll
507             Context: BidList
508             LostList
509             WonList
510             DeletedFromWonList
511             DeletedFromLostList
512              
513             Calls: GetMyeBaySelling
514             Returned: Conditionally
515             Details: DetailLevel: none, ReturnSummary, ReturnAll
516             Context: ScheduledList
517             SoldList
518             UnsoldList
519             DeletedFromSoldList
520             DeletedFromUnsoldList
521             BidList
522              
523             Calls: GetBidderList
524             Returned: Always
525              
526             Calls: GetItem
527             Returned: Always
528             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
529              
530             # Returns: 'ns:AmountType'
531              
532             =cut
533              
534             sub getConvertedStartPrice {
535             my $self = shift;
536             return $self->_getDataTypeInstance( 'ConvertedStartPrice'
537             ,'eBay::API::XML::DataType::AmountType');
538             }
539              
540              
541             =head2 setEndTime()
542              
543             Time stamp (in GMT) when the listing is scheduled to end
544             (calculated based on the values of StartTime and ListingDuration)
545             or the actual end time if the item has ended.
546             In GetSearchResults, for StoresFixedPrice items which
547             are "Good Till Canceled," this value is 5 minutes later than
548             the actual end time of the item. The discrepancy is intended
549             to facilitate renewal every 30 days of such items' end times.
550              
551             # Argument: 'xs:dateTime'
552              
553             =cut
554              
555             sub setEndTime {
556             my $self = shift;
557             $self->{'EndTime'} = shift
558             }
559              
560             =head2 getEndTime()
561              
562             Calls: GetBidderList
563             GetDispute
564             Returned: Always
565              
566             Calls: GetItem
567             Returned: Always
568             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
569              
570             Calls: GetItemTransactions
571             GetSellerTransactions
572             Returned: Conditionally
573             Details: DetailLevel: ReturnAll
574              
575             Calls: GetSellerList
576             Returned: Conditionally
577             Details: DetailLevel: none, ItemReturnDescription, ReturnAll
578              
579             Calls: GetBestOffers
580             Returned: Conditionally
581             Details: DetailLevel: none, ReturnAll
582              
583             Calls: GetCategoryListings
584             GetItemsAwaitingFeedback
585             GetMemberMessages
586             Returned: Conditionally
587              
588             Calls: GetSearchResults
589             Returned: Conditionally
590             Details: DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll
591             GranularityLevel: Coarse
592              
593              
594             Calls: GetMyeBayBuying
595             Returned: Conditionally
596             Details: DetailLevel: none, ReturnSummary, ReturnAll
597             Context: BidList
598             LostList
599             SecondChanceOffer
600             WatchList
601             WonList
602             DeletedFromWonList
603             DeletedFromLostList
604              
605             Calls: GetMyeBaySelling
606             Returned: Conditionally
607             Details: DetailLevel: none, ReturnSummary, ReturnAll
608             Context: SoldList
609             UnsoldList
610             DeletedFromSoldList
611             DeletedFromUnsoldList
612             BidList
613              
614             Calls: GetSellerEvents
615             Returned: Conditionally
616             Details: DetailLevel: none, ReturnAll
617              
618             Calls: GetProducts
619             Returned: Conditionally
620              
621             # Returns: 'xs:dateTime'
622              
623             =cut
624              
625             sub getEndTime {
626             my $self = shift;
627             return $self->{'EndTime'};
628             }
629              
630              
631             =head2 setHasPublicMessages()
632              
633             Indicates whether the item has any publicly displayed messages. Use
634             GetMemberMessages to retrieve public messages for the item if this flag
635             indicates that there are any.
636              
637             # Argument: 'xs:boolean'
638              
639             =cut
640              
641             sub setHasPublicMessages {
642             my $self = shift;
643             $self->{'HasPublicMessages'} = shift
644             }
645              
646             =head2 isHasPublicMessages()
647              
648             Calls: GetBidderList
649             Returned: Always
650              
651             Calls: GetItem
652             Returned: Always
653             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
654              
655             Calls: GetItemTransactions
656             GetSellerTransactions
657             Returned: Conditionally
658             Details: DetailLevel: ReturnAll
659              
660             Calls: GetSellerList
661             Returned: Conditionally
662             Details: DetailLevel: ItemReturnDescription, ReturnAll
663              
664             # Returns: 'xs:boolean'
665              
666             =cut
667              
668             sub isHasPublicMessages {
669             my $self = shift;
670             return $self->{'HasPublicMessages'};
671             }
672              
673              
674             =head2 setHasReservePrice()
675              
676             If true, the seller specified a value in ReservePrice.
677              
678             # Argument: 'xs:boolean'
679              
680             =cut
681              
682             sub setHasReservePrice {
683             my $self = shift;
684             $self->{'HasReservePrice'} = shift
685             }
686              
687             =head2 isHasReservePrice()
688              
689             Calls: GetBidderList
690             Returned: Always
691              
692             Calls: GetItem
693             Returned: Always
694             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
695              
696             Calls: GetItemTransactions
697             GetSellerTransactions
698             Returned: Conditionally
699             Details: DetailLevel: ReturnAll
700              
701             Calls: GetSellerList
702             Returned: Conditionally
703             Details: DetailLevel: ItemReturnDescription, ReturnAll
704             GranularityLevel: Medium, Fine
705              
706              
707             Calls: GetMyeBayBuying
708             Returned: Conditionally
709             Details: DetailLevel: none, ReturnSummary, ReturnAll
710             Context: WonList
711             DeletedFromWonList
712              
713             # Returns: 'xs:boolean'
714              
715             =cut
716              
717             sub isHasReservePrice {
718             my $self = shift;
719             return $self->{'HasReservePrice'};
720             }
721              
722              
723             =head2 setHasUnansweredQuestions()
724              
725             Indicates whether the item has any unanswered questions. Use
726             GetMemberMessages to retrieve unanswered questions for the item if this flag
727             indicates that there are any.
728              
729             # Argument: 'xs:boolean'
730              
731             =cut
732              
733             sub setHasUnansweredQuestions {
734             my $self = shift;
735             $self->{'HasUnansweredQuestions'} = shift
736             }
737              
738             =head2 isHasUnansweredQuestions()
739              
740             Calls: GetBidderList
741             Returned: Always
742              
743             Calls: GetItem
744             Returned: Always
745             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
746              
747             Calls: GetItemTransactions
748             GetSellerTransactions
749             Returned: Conditionally
750             Details: DetailLevel: ReturnAll
751              
752             Calls: GetSellerList
753             Returned: Conditionally
754             Details: DetailLevel: ItemReturnDescription, ReturnAll
755              
756             # Returns: 'xs:boolean'
757              
758             =cut
759              
760             sub isHasUnansweredQuestions {
761             my $self = shift;
762             return $self->{'HasUnansweredQuestions'};
763             }
764              
765              
766             =head2 setLocalListingDistance()
767              
768             Specifies a distance (in miles) used as the radius of the area about the
769             supplied postal code that constitutes the local market. Use
770             GetCategoryFeatures to determine the local listing distances supported by
771             a given site, category, and Local Market subscription level.
772              
773             Calls: AddItem
774             GetItemRecommendations
775             RequiredInput: Conditionally
776              
777             # Argument: 'xs:string'
778              
779             =cut
780              
781             sub setLocalListingDistance {
782             my $self = shift;
783             $self->{'LocalListingDistance'} = shift
784             }
785              
786             =head2 getLocalListingDistance()
787              
788             # Returns: 'xs:string'
789              
790             =cut
791              
792             sub getLocalListingDistance {
793             my $self = shift;
794             return $self->{'LocalListingDistance'};
795             }
796              
797              
798             =head2 setMinimumBestOfferMessage()
799              
800             Specifies the message sent from the seller to the buyer when a
801             submitted best offer is automatically declined by the seller. A best offer
802             is automatically declined if it does not meet the minimum acceptable best
803             offer price specified by the seller with MinimumBestOfferPrice. Applies only
804             to items listed in categories that support the Best Offer Auto-Decline
805             feature. Best Offer must be enabled for the item.
806             To remove this value when revising or relisting an item, use DeletedField.
807              
808             DeprecationDetails: NoOp
809             DeprecationVersion: 547
810             UseInstead:
811             Calls: AddItem
812             GetItemRecommendations
813             ReviseItem
814             RelistItem
815             VerifyAddItem
816             RequiredInput: No
817              
818             # Argument: 'xs:string'
819              
820             =cut
821              
822             sub setMinimumBestOfferMessage {
823             my $self = shift;
824             $self->{'MinimumBestOfferMessage'} = shift
825             }
826              
827             =head2 getMinimumBestOfferMessage()
828              
829             Calls: GetItem
830             Returned: Conditionally
831             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
832              
833             Calls: GetItemTransactions
834             GetSellerTransactions
835             Returned: Conditionally
836             Details: DetailLevel: ReturnAll
837              
838             Calls: GetSellerList
839             Returned: Conditionally
840             Details: DetailLevel: ItemReturnDescription, ReturnAll
841              
842             # Returns: 'xs:string'
843              
844             =cut
845              
846             sub getMinimumBestOfferMessage {
847             my $self = shift;
848             return $self->{'MinimumBestOfferMessage'};
849             }
850              
851              
852             =head2 setMinimumBestOfferPrice()
853              
854             Specifies the minimum acceptable best offer price. If a buyer
855             submits a best offer that is below this value, the offer is automatically
856             declined by the seller. Applies only to items listed in categories that
857             support the Best Offer Auto-Decline feature. Best Offer must be enabled
858             for the item, and only the seller who listed the item can see this value.
859             To remove this value when revising or relisting an item, use DeletedField.
860              
861             Calls: AddItem
862             GetItemRecommendations
863             ReviseItem
864             RelistItem
865             VerifyAddItem
866             RequiredInput: No
867              
868             # Argument: 'ns:AmountType'
869              
870             =cut
871              
872             sub setMinimumBestOfferPrice {
873             my $self = shift;
874             $self->{'MinimumBestOfferPrice'} = shift
875             }
876              
877             =head2 getMinimumBestOfferPrice()
878              
879             Calls: GetItem
880             Returned: Conditionally
881             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
882              
883             Calls: GetItemTransactions
884             GetSellerTransactions
885             Returned: Conditionally
886             Details: DetailLevel: ReturnAll
887              
888             Calls: GetSellerList
889             Returned: Conditionally
890             Details: DetailLevel: ItemReturnDescription, ReturnAll
891              
892             # Returns: 'ns:AmountType'
893              
894             =cut
895              
896             sub getMinimumBestOfferPrice {
897             my $self = shift;
898             return $self->_getDataTypeInstance( 'MinimumBestOfferPrice'
899             ,'eBay::API::XML::DataType::AmountType');
900             }
901              
902              
903             =head2 setPayPerLeadEnabled()
904              
905             If true as an input or output field, the item is pay-per-lead-enabled.
906             This field applies to the pay-per-lead feature, which is
907             planned for availability on the US site in upcoming months.
908              
909             Default: false
910              
911             Calls: AddItem
912             ReviseItem
913             RelistItem
914             VerifyAddItem
915             RequiredInput: No
916              
917             # Argument: 'xs:boolean'
918              
919             =cut
920              
921             sub setPayPerLeadEnabled {
922             my $self = shift;
923             $self->{'PayPerLeadEnabled'} = shift
924             }
925              
926             =head2 isPayPerLeadEnabled()
927              
928             Calls: GetItem
929             Returned: Conditionally
930             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
931              
932             Calls: GetSellerList
933             Returned: Conditionally
934             Details: DetailLevel: ItemReturnDescription, ReturnAll
935              
936             # Returns: 'xs:boolean'
937              
938             =cut
939              
940             sub isPayPerLeadEnabled {
941             my $self = shift;
942             return $self->{'PayPerLeadEnabled'};
943             }
944              
945              
946             =head2 setRelistedItemID()
947              
948             Indicates the new item ID for a re-listed item. When an item is
949             re-listed, the item ID for the new (re-list) item is added to the
950             old (expired) listing to provide buyers a means to navigate to
951             the new listing. This value only appears when the old listing is
952             retrieved.
953             Output only.
954              
955             # Argument: 'ns:ItemIDType'
956              
957             =cut
958              
959             sub setRelistedItemID {
960             my $self = shift;
961             $self->{'RelistedItemID'} = shift
962             }
963              
964             =head2 getRelistedItemID()
965              
966             Calls: GetBidderList
967             Returned: Conditionally
968              
969             Calls: GetItem
970             Returned: Conditionally
971             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
972              
973             Calls: GetItemTransactions
974             GetSellerTransactions
975             Returned: Conditionally
976             Details: DetailLevel: ReturnAll
977              
978             Calls: GetSellerList
979             Returned: Conditionally
980             Details: DetailLevel: ItemReturnDescription, ReturnAll
981              
982             # Returns: 'ns:ItemIDType'
983              
984             =cut
985              
986             sub getRelistedItemID {
987             my $self = shift;
988             return $self->_getDataTypeInstance( 'RelistedItemID'
989             ,'eBay::API::XML::DataType::ItemIDType');
990             }
991              
992              
993             =head2 setSecondChanceOriginalItemID()
994              
995             The item ID for the original listing from which a second chance offer
996             is made. This value is only returned when the data for the second chance
997             offer listing is retrieved.
998             Output only.
999              
1000             # Argument: 'ns:ItemIDType'
1001              
1002             =cut
1003              
1004             sub setSecondChanceOriginalItemID {
1005             my $self = shift;
1006             $self->{'SecondChanceOriginalItemID'} = shift
1007             }
1008              
1009             =head2 getSecondChanceOriginalItemID()
1010              
1011             Calls: GetBidderList
1012             Returned: Conditionally
1013              
1014             Calls: GetItem
1015             Returned: Conditionally
1016             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
1017              
1018             # Returns: 'ns:ItemIDType'
1019              
1020             =cut
1021              
1022             sub getSecondChanceOriginalItemID {
1023             my $self = shift;
1024             return $self->_getDataTypeInstance( 'SecondChanceOriginalItemID'
1025             ,'eBay::API::XML::DataType::ItemIDType');
1026             }
1027              
1028              
1029             =head2 setSellerBusinessType()
1030              
1031             Type of seller account. This value is not returned for most sites.
1032             This value is not returned for the German site
1033             (site ID 77) or eBay Motors site (site ID 100).
1034              
1035             # Argument: 'ns:SellerBusinessCodeType'
1036              
1037             =cut
1038              
1039             sub setSellerBusinessType {
1040             my $self = shift;
1041             $self->{'SellerBusinessType'} = shift
1042             }
1043              
1044             =head2 getSellerBusinessType()
1045              
1046             Calls: GetSearchResults
1047             Returned: Conditionally
1048             Details: DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll
1049              
1050             # Returns: 'ns:SellerBusinessCodeType'
1051              
1052             =cut
1053              
1054             sub getSellerBusinessType {
1055             my $self = shift;
1056             return $self->{'SellerBusinessType'};
1057             }
1058              
1059              
1060             =head2 setStartTime()
1061              
1062             The StartTime value returned by non-search calls such as
1063             GetItem is the time stamp (in GMT) for when
1064             the item was listed.
1065             The StartTime value returned by search calls such
1066             as GetSearchResults and GetCategoryListings may vary
1067             from the value returned by GetItem.
1068             The time value is the same value in the following:
1069             The StartTime value returned by GetSearchResults,
1070             the StartTime value returned by GetCategoryListings,
1071             and the time the item became available for search on
1072             the eBay site.
1073              
1074             # Argument: 'xs:dateTime'
1075              
1076             =cut
1077              
1078             sub setStartTime {
1079             my $self = shift;
1080             $self->{'StartTime'} = shift
1081             }
1082              
1083             =head2 getStartTime()
1084              
1085             Calls: GetBidderList
1086             GetDispute
1087             Returned: Always
1088              
1089             Calls: GetItem
1090             Returned: Always
1091             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
1092              
1093             Calls: GetCategoryListings
1094             GetMemberMessages
1095             GetProducts
1096             Returned: Conditionally
1097              
1098             Calls: GetSearchResults
1099             Returned: Conditionally
1100             Details: DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll
1101             GranularityLevel: Coarse
1102              
1103              
1104             Calls: GetItemTransactions
1105             GetSellerTransactions
1106             Returned: Conditionally
1107             Details: DetailLevel: ReturnAll
1108              
1109             Calls: GetSellerList
1110             Returned: Conditionally
1111             Details: DetailLevel: none, ItemReturnDescription, ReturnAll
1112              
1113             Calls: GetMyeBayBuying
1114             Returned: Conditionally
1115             Details: DetailLevel: none, ReturnSummary, ReturnAll
1116             Context: BestOfferList
1117             BidList
1118             LostList
1119             WatchList
1120             WonList
1121             DeletedFromWonList
1122             DeletedFromLostList
1123              
1124             Calls: GetMyeBaySelling
1125             Returned: Conditionally
1126             Details: DetailLevel: none, ReturnSummary, ReturnAll
1127             Context: ActiveList
1128             ScheduledList
1129             SoldList
1130             UnsoldList
1131             DeletedFromSoldList
1132             DeletedFromUnsoldList
1133             BidList
1134              
1135             Calls: GetSellerEvents
1136             Returned: Conditionally
1137             Details: DetailLevel: none, ReturnAll
1138              
1139             # Returns: 'xs:dateTime'
1140              
1141             =cut
1142              
1143             sub getStartTime {
1144             my $self = shift;
1145             return $self->{'StartTime'};
1146             }
1147              
1148              
1149             =head2 setTCROriginalItemID()
1150              
1151             Indicates the item ID of the original item listing from which a
1152             Transaction Confirmation Request (TCR) was created. This value is only
1153             returned when the data for a TCR is retrieved.
1154              
1155             # Argument: 'ns:ItemIDType'
1156              
1157             =cut
1158              
1159             sub setTCROriginalItemID {
1160             my $self = shift;
1161             $self->{'TCROriginalItemID'} = shift
1162             }
1163              
1164             =head2 getTCROriginalItemID()
1165              
1166             Calls: GetItem
1167             Returned: Conditionally
1168             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
1169              
1170             Calls: GetItemTransactions
1171             GetSellerTransactions
1172             Returned: Conditionally
1173             Details: DetailLevel: ReturnAll
1174              
1175             Calls: GetSellerList
1176             Returned: Conditionally
1177             Details: DetailLevel: none, ItemReturnDescription, ReturnAll
1178              
1179             Calls: GetBidderList
1180             Returned: Conditionally
1181              
1182             # Returns: 'ns:ItemIDType'
1183              
1184             =cut
1185              
1186             sub getTCROriginalItemID {
1187             my $self = shift;
1188             return $self->_getDataTypeInstance( 'TCROriginalItemID'
1189             ,'eBay::API::XML::DataType::ItemIDType');
1190             }
1191              
1192              
1193             =head2 setViewItemURL()
1194              
1195             The URL of the Web page where a user can view the listing.
1196             On the US site, this is called the "View Item" page.
1197             If you enabled affiliate tracking in a search-related call
1198             (for example, if you used the AffiliateTrackingDetails container
1199             in an applicable call), ViewItemURL contains
1200             a string that includes affiliate tracking information
1201             (see the
1202             eBay Partner Network).
1203             For GetSearchResultsExpress, the ViewItemURL field is returned only if you specified
1204             AffiliateTrackingDetails in the request.
1205              
1206             # Argument: 'xs:anyURI'
1207              
1208             =cut
1209              
1210             sub setViewItemURL {
1211             my $self = shift;
1212             $self->{'ViewItemURL'} = shift
1213             }
1214              
1215             =head2 getViewItemURL()
1216              
1217             Calls: GetBidderList
1218             Returned: Always
1219              
1220             Calls: GetItem
1221             Returned: Always
1222             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
1223              
1224             Calls: GetCategoryListings
1225             GetProducts
1226             Returned: Conditionally
1227              
1228             Calls: GetMyeBayBuying
1229             Returned: Conditionally
1230             Details: DetailLevel: none, ReturnSummary, ReturnAll
1231             Context: WatchList
1232              
1233             Calls: GetSearchResults
1234             Returned: Conditionally
1235             Details: DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll
1236             GranularityLevel: Coarse
1237              
1238              
1239             Calls: GetItemTransactions
1240             GetSellerTransactions
1241             Returned: Conditionally
1242             Details: DetailLevel: ReturnAll
1243              
1244             Calls: GetSellerList
1245             Returned: Conditionally
1246             Details: DetailLevel: ItemReturnDescription, ReturnAll
1247              
1248             # Returns: 'xs:anyURI'
1249              
1250             =cut
1251              
1252             sub getViewItemURL {
1253             my $self = shift;
1254             return $self->{'ViewItemURL'};
1255             }
1256              
1257              
1258             =head2 setViewItemURLForNaturalSearch()
1259              
1260             This URL takes you to the same View Item page as ViewItemURL,
1261             but this URL is optimized to support natural search.
1262             That is, this URL is designed to make items on eBay easier to find via
1263             popular Internet search engines.
1264             For example, this URL specifies the item title, and it is
1265             optimized for natural search: "_W0QQ" is like "?" (question mark),
1266             "QQ" is like "&" (ampersand),
1267             and "Z" is like "=" (equals sign).
1268            
1269            
1270             Note:
1271             This URL may include additional
1272             query parameters that don't appear in ViewItemURL and vice versa.
1273             You should not modify the query syntax. For example,
1274             eBay won't recognize the URL if you change QQ to ?.
1275              
1276             # Argument: 'xs:anyURI'
1277              
1278             =cut
1279              
1280             sub setViewItemURLForNaturalSearch {
1281             my $self = shift;
1282             $self->{'ViewItemURLForNaturalSearch'} = shift
1283             }
1284              
1285             =head2 getViewItemURLForNaturalSearch()
1286              
1287             Calls: GetSearchResults
1288             Returned: Conditionally
1289             Details: DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll
1290             GranularityLevel: Coarse
1291              
1292              
1293             Calls: GetCategoryListings
1294             Returned: Conditionally
1295              
1296             Calls: GetBidderList
1297             Returned: Conditionally
1298              
1299             Calls: GetItem
1300             Returned: Conditionally
1301             Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
1302              
1303             Calls: GetItemTransactions
1304             GetSellerTransactions
1305             Returned: Conditionally
1306             Details: DetailLevel: ReturnAll
1307              
1308             Calls: GetSellerList
1309             Returned: Conditionally
1310             Details: DetailLevel: ItemReturnDescription, ReturnAll
1311              
1312             Calls: GetProducts
1313             Returned: Conditionally
1314              
1315             # Returns: 'xs:anyURI'
1316              
1317             =cut
1318              
1319             sub getViewItemURLForNaturalSearch {
1320             my $self = shift;
1321             return $self->{'ViewItemURLForNaturalSearch'};
1322             }
1323              
1324              
1325              
1326              
1327              
1328             ## Attribute and Property lists
1329             sub getPropertiesList {
1330             my $self = shift;
1331             return \@gaProperties;
1332             }
1333              
1334             sub getAttributesList {
1335             my $self = shift;
1336             return \@gaAttributes;
1337             }
1338              
1339              
1340              
1341             1;