lib/eBay/API/XML/DataType/ShippingDetailsType.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::ShippingDetailsType; | ||||||
4 | |||||||
5 | 1 | 1 | 1406 | use strict; | |||
1 | 2 | ||||||
1 | 34 | ||||||
6 | 1 | 1 | 5 | use warnings; | |||
1 | 2 | ||||||
1 | 29 | ||||||
7 | |||||||
8 | ########################################################################## | ||||||
9 | # | ||||||
10 | # Module: ............... |
||||||
11 | # File: ................. ShippingDetailsType.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::ShippingDetailsType | ||||||
21 | |||||||
22 | =head1 DESCRIPTION | ||||||
23 | |||||||
24 | Type for the shipping-related details for an item or transaction, | ||||||
25 | including flat and calculated shipping costs and shipping | ||||||
26 | insurance costs. | ||||||
27 | |||||||
28 | |||||||
29 | |||||||
30 | =head1 SYNOPSIS | ||||||
31 | |||||||
32 | =cut | ||||||
33 | |||||||
34 | |||||||
35 | =head1 INHERITANCE | ||||||
36 | |||||||
37 | eBay::API::XML::DataType::ShippingDetailsType inherits from the L |
||||||
38 | |||||||
39 | =cut | ||||||
40 | |||||||
41 | 1 | 1 | 38 | use eBay::API::XML::BaseDataType; | |||
0 | |||||||
0 | |||||||
42 | our @ISA = ("eBay::API::XML::BaseDataType"); | ||||||
43 | |||||||
44 | use eBay::API::XML::DataType::AmountType; | ||||||
45 | use eBay::API::XML::DataType::CalculatedShippingDiscountType; | ||||||
46 | use eBay::API::XML::DataType::CalculatedShippingRateType; | ||||||
47 | use eBay::API::XML::DataType::FlatShippingDiscountType; | ||||||
48 | use eBay::API::XML::DataType::InsuranceDetailsType; | ||||||
49 | use eBay::API::XML::DataType::InternationalShippingServiceOptionsType; | ||||||
50 | use eBay::API::XML::DataType::PromotionalShippingDiscountDetailsType; | ||||||
51 | use eBay::API::XML::DataType::SalesTaxType; | ||||||
52 | use eBay::API::XML::DataType::ShippingServiceOptionsType; | ||||||
53 | use eBay::API::XML::DataType::TaxTableType; | ||||||
54 | use eBay::API::XML::DataType::Enum::InsuranceOptionCodeType; | ||||||
55 | use eBay::API::XML::DataType::Enum::ShippingRateTypeCodeType; | ||||||
56 | use eBay::API::XML::DataType::Enum::ShippingTypeCodeType; | ||||||
57 | |||||||
58 | |||||||
59 | my @gaProperties = ( [ 'AllowPaymentEdit', 'xs:boolean', '', '', '' ] | ||||||
60 | , [ 'ApplyShippingDiscount', 'xs:boolean', '', '', '' ] | ||||||
61 | , [ 'CODCost', 'ns:AmountType', '' | ||||||
62 | ,'eBay::API::XML::DataType::AmountType', '1' ] | ||||||
63 | , [ 'CalculatedShippingDiscount', 'ns:CalculatedShippingDiscountType', '' | ||||||
64 | ,'eBay::API::XML::DataType::CalculatedShippingDiscountType', '1' ] | ||||||
65 | , [ 'CalculatedShippingRate', 'ns:CalculatedShippingRateType', '' | ||||||
66 | ,'eBay::API::XML::DataType::CalculatedShippingRateType', '1' ] | ||||||
67 | , [ 'ChangePaymentInstructions', 'xs:boolean', '', '', '' ] | ||||||
68 | , [ 'DefaultShippingCost', 'ns:AmountType', '' | ||||||
69 | ,'eBay::API::XML::DataType::AmountType', '1' ] | ||||||
70 | , [ 'FlatShippingDiscount', 'ns:FlatShippingDiscountType', '' | ||||||
71 | ,'eBay::API::XML::DataType::FlatShippingDiscountType', '1' ] | ||||||
72 | , [ 'GetItFast', 'xs:boolean', '', '', '' ] | ||||||
73 | , [ 'InsuranceDetails', 'ns:InsuranceDetailsType', '' | ||||||
74 | ,'eBay::API::XML::DataType::InsuranceDetailsType', '1' ] | ||||||
75 | , [ 'InsuranceFee', 'ns:AmountType', '' | ||||||
76 | ,'eBay::API::XML::DataType::AmountType', '1' ] | ||||||
77 | , [ 'InsuranceOption', 'ns:InsuranceOptionCodeType', '' | ||||||
78 | ,'eBay::API::XML::DataType::Enum::InsuranceOptionCodeType', '' ] | ||||||
79 | , [ 'InsuranceWanted', 'xs:boolean', '', '', '' ] | ||||||
80 | , [ 'InternationalCalculatedShippingDiscount', 'ns:CalculatedShippingDiscountType', '' | ||||||
81 | ,'eBay::API::XML::DataType::CalculatedShippingDiscountType', '1' ] | ||||||
82 | , [ 'InternationalFlatShippingDiscount', 'ns:FlatShippingDiscountType', '' | ||||||
83 | ,'eBay::API::XML::DataType::FlatShippingDiscountType', '1' ] | ||||||
84 | , [ 'InternationalInsuranceDetails', 'ns:InsuranceDetailsType', '' | ||||||
85 | ,'eBay::API::XML::DataType::InsuranceDetailsType', '1' ] | ||||||
86 | , [ 'InternationalPromotionalShippingDiscount', 'xs:boolean', '', '', '' ] | ||||||
87 | , [ 'InternationalShippingDiscountProfileID', 'xs:string', '', '', '' ] | ||||||
88 | , [ 'InternationalShippingServiceOption', 'ns:InternationalShippingServiceOptionsType', '1' | ||||||
89 | ,'eBay::API::XML::DataType::InternationalShippingServiceOptionsType', '1' ] | ||||||
90 | , [ 'PaymentEdited', 'xs:boolean', '', '', '' ] | ||||||
91 | , [ 'PaymentInstructions', 'xs:string', '', '', '' ] | ||||||
92 | , [ 'PromotionalShippingDiscount', 'xs:boolean', '', '', '' ] | ||||||
93 | , [ 'PromotionalShippingDiscountDetails', 'ns:PromotionalShippingDiscountDetailsType', '' | ||||||
94 | ,'eBay::API::XML::DataType::PromotionalShippingDiscountDetailsType', '1' ] | ||||||
95 | , [ 'SalesTax', 'ns:SalesTaxType', '' | ||||||
96 | ,'eBay::API::XML::DataType::SalesTaxType', '1' ] | ||||||
97 | , [ 'SellingManagerSalesRecordNumber', 'xs:int', '', '', '' ] | ||||||
98 | , [ 'ShipmentTrackingNumber', 'xs:string', '', '', '' ] | ||||||
99 | , [ 'ShippingDiscountProfileID', 'xs:string', '', '', '' ] | ||||||
100 | , [ 'ShippingRateErrorMessage', 'xs:string', '', '', '' ] | ||||||
101 | , [ 'ShippingRateType', 'ns:ShippingRateTypeCodeType', '' | ||||||
102 | ,'eBay::API::XML::DataType::Enum::ShippingRateTypeCodeType', '' ] | ||||||
103 | , [ 'ShippingServiceOptions', 'ns:ShippingServiceOptionsType', '1' | ||||||
104 | ,'eBay::API::XML::DataType::ShippingServiceOptionsType', '1' ] | ||||||
105 | , [ 'ShippingServiceUsed', 'xs:token', '', '', '' ] | ||||||
106 | , [ 'ShippingType', 'ns:ShippingTypeCodeType', '' | ||||||
107 | ,'eBay::API::XML::DataType::Enum::ShippingTypeCodeType', '' ] | ||||||
108 | , [ 'TaxTable', 'ns:TaxTableType', '' | ||||||
109 | ,'eBay::API::XML::DataType::TaxTableType', '1' ] | ||||||
110 | , [ 'ThirdPartyCheckout', 'xs:boolean', '', '', '' ] | ||||||
111 | ); | ||||||
112 | push @gaProperties, @{eBay::API::XML::BaseDataType::getPropertiesList()}; | ||||||
113 | |||||||
114 | my @gaAttributes = ( | ||||||
115 | ); | ||||||
116 | push @gaAttributes, @{eBay::API::XML::BaseDataType::getAttributesList()}; | ||||||
117 | |||||||
118 | =head1 Subroutines: | ||||||
119 | |||||||
120 | =cut | ||||||
121 | |||||||
122 | sub new { | ||||||
123 | my $classname = shift; | ||||||
124 | my %args = @_; | ||||||
125 | my $self = $classname->SUPER::new(%args); | ||||||
126 | return $self; | ||||||
127 | } | ||||||
128 | |||||||
129 | sub isScalar { | ||||||
130 | return 0; | ||||||
131 | } | ||||||
132 | |||||||
133 | |||||||
134 | |||||||
135 | =head2 setAllowPaymentEdit() | ||||||
136 | |||||||
137 | Instead of using this tag, see the PaymentEdited tag. | ||||||
138 | Originally, the AllowPaymentEdit tag specified whether the seller allows the | ||||||
139 | buyer to edit the payment amount for the transaction. (Sellers | ||||||
140 | enabled this property in their My eBay user preferences on the | ||||||
141 | eBay site.) ShippingDetails.AllowPaymentEdit is no longer being | ||||||
142 | populated by calls to GetItemTransactions. | ||||||
143 | Not applicable to Half.com. | ||||||
144 | |||||||
145 | # Argument: 'xs:boolean' | ||||||
146 | |||||||
147 | =cut | ||||||
148 | |||||||
149 | sub setAllowPaymentEdit { | ||||||
150 | my $self = shift; | ||||||
151 | $self->{'AllowPaymentEdit'} = shift | ||||||
152 | } | ||||||
153 | |||||||
154 | =head2 isAllowPaymentEdit() | ||||||
155 | |||||||
156 | Calls: GetBidderList | ||||||
157 | Returned: Conditionally | ||||||
158 | |||||||
159 | Calls: GetSellerList | ||||||
160 | Returned: Conditionally | ||||||
161 | Details: DetailLevel: ItemReturnDescription, ReturnAll | ||||||
162 | |||||||
163 | Calls: GetOrderTransactions | ||||||
164 | Returned: Conditionally | ||||||
165 | Details: DetailLevel: none, ItemReturnDescription, ReturnAll | ||||||
166 | |||||||
167 | Calls: GetItem | ||||||
168 | Returned: Conditionally | ||||||
169 | Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll | ||||||
170 | |||||||
171 | # Returns: 'xs:boolean' | ||||||
172 | |||||||
173 | =cut | ||||||
174 | |||||||
175 | sub isAllowPaymentEdit { | ||||||
176 | my $self = shift; | ||||||
177 | return $self->{'AllowPaymentEdit'}; | ||||||
178 | } | ||||||
179 | |||||||
180 | |||||||
181 | =head2 setApplyShippingDiscount() | ||||||
182 | |||||||
183 | Whether the seller specifies that a shipping discount is to be | ||||||
184 | applied (in the event that an item's transaction is later | ||||||
185 | combined with others into a single order). | ||||||
186 | Not applicable to Half.com. | ||||||
187 | |||||||
188 | # Argument: 'xs:boolean' | ||||||
189 | |||||||
190 | =cut | ||||||
191 | |||||||
192 | sub setApplyShippingDiscount { | ||||||
193 | my $self = shift; | ||||||
194 | $self->{'ApplyShippingDiscount'} = shift | ||||||
195 | } | ||||||
196 | |||||||
197 | =head2 isApplyShippingDiscount() | ||||||
198 | |||||||
199 | Calls: GetSellerList | ||||||
200 | Returned: Conditionally | ||||||
201 | Details: DetailLevel: ItemReturnDescription, ReturnAll | ||||||
202 | GranularityLevel: Fine | ||||||
203 | |||||||
204 | |||||||
205 | Calls: GetBidderList | ||||||
206 | Returned: Conditionally | ||||||
207 | |||||||
208 | Calls: GetItem | ||||||
209 | Returned: Conditionally | ||||||
210 | Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll | ||||||
211 | |||||||
212 | # Returns: 'xs:boolean' | ||||||
213 | |||||||
214 | =cut | ||||||
215 | |||||||
216 | sub isApplyShippingDiscount { | ||||||
217 | my $self = shift; | ||||||
218 | return $self->{'ApplyShippingDiscount'}; | ||||||
219 | } | ||||||
220 | |||||||
221 | |||||||
222 | =head2 setCODCost() | ||||||
223 | |||||||
224 | Italy site (site ID 101) only. Contains | ||||||
225 | the cash-on-delivery (COD) cost, for COD shipping. | ||||||
226 | |||||||
227 | SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=CODInShippingDetails | ||||||
228 | Title: Specifying the Cash on Delivery Option in Shipping Details | ||||||
229 | |||||||
230 | Calls: AddItem | ||||||
231 | RelistItem | ||||||
232 | ReviseItem | ||||||
233 | VerifyAddItem | ||||||
234 | AddOrder | ||||||
235 | RequiredInput: Conditionally | ||||||
236 | |||||||
237 | # Argument: 'ns:AmountType' | ||||||
238 | |||||||
239 | =cut | ||||||
240 | |||||||
241 | sub setCODCost { | ||||||
242 | my $self = shift; | ||||||
243 | $self->{'CODCost'} = shift | ||||||
244 | } | ||||||
245 | |||||||
246 | =head2 getCODCost() | ||||||
247 | |||||||
248 | Calls: GetItemShipping | ||||||
249 | Returned: Conditionally | ||||||
250 | |||||||
251 | Calls: GetItem | ||||||
252 | Returned: Conditionally | ||||||
253 | Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll | ||||||
254 | |||||||
255 | Calls: GetItemTransactions | ||||||
256 | GetSellerTransactions | ||||||
257 | Returned: Conditionally | ||||||
258 | Details: DetailLevel: none, ItemReturnDescription, ReturnAll | ||||||
259 | |||||||
260 | Calls: GetOrders | ||||||
261 | Returned: Conditionally | ||||||
262 | Details: DetailLevel: none | ||||||
263 | |||||||
264 | Calls: GetOrderTransactions | ||||||
265 | Returned: Conditionally | ||||||
266 | Details: DetailLevel: none, ItemReturnDescription, ReturnAll | ||||||
267 | ExcludeFromContext: Transaction | ||||||
268 | Context: Order | ||||||
269 | |||||||
270 | # Returns: 'ns:AmountType' | ||||||
271 | |||||||
272 | =cut | ||||||
273 | |||||||
274 | sub getCODCost { | ||||||
275 | my $self = shift; | ||||||
276 | return $self->_getDataTypeInstance( 'CODCost' | ||||||
277 | ,'eBay::API::XML::DataType::AmountType'); | ||||||
278 | } | ||||||
279 | |||||||
280 | |||||||
281 | =head2 setCalculatedShippingDiscount() | ||||||
282 | |||||||
283 | If a calculated shipping discount was offered for the domestic shipping services, this | ||||||
284 | contains the details of the calculated shipping discount. Otherwise, it is not returned. | ||||||
285 | Only returned if the calling user is the seller. | ||||||
286 | |||||||
287 | SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ShippingDiscountProfiles | ||||||
288 | Title: Shipping Cost Discount Profiles | ||||||
289 | |||||||
290 | # Argument: 'ns:CalculatedShippingDiscountType' | ||||||
291 | |||||||
292 | =cut | ||||||
293 | |||||||
294 | sub setCalculatedShippingDiscount { | ||||||
295 | my $self = shift; | ||||||
296 | $self->{'CalculatedShippingDiscount'} = shift | ||||||
297 | } | ||||||
298 | |||||||
299 | =head2 getCalculatedShippingDiscount() | ||||||
300 | |||||||
301 | Calls: GetItem | ||||||
302 | Returned: Conditionally | ||||||
303 | Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll | ||||||
304 | |||||||
305 | # Returns: 'ns:CalculatedShippingDiscountType' | ||||||
306 | |||||||
307 | =cut | ||||||
308 | |||||||
309 | sub getCalculatedShippingDiscount { | ||||||
310 | my $self = shift; | ||||||
311 | return $self->_getDataTypeInstance( 'CalculatedShippingDiscount' | ||||||
312 | ,'eBay::API::XML::DataType::CalculatedShippingDiscountType'); | ||||||
313 | } | ||||||
314 | |||||||
315 | |||||||
316 | =head2 setCalculatedShippingRate() | ||||||
317 | |||||||
318 | Details pertinent to one or more items for which | ||||||
319 | calculated shipping has been offered by the seller, such as | ||||||
320 | package dimension and weight and packaging/handling costs. | ||||||
321 | Not applicable to Half.com or eBay Motors vehicle listings. | ||||||
322 | If your call may specify a large-dimension item listed with UPS, see | ||||||
323 | Dimensional Weight limit on UPS shipping services results in failure of shipping calculator. | ||||||
324 | For Germany and the UK, this field is ignored when Item.ListingType=Express. | ||||||
325 | |||||||
326 | Note: | ||||||
327 | At the end of April 2008, UK and Germany eBay Express will be shutdown. No | ||||||
328 | users will be eligible to list on these sites. All users previously registered | ||||||
329 | on UK and Germany Express will have their registered status revoked. Any | ||||||
330 | Express only items listed on these sites will be ended and credited the full | ||||||
331 | insertion fee to their sellers. Please refer to the respective Express sites | ||||||
332 | for more information. | ||||||
333 | |||||||
334 | |||||||
335 | Calls: AddItem | ||||||
336 | GetItemRecommendations | ||||||
337 | RelistItem | ||||||
338 | ReviseItem | ||||||
339 | VerifyAddItem | ||||||
340 | RequiredInput: Conditionally | ||||||
341 | |||||||
342 | # Argument: 'ns:CalculatedShippingRateType' | ||||||
343 | |||||||
344 | =cut | ||||||
345 | |||||||
346 | sub setCalculatedShippingRate { | ||||||
347 | my $self = shift; | ||||||
348 | $self->{'CalculatedShippingRate'} = shift | ||||||
349 | } | ||||||
350 | |||||||
351 | =head2 getCalculatedShippingRate() | ||||||
352 | |||||||
353 | Calls: GetItem | ||||||
354 | Returned: Conditionally | ||||||
355 | Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll | ||||||
356 | |||||||
357 | Calls: GetSellerList | ||||||
358 | Returned: Conditionally | ||||||
359 | Details: DetailLevel: ItemReturnDescription, ReturnAll | ||||||
360 | |||||||
361 | Calls: GetItemShipping | ||||||
362 | Returned: Conditionally | ||||||
363 | |||||||
364 | Calls: GetItemTransactions | ||||||
365 | GetSellerTransactions | ||||||
366 | Returned: Conditionally | ||||||
367 | Details: DetailLevel: none, ReturnAll | ||||||
368 | |||||||
369 | # Returns: 'ns:CalculatedShippingRateType' | ||||||
370 | |||||||
371 | =cut | ||||||
372 | |||||||
373 | sub getCalculatedShippingRate { | ||||||
374 | my $self = shift; | ||||||
375 | return $self->_getDataTypeInstance( 'CalculatedShippingRate' | ||||||
376 | ,'eBay::API::XML::DataType::CalculatedShippingRateType'); | ||||||
377 | } | ||||||
378 | |||||||
379 | |||||||
380 | =head2 setChangePaymentInstructions() | ||||||
381 | |||||||
382 | Whether the seller specified payment and shipping instructions during | ||||||
383 | checkout (for example, to update the details of a transaction). Flat and | ||||||
384 | calculated shipping. | ||||||
385 | Not applicable to Half.com. | ||||||
386 | |||||||
387 | # Argument: 'xs:boolean' | ||||||
388 | |||||||
389 | =cut | ||||||
390 | |||||||
391 | sub setChangePaymentInstructions { | ||||||
392 | my $self = shift; | ||||||
393 | $self->{'ChangePaymentInstructions'} = shift | ||||||
394 | } | ||||||
395 | |||||||
396 | =head2 isChangePaymentInstructions() | ||||||
397 | |||||||
398 | Calls: GetItemShipping | ||||||
399 | Returned: Conditionally | ||||||
400 | |||||||
401 | Calls: GetItemTransactions | ||||||
402 | GetSellerTransactions | ||||||
403 | Returned: Conditionally | ||||||
404 | Details: DetailLevel: none, ItemReturnDescription, ReturnAll | ||||||
405 | |||||||
406 | Calls: GetOrderTransactions | ||||||
407 | Returned: Conditionally | ||||||
408 | Details: DetailLevel: none, ItemReturnDescription, ReturnAll | ||||||
409 | |||||||
410 | # Returns: 'xs:boolean' | ||||||
411 | |||||||
412 | =cut | ||||||
413 | |||||||
414 | sub isChangePaymentInstructions { | ||||||
415 | my $self = shift; | ||||||
416 | return $self->{'ChangePaymentInstructions'}; | ||||||
417 | } | ||||||
418 | |||||||
419 | |||||||
420 | =head2 setDefaultShippingCost() | ||||||
421 | |||||||
422 | The default shipping cost for the item. If the seller specified | ||||||
423 | multiple shipping services, this is the "first" shipping service | ||||||
424 | as specified by the seller when they listed the item. |
||||||
425 | |
||||||
426 | For GetSearchResults: |
||||||
427 | If ShippingType has the value Flat, then the actual shipping cost is shown. If | ||||||
428 | ShippingType has the value Free, then zero is shown. If ShippingType has the | ||||||
429 | value Calculated, then this tag (DefaultShippingCost) is not shown. If | ||||||
430 | ShippingType has the value NotSpecified, then this tag (DefaultShippingCost) | ||||||
431 | is not shown. If ShippingType has the value Freight, then this tag | ||||||
432 | (DefaultShippingCost) is not shown. | ||||||
433 | |
||||||
434 | |
||||||
435 | In GetSearchResultsExpress: |
||||||
436 | If flat shipping was specified or the shipping cost is 0.00 (free) for the | ||||||
437 | item, then the actual shipping cost is shown. If calculated shipping was | ||||||
438 | specified for the item, then this tag (DefaultShippingCost) is only shown if | ||||||
439 | PostalCode is specified in the GetSearchResultsExpress request. Otherwise, | ||||||
440 | ShippingRateErrorMessage is returned with a message that the postal code is | ||||||
441 | required for the shipping calculation. | ||||||
442 | Only returned when ItemDetails is set to Fine. | ||||||
443 | |
||||||
444 | |
||||||
445 | Not applicable to Half.com. | ||||||
446 | |||||||
447 | # Argument: 'ns:AmountType' | ||||||
448 | |||||||
449 | =cut | ||||||
450 | |||||||
451 | sub setDefaultShippingCost { | ||||||
452 | my $self = shift; | ||||||
453 | $self->{'DefaultShippingCost'} = shift | ||||||
454 | } | ||||||
455 | |||||||
456 | =head2 getDefaultShippingCost() | ||||||
457 | |||||||
458 | Calls: GetProducts | ||||||
459 | Returned: Conditionally | ||||||
460 | |||||||
461 | Calls: GetSearchResults | ||||||
462 | Returned: Conditionally | ||||||
463 | Details: DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll | ||||||
464 | GranularityLevel: Coarse | ||||||
465 | |||||||
466 | |||||||
467 | # Returns: 'ns:AmountType' | ||||||
468 | |||||||
469 | =cut | ||||||
470 | |||||||
471 | sub getDefaultShippingCost { | ||||||
472 | my $self = shift; | ||||||
473 | return $self->_getDataTypeInstance( 'DefaultShippingCost' | ||||||
474 | ,'eBay::API::XML::DataType::AmountType'); | ||||||
475 | } | ||||||
476 | |||||||
477 | |||||||
478 | =head2 setFlatShippingDiscount() | ||||||
479 | |||||||
480 | If a flat rate shipping discount was offered for the domestic shipping services, this | ||||||
481 | contains the details of the flat rate shipping discount. Otherwise, it is not returned. | ||||||
482 | Only returned if the calling user is the seller. | ||||||
483 | |||||||
484 | SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ShippingDiscountProfiles | ||||||
485 | Title: Shipping Cost Discount Profiles | ||||||
486 | |||||||
487 | # Argument: 'ns:FlatShippingDiscountType' | ||||||
488 | |||||||
489 | =cut | ||||||
490 | |||||||
491 | sub setFlatShippingDiscount { | ||||||
492 | my $self = shift; | ||||||
493 | $self->{'FlatShippingDiscount'} = shift | ||||||
494 | } | ||||||
495 | |||||||
496 | =head2 getFlatShippingDiscount() | ||||||
497 | |||||||
498 | Calls: GetItem | ||||||
499 | Returned: Conditionally | ||||||
500 | Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll | ||||||
501 | |||||||
502 | # Returns: 'ns:FlatShippingDiscountType' | ||||||
503 | |||||||
504 | =cut | ||||||
505 | |||||||
506 | sub getFlatShippingDiscount { | ||||||
507 | my $self = shift; | ||||||
508 | return $self->_getDataTypeInstance( 'FlatShippingDiscount' | ||||||
509 | ,'eBay::API::XML::DataType::FlatShippingDiscountType'); | ||||||
510 | } | ||||||
511 | |||||||
512 | |||||||
513 | =head2 setGetItFast() | ||||||
514 | |||||||
515 | Indicates whether the seller has opted the listing into the Get | ||||||
516 | It Fast feature. If GetItFast is true and if at least one of | ||||||
517 | the domestic shipping services offered by the seller is an | ||||||
518 | expedited shipping service, every shipping service offered by | ||||||
519 | the seller is considered a Get It Fast service, and the seller | ||||||
520 | commits to delivering the item to the buyer-selected shipping | ||||||
521 | service within one day. | ||||||
522 | Also applicable to Half.com (for GetOrders). | ||||||
523 | |||||||
524 | # Argument: 'xs:boolean' | ||||||
525 | |||||||
526 | =cut | ||||||
527 | |||||||
528 | sub setGetItFast { | ||||||
529 | my $self = shift; | ||||||
530 | $self->{'GetItFast'} = shift | ||||||
531 | } | ||||||
532 | |||||||
533 | =head2 isGetItFast() | ||||||
534 | |||||||
535 | Calls: GetBidderList | ||||||
536 | GetItemShipping | ||||||
537 | Returned: Conditionally | ||||||
538 | |||||||
539 | Calls: GetItem | ||||||
540 | Returned: Conditionally | ||||||
541 | Details: DetailLevel: none, ItemReturnDescription, | ||||||
542 | ItemReturnAttributes, ReturnAll | ||||||
543 | |||||||
544 | Calls: GetItemTransactions | ||||||
545 | GetSellerTransactions | ||||||
546 | Returned: Conditionally | ||||||
547 | Details: DetailLevel: none, ReturnAll | ||||||
548 | |||||||
549 | Calls: GetOrders | ||||||
550 | Returned: Always | ||||||
551 | Details: DetailLevel: none | ||||||
552 | |||||||
553 | Calls: GetOrderTransactions | ||||||
554 | Returned: Always | ||||||
555 | Details: DetailLevel: none, ItemReturnDescription, ReturnAll | ||||||
556 | |||||||
557 | # Returns: 'xs:boolean' | ||||||
558 | |||||||
559 | =cut | ||||||
560 | |||||||
561 | sub isGetItFast { | ||||||
562 | my $self = shift; | ||||||
563 | return $self->{'GetItFast'}; | ||||||
564 | } | ||||||
565 | |||||||
566 | |||||||
567 | =head2 setInsuranceDetails() | ||||||
568 | |||||||
569 | Container for domestic insurance information. (Note that there are fields | ||||||
570 | named InsuranceFee and InsuranceOption at the same level as this container. | ||||||
571 | These were once used for representing both domestic and international | ||||||
572 | insurance details.) | ||||||
573 | If this (newer) container is provided on input and if | ||||||
574 | ShippingDetails.InsuranceFee or | ||||||
575 | ShippingDetails.InsuranceOption are also provided, those two (older fields) | ||||||
576 | are ignored. | ||||||
577 | If this container is omitted on input, its InsuranceFee and InsuranceOption | ||||||
578 | subfields are set to match whatever (the older fields) | ||||||
579 | ShippingDetails.InsuranceFee and ShippingDetails.InsuranceOption are set to. | ||||||
580 | For flat and calculated shipping, depending on which subfields are used. | ||||||
581 | |||||||
582 | Calls: AddItem | ||||||
583 | RelistItem | ||||||
584 | ReviseItem | ||||||
585 | VerifyAddItem | ||||||
586 | RequiredInput: No | ||||||
587 | |||||||
588 | # Argument: 'ns:InsuranceDetailsType' | ||||||
589 | |||||||
590 | =cut | ||||||
591 | |||||||
592 | sub setInsuranceDetails { | ||||||
593 | my $self = shift; | ||||||
594 | $self->{'InsuranceDetails'} = shift | ||||||
595 | } | ||||||
596 | |||||||
597 | =head2 getInsuranceDetails() | ||||||
598 | |||||||
599 | Calls: GetBidderList | ||||||
600 | Returned: Conditionally | ||||||
601 | |||||||
602 | Calls: GetItem | ||||||
603 | Returned: Always | ||||||
604 | Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll | ||||||
605 | |||||||
606 | # Returns: 'ns:InsuranceDetailsType' | ||||||
607 | |||||||
608 | =cut | ||||||
609 | |||||||
610 | sub getInsuranceDetails { | ||||||
611 | my $self = shift; | ||||||
612 | return $self->_getDataTypeInstance( 'InsuranceDetails' | ||||||
613 | ,'eBay::API::XML::DataType::InsuranceDetailsType'); | ||||||
614 | } | ||||||
615 | |||||||
616 | |||||||
617 | =head2 setInsuranceFee() | ||||||
618 | |||||||
619 | Cost of shipping insurance set by the seller. If the | ||||||
620 | buyer bought more than one of this item, this is the insurance | ||||||
621 | for just a single item. Exception: for GetItemShipping, this is | ||||||
622 | proportional to QuantitySold. Value should be greater than 0.00 if | ||||||
623 | InsuranceOption is Optional or Required. For flat shipping only. | ||||||
624 | Optional as input and only allowed if ChangePaymentInstructions | ||||||
625 | is true. | ||||||
626 | This field is ignored when InsuranceOption is not specified in the request. | ||||||
627 | This field is ignored when Item.ListingType=Express. | ||||||
628 | |
||||||
629 | |
||||||
630 | Applicable to Half.com for GetOrders. | ||||||
631 | Not applicable to eBay Motors vehicle listings. | ||||||
632 | |||||||
633 | Max: Default: 0.00 | ||||||
634 | Min: | ||||||
635 | Calls: AddItem | ||||||
636 | GetItemRecommendations | ||||||
637 | AddOrder | ||||||
638 | RelistItem | ||||||
639 | ReviseItem | ||||||
640 | VerifyAddItem | ||||||
641 | RequiredInput: No | ||||||
642 | |||||||
643 | # Argument: 'ns:AmountType' | ||||||
644 | |||||||
645 | =cut | ||||||
646 | |||||||
647 | sub setInsuranceFee { | ||||||
648 | my $self = shift; | ||||||
649 | $self->{'InsuranceFee'} = shift | ||||||
650 | } | ||||||
651 | |||||||
652 | =head2 getInsuranceFee() | ||||||
653 | |||||||
654 | Calls: GetBidderList | ||||||
655 | GetItemShipping | ||||||
656 | Returned: Conditionally | ||||||
657 | |||||||
658 | Calls: GetItem | ||||||
659 | Returned: Conditionally | ||||||
660 | Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll | ||||||
661 | |||||||
662 | Calls: GetItemTransactions | ||||||
663 | GetSellerTransactions | ||||||
664 | Returned: Conditionally | ||||||
665 | Details: DetailLevel: none, ItemReturnDescription, ReturnAll | ||||||
666 | |||||||
667 | Calls: GetOrders | ||||||
668 | Returned: Always | ||||||
669 | Details: DetailLevel: none | ||||||
670 | |||||||
671 | Calls: GetOrderTransactions | ||||||
672 | Returned: Always | ||||||
673 | Details: DetailLevel: none, ItemReturnDescription, ReturnAll | ||||||
674 | ExcludeFromContext: Transaction | ||||||
675 | Context: Order | ||||||
676 | |||||||
677 | # Returns: 'ns:AmountType' | ||||||
678 | |||||||
679 | =cut | ||||||
680 | |||||||
681 | sub getInsuranceFee { | ||||||
682 | my $self = shift; | ||||||
683 | return $self->_getDataTypeInstance( 'InsuranceFee' | ||||||
684 | ,'eBay::API::XML::DataType::AmountType'); | ||||||
685 | } | ||||||
686 | |||||||
687 | |||||||
688 | =head2 setInsuranceOption() | ||||||
689 | |||||||
690 | Whether the seller offers shipping insurance and, if | ||||||
691 | so, whether the insurance is optional or required. Flat and | ||||||
692 | calculated shipping. Optional as input and only allowed if | ||||||
693 | ChangePaymentInstructions is true. | ||||||
694 | Also applicable to Half.com (for GetOrders). | ||||||
695 | This field is ignored when Item.ListingType=Express. | ||||||
696 | If this field is not included in the request, values specified in the InsuranceFee field will be ignored. | ||||||
697 | |||||||
698 | Calls: AddItem | ||||||
699 | GetItemRecommendations | ||||||
700 | AddOrder | ||||||
701 | RelistItem | ||||||
702 | ReviseItem | ||||||
703 | VerifyAddItem | ||||||
704 | RequiredInput: No | ||||||
705 | AllValuesExcept: NotOfferedOnSite | ||||||
706 | |||||||
707 | # Argument: 'ns:InsuranceOptionCodeType' | ||||||
708 | |||||||
709 | =cut | ||||||
710 | |||||||
711 | sub setInsuranceOption { | ||||||
712 | my $self = shift; | ||||||
713 | $self->{'InsuranceOption'} = shift | ||||||
714 | } | ||||||
715 | |||||||
716 | =head2 getInsuranceOption() | ||||||
717 | |||||||
718 | Calls: GetBidderList | ||||||
719 | GetItemShipping | ||||||
720 | Returned: Conditionally | ||||||
721 | |||||||
722 | Calls: GetSellerList | ||||||
723 | Returned: Conditionally | ||||||
724 | Details: DetailLevel: ItemReturnDescription, ReturnAll | ||||||
725 | GranularityLevel: Fine | ||||||
726 | |||||||
727 | |||||||
728 | Calls: GetItem | ||||||
729 | Returned: Conditionally | ||||||
730 | Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll | ||||||
731 | |||||||
732 | Calls: GetItemTransactions | ||||||
733 | GetSellerTransactions | ||||||
734 | Returned: Conditionally | ||||||
735 | Details: DetailLevel: none, ItemReturnDescription, ReturnAll | ||||||
736 | |||||||
737 | Calls: GetOrders | ||||||
738 | Returned: Always | ||||||
739 | Details: DetailLevel: none | ||||||
740 | |||||||
741 | Calls: GetOrderTransactions | ||||||
742 | Returned: Always | ||||||
743 | Details: DetailLevel: none, ItemReturnDescription, ReturnAll | ||||||
744 | |||||||
745 | # Returns: 'ns:InsuranceOptionCodeType' | ||||||
746 | |||||||
747 | =cut | ||||||
748 | |||||||
749 | sub getInsuranceOption { | ||||||
750 | my $self = shift; | ||||||
751 | return $self->{'InsuranceOption'}; | ||||||
752 | } | ||||||
753 | |||||||
754 | |||||||
755 | =head2 setInsuranceWanted() | ||||||
756 | |||||||
757 | Whether the buyer selected to pay for insurance offered | ||||||
758 | by the seller as an option. This only has a value after the | ||||||
759 | buyer has gone through checkout and selected the insurance | ||||||
760 | preference. | ||||||
761 | Also applicable to Half.com (for GetOrders). | ||||||
762 | |||||||
763 | # Argument: 'xs:boolean' | ||||||
764 | |||||||
765 | =cut | ||||||
766 | |||||||
767 | sub setInsuranceWanted { | ||||||
768 | my $self = shift; | ||||||
769 | $self->{'InsuranceWanted'} = shift | ||||||
770 | } | ||||||
771 | |||||||
772 | =head2 isInsuranceWanted() | ||||||
773 | |||||||
774 | Calls: GetOrders | ||||||
775 | Returned: Always | ||||||
776 | Details: DetailLevel: none | ||||||
777 | |||||||
778 | Calls: GetOrderTransactions | ||||||
779 | Returned: Always | ||||||
780 | Details: DetailLevel: none, ItemReturnDescription, ReturnAll | ||||||
781 | |||||||
782 | Calls: GetItemShipping | ||||||
783 | Returned: Conditionally | ||||||
784 | |||||||
785 | Calls: GetItemTransactions | ||||||
786 | GetSellerTransactions | ||||||
787 | Returned: Conditionally | ||||||
788 | Details: DetailLevel: none, ItemReturnDescription, ReturnAll | ||||||
789 | |||||||
790 | # Returns: 'xs:boolean' | ||||||
791 | |||||||
792 | =cut | ||||||
793 | |||||||
794 | sub isInsuranceWanted { | ||||||
795 | my $self = shift; | ||||||
796 | return $self->{'InsuranceWanted'}; | ||||||
797 | } | ||||||
798 | |||||||
799 | |||||||
800 | =head2 setInternationalCalculatedShippingDiscount() | ||||||
801 | |||||||
802 | If a calculated shipping discount was offered for the international shipping services, this | ||||||
803 | contains the details of the calculated shipping discount. Otherwise, it is not returned. | ||||||
804 | Only returned if the calling user is the seller. | ||||||
805 | |||||||
806 | SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ShippingDiscountProfiles | ||||||
807 | Title: Shipping Cost Discount Profiles | ||||||
808 | |||||||
809 | # Argument: 'ns:CalculatedShippingDiscountType' | ||||||
810 | |||||||
811 | =cut | ||||||
812 | |||||||
813 | sub setInternationalCalculatedShippingDiscount { | ||||||
814 | my $self = shift; | ||||||
815 | $self->{'InternationalCalculatedShippingDiscount'} = shift | ||||||
816 | } | ||||||
817 | |||||||
818 | =head2 getInternationalCalculatedShippingDiscount() | ||||||
819 | |||||||
820 | Calls: GetItem | ||||||
821 | Returned: Conditionally | ||||||
822 | Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll | ||||||
823 | |||||||
824 | # Returns: 'ns:CalculatedShippingDiscountType' | ||||||
825 | |||||||
826 | =cut | ||||||
827 | |||||||
828 | sub getInternationalCalculatedShippingDiscount { | ||||||
829 | my $self = shift; | ||||||
830 | return $self->_getDataTypeInstance( 'InternationalCalculatedShippingDiscount' | ||||||
831 | ,'eBay::API::XML::DataType::CalculatedShippingDiscountType'); | ||||||
832 | } | ||||||
833 | |||||||
834 | |||||||
835 | =head2 setInternationalFlatShippingDiscount() | ||||||
836 | |||||||
837 | If a flat rate shipping discount was offered for the international shipping services, this | ||||||
838 | contains the details of the flat rate shipping discount. Otherwise, it is not returned. | ||||||
839 | Only returned if the calling user is the seller. | ||||||
840 | |||||||
841 | SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ShippingDiscountProfiles | ||||||
842 | Title: Shipping Cost Discount Profiles | ||||||
843 | |||||||
844 | # Argument: 'ns:FlatShippingDiscountType' | ||||||
845 | |||||||
846 | =cut | ||||||
847 | |||||||
848 | sub setInternationalFlatShippingDiscount { | ||||||
849 | my $self = shift; | ||||||
850 | $self->{'InternationalFlatShippingDiscount'} = shift | ||||||
851 | } | ||||||
852 | |||||||
853 | =head2 getInternationalFlatShippingDiscount() | ||||||
854 | |||||||
855 | Calls: GetItem | ||||||
856 | Returned: Conditionally | ||||||
857 | Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll | ||||||
858 | |||||||
859 | # Returns: 'ns:FlatShippingDiscountType' | ||||||
860 | |||||||
861 | =cut | ||||||
862 | |||||||
863 | sub getInternationalFlatShippingDiscount { | ||||||
864 | my $self = shift; | ||||||
865 | return $self->_getDataTypeInstance( 'InternationalFlatShippingDiscount' | ||||||
866 | ,'eBay::API::XML::DataType::FlatShippingDiscountType'); | ||||||
867 | } | ||||||
868 | |||||||
869 | |||||||
870 | =head2 setInternationalInsuranceDetails() | ||||||
871 | |||||||
872 | Container for international insurance information. (Note that there are fields | ||||||
873 | named InsuranceFee and InsuranceOption at the same level as this container. | ||||||
874 | These were once used for representing both domestic and international | ||||||
875 | insurance details.) If this (newer) container is provided on input and if | ||||||
876 | ShippingDetails.InsuranceFee or ShippingDetails.InsuranceOption are also | ||||||
877 | provided, those two (older fields) are ignored. | ||||||
878 | If this container is omitted on input, its InsuranceFee and InsuranceOption | ||||||
879 | subfields are set to match whatever (the older fields) | ||||||
880 | ShippingDetails.InsuranceFee and ShippingDetails.InsuranceOption are set to. | ||||||
881 | For flat and calculated shipping, depending on which subfields are used. | ||||||
882 | |||||||
883 | Calls: AddItem | ||||||
884 | RelistItem | ||||||
885 | ReviseItem | ||||||
886 | VerifyAddItem | ||||||
887 | RequiredInput: No | ||||||
888 | |||||||
889 | # Argument: 'ns:InsuranceDetailsType' | ||||||
890 | |||||||
891 | =cut | ||||||
892 | |||||||
893 | sub setInternationalInsuranceDetails { | ||||||
894 | my $self = shift; | ||||||
895 | $self->{'InternationalInsuranceDetails'} = shift | ||||||
896 | } | ||||||
897 | |||||||
898 | =head2 getInternationalInsuranceDetails() | ||||||
899 | |||||||
900 | Calls: GetBidderList | ||||||
901 | Returned: Conditionally | ||||||
902 | |||||||
903 | Calls: GetItem | ||||||
904 | Returned: Always | ||||||
905 | Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll | ||||||
906 | |||||||
907 | # Returns: 'ns:InsuranceDetailsType' | ||||||
908 | |||||||
909 | =cut | ||||||
910 | |||||||
911 | sub getInternationalInsuranceDetails { | ||||||
912 | my $self = shift; | ||||||
913 | return $self->_getDataTypeInstance( 'InternationalInsuranceDetails' | ||||||
914 | ,'eBay::API::XML::DataType::InsuranceDetailsType'); | ||||||
915 | } | ||||||
916 | |||||||
917 | |||||||
918 | =head2 setInternationalPromotionalShippingDiscount() | ||||||
919 | |||||||
920 | On input, this specifies whether to offer the promotional shipping discount | ||||||
921 | for the international shipping services of this listing (only applicable if the | ||||||
922 | seller has a promotional shipping discount in effect at the moment). On | ||||||
923 | output, this indicates whether the promotional shipping discount is being | ||||||
924 | offered for the international shipping services of this listing (if the listing is | ||||||
925 | still active--this is only possible if the seller has a promotional shipping | ||||||
926 | discount in effect at the moment) or whether the discount was offered at the | ||||||
927 | time the listing ended. | ||||||
928 | Only returned if the calling user is the seller. | ||||||
929 | |||||||
930 | SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ShippingDiscountProfiles | ||||||
931 | Title: Shipping Cost Discount Profiles | ||||||
932 | |||||||
933 | Calls: AddItem | ||||||
934 | RelistItem | ||||||
935 | ReviseItem | ||||||
936 | VerifyAddItem | ||||||
937 | RequiredInput: Conditionally | ||||||
938 | |||||||
939 | # Argument: 'xs:boolean' | ||||||
940 | |||||||
941 | =cut | ||||||
942 | |||||||
943 | sub setInternationalPromotionalShippingDiscount { | ||||||
944 | my $self = shift; | ||||||
945 | $self->{'InternationalPromotionalShippingDiscount'} = shift | ||||||
946 | } | ||||||
947 | |||||||
948 | =head2 isInternationalPromotionalShippingDiscount() | ||||||
949 | |||||||
950 | Calls: GetItem | ||||||
951 | Returned: Conditionally | ||||||
952 | Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll | ||||||
953 | |||||||
954 | # Returns: 'xs:boolean' | ||||||
955 | |||||||
956 | =cut | ||||||
957 | |||||||
958 | sub isInternationalPromotionalShippingDiscount { | ||||||
959 | my $self = shift; | ||||||
960 | return $self->{'InternationalPromotionalShippingDiscount'}; | ||||||
961 | } | ||||||
962 | |||||||
963 | |||||||
964 | =head2 setInternationalShippingDiscountProfileID() | ||||||
965 | |||||||
966 | On input, this is the ID of the shipping discount to offer for the international | ||||||
967 | shipping services (where the shipping discount is either of type | ||||||
968 | FlatShippingDiscount or CalculatedShippingDiscount). On output, this is the ID | ||||||
969 | of the shipping discount offered and corresponds to whichever is returned: | ||||||
970 | FlatShippingDiscount or CalculatedShippingDiscount. Only returned if the | ||||||
971 | calling user is the seller. | ||||||
972 | |||||||
973 | SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ShippingDiscountProfiles | ||||||
974 | Title: Shipping Cost Discount Profiles | ||||||
975 | |||||||
976 | Calls: AddItem | ||||||
977 | RelistItem | ||||||
978 | ReviseItem | ||||||
979 | VerifyAddItem | ||||||
980 | RequiredInput: Conditionally | ||||||
981 | |||||||
982 | # Argument: 'xs:string' | ||||||
983 | |||||||
984 | =cut | ||||||
985 | |||||||
986 | sub setInternationalShippingDiscountProfileID { | ||||||
987 | my $self = shift; | ||||||
988 | $self->{'InternationalShippingDiscountProfileID'} = shift | ||||||
989 | } | ||||||
990 | |||||||
991 | =head2 getInternationalShippingDiscountProfileID() | ||||||
992 | |||||||
993 | Calls: GetItem | ||||||
994 | Returned: Conditionally | ||||||
995 | Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll | ||||||
996 | |||||||
997 | # Returns: 'xs:string' | ||||||
998 | |||||||
999 | =cut | ||||||
1000 | |||||||
1001 | sub getInternationalShippingDiscountProfileID { | ||||||
1002 | my $self = shift; | ||||||
1003 | return $self->{'InternationalShippingDiscountProfileID'}; | ||||||
1004 | } | ||||||
1005 | |||||||
1006 | |||||||
1007 | =head2 setInternationalShippingServiceOption() | ||||||
1008 | |||||||
1009 | Shipping costs and options related to an international shipping service. If | ||||||
1010 | used, at least one domestic shipping service must also be provided in | ||||||
1011 | ShippingServiceOptions. |
||||||
1012 | |
||||||
1013 | If you specify multiple InternationalShippingServiceOption nodes, the | ||||||
1014 | repeating nodes must be contiguous. That is, you cannot insert other nodes | ||||||
1015 | between InternationalShippingServiceOption nodes. |
||||||
1016 | |
||||||
1017 | If you specify ShippingDetails when you revise or relist an item but you omit | ||||||
1018 | InternationalShippingServiceOption, eBay will drop the international shipping | ||||||
1019 | services from the listing. This may also have unintended side effects, as | ||||||
1020 | other fields that depend on this data may be dropped as well. To retain the | ||||||
1021 | shipping services and dependent fields when you modify other shipping details, | ||||||
1022 | it may be simplest to specify all ShippingDetails that you still want to | ||||||
1023 | include in the listing. |
||||||
1024 | |
||||||
1025 | Not applicable to Half.com or eBay Motors vehicle listings. | ||||||
1026 | This field is ignored when Item.ListingType=Express. | ||||||
1027 | |||||||
1028 | SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SchemaOverview | ||||||
1029 | For: rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1) | ||||||
1030 | Title: Overview of the API Schema | ||||||
1031 | |||||||
1032 | Calls: AddItem | ||||||
1033 | AddOrder | ||||||
1034 | GetItemRecommendations | ||||||
1035 | RelistItem | ||||||
1036 | ReviseItem | ||||||
1037 | VerifyAddItem | ||||||
1038 | RequiredInput: No | ||||||
1039 | |||||||
1040 | # Argument: reference to an array | ||||||
1041 | of 'ns:InternationalShippingServiceOptionsType' | ||||||
1042 | |||||||
1043 | =cut | ||||||
1044 | |||||||
1045 | sub setInternationalShippingServiceOption { | ||||||
1046 | my $self = shift; | ||||||
1047 | $self->{'InternationalShippingServiceOption'} = | ||||||
1048 | $self->convertArray_To_RefToArrayIfNeeded(@_); | ||||||
1049 | } | ||||||
1050 | |||||||
1051 | =head2 getInternationalShippingServiceOption() | ||||||
1052 | |||||||
1053 | Calls: GetBidderList | ||||||
1054 | GetItemShipping | ||||||
1055 | Returned: Conditionally | ||||||
1056 | |||||||
1057 | Calls: GetItem | ||||||
1058 | Returned: Conditionally | ||||||
1059 | Details: DetailLevel: none, ItemReturnDescription, | ||||||
1060 | ItemReturnAttributes, ReturnAll | ||||||
1061 | |||||||
1062 | Calls: GetSellerList | ||||||
1063 | Returned: Conditionally | ||||||
1064 | Details: DetailLevel: ItemReturnDescription, ReturnAll | ||||||
1065 | |||||||
1066 | Calls: GetItemTransactions | ||||||
1067 | Returned: Conditionally | ||||||
1068 | Details: DetailLevel: none, ReturnAll | ||||||
1069 | |||||||
1070 | Calls: GetOrders | ||||||
1071 | Returned: Conditionally | ||||||
1072 | Details: DetailLevel: none | ||||||
1073 | |||||||
1074 | Calls: GetOrderTransactions | ||||||
1075 | Returned: Conditionally | ||||||
1076 | Details: DetailLevel: none, ItemReturnDescription, ReturnAll | ||||||
1077 | |||||||
1078 | # Returns: reference to an array | ||||||
1079 | of 'ns:InternationalShippingServiceOptionsType' | ||||||
1080 | |||||||
1081 | =cut | ||||||
1082 | |||||||
1083 | sub getInternationalShippingServiceOption { | ||||||
1084 | my $self = shift; | ||||||
1085 | return $self->_getDataTypeArray('InternationalShippingServiceOption'); | ||||||
1086 | } | ||||||
1087 | |||||||
1088 | |||||||
1089 | =head2 setPaymentEdited() | ||||||
1090 | |||||||
1091 | Whether the seller allows the buyer to edit the payment amount | ||||||
1092 | for the transaction. (Sellers enable this property in their My | ||||||
1093 | eBay user preferences on the eBay site.) | ||||||
1094 | Not applicable to Half.com. | ||||||
1095 | |||||||
1096 | # Argument: 'xs:boolean' | ||||||
1097 | |||||||
1098 | =cut | ||||||
1099 | |||||||
1100 | sub setPaymentEdited { | ||||||
1101 | my $self = shift; | ||||||
1102 | $self->{'PaymentEdited'} = shift | ||||||
1103 | } | ||||||
1104 | |||||||
1105 | =head2 isPaymentEdited() | ||||||
1106 | |||||||
1107 | Calls: GetItemShipping | ||||||
1108 | Returned: Conditionally | ||||||
1109 | |||||||
1110 | Calls: GetSellerList | ||||||
1111 | Returned: Conditionally | ||||||
1112 | Details: DetailLevel: ItemReturnDescription, ReturnAll | ||||||
1113 | |||||||
1114 | Calls: GetItemTransactions | ||||||
1115 | GetSellerTransactions | ||||||
1116 | Returned: Conditionally | ||||||
1117 | Details: DetailLevel: none, ItemReturnDescription, ReturnAll | ||||||
1118 | |||||||
1119 | # Returns: 'xs:boolean' | ||||||
1120 | |||||||
1121 | =cut | ||||||
1122 | |||||||
1123 | sub isPaymentEdited { | ||||||
1124 | my $self = shift; | ||||||
1125 | return $self->{'PaymentEdited'}; | ||||||
1126 | } | ||||||
1127 | |||||||
1128 | |||||||
1129 | =head2 setPaymentInstructions() | ||||||
1130 | |||||||
1131 | Payment instructions/message from the seller to the buyer. | ||||||
1132 | These instructions appear on eBay's View Item page and on eBay's | ||||||
1133 | checkout page when the buyer pays for the item. Sellers usually use | ||||||
1134 | this field to specify payment instructions, return policy details, | ||||||
1135 | how soon the item will shipped, feedback instructions, and other reminders | ||||||
1136 | that the buyer should be aware of when they bid on or buy an item. | ||||||
1137 | This field can be specified regardless of the shipping type. | ||||||
1138 | Some sites also let you specify a standard return policy by using | ||||||
1139 | Item.AttributeSetArray in addition or instead. | ||||||
1140 | eBay only allows 500 characters as input, | ||||||
1141 | but due to the way the eBay Web site UI treats characters, this field can | ||||||
1142 | return more than 500 characters in the response. | ||||||
1143 | Characters like & and ' (apostrophe/single quote) count | ||||||
1144 | as 5 characters each. | ||||||
1145 | To remove this value when revising or relisting an item, use DeletedField. | ||||||
1146 | Applicable to eBay Motors (usually used for the return policy). | ||||||
1147 | Not applicable to Half.com. | ||||||
1148 | |||||||
1149 | SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ReturnPolicy | ||||||
1150 | Title: Offering a Clear Return Policy | ||||||
1151 | , URL: io_AddItem.html#Request.Item.AttributeSetArray | ||||||
1152 | Title: (AddItem) Item.AttributeSetArray | ||||||
1153 | , URL: io_GetItem.html#Response.Item.AttributeSetArray | ||||||
1154 | Title: (GetItem) Item.AttributeSetArray | ||||||
1155 | |||||||
1156 | MaxLength: 1000 | ||||||
1157 | |||||||
1158 | Calls: AddItem | ||||||
1159 | GetItemRecommendations | ||||||
1160 | RelistItem | ||||||
1161 | ReviseItem | ||||||
1162 | VerifyAddItem | ||||||
1163 | RequiredInput: No | ||||||
1164 | |||||||
1165 | # Argument: 'xs:string' | ||||||
1166 | |||||||
1167 | =cut | ||||||
1168 | |||||||
1169 | sub setPaymentInstructions { | ||||||
1170 | my $self = shift; | ||||||
1171 | $self->{'PaymentInstructions'} = shift | ||||||
1172 | } | ||||||
1173 | |||||||
1174 | =head2 getPaymentInstructions() | ||||||
1175 | |||||||
1176 | Calls: GetBidderList | ||||||
1177 | GetItemShipping | ||||||
1178 | Returned: Conditionally | ||||||
1179 | |||||||
1180 | Calls: GetItem | ||||||
1181 | Returned: Conditionally | ||||||
1182 | Details: DetailLevel: none, ItemReturnDescription, | ||||||
1183 | ItemReturnAttributes, ReturnAll | ||||||
1184 | |||||||
1185 | Calls: GetItemTransactions | ||||||
1186 | GetSellerTransactions | ||||||
1187 | Returned: Conditionally | ||||||
1188 | Details: DetailLevel: none, ItemReturnDescription, ReturnAll | ||||||
1189 | |||||||
1190 | # Returns: 'xs:string' | ||||||
1191 | |||||||
1192 | =cut | ||||||
1193 | |||||||
1194 | sub getPaymentInstructions { | ||||||
1195 | my $self = shift; | ||||||
1196 | return $self->{'PaymentInstructions'}; | ||||||
1197 | } | ||||||
1198 | |||||||
1199 | |||||||
1200 | =head2 setPromotionalShippingDiscount() | ||||||
1201 | |||||||
1202 | On input, this specifies whether to offer the promotional shipping discount | ||||||
1203 | for the domestic shipping services of this listing (only applicable if the | ||||||
1204 | seller has a promotional shipping discount in effect at the moment). On | ||||||
1205 | output, this indicates whether the promotional shipping discount is being | ||||||
1206 | offered for the domestic shipping services of this listing (if the listing is | ||||||
1207 | still active--this is only possible if the seller has a promotional shipping | ||||||
1208 | discount in effect at the moment) or whether the discount was offered at the | ||||||
1209 | time the listing ended. | ||||||
1210 | Only returned if the calling user is the seller. | ||||||
1211 | |||||||
1212 | SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ShippingDiscountProfiles | ||||||
1213 | Title: Shipping Cost Discount Profiles | ||||||
1214 | |||||||
1215 | Calls: AddItem | ||||||
1216 | RelistItem | ||||||
1217 | ReviseItem | ||||||
1218 | VerifyAddItem | ||||||
1219 | RequiredInput: Conditionally | ||||||
1220 | |||||||
1221 | # Argument: 'xs:boolean' | ||||||
1222 | |||||||
1223 | =cut | ||||||
1224 | |||||||
1225 | sub setPromotionalShippingDiscount { | ||||||
1226 | my $self = shift; | ||||||
1227 | $self->{'PromotionalShippingDiscount'} = shift | ||||||
1228 | } | ||||||
1229 | |||||||
1230 | =head2 isPromotionalShippingDiscount() | ||||||
1231 | |||||||
1232 | Calls: GetItem | ||||||
1233 | Returned: Conditionally | ||||||
1234 | Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll | ||||||
1235 | |||||||
1236 | # Returns: 'xs:boolean' | ||||||
1237 | |||||||
1238 | =cut | ||||||
1239 | |||||||
1240 | sub isPromotionalShippingDiscount { | ||||||
1241 | my $self = shift; | ||||||
1242 | return $self->{'PromotionalShippingDiscount'}; | ||||||
1243 | } | ||||||
1244 | |||||||
1245 | |||||||
1246 | =head2 setPromotionalShippingDiscountDetails() | ||||||
1247 | |||||||
1248 | Details of the promotional shipping discount, if such is being offered while the listing is | ||||||
1249 | active or was offered at the time the listing ended. | ||||||
1250 | Only returned if the calling user is the seller. | ||||||
1251 | |||||||
1252 | SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ShippingDiscountProfiles | ||||||
1253 | Title: Shipping Cost Discount Profiles | ||||||
1254 | |||||||
1255 | # Argument: 'ns:PromotionalShippingDiscountDetailsType' | ||||||
1256 | |||||||
1257 | =cut | ||||||
1258 | |||||||
1259 | sub setPromotionalShippingDiscountDetails { | ||||||
1260 | my $self = shift; | ||||||
1261 | $self->{'PromotionalShippingDiscountDetails'} = shift | ||||||
1262 | } | ||||||
1263 | |||||||
1264 | =head2 getPromotionalShippingDiscountDetails() | ||||||
1265 | |||||||
1266 | Calls: GetShippingDiscountProfiles | ||||||
1267 | Returned: Conditionally | ||||||
1268 | |||||||
1269 | Calls: GetItem | ||||||
1270 | Returned: Conditionally | ||||||
1271 | Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll | ||||||
1272 | |||||||
1273 | # Returns: 'ns:PromotionalShippingDiscountDetailsType' | ||||||
1274 | |||||||
1275 | =cut | ||||||
1276 | |||||||
1277 | sub getPromotionalShippingDiscountDetails { | ||||||
1278 | my $self = shift; | ||||||
1279 | return $self->_getDataTypeInstance( 'PromotionalShippingDiscountDetails' | ||||||
1280 | ,'eBay::API::XML::DataType::PromotionalShippingDiscountDetailsType'); | ||||||
1281 | } | ||||||
1282 | |||||||
1283 | |||||||
1284 | =head2 setSalesTax() | ||||||
1285 | |||||||
1286 | Sales tax details. US site only. Flat and calculated shipping. | ||||||
1287 | Also applicable to Half.com (for GetOrders). | ||||||
1288 | If your application normally calculates sales tax without using eBay's tax | ||||||
1289 | tables, you should understand how purchases via eBay Express will affect | ||||||
1290 | the way you process payments. | ||||||
1291 | For general information about listings on eBay Express, | ||||||
1292 | see the eBay Web Services Guide links below. | ||||||
1293 | Not applicable to eBay Motors vehicle listings. | ||||||
1294 | |||||||
1295 | SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SalesTax | ||||||
1296 | Title: Enabling Multi-jurisdiction Sales Tax | ||||||
1297 | , URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ExpressTax | ||||||
1298 | Title: Specify Sales Tax for Express and eBay | ||||||
1299 | |||||||
1300 | |||||||
1301 | Calls: AddItem | ||||||
1302 | AddOrder | ||||||
1303 | GetItemRecommendations | ||||||
1304 | RelistItem | ||||||
1305 | ReviseItem | ||||||
1306 | VerifyAddItem | ||||||
1307 | RequiredInput: No | ||||||
1308 | |||||||
1309 | # Argument: 'ns:SalesTaxType' | ||||||
1310 | |||||||
1311 | =cut | ||||||
1312 | |||||||
1313 | sub setSalesTax { | ||||||
1314 | my $self = shift; | ||||||
1315 | $self->{'SalesTax'} = shift | ||||||
1316 | } | ||||||
1317 | |||||||
1318 | =head2 getSalesTax() | ||||||
1319 | |||||||
1320 | Calls: GetSellerList | ||||||
1321 | Returned: Conditionally | ||||||
1322 | Details: DetailLevel: ItemReturnDescription, ReturnAll | ||||||
1323 | GranularityLevel: Fine | ||||||
1324 | |||||||
1325 | |||||||
1326 | Calls: GetBidderList | ||||||
1327 | GetItemShipping | ||||||
1328 | Returned: Conditionally | ||||||
1329 | |||||||
1330 | Calls: GetItem | ||||||
1331 | Returned: Conditionally | ||||||
1332 | Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll | ||||||
1333 | |||||||
1334 | Calls: GetItemTransactions | ||||||
1335 | GetSellerTransactions | ||||||
1336 | Returned: Conditionally | ||||||
1337 | Details: DetailLevel: none, ItemReturnDescription, ReturnAll | ||||||
1338 | |||||||
1339 | Calls: GetOrders | ||||||
1340 | Returned: Always | ||||||
1341 | Details: DetailLevel: none | ||||||
1342 | |||||||
1343 | Calls: GetOrderTransactions | ||||||
1344 | Returned: Always | ||||||
1345 | Details: DetailLevel: none, ItemReturnDescription, ReturnAll | ||||||
1346 | |||||||
1347 | # Returns: 'ns:SalesTaxType' | ||||||
1348 | |||||||
1349 | =cut | ||||||
1350 | |||||||
1351 | sub getSalesTax { | ||||||
1352 | my $self = shift; | ||||||
1353 | return $self->_getDataTypeInstance( 'SalesTax' | ||||||
1354 | ,'eBay::API::XML::DataType::SalesTaxType'); | ||||||
1355 | } | ||||||
1356 | |||||||
1357 | |||||||
1358 | =head2 setSellingManagerSalesRecordNumber() | ||||||
1359 | |||||||
1360 | Applicable to Selling Manager Pro sellers. Also applicable to | ||||||
1361 | Half.com (for GetOrders). For GetOrders, the Transaction container | ||||||
1362 | includes this element within ShippingDetails. | ||||||
1363 | |||||||
1364 | # Argument: 'xs:int' | ||||||
1365 | |||||||
1366 | =cut | ||||||
1367 | |||||||
1368 | sub setSellingManagerSalesRecordNumber { | ||||||
1369 | my $self = shift; | ||||||
1370 | $self->{'SellingManagerSalesRecordNumber'} = shift | ||||||
1371 | } | ||||||
1372 | |||||||
1373 | =head2 getSellingManagerSalesRecordNumber() | ||||||
1374 | |||||||
1375 | Calls: GetItemTransactions | ||||||
1376 | GetSellerTransactions | ||||||
1377 | Returned: Conditionally | ||||||
1378 | Details: DetailLevel: none, ItemReturnDescription, ReturnAll | ||||||
1379 | |||||||
1380 | Calls: GetOrders | ||||||
1381 | Returned: Conditionally | ||||||
1382 | Details: DetailLevel: none | ||||||
1383 | |||||||
1384 | Calls: GetOrderTransactions | ||||||
1385 | Returned: Conditionally | ||||||
1386 | Details: DetailLevel: none, ItemReturnDescription, ReturnAll | ||||||
1387 | |||||||
1388 | # Returns: 'xs:int' | ||||||
1389 | |||||||
1390 | =cut | ||||||
1391 | |||||||
1392 | sub getSellingManagerSalesRecordNumber { | ||||||
1393 | my $self = shift; | ||||||
1394 | return $self->{'SellingManagerSalesRecordNumber'}; | ||||||
1395 | } | ||||||
1396 | |||||||
1397 | |||||||
1398 | =head2 setShipmentTrackingNumber() | ||||||
1399 | |||||||
1400 | Shipment tracking number supplied by the shipping carrier. | ||||||
1401 | Not applicable to Half.com. | ||||||
1402 | |||||||
1403 | # Argument: 'xs:string' | ||||||
1404 | |||||||
1405 | =cut | ||||||
1406 | |||||||
1407 | sub setShipmentTrackingNumber { | ||||||
1408 | my $self = shift; | ||||||
1409 | $self->{'ShipmentTrackingNumber'} = shift | ||||||
1410 | } | ||||||
1411 | |||||||
1412 | =head2 getShipmentTrackingNumber() | ||||||
1413 | |||||||
1414 | Calls: GetItemTransactions | ||||||
1415 | GetSellerTransactions | ||||||
1416 | Returned: Conditionally | ||||||
1417 | Details: DetailLevel: none, ItemReturnDescription, ReturnAll | ||||||
1418 | |||||||
1419 | # Returns: 'xs:string' | ||||||
1420 | |||||||
1421 | =cut | ||||||
1422 | |||||||
1423 | sub getShipmentTrackingNumber { | ||||||
1424 | my $self = shift; | ||||||
1425 | return $self->{'ShipmentTrackingNumber'}; | ||||||
1426 | } | ||||||
1427 | |||||||
1428 | |||||||
1429 | =head2 setShippingDiscountProfileID() | ||||||
1430 | |||||||
1431 | On input, this is the ID of the shipping discount to offer for the domestic | ||||||
1432 | shipping services (where the shipping discount is either of type | ||||||
1433 | FlatShippingDiscount or CalculatedShippingDiscount). On output, this is the ID | ||||||
1434 | of the shipping discount offered and corresponds to whichever is returned: | ||||||
1435 | FlatShippingDiscount or CalculatedShippingDiscount. Only returned if the | ||||||
1436 | calling user is the seller. | ||||||
1437 | Only returned if the calling user is the seller. | ||||||
1438 | |||||||
1439 | SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ShippingDiscountProfiles | ||||||
1440 | Title: Shipping Cost Discount Profiles | ||||||
1441 | |||||||
1442 | Calls: AddItem | ||||||
1443 | RelistItem | ||||||
1444 | ReviseItem | ||||||
1445 | VerifyAddItem | ||||||
1446 | RequiredInput: Conditionally | ||||||
1447 | |||||||
1448 | # Argument: 'xs:string' | ||||||
1449 | |||||||
1450 | =cut | ||||||
1451 | |||||||
1452 | sub setShippingDiscountProfileID { | ||||||
1453 | my $self = shift; | ||||||
1454 | $self->{'ShippingDiscountProfileID'} = shift | ||||||
1455 | } | ||||||
1456 | |||||||
1457 | =head2 getShippingDiscountProfileID() | ||||||
1458 | |||||||
1459 | Calls: GetItem | ||||||
1460 | Returned: Conditionally | ||||||
1461 | Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll | ||||||
1462 | |||||||
1463 | # Returns: 'xs:string' | ||||||
1464 | |||||||
1465 | =cut | ||||||
1466 | |||||||
1467 | sub getShippingDiscountProfileID { | ||||||
1468 | my $self = shift; | ||||||
1469 | return $self->{'ShippingDiscountProfileID'}; | ||||||
1470 | } | ||||||
1471 | |||||||
1472 | |||||||
1473 | =head2 setShippingRateErrorMessage() | ||||||
1474 | |||||||
1475 | For most applicable calls, returns the words No Error or returns an error | ||||||
1476 | message related to an attempt to calculate shipping rates. For calculated | ||||||
1477 | shipping only. | ||||||
1478 | Not applicable to Half.com or eBay Motors vehicle listings. | ||||||
1479 | |
||||||
1480 | |
||||||
1481 | GetSearchResultsExpress returns this when no PostalCode was specified in the | ||||||
1482 | request and the item was listed with calculated shipping rates. The message | ||||||
1483 | text explains that a postal code is needed to calculate shipping. Only | ||||||
1484 | returned when ItemDetails is set to Fine. | ||||||
1485 | |||||||
1486 | # Argument: 'xs:string' | ||||||
1487 | |||||||
1488 | =cut | ||||||
1489 | |||||||
1490 | sub setShippingRateErrorMessage { | ||||||
1491 | my $self = shift; | ||||||
1492 | $self->{'ShippingRateErrorMessage'} = shift | ||||||
1493 | } | ||||||
1494 | |||||||
1495 | =head2 getShippingRateErrorMessage() | ||||||
1496 | |||||||
1497 | Calls: GetItemShipping | ||||||
1498 | Returned: Conditionally | ||||||
1499 | |||||||
1500 | Calls: GetItemTransactions | ||||||
1501 | GetSellerTransactions | ||||||
1502 | Returned: Conditionally | ||||||
1503 | Details: DetailLevel: none, ReturnAll | ||||||
1504 | |||||||
1505 | # Returns: 'xs:string' | ||||||
1506 | |||||||
1507 | =cut | ||||||
1508 | |||||||
1509 | sub getShippingRateErrorMessage { | ||||||
1510 | my $self = shift; | ||||||
1511 | return $self->{'ShippingRateErrorMessage'}; | ||||||
1512 | } | ||||||
1513 | |||||||
1514 | |||||||
1515 | =head2 setShippingRateType() | ||||||
1516 | |||||||
1517 | A shipping rate scale for shipping through UPS that affects the shipping cost | ||||||
1518 | calculated for UPS (lower if ShippingRateType is DailyPickup). | ||||||
1519 | ShippingRateType is only returned if ShippingService is one of the UPS | ||||||
1520 | shipping services. For calculated shipping only. | ||||||
1521 | Not applicable to Half.com or eBay Motors vehicle listings. | ||||||
1522 | |||||||
1523 | SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Shipping | ||||||
1524 | Title: Shipping | ||||||
1525 | |||||||
1526 | # Argument: 'ns:ShippingRateTypeCodeType' | ||||||
1527 | |||||||
1528 | =cut | ||||||
1529 | |||||||
1530 | sub setShippingRateType { | ||||||
1531 | my $self = shift; | ||||||
1532 | $self->{'ShippingRateType'} = shift | ||||||
1533 | } | ||||||
1534 | |||||||
1535 | =head2 getShippingRateType() | ||||||
1536 | |||||||
1537 | Calls: GetItemShipping | ||||||
1538 | Returned: Conditionally | ||||||
1539 | |||||||
1540 | Calls: GetItemTransactions | ||||||
1541 | GetSellerTransactions | ||||||
1542 | Returned: Conditionally | ||||||
1543 | Details: DetailLevel: none, ItemReturnDescription, ReturnAll | ||||||
1544 | |||||||
1545 | # Returns: 'ns:ShippingRateTypeCodeType' | ||||||
1546 | |||||||
1547 | =cut | ||||||
1548 | |||||||
1549 | sub getShippingRateType { | ||||||
1550 | my $self = shift; | ||||||
1551 | return $self->{'ShippingRateType'}; | ||||||
1552 | } | ||||||
1553 | |||||||
1554 | |||||||
1555 | =head2 setShippingServiceOptions() | ||||||
1556 | |||||||
1557 | Shipping costs and options related to domestic shipping services offered by | ||||||
1558 | the seller. Flat and calculated shipping. Required if | ||||||
1559 | InternationalShippingServiceOption is specified. |
||||||
1560 | |
||||||
1561 | If you specify multiple ShippingServiceOptions nodes, the repeating nodes must | ||||||
1562 | be contiguous. For example, you can insert InternationalShippingServiceOption | ||||||
1563 | nodes after a list of repeating ShippingServiceOptions nodes, but not between | ||||||
1564 | them: |
||||||
1565 | |
||||||
1566 | <ShippingServiceOptions>...</ShippingServiceOptions> |
||||||
1567 | <ShippingServiceOptions>...</ShippingServiceOptions> |
||||||
1568 | <ShippingServiceOptions>...</ShippingServiceOptions> |
||||||
1569 | <InternationalShippingServiceOption>...</InternationalShippingServiceOption> |
||||||
1570 | <InternationalShippingServiceOption>...</InternationalShippingServiceOption> |
||||||
1571 | |
||||||
1572 | If you specify ShippingDetails when you revise or relist an item but you omit | ||||||
1573 | ShippingServiceOptions, eBay will drop the domestic shipping services from the | ||||||
1574 | listing. This may also have unintended side effects, as other fields that | ||||||
1575 | depend on this data may be dropped as well. To retain the shipping services | ||||||
1576 | and dependent fields when you modify other shipping details, it may be | ||||||
1577 | simplest to specify all ShippingDetails that you still want to include in the | ||||||
1578 | listing. |
||||||
1579 | |
||||||
1580 | Not applicable to Half.com or eBay Motors vehicle listings. | ||||||
1581 | |||||||
1582 | SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SchemaOverview | ||||||
1583 | For: rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1) | ||||||
1584 | Title: Overview of the API Schema | ||||||
1585 | |||||||
1586 | Calls: AddItem | ||||||
1587 | GetItemRecommendations | ||||||
1588 | RelistItem | ||||||
1589 | ReviseItem | ||||||
1590 | VerifyAddItem | ||||||
1591 | RequiredInput: Conditionally | ||||||
1592 | |||||||
1593 | Calls: AddOrder | ||||||
1594 | RequiredInput: No | ||||||
1595 | |||||||
1596 | # Argument: reference to an array | ||||||
1597 | of 'ns:ShippingServiceOptionsType' | ||||||
1598 | |||||||
1599 | =cut | ||||||
1600 | |||||||
1601 | sub setShippingServiceOptions { | ||||||
1602 | my $self = shift; | ||||||
1603 | $self->{'ShippingServiceOptions'} = | ||||||
1604 | $self->convertArray_To_RefToArrayIfNeeded(@_); | ||||||
1605 | } | ||||||
1606 | |||||||
1607 | =head2 getShippingServiceOptions() | ||||||
1608 | |||||||
1609 | Calls: GetItem | ||||||
1610 | Returned: Always | ||||||
1611 | Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll | ||||||
1612 | |||||||
1613 | Calls: GetMyeBayBuying | ||||||
1614 | Returned: Conditionally | ||||||
1615 | Details: DetailLevel: none, ReturnSummary, ReturnAll | ||||||
1616 | Context: BidList | ||||||
1617 | WonList | ||||||
1618 | WatchList | ||||||
1619 | DeletedFromWonList | ||||||
1620 | BestOfferList | ||||||
1621 | |||||||
1622 | Calls: GetMyeBaySelling | ||||||
1623 | Returned: Conditionally | ||||||
1624 | Details: DetailLevel: none, ReturnSummary, ReturnAll | ||||||
1625 | Context: BidList | ||||||
1626 | ActiveList | ||||||
1627 | ScheduledList | ||||||
1628 | |||||||
1629 | Calls: GetSellerList | ||||||
1630 | Returned: Conditionally | ||||||
1631 | Details: DetailLevel: ItemReturnDescription, ReturnAll | ||||||
1632 | |||||||
1633 | Calls: GetItemShipping | ||||||
1634 | Returned: Conditionally | ||||||
1635 | |||||||
1636 | Calls: GetItemTransactions | ||||||
1637 | Returned: Conditionally | ||||||
1638 | Details: DetailLevel: none, ReturnAll | ||||||
1639 | |||||||
1640 | Calls: GetOrders | ||||||
1641 | Returned: Conditionally | ||||||
1642 | Details: DetailLevel: none | ||||||
1643 | |||||||
1644 | Calls: GetOrderTransactions | ||||||
1645 | Returned: Conditionally | ||||||
1646 | Details: DetailLevel: none, ItemReturnDescription, ReturnAll | ||||||
1647 | |||||||
1648 | # Returns: reference to an array | ||||||
1649 | of 'ns:ShippingServiceOptionsType' | ||||||
1650 | |||||||
1651 | =cut | ||||||
1652 | |||||||
1653 | sub getShippingServiceOptions { | ||||||
1654 | my $self = shift; | ||||||
1655 | return $self->_getDataTypeArray('ShippingServiceOptions'); | ||||||
1656 | } | ||||||
1657 | |||||||
1658 | |||||||
1659 | =head2 setShippingServiceUsed() | ||||||
1660 | |||||||
1661 | The shipping service that actually shipped the item(s). | ||||||
1662 | Not applicable to Half.com. | ||||||
1663 | |||||||
1664 | # Argument: 'xs:token' | ||||||
1665 | |||||||
1666 | =cut | ||||||
1667 | |||||||
1668 | sub setShippingServiceUsed { | ||||||
1669 | my $self = shift; | ||||||
1670 | $self->{'ShippingServiceUsed'} = shift | ||||||
1671 | } | ||||||
1672 | |||||||
1673 | =head2 getShippingServiceUsed() | ||||||
1674 | |||||||
1675 | Calls: GetItemTransactions | ||||||
1676 | GetSellerTransactions | ||||||
1677 | Returned: Conditionally | ||||||
1678 | Details: DetailLevel: none, ItemReturnDescription, ReturnAll | ||||||
1679 | |||||||
1680 | # Returns: 'xs:token' | ||||||
1681 | |||||||
1682 | =cut | ||||||
1683 | |||||||
1684 | sub getShippingServiceUsed { | ||||||
1685 | my $self = shift; | ||||||
1686 | return $self->{'ShippingServiceUsed'}; | ||||||
1687 | } | ||||||
1688 | |||||||
1689 | |||||||
1690 | =head2 setShippingType() | ||||||
1691 | |||||||
1692 | The shipping cost model offered by the seller. This is not returned for | ||||||
1693 | various calls since shipping type can be deduced: if a CalculatedShippingRate | ||||||
1694 | structure is returned by the call, the shipping type is Calculated. Otherwise, | ||||||
1695 | it is one of the other non-Calculated shipping types. | ||||||
1696 | Not applicable to Half.com. | ||||||
1697 | |||||||
1698 | Calls: AddItem | ||||||
1699 | RelistItem | ||||||
1700 | ReviseItem | ||||||
1701 | VerifyAddItem | ||||||
1702 | RequiredInput: No | ||||||
1703 | AllValuesExcept: Free, Freight | ||||||
1704 | |||||||
1705 | Calls: GetItemRecommendations | ||||||
1706 | RequiredInput: No | ||||||
1707 | AllValuesExcept: Free, Freight | ||||||
1708 | |||||||
1709 | # Argument: 'ns:ShippingTypeCodeType' | ||||||
1710 | |||||||
1711 | =cut | ||||||
1712 | |||||||
1713 | sub setShippingType { | ||||||
1714 | my $self = shift; | ||||||
1715 | $self->{'ShippingType'} = shift | ||||||
1716 | } | ||||||
1717 | |||||||
1718 | =head2 getShippingType() | ||||||
1719 | |||||||
1720 | Calls: GetBidderList | ||||||
1721 | Returned: Conditionally | ||||||
1722 | AllValuesExcept: Free | ||||||
1723 | |||||||
1724 | Calls: GetProducts | ||||||
1725 | Returned: Conditionally | ||||||
1726 | |||||||
1727 | Calls: GetSearchResults | ||||||
1728 | Returned: Conditionally | ||||||
1729 | Details: DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll | ||||||
1730 | GranularityLevel: Coarse | ||||||
1731 | |||||||
1732 | |||||||
1733 | Calls: GetItemTransactions | ||||||
1734 | Returned: Conditionally | ||||||
1735 | AllValuesExcept: Free, Freight | ||||||
1736 | Details: DetailLevel: ItemReturnDescription, none, ReturnAll | ||||||
1737 | |||||||
1738 | Calls: GetSellerTransactions | ||||||
1739 | Returned: Conditionally | ||||||
1740 | AllValuesExcept: Free, Freight | ||||||
1741 | Details: DetailLevel: ItemReturnDescription, none, ReturnAll | ||||||
1742 | |||||||
1743 | Calls: GetItem | ||||||
1744 | Returned: Conditionally | ||||||
1745 | AllValuesExcept: Free, Freight | ||||||
1746 | Details: DetailLevel: ItemReturnAttributes, none, ReturnAll | ||||||
1747 | |||||||
1748 | # Returns: 'ns:ShippingTypeCodeType' | ||||||
1749 | |||||||
1750 | =cut | ||||||
1751 | |||||||
1752 | sub getShippingType { | ||||||
1753 | my $self = shift; | ||||||
1754 | return $self->{'ShippingType'}; | ||||||
1755 | } | ||||||
1756 | |||||||
1757 | |||||||
1758 | =head2 setTaxTable() | ||||||
1759 | |||||||
1760 | Tax details for a jurisdiction such as a state or province. | ||||||
1761 | If no tax table is associated with the item, no tax table is returned, | ||||||
1762 | even if IncludeTaxTable is set to true. | ||||||
1763 |
|
||||||
1764 | If a tax table is associated with the item: | ||||||
1765 | |
||||||
1766 | - the tax table is returned if DetailLevel is ReturnAll or | ||||||
1767 | ItemReturnDescription (and the value of IncludeTaxTable does not matter) | ||||||
1768 | |
||||||
1769 | - if no DetailLevel is specified or if DetailLevel is ItemReturnAttributes, | ||||||
1770 | the tax table is returned only if IncludeTaxTable is true | ||||||
1771 |
|
||||||
1772 | Not applicable to Half.com. | ||||||
1773 | |||||||
1774 | # Argument: 'ns:TaxTableType' | ||||||
1775 | |||||||
1776 | =cut | ||||||
1777 | |||||||
1778 | sub setTaxTable { | ||||||
1779 | my $self = shift; | ||||||
1780 | $self->{'TaxTable'} = shift | ||||||
1781 | } | ||||||
1782 | |||||||
1783 | =head2 getTaxTable() | ||||||
1784 | |||||||
1785 | Calls: GetItem | ||||||
1786 | Returned: Conditionally | ||||||
1787 | Details: DetailLevel: ItemReturnDescription, ReturnAll | ||||||
1788 | |||||||
1789 | Calls: GetBidderList | ||||||
1790 | GetItemShipping | ||||||
1791 | Returned: Conditionally | ||||||
1792 | |||||||
1793 | Calls: GetOrderTransactions | ||||||
1794 | Returned: Conditionally | ||||||
1795 | Details: DetailLevel: ReturnAll | ||||||
1796 | |||||||
1797 | Calls: GetSellerList | ||||||
1798 | Returned: Conditionally | ||||||
1799 | Details: DetailLevel: ItemReturnDescription, ReturnAll | ||||||
1800 | GranularityLevel: Coarse, Medium, Fine | ||||||
1801 | |||||||
1802 | |||||||
1803 | Calls: GetItemTransactions | ||||||
1804 | GetSellerTransactions | ||||||
1805 | Returned: Conditionally | ||||||
1806 | Details: DetailLevel: none, ReturnAll | ||||||
1807 | |||||||
1808 | # Returns: 'ns:TaxTableType' | ||||||
1809 | |||||||
1810 | =cut | ||||||
1811 | |||||||
1812 | sub getTaxTable { | ||||||
1813 | my $self = shift; | ||||||
1814 | return $self->_getDataTypeInstance( 'TaxTable' | ||||||
1815 | ,'eBay::API::XML::DataType::TaxTableType'); | ||||||
1816 | } | ||||||
1817 | |||||||
1818 | |||||||
1819 | =head2 setThirdPartyCheckout() | ||||||
1820 | |||||||
1821 | Whether checkout for this is to be handled by a | ||||||
1822 | Third-Party Checkout application. The counterpart in the AddItem | ||||||
1823 | family of calls is Item.ThirdPartyCheckout. | ||||||
1824 | Not applicable to Half.com. | ||||||
1825 | |||||||
1826 | SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ThirdPartyCheckout | ||||||
1827 | Title: Third Party Checkout | ||||||
1828 | , URL: io_AddItem.html#Request.Item.ThirdPartyCheckout | ||||||
1829 | Title: (AddItem) Item.ThirdPartyCheckout | ||||||
1830 | |||||||
1831 | |||||||
1832 | Calls: AddOrder | ||||||
1833 | RequiredInput: No | ||||||
1834 | |||||||
1835 | # Argument: 'xs:boolean' | ||||||
1836 | |||||||
1837 | =cut | ||||||
1838 | |||||||
1839 | sub setThirdPartyCheckout { | ||||||
1840 | my $self = shift; | ||||||
1841 | $self->{'ThirdPartyCheckout'} = shift | ||||||
1842 | } | ||||||
1843 | |||||||
1844 | =head2 isThirdPartyCheckout() | ||||||
1845 | |||||||
1846 | Calls: GetItem | ||||||
1847 | Returned: Always | ||||||
1848 | Details: DetailLevel: none, ItemReturnDescription, | ||||||
1849 | ItemReturnAttributes, ReturnAll | ||||||
1850 | |||||||
1851 | Calls: GetSellerList | ||||||
1852 | Returned: Conditionally | ||||||
1853 | Details: DetailLevel: ItemReturnDescription, ReturnAll | ||||||
1854 | GranularityLevel: Fine | ||||||
1855 | |||||||
1856 | |||||||
1857 | Calls: GetBidderList | ||||||
1858 | GetItemShipping | ||||||
1859 | Returned: Conditionally | ||||||
1860 | |||||||
1861 | Calls: GetItemTransactions | ||||||
1862 | GetSellerTransactions | ||||||
1863 | Returned: Conditionally | ||||||
1864 | Details: DetailLevel: none, ReturnAll | ||||||
1865 | |||||||
1866 | # Returns: 'xs:boolean' | ||||||
1867 | |||||||
1868 | =cut | ||||||
1869 | |||||||
1870 | sub isThirdPartyCheckout { | ||||||
1871 | my $self = shift; | ||||||
1872 | return $self->{'ThirdPartyCheckout'}; | ||||||
1873 | } | ||||||
1874 | |||||||
1875 | |||||||
1876 | |||||||
1877 | |||||||
1878 | |||||||
1879 | ## Attribute and Property lists | ||||||
1880 | sub getPropertiesList { | ||||||
1881 | my $self = shift; | ||||||
1882 | return \@gaProperties; | ||||||
1883 | } | ||||||
1884 | |||||||
1885 | sub getAttributesList { | ||||||
1886 | my $self = shift; | ||||||
1887 | return \@gaAttributes; | ||||||
1888 | } | ||||||
1889 | |||||||
1890 | |||||||
1891 | |||||||
1892 | 1; |