line |
stmt |
bran |
cond |
sub |
pod |
time |
code |
1
|
|
|
|
|
|
|
#!/usr/bin/perl |
2
|
|
|
|
|
|
|
|
3
|
|
|
|
|
|
|
package eBay::API::XML::Call::SendInvoice; |
4
|
|
|
|
|
|
|
|
5
|
1
|
|
|
1
|
|
2528
|
use strict; |
|
1
|
|
|
|
|
2
|
|
|
1
|
|
|
|
|
26
|
|
6
|
1
|
|
|
1
|
|
4
|
use warnings; |
|
1
|
|
|
|
|
2
|
|
|
1
|
|
|
|
|
36
|
|
7
|
|
|
|
|
|
|
|
8
|
|
|
|
|
|
|
########################################################################## |
9
|
|
|
|
|
|
|
# |
10
|
|
|
|
|
|
|
# Module: ............... eBay/API/XML |
11
|
|
|
|
|
|
|
# File: ................. SendInvoice.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::Call::SendInvoice |
21
|
|
|
|
|
|
|
|
22
|
|
|
|
|
|
|
=head1 DESCRIPTION |
23
|
|
|
|
|
|
|
|
24
|
|
|
|
|
|
|
|
25
|
|
|
|
|
|
|
|
26
|
|
|
|
|
|
|
=head1 SYNOPSIS |
27
|
|
|
|
|
|
|
|
28
|
|
|
|
|
|
|
=cut |
29
|
|
|
|
|
|
|
|
30
|
|
|
|
|
|
|
|
31
|
|
|
|
|
|
|
=head1 INHERITANCE |
32
|
|
|
|
|
|
|
|
33
|
|
|
|
|
|
|
eBay::API::XML::Call::SendInvoice inherits from the L class |
34
|
|
|
|
|
|
|
|
35
|
|
|
|
|
|
|
=cut |
36
|
|
|
|
|
|
|
|
37
|
1
|
|
|
1
|
|
32
|
use eBay::API::XML::BaseCall; |
|
0
|
|
|
|
|
|
|
|
0
|
|
|
|
|
|
|
38
|
|
|
|
|
|
|
our @ISA = ("eBay::API::XML::BaseCall"); |
39
|
|
|
|
|
|
|
|
40
|
|
|
|
|
|
|
use eBay::API::XML::Call::SendInvoice::SendInvoiceRequestType; |
41
|
|
|
|
|
|
|
use eBay::API::XML::Call::SendInvoice::SendInvoiceResponseType; |
42
|
|
|
|
|
|
|
|
43
|
|
|
|
|
|
|
|
44
|
|
|
|
|
|
|
=head1 Subroutines: |
45
|
|
|
|
|
|
|
|
46
|
|
|
|
|
|
|
=cut |
47
|
|
|
|
|
|
|
|
48
|
|
|
|
|
|
|
sub getApiCallName { |
49
|
|
|
|
|
|
|
return 'SendInvoice'; |
50
|
|
|
|
|
|
|
} |
51
|
|
|
|
|
|
|
sub getRequestDataTypeFullPackage { |
52
|
|
|
|
|
|
|
return 'eBay::API::XML::Call::SendInvoice::SendInvoiceRequestType'; |
53
|
|
|
|
|
|
|
} |
54
|
|
|
|
|
|
|
sub getResponseDataTypeFullPackage { |
55
|
|
|
|
|
|
|
return 'eBay::API::XML::Call::SendInvoice::SendInvoiceResponseType'; |
56
|
|
|
|
|
|
|
} |
57
|
|
|
|
|
|
|
|
58
|
|
|
|
|
|
|
# |
59
|
|
|
|
|
|
|
# input properties |
60
|
|
|
|
|
|
|
# |
61
|
|
|
|
|
|
|
|
62
|
|
|
|
|
|
|
=head2 setCODCost() |
63
|
|
|
|
|
|
|
|
64
|
|
|
|
|
|
|
Italy site (site ID 101) only. |
65
|
|
|
|
|
|
|
Enables you to specify the cash-on-delivery (COD) cost, for COD shipping. |
66
|
|
|
|
|
|
|
|
67
|
|
|
|
|
|
|
SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=CODInShippingDetails |
68
|
|
|
|
|
|
|
Title: Specifying the Cash on Delivery Option in Shipping Details |
69
|
|
|
|
|
|
|
|
70
|
|
|
|
|
|
|
RequiredInput: No |
71
|
|
|
|
|
|
|
# Argument: 'ns:AmountType' |
72
|
|
|
|
|
|
|
|
73
|
|
|
|
|
|
|
=cut |
74
|
|
|
|
|
|
|
|
75
|
|
|
|
|
|
|
sub setCODCost { |
76
|
|
|
|
|
|
|
my $self = shift; |
77
|
|
|
|
|
|
|
my $pCODCost = shift; |
78
|
|
|
|
|
|
|
$self->getRequestDataType()->setCODCost($pCODCost); |
79
|
|
|
|
|
|
|
} |
80
|
|
|
|
|
|
|
|
81
|
|
|
|
|
|
|
=head2 setCheckoutInstructions() |
82
|
|
|
|
|
|
|
|
83
|
|
|
|
|
|
|
Seller's Payment instructions/message to the buyer and return policy. |
84
|
|
|
|
|
|
|
Default is null. |
85
|
|
|
|
|
|
|
|
86
|
|
|
|
|
|
|
MaxLength: 500 |
87
|
|
|
|
|
|
|
|
88
|
|
|
|
|
|
|
RequiredInput: No |
89
|
|
|
|
|
|
|
# Argument: 'xs:string' |
90
|
|
|
|
|
|
|
|
91
|
|
|
|
|
|
|
=cut |
92
|
|
|
|
|
|
|
|
93
|
|
|
|
|
|
|
sub setCheckoutInstructions { |
94
|
|
|
|
|
|
|
my $self = shift; |
95
|
|
|
|
|
|
|
my $sCheckoutInstructions = shift; |
96
|
|
|
|
|
|
|
$self->getRequestDataType()->setCheckoutInstructions($sCheckoutInstructions); |
97
|
|
|
|
|
|
|
} |
98
|
|
|
|
|
|
|
|
99
|
|
|
|
|
|
|
=head2 setEmailCopyToSeller() |
100
|
|
|
|
|
|
|
|
101
|
|
|
|
|
|
|
Specifies whether the seller wishes to be copied on the invoice email that |
102
|
|
|
|
|
|
|
will be sent to the buyer. Default will be true. |
103
|
|
|
|
|
|
|
|
104
|
|
|
|
|
|
|
RequiredInput: No |
105
|
|
|
|
|
|
|
# Argument: 'xs:boolean' |
106
|
|
|
|
|
|
|
|
107
|
|
|
|
|
|
|
=cut |
108
|
|
|
|
|
|
|
|
109
|
|
|
|
|
|
|
sub setEmailCopyToSeller { |
110
|
|
|
|
|
|
|
my $self = shift; |
111
|
|
|
|
|
|
|
my $sEmailCopyToSeller = shift; |
112
|
|
|
|
|
|
|
$self->getRequestDataType()->setEmailCopyToSeller($sEmailCopyToSeller); |
113
|
|
|
|
|
|
|
} |
114
|
|
|
|
|
|
|
|
115
|
|
|
|
|
|
|
=head2 setInsuranceFee() |
116
|
|
|
|
|
|
|
|
117
|
|
|
|
|
|
|
Insurance cost, as set by seller, if ShippingType = 1. |
118
|
|
|
|
|
|
|
Specify if InsuranceOption is optional or required. Must |
119
|
|
|
|
|
|
|
be greater than zero value if a value of Optional or Required is passed in |
120
|
|
|
|
|
|
|
InsuranceOption. Value specified should be the total cost of insuring the |
121
|
|
|
|
|
|
|
item. |
122
|
|
|
|
|
|
|
|
123
|
|
|
|
|
|
|
Not applicable to invoices for digital listings. |
124
|
|
|
|
|
|
|
|
125
|
|
|
|
|
|
|
SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ShippingGettingCosts |
126
|
|
|
|
|
|
|
Title: Determining Shipping Costs for a Listing |
127
|
|
|
|
|
|
|
Default: 0.0 |
128
|
|
|
|
|
|
|
|
129
|
|
|
|
|
|
|
RequiredInput: No |
130
|
|
|
|
|
|
|
# Argument: 'ns:AmountType' |
131
|
|
|
|
|
|
|
|
132
|
|
|
|
|
|
|
=cut |
133
|
|
|
|
|
|
|
|
134
|
|
|
|
|
|
|
sub setInsuranceFee { |
135
|
|
|
|
|
|
|
my $self = shift; |
136
|
|
|
|
|
|
|
my $pInsuranceFee = shift; |
137
|
|
|
|
|
|
|
$self->getRequestDataType()->setInsuranceFee($pInsuranceFee); |
138
|
|
|
|
|
|
|
} |
139
|
|
|
|
|
|
|
|
140
|
|
|
|
|
|
|
=head2 setInsuranceOption() |
141
|
|
|
|
|
|
|
|
142
|
|
|
|
|
|
|
Specifies whether insurance fee is required. An InsuranceOption value of |
143
|
|
|
|
|
|
|
IncludedInShippingHandling cannot be used if the item will use calculated |
144
|
|
|
|
|
|
|
shipping. Some shipping carriers automatically include shipping insurance |
145
|
|
|
|
|
|
|
for qualifying items. |
146
|
|
|
|
|
|
|
|
147
|
|
|
|
|
|
|
Not applicable to invoices for digital listings. |
148
|
|
|
|
|
|
|
|
149
|
|
|
|
|
|
|
SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ShippingGettingCosts |
150
|
|
|
|
|
|
|
Title: Determining Shipping Costs for a Listing |
151
|
|
|
|
|
|
|
|
152
|
|
|
|
|
|
|
RequiredInput: No |
153
|
|
|
|
|
|
|
AllValuesExcept: NotOfferedOnSite |
154
|
|
|
|
|
|
|
# Argument: 'ns:InsuranceOptionCodeType' |
155
|
|
|
|
|
|
|
|
156
|
|
|
|
|
|
|
=cut |
157
|
|
|
|
|
|
|
|
158
|
|
|
|
|
|
|
sub setInsuranceOption { |
159
|
|
|
|
|
|
|
my $self = shift; |
160
|
|
|
|
|
|
|
my $sInsuranceOption = shift; |
161
|
|
|
|
|
|
|
$self->getRequestDataType()->setInsuranceOption($sInsuranceOption); |
162
|
|
|
|
|
|
|
} |
163
|
|
|
|
|
|
|
|
164
|
|
|
|
|
|
|
=head2 setInternationalShippingServiceOptions() |
165
|
|
|
|
|
|
|
|
166
|
|
|
|
|
|
|
If the buyer's shipping address is international, use this to offer up to |
167
|
|
|
|
|
|
|
three shipping services, and omit all domestic ShippingServiceOptions. Any |
168
|
|
|
|
|
|
|
shipping insurance cost specified should be the same for all services |
169
|
|
|
|
|
|
|
offered. |
170
|
|
|
|
|
|
|
|
171
|
|
|
|
|
|
|
Not applicable to invoices for digital listings. |
172
|
|
|
|
|
|
|
|
173
|
|
|
|
|
|
|
RequiredInput: No |
174
|
|
|
|
|
|
|
# Argument: reference to an array |
175
|
|
|
|
|
|
|
of 'ns:InternationalShippingServiceOptionsType' |
176
|
|
|
|
|
|
|
|
177
|
|
|
|
|
|
|
=cut |
178
|
|
|
|
|
|
|
|
179
|
|
|
|
|
|
|
sub setInternationalShippingServiceOptions { |
180
|
|
|
|
|
|
|
my $self = shift; |
181
|
|
|
|
|
|
|
my $pInternationalShippingServiceOptions = shift; |
182
|
|
|
|
|
|
|
$self->getRequestDataType()->setInternationalShippingServiceOptions($pInternationalShippingServiceOptions); |
183
|
|
|
|
|
|
|
} |
184
|
|
|
|
|
|
|
|
185
|
|
|
|
|
|
|
=head2 setItemID() |
186
|
|
|
|
|
|
|
|
187
|
|
|
|
|
|
|
Item ID. If OrderID is not provided, both ItemID and |
188
|
|
|
|
|
|
|
TransactionID must be provided. |
189
|
|
|
|
|
|
|
|
190
|
|
|
|
|
|
|
MaxLength: 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) |
191
|
|
|
|
|
|
|
|
192
|
|
|
|
|
|
|
RequiredInput: Conditionally |
193
|
|
|
|
|
|
|
# Argument: 'ns:ItemIDType' |
194
|
|
|
|
|
|
|
|
195
|
|
|
|
|
|
|
=cut |
196
|
|
|
|
|
|
|
|
197
|
|
|
|
|
|
|
sub setItemID { |
198
|
|
|
|
|
|
|
my $self = shift; |
199
|
|
|
|
|
|
|
my $pItemID = shift; |
200
|
|
|
|
|
|
|
$self->getRequestDataType()->setItemID($pItemID); |
201
|
|
|
|
|
|
|
} |
202
|
|
|
|
|
|
|
|
203
|
|
|
|
|
|
|
=head2 setOrderID() |
204
|
|
|
|
|
|
|
|
205
|
|
|
|
|
|
|
Unique ID for a multi-item order. Either this OrderID must |
206
|
|
|
|
|
|
|
be specified or ItemID plus TransactionID must be specified. |
207
|
|
|
|
|
|
|
If OrderID is specified, ItemID and |
208
|
|
|
|
|
|
|
TransactionID are ignored if present in the same request. Changes to the |
209
|
|
|
|
|
|
|
checkout status are applied to the specified order as a whole |
210
|
|
|
|
|
|
|
(and thus to the child transactions associated with the order). |
211
|
|
|
|
|
|
|
|
212
|
|
|
|
|
|
|
RequiredInput: Conditionally |
213
|
|
|
|
|
|
|
# Argument: 'ns:OrderIDType' |
214
|
|
|
|
|
|
|
|
215
|
|
|
|
|
|
|
=cut |
216
|
|
|
|
|
|
|
|
217
|
|
|
|
|
|
|
sub setOrderID { |
218
|
|
|
|
|
|
|
my $self = shift; |
219
|
|
|
|
|
|
|
my $pOrderID = shift; |
220
|
|
|
|
|
|
|
$self->getRequestDataType()->setOrderID($pOrderID); |
221
|
|
|
|
|
|
|
} |
222
|
|
|
|
|
|
|
|
223
|
|
|
|
|
|
|
=head2 setPayPalEmailAddress() |
224
|
|
|
|
|
|
|
|
225
|
|
|
|
|
|
|
Provide PayPal email address if the payment method added is PayPal. |
226
|
|
|
|
|
|
|
For digital listings, this must be an email address associated with |
227
|
|
|
|
|
|
|
a verified PayPal Premier or Business account. |
228
|
|
|
|
|
|
|
|
229
|
|
|
|
|
|
|
RequiredInput: No |
230
|
|
|
|
|
|
|
# Argument: 'xs:string' |
231
|
|
|
|
|
|
|
|
232
|
|
|
|
|
|
|
=cut |
233
|
|
|
|
|
|
|
|
234
|
|
|
|
|
|
|
sub setPayPalEmailAddress { |
235
|
|
|
|
|
|
|
my $self = shift; |
236
|
|
|
|
|
|
|
my $sPayPalEmailAddress = shift; |
237
|
|
|
|
|
|
|
$self->getRequestDataType()->setPayPalEmailAddress($sPayPalEmailAddress); |
238
|
|
|
|
|
|
|
} |
239
|
|
|
|
|
|
|
|
240
|
|
|
|
|
|
|
=head2 setPaymentMethods() |
241
|
|
|
|
|
|
|
|
242
|
|
|
|
|
|
|
Optional ability for the seller to add certain payment methods on |
243
|
|
|
|
|
|
|
transaction if they were not originally specified on the item. Valid |
244
|
|
|
|
|
|
|
values are PayPal in the US, and MoneyXferAcceptedInCheckout (CIP+) in |
245
|
|
|
|
|
|
|
Germany. |
246
|
|
|
|
|
|
|
|
247
|
|
|
|
|
|
|
RequiredInput: No |
248
|
|
|
|
|
|
|
# Argument: reference to an array |
249
|
|
|
|
|
|
|
of 'ns:BuyerPaymentMethodCodeType' |
250
|
|
|
|
|
|
|
|
251
|
|
|
|
|
|
|
=cut |
252
|
|
|
|
|
|
|
|
253
|
|
|
|
|
|
|
sub setPaymentMethods { |
254
|
|
|
|
|
|
|
my $self = shift; |
255
|
|
|
|
|
|
|
my $sPaymentMethods = shift; |
256
|
|
|
|
|
|
|
$self->getRequestDataType()->setPaymentMethods($sPaymentMethods); |
257
|
|
|
|
|
|
|
} |
258
|
|
|
|
|
|
|
|
259
|
|
|
|
|
|
|
=head2 setSalesTax() |
260
|
|
|
|
|
|
|
|
261
|
|
|
|
|
|
|
The details of the sales tax added to the invoice. |
262
|
|
|
|
|
|
|
|
263
|
|
|
|
|
|
|
RequiredInput: No |
264
|
|
|
|
|
|
|
# Argument: 'ns:SalesTaxType' |
265
|
|
|
|
|
|
|
|
266
|
|
|
|
|
|
|
=cut |
267
|
|
|
|
|
|
|
|
268
|
|
|
|
|
|
|
sub setSalesTax { |
269
|
|
|
|
|
|
|
my $self = shift; |
270
|
|
|
|
|
|
|
my $pSalesTax = shift; |
271
|
|
|
|
|
|
|
$self->getRequestDataType()->setSalesTax($pSalesTax); |
272
|
|
|
|
|
|
|
} |
273
|
|
|
|
|
|
|
|
274
|
|
|
|
|
|
|
=head2 setShippingServiceOptions() |
275
|
|
|
|
|
|
|
|
276
|
|
|
|
|
|
|
If the buyer's shipping address is domestic, use this to offer up to |
277
|
|
|
|
|
|
|
three shipping services, and omit all InternationalShippingServiceOptions. Any |
278
|
|
|
|
|
|
|
shipping insurance cost specified should be the same for all services |
279
|
|
|
|
|
|
|
offered. |
280
|
|
|
|
|
|
|
|
281
|
|
|
|
|
|
|
Not applicable to invoices for digital listings. |
282
|
|
|
|
|
|
|
|
283
|
|
|
|
|
|
|
RequiredInput: No |
284
|
|
|
|
|
|
|
# Argument: reference to an array |
285
|
|
|
|
|
|
|
of 'ns:ShippingServiceOptionsType' |
286
|
|
|
|
|
|
|
|
287
|
|
|
|
|
|
|
=cut |
288
|
|
|
|
|
|
|
|
289
|
|
|
|
|
|
|
sub setShippingServiceOptions { |
290
|
|
|
|
|
|
|
my $self = shift; |
291
|
|
|
|
|
|
|
my $pShippingServiceOptions = shift; |
292
|
|
|
|
|
|
|
$self->getRequestDataType()->setShippingServiceOptions($pShippingServiceOptions); |
293
|
|
|
|
|
|
|
} |
294
|
|
|
|
|
|
|
|
295
|
|
|
|
|
|
|
=head2 setTransactionID() |
296
|
|
|
|
|
|
|
|
297
|
|
|
|
|
|
|
ID for the transaction with which the item was sold. |
298
|
|
|
|
|
|
|
If OrderID is not provided, both ItemID and |
299
|
|
|
|
|
|
|
TransactionID must be provided. |
300
|
|
|
|
|
|
|
For Chinese auctions, the value passed in the TransactionId |
301
|
|
|
|
|
|
|
argument must be 0 or the call will fail with an error. |
302
|
|
|
|
|
|
|
Call GetItemTransactions or GetSellerTransactions to |
303
|
|
|
|
|
|
|
determine the correct transaction ID. |
304
|
|
|
|
|
|
|
|
305
|
|
|
|
|
|
|
MaxLength: 19 (Note: The eBay database specifies 38. Currently, transaction IDs are usually 9 to 12 digits.) |
306
|
|
|
|
|
|
|
|
307
|
|
|
|
|
|
|
RequiredInput: Conditionally |
308
|
|
|
|
|
|
|
# Argument: 'xs:string' |
309
|
|
|
|
|
|
|
|
310
|
|
|
|
|
|
|
=cut |
311
|
|
|
|
|
|
|
|
312
|
|
|
|
|
|
|
sub setTransactionID { |
313
|
|
|
|
|
|
|
my $self = shift; |
314
|
|
|
|
|
|
|
my $sTransactionID = shift; |
315
|
|
|
|
|
|
|
$self->getRequestDataType()->setTransactionID($sTransactionID); |
316
|
|
|
|
|
|
|
} |
317
|
|
|
|
|
|
|
|
318
|
|
|
|
|
|
|
|
319
|
|
|
|
|
|
|
|
320
|
|
|
|
|
|
|
# |
321
|
|
|
|
|
|
|
# output properties |
322
|
|
|
|
|
|
|
# |
323
|
|
|
|
|
|
|
|
324
|
|
|
|
|
|
|
|
325
|
|
|
|
|
|
|
|
326
|
|
|
|
|
|
|
|
327
|
|
|
|
|
|
|
|
328
|
|
|
|
|
|
|
1; |