1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="content_v2.html">Content API for Shopping</a> . <a href="content_v2.orderinvoices.html">orderinvoices</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#createchargeinvoice">createchargeinvoice(merchantId, orderId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a charge invoice for a shipment group, and triggers a charge capture for orderinvoice enabled orders.</p>
<p class="toc_element">
<code><a href="#createrefundinvoice">createrefundinvoice(merchantId, orderId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a refund invoice for one or more shipment groups, and triggers a refund for orderinvoice enabled orders. This can only be used for line items that have previously been charged using `createChargeInvoice`. All amounts (except for the summary) are incremental with respect to the previous invoice.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="createchargeinvoice">createchargeinvoice(merchantId, orderId, body=None, x__xgafv=None)</code>
<pre>Creates a charge invoice for a shipment group, and triggers a charge capture for orderinvoice enabled orders.
Args:
merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
orderId: string, The ID of the order. (required)
body: object, The request body.
The object takes the form of:
{
"invoiceId": "A String", # [required] The ID of the invoice.
"invoiceSummary": { # [required] Invoice summary.
"additionalChargeSummaries": [ # Summary of the total amounts of the additional charges.
{
"totalAmount": { # [required] Total additional charge for this type.
"pretax": { # [required] Value before taxes.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"tax": { # [required] Tax value.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
"type": "A String", # [required] Type of the additional charge. Acceptable values are: - "`shipping`"
},
],
"customerBalance": { # Deprecated.
"pretax": { # [required] Value before taxes.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"tax": { # [required] Tax value.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
"googleBalance": { # Deprecated.
"pretax": { # [required] Value before taxes.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"tax": { # [required] Tax value.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
"merchantBalance": { # Deprecated.
"pretax": { # [required] Value before taxes.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"tax": { # [required] Tax value.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
"productTotal": { # [required] Total price for the product.
"pretax": { # [required] Value before taxes.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"tax": { # [required] Tax value.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
"promotionSummaries": [ # Deprecated.
{
"promotionAmount": { # [required] Amount of the promotion. The values here are the promotion applied to the unit price pretax and to the total of the tax amounts.
"pretax": { # [required] Value before taxes.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"tax": { # [required] Tax value.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
"promotionId": "A String", # [required] ID of the promotion.
},
],
},
"lineItemInvoices": [ # [required] Invoice details per line item.
{
"lineItemId": "A String", # ID of the line item. Either lineItemId or productId must be set.
"productId": "A String", # ID of the product. This is the REST ID used in the products service. Either lineItemId or productId must be set.
"shipmentUnitIds": [ # [required] The shipment unit ID is assigned by the merchant and defines individual quantities within a line item. The same ID can be assigned to units that are the same while units that differ must be assigned a different ID (for example: free or promotional units).
"A String",
],
"unitInvoice": { # [required] Invoice details for a single unit.
"additionalCharges": [ # Additional charges for a unit, e.g. shipping costs.
{
"additionalChargeAmount": { # [required] Amount of the additional charge.
"pretax": { # [required] Value before taxes.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"tax": { # [required] Tax value.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
"additionalChargePromotions": [ # Deprecated.
{
"promotionAmount": { # [required] Amount of the promotion. The values here are the promotion applied to the unit price pretax and to the total of the tax amounts.
"pretax": { # [required] Value before taxes.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"tax": { # [required] Tax value.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
"promotionId": "A String", # [required] ID of the promotion.
},
],
"type": "A String", # [required] Type of the additional charge. Acceptable values are: - "`shipping`"
},
],
"promotions": [ # Deprecated.
{
"promotionAmount": { # [required] Amount of the promotion. The values here are the promotion applied to the unit price pretax and to the total of the tax amounts.
"pretax": { # [required] Value before taxes.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"tax": { # [required] Tax value.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
"promotionId": "A String", # [required] ID of the promotion.
},
],
"unitPricePretax": { # [required] Price of the unit, before applying taxes.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"unitPriceTaxes": [ # Tax amounts to apply to the unit price.
{
"taxAmount": { # [required] Tax amount for the tax type.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"taxName": "A String", # Optional name of the tax type. This should only be provided if `taxType` is `otherFeeTax`.
"taxType": "A String", # [required] Type of the tax. Acceptable values are: - "`otherFee`" - "`otherFeeTax`" - "`sales`"
},
],
},
},
],
"operationId": "A String", # [required] The ID of the operation, unique across all operations for a given order.
"shipmentGroupId": "A String", # [required] ID of the shipment group. It is assigned by the merchant in the `shipLineItems` method and is used to group multiple line items that have the same kind of shipping charges.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"executionStatus": "A String", # The status of the execution. Acceptable values are: - "`duplicate`" - "`executed`"
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "content#orderinvoicesCreateChargeInvoiceResponse".
}</pre>
</div>
<div class="method">
<code class="details" id="createrefundinvoice">createrefundinvoice(merchantId, orderId, body=None, x__xgafv=None)</code>
<pre>Creates a refund invoice for one or more shipment groups, and triggers a refund for orderinvoice enabled orders. This can only be used for line items that have previously been charged using `createChargeInvoice`. All amounts (except for the summary) are incremental with respect to the previous invoice.
Args:
merchantId: string, The ID of the account that manages the order. This cannot be a multi-client account. (required)
orderId: string, The ID of the order. (required)
body: object, The request body.
The object takes the form of:
{
"invoiceId": "A String", # [required] The ID of the invoice.
"operationId": "A String", # [required] The ID of the operation, unique across all operations for a given order.
"refundOnlyOption": { # Option to create a refund-only invoice. Exactly one of `refundOnlyOption` or `returnOption` must be provided.
"description": "A String", # Optional description of the refund reason.
"reason": "A String", # [required] Reason for the refund. Acceptable values are: - "`adjustment`" - "`autoPostInternal`" - "`autoPostInvalidBillingAddress`" - "`autoPostNoInventory`" - "`autoPostPriceError`" - "`autoPostUndeliverableShippingAddress`" - "`couponAbuse`" - "`courtesyAdjustment`" - "`customerCanceled`" - "`customerDiscretionaryReturn`" - "`customerInitiatedMerchantCancel`" - "`customerSupportRequested`" - "`deliveredLateByCarrier`" - "`deliveredTooLate`" - "`expiredItem`" - "`failToPushOrderGoogleError`" - "`failToPushOrderMerchantError`" - "`failToPushOrderMerchantFulfillmentError`" - "`failToPushOrderToMerchant`" - "`failToPushOrderToMerchantOutOfStock`" - "`feeAdjustment`" - "`invalidCoupon`" - "`lateShipmentCredit`" - "`malformedShippingAddress`" - "`merchantDidNotShipOnTime`" - "`noInventory`" - "`orderTimeout`" - "`other`" - "`paymentAbuse`" - "`paymentDeclined`" - "`priceAdjustment`" - "`priceError`" - "`productArrivedDamaged`" - "`productNotAsDescribed`" - "`promoReallocation`" - "`qualityNotAsExpected`" - "`returnRefundAbuse`" - "`shippingCostAdjustment`" - "`shippingPriceError`" - "`taxAdjustment`" - "`taxError`" - "`undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" - "`wrongProductShipped`"
},
"returnOption": { # Option to create an invoice for a refund and mark all items within the invoice as returned. Exactly one of `refundOnlyOption` or `returnOption` must be provided.
"description": "A String", # Optional description of the return reason.
"reason": "A String", # [required] Reason for the return. Acceptable values are: - "`customerDiscretionaryReturn`" - "`customerInitiatedMerchantCancel`" - "`deliveredTooLate`" - "`expiredItem`" - "`invalidCoupon`" - "`malformedShippingAddress`" - "`other`" - "`productArrivedDamaged`" - "`productNotAsDescribed`" - "`qualityNotAsExpected`" - "`undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" - "`wrongProductShipped`"
},
"shipmentInvoices": [ # Invoice details for different shipment groups.
{
"invoiceSummary": { # [required] Invoice summary.
"additionalChargeSummaries": [ # Summary of the total amounts of the additional charges.
{
"totalAmount": { # [required] Total additional charge for this type.
"pretax": { # [required] Value before taxes.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"tax": { # [required] Tax value.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
"type": "A String", # [required] Type of the additional charge. Acceptable values are: - "`shipping`"
},
],
"customerBalance": { # Deprecated.
"pretax": { # [required] Value before taxes.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"tax": { # [required] Tax value.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
"googleBalance": { # Deprecated.
"pretax": { # [required] Value before taxes.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"tax": { # [required] Tax value.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
"merchantBalance": { # Deprecated.
"pretax": { # [required] Value before taxes.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"tax": { # [required] Tax value.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
"productTotal": { # [required] Total price for the product.
"pretax": { # [required] Value before taxes.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"tax": { # [required] Tax value.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
"promotionSummaries": [ # Deprecated.
{
"promotionAmount": { # [required] Amount of the promotion. The values here are the promotion applied to the unit price pretax and to the total of the tax amounts.
"pretax": { # [required] Value before taxes.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"tax": { # [required] Tax value.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
"promotionId": "A String", # [required] ID of the promotion.
},
],
},
"lineItemInvoices": [ # [required] Invoice details per line item.
{
"lineItemId": "A String", # ID of the line item. Either lineItemId or productId must be set.
"productId": "A String", # ID of the product. This is the REST ID used in the products service. Either lineItemId or productId must be set.
"shipmentUnitIds": [ # [required] The shipment unit ID is assigned by the merchant and defines individual quantities within a line item. The same ID can be assigned to units that are the same while units that differ must be assigned a different ID (for example: free or promotional units).
"A String",
],
"unitInvoice": { # [required] Invoice details for a single unit.
"additionalCharges": [ # Additional charges for a unit, e.g. shipping costs.
{
"additionalChargeAmount": { # [required] Amount of the additional charge.
"pretax": { # [required] Value before taxes.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"tax": { # [required] Tax value.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
"additionalChargePromotions": [ # Deprecated.
{
"promotionAmount": { # [required] Amount of the promotion. The values here are the promotion applied to the unit price pretax and to the total of the tax amounts.
"pretax": { # [required] Value before taxes.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"tax": { # [required] Tax value.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
"promotionId": "A String", # [required] ID of the promotion.
},
],
"type": "A String", # [required] Type of the additional charge. Acceptable values are: - "`shipping`"
},
],
"promotions": [ # Deprecated.
{
"promotionAmount": { # [required] Amount of the promotion. The values here are the promotion applied to the unit price pretax and to the total of the tax amounts.
"pretax": { # [required] Value before taxes.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"tax": { # [required] Tax value.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
},
"promotionId": "A String", # [required] ID of the promotion.
},
],
"unitPricePretax": { # [required] Price of the unit, before applying taxes.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"unitPriceTaxes": [ # Tax amounts to apply to the unit price.
{
"taxAmount": { # [required] Tax amount for the tax type.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"taxName": "A String", # Optional name of the tax type. This should only be provided if `taxType` is `otherFeeTax`.
"taxType": "A String", # [required] Type of the tax. Acceptable values are: - "`otherFee`" - "`otherFeeTax`" - "`sales`"
},
],
},
},
],
"shipmentGroupId": "A String", # [required] ID of the shipment group. It is assigned by the merchant in the `shipLineItems` method and is used to group multiple line items that have the same kind of shipping charges.
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"executionStatus": "A String", # The status of the execution. Acceptable values are: - "`duplicate`" - "`executed`"
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "content#orderinvoicesCreateRefundInvoiceResponse".
}</pre>
</div>
</body></html>
|
